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>
61 #define PRIQ_SUBQ_INDEX ALTQ_SUBQ_INDEX_DEFAULT
62 #define PRIQ_LOCK(ifq) \
63 ALTQ_SQ_LOCK(&(ifq)->altq_subq[PRIQ_SUBQ_INDEX])
64 #define PRIQ_UNLOCK(ifq) \
65 ALTQ_SQ_UNLOCK(&(ifq)->altq_subq[PRIQ_SUBQ_INDEX])
70 static int priq_clear_interface(struct priq_if *);
71 static int priq_request(struct ifaltq_subque *, int, void *);
72 static void priq_purge(struct priq_if *);
73 static struct priq_class *priq_class_create(struct priq_if *, int, int, int, int);
74 static int priq_class_destroy(struct priq_class *);
75 static int priq_enqueue(struct ifaltq_subque *, struct mbuf *,
76 struct altq_pktattr *);
77 static struct mbuf *priq_dequeue(struct ifaltq_subque *, int);
79 static int priq_addq(struct priq_class *, struct mbuf *);
80 static struct mbuf *priq_getq(struct priq_class *);
81 static struct mbuf *priq_pollq(struct priq_class *);
82 static void priq_purgeq(struct priq_class *);
84 static void get_class_stats(struct priq_classstats *, struct priq_class *);
85 static struct priq_class *clh_to_clp(struct priq_if *, uint32_t);
88 priq_pfattach(struct pf_altq *a, struct ifaltq *ifq)
90 return altq_attach(ifq, ALTQT_PRIQ, a->altq_disc, ifq_mapsubq_default,
91 priq_enqueue, priq_dequeue, priq_request, NULL, NULL);
95 priq_add_altq(struct pf_altq *a)
102 if ((ifp = ifunit(a->ifname)) == NULL) {
106 if (!ifq_is_ready(&ifp->if_snd)) {
111 pif = kmalloc(sizeof(*pif), M_ALTQ, M_WAITOK | M_ZERO);
112 pif->pif_bandwidth = a->ifbandwidth;
113 pif->pif_maxpri = -1;
114 pif->pif_ifq = &ifp->if_snd;
115 ifq_purge_all(&ifp->if_snd);
119 /* keep the state in pf_altq */
126 priq_remove_altq(struct pf_altq *a)
130 if ((pif = a->altq_disc) == NULL)
134 priq_clear_interface(pif);
141 priq_add_queue_locked(struct pf_altq *a, struct priq_if *pif)
143 struct priq_class *cl;
145 KKASSERT(a->priority < PRIQ_MAXPRI);
146 KKASSERT(a->qid != 0);
148 if (pif->pif_classes[a->priority] != NULL)
150 if (clh_to_clp(pif, a->qid) != NULL)
153 cl = priq_class_create(pif, a->priority, a->qlimit,
154 a->pq_u.priq_opts.flags, a->qid);
162 priq_add_queue(struct pf_altq *a)
168 /* check parameters */
169 if (a->priority >= PRIQ_MAXPRI)
174 /* XXX not MP safe */
175 if ((pif = a->altq_disc) == NULL)
180 error = priq_add_queue_locked(a, pif);
187 priq_remove_queue_locked(struct pf_altq *a, struct priq_if *pif)
189 struct priq_class *cl;
191 if ((cl = clh_to_clp(pif, a->qid)) == NULL)
194 return (priq_class_destroy(cl));
198 priq_remove_queue(struct pf_altq *a)
204 /* XXX not MF safe */
205 if ((pif = a->altq_disc) == NULL)
210 error = priq_remove_queue_locked(a, pif);
217 priq_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
220 struct priq_class *cl;
221 struct priq_classstats stats;
225 if (*nbytes < sizeof(stats))
230 /* XXX not MP safe */
231 if ((pif = altq_lookup(a->ifname, ALTQT_PRIQ)) == NULL) {
239 if ((cl = clh_to_clp(pif, a->qid)) == NULL) {
245 get_class_stats(&stats, cl);
251 if ((error = copyout((caddr_t)&stats, ubuf, sizeof(stats))) != 0)
253 *nbytes = sizeof(stats);
258 * bring the interface back to the initial state by discarding
259 * all the filters and classes.
262 priq_clear_interface(struct priq_if *pif)
264 struct priq_class *cl;
267 /* clear out the classes */
268 for (pri = 0; pri <= pif->pif_maxpri; pri++) {
269 if ((cl = pif->pif_classes[pri]) != NULL)
270 priq_class_destroy(cl);
277 priq_request(struct ifaltq_subque *ifsq, int req, void *arg)
279 struct ifaltq *ifq = ifsq->ifsq_altq;
280 struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
285 if (ifsq_get_index(ifsq) == PRIQ_SUBQ_INDEX) {
289 * Race happened, the unrelated subqueue was
290 * picked during the packet scheduler transition.
292 ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
300 /* discard all the queued packets on the interface */
302 priq_purge(struct priq_if *pif)
304 struct priq_class *cl;
307 for (pri = 0; pri <= pif->pif_maxpri; pri++) {
308 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q))
311 if (ifq_is_enabled(pif->pif_ifq))
312 ALTQ_SQ_CNTR_RESET(&pif->pif_ifq->altq_subq[PRIQ_SUBQ_INDEX]);
315 static struct priq_class *
316 priq_class_create(struct priq_if *pif, int pri, int qlimit, int flags, int qid)
318 struct priq_class *cl;
321 if (flags & PRCF_RED) {
323 kprintf("priq_class_create: RED not configured for PRIQ!\n");
329 if ((cl = pif->pif_classes[pri]) != NULL) {
330 /* modify the class instead of creating a new one */
332 if (!qempty(cl->cl_q))
336 if (q_is_rio(cl->cl_q))
337 rio_destroy((rio_t *)cl->cl_red);
340 if (q_is_red(cl->cl_q))
341 red_destroy(cl->cl_red);
344 cl = kmalloc(sizeof(*cl), M_ALTQ, M_WAITOK | M_ZERO);
345 cl->cl_q = kmalloc(sizeof(*cl->cl_q), M_ALTQ, M_WAITOK | M_ZERO);
348 pif->pif_classes[pri] = cl;
349 if (flags & PRCF_DEFAULTCLASS)
350 pif->pif_default = cl;
352 qlimit = 50; /* use default */
353 qlimit(cl->cl_q) = qlimit;
354 qtype(cl->cl_q) = Q_DROPTAIL;
356 cl->cl_flags = flags;
358 if (pri > pif->pif_maxpri)
359 pif->pif_maxpri = pri;
364 if (flags & (PRCF_RED|PRCF_RIO)) {
365 int red_flags, red_pkttime;
368 if (flags & PRCF_ECN)
369 red_flags |= REDF_ECN;
371 if (flags & PRCF_CLEARDSCP)
372 red_flags |= RIOF_CLEARDSCP;
374 if (pif->pif_bandwidth < 8)
375 red_pkttime = 1000 * 1000 * 1000; /* 1 sec */
377 red_pkttime = (int64_t)pif->pif_ifq->altq_ifp->if_mtu
378 * 1000 * 1000 * 1000 / (pif->pif_bandwidth / 8);
380 if (flags & PRCF_RIO) {
381 cl->cl_red = (red_t *)rio_alloc(0, NULL,
382 red_flags, red_pkttime);
383 if (cl->cl_red != NULL)
384 qtype(cl->cl_q) = Q_RIO;
387 if (flags & PRCF_RED) {
388 cl->cl_red = red_alloc(0, 0,
389 qlimit(cl->cl_q) * 10/100,
390 qlimit(cl->cl_q) * 30/100,
391 red_flags, red_pkttime);
392 if (cl->cl_red != NULL)
393 qtype(cl->cl_q) = Q_RED;
396 #endif /* ALTQ_RED */
402 priq_class_destroy(struct priq_class *cl)
409 if (!qempty(cl->cl_q))
413 pif->pif_classes[cl->cl_pri] = NULL;
414 if (pif->pif_maxpri == cl->cl_pri) {
415 for (pri = cl->cl_pri; pri >= 0; pri--)
416 if (pif->pif_classes[pri] != NULL) {
417 pif->pif_maxpri = pri;
421 pif->pif_maxpri = -1;
425 if (cl->cl_red != NULL) {
427 if (q_is_rio(cl->cl_q))
428 rio_destroy((rio_t *)cl->cl_red);
431 if (q_is_red(cl->cl_q))
432 red_destroy(cl->cl_red);
435 kfree(cl->cl_q, M_ALTQ);
441 * priq_enqueue is an enqueue function to be registered to
442 * (*ifsq_enqueue) in struct ifaltq_subque.
445 priq_enqueue(struct ifaltq_subque *ifsq, struct mbuf *m,
446 struct altq_pktattr *pktattr)
448 struct ifaltq *ifq = ifsq->ifsq_altq;
449 struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
450 struct priq_class *cl;
454 if (ifsq_get_index(ifsq) != PRIQ_SUBQ_INDEX) {
456 * Race happened, the unrelated subqueue was
457 * picked during the packet scheduler transition.
459 ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
466 /* grab class set by classifier */
468 if (m->m_pkthdr.fw_flags & PF_MBUF_STRUCTURE)
469 cl = clh_to_clp(pif, m->m_pkthdr.pf.qid);
473 cl = pif->pif_default;
480 cl->cl_pktattr = NULL;
482 if (priq_addq(cl, m) != 0) {
483 /* drop occurred. mbuf was freed in priq_addq. */
484 PKTCNTR_ADD(&cl->cl_dropcnt, len);
488 ALTQ_SQ_PKTCNT_INC(ifsq);
496 * priq_dequeue is a dequeue function to be registered to
497 * (*ifsq_dequeue) in struct ifaltq_subque.
499 * note: ALTDQ_POLL returns the next packet without removing the packet
500 * from the queue. ALTDQ_REMOVE is a normal dequeue operation.
503 priq_dequeue(struct ifaltq_subque *ifsq, int op)
505 struct ifaltq *ifq = ifsq->ifsq_altq;
506 struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
507 struct priq_class *cl;
511 if (ifsq_get_index(ifsq) != PRIQ_SUBQ_INDEX) {
513 * Race happened, the unrelated subqueue was
514 * picked during the packet scheduler transition.
516 ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
520 if (ifsq_is_empty(ifsq)) {
521 /* no packet in the queue */
527 for (pri = pif->pif_maxpri; pri >= 0; pri--) {
528 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q)) {
529 if (op == ALTDQ_POLL) {
536 ALTQ_SQ_PKTCNT_DEC(ifsq);
537 if (qempty(cl->cl_q))
539 PKTCNTR_ADD(&cl->cl_xmitcnt, m_pktlen(m));
549 priq_addq(struct priq_class *cl, struct mbuf *m)
552 if (q_is_rio(cl->cl_q))
553 return rio_addq((rio_t *)cl->cl_red, cl->cl_q, m,
557 if (q_is_red(cl->cl_q))
558 return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
560 if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
565 if (cl->cl_flags & PRCF_CLEARDSCP)
566 write_dsfield(m, cl->cl_pktattr, 0);
574 priq_getq(struct priq_class *cl)
577 if (q_is_rio(cl->cl_q))
578 return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
581 if (q_is_red(cl->cl_q))
582 return red_getq(cl->cl_red, cl->cl_q);
584 return _getq(cl->cl_q);
588 priq_pollq(struct priq_class *cl)
590 return qhead(cl->cl_q);
594 priq_purgeq(struct priq_class *cl)
598 if (qempty(cl->cl_q))
601 while ((m = _getq(cl->cl_q)) != NULL) {
602 PKTCNTR_ADD(&cl->cl_dropcnt, m_pktlen(m));
605 KKASSERT(qlen(cl->cl_q) == 0);
609 get_class_stats(struct priq_classstats *sp, struct priq_class *cl)
611 sp->class_handle = cl->cl_handle;
612 sp->qlength = qlen(cl->cl_q);
613 sp->qlimit = qlimit(cl->cl_q);
614 sp->period = cl->cl_period;
615 sp->xmitcnt = cl->cl_xmitcnt;
616 sp->dropcnt = cl->cl_dropcnt;
618 sp->qtype = qtype(cl->cl_q);
620 if (q_is_red(cl->cl_q))
621 red_getstats(cl->cl_red, &sp->red[0]);
624 if (q_is_rio(cl->cl_q))
625 rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
629 /* convert a class handle to the corresponding class pointer */
630 static struct priq_class *
631 clh_to_clp(struct priq_if *pif, uint32_t chandle)
633 struct priq_class *cl;
639 for (idx = pif->pif_maxpri; idx >= 0; idx--)
640 if ((cl = pif->pif_classes[idx]) != NULL &&
641 cl->cl_handle == chandle)
647 #endif /* ALTQ_PRIQ */