sys/net/altq/altq_hfsc.c

   1 /*      $KAME: altq_hfsc.c,v 1.25 2004/04/17 10:54:48 kjc Exp $ */
   2 /*      $DragonFly: src/sys/net/altq/altq_hfsc.c,v 1.9 2008/05/14 11:59:23 sephe Exp $ */
   3
   4 /*
   5  * Copyright (c) 1997-1999 Carnegie Mellon University. All Rights Reserved.
   6  *
   7  * Permission to use, copy, modify, and distribute this software and
   8  * its documentation is hereby granted (including for commercial or
   9  * for-profit use), provided that both the copyright notice and this
  10  * permission notice appear in all copies of the software, derivative
  11  * works, or modified versions, and any portions thereof.
  12  *
  13  * THIS SOFTWARE IS EXPERIMENTAL AND IS KNOWN TO HAVE BUGS, SOME OF
  14  * WHICH MAY HAVE SERIOUS CONSEQUENCES.  CARNEGIE MELLON PROVIDES THIS
  15  * SOFTWARE IN ITS ``AS IS'' CONDITION, AND ANY EXPRESS OR IMPLIED
  16  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18  * DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  22  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  23  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  25  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  26  * DAMAGE.
  27  *
  28  * Carnegie Mellon encourages (but does not require) users of this
  29  * software to return any improvements or extensions that they make,
  30  * and to grant Carnegie Mellon the rights to redistribute these
  31  * changes without encumbrance.
  32  */
  33 /*
  34  * H-FSC is described in Proceedings of SIGCOMM'97,
  35  * "A Hierarchical Fair Service Curve Algorithm for Link-Sharing,
  36  * Real-Time and Priority Service"
  37  * by Ion Stoica, Hui Zhang, and T. S. Eugene Ng.
  38  *
  39  * Oleg Cherevko <olwi@aq.ml.com.ua> added the upperlimit for link-sharing.
  40  * when a class has an upperlimit, the fit-time is computed from the
  41  * upperlimit service curve.  the link-sharing scheduler does not schedule
  42  * a class whose fit-time exceeds the current time.
  43  */
  44
  45 #include "opt_altq.h"
  46 #include "opt_inet.h"
  47 #include "opt_inet6.h"
  48
  49 #ifdef ALTQ_HFSC  /* hfsc is enabled by ALTQ_HFSC option in opt_altq.h */
  50
  51 #include <sys/param.h>
  52 #include <sys/malloc.h>
  53 #include <sys/mbuf.h>
  54 #include <sys/socket.h>
  55 #include <sys/systm.h>
  56 #include <sys/errno.h>
  57 #include <sys/queue.h>
  58 #include <sys/thread.h>
  59
  60 #include <net/if.h>
  61 #include <net/ifq_var.h>
  62 #include <netinet/in.h>
  63
  64 #include <net/pf/pfvar.h>
  65 #include <net/altq/altq.h>
  66 #include <net/altq/altq_hfsc.h>
  67
  68 #include <sys/thread2.h>
  69
  70 /*
  71  * function prototypes
  72  */
  73 static int      hfsc_clear_interface(struct hfsc_if *);
  74 static int      hfsc_request(struct ifaltq *, int, void *);
  75 static void     hfsc_purge(struct hfsc_if *);
  76 static struct hfsc_class *hfsc_class_create(struct hfsc_if *,
  77                                             struct service_curve *,
  78                                             struct service_curve *,
  79                                             struct service_curve *,
  80                                             struct hfsc_class *, int, int, int);
  81 static int      hfsc_class_destroy(struct hfsc_class *);
  82 static struct hfsc_class *hfsc_nextclass(struct hfsc_class *);
  83 static int      hfsc_enqueue(struct ifaltq *, struct mbuf *,
  84                              struct altq_pktattr *);
  85 static struct mbuf *hfsc_dequeue(struct ifaltq *, struct mbuf *, int);
  86
  87 static int      hfsc_addq(struct hfsc_class *, struct mbuf *);
  88 static struct mbuf *hfsc_getq(struct hfsc_class *);
  89 static struct mbuf *hfsc_pollq(struct hfsc_class *);
  90 static void     hfsc_purgeq(struct hfsc_class *);
  91
  92 static void     update_cfmin(struct hfsc_class *);
  93 static void     set_active(struct hfsc_class *, int);
  94 static void     set_passive(struct hfsc_class *);
  95
  96 static void     init_ed(struct hfsc_class *, int);
  97 static void     update_ed(struct hfsc_class *, int);
  98 static void     update_d(struct hfsc_class *, int);
  99 static void     init_vf(struct hfsc_class *, int);
 100 static void     update_vf(struct hfsc_class *, int, uint64_t);
 101 static ellist_t *ellist_alloc(void);
 102 static void     ellist_destroy(ellist_t *);
 103 static void     ellist_insert(struct hfsc_class *);
 104 static void     ellist_remove(struct hfsc_class *);
 105 static void     ellist_update(struct hfsc_class *);
 106 struct hfsc_class *ellist_get_mindl(ellist_t *, uint64_t);
 107 static actlist_t *actlist_alloc(void);
 108 static void     actlist_destroy(actlist_t *);
 109 static void     actlist_insert(struct hfsc_class *);
 110 static void     actlist_remove(struct hfsc_class *);
 111 static void     actlist_update(struct hfsc_class *);
 112
 113 static struct hfsc_class *actlist_firstfit(struct hfsc_class *, uint64_t);
 114
 115 static __inline uint64_t        seg_x2y(uint64_t, uint64_t);
 116 static __inline uint64_t        seg_y2x(uint64_t, uint64_t);
 117 static __inline uint64_t        m2sm(u_int);
 118 static __inline uint64_t        m2ism(u_int);
 119 static __inline uint64_t        d2dx(u_int);
 120 static u_int                    sm2m(uint64_t);
 121 static u_int                    dx2d(uint64_t);
 122
 123 static void     sc2isc(struct service_curve *, struct internal_sc *);
 124 static void     rtsc_init(struct runtime_sc *, struct internal_sc *,
 125                           uint64_t, uint64_t);
 126 static uint64_t rtsc_y2x(struct runtime_sc *, uint64_t);
 127 static uint64_t rtsc_x2y(struct runtime_sc *, uint64_t);
 128 static void     rtsc_min(struct runtime_sc *, struct internal_sc *,
 129                          uint64_t, uint64_t);
 130
 131 static void     get_class_stats(struct hfsc_classstats *, struct hfsc_class *);
 132 static struct hfsc_class *clh_to_clp(struct hfsc_if *, uint32_t);
 133
 134 /*
 135  * macros
 136  */
 137 #define is_a_parent_class(cl)   ((cl)->cl_children != NULL)
 138
 139 #define HT_INFINITY     0xffffffffffffffffLL    /* infinite time value */
 140
 141 int
 142 hfsc_pfattach(struct pf_altq *a, struct ifaltq *ifq)
 143 {
 144         return altq_attach(ifq, ALTQT_HFSC, a->altq_disc,
 145             hfsc_enqueue, hfsc_dequeue, hfsc_request, NULL, NULL);
 146 }
 147
 148 int
 149 hfsc_add_altq(struct pf_altq *a)
 150 {
 151         struct hfsc_if *hif;
 152         struct ifnet *ifp;
 153
 154         if ((ifp = ifunit(a->ifname)) == NULL)
 155                 return (EINVAL);
 156         if (!ifq_is_ready(&ifp->if_snd))
 157                 return (ENODEV);
 158
 159         hif = kmalloc(sizeof(struct hfsc_if), M_ALTQ, M_WAITOK | M_ZERO);
 160
 161         hif->hif_eligible = ellist_alloc();
 162         hif->hif_ifq = &ifp->if_snd;
 163         ifq_purge(&ifp->if_snd);
 164
 165         /* keep the state in pf_altq */
 166         a->altq_disc = hif;
 167
 168         return (0);
 169 }
 170
 171 int
 172 hfsc_remove_altq(struct pf_altq *a)
 173 {
 174         struct hfsc_if *hif;
 175
 176         if ((hif = a->altq_disc) == NULL)
 177                 return (EINVAL);
 178         a->altq_disc = NULL;
 179
 180         hfsc_clear_interface(hif);
 181         hfsc_class_destroy(hif->hif_rootclass);
 182
 183         ellist_destroy(hif->hif_eligible);
 184
 185         kfree(hif, M_ALTQ);
 186
 187         return (0);
 188 }
 189
 190 static int
 191 hfsc_add_queue_locked(struct pf_altq *a, struct hfsc_if *hif)
 192 {
 193         struct hfsc_class *cl, *parent;
 194         struct hfsc_opts *opts;
 195         struct service_curve rtsc, lssc, ulsc;
 196
 197         KKASSERT(a->qid != 0);
 198
 199         opts = &a->pq_u.hfsc_opts;
 200
 201         if (a->parent_qid == HFSC_NULLCLASS_HANDLE && hif->hif_rootclass == NULL)
 202                 parent = NULL;
 203         else if ((parent = clh_to_clp(hif, a->parent_qid)) == NULL)
 204                 return (EINVAL);
 205
 206         if (clh_to_clp(hif, a->qid) != NULL)
 207                 return (EBUSY);
 208
 209         rtsc.m1 = opts->rtsc_m1;
 210         rtsc.d  = opts->rtsc_d;
 211         rtsc.m2 = opts->rtsc_m2;
 212         lssc.m1 = opts->lssc_m1;
 213         lssc.d  = opts->lssc_d;
 214         lssc.m2 = opts->lssc_m2;
 215         ulsc.m1 = opts->ulsc_m1;
 216         ulsc.d  = opts->ulsc_d;
 217         ulsc.m2 = opts->ulsc_m2;
 218
 219         cl = hfsc_class_create(hif, &rtsc, &lssc, &ulsc, parent, a->qlimit,
 220                                opts->flags, a->qid);
 221         if (cl == NULL)
 222                 return (ENOMEM);
 223
 224         return (0);
 225 }
 226
 227 int
 228 hfsc_add_queue(struct pf_altq *a)
 229 {
 230         struct hfsc_if *hif;
 231         struct ifaltq *ifq;
 232         int error;
 233
 234         if (a->qid == 0)
 235                 return (EINVAL);
 236
 237         /* XXX not MP safe */
 238         if ((hif = a->altq_disc) == NULL)
 239                 return (EINVAL);
 240         ifq = hif->hif_ifq;
 241
 242         ALTQ_LOCK(ifq);
 243         error = hfsc_add_queue_locked(a, hif);
 244         ALTQ_UNLOCK(ifq);
 245
 246         return error;
 247 }
 248
 249 static int
 250 hfsc_remove_queue_locked(struct pf_altq *a, struct hfsc_if *hif)
 251 {
 252         struct hfsc_class *cl;
 253
 254         if ((cl = clh_to_clp(hif, a->qid)) == NULL)
 255                 return (EINVAL);
 256
 257         return (hfsc_class_destroy(cl));
 258 }
 259
 260 int
 261 hfsc_remove_queue(struct pf_altq *a)
 262 {
 263         struct hfsc_if *hif;
 264         struct ifaltq *ifq;
 265         int error;
 266
 267         /* XXX not MP safe */
 268         if ((hif = a->altq_disc) == NULL)
 269                 return (EINVAL);
 270         ifq = hif->hif_ifq;
 271
 272         ALTQ_LOCK(ifq);
 273         error = hfsc_remove_queue_locked(a, hif);
 274         ALTQ_UNLOCK(ifq);
 275
 276         return error;
 277 }
 278
 279 int
 280 hfsc_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
 281 {
 282         struct hfsc_if *hif;
 283         struct hfsc_class *cl;
 284         struct hfsc_classstats stats;
 285         struct ifaltq *ifq;
 286         int error = 0;
 287
 288         if (*nbytes < sizeof(stats))
 289                 return (EINVAL);
 290
 291         /* XXX not MP safe */
 292         if ((hif = altq_lookup(a->ifname, ALTQT_HFSC)) == NULL)
 293                 return (EBADF);
 294         ifq = hif->hif_ifq;
 295
 296         ALTQ_LOCK(ifq);
 297
 298         if ((cl = clh_to_clp(hif, a->qid)) == NULL) {
 299                 ALTQ_UNLOCK(ifq);
 300                 return (EINVAL);
 301         }
 302
 303         get_class_stats(&stats, cl);
 304
 305         ALTQ_UNLOCK(ifq);
 306
 307         if ((error = copyout((caddr_t)&stats, ubuf, sizeof(stats))) != 0)
 308                 return (error);
 309         *nbytes = sizeof(stats);
 310         return (0);
 311 }
 312
 313 /*
 314  * bring the interface back to the initial state by discarding
 315  * all the filters and classes except the root class.
 316  */
 317 static int
 318 hfsc_clear_interface(struct hfsc_if *hif)
 319 {
 320         struct hfsc_class *cl;
 321
 322         if (hif->hif_rootclass == NULL)
 323                 return (0);
 324
 325
 326         /* clear out the classes */
 327         while ((cl = hif->hif_rootclass->cl_children) != NULL) {
 328                 /*
 329                  * remove the first leaf class found in the hierarchy
 330                  * then start over
 331                  */
 332                 for (; cl != NULL; cl = hfsc_nextclass(cl)) {
 333                         if (!is_a_parent_class(cl)) {
 334                                 hfsc_class_destroy(cl);
 335                                 break;
 336                         }
 337                 }
 338         }
 339
 340         return (0);
 341 }
 342
 343 static int
 344 hfsc_request(struct ifaltq *ifq, int req, void *arg)
 345 {
 346         struct hfsc_if *hif = (struct hfsc_if *)ifq->altq_disc;
 347
 348         crit_enter();
 349         switch (req) {
 350         case ALTRQ_PURGE:
 351                 hfsc_purge(hif);
 352                 break;
 353         }
 354         crit_exit();
 355         return (0);
 356 }
 357
 358 /* discard all the queued packets on the interface */
 359 static void
 360 hfsc_purge(struct hfsc_if *hif)
 361 {
 362         struct hfsc_class *cl;
 363
 364         for (cl = hif->hif_rootclass; cl != NULL; cl = hfsc_nextclass(cl)) {
 365                 if (!qempty(cl->cl_q))
 366                         hfsc_purgeq(cl);
 367         }
 368         if (ifq_is_enabled(hif->hif_ifq))
 369                 hif->hif_ifq->ifq_len = 0;
 370 }
 371
 372 struct hfsc_class *
 373 hfsc_class_create(struct hfsc_if *hif, struct service_curve *rsc,
 374                   struct service_curve *fsc, struct service_curve *usc,
 375                   struct hfsc_class *parent, int qlimit, int flags, int qid)
 376 {
 377         struct hfsc_class *cl, *p;
 378         int i;
 379
 380         if (hif->hif_classes >= HFSC_MAX_CLASSES)
 381                 return (NULL);
 382
 383 #ifndef ALTQ_RED
 384         if (flags & HFCF_RED) {
 385 #ifdef ALTQ_DEBUG
 386                 kprintf("hfsc_class_create: RED not configured for HFSC!\n");
 387 #endif
 388                 return (NULL);
 389         }
 390 #endif
 391
 392         cl = kmalloc(sizeof(*cl), M_ALTQ, M_WAITOK | M_ZERO);
 393         cl->cl_q = kmalloc(sizeof(*cl->cl_q), M_ALTQ, M_WAITOK | M_ZERO);
 394         cl->cl_actc = actlist_alloc();
 395
 396         if (qlimit == 0)
 397                 qlimit = 50;  /* use default */
 398         qlimit(cl->cl_q) = qlimit;
 399         qtype(cl->cl_q) = Q_DROPTAIL;
 400         qlen(cl->cl_q) = 0;
 401         cl->cl_flags = flags;
 402 #ifdef ALTQ_RED
 403         if (flags & (HFCF_RED|HFCF_RIO)) {
 404                 int red_flags, red_pkttime;
 405                 u_int m2;
 406
 407                 m2 = 0;
 408                 if (rsc != NULL && rsc->m2 > m2)
 409                         m2 = rsc->m2;
 410                 if (fsc != NULL && fsc->m2 > m2)
 411                         m2 = fsc->m2;
 412                 if (usc != NULL && usc->m2 > m2)
 413                         m2 = usc->m2;
 414
 415                 red_flags = 0;
 416                 if (flags & HFCF_ECN)
 417                         red_flags |= REDF_ECN;
 418 #ifdef ALTQ_RIO
 419                 if (flags & HFCF_CLEARDSCP)
 420                         red_flags |= RIOF_CLEARDSCP;
 421 #endif
 422                 if (m2 < 8)
 423                         red_pkttime = 1000 * 1000 * 1000; /* 1 sec */
 424                 else
 425                         red_pkttime = (int64_t)hif->hif_ifq->altq_ifp->if_mtu
 426                                 * 1000 * 1000 * 1000 / (m2 / 8);
 427                 if (flags & HFCF_RED) {
 428                         cl->cl_red = red_alloc(0, 0,
 429                             qlimit(cl->cl_q) * 10/100,
 430                             qlimit(cl->cl_q) * 30/100,
 431                             red_flags, red_pkttime);
 432                         if (cl->cl_red != NULL)
 433                                 qtype(cl->cl_q) = Q_RED;
 434                 }
 435 #ifdef ALTQ_RIO
 436                 else {
 437                         cl->cl_red = (red_t *)rio_alloc(0, NULL,
 438                             red_flags, red_pkttime);
 439                         if (cl->cl_red != NULL)
 440                                 qtype(cl->cl_q) = Q_RIO;
 441                 }
 442 #endif
 443         }
 444 #endif /* ALTQ_RED */
 445
 446         if (rsc != NULL && (rsc->m1 != 0 || rsc->m2 != 0)) {
 447                 cl->cl_rsc = kmalloc(sizeof(*cl->cl_rsc), M_ALTQ, M_WAITOK);
 448                 sc2isc(rsc, cl->cl_rsc);
 449                 rtsc_init(&cl->cl_deadline, cl->cl_rsc, 0, 0);
 450                 rtsc_init(&cl->cl_eligible, cl->cl_rsc, 0, 0);
 451         }
 452         if (fsc != NULL && (fsc->m1 != 0 || fsc->m2 != 0)) {
 453                 cl->cl_fsc = kmalloc(sizeof(*cl->cl_fsc), M_ALTQ, M_WAITOK);
 454                 if (cl->cl_fsc == NULL)
 455                         goto err_ret;
 456                 sc2isc(fsc, cl->cl_fsc);
 457                 rtsc_init(&cl->cl_virtual, cl->cl_fsc, 0, 0);
 458         }
 459         if (usc != NULL && (usc->m1 != 0 || usc->m2 != 0)) {
 460                 cl->cl_usc = kmalloc(sizeof(*cl->cl_usc), M_ALTQ, M_WAITOK);
 461                 if (cl->cl_usc == NULL)
 462                         goto err_ret;
 463                 sc2isc(usc, cl->cl_usc);
 464                 rtsc_init(&cl->cl_ulimit, cl->cl_usc, 0, 0);
 465         }
 466
 467         cl->cl_id = hif->hif_classid++;
 468         cl->cl_handle = qid;
 469         cl->cl_hif = hif;
 470         cl->cl_parent = parent;
 471
 472         crit_enter();
 473         hif->hif_classes++;
 474
 475         /*
 476          * find a free slot in the class table.  if the slot matching
 477          * the lower bits of qid is free, use this slot.  otherwise,
 478          * use the first free slot.
 479          */
 480         i = qid % HFSC_MAX_CLASSES;
 481         if (hif->hif_class_tbl[i] == NULL)
 482                 hif->hif_class_tbl[i] = cl;
 483         else {
 484                 for (i = 0; i < HFSC_MAX_CLASSES; i++) {
 485                         if (hif->hif_class_tbl[i] == NULL) {
 486                                 hif->hif_class_tbl[i] = cl;
 487                                 break;
 488                         }
 489                 }
 490                 if (i == HFSC_MAX_CLASSES) {
 491                         crit_exit();
 492                         goto err_ret;
 493                 }
 494         }
 495
 496         if (flags & HFCF_DEFAULTCLASS)
 497                 hif->hif_defaultclass = cl;
 498
 499         if (parent == NULL) {
 500                 /* this is root class */
 501                 hif->hif_rootclass = cl;
 502         } else if (parent->cl_children == NULL) {
 503                 /* add this class to the children list of the parent */
 504                 parent->cl_children = cl;
 505         } else {
 506                 p = parent->cl_children;
 507                 while (p->cl_siblings != NULL)
 508                         p = p->cl_siblings;
 509                 p->cl_siblings = cl;
 510         }
 511         crit_exit();
 512
 513         return (cl);
 514
 515  err_ret:
 516         if (cl->cl_actc != NULL)
 517                 actlist_destroy(cl->cl_actc);
 518         if (cl->cl_red != NULL) {
 519 #ifdef ALTQ_RIO
 520                 if (q_is_rio(cl->cl_q))
 521                         rio_destroy((rio_t *)cl->cl_red);
 522 #endif
 523 #ifdef ALTQ_RED
 524                 if (q_is_red(cl->cl_q))
 525                         red_destroy(cl->cl_red);
 526 #endif
 527         }
 528         if (cl->cl_fsc != NULL)
 529                 kfree(cl->cl_fsc, M_ALTQ);
 530         if (cl->cl_rsc != NULL)
 531                 kfree(cl->cl_rsc, M_ALTQ);
 532         if (cl->cl_usc != NULL)
 533                 kfree(cl->cl_usc, M_ALTQ);
 534         if (cl->cl_q != NULL)
 535                 kfree(cl->cl_q, M_ALTQ);
 536         kfree(cl, M_ALTQ);
 537         return (NULL);
 538 }
 539
 540 static int
 541 hfsc_class_destroy(struct hfsc_class *cl)
 542 {
 543         int i;
 544
 545         if (cl == NULL)
 546                 return (0);
 547
 548         if (is_a_parent_class(cl))
 549                 return (EBUSY);
 550
 551         crit_enter();
 552
 553         if (!qempty(cl->cl_q))
 554                 hfsc_purgeq(cl);
 555
 556         if (cl->cl_parent == NULL) {
 557                 /* this is root class */
 558         } else {
 559                 struct hfsc_class *p = cl->cl_parent->cl_children;
 560
 561                 if (p == cl) {
 562                         cl->cl_parent->cl_children = cl->cl_siblings;
 563                 } else {
 564                         do {
 565                                 if (p->cl_siblings == cl) {
 566                                         p->cl_siblings = cl->cl_siblings;
 567                                         break;
 568                                 }
 569                         } while ((p = p->cl_siblings) != NULL);
 570                 }
 571                 KKASSERT(p != NULL);
 572         }
 573
 574         for (i = 0; i < HFSC_MAX_CLASSES; i++) {
 575                 if (cl->cl_hif->hif_class_tbl[i] == cl) {
 576                         cl->cl_hif->hif_class_tbl[i] = NULL;
 577                         break;
 578                 }
 579         }
 580
 581         cl->cl_hif->hif_classes--;
 582         crit_exit();
 583
 584         actlist_destroy(cl->cl_actc);
 585
 586         if (cl->cl_red != NULL) {
 587 #ifdef ALTQ_RIO
 588                 if (q_is_rio(cl->cl_q))
 589                         rio_destroy((rio_t *)cl->cl_red);
 590 #endif
 591 #ifdef ALTQ_RED
 592                 if (q_is_red(cl->cl_q))
 593                         red_destroy(cl->cl_red);
 594 #endif
 595         }
 596
 597         if (cl == cl->cl_hif->hif_rootclass)
 598                 cl->cl_hif->hif_rootclass = NULL;
 599         if (cl == cl->cl_hif->hif_defaultclass)
 600                 cl->cl_hif->hif_defaultclass = NULL;
 601
 602         if (cl->cl_usc != NULL)
 603                 kfree(cl->cl_usc, M_ALTQ);
 604         if (cl->cl_fsc != NULL)
 605                 kfree(cl->cl_fsc, M_ALTQ);
 606         if (cl->cl_rsc != NULL)
 607                 kfree(cl->cl_rsc, M_ALTQ);
 608         kfree(cl->cl_q, M_ALTQ);
 609         kfree(cl, M_ALTQ);
 610
 611         return (0);
 612 }
 613
 614 /*
 615  * hfsc_nextclass returns the next class in the tree.
 616  *   usage:
 617  *      for (cl = hif->hif_rootclass; cl != NULL; cl = hfsc_nextclass(cl))
 618  *              do_something;
 619  */
 620 static struct hfsc_class *
 621 hfsc_nextclass(struct hfsc_class *cl)
 622 {
 623         if (cl->cl_children != NULL) {
 624                 cl = cl->cl_children;
 625         } else if (cl->cl_siblings != NULL) {
 626                 cl = cl->cl_siblings;
 627         } else {
 628                 while ((cl = cl->cl_parent) != NULL) {
 629                         if (cl->cl_siblings != NULL) {
 630                                 cl = cl->cl_siblings;
 631                                 break;
 632                         }
 633                 }
 634         }
 635
 636         return (cl);
 637 }
 638
 639 /*
 640  * hfsc_enqueue is an enqueue function to be registered to
 641  * (*altq_enqueue) in struct ifaltq.
 642  */
 643 static int
 644 hfsc_enqueue(struct ifaltq *ifq, struct mbuf *m, struct altq_pktattr *pktattr)
 645 {
 646         struct hfsc_if  *hif = (struct hfsc_if *)ifq->altq_disc;
 647         struct hfsc_class *cl;
 648         struct pf_mtag *pf;
 649         int len;
 650
 651         /* grab class set by classifier */
 652         if ((m->m_flags & M_PKTHDR) == 0) {
 653                 /* should not happen */
 654                 if_printf(ifq->altq_ifp, "altq: packet does not have pkthdr\n");
 655                 m_freem(m);
 656                 return (ENOBUFS);
 657         }
 658         crit_enter();
 659         if ((pf = altq_find_pftag(m)) != NULL)
 660                 cl = clh_to_clp(hif, pf->qid);
 661         else
 662                 cl = NULL;
 663         if (cl == NULL || is_a_parent_class(cl)) {
 664                 cl = hif->hif_defaultclass;
 665                 if (cl == NULL) {
 666                         m_freem(m);
 667                         crit_exit();
 668                         return (ENOBUFS);
 669                 }
 670         }
 671         cl->cl_pktattr = NULL;
 672         len = m_pktlen(m);
 673         if (hfsc_addq(cl, m) != 0) {
 674                 /* drop occurred.  mbuf was freed in hfsc_addq. */
 675                 PKTCNTR_ADD(&cl->cl_stats.drop_cnt, len);
 676                 crit_exit();
 677                 return (ENOBUFS);
 678         }
 679         ifq->ifq_len++;
 680         cl->cl_hif->hif_packets++;
 681
 682         /* successfully queued. */
 683         if (qlen(cl->cl_q) == 1)
 684                 set_active(cl, m_pktlen(m));
 685         crit_exit();
 686         return (0);
 687 }
 688
 689 /*
 690  * hfsc_dequeue is a dequeue function to be registered to
 691  * (*altq_dequeue) in struct ifaltq.
 692  *
 693  * note: ALTDQ_POLL returns the next packet without removing the packet
 694  *      from the queue.  ALTDQ_REMOVE is a normal dequeue operation.
 695  *      ALTDQ_REMOVE must return the same packet if called immediately
 696  *      after ALTDQ_POLL.
 697  */
 698 static struct mbuf *
 699 hfsc_dequeue(struct ifaltq *ifq, struct mbuf *mpolled, int op)
 700 {
 701         struct hfsc_if  *hif = (struct hfsc_if *)ifq->altq_disc;
 702         struct hfsc_class *cl;
 703         struct mbuf *m;
 704         int len, next_len;
 705         int realtime = 0;
 706         uint64_t cur_time;
 707
 708         if (hif->hif_packets == 0) {
 709                 /* no packet in the tree */
 710                 return (NULL);
 711         }
 712
 713         crit_enter();
 714         cur_time = read_machclk();
 715
 716         if (op == ALTDQ_REMOVE && hif->hif_pollcache != NULL) {
 717                 cl = hif->hif_pollcache;
 718                 hif->hif_pollcache = NULL;
 719                 /* check if the class was scheduled by real-time criteria */
 720                 if (cl->cl_rsc != NULL)
 721                         realtime = (cl->cl_e <= cur_time);
 722         } else {
 723                 /*
 724                  * if there are eligible classes, use real-time criteria.
 725                  * find the class with the minimum deadline among
 726                  * the eligible classes.
 727                  */
 728                 if ((cl = ellist_get_mindl(hif->hif_eligible, cur_time)) != NULL) {
 729                         realtime = 1;
 730                 } else {
 731 #ifdef ALTQ_DEBUG
 732                         int fits = 0;
 733 #endif
 734                         /*
 735                          * use link-sharing criteria
 736                          * get the class with the minimum vt in the hierarchy
 737                          */
 738                         cl = hif->hif_rootclass;
 739                         while (is_a_parent_class(cl)) {
 740
 741                                 cl = actlist_firstfit(cl, cur_time);
 742                                 if (cl == NULL) {
 743 #ifdef ALTQ_DEBUG
 744                                         if (fits > 0)
 745                                                 kprintf("%d fit but none found\n",fits);
 746 #endif
 747                                         m = NULL;
 748                                         goto done;
 749                                 }
 750                                 /*
 751                                  * update parent's cl_cvtmin.
 752                                  * don't update if the new vt is smaller.
 753                                  */
 754                                 if (cl->cl_parent->cl_cvtmin < cl->cl_vt)
 755                                         cl->cl_parent->cl_cvtmin = cl->cl_vt;
 756 #ifdef ALTQ_DEBUG
 757                                 fits++;
 758 #endif
 759                         }
 760                 }
 761
 762                 if (op == ALTDQ_POLL) {
 763                         hif->hif_pollcache = cl;
 764                         m = hfsc_pollq(cl);
 765                         goto done;
 766                 }
 767         }
 768
 769         m = hfsc_getq(cl);
 770         if (m == NULL)
 771                 panic("hfsc_dequeue:");
 772         len = m_pktlen(m);
 773         cl->cl_hif->hif_packets--;
 774         ifq->ifq_len--;
 775         PKTCNTR_ADD(&cl->cl_stats.xmit_cnt, len);
 776
 777         update_vf(cl, len, cur_time);
 778         if (realtime)
 779                 cl->cl_cumul += len;
 780
 781         if (!qempty(cl->cl_q)) {
 782                 if (cl->cl_rsc != NULL) {
 783                         /* update ed */
 784                         next_len = m_pktlen(qhead(cl->cl_q));
 785
 786                         if (realtime)
 787                                 update_ed(cl, next_len);
 788                         else
 789                                 update_d(cl, next_len);
 790                 }
 791         } else {
 792                 /* the class becomes passive */
 793                 set_passive(cl);
 794         }
 795 done:
 796         crit_exit();
 797         KKASSERT(mpolled == NULL || m == mpolled);
 798         return (m);
 799 }
 800
 801 static int
 802 hfsc_addq(struct hfsc_class *cl, struct mbuf *m)
 803 {
 804
 805 #ifdef ALTQ_RIO
 806         if (q_is_rio(cl->cl_q))
 807                 return rio_addq((rio_t *)cl->cl_red, cl->cl_q,
 808                                 m, cl->cl_pktattr);
 809 #endif
 810 #ifdef ALTQ_RED
 811         if (q_is_red(cl->cl_q))
 812                 return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
 813 #endif
 814         if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
 815                 m_freem(m);
 816                 return (-1);
 817         }
 818
 819         if (cl->cl_flags & HFCF_CLEARDSCP)
 820                 write_dsfield(m, cl->cl_pktattr, 0);
 821
 822         _addq(cl->cl_q, m);
 823
 824         return (0);
 825 }
 826
 827 static struct mbuf *
 828 hfsc_getq(struct hfsc_class *cl)
 829 {
 830 #ifdef ALTQ_RIO
 831         if (q_is_rio(cl->cl_q))
 832                 return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
 833 #endif
 834 #ifdef ALTQ_RED
 835         if (q_is_red(cl->cl_q))
 836                 return red_getq(cl->cl_red, cl->cl_q);
 837 #endif
 838         return _getq(cl->cl_q);
 839 }
 840
 841 static struct mbuf *
 842 hfsc_pollq(struct hfsc_class *cl)
 843 {
 844         return qhead(cl->cl_q);
 845 }
 846
 847 static void
 848 hfsc_purgeq(struct hfsc_class *cl)
 849 {
 850         struct mbuf *m;
 851
 852         if (qempty(cl->cl_q))
 853                 return;
 854
 855         while ((m = _getq(cl->cl_q)) != NULL) {
 856                 PKTCNTR_ADD(&cl->cl_stats.drop_cnt, m_pktlen(m));
 857                 m_freem(m);
 858                 cl->cl_hif->hif_packets--;
 859                 cl->cl_hif->hif_ifq->ifq_len--;
 860         }
 861         KKASSERT(qlen(cl->cl_q) == 0);
 862
 863         update_vf(cl, 0, 0);    /* remove cl from the actlist */
 864         set_passive(cl);
 865 }
 866
 867 static void
 868 set_active(struct hfsc_class *cl, int len)
 869 {
 870         if (cl->cl_rsc != NULL)
 871                 init_ed(cl, len);
 872         if (cl->cl_fsc != NULL)
 873                 init_vf(cl, len);
 874
 875         cl->cl_stats.period++;
 876 }
 877
 878 static void
 879 set_passive(struct hfsc_class *cl)
 880 {
 881         if (cl->cl_rsc != NULL)
 882                 ellist_remove(cl);
 883
 884         /*
 885          * actlist is now handled in update_vf() so that update_vf(cl, 0, 0)
 886          * needs to be called explicitly to remove a class from actlist
 887          */
 888 }
 889
 890 static void
 891 init_ed(struct hfsc_class *cl, int next_len)
 892 {
 893         uint64_t cur_time;
 894
 895         cur_time = read_machclk();
 896
 897         /* update the deadline curve */
 898         rtsc_min(&cl->cl_deadline, cl->cl_rsc, cur_time, cl->cl_cumul);
 899
 900         /*
 901          * update the eligible curve.
 902          * for concave, it is equal to the deadline curve.
 903          * for convex, it is a linear curve with slope m2.
 904          */
 905         cl->cl_eligible = cl->cl_deadline;
 906         if (cl->cl_rsc->sm1 <= cl->cl_rsc->sm2) {
 907                 cl->cl_eligible.dx = 0;
 908                 cl->cl_eligible.dy = 0;
 909         }
 910
 911         /* compute e and d */
 912         cl->cl_e = rtsc_y2x(&cl->cl_eligible, cl->cl_cumul);
 913         cl->cl_d = rtsc_y2x(&cl->cl_deadline, cl->cl_cumul + next_len);
 914
 915         ellist_insert(cl);
 916 }
 917
 918 static void
 919 update_ed(struct hfsc_class *cl, int next_len)
 920 {
 921         cl->cl_e = rtsc_y2x(&cl->cl_eligible, cl->cl_cumul);
 922         cl->cl_d = rtsc_y2x(&cl->cl_deadline, cl->cl_cumul + next_len);
 923
 924         ellist_update(cl);
 925 }
 926
 927 static void
 928 update_d(struct hfsc_class *cl, int next_len)
 929 {
 930         cl->cl_d = rtsc_y2x(&cl->cl_deadline, cl->cl_cumul + next_len);
 931 }
 932
 933 static void
 934 init_vf(struct hfsc_class *cl, int len)
 935 {
 936         struct hfsc_class *max_cl, *p;
 937         uint64_t vt, f, cur_time;
 938         int go_active;
 939
 940         cur_time = 0;
 941         go_active = 1;
 942         for ( ; cl->cl_parent != NULL; cl = cl->cl_parent) {
 943                 if (go_active && cl->cl_nactive++ == 0)
 944                         go_active = 1;
 945                 else
 946                         go_active = 0;
 947
 948                 if (go_active) {
 949                         max_cl = actlist_last(cl->cl_parent->cl_actc);
 950                         if (max_cl != NULL) {
 951                                 /*
 952                                  * set vt to the average of the min and max
 953                                  * classes.  if the parent's period didn't
 954                                  * change, don't decrease vt of the class.
 955                                  */
 956                                 vt = max_cl->cl_vt;
 957                                 if (cl->cl_parent->cl_cvtmin != 0)
 958                                         vt = (cl->cl_parent->cl_cvtmin + vt)/2;
 959
 960                                 if (cl->cl_parent->cl_vtperiod !=
 961                                     cl->cl_parentperiod || vt > cl->cl_vt)
 962                                         cl->cl_vt = vt;
 963                         } else {
 964                                 /*
 965                                  * first child for a new parent backlog period.
 966                                  * add parent's cvtmax to vtoff of children
 967                                  * to make a new vt (vtoff + vt) larger than
 968                                  * the vt in the last period for all children.
 969                                  */
 970                                 vt = cl->cl_parent->cl_cvtmax;
 971                                 for (p = cl->cl_parent->cl_children; p != NULL;
 972                                      p = p->cl_siblings)
 973                                         p->cl_vtoff += vt;
 974                                 cl->cl_vt = 0;
 975                                 cl->cl_parent->cl_cvtmax = 0;
 976                                 cl->cl_parent->cl_cvtmin = 0;
 977                         }
 978                         cl->cl_initvt = cl->cl_vt;
 979
 980                         /* update the virtual curve */
 981                         vt = cl->cl_vt + cl->cl_vtoff;
 982                         rtsc_min(&cl->cl_virtual, cl->cl_fsc, vt, cl->cl_total);
 983                         if (cl->cl_virtual.x == vt) {
 984                                 cl->cl_virtual.x -= cl->cl_vtoff;
 985                                 cl->cl_vtoff = 0;
 986                         }
 987                         cl->cl_vtadj = 0;
 988
 989                         cl->cl_vtperiod++;  /* increment vt period */
 990                         cl->cl_parentperiod = cl->cl_parent->cl_vtperiod;
 991                         if (cl->cl_parent->cl_nactive == 0)
 992                                 cl->cl_parentperiod++;
 993                         cl->cl_f = 0;
 994
 995                         actlist_insert(cl);
 996
 997                         if (cl->cl_usc != NULL) {
 998                                 /* class has upper limit curve */
 999                                 if (cur_time == 0)
1000                                         cur_time = read_machclk();
1001
1002                                 /* update the ulimit curve */
1003                                 rtsc_min(&cl->cl_ulimit, cl->cl_usc, cur_time,
1004                                     cl->cl_total);
1005                                 /* compute myf */
1006                                 cl->cl_myf = rtsc_y2x(&cl->cl_ulimit,
1007                                     cl->cl_total);
1008                                 cl->cl_myfadj = 0;
1009                         }
1010                 }
1011
1012                 if (cl->cl_myf > cl->cl_cfmin)
1013                         f = cl->cl_myf;
1014                 else
1015                         f = cl->cl_cfmin;
1016                 if (f != cl->cl_f) {
1017                         cl->cl_f = f;
1018                         update_cfmin(cl->cl_parent);
1019                 }
1020         }
1021 }
1022
1023 static void
1024 update_vf(struct hfsc_class *cl, int len, uint64_t cur_time)
1025 {
1026         uint64_t f, myf_bound, delta;
1027         int go_passive;
1028
1029         go_passive = qempty(cl->cl_q);
1030
1031         for (; cl->cl_parent != NULL; cl = cl->cl_parent) {
1032                 cl->cl_total += len;
1033
1034                 if (cl->cl_fsc == NULL || cl->cl_nactive == 0)
1035                         continue;
1036
1037                 if (go_passive && --cl->cl_nactive == 0)
1038                         go_passive = 1;
1039                 else
1040                         go_passive = 0;
1041
1042                 if (go_passive) {
1043                         /* no more active child, going passive */
1044
1045                         /* update cvtmax of the parent class */
1046                         if (cl->cl_vt > cl->cl_parent->cl_cvtmax)
1047                                 cl->cl_parent->cl_cvtmax = cl->cl_vt;
1048
1049                         /* remove this class from the vt list */
1050                         actlist_remove(cl);
1051
1052                         update_cfmin(cl->cl_parent);
1053
1054                         continue;
1055                 }
1056
1057                 /*
1058                  * update vt and f
1059                  */
1060                 cl->cl_vt = rtsc_y2x(&cl->cl_virtual, cl->cl_total)
1061                     - cl->cl_vtoff + cl->cl_vtadj;
1062
1063                 /*
1064                  * if vt of the class is smaller than cvtmin,
1065                  * the class was skipped in the past due to non-fit.
1066                  * if so, we need to adjust vtadj.
1067                  */
1068                 if (cl->cl_vt < cl->cl_parent->cl_cvtmin) {
1069                         cl->cl_vtadj += cl->cl_parent->cl_cvtmin - cl->cl_vt;
1070                         cl->cl_vt = cl->cl_parent->cl_cvtmin;
1071                 }
1072
1073                 /* update the vt list */
1074                 actlist_update(cl);
1075
1076                 if (cl->cl_usc != NULL) {
1077                         cl->cl_myf = cl->cl_myfadj
1078                             + rtsc_y2x(&cl->cl_ulimit, cl->cl_total);
1079
1080                         /*
1081                          * if myf lags behind by more than one clock tick
1082                          * from the current time, adjust myfadj to prevent
1083                          * a rate-limited class from going greedy.
1084                          * in a steady state under rate-limiting, myf
1085                          * fluctuates within one clock tick.
1086                          */
1087                         myf_bound = cur_time - machclk_per_tick;
1088                         if (cl->cl_myf < myf_bound) {
1089                                 delta = cur_time - cl->cl_myf;
1090                                 cl->cl_myfadj += delta;
1091                                 cl->cl_myf += delta;
1092                         }
1093                 }
1094
1095                 /* cl_f is max(cl_myf, cl_cfmin) */
1096                 if (cl->cl_myf > cl->cl_cfmin)
1097                         f = cl->cl_myf;
1098                 else
1099                         f = cl->cl_cfmin;
1100                 if (f != cl->cl_f) {
1101                         cl->cl_f = f;
1102                         update_cfmin(cl->cl_parent);
1103                 }
1104         }
1105 }
1106
1107 static void
1108 update_cfmin(struct hfsc_class *cl)
1109 {
1110         struct hfsc_class *p;
1111         uint64_t cfmin;
1112
1113         if (TAILQ_EMPTY(cl->cl_actc)) {
1114                 cl->cl_cfmin = 0;
1115                 return;
1116         }
1117         cfmin = HT_INFINITY;
1118         TAILQ_FOREACH(p, cl->cl_actc, cl_actlist) {
1119                 if (p->cl_f == 0) {
1120                         cl->cl_cfmin = 0;
1121                         return;
1122                 }
1123                 if (p->cl_f < cfmin)
1124                         cfmin = p->cl_f;
1125         }
1126         cl->cl_cfmin = cfmin;
1127 }
1128
1129 /*
1130  * TAILQ based ellist and actlist implementation
1131  * (ion wanted to make a calendar queue based implementation)
1132  */
1133 /*
1134  * eligible list holds backlogged classes being sorted by their eligible times.
1135  * there is one eligible list per interface.
1136  */
1137
1138 static ellist_t *
1139 ellist_alloc(void)
1140 {
1141         ellist_t *head;
1142
1143         head = kmalloc(sizeof(ellist_t *), M_ALTQ, M_WAITOK);
1144         TAILQ_INIT(head);
1145         return (head);
1146 }
1147
1148 static void
1149 ellist_destroy(ellist_t *head)
1150 {
1151         kfree(head, M_ALTQ);
1152 }
1153
1154 static void
1155 ellist_insert(struct hfsc_class *cl)
1156 {
1157         struct hfsc_if *hif = cl->cl_hif;
1158         struct hfsc_class *p;
1159
1160         /* check the last entry first */
1161         if ((p = TAILQ_LAST(hif->hif_eligible, _eligible)) == NULL ||
1162             p->cl_e <= cl->cl_e) {
1163                 TAILQ_INSERT_TAIL(hif->hif_eligible, cl, cl_ellist);
1164                 return;
1165         }
1166
1167         TAILQ_FOREACH(p, hif->hif_eligible, cl_ellist) {
1168                 if (cl->cl_e < p->cl_e) {
1169                         TAILQ_INSERT_BEFORE(p, cl, cl_ellist);
1170                         return;
1171                 }
1172         }
1173         KKASSERT(0); /* should not reach here */
1174 }
1175
1176 static void
1177 ellist_remove(struct hfsc_class *cl)
1178 {
1179         struct hfsc_if *hif = cl->cl_hif;
1180
1181         TAILQ_REMOVE(hif->hif_eligible, cl, cl_ellist);
1182 }
1183
1184 static void
1185 ellist_update(struct hfsc_class *cl)
1186 {
1187         struct hfsc_if *hif = cl->cl_hif;
1188         struct hfsc_class *p, *last;
1189
1190         /*
1191          * the eligible time of a class increases monotonically.
1192          * if the next entry has a larger eligible time, nothing to do.
1193          */
1194         p = TAILQ_NEXT(cl, cl_ellist);
1195         if (p == NULL || cl->cl_e <= p->cl_e)
1196                 return;
1197
1198         /* check the last entry */
1199         last = TAILQ_LAST(hif->hif_eligible, _eligible);
1200         KKASSERT(last != NULL);
1201         if (last->cl_e <= cl->cl_e) {
1202                 TAILQ_REMOVE(hif->hif_eligible, cl, cl_ellist);
1203                 TAILQ_INSERT_TAIL(hif->hif_eligible, cl, cl_ellist);
1204                 return;
1205         }
1206
1207         /*
1208          * the new position must be between the next entry
1209          * and the last entry
1210          */
1211         while ((p = TAILQ_NEXT(p, cl_ellist)) != NULL) {
1212                 if (cl->cl_e < p->cl_e) {
1213                         TAILQ_REMOVE(hif->hif_eligible, cl, cl_ellist);
1214                         TAILQ_INSERT_BEFORE(p, cl, cl_ellist);
1215                         return;
1216                 }
1217         }
1218         KKASSERT(0); /* should not reach here */
1219 }
1220
1221 /* find the class with the minimum deadline among the eligible classes */
1222 struct hfsc_class *
1223 ellist_get_mindl(ellist_t *head, uint64_t cur_time)
1224 {
1225         struct hfsc_class *p, *cl = NULL;
1226
1227         TAILQ_FOREACH(p, head, cl_ellist) {
1228                 if (p->cl_e > cur_time)
1229                         break;
1230                 if (cl == NULL || p->cl_d < cl->cl_d)
1231                         cl = p;
1232         }
1233         return (cl);
1234 }
1235
1236 /*
1237  * active children list holds backlogged child classes being sorted
1238  * by their virtual time.
1239  * each intermediate class has one active children list.
1240  */
1241 static actlist_t *
1242 actlist_alloc(void)
1243 {
1244         actlist_t *head;
1245
1246         head = kmalloc(sizeof(*head), M_ALTQ, M_WAITOK);
1247         TAILQ_INIT(head);
1248         return (head);
1249 }
1250
1251 static void
1252 actlist_destroy(actlist_t *head)
1253 {
1254         kfree(head, M_ALTQ);
1255 }
1256 static void
1257 actlist_insert(struct hfsc_class *cl)
1258 {
1259         struct hfsc_class *p;
1260
1261         /* check the last entry first */
1262         if ((p = TAILQ_LAST(cl->cl_parent->cl_actc, _active)) == NULL
1263             || p->cl_vt <= cl->cl_vt) {
1264                 TAILQ_INSERT_TAIL(cl->cl_parent->cl_actc, cl, cl_actlist);
1265                 return;
1266         }
1267
1268         TAILQ_FOREACH(p, cl->cl_parent->cl_actc, cl_actlist) {
1269                 if (cl->cl_vt < p->cl_vt) {
1270                         TAILQ_INSERT_BEFORE(p, cl, cl_actlist);
1271                         return;
1272                 }
1273         }
1274         KKASSERT(0); /* should not reach here */
1275 }
1276
1277 static void
1278 actlist_remove(struct hfsc_class *cl)
1279 {
1280         TAILQ_REMOVE(cl->cl_parent->cl_actc, cl, cl_actlist);
1281 }
1282
1283 static void
1284 actlist_update(struct hfsc_class *cl)
1285 {
1286         struct hfsc_class *p, *last;
1287
1288         /*
1289          * the virtual time of a class increases monotonically during its
1290          * backlogged period.
1291          * if the next entry has a larger virtual time, nothing to do.
1292          */
1293         p = TAILQ_NEXT(cl, cl_actlist);
1294         if (p == NULL || cl->cl_vt < p->cl_vt)
1295                 return;
1296
1297         /* check the last entry */
1298         last = TAILQ_LAST(cl->cl_parent->cl_actc, _active);
1299         KKASSERT(last != NULL);
1300         if (last->cl_vt <= cl->cl_vt) {
1301                 TAILQ_REMOVE(cl->cl_parent->cl_actc, cl, cl_actlist);
1302                 TAILQ_INSERT_TAIL(cl->cl_parent->cl_actc, cl, cl_actlist);
1303                 return;
1304         }
1305
1306         /*
1307          * the new position must be between the next entry
1308          * and the last entry
1309          */
1310         while ((p = TAILQ_NEXT(p, cl_actlist)) != NULL) {
1311                 if (cl->cl_vt < p->cl_vt) {
1312                         TAILQ_REMOVE(cl->cl_parent->cl_actc, cl, cl_actlist);
1313                         TAILQ_INSERT_BEFORE(p, cl, cl_actlist);
1314                         return;
1315                 }
1316         }
1317         KKASSERT(0); /* should not reach here */
1318 }
1319
1320 static struct hfsc_class *
1321 actlist_firstfit(struct hfsc_class *cl, uint64_t cur_time)
1322 {
1323         struct hfsc_class *p;
1324
1325         TAILQ_FOREACH(p, cl->cl_actc, cl_actlist) {
1326                 if (p->cl_f <= cur_time)
1327                         return (p);
1328         }
1329         return (NULL);
1330 }
1331
1332 /*
1333  * service curve support functions
1334  *
1335  *  external service curve parameters
1336  *      m: bits/sec
1337  *      d: msec
1338  *  internal service curve parameters
1339  *      sm: (bytes/tsc_interval) << SM_SHIFT
1340  *      ism: (tsc_count/byte) << ISM_SHIFT
1341  *      dx: tsc_count
1342  *
1343  * SM_SHIFT and ISM_SHIFT are scaled in order to keep effective digits.
1344  * we should be able to handle 100K-1Gbps linkspeed with 200Hz-1GHz CPU
1345  * speed.  SM_SHIFT and ISM_SHIFT are selected to have at least 3 effective
1346  * digits in decimal using the following table.
1347  *
1348  *  bits/sec    100Kbps     1Mbps     10Mbps     100Mbps    1Gbps
1349  *  ----------+-------------------------------------------------------
1350  *  bytes/nsec  12.5e-6    125e-6     1250e-6    12500e-6   125000e-6
1351  *  sm(500MHz)  25.0e-6    250e-6     2500e-6    25000e-6   250000e-6
1352  *  sm(200MHz)  62.5e-6    625e-6     6250e-6    62500e-6   625000e-6
1353  *
1354  *  nsec/byte   80000      8000       800        80         8
1355  *  ism(500MHz) 40000      4000       400        40         4
1356  *  ism(200MHz) 16000      1600       160        16         1.6
1357  */
1358 #define SM_SHIFT        24
1359 #define ISM_SHIFT       10
1360
1361 #define SM_MASK         ((1LL << SM_SHIFT) - 1)
1362 #define ISM_MASK        ((1LL << ISM_SHIFT) - 1)
1363
1364 static __inline uint64_t
1365 seg_x2y(uint64_t x, uint64_t sm)
1366 {
1367         uint64_t y;
1368
1369         /*
1370          * compute
1371          *      y = x * sm >> SM_SHIFT
1372          * but divide it for the upper and lower bits to avoid overflow
1373          */
1374         y = (x >> SM_SHIFT) * sm + (((x & SM_MASK) * sm) >> SM_SHIFT);
1375         return (y);
1376 }
1377
1378 static __inline uint64_t
1379 seg_y2x(uint64_t y, uint64_t ism)
1380 {
1381         uint64_t x;
1382
1383         if (y == 0)
1384                 x = 0;
1385         else if (ism == HT_INFINITY)
1386                 x = HT_INFINITY;
1387         else
1388                 x = (y >> ISM_SHIFT) * ism + (((y & ISM_MASK) * ism) >> ISM_SHIFT);
1389
1390         return (x);
1391 }
1392
1393 static __inline uint64_t
1394 m2sm(u_int m)
1395 {
1396         uint64_t sm;
1397
1398         sm = ((uint64_t)m << SM_SHIFT) / 8 / machclk_freq;
1399         return (sm);
1400 }
1401
1402 static __inline uint64_t
1403 m2ism(u_int m)
1404 {
1405         uint64_t ism;
1406
1407         if (m == 0)
1408                 ism = HT_INFINITY;
1409         else
1410                 ism = ((uint64_t)machclk_freq << ISM_SHIFT) * 8 / m;
1411         return (ism);
1412 }
1413
1414 static __inline uint64_t
1415 d2dx(u_int d)
1416 {
1417         uint64_t dx;
1418
1419         dx = ((uint64_t)d * machclk_freq) / 1000;
1420         return (dx);
1421 }
1422
1423 static u_int
1424 sm2m(uint64_t sm)
1425 {
1426         uint64_t m;
1427
1428         m = (sm * 8 * machclk_freq) >> SM_SHIFT;
1429         return ((u_int)m);
1430 }
1431
1432 static u_int
1433 dx2d(uint64_t dx)
1434 {
1435         uint64_t d;
1436
1437         d = dx * 1000 / machclk_freq;
1438         return ((u_int)d);
1439 }
1440
1441 static void
1442 sc2isc(struct service_curve *sc, struct internal_sc *isc)
1443 {
1444         isc->sm1 = m2sm(sc->m1);
1445         isc->ism1 = m2ism(sc->m1);
1446         isc->dx = d2dx(sc->d);
1447         isc->dy = seg_x2y(isc->dx, isc->sm1);
1448         isc->sm2 = m2sm(sc->m2);
1449         isc->ism2 = m2ism(sc->m2);
1450 }
1451
1452 /*
1453  * initialize the runtime service curve with the given internal
1454  * service curve starting at (x, y).
1455  */
1456 static void
1457 rtsc_init(struct runtime_sc *rtsc, struct internal_sc *isc, uint64_t x, uint64_t y)
1458 {
1459         rtsc->x = x;
1460         rtsc->y = y;
1461         rtsc->sm1 = isc->sm1;
1462         rtsc->ism1 = isc->ism1;
1463         rtsc->dx = isc->dx;
1464         rtsc->dy = isc->dy;
1465         rtsc->sm2 = isc->sm2;
1466         rtsc->ism2 = isc->ism2;
1467 }
1468
1469 /*
1470  * calculate the y-projection of the runtime service curve by the
1471  * given x-projection value
1472  */
1473 static uint64_t
1474 rtsc_y2x(struct runtime_sc *rtsc, uint64_t y)
1475 {
1476         uint64_t x;
1477
1478         if (y < rtsc->y) {
1479                 x = rtsc->x;
1480         } else if (y <= rtsc->y + rtsc->dy) {
1481                 /* x belongs to the 1st segment */
1482                 if (rtsc->dy == 0)
1483                         x = rtsc->x + rtsc->dx;
1484                 else
1485                         x = rtsc->x + seg_y2x(y - rtsc->y, rtsc->ism1);
1486         } else {
1487                 /* x belongs to the 2nd segment */
1488                 x = rtsc->x + rtsc->dx
1489                     + seg_y2x(y - rtsc->y - rtsc->dy, rtsc->ism2);
1490         }
1491         return (x);
1492 }
1493
1494 static uint64_t
1495 rtsc_x2y(struct runtime_sc *rtsc, uint64_t x)
1496 {
1497         uint64_t y;
1498
1499         if (x <= rtsc->x) {
1500                 y = rtsc->y;
1501         } else if (x <= rtsc->x + rtsc->dx) {
1502                 /* y belongs to the 1st segment */
1503                 y = rtsc->y + seg_x2y(x - rtsc->x, rtsc->sm1);
1504         } else
1505                 /* y belongs to the 2nd segment */
1506                 y = rtsc->y + rtsc->dy
1507                     + seg_x2y(x - rtsc->x - rtsc->dx, rtsc->sm2);
1508         return (y);
1509 }
1510
1511 /*
1512  * update the runtime service curve by taking the minimum of the current
1513  * runtime service curve and the service curve starting at (x, y).
1514  */
1515 static void
1516 rtsc_min(struct runtime_sc *rtsc, struct internal_sc *isc, uint64_t x, uint64_t y)
1517 {
1518         uint64_t y1, y2, dx, dy;
1519
1520         if (isc->sm1 <= isc->sm2) {
1521                 /* service curve is convex */
1522                 y1 = rtsc_x2y(rtsc, x);
1523                 if (y1 < y)
1524                         /* the current rtsc is smaller */
1525                         return;
1526                 rtsc->x = x;
1527                 rtsc->y = y;
1528                 return;
1529         }
1530
1531         /*
1532          * service curve is concave
1533          * compute the two y values of the current rtsc
1534          *      y1: at x
1535          *      y2: at (x + dx)
1536          */
1537         y1 = rtsc_x2y(rtsc, x);
1538         if (y1 <= y) {
1539                 /* rtsc is below isc, no change to rtsc */
1540                 return;
1541         }
1542
1543         y2 = rtsc_x2y(rtsc, x + isc->dx);
1544         if (y2 >= y + isc->dy) {
1545                 /* rtsc is above isc, replace rtsc by isc */
1546                 rtsc->x = x;
1547                 rtsc->y = y;
1548                 rtsc->dx = isc->dx;
1549                 rtsc->dy = isc->dy;
1550                 return;
1551         }
1552
1553         /*
1554          * the two curves intersect
1555          * compute the offsets (dx, dy) using the reverse
1556          * function of seg_x2y()
1557          *      seg_x2y(dx, sm1) == seg_x2y(dx, sm2) + (y1 - y)
1558          */
1559         dx = ((y1 - y) << SM_SHIFT) / (isc->sm1 - isc->sm2);
1560         /*
1561          * check if (x, y1) belongs to the 1st segment of rtsc.
1562          * if so, add the offset.
1563          */
1564         if (rtsc->x + rtsc->dx > x)
1565                 dx += rtsc->x + rtsc->dx - x;
1566         dy = seg_x2y(dx, isc->sm1);
1567
1568         rtsc->x = x;
1569         rtsc->y = y;
1570         rtsc->dx = dx;
1571         rtsc->dy = dy;
1572 }
1573
1574 static void
1575 get_class_stats(struct hfsc_classstats *sp, struct hfsc_class *cl)
1576 {
1577         sp->class_id = cl->cl_id;
1578         sp->class_handle = cl->cl_handle;
1579
1580         if (cl->cl_rsc != NULL) {
1581                 sp->rsc.m1 = sm2m(cl->cl_rsc->sm1);
1582                 sp->rsc.d = dx2d(cl->cl_rsc->dx);
1583                 sp->rsc.m2 = sm2m(cl->cl_rsc->sm2);
1584         } else {
1585                 sp->rsc.m1 = 0;
1586                 sp->rsc.d = 0;
1587                 sp->rsc.m2 = 0;
1588         }
1589         if (cl->cl_fsc != NULL) {
1590                 sp->fsc.m1 = sm2m(cl->cl_fsc->sm1);
1591                 sp->fsc.d = dx2d(cl->cl_fsc->dx);
1592                 sp->fsc.m2 = sm2m(cl->cl_fsc->sm2);
1593         } else {
1594                 sp->fsc.m1 = 0;
1595                 sp->fsc.d = 0;
1596                 sp->fsc.m2 = 0;
1597         }
1598         if (cl->cl_usc != NULL) {
1599                 sp->usc.m1 = sm2m(cl->cl_usc->sm1);
1600                 sp->usc.d = dx2d(cl->cl_usc->dx);
1601                 sp->usc.m2 = sm2m(cl->cl_usc->sm2);
1602         } else {
1603                 sp->usc.m1 = 0;
1604                 sp->usc.d = 0;
1605                 sp->usc.m2 = 0;
1606         }
1607
1608         sp->total = cl->cl_total;
1609         sp->cumul = cl->cl_cumul;
1610
1611         sp->d = cl->cl_d;
1612         sp->e = cl->cl_e;
1613         sp->vt = cl->cl_vt;
1614         sp->f = cl->cl_f;
1615
1616         sp->initvt = cl->cl_initvt;
1617         sp->vtperiod = cl->cl_vtperiod;
1618         sp->parentperiod = cl->cl_parentperiod;
1619         sp->nactive = cl->cl_nactive;
1620         sp->vtoff = cl->cl_vtoff;
1621         sp->cvtmax = cl->cl_cvtmax;
1622         sp->myf = cl->cl_myf;
1623         sp->cfmin = cl->cl_cfmin;
1624         sp->cvtmin = cl->cl_cvtmin;
1625         sp->myfadj = cl->cl_myfadj;
1626         sp->vtadj = cl->cl_vtadj;
1627
1628         sp->cur_time = read_machclk();
1629         sp->machclk_freq = machclk_freq;
1630
1631         sp->qlength = qlen(cl->cl_q);
1632         sp->qlimit = qlimit(cl->cl_q);
1633         sp->xmit_cnt = cl->cl_stats.xmit_cnt;
1634         sp->drop_cnt = cl->cl_stats.drop_cnt;
1635         sp->period = cl->cl_stats.period;
1636
1637         sp->qtype = qtype(cl->cl_q);
1638 #ifdef ALTQ_RED
1639         if (q_is_red(cl->cl_q))
1640                 red_getstats(cl->cl_red, &sp->red[0]);
1641 #endif
1642 #ifdef ALTQ_RIO
1643         if (q_is_rio(cl->cl_q))
1644                 rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
1645 #endif
1646 }
1647
1648 /* convert a class handle to the corresponding class pointer */
1649 static struct hfsc_class *
1650 clh_to_clp(struct hfsc_if *hif, uint32_t chandle)
1651 {
1652         int i;
1653         struct hfsc_class *cl;
1654
1655         if (chandle == 0)
1656                 return (NULL);
1657         /*
1658          * first, try optimistically the slot matching the lower bits of
1659          * the handle.  if it fails, do the linear table search.
1660          */
1661         i = chandle % HFSC_MAX_CLASSES;
1662         if ((cl = hif->hif_class_tbl[i]) != NULL && cl->cl_handle == chandle)
1663                 return (cl);
1664         for (i = 0; i < HFSC_MAX_CLASSES; i++)
1665                 if ((cl = hif->hif_class_tbl[i]) != NULL &&
1666                     cl->cl_handle == chandle)
1667                         return (cl);
1668         return (NULL);
1669 }
1670
1671 #endif /* ALTQ_HFSC */