1 /* $KAME: altq_priq.c,v 1.12 2004/04/17 10:54:48 kjc Exp $ */
2 /* $DragonFly: src/sys/net/altq/altq_priq.c,v 1.9 2008/05/14 11:59:23 sephe Exp $ */
5 * Copyright (C) 2000-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
35 #include "opt_inet6.h"
37 #ifdef ALTQ_PRIQ /* priq is enabled by ALTQ_PRIQ option in opt_altq.h */
39 #include <sys/param.h>
40 #include <sys/malloc.h>
42 #include <sys/socket.h>
43 #include <sys/sockio.h>
44 #include <sys/systm.h>
46 #include <sys/errno.h>
47 #include <sys/kernel.h>
48 #include <sys/queue.h>
49 #include <sys/thread.h>
52 #include <net/ifq_var.h>
53 #include <netinet/in.h>
55 #include <net/pf/pfvar.h>
56 #include <net/altq/altq.h>
57 #include <net/altq/altq_priq.h>
59 #include <sys/thread2.h>
64 static int priq_clear_interface(struct priq_if *);
65 static int priq_request(struct ifaltq *, int, void *);
66 static void priq_purge(struct priq_if *);
67 static struct priq_class *priq_class_create(struct priq_if *, int, int, int, int);
68 static int priq_class_destroy(struct priq_class *);
69 static int priq_enqueue(struct ifaltq *, struct mbuf *, struct altq_pktattr *);
70 static struct mbuf *priq_dequeue(struct ifaltq *, struct mbuf *, int);
72 static int priq_addq(struct priq_class *, struct mbuf *);
73 static struct mbuf *priq_getq(struct priq_class *);
74 static struct mbuf *priq_pollq(struct priq_class *);
75 static void priq_purgeq(struct priq_class *);
77 static void get_class_stats(struct priq_classstats *, struct priq_class *);
78 static struct priq_class *clh_to_clp(struct priq_if *, uint32_t);
81 priq_pfattach(struct pf_altq *a, struct ifaltq *ifq)
83 return altq_attach(ifq, ALTQT_PRIQ, a->altq_disc,
84 priq_enqueue, priq_dequeue, priq_request, NULL, NULL);
88 priq_add_altq(struct pf_altq *a)
93 if ((ifp = ifunit(a->ifname)) == NULL)
95 if (!ifq_is_ready(&ifp->if_snd))
98 pif = kmalloc(sizeof(*pif), M_ALTQ, M_WAITOK | M_ZERO);
99 pif->pif_bandwidth = a->ifbandwidth;
100 pif->pif_maxpri = -1;
101 pif->pif_ifq = &ifp->if_snd;
102 ifq_purge(&ifp->if_snd);
104 /* keep the state in pf_altq */
111 priq_remove_altq(struct pf_altq *a)
115 if ((pif = a->altq_disc) == NULL)
119 priq_clear_interface(pif);
126 priq_add_queue_locked(struct pf_altq *a, struct priq_if *pif)
128 struct priq_class *cl;
130 KKASSERT(a->priority < PRIQ_MAXPRI);
131 KKASSERT(a->qid != 0);
133 if (pif->pif_classes[a->priority] != NULL)
135 if (clh_to_clp(pif, a->qid) != NULL)
138 cl = priq_class_create(pif, a->priority, a->qlimit,
139 a->pq_u.priq_opts.flags, a->qid);
147 priq_add_queue(struct pf_altq *a)
153 /* check parameters */
154 if (a->priority >= PRIQ_MAXPRI)
159 /* XXX not MP safe */
160 if ((pif = a->altq_disc) == NULL)
165 error = priq_add_queue_locked(a, pif);
172 priq_remove_queue_locked(struct pf_altq *a, struct priq_if *pif)
174 struct priq_class *cl;
176 if ((cl = clh_to_clp(pif, a->qid)) == NULL)
179 return (priq_class_destroy(cl));
183 priq_remove_queue(struct pf_altq *a)
189 /* XXX not MF safe */
190 if ((pif = a->altq_disc) == NULL)
195 error = priq_remove_queue_locked(a, pif);
202 priq_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
205 struct priq_class *cl;
206 struct priq_classstats stats;
210 if (*nbytes < sizeof(stats))
213 /* XXX not MP safe */
214 if ((pif = altq_lookup(a->ifname, ALTQT_PRIQ)) == NULL)
220 if ((cl = clh_to_clp(pif, a->qid)) == NULL) {
225 get_class_stats(&stats, cl);
229 if ((error = copyout((caddr_t)&stats, ubuf, sizeof(stats))) != 0)
231 *nbytes = sizeof(stats);
236 * bring the interface back to the initial state by discarding
237 * all the filters and classes.
240 priq_clear_interface(struct priq_if *pif)
242 struct priq_class *cl;
245 /* clear out the classes */
246 for (pri = 0; pri <= pif->pif_maxpri; pri++) {
247 if ((cl = pif->pif_classes[pri]) != NULL)
248 priq_class_destroy(cl);
255 priq_request(struct ifaltq *ifq, int req, void *arg)
257 struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
269 /* discard all the queued packets on the interface */
271 priq_purge(struct priq_if *pif)
273 struct priq_class *cl;
276 for (pri = 0; pri <= pif->pif_maxpri; pri++) {
277 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q))
280 if (ifq_is_enabled(pif->pif_ifq))
281 pif->pif_ifq->ifq_len = 0;
284 static struct priq_class *
285 priq_class_create(struct priq_if *pif, int pri, int qlimit, int flags, int qid)
287 struct priq_class *cl;
290 if (flags & PRCF_RED) {
292 kprintf("priq_class_create: RED not configured for PRIQ!\n");
298 if ((cl = pif->pif_classes[pri]) != NULL) {
299 /* modify the class instead of creating a new one */
301 if (!qempty(cl->cl_q))
305 if (q_is_rio(cl->cl_q))
306 rio_destroy((rio_t *)cl->cl_red);
309 if (q_is_red(cl->cl_q))
310 red_destroy(cl->cl_red);
313 cl = kmalloc(sizeof(*cl), M_ALTQ, M_WAITOK | M_ZERO);
314 cl->cl_q = kmalloc(sizeof(*cl->cl_q), M_ALTQ, M_WAITOK | M_ZERO);
317 pif->pif_classes[pri] = cl;
318 if (flags & PRCF_DEFAULTCLASS)
319 pif->pif_default = cl;
321 qlimit = 50; /* use default */
322 qlimit(cl->cl_q) = qlimit;
323 qtype(cl->cl_q) = Q_DROPTAIL;
325 cl->cl_flags = flags;
327 if (pri > pif->pif_maxpri)
328 pif->pif_maxpri = pri;
333 if (flags & (PRCF_RED|PRCF_RIO)) {
334 int red_flags, red_pkttime;
337 if (flags & PRCF_ECN)
338 red_flags |= REDF_ECN;
340 if (flags & PRCF_CLEARDSCP)
341 red_flags |= RIOF_CLEARDSCP;
343 if (pif->pif_bandwidth < 8)
344 red_pkttime = 1000 * 1000 * 1000; /* 1 sec */
346 red_pkttime = (int64_t)pif->pif_ifq->altq_ifp->if_mtu
347 * 1000 * 1000 * 1000 / (pif->pif_bandwidth / 8);
349 if (flags & PRCF_RIO) {
350 cl->cl_red = (red_t *)rio_alloc(0, NULL,
351 red_flags, red_pkttime);
352 if (cl->cl_red != NULL)
353 qtype(cl->cl_q) = Q_RIO;
356 if (flags & PRCF_RED) {
357 cl->cl_red = red_alloc(0, 0,
358 qlimit(cl->cl_q) * 10/100,
359 qlimit(cl->cl_q) * 30/100,
360 red_flags, red_pkttime);
361 if (cl->cl_red != NULL)
362 qtype(cl->cl_q) = Q_RED;
365 #endif /* ALTQ_RED */
371 priq_class_destroy(struct priq_class *cl)
378 if (!qempty(cl->cl_q))
382 pif->pif_classes[cl->cl_pri] = NULL;
383 if (pif->pif_maxpri == cl->cl_pri) {
384 for (pri = cl->cl_pri; pri >= 0; pri--)
385 if (pif->pif_classes[pri] != NULL) {
386 pif->pif_maxpri = pri;
390 pif->pif_maxpri = -1;
394 if (cl->cl_red != NULL) {
396 if (q_is_rio(cl->cl_q))
397 rio_destroy((rio_t *)cl->cl_red);
400 if (q_is_red(cl->cl_q))
401 red_destroy(cl->cl_red);
404 kfree(cl->cl_q, M_ALTQ);
410 * priq_enqueue is an enqueue function to be registered to
411 * (*altq_enqueue) in struct ifaltq.
414 priq_enqueue(struct ifaltq *ifq, struct mbuf *m, struct altq_pktattr *pktattr)
416 struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
417 struct priq_class *cl;
423 /* grab class set by classifier */
424 if ((m->m_flags & M_PKTHDR) == 0) {
425 /* should not happen */
426 if_printf(ifq->altq_ifp, "altq: packet does not have pkthdr\n");
432 if (m->m_pkthdr.fw_flags & PF_MBUF_STRUCTURE)
433 cl = clh_to_clp(pif, m->m_pkthdr.pf.qid);
437 cl = pif->pif_default;
444 cl->cl_pktattr = NULL;
446 if (priq_addq(cl, m) != 0) {
447 /* drop occurred. mbuf was freed in priq_addq. */
448 PKTCNTR_ADD(&cl->cl_dropcnt, len);
460 * priq_dequeue is a dequeue function to be registered to
461 * (*altq_dequeue) in struct ifaltq.
463 * note: ALTDQ_POLL returns the next packet without removing the packet
464 * from the queue. ALTDQ_REMOVE is a normal dequeue operation.
465 * ALTDQ_REMOVE must return the same packet if called immediately
469 priq_dequeue(struct ifaltq *ifq, struct mbuf *mpolled, int op)
471 struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
472 struct priq_class *cl;
476 if (ifq_is_empty(ifq)) {
477 /* no packet in the queue */
478 KKASSERT(mpolled == NULL);
484 for (pri = pif->pif_maxpri; pri >= 0; pri--) {
485 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q)) {
486 if (op == ALTDQ_POLL) {
494 if (qempty(cl->cl_q))
496 PKTCNTR_ADD(&cl->cl_xmitcnt, m_pktlen(m));
502 KKASSERT(mpolled == NULL || mpolled == m);
507 priq_addq(struct priq_class *cl, struct mbuf *m)
510 if (q_is_rio(cl->cl_q))
511 return rio_addq((rio_t *)cl->cl_red, cl->cl_q, m,
515 if (q_is_red(cl->cl_q))
516 return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
518 if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
523 if (cl->cl_flags & PRCF_CLEARDSCP)
524 write_dsfield(m, cl->cl_pktattr, 0);
532 priq_getq(struct priq_class *cl)
535 if (q_is_rio(cl->cl_q))
536 return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
539 if (q_is_red(cl->cl_q))
540 return red_getq(cl->cl_red, cl->cl_q);
542 return _getq(cl->cl_q);
546 priq_pollq(struct priq_class *cl)
548 return qhead(cl->cl_q);
552 priq_purgeq(struct priq_class *cl)
556 if (qempty(cl->cl_q))
559 while ((m = _getq(cl->cl_q)) != NULL) {
560 PKTCNTR_ADD(&cl->cl_dropcnt, m_pktlen(m));
563 KKASSERT(qlen(cl->cl_q) == 0);
567 get_class_stats(struct priq_classstats *sp, struct priq_class *cl)
569 sp->class_handle = cl->cl_handle;
570 sp->qlength = qlen(cl->cl_q);
571 sp->qlimit = qlimit(cl->cl_q);
572 sp->period = cl->cl_period;
573 sp->xmitcnt = cl->cl_xmitcnt;
574 sp->dropcnt = cl->cl_dropcnt;
576 sp->qtype = qtype(cl->cl_q);
578 if (q_is_red(cl->cl_q))
579 red_getstats(cl->cl_red, &sp->red[0]);
582 if (q_is_rio(cl->cl_q))
583 rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
587 /* convert a class handle to the corresponding class pointer */
588 static struct priq_class *
589 clh_to_clp(struct priq_if *pif, uint32_t chandle)
591 struct priq_class *cl;
597 for (idx = pif->pif_maxpri; idx >= 0; idx--)
598 if ((cl = pif->pif_classes[idx]) != NULL &&
599 cl->cl_handle == chandle)
605 #endif /* ALTQ_PRIQ */