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.2 2005/05/24 20:59:05 dillon 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 /*
  62  * function prototypes
  63  */
  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 *, int);
  71
  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 *);
  76
  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);
  79
  80 int
  81 priq_pfattach(struct pf_altq *a)
  82 {
  83         struct ifnet *ifp;
  84         int s, error;
  85
  86         if ((ifp = ifunit(a->ifname)) == NULL || a->altq_disc == NULL)
  87                 return (EINVAL);
  88         s = splimp();
  89         error = altq_attach(&ifp->if_snd, ALTQT_PRIQ, a->altq_disc,
  90             priq_enqueue, priq_dequeue, priq_request, NULL, NULL);
  91         splx(s);
  92         return (error);
  93 }
  94
  95 int
  96 priq_add_altq(struct pf_altq *a)
  97 {
  98         struct priq_if *pif;
  99         struct ifnet *ifp;
 100
 101         if ((ifp = ifunit(a->ifname)) == NULL)
 102                 return (EINVAL);
 103         if (!ifq_is_ready(&ifp->if_snd))
 104                 return (ENODEV);
 105
 106         pif = malloc(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
 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         free(pif, M_ALTQ);
 129         return (0);
 130 }
 131
 132 int
 133 priq_add_queue(struct pf_altq *a)
 134 {
 135         struct priq_if *pif;
 136         struct priq_class *cl;
 137
 138         if ((pif = a->altq_disc) == NULL)
 139                 return (EINVAL);
 140
 141         /* check parameters */
 142         if (a->priority >= PRIQ_MAXPRI)
 143                 return (EINVAL);
 144         if (a->qid == 0)
 145                 return (EINVAL);
 146         if (pif->pif_classes[a->priority] != NULL)
 147                 return (EBUSY);
 148         if (clh_to_clp(pif, a->qid) != NULL)
 149                 return (EBUSY);
 150
 151         cl = priq_class_create(pif, a->priority, a->qlimit,
 152                                a->pq_u.priq_opts.flags, a->qid);
 153         if (cl == NULL)
 154                 return (ENOMEM);
 155
 156         return (0);
 157 }
 158
 159 int
 160 priq_remove_queue(struct pf_altq *a)
 161 {
 162         struct priq_if *pif;
 163         struct priq_class *cl;
 164
 165         if ((pif = a->altq_disc) == NULL)
 166                 return (EINVAL);
 167
 168         if ((cl = clh_to_clp(pif, a->qid)) == NULL)
 169                 return (EINVAL);
 170
 171         return (priq_class_destroy(cl));
 172 }
 173
 174 int
 175 priq_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
 176 {
 177         struct priq_if *pif;
 178         struct priq_class *cl;
 179         struct priq_classstats stats;
 180         int error = 0;
 181
 182         if ((pif = altq_lookup(a->ifname, ALTQT_PRIQ)) == NULL)
 183                 return (EBADF);
 184
 185         if ((cl = clh_to_clp(pif, a->qid)) == NULL)
 186                 return (EINVAL);
 187
 188         if (*nbytes < sizeof(stats))
 189                 return (EINVAL);
 190
 191         get_class_stats(&stats, cl);
 192
 193         if ((error = copyout((caddr_t)&stats, ubuf, sizeof(stats))) != 0)
 194                 return (error);
 195         *nbytes = sizeof(stats);
 196         return (0);
 197 }
 198
 199 /*
 200  * bring the interface back to the initial state by discarding
 201  * all the filters and classes.
 202  */
 203 static int
 204 priq_clear_interface(struct priq_if *pif)
 205 {
 206         struct priq_class *cl;
 207         int pri;
 208
 209         /* clear out the classes */
 210         for (pri = 0; pri <= pif->pif_maxpri; pri++) {
 211                 if ((cl = pif->pif_classes[pri]) != NULL)
 212                         priq_class_destroy(cl);
 213         }
 214
 215         return (0);
 216 }
 217
 218 static int
 219 priq_request(struct ifaltq *ifq, int req, void *arg)
 220 {
 221         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
 222
 223         crit_enter();
 224         switch (req) {
 225         case ALTRQ_PURGE:
 226                 priq_purge(pif);
 227                 break;
 228         }
 229         crit_exit();
 230         return (0);
 231 }
 232
 233 /* discard all the queued packets on the interface */
 234 static void
 235 priq_purge(struct priq_if *pif)
 236 {
 237         struct priq_class *cl;
 238         int pri;
 239
 240         for (pri = 0; pri <= pif->pif_maxpri; pri++) {
 241                 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q))
 242                         priq_purgeq(cl);
 243         }
 244         if (ifq_is_enabled(pif->pif_ifq))
 245                 pif->pif_ifq->ifq_len = 0;
 246 }
 247
 248 static struct priq_class *
 249 priq_class_create(struct priq_if *pif, int pri, int qlimit, int flags, int qid)
 250 {
 251         struct priq_class *cl;
 252         int s;
 253
 254 #ifndef ALTQ_RED
 255         if (flags & PRCF_RED) {
 256 #ifdef ALTQ_DEBUG
 257                 printf("priq_class_create: RED not configured for PRIQ!\n");
 258 #endif
 259                 return (NULL);
 260         }
 261 #endif
 262
 263         if ((cl = pif->pif_classes[pri]) != NULL) {
 264                 /* modify the class instead of creating a new one */
 265                 s = splimp();
 266                 if (!qempty(cl->cl_q))
 267                         priq_purgeq(cl);
 268                 splx(s);
 269 #ifdef ALTQ_RIO
 270                 if (q_is_rio(cl->cl_q))
 271                         rio_destroy((rio_t *)cl->cl_red);
 272 #endif
 273 #ifdef ALTQ_RED
 274                 if (q_is_red(cl->cl_q))
 275                         red_destroy(cl->cl_red);
 276 #endif
 277         } else {
 278                 cl = malloc(sizeof(*cl), M_ALTQ, M_WAITOK | M_ZERO);
 279                 cl->cl_q = malloc(sizeof(*cl->cl_q), M_ALTQ, M_WAITOK | M_ZERO);
 280         }
 281
 282         pif->pif_classes[pri] = cl;
 283         if (flags & PRCF_DEFAULTCLASS)
 284                 pif->pif_default = cl;
 285         if (qlimit == 0)
 286                 qlimit = 50;  /* use default */
 287         qlimit(cl->cl_q) = qlimit;
 288         qtype(cl->cl_q) = Q_DROPTAIL;
 289         qlen(cl->cl_q) = 0;
 290         cl->cl_flags = flags;
 291         cl->cl_pri = pri;
 292         if (pri > pif->pif_maxpri)
 293                 pif->pif_maxpri = pri;
 294         cl->cl_pif = pif;
 295         cl->cl_handle = qid;
 296
 297 #ifdef ALTQ_RED
 298         if (flags & (PRCF_RED|PRCF_RIO)) {
 299                 int red_flags, red_pkttime;
 300
 301                 red_flags = 0;
 302                 if (flags & PRCF_ECN)
 303                         red_flags |= REDF_ECN;
 304 #ifdef ALTQ_RIO
 305                 if (flags & PRCF_CLEARDSCP)
 306                         red_flags |= RIOF_CLEARDSCP;
 307 #endif
 308                 if (pif->pif_bandwidth < 8)
 309                         red_pkttime = 1000 * 1000 * 1000; /* 1 sec */
 310                 else
 311                         red_pkttime = (int64_t)pif->pif_ifq->altq_ifp->if_mtu
 312                           * 1000 * 1000 * 1000 / (pif->pif_bandwidth / 8);
 313 #ifdef ALTQ_RIO
 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;
 319                 } else
 320 #endif
 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;
 328                 }
 329         }
 330 #endif /* ALTQ_RED */
 331
 332         return (cl);
 333 }
 334
 335 static int
 336 priq_class_destroy(struct priq_class *cl)
 337 {
 338         struct priq_if *pif;
 339         int s, pri;
 340
 341         s = splimp();
 342
 343         if (!qempty(cl->cl_q))
 344                 priq_purgeq(cl);
 345
 346         pif = cl->cl_pif;
 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;
 352                                 break;
 353                         }
 354                 if (pri < 0)
 355                         pif->pif_maxpri = -1;
 356         }
 357         splx(s);
 358
 359         if (cl->cl_red != NULL) {
 360 #ifdef ALTQ_RIO
 361                 if (q_is_rio(cl->cl_q))
 362                         rio_destroy((rio_t *)cl->cl_red);
 363 #endif
 364 #ifdef ALTQ_RED
 365                 if (q_is_red(cl->cl_q))
 366                         red_destroy(cl->cl_red);
 367 #endif
 368         }
 369         free(cl->cl_q, M_ALTQ);
 370         free(cl, M_ALTQ);
 371         return (0);
 372 }
 373
 374 /*
 375  * priq_enqueue is an enqueue function to be registered to
 376  * (*altq_enqueue) in struct ifaltq.
 377  */
 378 static int
 379 priq_enqueue(struct ifaltq *ifq, struct mbuf *m, struct altq_pktattr *pktattr)
 380 {
 381         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
 382         struct priq_class *cl;
 383         int error;
 384         int len;
 385
 386         crit_enter();
 387
 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");
 392                 m_freem(m);
 393                 error = ENOBUFS;
 394                 goto done;
 395         }
 396
 397         if (m->m_pkthdr.fw_flags & ALTQ_MBUF_TAGGED)
 398                 cl = clh_to_clp(pif, m->m_pkthdr.altq_qid);
 399         else
 400                 cl = NULL;
 401         if (cl == NULL) {
 402                 cl = pif->pif_default;
 403                 if (cl == NULL) {
 404                         m_freem(m);
 405                         error = ENOBUFS;
 406                         goto done;
 407                 }
 408         }
 409         cl->cl_pktattr = NULL;
 410         len = m_pktlen(m);
 411         if (priq_addq(cl, m) != 0) {
 412                 /* drop occurred.  mbuf was freed in priq_addq. */
 413                 PKTCNTR_ADD(&cl->cl_dropcnt, len);
 414                 error = ENOBUFS;
 415                 goto done;
 416         }
 417         ifq->ifq_len++;
 418         error = 0;
 419 done:
 420         crit_exit();
 421         return (error);
 422 }
 423
 424 /*
 425  * priq_dequeue is a dequeue function to be registered to
 426  * (*altq_dequeue) in struct ifaltq.
 427  *
 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
 431  *      after ALTDQ_POLL.
 432  */
 433 static struct mbuf *
 434 priq_dequeue(struct ifaltq *ifq, int op)
 435 {
 436         struct priq_if *pif = (struct priq_if *)ifq->altq_disc;
 437         struct priq_class *cl;
 438         struct mbuf *m;
 439         int pri;
 440
 441         if (ifq_is_empty(ifq)) {
 442                 /* no packet in the queue */
 443                 return (NULL);
 444         }
 445
 446         crit_enter();
 447         m = NULL;
 448         for (pri = pif->pif_maxpri;  pri >= 0; pri--) {
 449                 if ((cl = pif->pif_classes[pri]) != NULL && !qempty(cl->cl_q)) {
 450                         if (op == ALTDQ_POLL) {
 451                                 m = priq_pollq(cl);
 452                                 break;
 453                         }
 454
 455                         m = priq_getq(cl);
 456                         if (m != NULL) {
 457                                 ifq->ifq_len--;
 458                                 if (qempty(cl->cl_q))
 459                                         cl->cl_period++;
 460                                 PKTCNTR_ADD(&cl->cl_xmitcnt, m_pktlen(m));
 461                         }
 462                         break;
 463                 }
 464         }
 465         crit_exit();
 466         return (m);
 467 }
 468
 469 static int
 470 priq_addq(struct priq_class *cl, struct mbuf *m)
 471 {
 472 #ifdef ALTQ_RIO
 473         if (q_is_rio(cl->cl_q))
 474                 return rio_addq((rio_t *)cl->cl_red, cl->cl_q, m,
 475                                 cl->cl_pktattr);
 476 #endif
 477 #ifdef ALTQ_RED
 478         if (q_is_red(cl->cl_q))
 479                 return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
 480 #endif
 481         if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
 482                 m_freem(m);
 483                 return (-1);
 484         }
 485
 486         if (cl->cl_flags & PRCF_CLEARDSCP)
 487                 write_dsfield(m, cl->cl_pktattr, 0);
 488
 489         _addq(cl->cl_q, m);
 490
 491         return (0);
 492 }
 493
 494 static struct mbuf *
 495 priq_getq(struct priq_class *cl)
 496 {
 497 #ifdef ALTQ_RIO
 498         if (q_is_rio(cl->cl_q))
 499                 return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
 500 #endif
 501 #ifdef ALTQ_RED
 502         if (q_is_red(cl->cl_q))
 503                 return red_getq(cl->cl_red, cl->cl_q);
 504 #endif
 505         return _getq(cl->cl_q);
 506 }
 507
 508 static struct mbuf *
 509 priq_pollq(struct priq_class *cl)
 510 {
 511         return qhead(cl->cl_q);
 512 }
 513
 514 static void
 515 priq_purgeq(struct priq_class *cl)
 516 {
 517         struct mbuf *m;
 518
 519         if (qempty(cl->cl_q))
 520                 return;
 521
 522         while ((m = _getq(cl->cl_q)) != NULL) {
 523                 PKTCNTR_ADD(&cl->cl_dropcnt, m_pktlen(m));
 524                 m_freem(m);
 525         }
 526         KKASSERT(qlen(cl->cl_q) == 0);
 527 }
 528
 529 static void
 530 get_class_stats(struct priq_classstats *sp, struct priq_class *cl)
 531 {
 532         sp->class_handle = cl->cl_handle;
 533         sp->qlength = qlen(cl->cl_q);
 534         sp->qlimit = qlimit(cl->cl_q);
 535         sp->period = cl->cl_period;
 536         sp->xmitcnt = cl->cl_xmitcnt;
 537         sp->dropcnt = cl->cl_dropcnt;
 538
 539         sp->qtype = qtype(cl->cl_q);
 540 #ifdef ALTQ_RED
 541         if (q_is_red(cl->cl_q))
 542                 red_getstats(cl->cl_red, &sp->red[0]);
 543 #endif
 544 #ifdef ALTQ_RIO
 545         if (q_is_rio(cl->cl_q))
 546                 rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
 547 #endif
 548 }
 549
 550 /* convert a class handle to the corresponding class pointer */
 551 static struct priq_class *
 552 clh_to_clp(struct priq_if *pif, uint32_t chandle)
 553 {
 554         struct priq_class *cl;
 555         int idx;
 556
 557         if (chandle == 0)
 558                 return (NULL);
 559
 560         for (idx = pif->pif_maxpri; idx >= 0; idx--)
 561                 if ((cl = pif->pif_classes[idx]) != NULL &&
 562                     cl->cl_handle == chandle)
 563                         return (cl);
 564
 565         return (NULL);
 566 }
 567
 568 #endif /* ALTQ_PRIQ */