1/* 2 * PIE - Proportional Integral controller Enhanced AQM algorithm. 3 * 4 * $FreeBSD: stable/11/sys/netpfil/ipfw/dn_aqm_pie.c 318904 2017-05-25 22:39:48Z truckman $ 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#include <sys/cdefs.h> 35#include "opt_inet6.h" 36 37#include <sys/param.h> 38#include <sys/systm.h> 39#include <sys/malloc.h> 40#include <sys/mbuf.h> 41#include <sys/kernel.h> 42#include <sys/lock.h> 43#include <sys/module.h> 44#include <sys/mutex.h> 45#include <sys/priv.h> 46#include <sys/proc.h> 47#include <sys/rwlock.h> 48#include <sys/socket.h> 49#include <sys/time.h> 50#include <sys/sysctl.h> 51 52#include <net/if.h> /* IFNAMSIZ, struct ifaddr, ifq head, lock.h mutex.h */ 53#include <net/netisr.h> 54#include <net/vnet.h> 55 56#include <netinet/in.h> 57#include <netinet/ip.h> /* ip_len, ip_off */ 58#include <netinet/ip_var.h> /* ip_output(), IP_FORWARDING */ 59#include <netinet/ip_fw.h> 60#include <netinet/ip_dummynet.h> 61#include <netinet/if_ether.h> /* various ether_* routines */ 62#include <netinet/ip6.h> /* for ip6_input, ip6_output prototypes */ 63#include <netinet6/ip6_var.h> 64#include <netpfil/ipfw/dn_heap.h> 65 66#ifdef NEW_AQM 67#include <netpfil/ipfw/ip_fw_private.h> 68#include <netpfil/ipfw/ip_dn_private.h> 69#include <netpfil/ipfw/dn_aqm.h> 70#include <netpfil/ipfw/dn_aqm_pie.h> 71#include <netpfil/ipfw/dn_sched.h> 72 73/* for debugging */ 74#include <sys/syslog.h> 75 76static struct dn_aqm pie_desc; 77 78/* PIE defaults 79 * target=15ms, tupdate=15ms, max_burst=150ms, 80 * max_ecnth=0.1, alpha=0.125, beta=1.25, 81 */ 82struct dn_aqm_pie_parms pie_sysctl = 83 { 15 * AQM_TIME_1MS, 15 * AQM_TIME_1MS, 150 * AQM_TIME_1MS, 84 PIE_SCALE/10 , PIE_SCALE * 0.125, PIE_SCALE * 1.25 , 85 PIE_CAPDROP_ENABLED | PIE_DEPRATEEST_ENABLED | PIE_DERAND_ENABLED }; 86 87static int 88pie_sysctl_alpha_beta_handler(SYSCTL_HANDLER_ARGS) 89{ 90 int error; 91 long value; 92 93 if (!strcmp(oidp->oid_name,"alpha")) 94 value = pie_sysctl.alpha; 95 else 96 value = pie_sysctl.beta; 97 98 value = value * 1000 / PIE_SCALE; 99 error = sysctl_handle_long(oidp, &value, 0, req); 100 if (error != 0 || req->newptr == NULL) 101 return (error); 102 if (value < 1 || value > 7 * PIE_SCALE) 103 return (EINVAL); 104 value = (value * PIE_SCALE) / 1000; 105 if (!strcmp(oidp->oid_name,"alpha")) 106 pie_sysctl.alpha = value; 107 else 108 pie_sysctl.beta = value; 109 return (0); 110} 111 112static int 113pie_sysctl_target_tupdate_maxb_handler(SYSCTL_HANDLER_ARGS) 114{ 115 int error; 116 long value; 117 118 if (!strcmp(oidp->oid_name,"target")) 119 value = pie_sysctl.qdelay_ref; 120 else if (!strcmp(oidp->oid_name,"tupdate")) 121 value = pie_sysctl.tupdate; 122 else 123 value = pie_sysctl.max_burst; 124 125 value = value / AQM_TIME_1US; 126 error = sysctl_handle_long(oidp, &value, 0, req); 127 if (error != 0 || req->newptr == NULL) 128 return (error); 129 if (value < 1 || value > 10 * AQM_TIME_1S) 130 return (EINVAL); 131 value = value * AQM_TIME_1US; 132 133 if (!strcmp(oidp->oid_name,"target")) 134 pie_sysctl.qdelay_ref = value; 135 else if (!strcmp(oidp->oid_name,"tupdate")) 136 pie_sysctl.tupdate = value; 137 else 138 pie_sysctl.max_burst = value; 139 return (0); 140} 141 142static int 143pie_sysctl_max_ecnth_handler(SYSCTL_HANDLER_ARGS) 144{ 145 int error; 146 long value; 147 148 value = pie_sysctl.max_ecnth; 149 value = value * 1000 / PIE_SCALE; 150 error = sysctl_handle_long(oidp, &value, 0, req); 151 if (error != 0 || req->newptr == NULL) 152 return (error); 153 if (value < 1 || value > PIE_SCALE) 154 return (EINVAL); 155 value = (value * PIE_SCALE) / 1000; 156 pie_sysctl.max_ecnth = value; 157 return (0); 158} 159 160/* define PIE sysctl variables */ 161SYSBEGIN(f4) 162SYSCTL_DECL(_net_inet); 163SYSCTL_DECL(_net_inet_ip); 164SYSCTL_DECL(_net_inet_ip_dummynet); 165static SYSCTL_NODE(_net_inet_ip_dummynet, OID_AUTO, 166 pie, CTLFLAG_RW, 0, "PIE"); 167 168#ifdef SYSCTL_NODE 169SYSCTL_PROC(_net_inet_ip_dummynet_pie, OID_AUTO, target, 170 CTLTYPE_LONG | CTLFLAG_RW, NULL, 0, 171 pie_sysctl_target_tupdate_maxb_handler, "L", 172 "queue target in microsecond"); 173SYSCTL_PROC(_net_inet_ip_dummynet_pie, OID_AUTO, tupdate, 174 CTLTYPE_LONG | CTLFLAG_RW, NULL, 0, 175 pie_sysctl_target_tupdate_maxb_handler, "L", 176 "the frequency of drop probability calculation in microsecond"); 177SYSCTL_PROC(_net_inet_ip_dummynet_pie, OID_AUTO, max_burst, 178 CTLTYPE_LONG | CTLFLAG_RW, NULL, 0, 179 pie_sysctl_target_tupdate_maxb_handler, "L", 180 "Burst allowance interval in microsecond"); 181 182SYSCTL_PROC(_net_inet_ip_dummynet_pie, OID_AUTO, max_ecnth, 183 CTLTYPE_LONG | CTLFLAG_RW, NULL, 0, 184 pie_sysctl_max_ecnth_handler, "L", 185 "ECN safeguard threshold scaled by 1000"); 186 187SYSCTL_PROC(_net_inet_ip_dummynet_pie, OID_AUTO, alpha, 188 CTLTYPE_LONG | CTLFLAG_RW, NULL, 0, 189 pie_sysctl_alpha_beta_handler, "L", 190 "PIE alpha scaled by 1000"); 191SYSCTL_PROC(_net_inet_ip_dummynet_pie, OID_AUTO, beta, 192 CTLTYPE_LONG | CTLFLAG_RW, NULL, 0, 193 pie_sysctl_alpha_beta_handler, "L", 194 "beta scaled by 1000"); 195#endif 196 197 198/* 199 * Callout function for drop probability calculation 200 * This function is called over tupdate ms and takes pointer of PIE 201 * status variables as an argument 202 */ 203static void 204calculate_drop_prob(void *x) 205{ 206 int64_t p, prob, oldprob; 207 struct dn_aqm_pie_parms *pprms; 208 struct pie_status *pst = (struct pie_status *) x; 209 int p_isneg; 210 211 pprms = pst->parms; 212 prob = pst->drop_prob; 213 214 /* calculate current qdelay using DRE method. 215 * If TS is used and no data in the queue, reset current_qdelay 216 * as it stays at last value during dequeue process. 217 */ 218 if (pprms->flags & PIE_DEPRATEEST_ENABLED) 219 pst->current_qdelay = ((uint64_t)pst->pq->ni.len_bytes * 220 pst->avg_dq_time) >> PIE_DQ_THRESHOLD_BITS; 221 else 222 if (!pst->pq->ni.len_bytes) 223 pst->current_qdelay = 0; 224 225 /* calculate drop probability */ 226 p = (int64_t)pprms->alpha * 227 ((int64_t)pst->current_qdelay - (int64_t)pprms->qdelay_ref); 228 p +=(int64_t) pprms->beta * 229 ((int64_t)pst->current_qdelay - (int64_t)pst->qdelay_old); 230 231 /* take absolute value so right shift result is well defined */ 232 p_isneg = p < 0; 233 if (p_isneg) { 234 p = -p; 235 } 236 237 /* We PIE_MAX_PROB shift by 12-bits to increase the division precision */ 238 p *= (PIE_MAX_PROB << 12) / AQM_TIME_1S; 239 240 /* auto-tune drop probability */ 241 if (prob < (PIE_MAX_PROB / 1000000)) /* 0.000001 */ 242 p >>= 11 + PIE_FIX_POINT_BITS + 12; 243 else if (prob < (PIE_MAX_PROB / 100000)) /* 0.00001 */ 244 p >>= 9 + PIE_FIX_POINT_BITS + 12; 245 else if (prob < (PIE_MAX_PROB / 10000)) /* 0.0001 */ 246 p >>= 7 + PIE_FIX_POINT_BITS + 12; 247 else if (prob < (PIE_MAX_PROB / 1000)) /* 0.001 */ 248 p >>= 5 + PIE_FIX_POINT_BITS + 12; 249 else if (prob < (PIE_MAX_PROB / 100)) /* 0.01 */ 250 p >>= 3 + PIE_FIX_POINT_BITS + 12; 251 else if (prob < (PIE_MAX_PROB / 10)) /* 0.1 */ 252 p >>= 1 + PIE_FIX_POINT_BITS + 12; 253 else 254 p >>= PIE_FIX_POINT_BITS + 12; 255 256 oldprob = prob; 257 258 if (p_isneg) { 259 prob = prob - p; 260 261 /* check for multiplication underflow */ 262 if (prob > oldprob) { 263 prob= 0; 264 D("underflow"); 265 } 266 } else { 267 /* Cap Drop adjustment */ 268 if ((pprms->flags & PIE_CAPDROP_ENABLED) && 269 prob >= PIE_MAX_PROB / 10 && 270 p > PIE_MAX_PROB / 50 ) { 271 p = PIE_MAX_PROB / 50; 272 } 273 274 prob = prob + p; 275 276 /* check for multiplication overflow */ 277 if (prob<oldprob) { 278 D("overflow"); 279 prob= PIE_MAX_PROB; 280 } 281 } 282 283 /* 284 * decay the drop probability exponentially 285 * and restrict it to range 0 to PIE_MAX_PROB 286 */ 287 if (prob < 0) { 288 prob = 0; 289 } else { 290 if (pst->current_qdelay == 0 && pst->qdelay_old == 0) { 291 /* 0.98 ~= 1- 1/64 */ 292 prob = prob - (prob >> 6); 293 } 294 295 if (prob > PIE_MAX_PROB) { 296 prob = PIE_MAX_PROB; 297 } 298 } 299 300 pst->drop_prob = prob; 301 302 /* store current queue delay value in old queue delay*/ 303 pst->qdelay_old = pst->current_qdelay; 304 305 /* update burst allowance */ 306 if ((pst->sflags & PIE_ACTIVE) && pst->burst_allowance>0) { 307 308 if (pst->burst_allowance > pprms->tupdate ) 309 pst->burst_allowance -= pprms->tupdate; 310 else 311 pst->burst_allowance = 0; 312 } 313 314 /* reschedule calculate_drop_prob function */ 315 if (pst->sflags & PIE_ACTIVE) 316 callout_reset_sbt(&pst->aqm_pie_callout, 317 (uint64_t)pprms->tupdate * SBT_1US, 0, calculate_drop_prob, pst, 0); 318 319 mtx_unlock(&pst->lock_mtx); 320} 321 322/* 323 * Extract a packet from the head of queue 'q' 324 * Return a packet or NULL if the queue is empty. 325 * If getts is set, also extract packet's timestamp from mtag. 326 */ 327static struct mbuf * 328pie_extract_head(struct dn_queue *q, aqm_time_t *pkt_ts, int getts) 329{ 330 struct m_tag *mtag; 331 struct mbuf *m = q->mq.head; 332 333 if (m == NULL) 334 return m; 335 q->mq.head = m->m_nextpkt; 336 337 /* Update stats */ 338 update_stats(q, -m->m_pkthdr.len, 0); 339 340 if (q->ni.length == 0) /* queue is now idle */ 341 q->q_time = dn_cfg.curr_time; 342 343 if (getts) { 344 /* extract packet TS*/ 345 mtag = m_tag_locate(m, MTAG_ABI_COMPAT, DN_AQM_MTAG_TS, NULL); 346 if (mtag == NULL) { 347 D("PIE timestamp mtag not found!"); 348 *pkt_ts = 0; 349 } else { 350 *pkt_ts = *(aqm_time_t *)(mtag + 1); 351 m_tag_delete(m,mtag); 352 } 353 } 354 return m; 355} 356 357/* 358 * Initiate PIE variable and optionally activate it 359 */ 360__inline static void 361init_activate_pie(struct pie_status *pst, int resettimer) 362{ 363 struct dn_aqm_pie_parms *pprms; 364 365 mtx_lock(&pst->lock_mtx); 366 pprms = pst->parms; 367 pst->drop_prob = 0; 368 pst->qdelay_old = 0; 369 pst->burst_allowance = pprms->max_burst; 370 pst->accu_prob = 0; 371 pst->dq_count = 0; 372 pst->avg_dq_time = 0; 373 pst->sflags = PIE_INMEASUREMENT; 374 pst->measurement_start = AQM_UNOW; 375 376 if (resettimer) { 377 pst->sflags |= PIE_ACTIVE; 378 callout_reset_sbt(&pst->aqm_pie_callout, 379 (uint64_t)pprms->tupdate * SBT_1US, 380 0, calculate_drop_prob, pst, 0); 381 } 382 //DX(2, "PIE Activated"); 383 mtx_unlock(&pst->lock_mtx); 384} 385 386/* 387 * Deactivate PIE and stop probe update callout 388 */ 389__inline static void 390deactivate_pie(struct pie_status *pst) 391{ 392 mtx_lock(&pst->lock_mtx); 393 pst->sflags &= ~(PIE_ACTIVE | PIE_INMEASUREMENT); 394 callout_stop(&pst->aqm_pie_callout); 395 //D("PIE Deactivated"); 396 mtx_unlock(&pst->lock_mtx); 397} 398 399/* 400 * Dequeue and return a pcaket from queue 'q' or NULL if 'q' is empty. 401 * Also, caculate depature time or queue delay using timestamp 402 */ 403static struct mbuf * 404aqm_pie_dequeue(struct dn_queue *q) 405{ 406 struct mbuf *m; 407 struct dn_flow *ni; /* stats for scheduler instance */ 408 struct dn_aqm_pie_parms *pprms; 409 struct pie_status *pst; 410 aqm_time_t now; 411 aqm_time_t pkt_ts, dq_time; 412 int32_t w; 413 414 pst = q->aqm_status; 415 pprms = pst->parms; 416 ni = &q->_si->ni; 417 418 /*we extarct packet ts only when Departure Rate Estimation dis not used*/ 419 m = pie_extract_head(q, &pkt_ts, !(pprms->flags & PIE_DEPRATEEST_ENABLED)); 420 421 if (!m || !(pst->sflags & PIE_ACTIVE)) 422 return m; 423 424 now = AQM_UNOW; 425 if (pprms->flags & PIE_DEPRATEEST_ENABLED) { 426 /* calculate average depature time */ 427 if(pst->sflags & PIE_INMEASUREMENT) { 428 pst->dq_count += m->m_pkthdr.len; 429 430 if (pst->dq_count >= PIE_DQ_THRESHOLD) { 431 dq_time = now - pst->measurement_start; 432 433 /* 434 * if we don't have old avg dq_time i.e PIE is (re)initialized, 435 * don't use weight to calculate new avg_dq_time 436 */ 437 if(pst->avg_dq_time == 0) 438 pst->avg_dq_time = dq_time; 439 else { 440 /* 441 * weight = PIE_DQ_THRESHOLD/2^6, but we scaled 442 * weight by 2^8. Thus, scaled 443 * weight = PIE_DQ_THRESHOLD /2^8 444 * */ 445 w = PIE_DQ_THRESHOLD >> 8; 446 pst->avg_dq_time = (dq_time* w 447 + (pst->avg_dq_time * ((1L << 8) - w))) >> 8; 448 pst->sflags &= ~PIE_INMEASUREMENT; 449 } 450 } 451 } 452 453 /* 454 * Start new measurment cycle when the queue has 455 * PIE_DQ_THRESHOLD worth of bytes. 456 */ 457 if(!(pst->sflags & PIE_INMEASUREMENT) && 458 q->ni.len_bytes >= PIE_DQ_THRESHOLD) { 459 pst->sflags |= PIE_INMEASUREMENT; 460 pst->measurement_start = now; 461 pst->dq_count = 0; 462 } 463 } 464 /* Optionally, use packet timestamp to estimate queue delay */ 465 else 466 pst->current_qdelay = now - pkt_ts; 467 468 return m; 469} 470 471/* 472 * Enqueue a packet in q, subject to space and PIE queue management policy 473 * (whose parameters are in q->fs). 474 * Update stats for the queue and the scheduler. 475 * Return 0 on success, 1 on drop. The packet is consumed anyways. 476 */ 477static int 478aqm_pie_enqueue(struct dn_queue *q, struct mbuf* m) 479{ 480 struct dn_fs *f; 481 uint64_t len; 482 uint32_t qlen; 483 struct pie_status *pst; 484 struct dn_aqm_pie_parms *pprms; 485 int t; 486 487 len = m->m_pkthdr.len; 488 pst = q->aqm_status; 489 if(!pst) { 490 DX(2, "PIE queue is not initialized\n"); 491 update_stats(q, 0, 1); 492 FREE_PKT(m); 493 return 1; 494 } 495 496 f = &(q->fs->fs); 497 pprms = pst->parms; 498 t = ENQUE; 499 500 /* get current queue length in bytes or packets*/ 501 qlen = (f->flags & DN_QSIZE_BYTES) ? 502 q->ni.len_bytes : q->ni.length; 503 504 /* check for queue size and drop the tail if exceed queue limit*/ 505 if (qlen >= f->qsize) 506 t = DROP; 507 /* drop/mark the packet when PIE is active and burst time elapsed */ 508 else if ((pst->sflags & PIE_ACTIVE) && pst->burst_allowance==0 509 && drop_early(pst, q->ni.len_bytes) == DROP) { 510 /* 511 * if drop_prob over ECN threshold, drop the packet 512 * otherwise mark and enqueue it. 513 */ 514 if ((pprms->flags & PIE_ECN_ENABLED) && pst->drop_prob < 515 (pprms->max_ecnth << (PIE_PROB_BITS - PIE_FIX_POINT_BITS)) 516 && ecn_mark(m)) 517 t = ENQUE; 518 else 519 t = DROP; 520 } 521 522 /* Turn PIE on when 1/3 of the queue is full */ 523 if (!(pst->sflags & PIE_ACTIVE) && qlen >= pst->one_third_q_size) { 524 init_activate_pie(pst, 1); 525 } 526 527 /* Reset burst tolerance and optinally turn PIE off*/ 528 if ((pst->sflags & PIE_ACTIVE) && pst->drop_prob == 0 && 529 pst->current_qdelay < (pprms->qdelay_ref >> 1) && 530 pst->qdelay_old < (pprms->qdelay_ref >> 1)) { 531 532 pst->burst_allowance = pprms->max_burst; 533 if ((pprms->flags & PIE_ON_OFF_MODE_ENABLED) && qlen<=0) 534 deactivate_pie(pst); 535 } 536 537 /* Timestamp the packet if Departure Rate Estimation is disabled */ 538 if (t != DROP && !(pprms->flags & PIE_DEPRATEEST_ENABLED)) { 539 /* Add TS to mbuf as a TAG */ 540 struct m_tag *mtag; 541 mtag = m_tag_locate(m, MTAG_ABI_COMPAT, DN_AQM_MTAG_TS, NULL); 542 if (mtag == NULL) 543 mtag = m_tag_alloc(MTAG_ABI_COMPAT, DN_AQM_MTAG_TS, 544 sizeof(aqm_time_t), M_NOWAIT); 545 if (mtag == NULL) { 546 m_freem(m); 547 t = DROP; 548 } 549 *(aqm_time_t *)(mtag + 1) = AQM_UNOW; 550 m_tag_prepend(m, mtag); 551 } 552 553 if (t != DROP) { 554 mq_append(&q->mq, m); 555 update_stats(q, len, 0); 556 return (0); 557 } else { 558 update_stats(q, 0, 1); 559 560 /* reset accu_prob after packet drop */ 561 pst->accu_prob = 0; 562 FREE_PKT(m); 563 return 1; 564 } 565 return 0; 566} 567 568/* 569 * initialize PIE for queue 'q' 570 * First allocate memory for PIE status. 571 */ 572static int 573aqm_pie_init(struct dn_queue *q) 574{ 575 struct pie_status *pst; 576 struct dn_aqm_pie_parms *pprms; 577 int err = 0; 578 579 pprms = q->fs->aqmcfg; 580 581 do { /* exit with break when error occurs*/ 582 if (!pprms){ 583 DX(2, "AQM_PIE is not configured"); 584 err = EINVAL; 585 break; 586 } 587 588 q->aqm_status = malloc(sizeof(struct pie_status), 589 M_DUMMYNET, M_NOWAIT | M_ZERO); 590 if (q->aqm_status == NULL) { 591 D("cannot allocate PIE private data"); 592 err = ENOMEM ; 593 break; 594 } 595 596 pst = q->aqm_status; 597 /* increase reference count for PIE module */ 598 pie_desc.ref_count++; 599 600 pst->pq = q; 601 pst->parms = pprms; 602 603 /* For speed optimization, we caculate 1/3 queue size once here */ 604 // we can use x/3 = (x >>2) + (x >>4) + (x >>7) 605 pst->one_third_q_size = q->fs->fs.qsize/3; 606 607 mtx_init(&pst->lock_mtx, "mtx_pie", NULL, MTX_DEF); 608 callout_init_mtx(&pst->aqm_pie_callout, &pst->lock_mtx, 609 CALLOUT_RETURNUNLOCKED); 610 611 pst->current_qdelay = 0; 612 init_activate_pie(pst, !(pprms->flags & PIE_ON_OFF_MODE_ENABLED)); 613 614 //DX(2, "aqm_PIE_init"); 615 616 } while(0); 617 618 return err; 619} 620 621/* 622 * Callout function to destroy pie mtx and free PIE status memory 623 */ 624static void 625pie_callout_cleanup(void *x) 626{ 627 struct pie_status *pst = (struct pie_status *) x; 628 629 mtx_unlock(&pst->lock_mtx); 630 mtx_destroy(&pst->lock_mtx); 631 free(x, M_DUMMYNET); 632 DN_BH_WLOCK(); 633 pie_desc.ref_count--; 634 DN_BH_WUNLOCK(); 635} 636 637/* 638 * Clean up PIE status for queue 'q' 639 * Destroy memory allocated for PIE status. 640 */ 641static int 642aqm_pie_cleanup(struct dn_queue *q) 643{ 644 645 if(!q) { 646 D("q is null"); 647 return 0; 648 } 649 struct pie_status *pst = q->aqm_status; 650 if(!pst) { 651 //D("queue is already cleaned up"); 652 return 0; 653 } 654 if(!q->fs || !q->fs->aqmcfg) { 655 D("fs is null or no cfg"); 656 return 1; 657 } 658 if (q->fs->aqmfp && q->fs->aqmfp->type !=DN_AQM_PIE) { 659 D("Not PIE fs (%d)", q->fs->fs.fs_nr); 660 return 1; 661 } 662 663 /* 664 * Free PIE status allocated memory using pie_callout_cleanup() callout 665 * function to avoid any potential race. 666 * We reset aqm_pie_callout to call pie_callout_cleanup() in next 1um. This 667 * stops the scheduled calculate_drop_prob() callout and call pie_callout_cleanup() 668 * which does memory freeing. 669 */ 670 mtx_lock(&pst->lock_mtx); 671 callout_reset_sbt(&pst->aqm_pie_callout, 672 SBT_1US, 0, pie_callout_cleanup, pst, 0); 673 q->aqm_status = NULL; 674 mtx_unlock(&pst->lock_mtx); 675 676 return 0; 677} 678 679/* 680 * Config PIE parameters 681 * also allocate memory for PIE configurations 682 */ 683static int 684aqm_pie_config(struct dn_fsk* fs, struct dn_extra_parms *ep, int len) 685{ 686 struct dn_aqm_pie_parms *pcfg; 687 688 int l = sizeof(struct dn_extra_parms); 689 if (len < l) { 690 D("invalid sched parms length got %d need %d", len, l); 691 return EINVAL; 692 } 693 /* we free the old cfg because maybe the orignal allocation 694 * was used for diffirent AQM type. 695 */ 696 if (fs->aqmcfg) { 697 free(fs->aqmcfg, M_DUMMYNET); 698 fs->aqmcfg = NULL; 699 } 700 701 fs->aqmcfg = malloc(sizeof(struct dn_aqm_pie_parms), 702 M_DUMMYNET, M_NOWAIT | M_ZERO); 703 if (fs->aqmcfg== NULL) { 704 D("cannot allocate PIE configuration parameters"); 705 return ENOMEM; 706 } 707 708 /* par array contains pie configuration as follow 709 * 0- qdelay_ref,1- tupdate, 2- max_burst 710 * 3- max_ecnth, 4- alpha, 5- beta, 6- flags 711 */ 712 713 /* configure PIE parameters */ 714 pcfg = fs->aqmcfg; 715 716 if (ep->par[0] < 0) 717 pcfg->qdelay_ref = pie_sysctl.qdelay_ref * AQM_TIME_1US; 718 else 719 pcfg->qdelay_ref = ep->par[0]; 720 if (ep->par[1] < 0) 721 pcfg->tupdate = pie_sysctl.tupdate * AQM_TIME_1US; 722 else 723 pcfg->tupdate = ep->par[1]; 724 if (ep->par[2] < 0) 725 pcfg->max_burst = pie_sysctl.max_burst * AQM_TIME_1US; 726 else 727 pcfg->max_burst = ep->par[2]; 728 if (ep->par[3] < 0) 729 pcfg->max_ecnth = pie_sysctl.max_ecnth; 730 else 731 pcfg->max_ecnth = ep->par[3]; 732 if (ep->par[4] < 0) 733 pcfg->alpha = pie_sysctl.alpha; 734 else 735 pcfg->alpha = ep->par[4]; 736 if (ep->par[5] < 0) 737 pcfg->beta = pie_sysctl.beta; 738 else 739 pcfg->beta = ep->par[5]; 740 if (ep->par[6] < 0) 741 pcfg->flags = pie_sysctl.flags; 742 else 743 pcfg->flags = ep->par[6]; 744 745 /* bound PIE configurations */ 746 pcfg->qdelay_ref = BOUND_VAR(pcfg->qdelay_ref, 1, 10 * AQM_TIME_1S); 747 pcfg->tupdate = BOUND_VAR(pcfg->tupdate, 1, 10 * AQM_TIME_1S); 748 pcfg->max_burst = BOUND_VAR(pcfg->max_burst, 0, 10 * AQM_TIME_1S); 749 pcfg->max_ecnth = BOUND_VAR(pcfg->max_ecnth, 0, PIE_SCALE); 750 pcfg->alpha = BOUND_VAR(pcfg->alpha, 0, 7 * PIE_SCALE); 751 pcfg->beta = BOUND_VAR(pcfg->beta, 0 , 7 * PIE_SCALE); 752 753 pie_desc.cfg_ref_count++; 754 //D("pie cfg_ref_count=%d", pie_desc.cfg_ref_count); 755 return 0; 756} 757 758/* 759 * Deconfigure PIE and free memory allocation 760 */ 761static int 762aqm_pie_deconfig(struct dn_fsk* fs) 763{ 764 if (fs && fs->aqmcfg) { 765 free(fs->aqmcfg, M_DUMMYNET); 766 fs->aqmcfg = NULL; 767 pie_desc.cfg_ref_count--; 768 } 769 return 0; 770} 771 772/* 773 * Retrieve PIE configuration parameters. 774 */ 775static int 776aqm_pie_getconfig (struct dn_fsk *fs, struct dn_extra_parms * ep) 777{ 778 struct dn_aqm_pie_parms *pcfg; 779 if (fs->aqmcfg) { 780 strlcpy(ep->name, pie_desc.name, sizeof(ep->name)); 781 pcfg = fs->aqmcfg; 782 ep->par[0] = pcfg->qdelay_ref / AQM_TIME_1US; 783 ep->par[1] = pcfg->tupdate / AQM_TIME_1US; 784 ep->par[2] = pcfg->max_burst / AQM_TIME_1US; 785 ep->par[3] = pcfg->max_ecnth; 786 ep->par[4] = pcfg->alpha; 787 ep->par[5] = pcfg->beta; 788 ep->par[6] = pcfg->flags; 789 790 return 0; 791 } 792 return 1; 793} 794 795static struct dn_aqm pie_desc = { 796 _SI( .type = ) DN_AQM_PIE, 797 _SI( .name = ) "PIE", 798 _SI( .ref_count = ) 0, 799 _SI( .cfg_ref_count = ) 0, 800 _SI( .enqueue = ) aqm_pie_enqueue, 801 _SI( .dequeue = ) aqm_pie_dequeue, 802 _SI( .config = ) aqm_pie_config, 803 _SI( .deconfig = ) aqm_pie_deconfig, 804 _SI( .getconfig = ) aqm_pie_getconfig, 805 _SI( .init = ) aqm_pie_init, 806 _SI( .cleanup = ) aqm_pie_cleanup, 807}; 808 809DECLARE_DNAQM_MODULE(dn_aqm_pie, &pie_desc); 810#endif 811