1/* 2 * Codel/FQ_Codel and PIE/FQ_PIE Code: 3 * Copyright (C) 2016 Centre for Advanced Internet Architectures, 4 * Swinburne University of Technology, Melbourne, Australia. 5 * Portions of this code were made possible in part by a gift from 6 * The Comcast Innovation Fund. 7 * Implemented by Rasool Al-Saadi <ralsaadi@swin.edu.au> 8 * 9 * Copyright (c) 2002-2003,2010 Luigi Rizzo 10 * 11 * Redistribution and use in source forms, with and without modification, 12 * are permitted provided that this entire comment appears intact. 13 * 14 * Redistribution in binary form may occur without any restrictions. 15 * Obviously, it would be nice if you gave credit where credit is due 16 * but requiring it would be too onerous. 17 * 18 * This software is provided ``AS IS'' without any warranties of any kind. 19 * 20 * $FreeBSD: stable/11/sbin/ipfw/dummynet.c 331194 2018-03-19 07:28:54Z eadler $ 21 * 22 * dummynet support 23 */ 24 25#define NEW_AQM 26#include <sys/types.h> 27#include <sys/socket.h> 28/* XXX there are several sysctl leftover here */ 29#include <sys/sysctl.h> 30 31#include "ipfw2.h" 32 33#ifdef NEW_AQM 34#include <stdint.h> 35#endif 36 37#include <ctype.h> 38#include <err.h> 39#include <errno.h> 40#include <libutil.h> 41#include <netdb.h> 42#include <stdio.h> 43#include <stdlib.h> 44#include <string.h> 45#include <sysexits.h> 46 47#include <net/if.h> 48#include <netinet/in.h> 49#include <netinet/ip_fw.h> 50#include <netinet/ip_dummynet.h> 51#include <arpa/inet.h> /* inet_ntoa */ 52 53 54static struct _s_x dummynet_params[] = { 55 { "plr", TOK_PLR }, 56 { "noerror", TOK_NOERROR }, 57 { "buckets", TOK_BUCKETS }, 58 { "dst-ip", TOK_DSTIP }, 59 { "src-ip", TOK_SRCIP }, 60 { "dst-port", TOK_DSTPORT }, 61 { "src-port", TOK_SRCPORT }, 62 { "proto", TOK_PROTO }, 63 { "weight", TOK_WEIGHT }, 64 { "lmax", TOK_LMAX }, 65 { "maxlen", TOK_LMAX }, 66 { "all", TOK_ALL }, 67 { "mask", TOK_MASK }, /* alias for both */ 68 { "sched_mask", TOK_SCHED_MASK }, 69 { "flow_mask", TOK_FLOW_MASK }, 70 { "droptail", TOK_DROPTAIL }, 71 { "ecn", TOK_ECN }, 72 { "red", TOK_RED }, 73 { "gred", TOK_GRED }, 74#ifdef NEW_AQM 75 { "codel", TOK_CODEL}, /* Codel AQM */ 76 { "fq_codel", TOK_FQ_CODEL}, /* FQ-Codel */ 77 { "pie", TOK_PIE}, /* PIE AQM */ 78 { "fq_pie", TOK_FQ_PIE}, /* FQ-PIE */ 79#endif 80 { "bw", TOK_BW }, 81 { "bandwidth", TOK_BW }, 82 { "delay", TOK_DELAY }, 83 { "link", TOK_LINK }, 84 { "pipe", TOK_PIPE }, 85 { "queue", TOK_QUEUE }, 86 { "flowset", TOK_FLOWSET }, 87 { "sched", TOK_SCHED }, 88 { "pri", TOK_PRI }, 89 { "priority", TOK_PRI }, 90 { "type", TOK_TYPE }, 91 { "flow-id", TOK_FLOWID}, 92 { "dst-ipv6", TOK_DSTIP6}, 93 { "dst-ip6", TOK_DSTIP6}, 94 { "src-ipv6", TOK_SRCIP6}, 95 { "src-ip6", TOK_SRCIP6}, 96 { "profile", TOK_PROFILE}, 97 { "burst", TOK_BURST}, 98 { "dummynet-params", TOK_NULL }, 99 { NULL, 0 } /* terminator */ 100}; 101 102#ifdef NEW_AQM 103/* AQM/extra sched parameters tokens*/ 104static struct _s_x aqm_params[] = { 105 { "target", TOK_TARGET}, 106 { "interval", TOK_INTERVAL}, 107 { "limit", TOK_LIMIT}, 108 { "flows", TOK_FLOWS}, 109 { "quantum", TOK_QUANTUM}, 110 { "ecn", TOK_ECN}, 111 { "noecn", TOK_NO_ECN}, 112 { "tupdate", TOK_TUPDATE}, 113 { "max_burst", TOK_MAX_BURST}, 114 { "max_ecnth", TOK_MAX_ECNTH}, 115 { "alpha", TOK_ALPHA}, 116 { "beta", TOK_BETA}, 117 { "capdrop", TOK_CAPDROP}, 118 { "nocapdrop", TOK_NO_CAPDROP}, 119 { "onoff", TOK_ONOFF}, 120 { "dre", TOK_DRE}, 121 { "ts", TOK_TS}, 122 { "derand", TOK_DERAND}, 123 { "noderand", TOK_NO_DERAND}, 124 { NULL, 0 } /* terminator */ 125}; 126#endif 127 128#define O_NEXT(p, len) ((void *)((char *)p + len)) 129 130static void 131oid_fill(struct dn_id *oid, int len, int type, uintptr_t id) 132{ 133 oid->len = len; 134 oid->type = type; 135 oid->subtype = 0; 136 oid->id = id; 137} 138 139/* make room in the buffer and move the pointer forward */ 140static void * 141o_next(struct dn_id **o, int len, int type) 142{ 143 struct dn_id *ret = *o; 144 oid_fill(ret, len, type, 0); 145 *o = O_NEXT(*o, len); 146 return ret; 147} 148 149#ifdef NEW_AQM 150 151/* Codel flags */ 152enum { 153 CODEL_ECN_ENABLED = 1 154}; 155 156/* PIE flags, from PIE kernel module */ 157enum { 158 PIE_ECN_ENABLED = 1, 159 PIE_CAPDROP_ENABLED = 2, 160 PIE_ON_OFF_MODE_ENABLED = 4, 161 PIE_DEPRATEEST_ENABLED = 8, 162 PIE_DERAND_ENABLED = 16 163}; 164 165#define PIE_FIX_POINT_BITS 13 166#define PIE_SCALE (1L<<PIE_FIX_POINT_BITS) 167 168/* integer to time */ 169void 170us_to_time(int t,char *strt) 171{ 172 if (t < 0) 173 strt[0]='\0'; 174 else if ( t==0 ) 175 sprintf(strt,"%d", t); 176 else if (t< 1000) 177 sprintf(strt,"%dus", t); 178 else if (t < 1000000) 179 sprintf(strt,"%gms", (float) t / 1000); 180 else 181 sprintf(strt,"%gfs", (float) t / 1000000); 182} 183 184/* 185 * returns -1 if s is not a valid time, otherwise, return time in us 186 */ 187static long 188time_to_us(const char *s) 189{ 190 int i, dots = 0; 191 int len = strlen(s); 192 char strt[16]="", stru[16]=""; 193 194 if (len>15) 195 return -1; 196 for (i = 0; i<len && (isdigit(s[i]) || s[i]=='.') ; i++) 197 if (s[i]=='.') { 198 if (dots) 199 return -1; 200 else 201 dots++; 202 } 203 204 if (!i) 205 return -1; 206 strncpy(strt, s, i); 207 if (i<len) 208 strcpy(stru, s+i); 209 else 210 strcpy(stru, "ms"); 211 212 if (!strcasecmp(stru, "us")) 213 return atol(strt); 214 if (!strcasecmp(stru, "ms")) 215 return (strtod(strt, NULL) * 1000); 216 if (!strcasecmp(stru, "s")) 217 return (strtod(strt, NULL)*1000000); 218 219 return -1; 220} 221 222 223/* Get AQM or scheduler extra parameters */ 224void 225get_extra_parms(uint32_t nr, char *out, int subtype) 226{ 227 struct dn_extra_parms *ep; 228 int ret; 229 char strt1[15], strt2[15], strt3[15]; 230 u_int l; 231 232 /* prepare the request */ 233 l = sizeof(struct dn_extra_parms); 234 ep = safe_calloc(1, l); 235 memset(ep, 0, sizeof(*ep)); 236 *out = '\0'; 237 238 oid_fill(&ep->oid, l, DN_CMD_GET, DN_API_VERSION); 239 ep->oid.len = l; 240 ep->oid.subtype = subtype; 241 ep->nr = nr; 242 243 ret = do_cmd(-IP_DUMMYNET3, ep, (uintptr_t)&l); 244 if (ret) { 245 free(ep); 246 errx(EX_DATAERR, "Error getting extra parameters\n"); 247 } 248 249 switch (subtype) { 250 case DN_AQM_PARAMS: 251 if( !strcasecmp(ep->name, "codel")) { 252 us_to_time(ep->par[0], strt1); 253 us_to_time(ep->par[1], strt2); 254 l = sprintf(out, " AQM CoDel target %s interval %s", 255 strt1, strt2); 256 if (ep->par[2] & CODEL_ECN_ENABLED) 257 l = sprintf(out + l, " ECN"); 258 else 259 l += sprintf(out + l, " NoECN"); 260 } else if( !strcasecmp(ep->name, "pie")) { 261 us_to_time(ep->par[0], strt1); 262 us_to_time(ep->par[1], strt2); 263 us_to_time(ep->par[2], strt3); 264 l = sprintf(out, " AQM type PIE target %s tupdate %s alpha " 265 "%g beta %g max_burst %s max_ecnth %.3g", 266 strt1, 267 strt2, 268 ep->par[4] / (float) PIE_SCALE, 269 ep->par[5] / (float) PIE_SCALE, 270 strt3, 271 ep->par[3] / (float) PIE_SCALE 272 ); 273 274 if (ep->par[6] & PIE_ECN_ENABLED) 275 l += sprintf(out + l, " ECN"); 276 else 277 l += sprintf(out + l, " NoECN"); 278 if (ep->par[6] & PIE_CAPDROP_ENABLED) 279 l += sprintf(out + l, " CapDrop"); 280 else 281 l += sprintf(out + l, " NoCapDrop"); 282 if (ep->par[6] & PIE_ON_OFF_MODE_ENABLED) 283 l += sprintf(out + l, " OnOff"); 284 if (ep->par[6] & PIE_DEPRATEEST_ENABLED) 285 l += sprintf(out + l, " DRE"); 286 else 287 l += sprintf(out + l, " TS"); 288 if (ep->par[6] & PIE_DERAND_ENABLED) 289 l += sprintf(out + l, " Derand"); 290 else 291 l += sprintf(out + l, " NoDerand"); 292 } 293 break; 294 295 case DN_SCH_PARAMS: 296 if (!strcasecmp(ep->name,"FQ_CODEL")) { 297 us_to_time(ep->par[0], strt1); 298 us_to_time(ep->par[1], strt2); 299 l = sprintf(out," FQ_CODEL target %s interval %s" 300 " quantum %jd limit %jd flows %jd", 301 strt1, strt2, 302 (intmax_t) ep->par[3], 303 (intmax_t) ep->par[4], 304 (intmax_t) ep->par[5] 305 ); 306 if (ep->par[2] & CODEL_ECN_ENABLED) 307 l += sprintf(out + l, " ECN"); 308 else 309 l += sprintf(out + l, " NoECN"); 310 l += sprintf(out + l, "\n"); 311 } else if (!strcasecmp(ep->name,"FQ_PIE")) { 312 us_to_time(ep->par[0], strt1); 313 us_to_time(ep->par[1], strt2); 314 us_to_time(ep->par[2], strt3); 315 l = sprintf(out, " FQ_PIE target %s tupdate %s alpha " 316 "%g beta %g max_burst %s max_ecnth %.3g" 317 " quantum %jd limit %jd flows %jd", 318 strt1, 319 strt2, 320 ep->par[4] / (float) PIE_SCALE, 321 ep->par[5] / (float) PIE_SCALE, 322 strt3, 323 ep->par[3] / (float) PIE_SCALE, 324 (intmax_t) ep->par[7], 325 (intmax_t) ep->par[8], 326 (intmax_t) ep->par[9] 327 ); 328 329 if (ep->par[6] & PIE_ECN_ENABLED) 330 l += sprintf(out + l, " ECN"); 331 else 332 l += sprintf(out + l, " NoECN"); 333 if (ep->par[6] & PIE_CAPDROP_ENABLED) 334 l += sprintf(out + l, " CapDrop"); 335 else 336 l += sprintf(out + l, " NoCapDrop"); 337 if (ep->par[6] & PIE_ON_OFF_MODE_ENABLED) 338 l += sprintf(out + l, " OnOff"); 339 if (ep->par[6] & PIE_DEPRATEEST_ENABLED) 340 l += sprintf(out + l, " DRE"); 341 else 342 l += sprintf(out + l, " TS"); 343 if (ep->par[6] & PIE_DERAND_ENABLED) 344 l += sprintf(out + l, " Derand"); 345 else 346 l += sprintf(out + l, " NoDerand"); 347 l += sprintf(out + l, "\n"); 348 } 349 break; 350 } 351 352 free(ep); 353} 354#endif 355 356 357#if 0 358static int 359sort_q(void *arg, const void *pa, const void *pb) 360{ 361 int rev = (co.do_sort < 0); 362 int field = rev ? -co.do_sort : co.do_sort; 363 long long res = 0; 364 const struct dn_flow_queue *a = pa; 365 const struct dn_flow_queue *b = pb; 366 367 switch (field) { 368 case 1: /* pkts */ 369 res = a->len - b->len; 370 break; 371 case 2: /* bytes */ 372 res = a->len_bytes - b->len_bytes; 373 break; 374 375 case 3: /* tot pkts */ 376 res = a->tot_pkts - b->tot_pkts; 377 break; 378 379 case 4: /* tot bytes */ 380 res = a->tot_bytes - b->tot_bytes; 381 break; 382 } 383 if (res < 0) 384 res = -1; 385 if (res > 0) 386 res = 1; 387 return (int)(rev ? res : -res); 388} 389#endif 390 391/* print a mask and header for the subsequent list of flows */ 392static void 393print_mask(struct ipfw_flow_id *id) 394{ 395 if (!IS_IP6_FLOW_ID(id)) { 396 printf(" " 397 "mask: %s 0x%02x 0x%08x/0x%04x -> 0x%08x/0x%04x\n", 398 id->extra ? "queue," : "", 399 id->proto, 400 id->src_ip, id->src_port, 401 id->dst_ip, id->dst_port); 402 } else { 403 char buf[255]; 404 printf("\n mask: %sproto: 0x%02x, flow_id: 0x%08x, ", 405 id->extra ? "queue," : "", 406 id->proto, id->flow_id6); 407 inet_ntop(AF_INET6, &(id->src_ip6), buf, sizeof(buf)); 408 printf("%s/0x%04x -> ", buf, id->src_port); 409 inet_ntop(AF_INET6, &(id->dst_ip6), buf, sizeof(buf)); 410 printf("%s/0x%04x\n", buf, id->dst_port); 411 } 412} 413 414static void 415print_header(struct ipfw_flow_id *id) 416{ 417 if (!IS_IP6_FLOW_ID(id)) 418 printf("BKT Prot ___Source IP/port____ " 419 "____Dest. IP/port____ " 420 "Tot_pkt/bytes Pkt/Byte Drp\n"); 421 else 422 printf("BKT ___Prot___ _flow-id_ " 423 "______________Source IPv6/port_______________ " 424 "_______________Dest. IPv6/port_______________ " 425 "Tot_pkt/bytes Pkt/Byte Drp\n"); 426} 427 428static void 429list_flow(struct buf_pr *bp, struct dn_flow *ni) 430{ 431 char buff[255]; 432 struct protoent *pe = NULL; 433 struct in_addr ina; 434 struct ipfw_flow_id *id = &ni->fid; 435 436 pe = getprotobynumber(id->proto); 437 /* XXX: Should check for IPv4 flows */ 438 bprintf(bp, "%3u%c", (ni->oid.id) & 0xff, 439 id->extra ? '*' : ' '); 440 if (!IS_IP6_FLOW_ID(id)) { 441 if (pe) 442 bprintf(bp, "%-4s ", pe->p_name); 443 else 444 bprintf(bp, "%4u ", id->proto); 445 ina.s_addr = htonl(id->src_ip); 446 bprintf(bp, "%15s/%-5d ", 447 inet_ntoa(ina), id->src_port); 448 ina.s_addr = htonl(id->dst_ip); 449 bprintf(bp, "%15s/%-5d ", 450 inet_ntoa(ina), id->dst_port); 451 } else { 452 /* Print IPv6 flows */ 453 if (pe != NULL) 454 bprintf(bp, "%9s ", pe->p_name); 455 else 456 bprintf(bp, "%9u ", id->proto); 457 bprintf(bp, "%7d %39s/%-5d ", id->flow_id6, 458 inet_ntop(AF_INET6, &(id->src_ip6), buff, sizeof(buff)), 459 id->src_port); 460 bprintf(bp, " %39s/%-5d ", 461 inet_ntop(AF_INET6, &(id->dst_ip6), buff, sizeof(buff)), 462 id->dst_port); 463 } 464 pr_u64(bp, &ni->tot_pkts, 4); 465 pr_u64(bp, &ni->tot_bytes, 8); 466 bprintf(bp, "%2u %4u %3u", 467 ni->length, ni->len_bytes, ni->drops); 468} 469 470static void 471print_flowset_parms(struct dn_fs *fs, char *prefix) 472{ 473 int l; 474 char qs[30]; 475 char plr[30]; 476 char red[200]; /* Display RED parameters */ 477 478 l = fs->qsize; 479 if (fs->flags & DN_QSIZE_BYTES) { 480 if (l >= 8192) 481 sprintf(qs, "%d KB", l / 1024); 482 else 483 sprintf(qs, "%d B", l); 484 } else 485 sprintf(qs, "%3d sl.", l); 486 if (fs->plr) 487 sprintf(plr, "plr %f", 1.0 * fs->plr / (double)(0x7fffffff)); 488 else 489 plr[0] = '\0'; 490 491 if (fs->flags & DN_IS_RED) { /* RED parameters */ 492 sprintf(red, 493 "\n\t %cRED w_q %f min_th %d max_th %d max_p %f", 494 (fs->flags & DN_IS_GENTLE_RED) ? 'G' : ' ', 495 1.0 * fs->w_q / (double)(1 << SCALE_RED), 496 fs->min_th, 497 fs->max_th, 498 1.0 * fs->max_p / (double)(1 << SCALE_RED)); 499 if (fs->flags & DN_IS_ECN) 500 strncat(red, " (ecn)", 6); 501#ifdef NEW_AQM 502 /* get AQM parameters */ 503 } else if (fs->flags & DN_IS_AQM) { 504 get_extra_parms(fs->fs_nr, red, DN_AQM_PARAMS); 505#endif 506 } else 507 sprintf(red, "droptail"); 508 509 if (prefix[0]) { 510 printf("%s %s%s %d queues (%d buckets) %s\n", 511 prefix, qs, plr, fs->oid.id, fs->buckets, red); 512 prefix[0] = '\0'; 513 } else { 514 printf("q%05d %s%s %d flows (%d buckets) sched %d " 515 "weight %d lmax %d pri %d %s\n", 516 fs->fs_nr, qs, plr, fs->oid.id, fs->buckets, 517 fs->sched_nr, fs->par[0], fs->par[1], fs->par[2], red); 518 if (fs->flags & DN_HAVE_MASK) 519 print_mask(&fs->flow_mask); 520 } 521} 522 523static void 524print_extra_delay_parms(struct dn_profile *p) 525{ 526 double loss; 527 if (p->samples_no <= 0) 528 return; 529 530 loss = p->loss_level; 531 loss /= p->samples_no; 532 printf("\t profile: name \"%s\" loss %f samples %d\n", 533 p->name, loss, p->samples_no); 534} 535 536static void 537flush_buf(char *buf) 538{ 539 if (buf[0]) 540 printf("%s\n", buf); 541 buf[0] = '\0'; 542} 543 544/* 545 * generic list routine. We expect objects in a specific order, i.e. 546 * PIPES AND SCHEDULERS: 547 * link; scheduler; internal flowset if any; instances 548 * we can tell a pipe from the number. 549 * 550 * FLOWSETS: 551 * flowset; queues; 552 * link i (int queue); scheduler i; si(i) { flowsets() : queues } 553 */ 554static void 555list_pipes(struct dn_id *oid, struct dn_id *end) 556{ 557 char buf[160]; /* pending buffer */ 558 int toPrint = 1; /* print header */ 559 struct buf_pr bp; 560 561 buf[0] = '\0'; 562 bp_alloc(&bp, 4096); 563 for (; oid != end; oid = O_NEXT(oid, oid->len)) { 564 if (oid->len < sizeof(*oid)) 565 errx(1, "invalid oid len %d\n", oid->len); 566 567 switch (oid->type) { 568 default: 569 flush_buf(buf); 570 printf("unrecognized object %d size %d\n", oid->type, oid->len); 571 break; 572 case DN_TEXT: /* list of attached flowsets */ 573 { 574 int i, l; 575 struct { 576 struct dn_id id; 577 uint32_t p[0]; 578 } *d = (void *)oid; 579 l = (oid->len - sizeof(*oid))/sizeof(d->p[0]); 580 if (l == 0) 581 break; 582 printf(" Children flowsets: "); 583 for (i = 0; i < l; i++) 584 printf("%u ", d->p[i]); 585 printf("\n"); 586 break; 587 } 588 case DN_CMD_GET: 589 if (co.verbose) 590 printf("answer for cmd %d, len %d\n", oid->type, oid->id); 591 break; 592 case DN_SCH: { 593 struct dn_sch *s = (struct dn_sch *)oid; 594 flush_buf(buf); 595 printf(" sched %d type %s flags 0x%x %d buckets %d active\n", 596 s->sched_nr, 597 s->name, s->flags, s->buckets, s->oid.id); 598#ifdef NEW_AQM 599 char parms[200]; 600 get_extra_parms(s->sched_nr, parms, DN_SCH_PARAMS); 601 printf("%s",parms); 602#endif 603 if (s->flags & DN_HAVE_MASK) 604 print_mask(&s->sched_mask); 605 } 606 break; 607 608 case DN_FLOW: 609 if (toPrint != 0) { 610 print_header(&((struct dn_flow *)oid)->fid); 611 toPrint = 0; 612 } 613 list_flow(&bp, (struct dn_flow *)oid); 614 printf("%s\n", bp.buf); 615 bp_flush(&bp); 616 break; 617 618 case DN_LINK: { 619 struct dn_link *p = (struct dn_link *)oid; 620 double b = p->bandwidth; 621 char bwbuf[30]; 622 char burst[5 + 7]; 623 624 /* This starts a new object so flush buffer */ 625 flush_buf(buf); 626 /* data rate */ 627 if (b == 0) 628 sprintf(bwbuf, "unlimited "); 629 else if (b >= 1000000000) 630 sprintf(bwbuf, "%7.3f Gbit/s", b/1000000000); 631 else if (b >= 1000000) 632 sprintf(bwbuf, "%7.3f Mbit/s", b/1000000); 633 else if (b >= 1000) 634 sprintf(bwbuf, "%7.3f Kbit/s", b/1000); 635 else 636 sprintf(bwbuf, "%7.3f bit/s ", b); 637 638 if (humanize_number(burst, sizeof(burst), p->burst, 639 "", HN_AUTOSCALE, 0) < 0 || co.verbose) 640 sprintf(burst, "%d", (int)p->burst); 641 sprintf(buf, "%05d: %s %4d ms burst %s", 642 p->link_nr % DN_MAX_ID, bwbuf, p->delay, burst); 643 } 644 break; 645 646 case DN_FS: 647 print_flowset_parms((struct dn_fs *)oid, buf); 648 break; 649 case DN_PROFILE: 650 flush_buf(buf); 651 print_extra_delay_parms((struct dn_profile *)oid); 652 } 653 flush_buf(buf); // XXX does it really go here ? 654 } 655 656 bp_free(&bp); 657} 658 659/* 660 * Delete pipe, queue or scheduler i 661 */ 662int 663ipfw_delete_pipe(int do_pipe, int i) 664{ 665 struct { 666 struct dn_id oid; 667 uintptr_t a[1]; /* add more if we want a list */ 668 } cmd; 669 oid_fill((void *)&cmd, sizeof(cmd), DN_CMD_DELETE, DN_API_VERSION); 670 cmd.oid.subtype = (do_pipe == 1) ? DN_LINK : 671 ( (do_pipe == 2) ? DN_FS : DN_SCH); 672 cmd.a[0] = i; 673 i = do_cmd(IP_DUMMYNET3, &cmd, cmd.oid.len); 674 if (i) { 675 i = 1; 676 warn("rule %u: setsockopt(IP_DUMMYNET_DEL)", i); 677 } 678 return i; 679} 680 681/* 682 * Code to parse delay profiles. 683 * 684 * Some link types introduce extra delays in the transmission 685 * of a packet, e.g. because of MAC level framing, contention on 686 * the use of the channel, MAC level retransmissions and so on. 687 * From our point of view, the channel is effectively unavailable 688 * for this extra time, which is constant or variable depending 689 * on the link type. Additionally, packets may be dropped after this 690 * time (e.g. on a wireless link after too many retransmissions). 691 * We can model the additional delay with an empirical curve 692 * that represents its distribution. 693 * 694 * cumulative probability 695 * 1.0 ^ 696 * | 697 * L +-- loss-level x 698 * | ****** 699 * | * 700 * | ***** 701 * | * 702 * | ** 703 * | * 704 * +-------*-------------------> 705 * delay 706 * 707 * The empirical curve may have both vertical and horizontal lines. 708 * Vertical lines represent constant delay for a range of 709 * probabilities; horizontal lines correspond to a discontinuty 710 * in the delay distribution: the link will use the largest delay 711 * for a given probability. 712 * 713 * To pass the curve to dummynet, we must store the parameters 714 * in a file as described below, and issue the command 715 * 716 * ipfw pipe <n> config ... bw XXX profile <filename> ... 717 * 718 * The file format is the following, with whitespace acting as 719 * a separator and '#' indicating the beginning a comment: 720 * 721 * samples N 722 * the number of samples used in the internal 723 * representation (2..1024; default 100); 724 * 725 * loss-level L 726 * The probability above which packets are lost. 727 * (0.0 <= L <= 1.0, default 1.0 i.e. no loss); 728 * 729 * name identifier 730 * Optional a name (listed by "ipfw pipe show") 731 * to identify the distribution; 732 * 733 * "delay prob" | "prob delay" 734 * One of these two lines is mandatory and defines 735 * the format of the following lines with data points. 736 * 737 * XXX YYY 738 * 2 or more lines representing points in the curve, 739 * with either delay or probability first, according 740 * to the chosen format. 741 * The unit for delay is milliseconds. 742 * 743 * Data points does not need to be ordered or equal to the number 744 * specified in the "samples" line. ipfw will sort and interpolate 745 * the curve as needed. 746 * 747 * Example of a profile file: 748 749 name bla_bla_bla 750 samples 100 751 loss-level 0.86 752 prob delay 753 0 200 # minimum overhead is 200ms 754 0.5 200 755 0.5 300 756 0.8 1000 757 0.9 1300 758 1 1300 759 760 * Internally, we will convert the curve to a fixed number of 761 * samples, and when it is time to transmit a packet we will 762 * model the extra delay as extra bits in the packet. 763 * 764 */ 765 766#define ED_MAX_LINE_LEN 256+ED_MAX_NAME_LEN 767#define ED_TOK_SAMPLES "samples" 768#define ED_TOK_LOSS "loss-level" 769#define ED_TOK_NAME "name" 770#define ED_TOK_DELAY "delay" 771#define ED_TOK_PROB "prob" 772#define ED_TOK_BW "bw" 773#define ED_SEPARATORS " \t\n" 774#define ED_MIN_SAMPLES_NO 2 775 776/* 777 * returns 1 if s is a non-negative number, with at least one '.' 778 */ 779static int 780is_valid_number(const char *s) 781{ 782 int i, dots_found = 0; 783 int len = strlen(s); 784 785 for (i = 0; i<len; ++i) 786 if (!isdigit(s[i]) && (s[i] !='.' || ++dots_found > 1)) 787 return 0; 788 return 1; 789} 790 791/* 792 * Take as input a string describing a bandwidth value 793 * and return the numeric bandwidth value. 794 * set clocking interface or bandwidth value 795 */ 796static void 797read_bandwidth(char *arg, int *bandwidth, char *if_name, int namelen) 798{ 799 if (*bandwidth != -1) 800 warnx("duplicate token, override bandwidth value!"); 801 802 if (arg[0] >= 'a' && arg[0] <= 'z') { 803 if (!if_name) { 804 errx(1, "no if support"); 805 } 806 if (namelen >= IFNAMSIZ) 807 warn("interface name truncated"); 808 namelen--; 809 /* interface name */ 810 strlcpy(if_name, arg, namelen); 811 *bandwidth = 0; 812 } else { /* read bandwidth value */ 813 int bw; 814 char *end = NULL; 815 816 bw = strtoul(arg, &end, 0); 817 if (*end == 'K' || *end == 'k') { 818 end++; 819 bw *= 1000; 820 } else if (*end == 'M' || *end == 'm') { 821 end++; 822 bw *= 1000000; 823 } else if (*end == 'G' || *end == 'g') { 824 end++; 825 bw *= 1000000000; 826 } 827 if ((*end == 'B' && 828 _substrcmp2(end, "Bi", "Bit/s") != 0) || 829 _substrcmp2(end, "by", "bytes") == 0) 830 bw *= 8; 831 832 if (bw < 0) 833 errx(EX_DATAERR, "bandwidth too large"); 834 835 *bandwidth = bw; 836 if (if_name) 837 if_name[0] = '\0'; 838 } 839} 840 841struct point { 842 double prob; 843 double delay; 844}; 845 846static int 847compare_points(const void *vp1, const void *vp2) 848{ 849 const struct point *p1 = vp1; 850 const struct point *p2 = vp2; 851 double res = 0; 852 853 res = p1->prob - p2->prob; 854 if (res == 0) 855 res = p1->delay - p2->delay; 856 if (res < 0) 857 return -1; 858 else if (res > 0) 859 return 1; 860 else 861 return 0; 862} 863 864#define ED_EFMT(s) EX_DATAERR,"error in %s at line %d: "#s,filename,lineno 865 866static void 867load_extra_delays(const char *filename, struct dn_profile *p, 868 struct dn_link *link) 869{ 870 char line[ED_MAX_LINE_LEN]; 871 FILE *f; 872 int lineno = 0; 873 int i; 874 875 int samples = -1; 876 double loss = -1.0; 877 char profile_name[ED_MAX_NAME_LEN]; 878 int delay_first = -1; 879 int do_points = 0; 880 struct point points[ED_MAX_SAMPLES_NO]; 881 int points_no = 0; 882 883 /* XXX link never NULL? */ 884 p->link_nr = link->link_nr; 885 886 profile_name[0] = '\0'; 887 f = fopen(filename, "r"); 888 if (f == NULL) 889 err(EX_UNAVAILABLE, "fopen: %s", filename); 890 891 while (fgets(line, ED_MAX_LINE_LEN, f)) { /* read commands */ 892 char *s, *cur = line, *name = NULL, *arg = NULL; 893 894 ++lineno; 895 896 /* parse the line */ 897 while (cur) { 898 s = strsep(&cur, ED_SEPARATORS); 899 if (s == NULL || *s == '#') 900 break; 901 if (*s == '\0') 902 continue; 903 if (arg) 904 errx(ED_EFMT("too many arguments")); 905 if (name == NULL) 906 name = s; 907 else 908 arg = s; 909 } 910 if (name == NULL) /* empty line */ 911 continue; 912 if (arg == NULL) 913 errx(ED_EFMT("missing arg for %s"), name); 914 915 if (!strcasecmp(name, ED_TOK_SAMPLES)) { 916 if (samples > 0) 917 errx(ED_EFMT("duplicate ``samples'' line")); 918 if (atoi(arg) <=0) 919 errx(ED_EFMT("invalid number of samples")); 920 samples = atoi(arg); 921 if (samples>ED_MAX_SAMPLES_NO) 922 errx(ED_EFMT("too many samples, maximum is %d"), 923 ED_MAX_SAMPLES_NO); 924 do_points = 0; 925 } else if (!strcasecmp(name, ED_TOK_BW)) { 926 char buf[IFNAMSIZ]; 927 read_bandwidth(arg, &link->bandwidth, buf, sizeof(buf)); 928 } else if (!strcasecmp(name, ED_TOK_LOSS)) { 929 if (loss != -1.0) 930 errx(ED_EFMT("duplicated token: %s"), name); 931 if (!is_valid_number(arg)) 932 errx(ED_EFMT("invalid %s"), arg); 933 loss = atof(arg); 934 if (loss > 1) 935 errx(ED_EFMT("%s greater than 1.0"), name); 936 do_points = 0; 937 } else if (!strcasecmp(name, ED_TOK_NAME)) { 938 if (profile_name[0] != '\0') 939 errx(ED_EFMT("duplicated token: %s"), name); 940 strlcpy(profile_name, arg, sizeof(profile_name)); 941 do_points = 0; 942 } else if (!strcasecmp(name, ED_TOK_DELAY)) { 943 if (do_points) 944 errx(ED_EFMT("duplicated token: %s"), name); 945 delay_first = 1; 946 do_points = 1; 947 } else if (!strcasecmp(name, ED_TOK_PROB)) { 948 if (do_points) 949 errx(ED_EFMT("duplicated token: %s"), name); 950 delay_first = 0; 951 do_points = 1; 952 } else if (do_points) { 953 if (!is_valid_number(name) || !is_valid_number(arg)) 954 errx(ED_EFMT("invalid point found")); 955 if (delay_first) { 956 points[points_no].delay = atof(name); 957 points[points_no].prob = atof(arg); 958 } else { 959 points[points_no].delay = atof(arg); 960 points[points_no].prob = atof(name); 961 } 962 if (points[points_no].prob > 1.0) 963 errx(ED_EFMT("probability greater than 1.0")); 964 ++points_no; 965 } else { 966 errx(ED_EFMT("unrecognised command '%s'"), name); 967 } 968 } 969 970 fclose (f); 971 972 if (samples == -1) { 973 warnx("'%s' not found, assuming 100", ED_TOK_SAMPLES); 974 samples = 100; 975 } 976 977 if (loss == -1.0) { 978 warnx("'%s' not found, assuming no loss", ED_TOK_LOSS); 979 loss = 1; 980 } 981 982 /* make sure that there are enough points. */ 983 if (points_no < ED_MIN_SAMPLES_NO) 984 errx(ED_EFMT("too few samples, need at least %d"), 985 ED_MIN_SAMPLES_NO); 986 987 qsort(points, points_no, sizeof(struct point), compare_points); 988 989 /* interpolation */ 990 for (i = 0; i<points_no-1; ++i) { 991 double y1 = points[i].prob * samples; 992 double x1 = points[i].delay; 993 double y2 = points[i+1].prob * samples; 994 double x2 = points[i+1].delay; 995 996 int ix = y1; 997 int stop = y2; 998 999 if (x1 == x2) { 1000 for (; ix<stop; ++ix) 1001 p->samples[ix] = x1; 1002 } else { 1003 double m = (y2-y1)/(x2-x1); 1004 double c = y1 - m*x1; 1005 for (; ix<stop ; ++ix) 1006 p->samples[ix] = (ix - c)/m; 1007 } 1008 } 1009 p->samples_no = samples; 1010 p->loss_level = loss * samples; 1011 strlcpy(p->name, profile_name, sizeof(p->name)); 1012} 1013 1014#ifdef NEW_AQM 1015 1016/* Parse AQM/extra scheduler parameters */ 1017static int 1018process_extra_parms(int *ac, char **av, struct dn_extra_parms *ep, 1019 uint16_t type) 1020{ 1021 int i; 1022 1023 /* use kernel defaults */ 1024 for (i=0; i<DN_MAX_EXTRA_PARM; i++) 1025 ep->par[i] = -1; 1026 1027 switch(type) { 1028 case TOK_CODEL: 1029 case TOK_FQ_CODEL: 1030 /* Codel 1031 * 0- target, 1- interval, 2- flags, 1032 * FQ_CODEL 1033 * 3- quantum, 4- limit, 5- flows 1034 */ 1035 if (type==TOK_CODEL) 1036 ep->par[2] = 0; 1037 else 1038 ep->par[2] = CODEL_ECN_ENABLED; 1039 1040 while (*ac > 0) { 1041 int tok = match_token(aqm_params, *av); 1042 (*ac)--; av++; 1043 switch(tok) { 1044 case TOK_TARGET: 1045 if (*ac <= 0 || time_to_us(av[0]) < 0) 1046 errx(EX_DATAERR, "target needs time\n"); 1047 1048 ep->par[0] = time_to_us(av[0]); 1049 (*ac)--; av++; 1050 break; 1051 1052 case TOK_INTERVAL: 1053 if (*ac <= 0 || time_to_us(av[0]) < 0) 1054 errx(EX_DATAERR, "interval needs time\n"); 1055 1056 ep->par[1] = time_to_us(av[0]); 1057 (*ac)--; av++; 1058 break; 1059 1060 case TOK_ECN: 1061 ep->par[2] = CODEL_ECN_ENABLED; 1062 break; 1063 case TOK_NO_ECN: 1064 ep->par[2] &= ~CODEL_ECN_ENABLED; 1065 break; 1066 /* Config fq_codel parameters */ 1067 case TOK_QUANTUM: 1068 if (type != TOK_FQ_CODEL) 1069 errx(EX_DATAERR, "quantum is not for codel\n"); 1070 if (*ac <= 0 || !is_valid_number(av[0])) 1071 errx(EX_DATAERR, "quantum needs number\n"); 1072 1073 ep->par[3]= atoi(av[0]); 1074 (*ac)--; av++; 1075 break; 1076 1077 case TOK_LIMIT: 1078 if (type != TOK_FQ_CODEL) 1079 errx(EX_DATAERR, "limit is not for codel, use queue instead\n"); 1080 if (*ac <= 0 || !is_valid_number(av[0])) 1081 errx(EX_DATAERR, "limit needs number\n"); 1082 1083 ep->par[4] = atoi(av[0]); 1084 (*ac)--; av++; 1085 break; 1086 1087 case TOK_FLOWS: 1088 if (type != TOK_FQ_CODEL) 1089 errx(EX_DATAERR, "flows is not for codel\n"); 1090 if (*ac <= 0 || !is_valid_number(av[0])) 1091 errx(EX_DATAERR, "flows needs number\n"); 1092 1093 ep->par[5] = atoi(av[0]); 1094 (*ac)--; av++; 1095 break; 1096 1097 default: 1098 printf("%s is Invalid parameter\n", av[-1]); 1099 } 1100 } 1101 break; 1102 case TOK_PIE: 1103 case TOK_FQ_PIE: 1104 /* PIE 1105 * 0- target , 1- tupdate, 2- max_burst, 1106 * 3- max_ecnth, 4- alpha, 1107 * 5- beta, 6- flags 1108 * FQ_CODEL 1109 * 7- quantum, 8- limit, 9- flows 1110 */ 1111 1112 if ( type == TOK_PIE) 1113 ep->par[6] = PIE_CAPDROP_ENABLED | PIE_DEPRATEEST_ENABLED 1114 | PIE_DERAND_ENABLED; 1115 else 1116 /* for FQ-PIE, use TS mode */ 1117 ep->par[6] = PIE_CAPDROP_ENABLED | PIE_DERAND_ENABLED 1118 | PIE_ECN_ENABLED; 1119 1120 while (*ac > 0) { 1121 int tok = match_token(aqm_params, *av); 1122 (*ac)--; av++; 1123 switch(tok) { 1124 case TOK_TARGET: 1125 if (*ac <= 0 || time_to_us(av[0]) < 0) 1126 errx(EX_DATAERR, "target needs time\n"); 1127 1128 ep->par[0] = time_to_us(av[0]); 1129 (*ac)--; av++; 1130 break; 1131 1132 case TOK_TUPDATE: 1133 if (*ac <= 0 || time_to_us(av[0]) < 0) 1134 errx(EX_DATAERR, "tupdate needs time\n"); 1135 1136 ep->par[1] = time_to_us(av[0]); 1137 (*ac)--; av++; 1138 break; 1139 1140 case TOK_MAX_BURST: 1141 if (*ac <= 0 || time_to_us(av[0]) < 0) 1142 errx(EX_DATAERR, "max_burst needs time\n"); 1143 1144 ep->par[2] = time_to_us(av[0]); 1145 (*ac)--; av++; 1146 break; 1147 1148 case TOK_MAX_ECNTH: 1149 if (*ac <= 0 || !is_valid_number(av[0])) 1150 errx(EX_DATAERR, "max_ecnth needs number\n"); 1151 1152 ep->par[3] = atof(av[0]) * PIE_SCALE; 1153 (*ac)--; av++; 1154 break; 1155 1156 case TOK_ALPHA: 1157 if (*ac <= 0 || !is_valid_number(av[0])) 1158 errx(EX_DATAERR, "alpha needs number\n"); 1159 1160 ep->par[4] = atof(av[0]) * PIE_SCALE; 1161 (*ac)--; av++; 1162 break; 1163 1164 case TOK_BETA: 1165 if (*ac <= 0 || !is_valid_number(av[0])) 1166 errx(EX_DATAERR, "beta needs number\n"); 1167 1168 ep->par[5] = atof(av[0]) * PIE_SCALE; 1169 (*ac)--; av++; 1170 break; 1171 1172 case TOK_ECN: 1173 ep->par[6] |= PIE_ECN_ENABLED; 1174 break; 1175 case TOK_NO_ECN: 1176 ep->par[6] &= ~PIE_ECN_ENABLED; 1177 break; 1178 1179 case TOK_CAPDROP: 1180 ep->par[6] |= PIE_CAPDROP_ENABLED; 1181 break; 1182 case TOK_NO_CAPDROP: 1183 ep->par[6] &= ~PIE_CAPDROP_ENABLED; 1184 break; 1185 1186 case TOK_ONOFF: 1187 ep->par[6] |= PIE_ON_OFF_MODE_ENABLED; 1188 break; 1189 1190 case TOK_DRE: 1191 ep->par[6] |= PIE_DEPRATEEST_ENABLED; 1192 break; 1193 1194 case TOK_TS: 1195 ep->par[6] &= ~PIE_DEPRATEEST_ENABLED; 1196 break; 1197 1198 case TOK_DERAND: 1199 ep->par[6] |= PIE_DERAND_ENABLED; 1200 break; 1201 case TOK_NO_DERAND: 1202 ep->par[6] &= ~PIE_DERAND_ENABLED; 1203 break; 1204 1205 /* Config fq_pie parameters */ 1206 case TOK_QUANTUM: 1207 if (type != TOK_FQ_PIE) 1208 errx(EX_DATAERR, "quantum is not for pie\n"); 1209 if (*ac <= 0 || !is_valid_number(av[0])) 1210 errx(EX_DATAERR, "quantum needs number\n"); 1211 1212 ep->par[7]= atoi(av[0]); 1213 (*ac)--; av++; 1214 break; 1215 1216 case TOK_LIMIT: 1217 if (type != TOK_FQ_PIE) 1218 errx(EX_DATAERR, "limit is not for pie, use queue instead\n"); 1219 if (*ac <= 0 || !is_valid_number(av[0])) 1220 errx(EX_DATAERR, "limit needs number\n"); 1221 1222 ep->par[8] = atoi(av[0]); 1223 (*ac)--; av++; 1224 break; 1225 1226 case TOK_FLOWS: 1227 if (type != TOK_FQ_PIE) 1228 errx(EX_DATAERR, "flows is not for pie\n"); 1229 if (*ac <= 0 || !is_valid_number(av[0])) 1230 errx(EX_DATAERR, "flows needs number\n"); 1231 1232 ep->par[9] = atoi(av[0]); 1233 (*ac)--; av++; 1234 break; 1235 1236 1237 default: 1238 printf("%s is invalid parameter\n", av[-1]); 1239 } 1240 } 1241 break; 1242 } 1243 1244 return 0; 1245} 1246 1247#endif 1248 1249 1250/* 1251 * configuration of pipes, schedulers, flowsets. 1252 * When we configure a new scheduler, an empty pipe is created, so: 1253 * 1254 * do_pipe = 1 -> "pipe N config ..." only for backward compatibility 1255 * sched N+Delta type fifo sched_mask ... 1256 * pipe N+Delta <parameters> 1257 * flowset N+Delta pipe N+Delta (no parameters) 1258 * sched N type wf2q+ sched_mask ... 1259 * pipe N <parameters> 1260 * 1261 * do_pipe = 2 -> flowset N config 1262 * flowset N parameters 1263 * 1264 * do_pipe = 3 -> sched N config 1265 * sched N parameters (default no pipe) 1266 * optional Pipe N config ... 1267 * pipe ==> 1268 */ 1269void 1270ipfw_config_pipe(int ac, char **av) 1271{ 1272 int i; 1273 u_int j; 1274 char *end; 1275 struct dn_id *buf, *base; 1276 struct dn_sch *sch = NULL; 1277 struct dn_link *p = NULL; 1278 struct dn_fs *fs = NULL; 1279 struct dn_profile *pf = NULL; 1280 struct ipfw_flow_id *mask = NULL; 1281#ifdef NEW_AQM 1282 struct dn_extra_parms *aqm_extra; 1283 struct dn_extra_parms *sch_extra; 1284 int lmax_extra; 1285#endif 1286 1287 int lmax; 1288 uint32_t _foo = 0, *flags = &_foo , *buckets = &_foo; 1289 1290 /* 1291 * allocate space for 1 header, 1292 * 1 scheduler, 1 link, 1 flowset, 1 profile 1293 */ 1294 lmax = sizeof(struct dn_id); /* command header */ 1295 lmax += sizeof(struct dn_sch) + sizeof(struct dn_link) + 1296 sizeof(struct dn_fs) + sizeof(struct dn_profile); 1297 1298#ifdef NEW_AQM 1299 /* Extra Params */ 1300 lmax_extra = sizeof(struct dn_extra_parms); 1301 /* two lmax_extra because one for AQM params and another 1302 * sch params 1303 */ 1304 lmax += lmax_extra*2; 1305#endif 1306 1307 av++; ac--; 1308 /* Pipe number */ 1309 if (ac && isdigit(**av)) { 1310 i = atoi(*av); av++; ac--; 1311 } else 1312 i = -1; 1313 if (i <= 0) 1314 errx(EX_USAGE, "need a pipe/flowset/sched number"); 1315 base = buf = safe_calloc(1, lmax); 1316 /* all commands start with a 'CONFIGURE' and a version */ 1317 o_next(&buf, sizeof(struct dn_id), DN_CMD_CONFIG); 1318 base->id = DN_API_VERSION; 1319 1320 switch (co.do_pipe) { 1321 case 1: /* "pipe N config ..." */ 1322 /* Allocate space for the WF2Q+ scheduler, its link 1323 * and the FIFO flowset. Set the number, but leave 1324 * the scheduler subtype and other parameters to 0 1325 * so the kernel will use appropriate defaults. 1326 * XXX todo: add a flag to record if a parameter 1327 * is actually configured. 1328 * If we do a 'pipe config' mask -> sched_mask. 1329 * The FIFO scheduler and link are derived from the 1330 * WF2Q+ one in the kernel. 1331 */ 1332#ifdef NEW_AQM 1333 sch_extra = o_next(&buf, lmax_extra, DN_TEXT); 1334 sch_extra ->oid.subtype = 0; /* don't configure scheduler */ 1335#endif 1336 sch = o_next(&buf, sizeof(*sch), DN_SCH); 1337 p = o_next(&buf, sizeof(*p), DN_LINK); 1338#ifdef NEW_AQM 1339 aqm_extra = o_next(&buf, lmax_extra, DN_TEXT); 1340 aqm_extra ->oid.subtype = 0; /* don't configure AQM */ 1341#endif 1342 fs = o_next(&buf, sizeof(*fs), DN_FS); 1343 1344 sch->sched_nr = i; 1345 sch->oid.subtype = 0; /* defaults to WF2Q+ */ 1346 mask = &sch->sched_mask; 1347 flags = &sch->flags; 1348 buckets = &sch->buckets; 1349 *flags |= DN_PIPE_CMD; 1350 1351 p->link_nr = i; 1352 1353 /* This flowset is only for the FIFO scheduler */ 1354 fs->fs_nr = i + 2*DN_MAX_ID; 1355 fs->sched_nr = i + DN_MAX_ID; 1356 break; 1357 1358 case 2: /* "queue N config ... " */ 1359#ifdef NEW_AQM 1360 aqm_extra = o_next(&buf, lmax_extra, DN_TEXT); 1361 aqm_extra ->oid.subtype = 0; 1362#endif 1363 fs = o_next(&buf, sizeof(*fs), DN_FS); 1364 fs->fs_nr = i; 1365 mask = &fs->flow_mask; 1366 flags = &fs->flags; 1367 buckets = &fs->buckets; 1368 break; 1369 1370 case 3: /* "sched N config ..." */ 1371#ifdef NEW_AQM 1372 sch_extra = o_next(&buf, lmax_extra, DN_TEXT); 1373 sch_extra ->oid.subtype = 0; 1374#endif 1375 sch = o_next(&buf, sizeof(*sch), DN_SCH); 1376#ifdef NEW_AQM 1377 aqm_extra = o_next(&buf, lmax_extra, DN_TEXT); 1378 aqm_extra ->oid.subtype = 0; 1379#endif 1380 fs = o_next(&buf, sizeof(*fs), DN_FS); 1381 sch->sched_nr = i; 1382 mask = &sch->sched_mask; 1383 flags = &sch->flags; 1384 buckets = &sch->buckets; 1385 /* fs is used only with !MULTIQUEUE schedulers */ 1386 fs->fs_nr = i + DN_MAX_ID; 1387 fs->sched_nr = i; 1388 break; 1389 } 1390 /* set to -1 those fields for which we want to reuse existing 1391 * values from the kernel. 1392 * Also, *_nr and subtype = 0 mean reuse the value from the kernel. 1393 * XXX todo: support reuse of the mask. 1394 */ 1395 if (p) 1396 p->bandwidth = -1; 1397 for (j = 0; j < sizeof(fs->par)/sizeof(fs->par[0]); j++) 1398 fs->par[j] = -1; 1399 while (ac > 0) { 1400 double d; 1401 int tok = match_token(dummynet_params, *av); 1402 ac--; av++; 1403 1404 switch(tok) { 1405 case TOK_NOERROR: 1406 NEED(fs, "noerror is only for pipes"); 1407 fs->flags |= DN_NOERROR; 1408 break; 1409 1410 case TOK_PLR: 1411 NEED(fs, "plr is only for pipes"); 1412 NEED1("plr needs argument 0..1\n"); 1413 d = strtod(av[0], NULL); 1414 if (d > 1) 1415 d = 1; 1416 else if (d < 0) 1417 d = 0; 1418 fs->plr = (int)(d*0x7fffffff); 1419 ac--; av++; 1420 break; 1421 1422 case TOK_QUEUE: 1423 NEED(fs, "queue is only for pipes or flowsets"); 1424 NEED1("queue needs queue size\n"); 1425 end = NULL; 1426 fs->qsize = strtoul(av[0], &end, 0); 1427 if (*end == 'K' || *end == 'k') { 1428 fs->flags |= DN_QSIZE_BYTES; 1429 fs->qsize *= 1024; 1430 } else if (*end == 'B' || 1431 _substrcmp2(end, "by", "bytes") == 0) { 1432 fs->flags |= DN_QSIZE_BYTES; 1433 } 1434 ac--; av++; 1435 break; 1436 1437 case TOK_BUCKETS: 1438 NEED(fs, "buckets is only for pipes or flowsets"); 1439 NEED1("buckets needs argument\n"); 1440 *buckets = strtoul(av[0], NULL, 0); 1441 ac--; av++; 1442 break; 1443 1444 case TOK_FLOW_MASK: 1445 case TOK_SCHED_MASK: 1446 case TOK_MASK: 1447 NEED(mask, "tok_mask"); 1448 NEED1("mask needs mask specifier\n"); 1449 /* 1450 * per-flow queue, mask is dst_ip, dst_port, 1451 * src_ip, src_port, proto measured in bits 1452 */ 1453 1454 bzero(mask, sizeof(*mask)); 1455 end = NULL; 1456 1457 while (ac >= 1) { 1458 uint32_t *p32 = NULL; 1459 uint16_t *p16 = NULL; 1460 uint32_t *p20 = NULL; 1461 struct in6_addr *pa6 = NULL; 1462 uint32_t a; 1463 1464 tok = match_token(dummynet_params, *av); 1465 ac--; av++; 1466 switch(tok) { 1467 case TOK_ALL: 1468 /* 1469 * special case, all bits significant 1470 * except 'extra' (the queue number) 1471 */ 1472 mask->dst_ip = ~0; 1473 mask->src_ip = ~0; 1474 mask->dst_port = ~0; 1475 mask->src_port = ~0; 1476 mask->proto = ~0; 1477 n2mask(&mask->dst_ip6, 128); 1478 n2mask(&mask->src_ip6, 128); 1479 mask->flow_id6 = ~0; 1480 *flags |= DN_HAVE_MASK; 1481 goto end_mask; 1482 1483 case TOK_QUEUE: 1484 mask->extra = ~0; 1485 *flags |= DN_HAVE_MASK; 1486 goto end_mask; 1487 1488 case TOK_DSTIP: 1489 mask->addr_type = 4; 1490 p32 = &mask->dst_ip; 1491 break; 1492 1493 case TOK_SRCIP: 1494 mask->addr_type = 4; 1495 p32 = &mask->src_ip; 1496 break; 1497 1498 case TOK_DSTIP6: 1499 mask->addr_type = 6; 1500 pa6 = &mask->dst_ip6; 1501 break; 1502 1503 case TOK_SRCIP6: 1504 mask->addr_type = 6; 1505 pa6 = &mask->src_ip6; 1506 break; 1507 1508 case TOK_FLOWID: 1509 mask->addr_type = 6; 1510 p20 = &mask->flow_id6; 1511 break; 1512 1513 case TOK_DSTPORT: 1514 p16 = &mask->dst_port; 1515 break; 1516 1517 case TOK_SRCPORT: 1518 p16 = &mask->src_port; 1519 break; 1520 1521 case TOK_PROTO: 1522 break; 1523 1524 default: 1525 ac++; av--; /* backtrack */ 1526 goto end_mask; 1527 } 1528 if (ac < 1) 1529 errx(EX_USAGE, "mask: value missing"); 1530 if (*av[0] == '/') { 1531 a = strtoul(av[0]+1, &end, 0); 1532 if (pa6 == NULL) 1533 a = (a == 32) ? ~0 : (1 << a) - 1; 1534 } else 1535 a = strtoul(av[0], &end, 0); 1536 if (p32 != NULL) 1537 *p32 = a; 1538 else if (p16 != NULL) { 1539 if (a > 0xFFFF) 1540 errx(EX_DATAERR, 1541 "port mask must be 16 bit"); 1542 *p16 = (uint16_t)a; 1543 } else if (p20 != NULL) { 1544 if (a > 0xfffff) 1545 errx(EX_DATAERR, 1546 "flow_id mask must be 20 bit"); 1547 *p20 = (uint32_t)a; 1548 } else if (pa6 != NULL) { 1549 if (a > 128) 1550 errx(EX_DATAERR, 1551 "in6addr invalid mask len"); 1552 else 1553 n2mask(pa6, a); 1554 } else { 1555 if (a > 0xFF) 1556 errx(EX_DATAERR, 1557 "proto mask must be 8 bit"); 1558 mask->proto = (uint8_t)a; 1559 } 1560 if (a != 0) 1561 *flags |= DN_HAVE_MASK; 1562 ac--; av++; 1563 } /* end while, config masks */ 1564end_mask: 1565 break; 1566#ifdef NEW_AQM 1567 case TOK_CODEL: 1568 case TOK_PIE: 1569 NEED(fs, "codel/pie is only for flowsets"); 1570 1571 fs->flags &= ~(DN_IS_RED|DN_IS_GENTLE_RED); 1572 fs->flags |= DN_IS_AQM; 1573 1574 strlcpy(aqm_extra->name, av[-1], 1575 sizeof(aqm_extra->name)); 1576 aqm_extra->oid.subtype = DN_AQM_PARAMS; 1577 1578 process_extra_parms(&ac, av, aqm_extra, tok); 1579 break; 1580 1581 case TOK_FQ_CODEL: 1582 case TOK_FQ_PIE: 1583 if (!strcmp(av[-1],"type")) 1584 errx(EX_DATAERR, "use type before fq_codel/fq_pie"); 1585 1586 NEED(sch, "fq_codel/fq_pie is only for schd"); 1587 strlcpy(sch_extra->name, av[-1], 1588 sizeof(sch_extra->name)); 1589 sch_extra->oid.subtype = DN_SCH_PARAMS; 1590 process_extra_parms(&ac, av, sch_extra, tok); 1591 break; 1592#endif 1593 case TOK_RED: 1594 case TOK_GRED: 1595 NEED1("red/gred needs w_q/min_th/max_th/max_p\n"); 1596 fs->flags |= DN_IS_RED; 1597 if (tok == TOK_GRED) 1598 fs->flags |= DN_IS_GENTLE_RED; 1599 /* 1600 * the format for parameters is w_q/min_th/max_th/max_p 1601 */ 1602 if ((end = strsep(&av[0], "/"))) { 1603 double w_q = strtod(end, NULL); 1604 if (w_q > 1 || w_q <= 0) 1605 errx(EX_DATAERR, "0 < w_q <= 1"); 1606 fs->w_q = (int) (w_q * (1 << SCALE_RED)); 1607 } 1608 if ((end = strsep(&av[0], "/"))) { 1609 fs->min_th = strtoul(end, &end, 0); 1610 if (*end == 'K' || *end == 'k') 1611 fs->min_th *= 1024; 1612 } 1613 if ((end = strsep(&av[0], "/"))) { 1614 fs->max_th = strtoul(end, &end, 0); 1615 if (*end == 'K' || *end == 'k') 1616 fs->max_th *= 1024; 1617 } 1618 if ((end = strsep(&av[0], "/"))) { 1619 double max_p = strtod(end, NULL); 1620 if (max_p > 1 || max_p < 0) 1621 errx(EX_DATAERR, "0 <= max_p <= 1"); 1622 fs->max_p = (int)(max_p * (1 << SCALE_RED)); 1623 } 1624 ac--; av++; 1625 break; 1626 1627 case TOK_ECN: 1628 fs->flags |= DN_IS_ECN; 1629 break; 1630 1631 case TOK_DROPTAIL: 1632 NEED(fs, "droptail is only for flowsets"); 1633 fs->flags &= ~(DN_IS_RED|DN_IS_GENTLE_RED); 1634 break; 1635 1636 case TOK_BW: 1637 NEED(p, "bw is only for links"); 1638 NEED1("bw needs bandwidth or interface\n"); 1639 read_bandwidth(av[0], &p->bandwidth, NULL, 0); 1640 ac--; av++; 1641 break; 1642 1643 case TOK_DELAY: 1644 NEED(p, "delay is only for links"); 1645 NEED1("delay needs argument 0..10000ms\n"); 1646 p->delay = strtoul(av[0], NULL, 0); 1647 ac--; av++; 1648 break; 1649 1650 case TOK_TYPE: { 1651 int l; 1652 NEED(sch, "type is only for schedulers"); 1653 NEED1("type needs a string"); 1654 l = strlen(av[0]); 1655 if (l == 0 || l > 15) 1656 errx(1, "type %s too long\n", av[0]); 1657 strlcpy(sch->name, av[0], sizeof(sch->name)); 1658 sch->oid.subtype = 0; /* use string */ 1659#ifdef NEW_AQM 1660 /* if fq_codel is selected, consider all tokens after it 1661 * as parameters 1662 */ 1663 if (!strcasecmp(av[0],"fq_codel") || !strcasecmp(av[0],"fq_pie")){ 1664 strlcpy(sch_extra->name, av[0], 1665 sizeof(sch_extra->name)); 1666 sch_extra->oid.subtype = DN_SCH_PARAMS; 1667 process_extra_parms(&ac, av, sch_extra, tok); 1668 } else { 1669 ac--;av++; 1670 } 1671#else 1672 ac--;av++; 1673#endif 1674 break; 1675 } 1676 1677 case TOK_WEIGHT: 1678 NEED(fs, "weight is only for flowsets"); 1679 NEED1("weight needs argument\n"); 1680 fs->par[0] = strtol(av[0], &end, 0); 1681 ac--; av++; 1682 break; 1683 1684 case TOK_LMAX: 1685 NEED(fs, "lmax is only for flowsets"); 1686 NEED1("lmax needs argument\n"); 1687 fs->par[1] = strtol(av[0], &end, 0); 1688 ac--; av++; 1689 break; 1690 1691 case TOK_PRI: 1692 NEED(fs, "priority is only for flowsets"); 1693 NEED1("priority needs argument\n"); 1694 fs->par[2] = strtol(av[0], &end, 0); 1695 ac--; av++; 1696 break; 1697 1698 case TOK_SCHED: 1699 case TOK_PIPE: 1700 NEED(fs, "pipe/sched"); 1701 NEED1("pipe/link/sched needs number\n"); 1702 fs->sched_nr = strtoul(av[0], &end, 0); 1703 ac--; av++; 1704 break; 1705 1706 case TOK_PROFILE: 1707 NEED((!pf), "profile already set"); 1708 NEED(p, "profile"); 1709 { 1710 NEED1("extra delay needs the file name\n"); 1711 pf = o_next(&buf, sizeof(*pf), DN_PROFILE); 1712 load_extra_delays(av[0], pf, p); //XXX can't fail? 1713 --ac; ++av; 1714 } 1715 break; 1716 1717 case TOK_BURST: 1718 NEED(p, "burst"); 1719 NEED1("burst needs argument\n"); 1720 errno = 0; 1721 if (expand_number(av[0], &p->burst) < 0) 1722 if (errno != ERANGE) 1723 errx(EX_DATAERR, 1724 "burst: invalid argument"); 1725 if (errno || p->burst > (1ULL << 48) - 1) 1726 errx(EX_DATAERR, 1727 "burst: out of range (0..2^48-1)"); 1728 ac--; av++; 1729 break; 1730 1731 default: 1732 errx(EX_DATAERR, "unrecognised option ``%s''", av[-1]); 1733 } 1734 } 1735 1736 /* check validity of parameters */ 1737 if (p) { 1738 if (p->delay > 10000) 1739 errx(EX_DATAERR, "delay must be < 10000"); 1740 if (p->bandwidth == -1) 1741 p->bandwidth = 0; 1742 } 1743 if (fs) { 1744 /* XXX accept a 0 scheduler to keep the default */ 1745 if (fs->flags & DN_QSIZE_BYTES) { 1746 size_t len; 1747 long limit; 1748 1749 len = sizeof(limit); 1750 if (sysctlbyname("net.inet.ip.dummynet.pipe_byte_limit", 1751 &limit, &len, NULL, 0) == -1) 1752 limit = 1024*1024; 1753 if (fs->qsize > limit) 1754 errx(EX_DATAERR, "queue size must be < %ldB", limit); 1755 } else { 1756 size_t len; 1757 long limit; 1758 1759 len = sizeof(limit); 1760 if (sysctlbyname("net.inet.ip.dummynet.pipe_slot_limit", 1761 &limit, &len, NULL, 0) == -1) 1762 limit = 100; 1763 if (fs->qsize > limit) 1764 errx(EX_DATAERR, "2 <= queue size <= %ld", limit); 1765 } 1766 1767#ifdef NEW_AQM 1768 if ((fs->flags & DN_IS_ECN) && !((fs->flags & DN_IS_RED)|| 1769 (fs->flags & DN_IS_AQM))) 1770 errx(EX_USAGE, "ECN can be used with red/gred/" 1771 "codel/fq_codel only!"); 1772#else 1773 if ((fs->flags & DN_IS_ECN) && !(fs->flags & DN_IS_RED)) 1774 errx(EX_USAGE, "enable red/gred for ECN"); 1775 1776#endif 1777 1778 if (fs->flags & DN_IS_RED) { 1779 size_t len; 1780 int lookup_depth, avg_pkt_size; 1781 1782 if (!(fs->flags & DN_IS_ECN) && (fs->min_th >= fs->max_th)) 1783 errx(EX_DATAERR, "min_th %d must be < than max_th %d", 1784 fs->min_th, fs->max_th); 1785 else if ((fs->flags & DN_IS_ECN) && (fs->min_th > fs->max_th)) 1786 errx(EX_DATAERR, "min_th %d must be =< than max_th %d", 1787 fs->min_th, fs->max_th); 1788 1789 if (fs->max_th == 0) 1790 errx(EX_DATAERR, "max_th must be > 0"); 1791 1792 len = sizeof(int); 1793 if (sysctlbyname("net.inet.ip.dummynet.red_lookup_depth", 1794 &lookup_depth, &len, NULL, 0) == -1) 1795 lookup_depth = 256; 1796 if (lookup_depth == 0) 1797 errx(EX_DATAERR, "net.inet.ip.dummynet.red_lookup_depth" 1798 " must be greater than zero"); 1799 1800 len = sizeof(int); 1801 if (sysctlbyname("net.inet.ip.dummynet.red_avg_pkt_size", 1802 &avg_pkt_size, &len, NULL, 0) == -1) 1803 avg_pkt_size = 512; 1804 1805 if (avg_pkt_size == 0) 1806 errx(EX_DATAERR, 1807 "net.inet.ip.dummynet.red_avg_pkt_size must" 1808 " be greater than zero"); 1809 1810#if 0 /* the following computation is now done in the kernel */ 1811 /* 1812 * Ticks needed for sending a medium-sized packet. 1813 * Unfortunately, when we are configuring a WF2Q+ queue, we 1814 * do not have bandwidth information, because that is stored 1815 * in the parent pipe, and also we have multiple queues 1816 * competing for it. So we set s=0, which is not very 1817 * correct. But on the other hand, why do we want RED with 1818 * WF2Q+ ? 1819 */ 1820 if (p.bandwidth==0) /* this is a WF2Q+ queue */ 1821 s = 0; 1822 else 1823 s = (double)ck.hz * avg_pkt_size * 8 / p.bandwidth; 1824 /* 1825 * max idle time (in ticks) before avg queue size becomes 0. 1826 * NOTA: (3/w_q) is approx the value x so that 1827 * (1-w_q)^x < 10^-3. 1828 */ 1829 w_q = ((double)fs->w_q) / (1 << SCALE_RED); 1830 idle = s * 3. / w_q; 1831 fs->lookup_step = (int)idle / lookup_depth; 1832 if (!fs->lookup_step) 1833 fs->lookup_step = 1; 1834 weight = 1 - w_q; 1835 for (t = fs->lookup_step; t > 1; --t) 1836 weight *= 1 - w_q; 1837 fs->lookup_weight = (int)(weight * (1 << SCALE_RED)); 1838#endif /* code moved in the kernel */ 1839 } 1840 } 1841 1842 i = do_cmd(IP_DUMMYNET3, base, (char *)buf - (char *)base); 1843 1844 if (i) 1845 err(1, "setsockopt(%s)", "IP_DUMMYNET_CONFIGURE"); 1846} 1847 1848void 1849dummynet_flush(void) 1850{ 1851 struct dn_id oid; 1852 oid_fill(&oid, sizeof(oid), DN_CMD_FLUSH, DN_API_VERSION); 1853 do_cmd(IP_DUMMYNET3, &oid, oid.len); 1854} 1855 1856/* Parse input for 'ipfw [pipe|sched|queue] show [range list]' 1857 * Returns the number of ranges, and possibly stores them 1858 * in the array v of size len. 1859 */ 1860static int 1861parse_range(int ac, char *av[], uint32_t *v, int len) 1862{ 1863 int n = 0; 1864 char *endptr, *s; 1865 uint32_t base[2]; 1866 1867 if (v == NULL || len < 2) { 1868 v = base; 1869 len = 2; 1870 } 1871 1872 for (s = *av; s != NULL; av++, ac--) { 1873 v[0] = strtoul(s, &endptr, 10); 1874 v[1] = (*endptr != '-') ? v[0] : 1875 strtoul(endptr+1, &endptr, 10); 1876 if (*endptr == '\0') { /* prepare for next round */ 1877 s = (ac > 0) ? *(av+1) : NULL; 1878 } else { 1879 if (*endptr != ',') { 1880 warn("invalid number: %s", s); 1881 s = ++endptr; 1882 continue; 1883 } 1884 /* continue processing from here */ 1885 s = ++endptr; 1886 ac++; 1887 av--; 1888 } 1889 if (v[1] < v[0] || 1890 v[0] >= DN_MAX_ID-1 || 1891 v[1] >= DN_MAX_ID-1) { 1892 continue; /* invalid entry */ 1893 } 1894 n++; 1895 /* translate if 'pipe list' */ 1896 if (co.do_pipe == 1) { 1897 v[0] += DN_MAX_ID; 1898 v[1] += DN_MAX_ID; 1899 } 1900 v = (n*2 < len) ? v + 2 : base; 1901 } 1902 return n; 1903} 1904 1905/* main entry point for dummynet list functions. co.do_pipe indicates 1906 * which function we want to support. 1907 * av may contain filtering arguments, either individual entries 1908 * or ranges, or lists (space or commas are valid separators). 1909 * Format for a range can be n1-n2 or n3 n4 n5 ... 1910 * In a range n1 must be <= n2, otherwise the range is ignored. 1911 * A number 'n4' is translate in a range 'n4-n4' 1912 * All number must be > 0 and < DN_MAX_ID-1 1913 */ 1914void 1915dummynet_list(int ac, char *av[], int show_counters) 1916{ 1917 struct dn_id *oid, *x = NULL; 1918 int ret, i; 1919 int n; /* # of ranges */ 1920 u_int buflen, l; 1921 u_int max_size; /* largest obj passed up */ 1922 1923 (void)show_counters; // XXX unused, but we should use it. 1924 ac--; 1925 av++; /* skip 'list' | 'show' word */ 1926 1927 n = parse_range(ac, av, NULL, 0); /* Count # of ranges. */ 1928 1929 /* Allocate space to store ranges */ 1930 l = sizeof(*oid) + sizeof(uint32_t) * n * 2; 1931 oid = safe_calloc(1, l); 1932 oid_fill(oid, l, DN_CMD_GET, DN_API_VERSION); 1933 1934 if (n > 0) /* store ranges in idx */ 1935 parse_range(ac, av, (uint32_t *)(oid + 1), n*2); 1936 /* 1937 * Compute the size of the largest object returned. If the 1938 * response leaves at least this much spare space in the 1939 * buffer, then surely the response is complete; otherwise 1940 * there might be a risk of truncation and we will need to 1941 * retry with a larger buffer. 1942 * XXX don't bother with smaller structs. 1943 */ 1944 max_size = sizeof(struct dn_fs); 1945 if (max_size < sizeof(struct dn_sch)) 1946 max_size = sizeof(struct dn_sch); 1947 if (max_size < sizeof(struct dn_flow)) 1948 max_size = sizeof(struct dn_flow); 1949 1950 switch (co.do_pipe) { 1951 case 1: 1952 oid->subtype = DN_LINK; /* list pipe */ 1953 break; 1954 case 2: 1955 oid->subtype = DN_FS; /* list queue */ 1956 break; 1957 case 3: 1958 oid->subtype = DN_SCH; /* list sched */ 1959 break; 1960 } 1961 1962 /* 1963 * Ask the kernel an estimate of the required space (result 1964 * in oid.id), unless we are requesting a subset of objects, 1965 * in which case the kernel does not give an exact answer. 1966 * In any case, space might grow in the meantime due to the 1967 * creation of new queues, so we must be prepared to retry. 1968 */ 1969 if (n > 0) { 1970 buflen = 4*1024; 1971 } else { 1972 ret = do_cmd(-IP_DUMMYNET3, oid, (uintptr_t)&l); 1973 if (ret != 0 || oid->id <= sizeof(*oid)) 1974 goto done; 1975 buflen = oid->id + max_size; 1976 oid->len = sizeof(*oid); /* restore */ 1977 } 1978 /* Try a few times, until the buffer fits */ 1979 for (i = 0; i < 20; i++) { 1980 l = buflen; 1981 x = safe_realloc(x, l); 1982 bcopy(oid, x, oid->len); 1983 ret = do_cmd(-IP_DUMMYNET3, x, (uintptr_t)&l); 1984 if (ret != 0 || x->id <= sizeof(*oid)) 1985 goto done; /* no response */ 1986 if (l + max_size <= buflen) 1987 break; /* ok */ 1988 buflen *= 2; /* double for next attempt */ 1989 } 1990 list_pipes(x, O_NEXT(x, l)); 1991done: 1992 if (x) 1993 free(x); 1994 free(oid); 1995} 1996