2 /* $KAME: altq_cbq.h,v 1.10 2003/08/20 23:30:23 itojun Exp $ */
5 * Copyright (c) Sun Microsystems, Inc. 1993-1998 All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the SMCC Technology
21 * Development Group at Sun Microsystems, Inc.
23 * 4. The name of the Sun Microsystems, Inc nor may not be used to endorse or
24 * promote products derived from this software without specific prior
27 * SUN MICROSYSTEMS DOES NOT CLAIM MERCHANTABILITY OF THIS SOFTWARE OR THE
28 * SUITABILITY OF THIS SOFTWARE FOR ANY PARTICULAR PURPOSE. The software is
29 * provided "as is" without express or implied warranty of any kind.
31 * These notices must be retained in any copies of any part of this software.
34 #ifndef _ALTQ_ALTQ_CBQ_H_
35 #define _ALTQ_ALTQ_CBQ_H_
37 #include <altq/altq.h>
38 #include <altq/altq_rmclass.h>
39 #include <altq/altq_red.h>
40 #include <altq/altq_rio.h>
42 /* #pragma ident "@(#)cbq.h 1.18 98/05/13 SMI" */
49 * Define a well known class handles
51 #define NULL_CLASS_HANDLE 0xffffffff
52 #define ROOT_CLASS_HANDLE 0xfffffffe
53 #define DEFAULT_CLASS_HANDLE 0xfffffffd
55 #define CTL_CLASS_HANDLE 0xfffffffc
58 /* class flags shoud be same as class flags in rm_class.h */
59 #define CBQCLF_RED 0x0001 /* use RED */
60 #define CBQCLF_ECN 0x0002 /* use RED/ECN */
61 #define CBQCLF_RIO 0x0004 /* use RIO */
62 #define CBQCLF_FLOWVALVE 0x0008 /* use flowvalve (aka penalty-box) */
63 #define CBQCLF_CLEARDSCP 0x0010 /* clear diffserv codepoint */
64 #define CBQCLF_BORROW 0x0020 /* borrow from parent */
66 /* class flags only for root class */
67 #define CBQCLF_WRR 0x0100 /* weighted-round robin */
68 #define CBQCLF_EFFICIENT 0x0200 /* work-conserving */
70 /* class flags for special classes */
71 #define CBQCLF_ROOTCLASS 0x1000 /* root class */
72 #define CBQCLF_DEFCLASS 0x2000 /* default class */
74 #define CBQCLF_CTLCLASS 0x4000 /* control class */
76 #define CBQCLF_CLASSMASK 0xf000 /* class mask */
78 #define CBQ_MAXQSIZE 200
79 #define CBQ_MAXPRI RM_MAXPRIO
81 typedef struct _cbq_class_stats_ {
85 struct pktcntr xmit_cnt; /* packets sent in this class */
86 struct pktcntr drop_cnt; /* dropped packets */
87 u_int over; /* # times went over limit */
88 u_int borrows; /* # times tried to borrow */
89 u_int overactions; /* # times invoked overlimit action */
90 u_int delays; /* # times invoked delay actions */
92 /* other static class parameters useful for debugging */
101 int qcnt; /* # packets in queue */
104 /* red and rio related info */
106 struct redstats red[3];
111 * Define structures associated with IOCTLS for cbq.
115 * Define the CBQ interface structure. This must be included in all
116 * IOCTL's such that the CBQ driver may find the appropriate CBQ module
117 * associated with the network interface to be affected.
119 struct cbq_interface {
120 char cbq_ifacename[IFNAMSIZ];
123 typedef struct cbq_class_spec {
125 u_int nano_sec_per_byte;
130 u_int32_t parent_class_handle;
131 u_int32_t borrow_class_handle;
137 struct cbq_add_class {
138 struct cbq_interface cbq_iface;
140 cbq_class_spec_t cbq_class;
141 u_int32_t cbq_class_handle;
144 struct cbq_delete_class {
145 struct cbq_interface cbq_iface;
146 u_int32_t cbq_class_handle;
149 struct cbq_modify_class {
150 struct cbq_interface cbq_iface;
152 cbq_class_spec_t cbq_class;
153 u_int32_t cbq_class_handle;
156 struct cbq_add_filter {
157 struct cbq_interface cbq_iface;
158 u_int32_t cbq_class_handle;
159 struct flow_filter cbq_filter;
161 u_long cbq_filter_handle;
164 struct cbq_delete_filter {
165 struct cbq_interface cbq_iface;
166 u_long cbq_filter_handle;
169 /* number of classes are returned in nclasses field */
170 struct cbq_getstats {
171 struct cbq_interface iface;
173 class_stats_t *stats;
177 * Define IOCTLs for CBQ.
179 #define CBQ_IF_ATTACH _IOW('Q', 1, struct cbq_interface)
180 #define CBQ_IF_DETACH _IOW('Q', 2, struct cbq_interface)
181 #define CBQ_ENABLE _IOW('Q', 3, struct cbq_interface)
182 #define CBQ_DISABLE _IOW('Q', 4, struct cbq_interface)
183 #define CBQ_CLEAR_HIERARCHY _IOW('Q', 5, struct cbq_interface)
184 #define CBQ_ADD_CLASS _IOWR('Q', 7, struct cbq_add_class)
185 #define CBQ_DEL_CLASS _IOW('Q', 8, struct cbq_delete_class)
186 #define CBQ_MODIFY_CLASS _IOWR('Q', 9, struct cbq_modify_class)
187 #define CBQ_ADD_FILTER _IOWR('Q', 10, struct cbq_add_filter)
188 #define CBQ_DEL_FILTER _IOW('Q', 11, struct cbq_delete_filter)
189 #define CBQ_GETSTATS _IOWR('Q', 12, struct cbq_getstats)
190 #endif /* ALTQ3_COMPAT */
194 * Define macros only good for kernel drivers and modules.
196 #define CBQ_WATCHDOG (hz / 20)
197 #define CBQ_TIMEOUT 10
198 #define CBQ_LS_TIMEOUT (20 * hz / 1000)
200 #define CBQ_MAX_CLASSES 256
203 #define CBQ_MAX_FILTERS 256
207 #endif /* ALTQ3_COMPAT */
210 * Define State structures.
212 typedef struct cbqstate {
214 struct cbqstate *cbq_next;
216 int cbq_qlen; /* # of packets in cbq */
217 struct rm_class *cbq_class_tbl[CBQ_MAX_CLASSES];
219 struct rm_ifdat ifnp;
220 struct callout cbq_callout; /* for timeouts */
221 #ifdef ALTQ3_CLFIER_COMPAT
222 struct acc_classifier cbq_classifier;
232 #endif /* !_ALTQ_ALTQ_CBQ_H_ */