altq_rmclass.h revision 1.1
1 /* $KAME: altq_rmclass.h,v 1.6 2000/12/09 09:22:44 kjc Exp $ */ 2 3 /* 4 * Copyright (c) 1991-1997 Regents of the University of California. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 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 Network Research 18 * Group at Lawrence Berkeley Laboratory. 19 * 4. Neither the name of the University nor of the Laboratory may be used 20 * to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 */ 35 36 #ifndef _ALTQ_ALTQ_RMCLASS_H_ 37 #define _ALTQ_ALTQ_RMCLASS_H_ 38 39 #include <altq/altq_classq.h> 40 41 /* #pragma ident "@(#)rm_class.h 1.20 97/10/23 SMI" */ 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 #ifdef _KERNEL 48 49 typedef struct mbuf mbuf_t; 50 typedef struct rm_ifdat rm_ifdat_t; 51 typedef struct rm_class rm_class_t; 52 53 struct red; 54 55 /* 56 * Macros for dealing with time values. We assume all times are 57 * 'timevals'. `microtime' is used to get the best available clock 58 * resolution. If `microtime' *doesn't* return a value that's about 59 * ten times smaller than the average packet time on the fastest 60 * link that will use these routines, a slightly different clock 61 * scheme than this one should be used. 62 * (Bias due to truncation error in this scheme will overestimate utilization 63 * and discriminate against high bandwidth classes. To remove this bias an 64 * integrator needs to be added. The simplest integrator uses a history of 65 * 10 * avg.packet.time / min.tick.time packet completion entries. This is 66 * straight forward to add but we don't want to pay the extra memory 67 * traffic to maintain it if it's not necessary (occasionally a vendor 68 * accidentally builds a workstation with a decent clock - e.g., Sun & HP).) 69 */ 70 71 #define RM_GETTIME(now) microtime(&now) 72 73 #define TV_LT(a, b) (((a)->tv_sec < (b)->tv_sec) || \ 74 (((a)->tv_usec < (b)->tv_usec) && ((a)->tv_sec <= (b)->tv_sec))) 75 76 #define TV_DELTA(a, b, delta) { \ 77 register int xxs; \ 78 \ 79 delta = (a)->tv_usec - (b)->tv_usec; \ 80 if ((xxs = (a)->tv_sec - (b)->tv_sec)) { \ 81 switch (xxs) { \ 82 default: \ 83 if (xxs < 0) \ 84 printf("rm_class: bogus time values\n"); \ 85 delta = 0; \ 86 /* fall through */ \ 87 case 2: \ 88 delta += 1000000; \ 89 /* fall through */ \ 90 case 1: \ 91 delta += 1000000; \ 92 break; \ 93 } \ 94 } \ 95 } 96 97 #define TV_ADD_DELTA(a, delta, res) { \ 98 register int xxus = (a)->tv_usec + (delta); \ 99 \ 100 (res)->tv_sec = (a)->tv_sec; \ 101 while (xxus >= 1000000) { \ 102 ++((res)->tv_sec); \ 103 xxus -= 1000000; \ 104 } \ 105 (res)->tv_usec = xxus; \ 106 } 107 108 #define RM_TIMEOUT 2 /* 1 Clock tick. */ 109 110 #if 1 111 #define RM_MAXQUEUED 1 /* this isn't used in ALTQ/CBQ */ 112 #else 113 #define RM_MAXQUEUED 16 /* Max number of packets downstream of CBQ */ 114 #endif 115 #define RM_MAXPRIO 8 /* Max priority */ 116 #define RM_MAXQUEUE 64 /* Max queue length */ 117 #define RM_FILTER_GAIN 5 /* log2 of gain, e.g., 5 => 31/32 */ 118 #define RM_POWER (1 << RM_FILTER_GAIN) 119 #define RM_MAXDEPTH 32 120 #define RM_NS_PER_SEC (1000000000) 121 122 typedef struct _rm_class_stats_ { 123 u_int handle; 124 u_int depth; 125 126 struct pktcntr xmit_cnt; /* packets sent in this class */ 127 struct pktcntr drop_cnt; /* dropped packets */ 128 u_int over; /* # times went over limit */ 129 u_int borrows; /* # times tried to borrow */ 130 u_int overactions; /* # times invoked overlimit action */ 131 u_int delays; /* # times invoked delay actions */ 132 } rm_class_stats_t; 133 134 /* 135 * CBQ Class state structure 136 */ 137 struct rm_class { 138 class_queue_t *q_; /* Queue of packets */ 139 rm_ifdat_t *ifdat_; 140 int pri_; /* Class priority. */ 141 int depth_; /* Class depth */ 142 u_int ns_per_byte_; /* NanoSeconds per byte. */ 143 u_int maxrate_; /* Bytes per second for this class. */ 144 u_int allotment_; /* Fraction of link bandwidth. */ 145 u_int w_allotment_; /* Weighted allotment for WRR */ 146 int bytes_alloc_; /* Allocation for round of WRR */ 147 148 int avgidle_; 149 int maxidle_; 150 int minidle_; 151 int offtime_; 152 int sleeping_; /* != 0 if delaying */ 153 int qthresh_; /* Queue threshold for formal link sharing */ 154 int leaf_; /* Note whether leaf class or not.*/ 155 156 rm_class_t *children_; /* Children of this class */ 157 rm_class_t *next_; /* Next pointer, used if child */ 158 159 rm_class_t *peer_; /* Peer class */ 160 rm_class_t *borrow_; /* Borrow class */ 161 rm_class_t *parent_; /* Parent class */ 162 163 void (*overlimit)(struct rm_class *, struct rm_class *); 164 void (*drop)(struct rm_class *); /* Class drop action. */ 165 166 struct red *red_; /* RED state pointer */ 167 struct altq_pktattr *pktattr_; /* saved hdr used by RED/ECN */ 168 int flags_; 169 170 int last_pkttime_; /* saved pkt_time */ 171 struct timeval undertime_; /* time can next send */ 172 struct timeval last_; /* time last packet sent */ 173 struct timeval overtime_; 174 struct callout callout_; /* for timeout() calls */ 175 176 rm_class_stats_t stats_; /* Class Statistics */ 177 }; 178 179 /* 180 * CBQ Interface state 181 */ 182 struct rm_ifdat { 183 int queued_; /* # pkts queued downstream */ 184 int efficient_; /* Link Efficency bit */ 185 int wrr_; /* Enable Weighted Round-Robin */ 186 u_long ns_per_byte_; /* Link byte speed. */ 187 int maxqueued_; /* Max packets to queue */ 188 int maxpkt_; /* Max packet size. */ 189 int qi_; /* In/out pointers for downstream */ 190 int qo_; /* packets */ 191 192 /* 193 * Active class state and WRR state. 194 */ 195 rm_class_t *active_[RM_MAXPRIO]; /* Active cl's in each pri */ 196 int na_[RM_MAXPRIO]; /* # of active cl's in a pri */ 197 int num_[RM_MAXPRIO]; /* # of cl's per pri */ 198 int alloc_[RM_MAXPRIO]; /* Byte Allocation */ 199 u_long M_[RM_MAXPRIO]; /* WRR weights. */ 200 201 /* 202 * Network Interface/Solaris Queue state pointer. 203 */ 204 struct ifaltq *ifq_; 205 rm_class_t *default_; /* Default Pkt class, BE */ 206 rm_class_t *root_; /* Root Link class. */ 207 rm_class_t *ctl_; /* Control Traffic class. */ 208 void (*restart)(struct ifaltq *); /* Restart routine. */ 209 210 /* 211 * Current packet downstream packet state and dynamic state. 212 */ 213 rm_class_t *borrowed_[RM_MAXQUEUED]; /* Class borrowed last */ 214 rm_class_t *class_[RM_MAXQUEUED]; /* class sending */ 215 int curlen_[RM_MAXQUEUED]; /* Current pktlen */ 216 struct timeval now_[RM_MAXQUEUED]; /* Current packet time. */ 217 int is_overlimit_[RM_MAXQUEUED];/* Current packet time. */ 218 219 int cutoff_; /* Cut-off depth for borrowing */ 220 221 struct timeval ifnow_; /* expected xmit completion time */ 222 #if 1 /* ALTQ4PPP */ 223 int maxiftime_; /* max delay inside interface */ 224 #endif 225 rm_class_t *pollcache_; /* cached rm_class by poll operation */ 226 }; 227 228 /* flags for rmc_init and rmc_newclass */ 229 /* class flags */ 230 #define RMCF_RED 0x0001 231 #define RMCF_ECN 0x0002 232 #define RMCF_RIO 0x0004 233 #define RMCF_FLOWVALVE 0x0008 /* use flowvalve (aka penalty-box) */ 234 #define RMCF_CLEARDSCP 0x0010 /* clear diffserv codepoint */ 235 236 /* flags for rmc_init */ 237 #define RMCF_WRR 0x0100 238 #define RMCF_EFFICIENT 0x0200 239 240 #define is_a_parent_class(cl) ((cl)->children_ != NULL) 241 242 extern rm_class_t *rmc_newclass __P((int, struct rm_ifdat *, u_int, 243 void (*)(struct rm_class *, 244 struct rm_class *), 245 int, struct rm_class *, struct rm_class *, 246 u_int, int, u_int, int, int)); 247 extern void rmc_delete_class __P((struct rm_ifdat *, struct rm_class *)); 248 extern int rmc_modclass __P((struct rm_class *, u_int, int, 249 u_int, int, u_int, int)); 250 extern void rmc_init __P((struct ifaltq *, struct rm_ifdat *, u_int, 251 void (*)(struct ifaltq *), 252 int, int, u_int, int, u_int, int)); 253 extern int rmc_queue_packet __P((struct rm_class *, mbuf_t *)); 254 extern mbuf_t *rmc_dequeue_next __P((struct rm_ifdat *, int)); 255 extern void rmc_update_class_util __P((struct rm_ifdat *)); 256 extern void rmc_delay_action __P((struct rm_class *, struct rm_class *)); 257 extern void rmc_dropall __P((struct rm_class *)); 258 extern int rmc_get_weight __P((struct rm_ifdat *, int)); 259 260 #endif /* _KERNEL */ 261 262 #ifdef __cplusplus 263 } 264 #endif 265 266 #endif /* _ALTQ_ALTQ_RMCLASS_H_ */ 267
Indexes created Tue Sep 30 17:09:57 GMT 2025