2 /* $KAME: altq_rio.c,v 1.17 2003/07/10 12:07:49 kjc Exp $ */
5 * Copyright (C) 1998-2003
6 * Sony Computer Science Laboratories Inc. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * 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.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Copyright (c) 1990-1994 Regents of the University of California.
31 * All rights reserved.
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by the Computer Systems
44 * Engineering Group at Lawrence Berkeley Laboratory.
45 * 4. Neither the name of the University nor of the Laboratory may be used
46 * to endorse or promote products derived from this software without
47 * specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 #if defined(__FreeBSD__) || defined(__NetBSD__)
66 #include "opt_inet6.h"
68 #endif /* __FreeBSD__ || __NetBSD__ */
69 #ifdef ALTQ_RIO /* rio is enabled by ALTQ_RIO option in opt_altq.h */
71 #include <sys/param.h>
72 #include <sys/malloc.h>
74 #include <sys/socket.h>
75 #include <sys/systm.h>
76 #include <sys/errno.h>
77 #if 1 /* ALTQ3_COMPAT */
79 #include <sys/sockio.h>
80 #include <sys/kernel.h>
85 #include <netinet/in.h>
86 #include <netinet/in_systm.h>
87 #include <netinet/ip.h>
89 #include <netinet/ip6.h>
92 #include <net/pfvar.h>
93 #include <altq/altq.h>
94 #include <altq/altq_cdnr.h>
95 #include <altq/altq_red.h>
96 #include <altq/altq_rio.h>
98 #include <altq/altq_conf.h>
102 * RIO: RED with IN/OUT bit
104 * "Explicit Allocation of Best Effort Packet Delivery Service"
105 * David D. Clark and Wenjia Fang, MIT Lab for Computer Science
106 * http://diffserv.lcs.mit.edu/Papers/exp-alloc-ddc-wf.{ps,pdf}
108 * this implementation is extended to support more than 2 drop precedence
109 * values as described in RFC2597 (Assured Forwarding PHB Group).
113 * AF DS (differentiated service) codepoints.
114 * (classes can be mapped to CBQ or H-FSC classes.)
117 * +---+---+---+---+---+---+---+---+
118 * | CLASS |DropPre| 0 | CU |
119 * +---+---+---+---+---+---+---+---+
127 * medium drop prec: 10
131 /* normal red parameters */
132 #define W_WEIGHT 512 /* inverse of weight of EWMA (511/512) */
133 /* q_weight = 0.00195 */
135 /* red parameters for a slow link */
136 #define W_WEIGHT_1 128 /* inverse of weight of EWMA (127/128) */
137 /* q_weight = 0.0078125 */
139 /* red parameters for a very slow link (e.g., dialup) */
140 #define W_WEIGHT_2 64 /* inverse of weight of EWMA (63/64) */
141 /* q_weight = 0.015625 */
143 /* fixed-point uses 12-bit decimal places */
144 #define FP_SHIFT 12 /* fixed-point shift */
146 /* red parameters for drop probability */
147 #define INV_P_MAX 10 /* inverse of max drop probability */
148 #define TH_MIN 5 /* min threshold */
149 #define TH_MAX 15 /* max threshold */
151 #define RIO_LIMIT 60 /* default max queue lenght */
152 #define RIO_STATS /* collect statistics */
154 #define TV_DELTA(a, b, delta) { \
157 delta = (a)->tv_usec - (b)->tv_usec; \
158 if ((xxs = (a)->tv_sec - (b)->tv_sec) != 0) { \
161 } else if (xxs > 4) { \
165 delta += xxs * 1000000; \
166 } else while (xxs > 0) { \
174 /* rio_list keeps all rio_queue_t's allocated. */
175 static rio_queue_t *rio_list = NULL;
177 /* default rio parameter values */
178 static struct redparams default_rio_params[RIO_NDROPPREC] = {
179 /* th_min, th_max, inv_pmax */
180 { TH_MAX * 2 + TH_MIN, TH_MAX * 3, INV_P_MAX }, /* low drop precedence */
181 { TH_MAX + TH_MIN, TH_MAX * 2, INV_P_MAX }, /* medium drop precedence */
182 { TH_MIN, TH_MAX, INV_P_MAX } /* high drop precedence */
185 /* internal function prototypes */
186 static int dscp2index(u_int8_t);
188 static int rio_enqueue(struct ifaltq *, struct mbuf *, struct altq_pktattr *);
189 static struct mbuf *rio_dequeue(struct ifaltq *, int);
190 static int rio_request(struct ifaltq *, int, void *);
191 static int rio_detach(rio_queue_t *);
194 * rio device interface
198 #endif /* ALTQ3_COMPAT */
201 rio_alloc(int weight, struct redparams *params, int flags, int pkttime)
207 rp = malloc(sizeof(rio_t), M_DEVBUF, M_NOWAIT | M_ZERO);
211 rp->rio_flags = flags;
213 /* default packet time: 1000 bytes / 10Mbps * 8 * 1000000 */
214 rp->rio_pkttime = 800;
216 rp->rio_pkttime = pkttime;
219 rp->rio_weight = weight;
222 rp->rio_weight = W_WEIGHT;
224 /* when the link is very slow, adjust red parameters */
225 npkts_per_sec = 1000000 / rp->rio_pkttime;
226 if (npkts_per_sec < 50) {
227 /* up to about 400Kbps */
228 rp->rio_weight = W_WEIGHT_2;
229 } else if (npkts_per_sec < 300) {
230 /* up to about 2.4Mbps */
231 rp->rio_weight = W_WEIGHT_1;
235 /* calculate wshift. weight must be power of 2 */
237 for (i = 0; w > 1; i++)
240 w = 1 << rp->rio_wshift;
241 if (w != rp->rio_weight) {
242 printf("invalid weight value %d for red! use %d\n",
247 /* allocate weight table */
248 rp->rio_wtab = wtab_alloc(rp->rio_weight);
250 for (i = 0; i < RIO_NDROPPREC; i++) {
251 struct dropprec_state *prec = &rp->rio_precstate[i];
256 if (params == NULL || params[i].inv_pmax == 0)
257 prec->inv_pmax = default_rio_params[i].inv_pmax;
259 prec->inv_pmax = params[i].inv_pmax;
260 if (params == NULL || params[i].th_min == 0)
261 prec->th_min = default_rio_params[i].th_min;
263 prec->th_min = params[i].th_min;
264 if (params == NULL || params[i].th_max == 0)
265 prec->th_max = default_rio_params[i].th_max;
267 prec->th_max = params[i].th_max;
270 * th_min_s and th_max_s are scaled versions of th_min
271 * and th_max to be compared with avg.
273 prec->th_min_s = prec->th_min << (rp->rio_wshift + FP_SHIFT);
274 prec->th_max_s = prec->th_max << (rp->rio_wshift + FP_SHIFT);
277 * precompute probability denominator
278 * probd = (2 * (TH_MAX-TH_MIN) / pmax) in fixed-point
280 prec->probd = (2 * (prec->th_max - prec->th_min)
281 * prec->inv_pmax) << FP_SHIFT;
283 microtime(&prec->last);
290 rio_destroy(rio_t *rp)
292 wtab_destroy(rp->rio_wtab);
297 rio_getstats(rio_t *rp, struct redstats *sp)
301 for (i = 0; i < RIO_NDROPPREC; i++) {
302 bcopy(&rp->q_stats[i], sp, sizeof(struct redstats));
303 sp->q_avg = rp->rio_precstate[i].avg >> rp->rio_wshift;
308 #if (RIO_NDROPPREC == 3)
310 * internally, a drop precedence value is converted to an index
314 dscp2index(u_int8_t dscp)
316 int dpindex = dscp & AF_DROPPRECMASK;
320 return ((dpindex >> 3) - 1);
326 * kludge: when a packet is dequeued, we need to know its drop precedence
327 * in order to keep the queue length of each drop precedence.
328 * use m_pkthdr.rcvif to pass this info.
330 #define RIOM_SET_PRECINDEX(m, idx) \
331 do { (m)->m_pkthdr.rcvif = (void *)((long)(idx)); } while (0)
332 #define RIOM_GET_PRECINDEX(m) \
333 ({ long idx; idx = (long)((m)->m_pkthdr.rcvif); \
334 (m)->m_pkthdr.rcvif = NULL; idx; })
338 rio_addq(rio_t *rp, class_queue_t *q, struct mbuf *m,
339 struct altq_pktattr *pktattr)
342 u_int8_t dsfield, odsfield;
343 int dpindex, i, n, t;
345 struct dropprec_state *prec;
347 dsfield = odsfield = read_dsfield(m, pktattr);
348 dpindex = dscp2index(dsfield);
351 * update avg of the precedence states whose drop precedence
352 * is larger than or equal to the drop precedence of the packet
355 for (i = dpindex; i < RIO_NDROPPREC; i++) {
356 prec = &rp->rio_precstate[i];
362 t = (now.tv_sec - prec->last.tv_sec);
367 (now.tv_usec - prec->last.tv_usec);
368 n = t / rp->rio_pkttime;
369 /* calculate (avg = (1 - Wq)^n * avg) */
371 avg = (avg >> FP_SHIFT) *
372 pow_w(rp->rio_wtab, n);
376 /* run estimator. (avg is scaled by WEIGHT in fixed-point) */
377 avg += (prec->qlen << FP_SHIFT) - (avg >> rp->rio_wshift);
378 prec->avg = avg; /* save the new value */
380 * count keeps a tally of arriving traffic that has not
386 prec = &rp->rio_precstate[dpindex];
389 /* see if we drop early */
390 droptype = DTYPE_NODROP;
391 if (avg >= prec->th_min_s && prec->qlen > 1) {
392 if (avg >= prec->th_max_s) {
393 /* avg >= th_max: forced drop */
394 droptype = DTYPE_FORCED;
395 } else if (prec->old == 0) {
396 /* first exceeds th_min */
399 } else if (drop_early((avg - prec->th_min_s) >> rp->rio_wshift,
400 prec->probd, prec->count)) {
401 /* unforced drop by red */
402 droptype = DTYPE_EARLY;
410 * if the queue length hits the hard limit, it's a forced drop.
412 if (droptype == DTYPE_NODROP && qlen(q) >= qlimit(q))
413 droptype = DTYPE_FORCED;
415 if (droptype != DTYPE_NODROP) {
416 /* always drop incoming packet (as opposed to randomdrop) */
417 for (i = dpindex; i < RIO_NDROPPREC; i++)
418 rp->rio_precstate[i].count = 0;
420 if (droptype == DTYPE_EARLY)
421 rp->q_stats[dpindex].drop_unforced++;
423 rp->q_stats[dpindex].drop_forced++;
424 PKTCNTR_ADD(&rp->q_stats[dpindex].drop_cnt, m_pktlen(m));
430 for (i = dpindex; i < RIO_NDROPPREC; i++)
431 rp->rio_precstate[i].qlen++;
433 /* save drop precedence index in mbuf hdr */
434 RIOM_SET_PRECINDEX(m, dpindex);
436 if (rp->rio_flags & RIOF_CLEARDSCP)
437 dsfield &= ~DSCP_MASK;
439 if (dsfield != odsfield)
440 write_dsfield(m, pktattr, dsfield);
445 PKTCNTR_ADD(&rp->q_stats[dpindex].xmit_cnt, m_pktlen(m));
451 rio_getq(rio_t *rp, class_queue_t *q)
456 if ((m = _getq(q)) == NULL)
459 dpindex = RIOM_GET_PRECINDEX(m);
460 for (i = dpindex; i < RIO_NDROPPREC; i++) {
461 if (--rp->rio_precstate[i].qlen == 0) {
462 if (rp->rio_precstate[i].idle == 0) {
463 rp->rio_precstate[i].idle = 1;
464 microtime(&rp->rio_precstate[i].last);
473 rioopen(dev, flag, fmt, p)
476 #if (__FreeBSD_version > 500000)
482 /* everything will be done when the queueing scheme is attached. */
487 rioclose(dev, flag, fmt, p)
490 #if (__FreeBSD_version > 500000)
499 while ((rqp = rio_list) != NULL) {
501 err = rio_detach(rqp);
502 if (err != 0 && error == 0)
510 rioioctl(dev, cmd, addr, flag, p)
515 #if (__FreeBSD_version > 500000)
522 struct rio_interface *ifacep;
526 /* check super-user privilege */
531 #if (__FreeBSD_version > 700000)
532 if ((error = priv_check(p, PRIV_ALTQ_MANAGE)) != 0)
534 #elsif (__FreeBSD_version > 400000)
535 if ((error = suser(p)) != 0)
538 if ((error = suser(p->p_ucred, &p->p_acflag)) != 0)
547 ifacep = (struct rio_interface *)addr;
548 if ((rqp = altq_lookup(ifacep->rio_ifname, ALTQT_RIO)) == NULL) {
552 error = altq_enable(rqp->rq_ifq);
556 ifacep = (struct rio_interface *)addr;
557 if ((rqp = altq_lookup(ifacep->rio_ifname, ALTQT_RIO)) == NULL) {
561 error = altq_disable(rqp->rq_ifq);
565 ifp = ifunit(((struct rio_interface *)addr)->rio_ifname);
571 /* allocate and initialize rio_queue_t */
572 rqp = malloc(sizeof(rio_queue_t), M_DEVBUF, M_WAITOK);
577 bzero(rqp, sizeof(rio_queue_t));
579 rqp->rq_q = malloc(sizeof(class_queue_t),
581 if (rqp->rq_q == NULL) {
586 bzero(rqp->rq_q, sizeof(class_queue_t));
588 rqp->rq_rio = rio_alloc(0, NULL, 0, 0);
589 if (rqp->rq_rio == NULL) {
590 free(rqp->rq_q, M_DEVBUF);
596 rqp->rq_ifq = &ifp->if_snd;
597 qtail(rqp->rq_q) = NULL;
599 qlimit(rqp->rq_q) = RIO_LIMIT;
600 qtype(rqp->rq_q) = Q_RIO;
603 * set RIO to this ifnet structure.
605 error = altq_attach(rqp->rq_ifq, ALTQT_RIO, rqp,
606 rio_enqueue, rio_dequeue, rio_request,
609 rio_destroy(rqp->rq_rio);
610 free(rqp->rq_q, M_DEVBUF);
615 /* add this state to the rio list */
616 rqp->rq_next = rio_list;
621 ifacep = (struct rio_interface *)addr;
622 if ((rqp = altq_lookup(ifacep->rio_ifname, ALTQT_RIO)) == NULL) {
626 error = rio_detach(rqp);
631 struct rio_stats *q_stats;
635 q_stats = (struct rio_stats *)addr;
636 if ((rqp = altq_lookup(q_stats->iface.rio_ifname,
637 ALTQT_RIO)) == NULL) {
644 q_stats->q_limit = qlimit(rqp->rq_q);
645 q_stats->weight = rp->rio_weight;
646 q_stats->flags = rp->rio_flags;
648 for (i = 0; i < RIO_NDROPPREC; i++) {
649 q_stats->q_len[i] = rp->rio_precstate[i].qlen;
650 bcopy(&rp->q_stats[i], &q_stats->q_stats[i],
651 sizeof(struct redstats));
652 q_stats->q_stats[i].q_avg =
653 rp->rio_precstate[i].avg >> rp->rio_wshift;
655 q_stats->q_params[i].inv_pmax
656 = rp->rio_precstate[i].inv_pmax;
657 q_stats->q_params[i].th_min
658 = rp->rio_precstate[i].th_min;
659 q_stats->q_params[i].th_max
660 = rp->rio_precstate[i].th_max;
662 } while (/*CONSTCOND*/ 0);
671 fc = (struct rio_conf *)addr;
672 if ((rqp = altq_lookup(fc->iface.rio_ifname,
673 ALTQT_RIO)) == NULL) {
678 new = rio_alloc(fc->rio_weight, &fc->q_params[0],
679 fc->rio_flags, fc->rio_pkttime);
691 limit = fc->rio_limit;
692 if (limit < fc->q_params[RIO_NDROPPREC-1].th_max)
693 limit = fc->q_params[RIO_NDROPPREC-1].th_max;
694 qlimit(rqp->rq_q) = limit;
696 rio_destroy(rqp->rq_rio);
701 /* write back new values */
702 fc->rio_limit = limit;
703 for (i = 0; i < RIO_NDROPPREC; i++) {
704 fc->q_params[i].inv_pmax =
705 rqp->rq_rio->rio_precstate[i].inv_pmax;
706 fc->q_params[i].th_min =
707 rqp->rq_rio->rio_precstate[i].th_min;
708 fc->q_params[i].th_max =
709 rqp->rq_rio->rio_precstate[i].th_max;
711 } while (/*CONSTCOND*/ 0);
714 case RIO_SETDEFAULTS:
716 struct redparams *rp;
719 rp = (struct redparams *)addr;
720 for (i = 0; i < RIO_NDROPPREC; i++)
721 default_rio_params[i] = rp[i];
722 } while (/*CONSTCOND*/ 0);
740 if (ALTQ_IS_ENABLED(rqp->rq_ifq))
741 altq_disable(rqp->rq_ifq);
743 if ((error = altq_detach(rqp->rq_ifq)))
747 rio_list = rqp->rq_next;
749 for (tmp = rio_list; tmp != NULL; tmp = tmp->rq_next)
750 if (tmp->rq_next == rqp) {
751 tmp->rq_next = rqp->rq_next;
755 printf("rio_detach: no state found in rio_list!\n");
758 rio_destroy(rqp->rq_rio);
759 free(rqp->rq_q, M_DEVBUF);
765 * rio support routines
768 rio_request(ifq, req, arg)
773 rio_queue_t *rqp = (rio_queue_t *)ifq->altq_disc;
775 IFQ_LOCK_ASSERT(ifq);
780 if (ALTQ_IS_ENABLED(ifq))
790 * returns: 0 when successfully queued.
791 * ENOBUFS when drop occurs.
794 rio_enqueue(ifq, m, pktattr)
797 struct altq_pktattr *pktattr;
799 rio_queue_t *rqp = (rio_queue_t *)ifq->altq_disc;
802 IFQ_LOCK_ASSERT(ifq);
804 if (rio_addq(rqp->rq_rio, rqp->rq_q, m, pktattr) == 0)
813 * must be called in splimp.
815 * returns: mbuf dequeued.
816 * NULL when no packet is available in the queue.
824 rio_queue_t *rqp = (rio_queue_t *)ifq->altq_disc;
825 struct mbuf *m = NULL;
827 IFQ_LOCK_ASSERT(ifq);
829 if (op == ALTDQ_POLL)
830 return qhead(rqp->rq_q);
832 m = rio_getq(rqp->rq_rio, rqp->rq_q);
840 static struct altqsw rio_sw =
841 {"rio", rioopen, rioclose, rioioctl};
843 ALTQ_MODULE(altq_rio, ALTQT_RIO, &rio_sw);
844 MODULE_VERSION(altq_rio, 1);
845 MODULE_DEPEND(altq_rio, altq_red, 1, 1, 1);
847 #endif /* KLD_MODULE */
848 #endif /* ALTQ3_COMPAT */
850 #endif /* ALTQ_RIO */