01335e5afbc177c260381e4c1de40914996ff45e
[dragonfly.git] / sys / net / altq / altq_priq.c
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 $ */
3
4 /*
5  * Copyright (C) 2000-2003
6  *      Sony Computer Science Laboratories Inc.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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.
16  *
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
27  * SUCH DAMAGE.
28  */
29 /*
30  * priority queue
31  */
32
33 #include "opt_altq.h"
34 #include "opt_inet.h"
35 #include "opt_inet6.h"
36
37 #ifdef ALTQ_PRIQ  /* priq is enabled by ALTQ_PRIQ option in opt_altq.h */
38
39 #include <sys/param.h>
40 #include <sys/malloc.h>
41 #include <sys/mbuf.h>
42 #include <sys/socket.h>
43 #include <sys/sockio.h>
44 #include <sys/systm.h>
45 #include <sys/proc.h>
46 #include <sys/errno.h>
47 #include <sys/kernel.h>
48 #include <sys/queue.h>
49 #include <sys/thread.h>
50
51 #include <net/if.h>
52 #include <net/ifq_var.h>
53 #include <netinet/in.h>
54
55 #include <net/pf/pfvar.h>
56 #include <net/altq/altq.h>
57 #include <net/altq/altq_priq.h>
58
59 #include <sys/thread2.h>
60
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])
66
67 /*
68  * function prototypes
69  */
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 *, struct mbuf *, int);
78
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 *);
83
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);
86
87 int
88 priq_pfattach(struct pf_altq *a, struct ifaltq *ifq)
89 {
90         return altq_attach(ifq, ALTQT_PRIQ, a->altq_disc,
91             priq_enqueue, priq_dequeue, priq_request, NULL, NULL);
92 }
93
94 int
95 priq_add_altq(struct pf_altq *a)
96 {
97         struct priq_if *pif;
98         struct ifnet *ifp;
99
100         if ((ifp = ifunit(a->ifname)) == NULL)
101                 return (EINVAL);
102         if (!ifq_is_ready(&ifp->if_snd))
103                 return (ENODEV);
104
105         pif = kmalloc(sizeof(*pif), M_ALTQ, M_WAITOK | M_ZERO);
106         pif->pif_bandwidth = a->ifbandwidth;
107         pif->pif_maxpri = -1;
108         pif->pif_ifq = &ifp->if_snd;
109         ifq_purge_all(&ifp->if_snd);
110
111         /* keep the state in pf_altq */
112         a->altq_disc = pif;
113
114         return (0);
115 }
116
117 int
118 priq_remove_altq(struct pf_altq *a)
119 {
120         struct priq_if *pif;
121
122         if ((pif = a->altq_disc) == NULL)
123                 return (EINVAL);
124         a->altq_disc = NULL;
125
126         priq_clear_interface(pif);
127
128         kfree(pif, M_ALTQ);
129         return (0);
130 }
131
132 static int
133 priq_add_queue_locked(struct pf_altq *a, struct priq_if *pif)
134 {
135         struct priq_class *cl;
136
137         KKASSERT(a->priority < PRIQ_MAXPRI);
138         KKASSERT(a->qid != 0);
139
140         if (pif->pif_classes[a->priority] != NULL)
141                 return (EBUSY);
142         if (clh_to_clp(pif, a->qid) != NULL)
143                 return (EBUSY);
144
145         cl = priq_class_create(pif, a->priority, a->qlimit,
146                                a->pq_u.priq_opts.flags, a->qid);
147         if (cl == NULL)
148                 return (ENOMEM);
149
150         return (0);
151 }
152
153 int
154 priq_add_queue(struct pf_altq *a)
155 {
156         struct priq_if *pif;
157         struct ifaltq *ifq;
158         int error;
159
160         /* check parameters */
161         if (a->priority >= PRIQ_MAXPRI)
162                 return (EINVAL);
163         if (a->qid == 0)
164                 return (EINVAL);
165
166         /* XXX not MP safe */
167         if ((pif = a->altq_disc) == NULL)
168                 return (EINVAL);
169         ifq = pif->pif_ifq;
170
171         PRIQ_LOCK(ifq);
172         error = priq_add_queue_locked(a, pif);
173         PRIQ_UNLOCK(ifq);
174
175         return error;
176 }
177
178 static int
179 priq_remove_queue_locked(struct pf_altq *a, struct priq_if *pif)
180 {
181         struct priq_class *cl;
182
183         if ((cl = clh_to_clp(pif, a->qid)) == NULL)
184                 return (EINVAL);
185
186         return (priq_class_destroy(cl));
187 }
188
189 int
190 priq_remove_queue(struct pf_altq *a)
191 {
192         struct priq_if *pif;
193         struct ifaltq *ifq;
194         int error;
195
196         /* XXX not MF safe */
197         if ((pif = a->altq_disc) == NULL)
198                 return (EINVAL);
199         ifq = pif->pif_ifq;
200
201         PRIQ_LOCK(ifq);
202         error = priq_remove_queue_locked(a, pif);
203         PRIQ_UNLOCK(ifq);
204
205         return error;
206 }
207
208 int
209 priq_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
210 {
211         struct priq_if *pif;
212         struct priq_class *cl;
213         struct priq_classstats stats;
214         struct ifaltq *ifq;
215         int error = 0;
216
217         if (*nbytes < sizeof(stats))
218                 return (EINVAL);
219
220         /* XXX not MP safe */
221         if ((pif = altq_lookup(a->ifname, ALTQT_PRIQ)) == NULL)
222                 return (EBADF);
223         ifq = pif->pif_ifq;
224
225         PRIQ_LOCK(ifq);
226
227         if ((cl = clh_to_clp(pif, a->qid)) == NULL) {
228                 PRIQ_UNLOCK(ifq);
229                 return (EINVAL);
230         }
231
232         get_class_stats(&stats, cl);
233
234         PRIQ_UNLOCK(ifq);
235
236         if ((error = copyout((caddr_t)&stats, ubuf, sizeof(stats))) != 0)
237                 return (error);
238         *nbytes = sizeof(stats);
239         return (0);
240 }
241
242 /*
243  * bring the interface back to the initial state by discarding
244  * all the filters and classes.
245  */
246 static int
247 priq_clear_interface(struct priq_if *pif)
248 {
249         struct priq_class *cl;
250         int pri;
251
252         /* clear out the classes */
253         for (pri = 0; pri <= pif->pif_maxpri; pri++) {
254                 if ((cl = pif->pif_classes[pri]) != NULL)
255                         priq_class_destroy(cl);
256         }
257
258         return (0);
259 }
260
261 static int
262 priq_request(struct ifaltq_subque *ifsq, int req, void *arg)
263 {
264         struct ifaltq *ifq = ifsq->ifsq_altq;
265         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
266
267         crit_enter();
268         switch (req) {
269         case ALTRQ_PURGE:
270                 if (ifsq_get_index(ifsq) == PRIQ_SUBQ_INDEX) {
271                         priq_purge(pif);
272                 } else {
273                         /*
274                          * Race happened, the unrelated subqueue was
275                          * picked during the packet scheduler transition.
276                          */
277                         ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
278                 }
279                 break;
280         }
281         crit_exit();
282         return (0);
283 }
284
285 /* discard all the queued packets on the interface */
286 static void
287 priq_purge(struct priq_if *pif)
288 {
289         struct priq_class *cl;
290         int pri;
291
292         for (pri = 0; pri <= pif->pif_maxpri; pri++) {
293                 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q))
294                         priq_purgeq(cl);
295         }
296         if (ifq_is_enabled(pif->pif_ifq))
297                 pif->pif_ifq->altq_subq[PRIQ_SUBQ_INDEX].ifq_len = 0;
298 }
299
300 static struct priq_class *
301 priq_class_create(struct priq_if *pif, int pri, int qlimit, int flags, int qid)
302 {
303         struct priq_class *cl;
304
305 #ifndef ALTQ_RED
306         if (flags & PRCF_RED) {
307 #ifdef ALTQ_DEBUG
308                 kprintf("priq_class_create: RED not configured for PRIQ!\n");
309 #endif
310                 return (NULL);
311         }
312 #endif
313
314         if ((cl = pif->pif_classes[pri]) != NULL) {
315                 /* modify the class instead of creating a new one */
316                 crit_enter();
317                 if (!qempty(cl->cl_q))
318                         priq_purgeq(cl);
319                 crit_exit();
320 #ifdef ALTQ_RIO
321                 if (q_is_rio(cl->cl_q))
322                         rio_destroy((rio_t *)cl->cl_red);
323 #endif
324 #ifdef ALTQ_RED
325                 if (q_is_red(cl->cl_q))
326                         red_destroy(cl->cl_red);
327 #endif
328         } else {
329                 cl = kmalloc(sizeof(*cl), M_ALTQ, M_WAITOK | M_ZERO);
330                 cl->cl_q = kmalloc(sizeof(*cl->cl_q), M_ALTQ, M_WAITOK | M_ZERO);
331         }
332
333         pif->pif_classes[pri] = cl;
334         if (flags & PRCF_DEFAULTCLASS)
335                 pif->pif_default = cl;
336         if (qlimit == 0)
337                 qlimit = 50;  /* use default */
338         qlimit(cl->cl_q) = qlimit;
339         qtype(cl->cl_q) = Q_DROPTAIL;
340         qlen(cl->cl_q) = 0;
341         cl->cl_flags = flags;
342         cl->cl_pri = pri;
343         if (pri > pif->pif_maxpri)
344                 pif->pif_maxpri = pri;
345         cl->cl_pif = pif;
346         cl->cl_handle = qid;
347
348 #ifdef ALTQ_RED
349         if (flags & (PRCF_RED|PRCF_RIO)) {
350                 int red_flags, red_pkttime;
351
352                 red_flags = 0;
353                 if (flags & PRCF_ECN)
354                         red_flags |= REDF_ECN;
355 #ifdef ALTQ_RIO
356                 if (flags & PRCF_CLEARDSCP)
357                         red_flags |= RIOF_CLEARDSCP;
358 #endif
359                 if (pif->pif_bandwidth < 8)
360                         red_pkttime = 1000 * 1000 * 1000; /* 1 sec */
361                 else
362                         red_pkttime = (int64_t)pif->pif_ifq->altq_ifp->if_mtu
363                           * 1000 * 1000 * 1000 / (pif->pif_bandwidth / 8);
364 #ifdef ALTQ_RIO
365                 if (flags & PRCF_RIO) {
366                         cl->cl_red = (red_t *)rio_alloc(0, NULL,
367                                                 red_flags, red_pkttime);
368                         if (cl->cl_red != NULL)
369                                 qtype(cl->cl_q) = Q_RIO;
370                 } else
371 #endif
372                 if (flags & PRCF_RED) {
373                         cl->cl_red = red_alloc(0, 0,
374                             qlimit(cl->cl_q) * 10/100,
375                             qlimit(cl->cl_q) * 30/100,
376                             red_flags, red_pkttime);
377                         if (cl->cl_red != NULL)
378                                 qtype(cl->cl_q) = Q_RED;
379                 }
380         }
381 #endif /* ALTQ_RED */
382
383         return (cl);
384 }
385
386 static int
387 priq_class_destroy(struct priq_class *cl)
388 {
389         struct priq_if *pif;
390         int pri;
391
392         crit_enter();
393
394         if (!qempty(cl->cl_q))
395                 priq_purgeq(cl);
396
397         pif = cl->cl_pif;
398         pif->pif_classes[cl->cl_pri] = NULL;
399         if (pif->pif_maxpri == cl->cl_pri) {
400                 for (pri = cl->cl_pri; pri >= 0; pri--)
401                         if (pif->pif_classes[pri] != NULL) {
402                                 pif->pif_maxpri = pri;
403                                 break;
404                         }
405                 if (pri < 0)
406                         pif->pif_maxpri = -1;
407         }
408         crit_exit();
409
410         if (cl->cl_red != NULL) {
411 #ifdef ALTQ_RIO
412                 if (q_is_rio(cl->cl_q))
413                         rio_destroy((rio_t *)cl->cl_red);
414 #endif
415 #ifdef ALTQ_RED
416                 if (q_is_red(cl->cl_q))
417                         red_destroy(cl->cl_red);
418 #endif
419         }
420         kfree(cl->cl_q, M_ALTQ);
421         kfree(cl, M_ALTQ);
422         return (0);
423 }
424
425 /*
426  * priq_enqueue is an enqueue function to be registered to
427  * (*altq_enqueue) in struct ifaltq.
428  */
429 static int
430 priq_enqueue(struct ifaltq_subque *ifsq, struct mbuf *m,
431     struct altq_pktattr *pktattr)
432 {
433         struct ifaltq *ifq = ifsq->ifsq_altq;
434         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
435         struct priq_class *cl;
436         int error;
437         int len;
438
439         if (ifsq_get_index(ifsq) != PRIQ_SUBQ_INDEX) {
440                 /*
441                  * Race happened, the unrelated subqueue was
442                  * picked during the packet scheduler transition.
443                  */
444                 ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
445                 m_freem(m);
446                 return ENOBUFS;
447         }
448
449         crit_enter();
450
451         /* grab class set by classifier */
452         if ((m->m_flags & M_PKTHDR) == 0) {
453                 /* should not happen */
454                 if_printf(ifq->altq_ifp, "altq: packet does not have pkthdr\n");
455                 m_freem(m);
456                 error = ENOBUFS;
457                 goto done;
458         }
459
460         if (m->m_pkthdr.fw_flags & PF_MBUF_STRUCTURE)
461                 cl = clh_to_clp(pif, m->m_pkthdr.pf.qid);
462         else
463                 cl = NULL;
464         if (cl == NULL) {
465                 cl = pif->pif_default;
466                 if (cl == NULL) {
467                         m_freem(m);
468                         error = ENOBUFS;
469                         goto done;
470                 }
471         }
472         cl->cl_pktattr = NULL;
473         len = m_pktlen(m);
474         if (priq_addq(cl, m) != 0) {
475                 /* drop occurred.  mbuf was freed in priq_addq. */
476                 PKTCNTR_ADD(&cl->cl_dropcnt, len);
477                 error = ENOBUFS;
478                 goto done;
479         }
480         ifsq->ifq_len++;
481         error = 0;
482 done:
483         crit_exit();
484         return (error);
485 }
486
487 /*
488  * priq_dequeue is a dequeue function to be registered to
489  * (*altq_dequeue) in struct ifaltq.
490  *
491  * note: ALTDQ_POLL returns the next packet without removing the packet
492  *      from the queue.  ALTDQ_REMOVE is a normal dequeue operation.
493  *      ALTDQ_REMOVE must return the same packet if called immediately
494  *      after ALTDQ_POLL.
495  */
496 static struct mbuf *
497 priq_dequeue(struct ifaltq_subque *ifsq, struct mbuf *mpolled, int op)
498 {
499         struct ifaltq *ifq = ifsq->ifsq_altq;
500         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
501         struct priq_class *cl;
502         struct mbuf *m;
503         int pri;
504
505         if (ifsq_get_index(ifsq) != PRIQ_SUBQ_INDEX) {
506                 /*
507                  * Race happened, the unrelated subqueue was
508                  * picked during the packet scheduler transition.
509                  */
510                 ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
511                 return NULL;
512         }
513
514         if (ifsq_is_empty(ifsq)) {
515                 /* no packet in the queue */
516                 KKASSERT(mpolled == NULL);
517                 return (NULL);
518         }
519
520         crit_enter();
521         m = NULL;
522         for (pri = pif->pif_maxpri;  pri >= 0; pri--) {
523                 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q)) {
524                         if (op == ALTDQ_POLL) {
525                                 m = priq_pollq(cl);
526                                 break;
527                         }
528
529                         m = priq_getq(cl);
530                         if (m != NULL) {
531                                 ifsq->ifq_len--;
532                                 if (qempty(cl->cl_q))
533                                         cl->cl_period++;
534                                 PKTCNTR_ADD(&cl->cl_xmitcnt, m_pktlen(m));
535                         }
536                         break;
537                 }
538         }
539         crit_exit();
540         KKASSERT(mpolled == NULL || mpolled == m);
541         return (m);
542 }
543
544 static int
545 priq_addq(struct priq_class *cl, struct mbuf *m)
546 {
547 #ifdef ALTQ_RIO
548         if (q_is_rio(cl->cl_q))
549                 return rio_addq((rio_t *)cl->cl_red, cl->cl_q, m,
550                                 cl->cl_pktattr);
551 #endif
552 #ifdef ALTQ_RED
553         if (q_is_red(cl->cl_q))
554                 return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
555 #endif
556         if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
557                 m_freem(m);
558                 return (-1);
559         }
560
561         if (cl->cl_flags & PRCF_CLEARDSCP)
562                 write_dsfield(m, cl->cl_pktattr, 0);
563
564         _addq(cl->cl_q, m);
565
566         return (0);
567 }
568
569 static struct mbuf *
570 priq_getq(struct priq_class *cl)
571 {
572 #ifdef ALTQ_RIO
573         if (q_is_rio(cl->cl_q))
574                 return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
575 #endif
576 #ifdef ALTQ_RED
577         if (q_is_red(cl->cl_q))
578                 return red_getq(cl->cl_red, cl->cl_q);
579 #endif
580         return _getq(cl->cl_q);
581 }
582
583 static struct mbuf *
584 priq_pollq(struct priq_class *cl)
585 {
586         return qhead(cl->cl_q);
587 }
588
589 static void
590 priq_purgeq(struct priq_class *cl)
591 {
592         struct mbuf *m;
593
594         if (qempty(cl->cl_q))
595                 return;
596
597         while ((m = _getq(cl->cl_q)) != NULL) {
598                 PKTCNTR_ADD(&cl->cl_dropcnt, m_pktlen(m));
599                 m_freem(m);
600         }
601         KKASSERT(qlen(cl->cl_q) == 0);
602 }
603
604 static void
605 get_class_stats(struct priq_classstats *sp, struct priq_class *cl)
606 {
607         sp->class_handle = cl->cl_handle;
608         sp->qlength = qlen(cl->cl_q);
609         sp->qlimit = qlimit(cl->cl_q);
610         sp->period = cl->cl_period;
611         sp->xmitcnt = cl->cl_xmitcnt;
612         sp->dropcnt = cl->cl_dropcnt;
613
614         sp->qtype = qtype(cl->cl_q);
615 #ifdef ALTQ_RED
616         if (q_is_red(cl->cl_q))
617                 red_getstats(cl->cl_red, &sp->red[0]);
618 #endif
619 #ifdef ALTQ_RIO
620         if (q_is_rio(cl->cl_q))
621                 rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
622 #endif
623 }
624
625 /* convert a class handle to the corresponding class pointer */
626 static struct priq_class *
627 clh_to_clp(struct priq_if *pif, uint32_t chandle)
628 {
629         struct priq_class *cl;
630         int idx;
631
632         if (chandle == 0)
633                 return (NULL);
634
635         for (idx = pif->pif_maxpri; idx >= 0; idx--)
636                 if ((cl = pif->pif_classes[idx]) != NULL &&
637                     cl->cl_handle == chandle)
638                         return (cl);
639
640         return (NULL);
641 }
642
643 #endif /* ALTQ_PRIQ */