xref: /dragonfly/sys/netgraph7/ng_car.h (revision 3851e4b8)
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: src/sys/netgraph/ng_car.h,v 1.2 2007/12/19 22:50:14 mav Exp $
28  * $DragonFly: src/sys/netgraph7/ng_car.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
29  */
30 
31 #ifndef _NETGRAPH_NG_CAR_H_
32 #define _NETGRAPH_NG_CAR_H_
33 
34 #define NG_CAR_NODE_TYPE	"car"
35 #define NGM_CAR_COOKIE		1173648034
36 
37 /* Hook names */
38 #define NG_CAR_HOOK_UPPER	"upper"
39 #define NG_CAR_HOOK_LOWER	"lower"
40 
41 /* Per hook statistics counters */
42 struct ng_car_hookstats {
43 	u_int64_t passed_pkts;	/* Counter for passed packets */
44 	u_int64_t droped_pkts;	/* Counter for droped packets */
45 	u_int64_t green_pkts;	/* Counter for green packets */
46 	u_int64_t yellow_pkts;	/* Counter for yellow packets */
47 	u_int64_t red_pkts;	/* Counter for red packets */
48 	u_int64_t errors;	/* Counter for operation errors */
49 };
50 #define NG_CAR_HOOKSTATS	{				\
51 	  { "passed",		&ng_parse_uint64_type	},	\
52 	  { "droped",		&ng_parse_uint64_type	},	\
53 	  { "green",		&ng_parse_uint64_type	},	\
54 	  { "yellow",		&ng_parse_uint64_type	},	\
55 	  { "red",		&ng_parse_uint64_type	},	\
56 	  { "errors",		&ng_parse_uint64_type	},	\
57 	  { NULL }						\
58 }
59 
60 /* Bulk statistics */
61 struct ng_car_bulkstats {
62 	struct ng_car_hookstats upstream;
63 	struct ng_car_hookstats downstream;
64 };
65 #define NG_CAR_BULKSTATS(hstatstype) {				\
66 	  { "upstream",		(hstatstype)		},	\
67 	  { "downstream",	(hstatstype)		},	\
68 	  { NULL }						\
69 }
70 
71 /* Per hook configuration */
72 struct ng_car_hookconf {
73 	u_int64_t cbs;		/* Commited burst size (bytes) */
74 	u_int64_t ebs;		/* Exceeded/Peak burst size (bytes) */
75 	u_int64_t cir;		/* Commited information rate (bits/s) */
76 	u_int64_t pir;		/* Peak information rate (bits/s) */
77 	u_int8_t green_action;	/* Action for green packets */
78 	u_int8_t yellow_action;	/* Action for yellow packets */
79 	u_int8_t red_action;	/* Action for red packets */
80 	u_int8_t mode;		/* single/double rate, ... */
81 	u_int8_t opt;		/* color-aware or color-blind */
82 };
83 /* Keep this definition in sync with the above structure */
84 #define NG_CAR_HOOKCONF	{					\
85 	  { "cbs",		&ng_parse_uint64_type	},	\
86 	  { "ebs",		&ng_parse_uint64_type	},	\
87 	  { "cir",		&ng_parse_uint64_type	},	\
88 	  { "pir",		&ng_parse_uint64_type	},	\
89 	  { "greenAction",	&ng_parse_uint8_type	},	\
90 	  { "yellowAction",	&ng_parse_uint8_type	},	\
91 	  { "redAction",	&ng_parse_uint8_type	},	\
92 	  { "mode",		&ng_parse_uint8_type	},	\
93 	  { "opt",		&ng_parse_uint8_type	},	\
94 	  { NULL }						\
95 }
96 
97 #define NG_CAR_CBS_MIN		8192
98 #define NG_CAR_EBS_MIN		8192
99 #define NG_CAR_CIR_DFLT		10240
100 
101 /* possible actions (...Action) */
102 enum {
103     NG_CAR_ACTION_FORWARD = 1,
104     NG_CAR_ACTION_DROP,
105     NG_CAR_ACTION_MARK,
106     NG_CAR_ACTION_SET_TOS
107 };
108 
109 /* operation modes (mode) */
110 enum {
111     NG_CAR_SINGLE_RATE = 0,
112     NG_CAR_DOUBLE_RATE,
113     NG_CAR_RED,
114     NG_CAR_SHAPE
115 };
116 
117 /* mode options (opt) */
118 #define NG_CAR_COLOR_AWARE	1
119 #define NG_CAR_COUNT_PACKETS	2
120 
121 /* Bulk config */
122 struct 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 */
133 enum {
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