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 *, 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, ifq_mapsubq_default,
  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                 ALTQ_SQ_CNTR_RESET(&pif->pif_ifq->altq_subq[PRIQ_SUBQ_INDEX]);
 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  * (*ifsq_enqueue) in struct ifaltq_subque.
 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         M_ASSERTPKTHDR(m);
 453         if (m->m_pkthdr.fw_flags & PF_MBUF_STRUCTURE)
 454                 cl = clh_to_clp(pif, m->m_pkthdr.pf.qid);
 455         else
 456                 cl = NULL;
 457         if (cl == NULL) {
 458                 cl = pif->pif_default;
 459                 if (cl == NULL) {
 460                         m_freem(m);
 461                         error = ENOBUFS;
 462                         goto done;
 463                 }
 464         }
 465         cl->cl_pktattr = NULL;
 466         len = m_pktlen(m);
 467         if (priq_addq(cl, m) != 0) {
 468                 /* drop occurred.  mbuf was freed in priq_addq. */
 469                 PKTCNTR_ADD(&cl->cl_dropcnt, len);
 470                 error = ENOBUFS;
 471                 goto done;
 472         }
 473         ALTQ_SQ_PKTCNT_INC(ifsq);
 474         error = 0;
 475 done:
 476         crit_exit();
 477         return (error);
 478 }
 479
 480 /*
 481  * priq_dequeue is a dequeue function to be registered to
 482  * (*ifsq_dequeue) in struct ifaltq_subque.
 483  *
 484  * note: ALTDQ_POLL returns the next packet without removing the packet
 485  *      from the queue.  ALTDQ_REMOVE is a normal dequeue operation.
 486  */
 487 static struct mbuf *
 488 priq_dequeue(struct ifaltq_subque *ifsq, int op)
 489 {
 490         struct ifaltq *ifq = ifsq->ifsq_altq;
 491         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
 492         struct priq_class *cl;
 493         struct mbuf *m;
 494         int pri;
 495
 496         if (ifsq_get_index(ifsq) != PRIQ_SUBQ_INDEX) {
 497                 /*
 498                  * Race happened, the unrelated subqueue was
 499                  * picked during the packet scheduler transition.
 500                  */
 501                 ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
 502                 return NULL;
 503         }
 504
 505         if (ifsq_is_empty(ifsq)) {
 506                 /* no packet in the queue */
 507                 return (NULL);
 508         }
 509
 510         crit_enter();
 511         m = NULL;
 512         for (pri = pif->pif_maxpri;  pri >= 0; pri--) {
 513                 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q)) {
 514                         if (op == ALTDQ_POLL) {
 515                                 m = priq_pollq(cl);
 516                                 break;
 517                         }
 518
 519                         m = priq_getq(cl);
 520                         if (m != NULL) {
 521                                 ALTQ_SQ_PKTCNT_DEC(ifsq);
 522                                 if (qempty(cl->cl_q))
 523                                         cl->cl_period++;
 524                                 PKTCNTR_ADD(&cl->cl_xmitcnt, m_pktlen(m));
 525                         }
 526                         break;
 527                 }
 528         }
 529         crit_exit();
 530         return (m);
 531 }
 532
 533 static int
 534 priq_addq(struct priq_class *cl, struct mbuf *m)
 535 {
 536 #ifdef ALTQ_RIO
 537         if (q_is_rio(cl->cl_q))
 538                 return rio_addq((rio_t *)cl->cl_red, cl->cl_q, m,
 539                                 cl->cl_pktattr);
 540 #endif
 541 #ifdef ALTQ_RED
 542         if (q_is_red(cl->cl_q))
 543                 return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
 544 #endif
 545         if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
 546                 m_freem(m);
 547                 return (-1);
 548         }
 549
 550         if (cl->cl_flags & PRCF_CLEARDSCP)
 551                 write_dsfield(m, cl->cl_pktattr, 0);
 552
 553         _addq(cl->cl_q, m);
 554
 555         return (0);
 556 }
 557
 558 static struct mbuf *
 559 priq_getq(struct priq_class *cl)
 560 {
 561 #ifdef ALTQ_RIO
 562         if (q_is_rio(cl->cl_q))
 563                 return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
 564 #endif
 565 #ifdef ALTQ_RED
 566         if (q_is_red(cl->cl_q))
 567                 return red_getq(cl->cl_red, cl->cl_q);
 568 #endif
 569         return _getq(cl->cl_q);
 570 }
 571
 572 static struct mbuf *
 573 priq_pollq(struct priq_class *cl)
 574 {
 575         return qhead(cl->cl_q);
 576 }
 577
 578 static void
 579 priq_purgeq(struct priq_class *cl)
 580 {
 581         struct mbuf *m;
 582
 583         if (qempty(cl->cl_q))
 584                 return;
 585
 586         while ((m = _getq(cl->cl_q)) != NULL) {
 587                 PKTCNTR_ADD(&cl->cl_dropcnt, m_pktlen(m));
 588                 m_freem(m);
 589         }
 590         KKASSERT(qlen(cl->cl_q) == 0);
 591 }
 592
 593 static void
 594 get_class_stats(struct priq_classstats *sp, struct priq_class *cl)
 595 {
 596         sp->class_handle = cl->cl_handle;
 597         sp->qlength = qlen(cl->cl_q);
 598         sp->qlimit = qlimit(cl->cl_q);
 599         sp->period = cl->cl_period;
 600         sp->xmitcnt = cl->cl_xmitcnt;
 601         sp->dropcnt = cl->cl_dropcnt;
 602
 603         sp->qtype = qtype(cl->cl_q);
 604 #ifdef ALTQ_RED
 605         if (q_is_red(cl->cl_q))
 606                 red_getstats(cl->cl_red, &sp->red[0]);
 607 #endif
 608 #ifdef ALTQ_RIO
 609         if (q_is_rio(cl->cl_q))
 610                 rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
 611 #endif
 612 }
 613
 614 /* convert a class handle to the corresponding class pointer */
 615 static struct priq_class *
 616 clh_to_clp(struct priq_if *pif, uint32_t chandle)
 617 {
 618         struct priq_class *cl;
 619         int idx;
 620
 621         if (chandle == 0)
 622                 return (NULL);
 623
 624         for (idx = pif->pif_maxpri; idx >= 0; idx--)
 625                 if ((cl = pif->pif_classes[idx]) != NULL &&
 626                     cl->cl_handle == chandle)
 627                         return (cl);
 628
 629         return (NULL);
 630 }
 631
 632 #endif /* ALTQ_PRIQ */