git.oblomov.eu Git - linux-2.6/blob - net/sched/sch_netem.c

   1 /*
   2  * net/sched/sch_netem.c        Network emulator
   3  *
   4  *              This program is free software; you can redistribute it and/or
   5  *              modify it under the terms of the GNU General Public License
   6  *              as published by the Free Software Foundation; either version
   7  *              2 of the License.
   8  *
   9  *              Many of the algorithms and ideas for this came from
  10  *              NIST Net which is not copyrighted.
  11  *
  12  * Authors:     Stephen Hemminger <shemminger@osdl.org>
  13  *              Catalin(ux aka Dino) BOIE <catab at umbrella dot ro>
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/types.h>
  18 #include <linux/kernel.h>
  19 #include <linux/errno.h>
  20 #include <linux/skbuff.h>
  21 #include <linux/rtnetlink.h>
  22
  23 #include <net/netlink.h>
  24 #include <net/pkt_sched.h>
  25
  26 #define VERSION "1.2"
  27
  28 /*      Network Emulation Queuing algorithm.
  29         ====================================
  30
  31         Sources: [1] Mark Carson, Darrin Santay, "NIST Net - A Linux-based
  32                  Network Emulation Tool
  33                  [2] Luigi Rizzo, DummyNet for FreeBSD
  34
  35          ----------------------------------------------------------------
  36
  37          This started out as a simple way to delay outgoing packets to
  38          test TCP but has grown to include most of the functionality
  39          of a full blown network emulator like NISTnet. It can delay
  40          packets and add random jitter (and correlation). The random
  41          distribution can be loaded from a table as well to provide
  42          normal, Pareto, or experimental curves. Packet loss,
  43          duplication, and reordering can also be emulated.
  44
  45          This qdisc does not do classification that can be handled in
  46          layering other disciplines.  It does not need to do bandwidth
  47          control either since that can be handled by using token
  48          bucket or other rate control.
  49
  50          The simulator is limited by the Linux timer resolution
  51          and will create packet bursts on the HZ boundary (1ms).
  52 */
  53
  54 struct netem_sched_data {
  55         struct Qdisc    *qdisc;
  56         struct qdisc_watchdog watchdog;
  57
  58         psched_tdiff_t latency;
  59         psched_tdiff_t jitter;
  60
  61         u32 loss;
  62         u32 limit;
  63         u32 counter;
  64         u32 gap;
  65         u32 duplicate;
  66         u32 reorder;
  67         u32 corrupt;
  68
  69         struct crndstate {
  70                 u32 last;
  71                 u32 rho;
  72         } delay_cor, loss_cor, dup_cor, reorder_cor, corrupt_cor;
  73
  74         struct disttable {
  75                 u32  size;
  76                 s16 table[0];
  77         } *delay_dist;
  78 };
  79
  80 /* Time stamp put into socket buffer control block */
  81 struct netem_skb_cb {
  82         psched_time_t   time_to_send;
  83 };
  84
  85 static inline struct netem_skb_cb *netem_skb_cb(struct sk_buff *skb)
  86 {
  87         BUILD_BUG_ON(sizeof(skb->cb) <
  88                 sizeof(struct qdisc_skb_cb) + sizeof(struct netem_skb_cb));
  89         return (struct netem_skb_cb *)qdisc_skb_cb(skb)->data;
  90 }
  91
  92 /* init_crandom - initialize correlated random number generator
  93  * Use entropy source for initial seed.
  94  */
  95 static void init_crandom(struct crndstate *state, unsigned long rho)
  96 {
  97         state->rho = rho;
  98         state->last = net_random();
  99 }
 100
 101 /* get_crandom - correlated random number generator
 102  * Next number depends on last value.
 103  * rho is scaled to avoid floating point.
 104  */
 105 static u32 get_crandom(struct crndstate *state)
 106 {
 107         u64 value, rho;
 108         unsigned long answer;
 109
 110         if (state->rho == 0)    /* no correlation */
 111                 return net_random();
 112
 113         value = net_random();
 114         rho = (u64)state->rho + 1;
 115         answer = (value * ((1ull<<32) - rho) + state->last * rho) >> 32;
 116         state->last = answer;
 117         return answer;
 118 }
 119
 120 /* tabledist - return a pseudo-randomly distributed value with mean mu and
 121  * std deviation sigma.  Uses table lookup to approximate the desired
 122  * distribution, and a uniformly-distributed pseudo-random source.
 123  */
 124 static psched_tdiff_t tabledist(psched_tdiff_t mu, psched_tdiff_t sigma,
 125                                 struct crndstate *state,
 126                                 const struct disttable *dist)
 127 {
 128         psched_tdiff_t x;
 129         long t;
 130         u32 rnd;
 131
 132         if (sigma == 0)
 133                 return mu;
 134
 135         rnd = get_crandom(state);
 136
 137         /* default uniform distribution */
 138         if (dist == NULL)
 139                 return (rnd % (2*sigma)) - sigma + mu;
 140
 141         t = dist->table[rnd % dist->size];
 142         x = (sigma % NETEM_DIST_SCALE) * t;
 143         if (x >= 0)
 144                 x += NETEM_DIST_SCALE/2;
 145         else
 146                 x -= NETEM_DIST_SCALE/2;
 147
 148         return  x / NETEM_DIST_SCALE + (sigma / NETEM_DIST_SCALE) * t + mu;
 149 }
 150
 151 /*
 152  * Insert one skb into qdisc.
 153  * Note: parent depends on return value to account for queue length.
 154  *      NET_XMIT_DROP: queue length didn't change.
 155  *      NET_XMIT_SUCCESS: one skb was queued.
 156  */
 157 static int netem_enqueue(struct sk_buff *skb, struct Qdisc *sch)
 158 {
 159         struct netem_sched_data *q = qdisc_priv(sch);
 160         /* We don't fill cb now as skb_unshare() may invalidate it */
 161         struct netem_skb_cb *cb;
 162         struct sk_buff *skb2;
 163         int ret;
 164         int count = 1;
 165
 166         pr_debug("netem_enqueue skb=%p\n", skb);
 167
 168         /* Random duplication */
 169         if (q->duplicate && q->duplicate >= get_crandom(&q->dup_cor))
 170                 ++count;
 171
 172         /* Random packet drop 0 => none, ~0 => all */
 173         if (q->loss && q->loss >= get_crandom(&q->loss_cor))
 174                 --count;
 175
 176         if (count == 0) {
 177                 sch->qstats.drops++;
 178                 kfree_skb(skb);
 179                 return NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
 180         }
 181
 182         skb_orphan(skb);
 183
 184         /*
 185          * If we need to duplicate packet, then re-insert at top of the
 186          * qdisc tree, since parent queuer expects that only one
 187          * skb will be queued.
 188          */
 189         if (count > 1 && (skb2 = skb_clone(skb, GFP_ATOMIC)) != NULL) {
 190                 struct Qdisc *rootq = qdisc_root(sch);
 191                 u32 dupsave = q->duplicate; /* prevent duplicating a dup... */
 192                 q->duplicate = 0;
 193
 194                 qdisc_enqueue_root(skb2, rootq);
 195                 q->duplicate = dupsave;
 196         }
 197
 198         /*
 199          * Randomized packet corruption.
 200          * Make copy if needed since we are modifying
 201          * If packet is going to be hardware checksummed, then
 202          * do it now in software before we mangle it.
 203          */
 204         if (q->corrupt && q->corrupt >= get_crandom(&q->corrupt_cor)) {
 205                 if (!(skb = skb_unshare(skb, GFP_ATOMIC))
 206                     || (skb->ip_summed == CHECKSUM_PARTIAL
 207                         && skb_checksum_help(skb))) {
 208                         sch->qstats.drops++;
 209                         return NET_XMIT_DROP;
 210                 }
 211
 212                 skb->data[net_random() % skb_headlen(skb)] ^= 1<<(net_random() % 8);
 213         }
 214
 215         cb = netem_skb_cb(skb);
 216         if (q->gap == 0                 /* not doing reordering */
 217             || q->counter < q->gap      /* inside last reordering gap */
 218             || q->reorder < get_crandom(&q->reorder_cor)) {
 219                 psched_time_t now;
 220                 psched_tdiff_t delay;
 221
 222                 delay = tabledist(q->latency, q->jitter,
 223                                   &q->delay_cor, q->delay_dist);
 224
 225                 now = psched_get_time();
 226                 cb->time_to_send = now + delay;
 227                 ++q->counter;
 228                 ret = qdisc_enqueue(skb, q->qdisc);
 229         } else {
 230                 /*
 231                  * Do re-ordering by putting one out of N packets at the front
 232                  * of the queue.
 233                  */
 234                 cb->time_to_send = psched_get_time();
 235                 q->counter = 0;
 236
 237                 __skb_queue_head(&q->qdisc->q, skb);
 238                 q->qdisc->qstats.backlog += qdisc_pkt_len(skb);
 239                 q->qdisc->qstats.requeues++;
 240                 ret = NET_XMIT_SUCCESS;
 241         }
 242
 243         if (likely(ret == NET_XMIT_SUCCESS)) {
 244                 sch->q.qlen++;
 245                 sch->bstats.bytes += qdisc_pkt_len(skb);
 246                 sch->bstats.packets++;
 247         } else if (net_xmit_drop_count(ret)) {
 248                 sch->qstats.drops++;
 249         }
 250
 251         pr_debug("netem: enqueue ret %d\n", ret);
 252         return ret;
 253 }
 254
 255 /* Requeue packets but don't change time stamp */
 256 static int netem_requeue(struct sk_buff *skb, struct Qdisc *sch)
 257 {
 258         struct netem_sched_data *q = qdisc_priv(sch);
 259         int ret;
 260
 261         if ((ret = q->qdisc->ops->requeue(skb, q->qdisc)) == 0) {
 262                 sch->q.qlen++;
 263                 sch->qstats.requeues++;
 264         }
 265
 266         return ret;
 267 }
 268
 269 static unsigned int netem_drop(struct Qdisc* sch)
 270 {
 271         struct netem_sched_data *q = qdisc_priv(sch);
 272         unsigned int len = 0;
 273
 274         if (q->qdisc->ops->drop && (len = q->qdisc->ops->drop(q->qdisc)) != 0) {
 275                 sch->q.qlen--;
 276                 sch->qstats.drops++;
 277         }
 278         return len;
 279 }
 280
 281 static struct sk_buff *netem_dequeue(struct Qdisc *sch)
 282 {
 283         struct netem_sched_data *q = qdisc_priv(sch);
 284         struct sk_buff *skb;
 285
 286         smp_mb();
 287         if (sch->flags & TCQ_F_THROTTLED)
 288                 return NULL;
 289
 290         skb = q->qdisc->ops->peek(q->qdisc);
 291         if (skb) {
 292                 const struct netem_skb_cb *cb = netem_skb_cb(skb);
 293                 psched_time_t now = psched_get_time();
 294
 295                 /* if more time remaining? */
 296                 if (cb->time_to_send <= now) {
 297                         skb = qdisc_dequeue_peeked(q->qdisc);
 298                         if (unlikely(!skb))
 299                                 return NULL;
 300
 301                         pr_debug("netem_dequeue: return skb=%p\n", skb);
 302                         sch->q.qlen--;
 303                         return skb;
 304                 }
 305
 306                 qdisc_watchdog_schedule(&q->watchdog, cb->time_to_send);
 307         }
 308
 309         return NULL;
 310 }
 311
 312 static void netem_reset(struct Qdisc *sch)
 313 {
 314         struct netem_sched_data *q = qdisc_priv(sch);
 315
 316         qdisc_reset(q->qdisc);
 317         sch->q.qlen = 0;
 318         qdisc_watchdog_cancel(&q->watchdog);
 319 }
 320
 321 /*
 322  * Distribution data is a variable size payload containing
 323  * signed 16 bit values.
 324  */
 325 static int get_dist_table(struct Qdisc *sch, const struct nlattr *attr)
 326 {
 327         struct netem_sched_data *q = qdisc_priv(sch);
 328         unsigned long n = nla_len(attr)/sizeof(__s16);
 329         const __s16 *data = nla_data(attr);
 330         spinlock_t *root_lock;
 331         struct disttable *d;
 332         int i;
 333
 334         if (n > 65536)
 335                 return -EINVAL;
 336
 337         d = kmalloc(sizeof(*d) + n*sizeof(d->table[0]), GFP_KERNEL);
 338         if (!d)
 339                 return -ENOMEM;
 340
 341         d->size = n;
 342         for (i = 0; i < n; i++)
 343                 d->table[i] = data[i];
 344
 345         root_lock = qdisc_root_sleeping_lock(sch);
 346
 347         spin_lock_bh(root_lock);
 348         d = xchg(&q->delay_dist, d);
 349         spin_unlock_bh(root_lock);
 350
 351         kfree(d);
 352         return 0;
 353 }
 354
 355 static int get_correlation(struct Qdisc *sch, const struct nlattr *attr)
 356 {
 357         struct netem_sched_data *q = qdisc_priv(sch);
 358         const struct tc_netem_corr *c = nla_data(attr);
 359
 360         init_crandom(&q->delay_cor, c->delay_corr);
 361         init_crandom(&q->loss_cor, c->loss_corr);
 362         init_crandom(&q->dup_cor, c->dup_corr);
 363         return 0;
 364 }
 365
 366 static int get_reorder(struct Qdisc *sch, const struct nlattr *attr)
 367 {
 368         struct netem_sched_data *q = qdisc_priv(sch);
 369         const struct tc_netem_reorder *r = nla_data(attr);
 370
 371         q->reorder = r->probability;
 372         init_crandom(&q->reorder_cor, r->correlation);
 373         return 0;
 374 }
 375
 376 static int get_corrupt(struct Qdisc *sch, const struct nlattr *attr)
 377 {
 378         struct netem_sched_data *q = qdisc_priv(sch);
 379         const struct tc_netem_corrupt *r = nla_data(attr);
 380
 381         q->corrupt = r->probability;
 382         init_crandom(&q->corrupt_cor, r->correlation);
 383         return 0;
 384 }
 385
 386 static const struct nla_policy netem_policy[TCA_NETEM_MAX + 1] = {
 387         [TCA_NETEM_CORR]        = { .len = sizeof(struct tc_netem_corr) },
 388         [TCA_NETEM_REORDER]     = { .len = sizeof(struct tc_netem_reorder) },
 389         [TCA_NETEM_CORRUPT]     = { .len = sizeof(struct tc_netem_corrupt) },
 390 };
 391
 392 static int parse_attr(struct nlattr *tb[], int maxtype, struct nlattr *nla,
 393                       const struct nla_policy *policy, int len)
 394 {
 395         int nested_len = nla_len(nla) - NLA_ALIGN(len);
 396
 397         if (nested_len < 0)
 398                 return -EINVAL;
 399         if (nested_len >= nla_attr_size(0))
 400                 return nla_parse(tb, maxtype, nla_data(nla) + NLA_ALIGN(len),
 401                                  nested_len, policy);
 402         memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
 403         return 0;
 404 }
 405
 406 /* Parse netlink message to set options */
 407 static int netem_change(struct Qdisc *sch, struct nlattr *opt)
 408 {
 409         struct netem_sched_data *q = qdisc_priv(sch);
 410         struct nlattr *tb[TCA_NETEM_MAX + 1];
 411         struct tc_netem_qopt *qopt;
 412         int ret;
 413
 414         if (opt == NULL)
 415                 return -EINVAL;
 416
 417         qopt = nla_data(opt);
 418         ret = parse_attr(tb, TCA_NETEM_MAX, opt, netem_policy, sizeof(*qopt));
 419         if (ret < 0)
 420                 return ret;
 421
 422         ret = fifo_set_limit(q->qdisc, qopt->limit);
 423         if (ret) {
 424                 pr_debug("netem: can't set fifo limit\n");
 425                 return ret;
 426         }
 427
 428         q->latency = qopt->latency;
 429         q->jitter = qopt->jitter;
 430         q->limit = qopt->limit;
 431         q->gap = qopt->gap;
 432         q->counter = 0;
 433         q->loss = qopt->loss;
 434         q->duplicate = qopt->duplicate;
 435
 436         /* for compatibility with earlier versions.
 437          * if gap is set, need to assume 100% probability
 438          */
 439         if (q->gap)
 440                 q->reorder = ~0;
 441
 442         if (tb[TCA_NETEM_CORR]) {
 443                 ret = get_correlation(sch, tb[TCA_NETEM_CORR]);
 444                 if (ret)
 445                         return ret;
 446         }
 447
 448         if (tb[TCA_NETEM_DELAY_DIST]) {
 449                 ret = get_dist_table(sch, tb[TCA_NETEM_DELAY_DIST]);
 450                 if (ret)
 451                         return ret;
 452         }
 453
 454         if (tb[TCA_NETEM_REORDER]) {
 455                 ret = get_reorder(sch, tb[TCA_NETEM_REORDER]);
 456                 if (ret)
 457                         return ret;
 458         }
 459
 460         if (tb[TCA_NETEM_CORRUPT]) {
 461                 ret = get_corrupt(sch, tb[TCA_NETEM_CORRUPT]);
 462                 if (ret)
 463                         return ret;
 464         }
 465
 466         return 0;
 467 }
 468
 469 /*
 470  * Special case version of FIFO queue for use by netem.
 471  * It queues in order based on timestamps in skb's
 472  */
 473 struct fifo_sched_data {
 474         u32 limit;
 475         psched_time_t oldest;
 476 };
 477
 478 static int tfifo_enqueue(struct sk_buff *nskb, struct Qdisc *sch)
 479 {
 480         struct fifo_sched_data *q = qdisc_priv(sch);
 481         struct sk_buff_head *list = &sch->q;
 482         psched_time_t tnext = netem_skb_cb(nskb)->time_to_send;
 483         struct sk_buff *skb;
 484
 485         if (likely(skb_queue_len(list) < q->limit)) {
 486                 /* Optimize for add at tail */
 487                 if (likely(skb_queue_empty(list) || tnext >= q->oldest)) {
 488                         q->oldest = tnext;
 489                         return qdisc_enqueue_tail(nskb, sch);
 490                 }
 491
 492                 skb_queue_reverse_walk(list, skb) {
 493                         const struct netem_skb_cb *cb = netem_skb_cb(skb);
 494
 495                         if (tnext >= cb->time_to_send)
 496                                 break;
 497                 }
 498
 499                 __skb_queue_after(list, skb, nskb);
 500
 501                 sch->qstats.backlog += qdisc_pkt_len(nskb);
 502                 sch->bstats.bytes += qdisc_pkt_len(nskb);
 503                 sch->bstats.packets++;
 504
 505                 return NET_XMIT_SUCCESS;
 506         }
 507
 508         return qdisc_reshape_fail(nskb, sch);
 509 }
 510
 511 static int tfifo_init(struct Qdisc *sch, struct nlattr *opt)
 512 {
 513         struct fifo_sched_data *q = qdisc_priv(sch);
 514
 515         if (opt) {
 516                 struct tc_fifo_qopt *ctl = nla_data(opt);
 517                 if (nla_len(opt) < sizeof(*ctl))
 518                         return -EINVAL;
 519
 520                 q->limit = ctl->limit;
 521         } else
 522                 q->limit = max_t(u32, qdisc_dev(sch)->tx_queue_len, 1);
 523
 524         q->oldest = PSCHED_PASTPERFECT;
 525         return 0;
 526 }
 527
 528 static int tfifo_dump(struct Qdisc *sch, struct sk_buff *skb)
 529 {
 530         struct fifo_sched_data *q = qdisc_priv(sch);
 531         struct tc_fifo_qopt opt = { .limit = q->limit };
 532
 533         NLA_PUT(skb, TCA_OPTIONS, sizeof(opt), &opt);
 534         return skb->len;
 535
 536 nla_put_failure:
 537         return -1;
 538 }
 539
 540 static struct Qdisc_ops tfifo_qdisc_ops __read_mostly = {
 541         .id             =       "tfifo",
 542         .priv_size      =       sizeof(struct fifo_sched_data),
 543         .enqueue        =       tfifo_enqueue,
 544         .dequeue        =       qdisc_dequeue_head,
 545         .peek           =       qdisc_peek_head,
 546         .requeue        =       qdisc_requeue,
 547         .drop           =       qdisc_queue_drop,
 548         .init           =       tfifo_init,
 549         .reset          =       qdisc_reset_queue,
 550         .change         =       tfifo_init,
 551         .dump           =       tfifo_dump,
 552 };
 553
 554 static int netem_init(struct Qdisc *sch, struct nlattr *opt)
 555 {
 556         struct netem_sched_data *q = qdisc_priv(sch);
 557         int ret;
 558
 559         if (!opt)
 560                 return -EINVAL;
 561
 562         qdisc_watchdog_init(&q->watchdog, sch);
 563
 564         q->qdisc = qdisc_create_dflt(qdisc_dev(sch), sch->dev_queue,
 565                                      &tfifo_qdisc_ops,
 566                                      TC_H_MAKE(sch->handle, 1));
 567         if (!q->qdisc) {
 568                 pr_debug("netem: qdisc create failed\n");
 569                 return -ENOMEM;
 570         }
 571
 572         ret = netem_change(sch, opt);
 573         if (ret) {
 574                 pr_debug("netem: change failed\n");
 575                 qdisc_destroy(q->qdisc);
 576         }
 577         return ret;
 578 }
 579
 580 static void netem_destroy(struct Qdisc *sch)
 581 {
 582         struct netem_sched_data *q = qdisc_priv(sch);
 583
 584         qdisc_watchdog_cancel(&q->watchdog);
 585         qdisc_destroy(q->qdisc);
 586         kfree(q->delay_dist);
 587 }
 588
 589 static int netem_dump(struct Qdisc *sch, struct sk_buff *skb)
 590 {
 591         const struct netem_sched_data *q = qdisc_priv(sch);
 592         unsigned char *b = skb_tail_pointer(skb);
 593         struct nlattr *nla = (struct nlattr *) b;
 594         struct tc_netem_qopt qopt;
 595         struct tc_netem_corr cor;
 596         struct tc_netem_reorder reorder;
 597         struct tc_netem_corrupt corrupt;
 598
 599         qopt.latency = q->latency;
 600         qopt.jitter = q->jitter;
 601         qopt.limit = q->limit;
 602         qopt.loss = q->loss;
 603         qopt.gap = q->gap;
 604         qopt.duplicate = q->duplicate;
 605         NLA_PUT(skb, TCA_OPTIONS, sizeof(qopt), &qopt);
 606
 607         cor.delay_corr = q->delay_cor.rho;
 608         cor.loss_corr = q->loss_cor.rho;
 609         cor.dup_corr = q->dup_cor.rho;
 610         NLA_PUT(skb, TCA_NETEM_CORR, sizeof(cor), &cor);
 611
 612         reorder.probability = q->reorder;
 613         reorder.correlation = q->reorder_cor.rho;
 614         NLA_PUT(skb, TCA_NETEM_REORDER, sizeof(reorder), &reorder);
 615
 616         corrupt.probability = q->corrupt;
 617         corrupt.correlation = q->corrupt_cor.rho;
 618         NLA_PUT(skb, TCA_NETEM_CORRUPT, sizeof(corrupt), &corrupt);
 619
 620         nla->nla_len = skb_tail_pointer(skb) - b;
 621
 622         return skb->len;
 623
 624 nla_put_failure:
 625         nlmsg_trim(skb, b);
 626         return -1;
 627 }
 628
 629 static struct Qdisc_ops netem_qdisc_ops __read_mostly = {
 630         .id             =       "netem",
 631         .priv_size      =       sizeof(struct netem_sched_data),
 632         .enqueue        =       netem_enqueue,
 633         .dequeue        =       netem_dequeue,
 634         .peek           =       qdisc_peek_dequeued,
 635         .requeue        =       netem_requeue,
 636         .drop           =       netem_drop,
 637         .init           =       netem_init,
 638         .reset          =       netem_reset,
 639         .destroy        =       netem_destroy,
 640         .change         =       netem_change,
 641         .dump           =       netem_dump,
 642         .owner          =       THIS_MODULE,
 643 };
 644
 645
 646 static int __init netem_module_init(void)
 647 {
 648         pr_info("netem: version " VERSION "\n");
 649         return register_qdisc(&netem_qdisc_ops);
 650 }
 651 static void __exit netem_module_exit(void)
 652 {
 653         unregister_qdisc(&netem_qdisc_ops);
 654 }
 655 module_init(netem_module_init)
 656 module_exit(netem_module_exit)
 657 MODULE_LICENSE("GPL");