sys/netpfil/ipfw/dn_sched_fq_pie.c

   1 /*
   2  * FQ_PIE - The FlowQueue-PIE scheduler/AQM
   3  *
   4  * $FreeBSD$
   5  *
   6  * Copyright (C) 2016 Centre for Advanced Internet Architectures,
   7  *  Swinburne University of Technology, Melbourne, Australia.
   8  * Portions of this code were made possible in part by a gift from
   9  *  The Comcast Innovation Fund.
  10  * Implemented by Rasool Al-Saadi <ralsaadi@swin.edu.au>
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* Important note:
  35  * As there is no an office document for FQ-PIE specification, we used
  36  * FQ-CoDel algorithm with some modifications to implement FQ-PIE.
  37  * This FQ-PIE implementation is a beta version and have not been tested
  38  * extensively. Our FQ-PIE uses stand-alone PIE AQM per sub-queue. By
  39  * default, timestamp is used to calculate queue delay instead of departure
  40  * rate estimation method. Although departure rate estimation is available
  41  * as testing option, the results could be incorrect. Moreover, turning PIE on
  42  * and off option is available but it does not work properly in this version.
  43  */
  44
  45
  46 #ifdef _KERNEL
  47 #include <sys/malloc.h>
  48 #include <sys/socket.h>
  49 #include <sys/kernel.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/lock.h>
  52 #include <sys/module.h>
  53 #include <sys/mutex.h>
  54 #include <net/if.h>     /* IFNAMSIZ */
  55 #include <netinet/in.h>
  56 #include <netinet/ip_var.h>             /* ipfw_rule_ref */
  57 #include <netinet/ip_fw.h>      /* flow_id */
  58 #include <netinet/ip_dummynet.h>
  59
  60 #include <sys/proc.h>
  61 #include <sys/rwlock.h>
  62
  63 #include <netpfil/ipfw/ip_fw_private.h>
  64 #include <sys/sysctl.h>
  65 #include <netinet/ip.h>
  66 #include <netinet/ip6.h>
  67 #include <netinet/ip_icmp.h>
  68 #include <netinet/tcp.h>
  69 #include <netinet/udp.h>
  70 #include <sys/queue.h>
  71 #include <sys/hash.h>
  72
  73 #include <netpfil/ipfw/dn_heap.h>
  74 #include <netpfil/ipfw/ip_dn_private.h>
  75
  76 #include <netpfil/ipfw/dn_aqm.h>
  77 #include <netpfil/ipfw/dn_aqm_pie.h>
  78 #include <netpfil/ipfw/dn_sched.h>
  79
  80 #else
  81 #include <dn_test.h>
  82 #endif
  83
  84 #define DN_SCHED_FQ_PIE 7
  85
  86 /* list of queues */
  87 STAILQ_HEAD(fq_pie_list, fq_pie_flow) ;
  88
  89 /* FQ_PIE parameters including PIE */
  90 struct dn_sch_fq_pie_parms {
  91         struct dn_aqm_pie_parms pcfg;   /* PIE configuration Parameters */
  92         /* FQ_PIE Parameters */
  93         uint32_t flows_cnt;     /* number of flows */
  94         uint32_t limit; /* hard limit of FQ_PIE queue size*/
  95         uint32_t quantum;
  96 };
  97
  98 /* flow (sub-queue) stats */
  99 struct flow_stats {
 100         uint64_t tot_pkts;      /* statistics counters  */
 101         uint64_t tot_bytes;
 102         uint32_t length;                /* Queue length, in packets */
 103         uint32_t len_bytes;     /* Queue length, in bytes */
 104         uint32_t drops;
 105 };
 106
 107 /* A flow of packets (sub-queue)*/
 108 struct fq_pie_flow {
 109         struct mq       mq;     /* list of packets */
 110         struct flow_stats stats;        /* statistics */
 111         int deficit;
 112         int active;             /* 1: flow is active (in a list) */
 113         struct pie_status pst;  /* pie status variables */
 114         struct fq_pie_si_extra *psi_extra;
 115         STAILQ_ENTRY(fq_pie_flow) flowchain;
 116 };
 117
 118 /* extra fq_pie scheduler configurations */
 119 struct fq_pie_schk {
 120         struct dn_sch_fq_pie_parms cfg;
 121 };
 122
 123
 124 /* fq_pie scheduler instance extra state vars.
 125  * The purpose of separation this structure is to preserve number of active
 126  * sub-queues and the flows array pointer even after the scheduler instance
 127  * is destroyed.
 128  * Preserving these varaiables allows freeing the allocated memory by
 129  * fqpie_callout_cleanup() independently from fq_pie_free_sched().
 130  */
 131 struct fq_pie_si_extra {
 132         uint32_t nr_active_q;   /* number of active queues */
 133         struct fq_pie_flow *flows;      /* array of flows (queues) */
 134         };
 135
 136 /* fq_pie scheduler instance */
 137 struct fq_pie_si {
 138         struct dn_sch_inst _si; /* standard scheduler instance. SHOULD BE FIRST */
 139         struct dn_queue main_q; /* main queue is after si directly */
 140         uint32_t perturbation;  /* random value */
 141         struct fq_pie_list newflows;    /* list of new queues */
 142         struct fq_pie_list oldflows;    /* list of old queues */
 143         struct fq_pie_si_extra *si_extra; /* extra state vars*/
 144 };
 145
 146
 147 static struct dn_alg fq_pie_desc;
 148
 149 /*  Default FQ-PIE parameters including PIE */
 150 /*  PIE defaults
 151  * target=15ms, max_burst=150ms, max_ecnth=0.1,
 152  * alpha=0.125, beta=1.25, tupdate=15ms
 153  * FQ-
 154  * flows=1024, limit=10240, quantum =1514
 155  */
 156 struct dn_sch_fq_pie_parms
 157  fq_pie_sysctl = {{15000 * AQM_TIME_1US, 15000 * AQM_TIME_1US,
 158         150000 * AQM_TIME_1US, PIE_SCALE * 0.1, PIE_SCALE * 0.125,
 159         PIE_SCALE * 1.25,       PIE_CAPDROP_ENABLED | PIE_DERAND_ENABLED},
 160         1024, 10240, 1514};
 161
 162 static int
 163 fqpie_sysctl_alpha_beta_handler(SYSCTL_HANDLER_ARGS)
 164 {
 165         int error;
 166         long  value;
 167
 168         if (!strcmp(oidp->oid_name,"alpha"))
 169                 value = fq_pie_sysctl.pcfg.alpha;
 170         else
 171                 value = fq_pie_sysctl.pcfg.beta;
 172
 173         value = value * 1000 / PIE_SCALE;
 174         error = sysctl_handle_long(oidp, &value, 0, req);
 175         if (error != 0 || req->newptr == NULL)
 176                 return (error);
 177         if (value < 1 || value > 7 * PIE_SCALE)
 178                 return (EINVAL);
 179         value = (value * PIE_SCALE) / 1000;
 180         if (!strcmp(oidp->oid_name,"alpha"))
 181                         fq_pie_sysctl.pcfg.alpha = value;
 182         else
 183                 fq_pie_sysctl.pcfg.beta = value;
 184         return (0);
 185 }
 186
 187 static int
 188 fqpie_sysctl_target_tupdate_maxb_handler(SYSCTL_HANDLER_ARGS)
 189 {
 190         int error;
 191         long  value;
 192
 193         if (!strcmp(oidp->oid_name,"target"))
 194                 value = fq_pie_sysctl.pcfg.qdelay_ref;
 195         else if (!strcmp(oidp->oid_name,"tupdate"))
 196                 value = fq_pie_sysctl.pcfg.tupdate;
 197         else
 198                 value = fq_pie_sysctl.pcfg.max_burst;
 199
 200         value = value / AQM_TIME_1US;
 201         error = sysctl_handle_long(oidp, &value, 0, req);
 202         if (error != 0 || req->newptr == NULL)
 203                 return (error);
 204         if (value < 1 || value > 10 * AQM_TIME_1S)
 205                 return (EINVAL);
 206         value = value * AQM_TIME_1US;
 207
 208         if (!strcmp(oidp->oid_name,"target"))
 209                 fq_pie_sysctl.pcfg.qdelay_ref  = value;
 210         else if (!strcmp(oidp->oid_name,"tupdate"))
 211                 fq_pie_sysctl.pcfg.tupdate  = value;
 212         else
 213                 fq_pie_sysctl.pcfg.max_burst = value;
 214         return (0);
 215 }
 216
 217 static int
 218 fqpie_sysctl_max_ecnth_handler(SYSCTL_HANDLER_ARGS)
 219 {
 220         int error;
 221         long  value;
 222
 223         value = fq_pie_sysctl.pcfg.max_ecnth;
 224         value = value * 1000 / PIE_SCALE;
 225         error = sysctl_handle_long(oidp, &value, 0, req);
 226         if (error != 0 || req->newptr == NULL)
 227                 return (error);
 228         if (value < 1 || value > PIE_SCALE)
 229                 return (EINVAL);
 230         value = (value * PIE_SCALE) / 1000;
 231         fq_pie_sysctl.pcfg.max_ecnth = value;
 232         return (0);
 233 }
 234
 235 /* define FQ- PIE sysctl variables */
 236 SYSBEGIN(f4)
 237 SYSCTL_DECL(_net_inet);
 238 SYSCTL_DECL(_net_inet_ip);
 239 SYSCTL_DECL(_net_inet_ip_dummynet);
 240 static SYSCTL_NODE(_net_inet_ip_dummynet, OID_AUTO, fqpie,
 241     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
 242     "FQ_PIE");
 243
 244 #ifdef SYSCTL_NODE
 245
 246 SYSCTL_PROC(_net_inet_ip_dummynet_fqpie, OID_AUTO, target,
 247     CTLTYPE_LONG | CTLFLAG_RW | CTLFLAG_NEEDGIANT, NULL, 0,
 248     fqpie_sysctl_target_tupdate_maxb_handler, "L",
 249     "queue target in microsecond");
 250
 251 SYSCTL_PROC(_net_inet_ip_dummynet_fqpie, OID_AUTO, tupdate,
 252     CTLTYPE_LONG | CTLFLAG_RW | CTLFLAG_NEEDGIANT, NULL, 0,
 253     fqpie_sysctl_target_tupdate_maxb_handler, "L",
 254     "the frequency of drop probability calculation in microsecond");
 255
 256 SYSCTL_PROC(_net_inet_ip_dummynet_fqpie, OID_AUTO, max_burst,
 257     CTLTYPE_LONG | CTLFLAG_RW | CTLFLAG_NEEDGIANT, NULL, 0,
 258     fqpie_sysctl_target_tupdate_maxb_handler, "L",
 259     "Burst allowance interval in microsecond");
 260
 261 SYSCTL_PROC(_net_inet_ip_dummynet_fqpie, OID_AUTO, max_ecnth,
 262     CTLTYPE_LONG | CTLFLAG_RW | CTLFLAG_NEEDGIANT, NULL, 0,
 263     fqpie_sysctl_max_ecnth_handler, "L",
 264     "ECN safeguard threshold scaled by 1000");
 265
 266 SYSCTL_PROC(_net_inet_ip_dummynet_fqpie, OID_AUTO, alpha,
 267     CTLTYPE_LONG | CTLFLAG_RW | CTLFLAG_NEEDGIANT, NULL, 0,
 268     fqpie_sysctl_alpha_beta_handler, "L",
 269     "PIE alpha scaled by 1000");
 270
 271 SYSCTL_PROC(_net_inet_ip_dummynet_fqpie, OID_AUTO, beta,
 272     CTLTYPE_LONG | CTLFLAG_RW | CTLFLAG_NEEDGIANT, NULL, 0,
 273     fqpie_sysctl_alpha_beta_handler, "L",
 274     "beta scaled by 1000");
 275
 276 SYSCTL_UINT(_net_inet_ip_dummynet_fqpie, OID_AUTO, quantum,
 277         CTLFLAG_RW, &fq_pie_sysctl.quantum, 1514, "quantum for FQ_PIE");
 278 SYSCTL_UINT(_net_inet_ip_dummynet_fqpie, OID_AUTO, flows,
 279         CTLFLAG_RW, &fq_pie_sysctl.flows_cnt, 1024, "Number of queues for FQ_PIE");
 280 SYSCTL_UINT(_net_inet_ip_dummynet_fqpie, OID_AUTO, limit,
 281         CTLFLAG_RW, &fq_pie_sysctl.limit, 10240, "limit for FQ_PIE");
 282 #endif
 283
 284 /* Helper function to update queue&main-queue and scheduler statistics.
 285  * negative len & drop -> drop
 286  * negative len -> dequeue
 287  * positive len -> enqueue
 288  * positive len + drop -> drop during enqueue
 289  */
 290 __inline static void
 291 fq_update_stats(struct fq_pie_flow *q, struct fq_pie_si *si, int len,
 292         int drop)
 293 {
 294         int inc = 0;
 295
 296         if (len < 0)
 297                 inc = -1;
 298         else if (len > 0)
 299                 inc = 1;
 300
 301         if (drop) {
 302                 si->main_q.ni.drops ++;
 303                 q->stats.drops ++;
 304                 si->_si.ni.drops ++;
 305                 io_pkt_drop ++;
 306         }
 307
 308         if (!drop || (drop && len < 0)) {
 309                 /* Update stats for the main queue */
 310                 si->main_q.ni.length += inc;
 311                 si->main_q.ni.len_bytes += len;
 312
 313                 /*update sub-queue stats */
 314                 q->stats.length += inc;
 315                 q->stats.len_bytes += len;
 316
 317                 /*update scheduler instance stats */
 318                 si->_si.ni.length += inc;
 319                 si->_si.ni.len_bytes += len;
 320         }
 321
 322         if (inc > 0) {
 323                 si->main_q.ni.tot_bytes += len;
 324                 si->main_q.ni.tot_pkts ++;
 325
 326                 q->stats.tot_bytes +=len;
 327                 q->stats.tot_pkts++;
 328
 329                 si->_si.ni.tot_bytes +=len;
 330                 si->_si.ni.tot_pkts ++;
 331         }
 332
 333 }
 334
 335 /*
 336  * Extract a packet from the head of sub-queue 'q'
 337  * Return a packet or NULL if the queue is empty.
 338  * If getts is set, also extract packet's timestamp from mtag.
 339  */
 340 __inline static struct mbuf *
 341 fq_pie_extract_head(struct fq_pie_flow *q, aqm_time_t *pkt_ts,
 342         struct fq_pie_si *si, int getts)
 343 {
 344         struct mbuf *m = q->mq.head;
 345
 346         if (m == NULL)
 347                 return m;
 348         q->mq.head = m->m_nextpkt;
 349
 350         fq_update_stats(q, si, -m->m_pkthdr.len, 0);
 351
 352         if (si->main_q.ni.length == 0) /* queue is now idle */
 353                         si->main_q.q_time = dn_cfg.curr_time;
 354
 355         if (getts) {
 356                 /* extract packet timestamp*/
 357                 struct m_tag *mtag;
 358                 mtag = m_tag_locate(m, MTAG_ABI_COMPAT, DN_AQM_MTAG_TS, NULL);
 359                 if (mtag == NULL){
 360                         D("PIE timestamp mtag not found!");
 361                         *pkt_ts = 0;
 362                 } else {
 363                         *pkt_ts = *(aqm_time_t *)(mtag + 1);
 364                         m_tag_delete(m,mtag);
 365                 }
 366         }
 367         return m;
 368 }
 369
 370 /*
 371  * Callout function for drop probability calculation
 372  * This function is called over tupdate ms and takes pointer of FQ-PIE
 373  * flow as an argument
 374   */
 375 static void
 376 fq_calculate_drop_prob(void *x)
 377 {
 378         struct fq_pie_flow *q = (struct fq_pie_flow *) x;
 379         struct pie_status *pst = &q->pst;
 380         struct dn_aqm_pie_parms *pprms;
 381         int64_t p, prob, oldprob;
 382         aqm_time_t now;
 383         int p_isneg;
 384
 385         now = AQM_UNOW;
 386         pprms = pst->parms;
 387         prob = pst->drop_prob;
 388
 389         /* calculate current qdelay using DRE method.
 390          * If TS is used and no data in the queue, reset current_qdelay
 391          * as it stays at last value during dequeue process.
 392         */
 393         if (pprms->flags & PIE_DEPRATEEST_ENABLED)
 394                 pst->current_qdelay = ((uint64_t)q->stats.len_bytes  * pst->avg_dq_time)
 395                         >> PIE_DQ_THRESHOLD_BITS;
 396         else
 397                 if (!q->stats.len_bytes)
 398                         pst->current_qdelay = 0;
 399
 400         /* calculate drop probability */
 401         p = (int64_t)pprms->alpha *
 402                 ((int64_t)pst->current_qdelay - (int64_t)pprms->qdelay_ref);
 403         p +=(int64_t) pprms->beta *
 404                 ((int64_t)pst->current_qdelay - (int64_t)pst->qdelay_old);
 405
 406         /* take absolute value so right shift result is well defined */
 407         p_isneg = p < 0;
 408         if (p_isneg) {
 409                 p = -p;
 410         }
 411
 412         /* We PIE_MAX_PROB shift by 12-bits to increase the division precision  */
 413         p *= (PIE_MAX_PROB << 12) / AQM_TIME_1S;
 414
 415         /* auto-tune drop probability */
 416         if (prob < (PIE_MAX_PROB / 1000000)) /* 0.000001 */
 417                 p >>= 11 + PIE_FIX_POINT_BITS + 12;
 418         else if (prob < (PIE_MAX_PROB / 100000)) /* 0.00001 */
 419                 p >>= 9 + PIE_FIX_POINT_BITS + 12;
 420         else if (prob < (PIE_MAX_PROB / 10000)) /* 0.0001 */
 421                 p >>= 7 + PIE_FIX_POINT_BITS + 12;
 422         else if (prob < (PIE_MAX_PROB / 1000)) /* 0.001 */
 423                 p >>= 5 + PIE_FIX_POINT_BITS + 12;
 424         else if (prob < (PIE_MAX_PROB / 100)) /* 0.01 */
 425                 p >>= 3 + PIE_FIX_POINT_BITS + 12;
 426         else if (prob < (PIE_MAX_PROB / 10)) /* 0.1 */
 427                 p >>= 1 + PIE_FIX_POINT_BITS + 12;
 428         else
 429                 p >>= PIE_FIX_POINT_BITS + 12;
 430
 431         oldprob = prob;
 432
 433         if (p_isneg) {
 434                 prob = prob - p;
 435
 436                 /* check for multiplication underflow */
 437                 if (prob > oldprob) {
 438                         prob= 0;
 439                         D("underflow");
 440                 }
 441         } else {
 442                 /* Cap Drop adjustment */
 443                 if ((pprms->flags & PIE_CAPDROP_ENABLED) &&
 444                     prob >= PIE_MAX_PROB / 10 &&
 445                     p > PIE_MAX_PROB / 50 ) {
 446                         p = PIE_MAX_PROB / 50;
 447                 }
 448
 449                 prob = prob + p;
 450
 451                 /* check for multiplication overflow */
 452                 if (prob<oldprob) {
 453                         D("overflow");
 454                         prob= PIE_MAX_PROB;
 455                 }
 456         }
 457
 458         /*
 459          * decay the drop probability exponentially
 460          * and restrict it to range 0 to PIE_MAX_PROB
 461          */
 462         if (prob < 0) {
 463                 prob = 0;
 464         } else {
 465                 if (pst->current_qdelay == 0 && pst->qdelay_old == 0) {
 466                         /* 0.98 ~= 1- 1/64 */
 467                         prob = prob - (prob >> 6);
 468                 }
 469
 470                 if (prob > PIE_MAX_PROB) {
 471                         prob = PIE_MAX_PROB;
 472                 }
 473         }
 474
 475         pst->drop_prob = prob;
 476
 477         /* store current delay value */
 478         pst->qdelay_old = pst->current_qdelay;
 479
 480         /* update burst allowance */
 481         if ((pst->sflags & PIE_ACTIVE) && pst->burst_allowance) {
 482                 if (pst->burst_allowance > pprms->tupdate)
 483                         pst->burst_allowance -= pprms->tupdate;
 484                 else
 485                         pst->burst_allowance = 0;
 486         }
 487
 488         if (pst->sflags & PIE_ACTIVE)
 489         callout_reset_sbt(&pst->aqm_pie_callout,
 490                 (uint64_t)pprms->tupdate * SBT_1US,
 491                 0, fq_calculate_drop_prob, q, 0);
 492
 493         mtx_unlock(&pst->lock_mtx);
 494 }
 495
 496 /*
 497  * Reset PIE variables & activate the queue
 498  */
 499 __inline static void
 500 fq_activate_pie(struct fq_pie_flow *q)
 501 {
 502         struct pie_status *pst = &q->pst;
 503         struct dn_aqm_pie_parms *pprms;
 504
 505         mtx_lock(&pst->lock_mtx);
 506         pprms = pst->parms;
 507
 508         pprms = pst->parms;
 509         pst->drop_prob = 0;
 510         pst->qdelay_old = 0;
 511         pst->burst_allowance = pprms->max_burst;
 512         pst->accu_prob = 0;
 513         pst->dq_count = 0;
 514         pst->avg_dq_time = 0;
 515         pst->sflags = PIE_INMEASUREMENT | PIE_ACTIVE;
 516         pst->measurement_start = AQM_UNOW;
 517
 518         callout_reset_sbt(&pst->aqm_pie_callout,
 519                 (uint64_t)pprms->tupdate * SBT_1US,
 520                 0, fq_calculate_drop_prob, q, 0);
 521
 522         mtx_unlock(&pst->lock_mtx);
 523 }
 524
 525
 526  /*
 527   * Deactivate PIE and stop probe update callout
 528   */
 529 __inline static void
 530 fq_deactivate_pie(struct pie_status *pst)
 531 {
 532         mtx_lock(&pst->lock_mtx);
 533         pst->sflags &= ~(PIE_ACTIVE | PIE_INMEASUREMENT);
 534         callout_stop(&pst->aqm_pie_callout);
 535         //D("PIE Deactivated");
 536         mtx_unlock(&pst->lock_mtx);
 537 }
 538
 539  /*
 540   * Initialize PIE for sub-queue 'q'
 541   */
 542 static int
 543 pie_init(struct fq_pie_flow *q, struct fq_pie_schk *fqpie_schk)
 544 {
 545         struct pie_status *pst=&q->pst;
 546         struct dn_aqm_pie_parms *pprms = pst->parms;
 547
 548         int err = 0;
 549         if (!pprms){
 550                 D("AQM_PIE is not configured");
 551                 err = EINVAL;
 552         } else {
 553                 q->psi_extra->nr_active_q++;
 554
 555                 /* For speed optimization, we caculate 1/3 queue size once here */
 556                 // XXX limit divided by number of queues divided by 3 ???
 557                 pst->one_third_q_size = (fqpie_schk->cfg.limit /
 558                         fqpie_schk->cfg.flows_cnt) / 3;
 559
 560                 mtx_init(&pst->lock_mtx, "mtx_pie", NULL, MTX_DEF);
 561                 callout_init_mtx(&pst->aqm_pie_callout, &pst->lock_mtx,
 562                         CALLOUT_RETURNUNLOCKED);
 563         }
 564
 565         return err;
 566 }
 567
 568 /*
 569  * callout function to destroy PIE lock, and free fq_pie flows and fq_pie si
 570  * extra memory when number of active sub-queues reaches zero.
 571  * 'x' is a fq_pie_flow to be destroyed
 572  */
 573 static void
 574 fqpie_callout_cleanup(void *x)
 575 {
 576         struct fq_pie_flow *q = x;
 577         struct pie_status *pst = &q->pst;
 578         struct fq_pie_si_extra *psi_extra;
 579
 580         mtx_unlock(&pst->lock_mtx);
 581         mtx_destroy(&pst->lock_mtx);
 582         psi_extra = q->psi_extra;
 583
 584         DN_BH_WLOCK();
 585         psi_extra->nr_active_q--;
 586
 587         /* when all sub-queues are destroyed, free flows fq_pie extra vars memory */
 588         if (!psi_extra->nr_active_q) {
 589                 free(psi_extra->flows, M_DUMMYNET);
 590                 free(psi_extra, M_DUMMYNET);
 591                 fq_pie_desc.ref_count--;
 592         }
 593         DN_BH_WUNLOCK();
 594 }
 595
 596 /*
 597  * Clean up PIE status for sub-queue 'q'
 598  * Stop callout timer and destroy mtx using fqpie_callout_cleanup() callout.
 599  */
 600 static int
 601 pie_cleanup(struct fq_pie_flow *q)
 602 {
 603         struct pie_status *pst  = &q->pst;
 604
 605         mtx_lock(&pst->lock_mtx);
 606         callout_reset_sbt(&pst->aqm_pie_callout,
 607                 SBT_1US, 0, fqpie_callout_cleanup, q, 0);
 608         mtx_unlock(&pst->lock_mtx);
 609         return 0;
 610 }
 611
 612 /*
 613  * Dequeue and return a pcaket from sub-queue 'q' or NULL if 'q' is empty.
 614  * Also, caculate depature time or queue delay using timestamp
 615  */
 616  static struct mbuf *
 617 pie_dequeue(struct fq_pie_flow *q, struct fq_pie_si *si)
 618 {
 619         struct mbuf *m;
 620         struct dn_aqm_pie_parms *pprms;
 621         struct pie_status *pst;
 622         aqm_time_t now;
 623         aqm_time_t pkt_ts, dq_time;
 624         int32_t w;
 625
 626         pst  = &q->pst;
 627         pprms = q->pst.parms;
 628
 629         /*we extarct packet ts only when Departure Rate Estimation dis not used*/
 630         m = fq_pie_extract_head(q, &pkt_ts, si,
 631                 !(pprms->flags & PIE_DEPRATEEST_ENABLED));
 632
 633         if (!m || !(pst->sflags & PIE_ACTIVE))
 634                 return m;
 635
 636         now = AQM_UNOW;
 637         if (pprms->flags & PIE_DEPRATEEST_ENABLED) {
 638                 /* calculate average depature time */
 639                 if(pst->sflags & PIE_INMEASUREMENT) {
 640                         pst->dq_count += m->m_pkthdr.len;
 641
 642                         if (pst->dq_count >= PIE_DQ_THRESHOLD) {
 643                                 dq_time = now - pst->measurement_start;
 644
 645                                 /*
 646                                  * if we don't have old avg dq_time i.e PIE is (re)initialized,
 647                                  * don't use weight to calculate new avg_dq_time
 648                                  */
 649                                 if(pst->avg_dq_time == 0)
 650                                         pst->avg_dq_time = dq_time;
 651                                 else {
 652                                         /*
 653                                          * weight = PIE_DQ_THRESHOLD/2^6, but we scaled
 654                                          * weight by 2^8. Thus, scaled
 655                                          * weight = PIE_DQ_THRESHOLD /2^8
 656                                          * */
 657                                         w = PIE_DQ_THRESHOLD >> 8;
 658                                         pst->avg_dq_time = (dq_time* w
 659                                                 + (pst->avg_dq_time * ((1L << 8) - w))) >> 8;
 660                                         pst->sflags &= ~PIE_INMEASUREMENT;
 661                                 }
 662                         }
 663                 }
 664
 665                 /*
 666                  * Start new measurment cycle when the queue has
 667                  *  PIE_DQ_THRESHOLD worth of bytes.
 668                  */
 669                 if(!(pst->sflags & PIE_INMEASUREMENT) &&
 670                         q->stats.len_bytes >= PIE_DQ_THRESHOLD) {
 671                         pst->sflags |= PIE_INMEASUREMENT;
 672                         pst->measurement_start = now;
 673                         pst->dq_count = 0;
 674                 }
 675         }
 676         /* Optionally, use packet timestamp to estimate queue delay */
 677         else
 678                 pst->current_qdelay = now - pkt_ts;
 679
 680         return m;
 681 }
 682
 683
 684  /*
 685  * Enqueue a packet in q, subject to space and FQ-PIE queue management policy
 686  * (whose parameters are in q->fs).
 687  * Update stats for the queue and the scheduler.
 688  * Return 0 on success, 1 on drop. The packet is consumed anyways.
 689  */
 690 static int
 691 pie_enqueue(struct fq_pie_flow *q, struct mbuf* m, struct fq_pie_si *si)
 692 {
 693         uint64_t len;
 694         struct pie_status *pst;
 695         struct dn_aqm_pie_parms *pprms;
 696         int t;
 697
 698         len = m->m_pkthdr.len;
 699         pst  = &q->pst;
 700         pprms = pst->parms;
 701         t = ENQUE;
 702
 703         /* drop/mark the packet when PIE is active and burst time elapsed */
 704         if (pst->sflags & PIE_ACTIVE && pst->burst_allowance == 0
 705                 && drop_early(pst, q->stats.len_bytes) == DROP) {
 706                         /*
 707                          * if drop_prob over ECN threshold, drop the packet
 708                          * otherwise mark and enqueue it.
 709                          */
 710                         if (pprms->flags & PIE_ECN_ENABLED && pst->drop_prob <
 711                                 (pprms->max_ecnth << (PIE_PROB_BITS - PIE_FIX_POINT_BITS))
 712                                 && ecn_mark(m))
 713                                 t = ENQUE;
 714                         else
 715                                 t = DROP;
 716                 }
 717
 718         /* Turn PIE on when 1/3 of the queue is full */
 719         if (!(pst->sflags & PIE_ACTIVE) && q->stats.len_bytes >=
 720                 pst->one_third_q_size) {
 721                 fq_activate_pie(q);
 722         }
 723
 724         /*  reset burst tolerance and optinally turn PIE off*/
 725         if (pst->drop_prob == 0 && pst->current_qdelay < (pprms->qdelay_ref >> 1)
 726                 && pst->qdelay_old < (pprms->qdelay_ref >> 1)) {
 727
 728                         pst->burst_allowance = pprms->max_burst;
 729                 if (pprms->flags & PIE_ON_OFF_MODE_ENABLED && q->stats.len_bytes<=0)
 730                         fq_deactivate_pie(pst);
 731         }
 732
 733         /* Use timestamp if Departure Rate Estimation mode is disabled */
 734         if (t != DROP && !(pprms->flags & PIE_DEPRATEEST_ENABLED)) {
 735                 /* Add TS to mbuf as a TAG */
 736                 struct m_tag *mtag;
 737                 mtag = m_tag_locate(m, MTAG_ABI_COMPAT, DN_AQM_MTAG_TS, NULL);
 738                 if (mtag == NULL)
 739                         mtag = m_tag_alloc(MTAG_ABI_COMPAT, DN_AQM_MTAG_TS,
 740                                 sizeof(aqm_time_t), M_NOWAIT);
 741                 if (mtag == NULL) {
 742                         m_freem(m);
 743                         t = DROP;
 744                 }
 745                 *(aqm_time_t *)(mtag + 1) = AQM_UNOW;
 746                 m_tag_prepend(m, mtag);
 747         }
 748
 749         if (t != DROP) {
 750                 mq_append(&q->mq, m);
 751                 fq_update_stats(q, si, len, 0);
 752                 return 0;
 753         } else {
 754                 fq_update_stats(q, si, len, 1);
 755                 pst->accu_prob = 0;
 756                 FREE_PKT(m);
 757                 return 1;
 758         }
 759
 760         return 0;
 761 }
 762
 763 /* Drop a packet form the head of FQ-PIE sub-queue */
 764 static void
 765 pie_drop_head(struct fq_pie_flow *q, struct fq_pie_si *si)
 766 {
 767         struct mbuf *m = q->mq.head;
 768
 769         if (m == NULL)
 770                 return;
 771         q->mq.head = m->m_nextpkt;
 772
 773         fq_update_stats(q, si, -m->m_pkthdr.len, 1);
 774
 775         if (si->main_q.ni.length == 0) /* queue is now idle */
 776                         si->main_q.q_time = dn_cfg.curr_time;
 777         /* reset accu_prob after packet drop */
 778         q->pst.accu_prob = 0;
 779
 780         FREE_PKT(m);
 781 }
 782
 783 /*
 784  * Classify a packet to queue number using Jenkins hash function.
 785  * Return: queue number
 786  * the input of the hash are protocol no, perturbation, src IP, dst IP,
 787  * src port, dst port,
 788  */
 789 static inline int
 790 fq_pie_classify_flow(struct mbuf *m, uint16_t fcount, struct fq_pie_si *si)
 791 {
 792         struct ip *ip;
 793         struct tcphdr *th;
 794         struct udphdr *uh;
 795         uint8_t tuple[41];
 796         uint16_t hash=0;
 797
 798         ip = (struct ip *)mtodo(m, dn_tag_get(m)->iphdr_off);
 799 //#ifdef INET6
 800         struct ip6_hdr *ip6;
 801         int isip6;
 802         isip6 = (ip->ip_v == 6);
 803
 804         if(isip6) {
 805                 ip6 = (struct ip6_hdr *)ip;
 806                 *((uint8_t *) &tuple[0]) = ip6->ip6_nxt;
 807                 *((uint32_t *) &tuple[1]) = si->perturbation;
 808                 memcpy(&tuple[5], ip6->ip6_src.s6_addr, 16);
 809                 memcpy(&tuple[21], ip6->ip6_dst.s6_addr, 16);
 810
 811                 switch (ip6->ip6_nxt) {
 812                 case IPPROTO_TCP:
 813                         th = (struct tcphdr *)(ip6 + 1);
 814                         *((uint16_t *) &tuple[37]) = th->th_dport;
 815                         *((uint16_t *) &tuple[39]) = th->th_sport;
 816                         break;
 817
 818                 case IPPROTO_UDP:
 819                         uh = (struct udphdr *)(ip6 + 1);
 820                         *((uint16_t *) &tuple[37]) = uh->uh_dport;
 821                         *((uint16_t *) &tuple[39]) = uh->uh_sport;
 822                         break;
 823                 default:
 824                         memset(&tuple[37], 0, 4);
 825                 }
 826
 827                 hash = jenkins_hash(tuple, 41, HASHINIT) %  fcount;
 828                 return hash;
 829         }
 830 //#endif
 831
 832         /* IPv4 */
 833         *((uint8_t *) &tuple[0]) = ip->ip_p;
 834         *((uint32_t *) &tuple[1]) = si->perturbation;
 835         *((uint32_t *) &tuple[5]) = ip->ip_src.s_addr;
 836         *((uint32_t *) &tuple[9]) = ip->ip_dst.s_addr;
 837
 838         switch (ip->ip_p) {
 839                 case IPPROTO_TCP:
 840                         th = (struct tcphdr *)(ip + 1);
 841                         *((uint16_t *) &tuple[13]) = th->th_dport;
 842                         *((uint16_t *) &tuple[15]) = th->th_sport;
 843                         break;
 844
 845                 case IPPROTO_UDP:
 846                         uh = (struct udphdr *)(ip + 1);
 847                         *((uint16_t *) &tuple[13]) = uh->uh_dport;
 848                         *((uint16_t *) &tuple[15]) = uh->uh_sport;
 849                         break;
 850                 default:
 851                         memset(&tuple[13], 0, 4);
 852         }
 853         hash = jenkins_hash(tuple, 17, HASHINIT) % fcount;
 854
 855         return hash;
 856 }
 857
 858 /*
 859  * Enqueue a packet into an appropriate queue according to
 860  * FQ-CoDe; algorithm.
 861  */
 862 static int
 863 fq_pie_enqueue(struct dn_sch_inst *_si, struct dn_queue *_q,
 864         struct mbuf *m)
 865 {
 866         struct fq_pie_si *si;
 867         struct fq_pie_schk *schk;
 868         struct dn_sch_fq_pie_parms *param;
 869         struct dn_queue *mainq;
 870         struct fq_pie_flow *flows;
 871         int idx, drop, i, maxidx;
 872
 873         mainq = (struct dn_queue *)(_si + 1);
 874         si = (struct fq_pie_si *)_si;
 875         flows = si->si_extra->flows;
 876         schk = (struct fq_pie_schk *)(si->_si.sched+1);
 877         param = &schk->cfg;
 878
 879          /* classify a packet to queue number*/
 880         idx = fq_pie_classify_flow(m, param->flows_cnt, si);
 881
 882         /* enqueue packet into appropriate queue using PIE AQM.
 883          * Note: 'pie_enqueue' function returns 1 only when it unable to
 884          * add timestamp to packet (no limit check)*/
 885         drop = pie_enqueue(&flows[idx], m, si);
 886
 887         /* pie unable to timestamp a packet */
 888         if (drop)
 889                 return 1;
 890
 891         /* If the flow (sub-queue) is not active ,then add it to tail of
 892          * new flows list, initialize and activate it.
 893          */
 894         if (!flows[idx].active) {
 895                 STAILQ_INSERT_TAIL(&si->newflows, &flows[idx], flowchain);
 896                 flows[idx].deficit = param->quantum;
 897                 fq_activate_pie(&flows[idx]);
 898                 flows[idx].active = 1;
 899         }
 900
 901         /* check the limit for all queues and remove a packet from the
 902          * largest one
 903          */
 904         if (mainq->ni.length > schk->cfg.limit) {
 905                 /* find first active flow */
 906                 for (maxidx = 0; maxidx < schk->cfg.flows_cnt; maxidx++)
 907                         if (flows[maxidx].active)
 908                                 break;
 909                 if (maxidx < schk->cfg.flows_cnt) {
 910                         /* find the largest sub- queue */
 911                         for (i = maxidx + 1; i < schk->cfg.flows_cnt; i++)
 912                                 if (flows[i].active && flows[i].stats.length >
 913                                         flows[maxidx].stats.length)
 914                                         maxidx = i;
 915                         pie_drop_head(&flows[maxidx], si);
 916                         drop = 1;
 917                 }
 918         }
 919
 920         return drop;
 921 }
 922
 923 /*
 924  * Dequeue a packet from an appropriate queue according to
 925  * FQ-CoDel algorithm.
 926  */
 927 static struct mbuf *
 928 fq_pie_dequeue(struct dn_sch_inst *_si)
 929 {
 930         struct fq_pie_si *si;
 931         struct fq_pie_schk *schk;
 932         struct dn_sch_fq_pie_parms *param;
 933         struct fq_pie_flow *f;
 934         struct mbuf *mbuf;
 935         struct fq_pie_list *fq_pie_flowlist;
 936
 937         si = (struct fq_pie_si *)_si;
 938         schk = (struct fq_pie_schk *)(si->_si.sched+1);
 939         param = &schk->cfg;
 940
 941         do {
 942                 /* select a list to start with */
 943                 if (STAILQ_EMPTY(&si->newflows))
 944                         fq_pie_flowlist = &si->oldflows;
 945                 else
 946                         fq_pie_flowlist = &si->newflows;
 947
 948                 /* Both new and old queue lists are empty, return NULL */
 949                 if (STAILQ_EMPTY(fq_pie_flowlist))
 950                         return NULL;
 951
 952                 f = STAILQ_FIRST(fq_pie_flowlist);
 953                 while (f != NULL)       {
 954                         /* if there is no flow(sub-queue) deficit, increase deficit
 955                          * by quantum, move the flow to the tail of old flows list
 956                          * and try another flow.
 957                          * Otherwise, the flow will be used for dequeue.
 958                          */
 959                         if (f->deficit < 0) {
 960                                  f->deficit += param->quantum;
 961                                  STAILQ_REMOVE_HEAD(fq_pie_flowlist, flowchain);
 962                                  STAILQ_INSERT_TAIL(&si->oldflows, f, flowchain);
 963                          } else
 964                                  break;
 965
 966                         f = STAILQ_FIRST(fq_pie_flowlist);
 967                 }
 968
 969                 /* the new flows list is empty, try old flows list */
 970                 if (STAILQ_EMPTY(fq_pie_flowlist))
 971                         continue;
 972
 973                 /* Dequeue a packet from the selected flow */
 974                 mbuf = pie_dequeue(f, si);
 975
 976                 /* pie did not return a packet */
 977                 if (!mbuf) {
 978                         /* If the selected flow belongs to new flows list, then move
 979                          * it to the tail of old flows list. Otherwise, deactivate it and
 980                          * remove it from the old list and
 981                          */
 982                         if (fq_pie_flowlist == &si->newflows) {
 983                                 STAILQ_REMOVE_HEAD(fq_pie_flowlist, flowchain);
 984                                 STAILQ_INSERT_TAIL(&si->oldflows, f, flowchain);
 985                         }       else {
 986                                 f->active = 0;
 987                                 fq_deactivate_pie(&f->pst);
 988                                 STAILQ_REMOVE_HEAD(fq_pie_flowlist, flowchain);
 989                         }
 990                         /* start again */
 991                         continue;
 992                 }
 993
 994                 /* we have a packet to return,
 995                  * update flow deficit and return the packet*/
 996                 f->deficit -= mbuf->m_pkthdr.len;
 997                 return mbuf;
 998
 999         } while (1);
1000
1001         /* unreachable point */
1002         return NULL;
1003 }
1004
1005 /*
1006  * Initialize fq_pie scheduler instance.
1007  * also, allocate memory for flows array.
1008  */
1009 static int
1010 fq_pie_new_sched(struct dn_sch_inst *_si)
1011 {
1012         struct fq_pie_si *si;
1013         struct dn_queue *q;
1014         struct fq_pie_schk *schk;
1015         struct fq_pie_flow *flows;
1016         int i;
1017
1018         si = (struct fq_pie_si *)_si;
1019         schk = (struct fq_pie_schk *)(_si->sched+1);
1020
1021         if(si->si_extra) {
1022                 D("si already configured!");
1023                 return 0;
1024         }
1025
1026         /* init the main queue */
1027         q = &si->main_q;
1028         set_oid(&q->ni.oid, DN_QUEUE, sizeof(*q));
1029         q->_si = _si;
1030         q->fs = _si->sched->fs;
1031
1032         /* allocate memory for scheduler instance extra vars */
1033         si->si_extra = malloc(sizeof(struct fq_pie_si_extra),
1034                  M_DUMMYNET, M_NOWAIT | M_ZERO);
1035         if (si->si_extra == NULL) {
1036                 D("cannot allocate memory for fq_pie si extra vars");
1037                 return ENOMEM ;
1038         }
1039         /* allocate memory for flows array */
1040         si->si_extra->flows = mallocarray(schk->cfg.flows_cnt,
1041             sizeof(struct fq_pie_flow), M_DUMMYNET, M_NOWAIT | M_ZERO);
1042         flows = si->si_extra->flows;
1043         if (flows == NULL) {
1044                 free(si->si_extra, M_DUMMYNET);
1045                 si->si_extra = NULL;
1046                 D("cannot allocate memory for fq_pie flows");
1047                 return ENOMEM ;
1048         }
1049
1050         /* init perturbation for this si */
1051         si->perturbation = random();
1052         si->si_extra->nr_active_q = 0;
1053
1054         /* init the old and new flows lists */
1055         STAILQ_INIT(&si->newflows);
1056         STAILQ_INIT(&si->oldflows);
1057
1058         /* init the flows (sub-queues) */
1059         for (i = 0; i < schk->cfg.flows_cnt; i++) {
1060                 flows[i].pst.parms = &schk->cfg.pcfg;
1061                 flows[i].psi_extra = si->si_extra;
1062                 pie_init(&flows[i], schk);
1063         }
1064
1065         fq_pie_desc.ref_count++;
1066
1067         return 0;
1068 }
1069
1070
1071 /*
1072  * Free fq_pie scheduler instance.
1073  */
1074 static int
1075 fq_pie_free_sched(struct dn_sch_inst *_si)
1076 {
1077         struct fq_pie_si *si;
1078         struct fq_pie_schk *schk;
1079         struct fq_pie_flow *flows;
1080         int i;
1081
1082         si = (struct fq_pie_si *)_si;
1083         schk = (struct fq_pie_schk *)(_si->sched+1);
1084         flows = si->si_extra->flows;
1085         for (i = 0; i < schk->cfg.flows_cnt; i++) {
1086                 pie_cleanup(&flows[i]);
1087         }
1088         si->si_extra = NULL;
1089         return 0;
1090 }
1091
1092 /*
1093  * Configure FQ-PIE scheduler.
1094  * the configurations for the scheduler is passed fromipfw  userland.
1095  */
1096 static int
1097 fq_pie_config(struct dn_schk *_schk)
1098 {
1099         struct fq_pie_schk *schk;
1100         struct dn_extra_parms *ep;
1101         struct dn_sch_fq_pie_parms *fqp_cfg;
1102
1103         schk = (struct fq_pie_schk *)(_schk+1);
1104         ep = (struct dn_extra_parms *) _schk->cfg;
1105
1106         /* par array contains fq_pie configuration as follow
1107          * PIE: 0- qdelay_ref,1- tupdate, 2- max_burst
1108          * 3- max_ecnth, 4- alpha, 5- beta, 6- flags
1109          * FQ_PIE: 7- quantum, 8- limit, 9- flows
1110          */
1111         if (ep && ep->oid.len ==sizeof(*ep) &&
1112                 ep->oid.subtype == DN_SCH_PARAMS) {
1113
1114                 fqp_cfg = &schk->cfg;
1115                 if (ep->par[0] < 0)
1116                         fqp_cfg->pcfg.qdelay_ref = fq_pie_sysctl.pcfg.qdelay_ref;
1117                 else
1118                         fqp_cfg->pcfg.qdelay_ref = ep->par[0];
1119                 if (ep->par[1] < 0)
1120                         fqp_cfg->pcfg.tupdate = fq_pie_sysctl.pcfg.tupdate;
1121                 else
1122                         fqp_cfg->pcfg.tupdate = ep->par[1];
1123                 if (ep->par[2] < 0)
1124                         fqp_cfg->pcfg.max_burst = fq_pie_sysctl.pcfg.max_burst;
1125                 else
1126                         fqp_cfg->pcfg.max_burst = ep->par[2];
1127                 if (ep->par[3] < 0)
1128                         fqp_cfg->pcfg.max_ecnth = fq_pie_sysctl.pcfg.max_ecnth;
1129                 else
1130                         fqp_cfg->pcfg.max_ecnth = ep->par[3];
1131                 if (ep->par[4] < 0)
1132                         fqp_cfg->pcfg.alpha = fq_pie_sysctl.pcfg.alpha;
1133                 else
1134                         fqp_cfg->pcfg.alpha = ep->par[4];
1135                 if (ep->par[5] < 0)
1136                         fqp_cfg->pcfg.beta = fq_pie_sysctl.pcfg.beta;
1137                 else
1138                         fqp_cfg->pcfg.beta = ep->par[5];
1139                 if (ep->par[6] < 0)
1140                         fqp_cfg->pcfg.flags = 0;
1141                 else
1142                         fqp_cfg->pcfg.flags = ep->par[6];
1143
1144                 /* FQ configurations */
1145                 if (ep->par[7] < 0)
1146                         fqp_cfg->quantum = fq_pie_sysctl.quantum;
1147                 else
1148                         fqp_cfg->quantum = ep->par[7];
1149                 if (ep->par[8] < 0)
1150                         fqp_cfg->limit = fq_pie_sysctl.limit;
1151                 else
1152                         fqp_cfg->limit = ep->par[8];
1153                 if (ep->par[9] < 0)
1154                         fqp_cfg->flows_cnt = fq_pie_sysctl.flows_cnt;
1155                 else
1156                         fqp_cfg->flows_cnt = ep->par[9];
1157
1158                 /* Bound the configurations */
1159                 fqp_cfg->pcfg.qdelay_ref = BOUND_VAR(fqp_cfg->pcfg.qdelay_ref,
1160                         1, 5 * AQM_TIME_1S);
1161                 fqp_cfg->pcfg.tupdate = BOUND_VAR(fqp_cfg->pcfg.tupdate,
1162                         1, 5 * AQM_TIME_1S);
1163                 fqp_cfg->pcfg.max_burst = BOUND_VAR(fqp_cfg->pcfg.max_burst,
1164                         0, 5 * AQM_TIME_1S);
1165                 fqp_cfg->pcfg.max_ecnth = BOUND_VAR(fqp_cfg->pcfg.max_ecnth,
1166                         0, PIE_SCALE);
1167                 fqp_cfg->pcfg.alpha = BOUND_VAR(fqp_cfg->pcfg.alpha, 0, 7 * PIE_SCALE);
1168                 fqp_cfg->pcfg.beta = BOUND_VAR(fqp_cfg->pcfg.beta, 0, 7 * PIE_SCALE);
1169
1170                 fqp_cfg->quantum = BOUND_VAR(fqp_cfg->quantum,1,9000);
1171                 fqp_cfg->limit= BOUND_VAR(fqp_cfg->limit,1,20480);
1172                 fqp_cfg->flows_cnt= BOUND_VAR(fqp_cfg->flows_cnt,1,65536);
1173         }
1174         else {
1175                 D("Wrong parameters for fq_pie scheduler");
1176                 return 1;
1177         }
1178
1179         return 0;
1180 }
1181
1182 /*
1183  * Return FQ-PIE scheduler configurations
1184  * the configurations for the scheduler is passed to userland.
1185  */
1186 static int
1187 fq_pie_getconfig (struct dn_schk *_schk, struct dn_extra_parms *ep) {
1188
1189         struct fq_pie_schk *schk = (struct fq_pie_schk *)(_schk+1);
1190         struct dn_sch_fq_pie_parms *fqp_cfg;
1191
1192         fqp_cfg = &schk->cfg;
1193
1194         strcpy(ep->name, fq_pie_desc.name);
1195         ep->par[0] = fqp_cfg->pcfg.qdelay_ref;
1196         ep->par[1] = fqp_cfg->pcfg.tupdate;
1197         ep->par[2] = fqp_cfg->pcfg.max_burst;
1198         ep->par[3] = fqp_cfg->pcfg.max_ecnth;
1199         ep->par[4] = fqp_cfg->pcfg.alpha;
1200         ep->par[5] = fqp_cfg->pcfg.beta;
1201         ep->par[6] = fqp_cfg->pcfg.flags;
1202
1203         ep->par[7] = fqp_cfg->quantum;
1204         ep->par[8] = fqp_cfg->limit;
1205         ep->par[9] = fqp_cfg->flows_cnt;
1206
1207         return 0;
1208 }
1209
1210 /*
1211  *  FQ-PIE scheduler descriptor
1212  * contains the type of the scheduler, the name, the size of extra
1213  * data structures, and function pointers.
1214  */
1215 static struct dn_alg fq_pie_desc = {
1216         _SI( .type = )  DN_SCHED_FQ_PIE,
1217         _SI( .name = ) "FQ_PIE",
1218         _SI( .flags = ) 0,
1219
1220         _SI( .schk_datalen = ) sizeof(struct fq_pie_schk),
1221         _SI( .si_datalen = ) sizeof(struct fq_pie_si) - sizeof(struct dn_sch_inst),
1222         _SI( .q_datalen = ) 0,
1223
1224         _SI( .enqueue = ) fq_pie_enqueue,
1225         _SI( .dequeue = ) fq_pie_dequeue,
1226         _SI( .config = ) fq_pie_config, /* new sched i.e. sched X config ...*/
1227         _SI( .destroy = ) NULL,  /*sched x delete */
1228         _SI( .new_sched = ) fq_pie_new_sched, /* new schd instance */
1229         _SI( .free_sched = ) fq_pie_free_sched, /* delete schd instance */
1230         _SI( .new_fsk = ) NULL,
1231         _SI( .free_fsk = ) NULL,
1232         _SI( .new_queue = ) NULL,
1233         _SI( .free_queue = ) NULL,
1234         _SI( .getconfig = )  fq_pie_getconfig,
1235         _SI( .ref_count = ) 0
1236 };
1237
1238 DECLARE_DNSCHED_MODULE(dn_fq_pie, &fq_pie_desc);