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.8 2006/12/22 23:44:55 swildner 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
)
86 if ((ifp
= ifunit(a
->ifname
)) == NULL
|| a
->altq_disc
== NULL
)
89 error
= altq_attach(&ifp
->if_snd
, ALTQT_PRIQ
, a
->altq_disc
,
90 priq_enqueue
, priq_dequeue
, priq_request
, NULL
, NULL
);
96 priq_add_altq(struct pf_altq
*a
)
101 if ((ifp
= ifunit(a
->ifname
)) == NULL
)
103 if (!ifq_is_ready(&ifp
->if_snd
))
106 pif
= kmalloc(sizeof(*pif
), M_ALTQ
, M_WAITOK
| M_ZERO
);
107 pif
->pif_bandwidth
= a
->ifbandwidth
;
108 pif
->pif_maxpri
= -1;
109 pif
->pif_ifq
= &ifp
->if_snd
;
110 ifq_purge(&ifp
->if_snd
);
112 /* keep the state in pf_altq */
119 priq_remove_altq(struct pf_altq
*a
)
123 if ((pif
= a
->altq_disc
) == NULL
)
127 priq_clear_interface(pif
);
134 priq_add_queue(struct pf_altq
*a
)
137 struct priq_class
*cl
;
139 if ((pif
= a
->altq_disc
) == NULL
)
142 /* check parameters */
143 if (a
->priority
>= PRIQ_MAXPRI
)
147 if (pif
->pif_classes
[a
->priority
] != NULL
)
149 if (clh_to_clp(pif
, a
->qid
) != NULL
)
152 cl
= priq_class_create(pif
, a
->priority
, a
->qlimit
,
153 a
->pq_u
.priq_opts
.flags
, a
->qid
);
161 priq_remove_queue(struct pf_altq
*a
)
164 struct priq_class
*cl
;
166 if ((pif
= a
->altq_disc
) == NULL
)
169 if ((cl
= clh_to_clp(pif
, a
->qid
)) == NULL
)
172 return (priq_class_destroy(cl
));
176 priq_getqstats(struct pf_altq
*a
, void *ubuf
, int *nbytes
)
179 struct priq_class
*cl
;
180 struct priq_classstats stats
;
183 if ((pif
= altq_lookup(a
->ifname
, ALTQT_PRIQ
)) == NULL
)
186 if ((cl
= clh_to_clp(pif
, a
->qid
)) == NULL
)
189 if (*nbytes
< sizeof(stats
))
192 get_class_stats(&stats
, cl
);
194 if ((error
= copyout((caddr_t
)&stats
, ubuf
, sizeof(stats
))) != 0)
196 *nbytes
= sizeof(stats
);
201 * bring the interface back to the initial state by discarding
202 * all the filters and classes.
205 priq_clear_interface(struct priq_if
*pif
)
207 struct priq_class
*cl
;
210 /* clear out the classes */
211 for (pri
= 0; pri
<= pif
->pif_maxpri
; pri
++) {
212 if ((cl
= pif
->pif_classes
[pri
]) != NULL
)
213 priq_class_destroy(cl
);
220 priq_request(struct ifaltq
*ifq
, int req
, void *arg
)
222 struct priq_if
*pif
= (struct priq_if
*)ifq
->altq_disc
;
234 /* discard all the queued packets on the interface */
236 priq_purge(struct priq_if
*pif
)
238 struct priq_class
*cl
;
241 for (pri
= 0; pri
<= pif
->pif_maxpri
; pri
++) {
242 if ((cl
= pif
->pif_classes
[pri
]) != NULL
&& !qempty(cl
->cl_q
))
245 if (ifq_is_enabled(pif
->pif_ifq
))
246 pif
->pif_ifq
->ifq_len
= 0;
249 static struct priq_class
*
250 priq_class_create(struct priq_if
*pif
, int pri
, int qlimit
, int flags
, int qid
)
252 struct priq_class
*cl
;
255 if (flags
& PRCF_RED
) {
257 kprintf("priq_class_create: RED not configured for PRIQ!\n");
263 if ((cl
= pif
->pif_classes
[pri
]) != NULL
) {
264 /* modify the class instead of creating a new one */
266 if (!qempty(cl
->cl_q
))
270 if (q_is_rio(cl
->cl_q
))
271 rio_destroy((rio_t
*)cl
->cl_red
);
274 if (q_is_red(cl
->cl_q
))
275 red_destroy(cl
->cl_red
);
278 cl
= kmalloc(sizeof(*cl
), M_ALTQ
, M_WAITOK
| M_ZERO
);
279 cl
->cl_q
= kmalloc(sizeof(*cl
->cl_q
), M_ALTQ
, M_WAITOK
| M_ZERO
);
282 pif
->pif_classes
[pri
] = cl
;
283 if (flags
& PRCF_DEFAULTCLASS
)
284 pif
->pif_default
= cl
;
286 qlimit
= 50; /* use default */
287 qlimit(cl
->cl_q
) = qlimit
;
288 qtype(cl
->cl_q
) = Q_DROPTAIL
;
290 cl
->cl_flags
= flags
;
292 if (pri
> pif
->pif_maxpri
)
293 pif
->pif_maxpri
= pri
;
298 if (flags
& (PRCF_RED
|PRCF_RIO
)) {
299 int red_flags
, red_pkttime
;
302 if (flags
& PRCF_ECN
)
303 red_flags
|= REDF_ECN
;
305 if (flags
& PRCF_CLEARDSCP
)
306 red_flags
|= RIOF_CLEARDSCP
;
308 if (pif
->pif_bandwidth
< 8)
309 red_pkttime
= 1000 * 1000 * 1000; /* 1 sec */
311 red_pkttime
= (int64_t)pif
->pif_ifq
->altq_ifp
->if_mtu
312 * 1000 * 1000 * 1000 / (pif
->pif_bandwidth
/ 8);
314 if (flags
& PRCF_RIO
) {
315 cl
->cl_red
= (red_t
*)rio_alloc(0, NULL
,
316 red_flags
, red_pkttime
);
317 if (cl
->cl_red
!= NULL
)
318 qtype(cl
->cl_q
) = Q_RIO
;
321 if (flags
& PRCF_RED
) {
322 cl
->cl_red
= red_alloc(0, 0,
323 qlimit(cl
->cl_q
) * 10/100,
324 qlimit(cl
->cl_q
) * 30/100,
325 red_flags
, red_pkttime
);
326 if (cl
->cl_red
!= NULL
)
327 qtype(cl
->cl_q
) = Q_RED
;
330 #endif /* ALTQ_RED */
336 priq_class_destroy(struct priq_class
*cl
)
343 if (!qempty(cl
->cl_q
))
347 pif
->pif_classes
[cl
->cl_pri
] = NULL
;
348 if (pif
->pif_maxpri
== cl
->cl_pri
) {
349 for (pri
= cl
->cl_pri
; pri
>= 0; pri
--)
350 if (pif
->pif_classes
[pri
] != NULL
) {
351 pif
->pif_maxpri
= pri
;
355 pif
->pif_maxpri
= -1;
359 if (cl
->cl_red
!= NULL
) {
361 if (q_is_rio(cl
->cl_q
))
362 rio_destroy((rio_t
*)cl
->cl_red
);
365 if (q_is_red(cl
->cl_q
))
366 red_destroy(cl
->cl_red
);
369 kfree(cl
->cl_q
, M_ALTQ
);
375 * priq_enqueue is an enqueue function to be registered to
376 * (*altq_enqueue) in struct ifaltq.
379 priq_enqueue(struct ifaltq
*ifq
, struct mbuf
*m
, struct altq_pktattr
*pktattr
)
381 struct priq_if
*pif
= (struct priq_if
*)ifq
->altq_disc
;
382 struct priq_class
*cl
;
388 /* grab class set by classifier */
389 if ((m
->m_flags
& M_PKTHDR
) == 0) {
390 /* should not happen */
391 if_printf(ifq
->altq_ifp
, "altq: packet does not have pkthdr\n");
397 if (m
->m_pkthdr
.fw_flags
& ALTQ_MBUF_TAGGED
)
398 cl
= clh_to_clp(pif
, m
->m_pkthdr
.altq_qid
);
402 cl
= pif
->pif_default
;
409 cl
->cl_pktattr
= NULL
;
411 if (priq_addq(cl
, m
) != 0) {
412 /* drop occurred. mbuf was freed in priq_addq. */
413 PKTCNTR_ADD(&cl
->cl_dropcnt
, len
);
425 * priq_dequeue is a dequeue function to be registered to
426 * (*altq_dequeue) in struct ifaltq.
428 * note: ALTDQ_POLL returns the next packet without removing the packet
429 * from the queue. ALTDQ_REMOVE is a normal dequeue operation.
430 * ALTDQ_REMOVE must return the same packet if called immediately
434 priq_dequeue(struct ifaltq
*ifq
, struct mbuf
*mpolled
, int op
)
436 struct priq_if
*pif
= (struct priq_if
*)ifq
->altq_disc
;
437 struct priq_class
*cl
;
441 if (ifq_is_empty(ifq
)) {
442 /* no packet in the queue */
443 KKASSERT(mpolled
== NULL
);
449 for (pri
= pif
->pif_maxpri
; pri
>= 0; pri
--) {
450 if ((cl
= pif
->pif_classes
[pri
]) != NULL
&& !qempty(cl
->cl_q
)) {
451 if (op
== ALTDQ_POLL
) {
459 if (qempty(cl
->cl_q
))
461 PKTCNTR_ADD(&cl
->cl_xmitcnt
, m_pktlen(m
));
467 KKASSERT(mpolled
== NULL
|| mpolled
== m
);
472 priq_addq(struct priq_class
*cl
, struct mbuf
*m
)
475 if (q_is_rio(cl
->cl_q
))
476 return rio_addq((rio_t
*)cl
->cl_red
, cl
->cl_q
, m
,
480 if (q_is_red(cl
->cl_q
))
481 return red_addq(cl
->cl_red
, cl
->cl_q
, m
, cl
->cl_pktattr
);
483 if (qlen(cl
->cl_q
) >= qlimit(cl
->cl_q
)) {
488 if (cl
->cl_flags
& PRCF_CLEARDSCP
)
489 write_dsfield(m
, cl
->cl_pktattr
, 0);
497 priq_getq(struct priq_class
*cl
)
500 if (q_is_rio(cl
->cl_q
))
501 return rio_getq((rio_t
*)cl
->cl_red
, cl
->cl_q
);
504 if (q_is_red(cl
->cl_q
))
505 return red_getq(cl
->cl_red
, cl
->cl_q
);
507 return _getq(cl
->cl_q
);
511 priq_pollq(struct priq_class
*cl
)
513 return qhead(cl
->cl_q
);
517 priq_purgeq(struct priq_class
*cl
)
521 if (qempty(cl
->cl_q
))
524 while ((m
= _getq(cl
->cl_q
)) != NULL
) {
525 PKTCNTR_ADD(&cl
->cl_dropcnt
, m_pktlen(m
));
528 KKASSERT(qlen(cl
->cl_q
) == 0);
532 get_class_stats(struct priq_classstats
*sp
, struct priq_class
*cl
)
534 sp
->class_handle
= cl
->cl_handle
;
535 sp
->qlength
= qlen(cl
->cl_q
);
536 sp
->qlimit
= qlimit(cl
->cl_q
);
537 sp
->period
= cl
->cl_period
;
538 sp
->xmitcnt
= cl
->cl_xmitcnt
;
539 sp
->dropcnt
= cl
->cl_dropcnt
;
541 sp
->qtype
= qtype(cl
->cl_q
);
543 if (q_is_red(cl
->cl_q
))
544 red_getstats(cl
->cl_red
, &sp
->red
[0]);
547 if (q_is_rio(cl
->cl_q
))
548 rio_getstats((rio_t
*)cl
->cl_red
, &sp
->red
[0]);
552 /* convert a class handle to the corresponding class pointer */
553 static struct priq_class
*
554 clh_to_clp(struct priq_if
*pif
, uint32_t chandle
)
556 struct priq_class
*cl
;
562 for (idx
= pif
->pif_maxpri
; idx
>= 0; idx
--)
563 if ((cl
= pif
->pif_classes
[idx
]) != NULL
&&
564 cl
->cl_handle
== chandle
)
570 #endif /* ALTQ_PRIQ */