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