1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2005 Nuno Antunes <nuno.antunes@gmail.com>
5 * Copyright (c) 2007 Alexander Motin <mav@freebsd.org>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD$
30 */
31
32#ifndef _NETGRAPH_NG_CAR_H_
33#define _NETGRAPH_NG_CAR_H_
34
35#define NG_CAR_NODE_TYPE	"car"
36#define NGM_CAR_COOKIE		1173648034
37
38/* Hook names */
39#define NG_CAR_HOOK_UPPER	"upper"
40#define NG_CAR_HOOK_LOWER	"lower"
41
42/* Per hook statistics counters */
43struct ng_car_hookstats {
44	u_int64_t passed_pkts;	/* Counter for passed packets */
45	u_int64_t dropped_pkts;	/* Counter for dropped packets */
46	u_int64_t green_pkts;	/* Counter for green packets */
47	u_int64_t yellow_pkts;	/* Counter for yellow packets */
48	u_int64_t red_pkts;	/* Counter for red packets */
49	u_int64_t errors;	/* Counter for operation errors */
50};
51#define NG_CAR_HOOKSTATS	{				\
52	  { "passed",		&ng_parse_uint64_type	},	\
53	  { "dropped",		&ng_parse_uint64_type	},	\
54	  { "green",		&ng_parse_uint64_type	},	\
55	  { "yellow",		&ng_parse_uint64_type	},	\
56	  { "red",		&ng_parse_uint64_type	},	\
57	  { "errors",		&ng_parse_uint64_type	},	\
58	  { NULL }						\
59}
60
61/* Bulk statistics */
62struct ng_car_bulkstats {
63	struct ng_car_hookstats upstream;
64	struct ng_car_hookstats downstream;
65};
66#define NG_CAR_BULKSTATS(hstatstype) {				\
67	  { "upstream",		(hstatstype)		},	\
68	  { "downstream",	(hstatstype)		},	\
69	  { NULL }						\
70}
71
72/* Per hook configuration */
73struct ng_car_hookconf {
74	u_int64_t cbs;		/* Committed burst size (bytes) */
75	u_int64_t ebs;		/* Exceeded/Peak burst size (bytes) */
76	u_int64_t cir;		/* Committed information rate (bits/s) */
77	u_int64_t pir;		/* Peak information rate (bits/s) */
78	u_int8_t green_action;	/* Action for green packets */
79	u_int8_t yellow_action;	/* Action for yellow packets */
80	u_int8_t red_action;	/* Action for red packets */
81	u_int8_t mode;		/* single/double rate, ... */
82	u_int8_t opt;		/* color-aware or color-blind */
83};
84/* Keep this definition in sync with the above structure */
85#define NG_CAR_HOOKCONF	{					\
86	  { "cbs",		&ng_parse_uint64_type	},	\
87	  { "ebs",		&ng_parse_uint64_type	},	\
88	  { "cir",		&ng_parse_uint64_type	},	\
89	  { "pir",		&ng_parse_uint64_type	},	\
90	  { "greenAction",	&ng_parse_uint8_type	},	\
91	  { "yellowAction",	&ng_parse_uint8_type	},	\
92	  { "redAction",	&ng_parse_uint8_type	},	\
93	  { "mode",		&ng_parse_uint8_type	},	\
94	  { "opt",		&ng_parse_uint8_type	},	\
95	  { NULL }						\
96}
97
98#define NG_CAR_CBS_MIN		8192
99#define NG_CAR_EBS_MIN		8192
100#define NG_CAR_CIR_DFLT		10240
101
102/* possible actions (...Action) */
103enum {
104    NG_CAR_ACTION_FORWARD = 1,
105    NG_CAR_ACTION_DROP,
106    NG_CAR_ACTION_MARK
107};
108
109/* operation modes (mode) */
110enum {
111    NG_CAR_SINGLE_RATE = 0,
112    NG_CAR_DOUBLE_RATE,
113    NG_CAR_RED,
114    NG_CAR_SHAPE
115};
116
117/* mode options (bits in opt) */
118#define NG_CAR_COLOR_AWARE	1
119#define NG_CAR_COUNT_PACKETS	2
120
121/* Bulk config */
122struct ng_car_bulkconf {
123	struct ng_car_hookconf upstream;
124	struct ng_car_hookconf downstream;
125};
126#define NG_CAR_BULKCONF(hconftype) {				\
127	  { "upstream",		(hconftype)		},	\
128	  { "downstream",	(hconftype)		},	\
129	  { NULL }						\
130}
131
132/* Commands */
133enum {
134	NGM_CAR_GET_STATS = 1,		/* Get statistics */
135	NGM_CAR_CLR_STATS,		/* Clear statistics */
136	NGM_CAR_GETCLR_STATS,		/* Get and clear statistics */
137	NGM_CAR_GET_CONF,		/* Get bulk configuration */
138	NGM_CAR_SET_CONF,		/* Set bulk configuration */
139};
140
141#endif /* _NETGRAPH_NG_CAR_H_ */
142