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