1 /*- 2 * Copyright (c) Sun Microsystems, Inc. 1993-1998 All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 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 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by the SMCC Technology 18 * Development Group at Sun Microsystems, Inc. 19 * 20 * 4. The name of the Sun Microsystems, Inc nor may not be used to endorse or 21 * promote products derived from this software without specific prior 22 * written permission. 23 * 24 * SUN MICROSYSTEMS DOES NOT CLAIM MERCHANTABILITY OF THIS SOFTWARE OR THE 25 * SUITABILITY OF THIS SOFTWARE FOR ANY PARTICULAR PURPOSE. The software is 26 * provided "as is" without express or implied warranty of any kind. 27 * 28 * These notices must be retained in any copies of any part of this software. 29 * 30 * $KAME: altq_cbq.h,v 1.12 2003/10/03 05:05:15 kjc Exp $ 31 * $FreeBSD$ 32 */ 33 34 #ifndef _ALTQ_ALTQ_CBQ_H_ 35 #define _ALTQ_ALTQ_CBQ_H_ 36 37 #include <net/altq/altq.h> 38 #include <net/altq/altq_rmclass.h> 39 #include <net/altq/altq_codel.h> 40 #include <net/altq/altq_red.h> 41 #include <net/altq/altq_rio.h> 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 #define NULL_CLASS_HANDLE 0 48 49 /* class flags must be same as class flags in altq_rmclass.h */ 50 #define CBQCLF_RED 0x0001 /* use RED */ 51 #define CBQCLF_ECN 0x0002 /* use RED/ECN */ 52 #define CBQCLF_RIO 0x0004 /* use RIO */ 53 #define CBQCLF_FLOWVALVE 0x0008 /* use flowvalve (aka penalty-box) */ 54 #define CBQCLF_CLEARDSCP 0x0010 /* clear diffserv codepoint */ 55 #define CBQCLF_BORROW 0x0020 /* borrow from parent */ 56 #define CBQCLF_CODEL 0x0040 /* use CoDel */ 57 58 #ifdef _KERNEL 59 CTASSERT(CBQCLF_RED == RMCF_RED); 60 CTASSERT(CBQCLF_ECN == RMCF_ECN); 61 CTASSERT(CBQCLF_RIO == RMCF_RIO); 62 CTASSERT(CBQCLF_FLOWVALVE == RMCF_FLOWVALVE); 63 CTASSERT(CBQCLF_CLEARDSCP == RMCF_CLEARDSCP); 64 CTASSERT(CBQCLF_CODEL == RMCF_CODEL); 65 #endif 66 67 /* class flags only for root class */ 68 #define CBQCLF_WRR 0x0100 /* weighted-round robin */ 69 #define CBQCLF_EFFICIENT 0x0200 /* work-conserving */ 70 71 /* class flags for special classes */ 72 #define CBQCLF_ROOTCLASS 0x1000 /* root class */ 73 #define CBQCLF_DEFCLASS 0x2000 /* default class */ 74 #define CBQCLF_CLASSMASK 0xf000 /* class mask */ 75 76 #define CBQ_MAXQSIZE 200 77 #define CBQ_MAXPRI RM_MAXPRIO 78 79 typedef struct _cbq_class_stats_ { 80 u_int32_t handle; 81 u_int depth; 82 83 struct pktcntr xmit_cnt; /* packets sent in this class */ 84 struct pktcntr drop_cnt; /* dropped packets */ 85 u_int over; /* # times went over limit */ 86 u_int borrows; /* # times tried to borrow */ 87 u_int overactions; /* # times invoked overlimit action */ 88 u_int delays; /* # times invoked delay actions */ 89 90 /* other static class parameters useful for debugging */ 91 int priority; 92 int maxidle; 93 int minidle; 94 int offtime; 95 int qmax; 96 int ns_per_byte; 97 int wrr_allot; 98 99 int qcnt; /* # packets in queue */ 100 int avgidle; 101 102 /* codel, red and rio related info */ 103 int qtype; 104 struct redstats red[3]; 105 struct codel_stats codel; 106 } class_stats_t; 107 108 /* 109 * CBQ_STATS_VERSION is defined in altq.h to work around issues stemming 110 * from mixing of public-API and internal bits in each scheduler-specific 111 * header. 112 */ 113 114 115 #ifdef _KERNEL 116 /* 117 * Define macros only good for kernel drivers and modules. 118 */ 119 #define CBQ_WATCHDOG (hz / 20) 120 #define CBQ_TIMEOUT 10 121 #define CBQ_LS_TIMEOUT (20 * hz / 1000) 122 123 #define CBQ_MAX_CLASSES 256 124 125 126 /* 127 * Define State structures. 128 */ 129 typedef struct cbqstate { 130 int cbq_qlen; /* # of packets in cbq */ 131 struct rm_class *cbq_class_tbl[CBQ_MAX_CLASSES]; 132 133 struct rm_ifdat ifnp; 134 struct callout cbq_callout; /* for timeouts */ 135 #ifdef ALTQ3_CLFIER_COMPAT 136 struct acc_classifier cbq_classifier; 137 #endif 138 } cbq_state_t; 139 140 #endif /* _KERNEL */ 141 142 #ifdef __cplusplus 143 } 144 #endif 145 146 #endif /* !_ALTQ_ALTQ_CBQ_H_ */ 147