arm64: cpufeature: Schedule enable() calls instead of calling them via IPI
[linux-2.6-block.git] / net / sched / sch_netem.c
CommitLineData
1da177e4
LT
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
798b6b19 7 * 2 of the License.
1da177e4
LT
8 *
9 * Many of the algorithms and ideas for this came from
10297b99 10 * NIST Net which is not copyrighted.
1da177e4
LT
11 *
12 * Authors: Stephen Hemminger <shemminger@osdl.org>
13 * Catalin(ux aka Dino) BOIE <catab at umbrella dot ro>
14 */
15
b7f080cf 16#include <linux/mm.h>
1da177e4 17#include <linux/module.h>
5a0e3ad6 18#include <linux/slab.h>
1da177e4
LT
19#include <linux/types.h>
20#include <linux/kernel.h>
21#include <linux/errno.h>
1da177e4 22#include <linux/skbuff.h>
78776d3f 23#include <linux/vmalloc.h>
1da177e4 24#include <linux/rtnetlink.h>
90b41a1c 25#include <linux/reciprocal_div.h>
aec0a40a 26#include <linux/rbtree.h>
1da177e4 27
dc5fc579 28#include <net/netlink.h>
1da177e4 29#include <net/pkt_sched.h>
e4ae004b 30#include <net/inet_ecn.h>
1da177e4 31
250a65f7 32#define VERSION "1.3"
eb229c4c 33
1da177e4
LT
34/* Network Emulation Queuing algorithm.
35 ====================================
36
37 Sources: [1] Mark Carson, Darrin Santay, "NIST Net - A Linux-based
38 Network Emulation Tool
39 [2] Luigi Rizzo, DummyNet for FreeBSD
40
41 ----------------------------------------------------------------
42
43 This started out as a simple way to delay outgoing packets to
44 test TCP but has grown to include most of the functionality
45 of a full blown network emulator like NISTnet. It can delay
46 packets and add random jitter (and correlation). The random
47 distribution can be loaded from a table as well to provide
48 normal, Pareto, or experimental curves. Packet loss,
49 duplication, and reordering can also be emulated.
50
51 This qdisc does not do classification that can be handled in
52 layering other disciplines. It does not need to do bandwidth
53 control either since that can be handled by using token
54 bucket or other rate control.
661b7972 55
56 Correlated Loss Generator models
57
58 Added generation of correlated loss according to the
59 "Gilbert-Elliot" model, a 4-state markov model.
60
61 References:
62 [1] NetemCLG Home http://netgroup.uniroma2.it/NetemCLG
63 [2] S. Salsano, F. Ludovici, A. Ordine, "Definition of a general
64 and intuitive loss model for packet networks and its implementation
65 in the Netem module in the Linux kernel", available in [1]
66
67 Authors: Stefano Salsano <stefano.salsano at uniroma2.it
68 Fabio Ludovici <fabio.ludovici at yahoo.it>
1da177e4
LT
69*/
70
71struct netem_sched_data {
aec0a40a
ED
72 /* internal t(ime)fifo qdisc uses t_root and sch->limit */
73 struct rb_root t_root;
50612537
ED
74
75 /* optional qdisc for classful handling (NULL at netem init) */
1da177e4 76 struct Qdisc *qdisc;
50612537 77
59cb5c67 78 struct qdisc_watchdog watchdog;
1da177e4 79
b407621c
SH
80 psched_tdiff_t latency;
81 psched_tdiff_t jitter;
82
1da177e4 83 u32 loss;
e4ae004b 84 u32 ecn;
1da177e4
LT
85 u32 limit;
86 u32 counter;
87 u32 gap;
1da177e4 88 u32 duplicate;
0dca51d3 89 u32 reorder;
c865e5d9 90 u32 corrupt;
6a031f67 91 u64 rate;
90b41a1c
HPP
92 s32 packet_overhead;
93 u32 cell_size;
809fa972 94 struct reciprocal_value cell_size_reciprocal;
90b41a1c 95 s32 cell_overhead;
1da177e4
LT
96
97 struct crndstate {
b407621c
SH
98 u32 last;
99 u32 rho;
c865e5d9 100 } delay_cor, loss_cor, dup_cor, reorder_cor, corrupt_cor;
1da177e4
LT
101
102 struct disttable {
103 u32 size;
104 s16 table[0];
105 } *delay_dist;
661b7972 106
107 enum {
108 CLG_RANDOM,
109 CLG_4_STATES,
110 CLG_GILB_ELL,
111 } loss_model;
112
a6e2fe17
YY
113 enum {
114 TX_IN_GAP_PERIOD = 1,
115 TX_IN_BURST_PERIOD,
116 LOST_IN_GAP_PERIOD,
117 LOST_IN_BURST_PERIOD,
118 } _4_state_model;
119
c045a734
YY
120 enum {
121 GOOD_STATE = 1,
122 BAD_STATE,
123 } GE_state_model;
124
661b7972 125 /* Correlated Loss Generation models */
126 struct clgstate {
127 /* state of the Markov chain */
128 u8 state;
129
130 /* 4-states and Gilbert-Elliot models */
131 u32 a1; /* p13 for 4-states or p for GE */
132 u32 a2; /* p31 for 4-states or r for GE */
133 u32 a3; /* p32 for 4-states or h for GE */
134 u32 a4; /* p14 for 4-states or 1-k for GE */
135 u32 a5; /* p23 used only in 4-states */
136 } clg;
137
1da177e4
LT
138};
139
50612537
ED
140/* Time stamp put into socket buffer control block
141 * Only valid when skbs are in our internal t(ime)fifo queue.
56b17425
ED
142 *
143 * As skb->rbnode uses same storage than skb->next, skb->prev and skb->tstamp,
144 * and skb->next & skb->prev are scratch space for a qdisc,
145 * we save skb->tstamp value in skb->cb[] before destroying it.
50612537 146 */
1da177e4
LT
147struct netem_skb_cb {
148 psched_time_t time_to_send;
aec0a40a 149 ktime_t tstamp_save;
1da177e4
LT
150};
151
aec0a40a
ED
152
153static struct sk_buff *netem_rb_to_skb(struct rb_node *rb)
154{
56b17425 155 return container_of(rb, struct sk_buff, rbnode);
aec0a40a
ED
156}
157
5f86173b
JK
158static inline struct netem_skb_cb *netem_skb_cb(struct sk_buff *skb)
159{
aec0a40a 160 /* we assume we can use skb next/prev/tstamp as storage for rb_node */
16bda13d 161 qdisc_cb_private_validate(skb, sizeof(struct netem_skb_cb));
175f9c1b 162 return (struct netem_skb_cb *)qdisc_skb_cb(skb)->data;
5f86173b
JK
163}
164
1da177e4
LT
165/* init_crandom - initialize correlated random number generator
166 * Use entropy source for initial seed.
167 */
168static void init_crandom(struct crndstate *state, unsigned long rho)
169{
170 state->rho = rho;
63862b5b 171 state->last = prandom_u32();
1da177e4
LT
172}
173
174/* get_crandom - correlated random number generator
175 * Next number depends on last value.
176 * rho is scaled to avoid floating point.
177 */
b407621c 178static u32 get_crandom(struct crndstate *state)
1da177e4
LT
179{
180 u64 value, rho;
181 unsigned long answer;
182
bb2f8cc0 183 if (state->rho == 0) /* no correlation */
63862b5b 184 return prandom_u32();
1da177e4 185
63862b5b 186 value = prandom_u32();
1da177e4
LT
187 rho = (u64)state->rho + 1;
188 answer = (value * ((1ull<<32) - rho) + state->last * rho) >> 32;
189 state->last = answer;
190 return answer;
191}
192
661b7972 193/* loss_4state - 4-state model loss generator
194 * Generates losses according to the 4-state Markov chain adopted in
195 * the GI (General and Intuitive) loss model.
196 */
197static bool loss_4state(struct netem_sched_data *q)
198{
199 struct clgstate *clg = &q->clg;
63862b5b 200 u32 rnd = prandom_u32();
661b7972 201
202 /*
25985edc 203 * Makes a comparison between rnd and the transition
661b7972 204 * probabilities outgoing from the current state, then decides the
205 * next state and if the next packet has to be transmitted or lost.
206 * The four states correspond to:
a6e2fe17
YY
207 * TX_IN_GAP_PERIOD => successfully transmitted packets within a gap period
208 * LOST_IN_BURST_PERIOD => isolated losses within a gap period
209 * LOST_IN_GAP_PERIOD => lost packets within a burst period
210 * TX_IN_GAP_PERIOD => successfully transmitted packets within a burst period
661b7972 211 */
212 switch (clg->state) {
a6e2fe17 213 case TX_IN_GAP_PERIOD:
661b7972 214 if (rnd < clg->a4) {
a6e2fe17 215 clg->state = LOST_IN_BURST_PERIOD;
661b7972 216 return true;
ab6c27be 217 } else if (clg->a4 < rnd && rnd < clg->a1 + clg->a4) {
a6e2fe17 218 clg->state = LOST_IN_GAP_PERIOD;
661b7972 219 return true;
a6e2fe17
YY
220 } else if (clg->a1 + clg->a4 < rnd) {
221 clg->state = TX_IN_GAP_PERIOD;
222 }
661b7972 223
224 break;
a6e2fe17 225 case TX_IN_BURST_PERIOD:
661b7972 226 if (rnd < clg->a5) {
a6e2fe17 227 clg->state = LOST_IN_GAP_PERIOD;
661b7972 228 return true;
a6e2fe17
YY
229 } else {
230 clg->state = TX_IN_BURST_PERIOD;
231 }
661b7972 232
233 break;
a6e2fe17 234 case LOST_IN_GAP_PERIOD:
661b7972 235 if (rnd < clg->a3)
a6e2fe17 236 clg->state = TX_IN_BURST_PERIOD;
661b7972 237 else if (clg->a3 < rnd && rnd < clg->a2 + clg->a3) {
a6e2fe17 238 clg->state = TX_IN_GAP_PERIOD;
661b7972 239 } else if (clg->a2 + clg->a3 < rnd) {
a6e2fe17 240 clg->state = LOST_IN_GAP_PERIOD;
661b7972 241 return true;
242 }
243 break;
a6e2fe17
YY
244 case LOST_IN_BURST_PERIOD:
245 clg->state = TX_IN_GAP_PERIOD;
661b7972 246 break;
247 }
248
249 return false;
250}
251
252/* loss_gilb_ell - Gilbert-Elliot model loss generator
253 * Generates losses according to the Gilbert-Elliot loss model or
254 * its special cases (Gilbert or Simple Gilbert)
255 *
25985edc 256 * Makes a comparison between random number and the transition
661b7972 257 * probabilities outgoing from the current state, then decides the
25985edc 258 * next state. A second random number is extracted and the comparison
661b7972 259 * with the loss probability of the current state decides if the next
260 * packet will be transmitted or lost.
261 */
262static bool loss_gilb_ell(struct netem_sched_data *q)
263{
264 struct clgstate *clg = &q->clg;
265
266 switch (clg->state) {
c045a734 267 case GOOD_STATE:
63862b5b 268 if (prandom_u32() < clg->a1)
c045a734 269 clg->state = BAD_STATE;
63862b5b 270 if (prandom_u32() < clg->a4)
661b7972 271 return true;
7c2781fa 272 break;
c045a734 273 case BAD_STATE:
63862b5b 274 if (prandom_u32() < clg->a2)
c045a734 275 clg->state = GOOD_STATE;
63862b5b 276 if (prandom_u32() > clg->a3)
661b7972 277 return true;
278 }
279
280 return false;
281}
282
283static bool loss_event(struct netem_sched_data *q)
284{
285 switch (q->loss_model) {
286 case CLG_RANDOM:
287 /* Random packet drop 0 => none, ~0 => all */
288 return q->loss && q->loss >= get_crandom(&q->loss_cor);
289
290 case CLG_4_STATES:
291 /* 4state loss model algorithm (used also for GI model)
292 * Extracts a value from the markov 4 state loss generator,
293 * if it is 1 drops a packet and if needed writes the event in
294 * the kernel logs
295 */
296 return loss_4state(q);
297
298 case CLG_GILB_ELL:
299 /* Gilbert-Elliot loss model algorithm
300 * Extracts a value from the Gilbert-Elliot loss generator,
301 * if it is 1 drops a packet and if needed writes the event in
302 * the kernel logs
303 */
304 return loss_gilb_ell(q);
305 }
306
307 return false; /* not reached */
308}
309
310
1da177e4
LT
311/* tabledist - return a pseudo-randomly distributed value with mean mu and
312 * std deviation sigma. Uses table lookup to approximate the desired
313 * distribution, and a uniformly-distributed pseudo-random source.
314 */
b407621c
SH
315static psched_tdiff_t tabledist(psched_tdiff_t mu, psched_tdiff_t sigma,
316 struct crndstate *state,
317 const struct disttable *dist)
1da177e4 318{
b407621c
SH
319 psched_tdiff_t x;
320 long t;
321 u32 rnd;
1da177e4
LT
322
323 if (sigma == 0)
324 return mu;
325
326 rnd = get_crandom(state);
327
328 /* default uniform distribution */
10297b99 329 if (dist == NULL)
1da177e4
LT
330 return (rnd % (2*sigma)) - sigma + mu;
331
332 t = dist->table[rnd % dist->size];
333 x = (sigma % NETEM_DIST_SCALE) * t;
334 if (x >= 0)
335 x += NETEM_DIST_SCALE/2;
336 else
337 x -= NETEM_DIST_SCALE/2;
338
339 return x / NETEM_DIST_SCALE + (sigma / NETEM_DIST_SCALE) * t + mu;
340}
341
90b41a1c 342static psched_time_t packet_len_2_sched_time(unsigned int len, struct netem_sched_data *q)
7bc0f28c 343{
90b41a1c 344 u64 ticks;
fc33cc72 345
90b41a1c
HPP
346 len += q->packet_overhead;
347
348 if (q->cell_size) {
349 u32 cells = reciprocal_divide(len, q->cell_size_reciprocal);
350
351 if (len > cells * q->cell_size) /* extra cell needed for remainder */
352 cells++;
353 len = cells * (q->cell_size + q->cell_overhead);
354 }
355
356 ticks = (u64)len * NSEC_PER_SEC;
357
358 do_div(ticks, q->rate);
fc33cc72 359 return PSCHED_NS2TICKS(ticks);
7bc0f28c
HPP
360}
361
ff704050 362static void tfifo_reset(struct Qdisc *sch)
363{
364 struct netem_sched_data *q = qdisc_priv(sch);
365 struct rb_node *p;
366
367 while ((p = rb_first(&q->t_root))) {
368 struct sk_buff *skb = netem_rb_to_skb(p);
369
370 rb_erase(p, &q->t_root);
2f08a9a1 371 rtnl_kfree_skbs(skb, skb);
ff704050 372 }
373}
374
960fb66e 375static void tfifo_enqueue(struct sk_buff *nskb, struct Qdisc *sch)
50612537 376{
aec0a40a 377 struct netem_sched_data *q = qdisc_priv(sch);
50612537 378 psched_time_t tnext = netem_skb_cb(nskb)->time_to_send;
aec0a40a 379 struct rb_node **p = &q->t_root.rb_node, *parent = NULL;
50612537 380
aec0a40a
ED
381 while (*p) {
382 struct sk_buff *skb;
50612537 383
aec0a40a
ED
384 parent = *p;
385 skb = netem_rb_to_skb(parent);
960fb66e 386 if (tnext >= netem_skb_cb(skb)->time_to_send)
aec0a40a
ED
387 p = &parent->rb_right;
388 else
389 p = &parent->rb_left;
50612537 390 }
56b17425
ED
391 rb_link_node(&nskb->rbnode, parent, p);
392 rb_insert_color(&nskb->rbnode, &q->t_root);
aec0a40a 393 sch->q.qlen++;
50612537
ED
394}
395
6071bd1a
NH
396/* netem can't properly corrupt a megapacket (like we get from GSO), so instead
397 * when we statistically choose to corrupt one, we instead segment it, returning
398 * the first packet to be corrupted, and re-enqueue the remaining frames
399 */
520ac30f
ED
400static struct sk_buff *netem_segment(struct sk_buff *skb, struct Qdisc *sch,
401 struct sk_buff **to_free)
6071bd1a
NH
402{
403 struct sk_buff *segs;
404 netdev_features_t features = netif_skb_features(skb);
405
406 segs = skb_gso_segment(skb, features & ~NETIF_F_GSO_MASK);
407
408 if (IS_ERR_OR_NULL(segs)) {
520ac30f 409 qdisc_drop(skb, sch, to_free);
6071bd1a
NH
410 return NULL;
411 }
412 consume_skb(skb);
413 return segs;
414}
415
48da34b7
FW
416static void netem_enqueue_skb_head(struct qdisc_skb_head *qh, struct sk_buff *skb)
417{
418 skb->next = qh->head;
419
420 if (!qh->head)
421 qh->tail = skb;
422 qh->head = skb;
423 qh->qlen++;
424}
425
0afb51e7
SH
426/*
427 * Insert one skb into qdisc.
428 * Note: parent depends on return value to account for queue length.
429 * NET_XMIT_DROP: queue length didn't change.
430 * NET_XMIT_SUCCESS: one skb was queued.
431 */
520ac30f
ED
432static int netem_enqueue(struct sk_buff *skb, struct Qdisc *sch,
433 struct sk_buff **to_free)
1da177e4
LT
434{
435 struct netem_sched_data *q = qdisc_priv(sch);
89e1df74
GC
436 /* We don't fill cb now as skb_unshare() may invalidate it */
437 struct netem_skb_cb *cb;
0afb51e7 438 struct sk_buff *skb2;
6071bd1a
NH
439 struct sk_buff *segs = NULL;
440 unsigned int len = 0, last_len, prev_len = qdisc_pkt_len(skb);
441 int nb = 0;
0afb51e7 442 int count = 1;
6071bd1a 443 int rc = NET_XMIT_SUCCESS;
1da177e4 444
0afb51e7
SH
445 /* Random duplication */
446 if (q->duplicate && q->duplicate >= get_crandom(&q->dup_cor))
447 ++count;
448
661b7972 449 /* Drop packet? */
e4ae004b
ED
450 if (loss_event(q)) {
451 if (q->ecn && INET_ECN_set_ce(skb))
25331d6c 452 qdisc_qstats_drop(sch); /* mark packet */
e4ae004b
ED
453 else
454 --count;
455 }
0afb51e7 456 if (count == 0) {
25331d6c 457 qdisc_qstats_drop(sch);
520ac30f 458 __qdisc_drop(skb, to_free);
c27f339a 459 return NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
1da177e4
LT
460 }
461
5a308f40
ED
462 /* If a delay is expected, orphan the skb. (orphaning usually takes
463 * place at TX completion time, so _before_ the link transit delay)
5a308f40
ED
464 */
465 if (q->latency || q->jitter)
f2f872f9 466 skb_orphan_partial(skb);
4e8a5201 467
0afb51e7
SH
468 /*
469 * If we need to duplicate packet, then re-insert at top of the
470 * qdisc tree, since parent queuer expects that only one
471 * skb will be queued.
472 */
473 if (count > 1 && (skb2 = skb_clone(skb, GFP_ATOMIC)) != NULL) {
7698b4fc 474 struct Qdisc *rootq = qdisc_root(sch);
0afb51e7 475 u32 dupsave = q->duplicate; /* prevent duplicating a dup... */
0afb51e7 476
b396cca6 477 q->duplicate = 0;
520ac30f 478 rootq->enqueue(skb2, rootq, to_free);
0afb51e7 479 q->duplicate = dupsave;
1da177e4
LT
480 }
481
c865e5d9
SH
482 /*
483 * Randomized packet corruption.
484 * Make copy if needed since we are modifying
485 * If packet is going to be hardware checksummed, then
486 * do it now in software before we mangle it.
487 */
488 if (q->corrupt && q->corrupt >= get_crandom(&q->corrupt_cor)) {
6071bd1a 489 if (skb_is_gso(skb)) {
520ac30f 490 segs = netem_segment(skb, sch, to_free);
6071bd1a
NH
491 if (!segs)
492 return NET_XMIT_DROP;
493 } else {
494 segs = skb;
495 }
496
497 skb = segs;
498 segs = segs->next;
499
8a6e9c67
ED
500 skb = skb_unshare(skb, GFP_ATOMIC);
501 if (unlikely(!skb)) {
502 qdisc_qstats_drop(sch);
503 goto finish_segs;
504 }
505 if (skb->ip_summed == CHECKSUM_PARTIAL &&
506 skb_checksum_help(skb)) {
507 qdisc_drop(skb, sch, to_free);
6071bd1a
NH
508 goto finish_segs;
509 }
c865e5d9 510
63862b5b
AH
511 skb->data[prandom_u32() % skb_headlen(skb)] ^=
512 1<<(prandom_u32() % 8);
c865e5d9
SH
513 }
514
97d0678f 515 if (unlikely(sch->q.qlen >= sch->limit))
520ac30f 516 return qdisc_drop(skb, sch, to_free);
960fb66e 517
25331d6c 518 qdisc_qstats_backlog_inc(sch, skb);
960fb66e 519
5f86173b 520 cb = netem_skb_cb(skb);
cc7ec456 521 if (q->gap == 0 || /* not doing reordering */
a42b4799 522 q->counter < q->gap - 1 || /* inside last reordering gap */
f64f9e71 523 q->reorder < get_crandom(&q->reorder_cor)) {
0f9f32ac 524 psched_time_t now;
07aaa115
SH
525 psched_tdiff_t delay;
526
527 delay = tabledist(q->latency, q->jitter,
528 &q->delay_cor, q->delay_dist);
529
3bebcda2 530 now = psched_get_time();
7bc0f28c
HPP
531
532 if (q->rate) {
aec0a40a 533 struct sk_buff *last;
7bc0f28c 534
97d0678f 535 if (sch->q.qlen)
48da34b7 536 last = sch->q.tail;
aec0a40a
ED
537 else
538 last = netem_rb_to_skb(rb_last(&q->t_root));
539 if (last) {
7bc0f28c 540 /*
a13d3104
JN
541 * Last packet in queue is reference point (now),
542 * calculate this time bonus and subtract
7bc0f28c
HPP
543 * from delay.
544 */
aec0a40a 545 delay -= netem_skb_cb(last)->time_to_send - now;
a13d3104 546 delay = max_t(psched_tdiff_t, 0, delay);
aec0a40a 547 now = netem_skb_cb(last)->time_to_send;
7bc0f28c 548 }
a13d3104 549
8cfd88d6 550 delay += packet_len_2_sched_time(qdisc_pkt_len(skb), q);
7bc0f28c
HPP
551 }
552
7c59e25f 553 cb->time_to_send = now + delay;
aec0a40a 554 cb->tstamp_save = skb->tstamp;
1da177e4 555 ++q->counter;
960fb66e 556 tfifo_enqueue(skb, sch);
1da177e4 557 } else {
10297b99 558 /*
0dca51d3
SH
559 * Do re-ordering by putting one out of N packets at the front
560 * of the queue.
561 */
3bebcda2 562 cb->time_to_send = psched_get_time();
0dca51d3 563 q->counter = 0;
8ba25dad 564
48da34b7 565 netem_enqueue_skb_head(&sch->q, skb);
eb101924 566 sch->qstats.requeues++;
378a2f09 567 }
1da177e4 568
6071bd1a
NH
569finish_segs:
570 if (segs) {
571 while (segs) {
572 skb2 = segs->next;
573 segs->next = NULL;
574 qdisc_skb_cb(segs)->pkt_len = segs->len;
575 last_len = segs->len;
520ac30f 576 rc = qdisc_enqueue(segs, sch, to_free);
6071bd1a
NH
577 if (rc != NET_XMIT_SUCCESS) {
578 if (net_xmit_drop_count(rc))
579 qdisc_qstats_drop(sch);
580 } else {
581 nb++;
582 len += last_len;
583 }
584 segs = skb2;
585 }
586 sch->q.qlen += nb;
587 if (nb > 1)
588 qdisc_tree_reduce_backlog(sch, 1 - nb, prev_len - len);
589 }
10f6dfcf 590 return NET_XMIT_SUCCESS;
1da177e4
LT
591}
592
1da177e4
LT
593static struct sk_buff *netem_dequeue(struct Qdisc *sch)
594{
595 struct netem_sched_data *q = qdisc_priv(sch);
596 struct sk_buff *skb;
aec0a40a 597 struct rb_node *p;
1da177e4 598
50612537 599tfifo_dequeue:
ed760cb8 600 skb = __qdisc_dequeue_head(&sch->q);
771018e7 601 if (skb) {
25331d6c 602 qdisc_qstats_backlog_dec(sch, skb);
0ad2a836 603deliver:
aec0a40a
ED
604 qdisc_bstats_update(sch, skb);
605 return skb;
606 }
607 p = rb_first(&q->t_root);
608 if (p) {
36b7bfe0
ED
609 psched_time_t time_to_send;
610
aec0a40a 611 skb = netem_rb_to_skb(p);
0f9f32ac
SH
612
613 /* if more time remaining? */
36b7bfe0
ED
614 time_to_send = netem_skb_cb(skb)->time_to_send;
615 if (time_to_send <= psched_get_time()) {
aec0a40a
ED
616 rb_erase(p, &q->t_root);
617
618 sch->q.qlen--;
0ad2a836 619 qdisc_qstats_backlog_dec(sch, skb);
aec0a40a
ED
620 skb->next = NULL;
621 skb->prev = NULL;
622 skb->tstamp = netem_skb_cb(skb)->tstamp_save;
03c05f0d 623
8caf1539
JP
624#ifdef CONFIG_NET_CLS_ACT
625 /*
626 * If it's at ingress let's pretend the delay is
627 * from the network (tstamp will be updated).
628 */
629 if (G_TC_FROM(skb->tc_verd) & AT_INGRESS)
630 skb->tstamp.tv64 = 0;
631#endif
10f6dfcf 632
50612537 633 if (q->qdisc) {
21de12ee 634 unsigned int pkt_len = qdisc_pkt_len(skb);
520ac30f
ED
635 struct sk_buff *to_free = NULL;
636 int err;
50612537 637
520ac30f
ED
638 err = qdisc_enqueue(skb, q->qdisc, &to_free);
639 kfree_skb_list(to_free);
21de12ee
ED
640 if (err != NET_XMIT_SUCCESS &&
641 net_xmit_drop_count(err)) {
642 qdisc_qstats_drop(sch);
643 qdisc_tree_reduce_backlog(sch, 1,
644 pkt_len);
50612537
ED
645 }
646 goto tfifo_dequeue;
647 }
aec0a40a 648 goto deliver;
07aaa115 649 }
11274e5a 650
50612537
ED
651 if (q->qdisc) {
652 skb = q->qdisc->ops->dequeue(q->qdisc);
653 if (skb)
654 goto deliver;
655 }
36b7bfe0 656 qdisc_watchdog_schedule(&q->watchdog, time_to_send);
0f9f32ac
SH
657 }
658
50612537
ED
659 if (q->qdisc) {
660 skb = q->qdisc->ops->dequeue(q->qdisc);
661 if (skb)
662 goto deliver;
663 }
0f9f32ac 664 return NULL;
1da177e4
LT
665}
666
1da177e4
LT
667static void netem_reset(struct Qdisc *sch)
668{
669 struct netem_sched_data *q = qdisc_priv(sch);
670
50612537 671 qdisc_reset_queue(sch);
ff704050 672 tfifo_reset(sch);
50612537
ED
673 if (q->qdisc)
674 qdisc_reset(q->qdisc);
59cb5c67 675 qdisc_watchdog_cancel(&q->watchdog);
1da177e4
LT
676}
677
6373a9a2 678static void dist_free(struct disttable *d)
679{
4cb28970 680 kvfree(d);
6373a9a2 681}
682
1da177e4
LT
683/*
684 * Distribution data is a variable size payload containing
685 * signed 16 bit values.
686 */
1e90474c 687static int get_dist_table(struct Qdisc *sch, const struct nlattr *attr)
1da177e4
LT
688{
689 struct netem_sched_data *q = qdisc_priv(sch);
6373a9a2 690 size_t n = nla_len(attr)/sizeof(__s16);
1e90474c 691 const __s16 *data = nla_data(attr);
7698b4fc 692 spinlock_t *root_lock;
1da177e4
LT
693 struct disttable *d;
694 int i;
6373a9a2 695 size_t s;
1da177e4 696
df173bda 697 if (n > NETEM_DIST_MAX)
1da177e4
LT
698 return -EINVAL;
699
6373a9a2 700 s = sizeof(struct disttable) + n * sizeof(s16);
bb52c7ac 701 d = kmalloc(s, GFP_KERNEL | __GFP_NOWARN);
6373a9a2 702 if (!d)
703 d = vmalloc(s);
1da177e4
LT
704 if (!d)
705 return -ENOMEM;
706
707 d->size = n;
708 for (i = 0; i < n; i++)
709 d->table[i] = data[i];
10297b99 710
102396ae 711 root_lock = qdisc_root_sleeping_lock(sch);
7698b4fc
DM
712
713 spin_lock_bh(root_lock);
bb52c7ac 714 swap(q->delay_dist, d);
7698b4fc 715 spin_unlock_bh(root_lock);
bb52c7ac
ED
716
717 dist_free(d);
1da177e4
LT
718 return 0;
719}
720
49545a77 721static void get_correlation(struct netem_sched_data *q, const struct nlattr *attr)
1da177e4 722{
1e90474c 723 const struct tc_netem_corr *c = nla_data(attr);
1da177e4 724
1da177e4
LT
725 init_crandom(&q->delay_cor, c->delay_corr);
726 init_crandom(&q->loss_cor, c->loss_corr);
727 init_crandom(&q->dup_cor, c->dup_corr);
1da177e4
LT
728}
729
49545a77 730static void get_reorder(struct netem_sched_data *q, const struct nlattr *attr)
0dca51d3 731{
1e90474c 732 const struct tc_netem_reorder *r = nla_data(attr);
0dca51d3 733
0dca51d3
SH
734 q->reorder = r->probability;
735 init_crandom(&q->reorder_cor, r->correlation);
0dca51d3
SH
736}
737
49545a77 738static void get_corrupt(struct netem_sched_data *q, const struct nlattr *attr)
c865e5d9 739{
1e90474c 740 const struct tc_netem_corrupt *r = nla_data(attr);
c865e5d9 741
c865e5d9
SH
742 q->corrupt = r->probability;
743 init_crandom(&q->corrupt_cor, r->correlation);
c865e5d9
SH
744}
745
49545a77 746static void get_rate(struct netem_sched_data *q, const struct nlattr *attr)
7bc0f28c 747{
7bc0f28c
HPP
748 const struct tc_netem_rate *r = nla_data(attr);
749
750 q->rate = r->rate;
90b41a1c
HPP
751 q->packet_overhead = r->packet_overhead;
752 q->cell_size = r->cell_size;
809fa972 753 q->cell_overhead = r->cell_overhead;
90b41a1c
HPP
754 if (q->cell_size)
755 q->cell_size_reciprocal = reciprocal_value(q->cell_size);
809fa972
HFS
756 else
757 q->cell_size_reciprocal = (struct reciprocal_value) { 0 };
7bc0f28c
HPP
758}
759
49545a77 760static int get_loss_clg(struct netem_sched_data *q, const struct nlattr *attr)
661b7972 761{
661b7972 762 const struct nlattr *la;
763 int rem;
764
765 nla_for_each_nested(la, attr, rem) {
766 u16 type = nla_type(la);
767
833fa743 768 switch (type) {
661b7972 769 case NETEM_LOSS_GI: {
770 const struct tc_netem_gimodel *gi = nla_data(la);
771
2494654d 772 if (nla_len(la) < sizeof(struct tc_netem_gimodel)) {
661b7972 773 pr_info("netem: incorrect gi model size\n");
774 return -EINVAL;
775 }
776
777 q->loss_model = CLG_4_STATES;
778
3fbac2a8 779 q->clg.state = TX_IN_GAP_PERIOD;
661b7972 780 q->clg.a1 = gi->p13;
781 q->clg.a2 = gi->p31;
782 q->clg.a3 = gi->p32;
783 q->clg.a4 = gi->p14;
784 q->clg.a5 = gi->p23;
785 break;
786 }
787
788 case NETEM_LOSS_GE: {
789 const struct tc_netem_gemodel *ge = nla_data(la);
790
2494654d 791 if (nla_len(la) < sizeof(struct tc_netem_gemodel)) {
792 pr_info("netem: incorrect ge model size\n");
661b7972 793 return -EINVAL;
794 }
795
796 q->loss_model = CLG_GILB_ELL;
3fbac2a8 797 q->clg.state = GOOD_STATE;
661b7972 798 q->clg.a1 = ge->p;
799 q->clg.a2 = ge->r;
800 q->clg.a3 = ge->h;
801 q->clg.a4 = ge->k1;
802 break;
803 }
804
805 default:
806 pr_info("netem: unknown loss type %u\n", type);
807 return -EINVAL;
808 }
809 }
810
811 return 0;
812}
813
27a3421e
PM
814static const struct nla_policy netem_policy[TCA_NETEM_MAX + 1] = {
815 [TCA_NETEM_CORR] = { .len = sizeof(struct tc_netem_corr) },
816 [TCA_NETEM_REORDER] = { .len = sizeof(struct tc_netem_reorder) },
817 [TCA_NETEM_CORRUPT] = { .len = sizeof(struct tc_netem_corrupt) },
7bc0f28c 818 [TCA_NETEM_RATE] = { .len = sizeof(struct tc_netem_rate) },
661b7972 819 [TCA_NETEM_LOSS] = { .type = NLA_NESTED },
e4ae004b 820 [TCA_NETEM_ECN] = { .type = NLA_U32 },
6a031f67 821 [TCA_NETEM_RATE64] = { .type = NLA_U64 },
27a3421e
PM
822};
823
2c10b32b
TG
824static int parse_attr(struct nlattr *tb[], int maxtype, struct nlattr *nla,
825 const struct nla_policy *policy, int len)
826{
827 int nested_len = nla_len(nla) - NLA_ALIGN(len);
828
661b7972 829 if (nested_len < 0) {
830 pr_info("netem: invalid attributes len %d\n", nested_len);
2c10b32b 831 return -EINVAL;
661b7972 832 }
833
2c10b32b
TG
834 if (nested_len >= nla_attr_size(0))
835 return nla_parse(tb, maxtype, nla_data(nla) + NLA_ALIGN(len),
836 nested_len, policy);
661b7972 837
2c10b32b
TG
838 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
839 return 0;
840}
841
c865e5d9 842/* Parse netlink message to set options */
1e90474c 843static int netem_change(struct Qdisc *sch, struct nlattr *opt)
1da177e4
LT
844{
845 struct netem_sched_data *q = qdisc_priv(sch);
b03f4672 846 struct nlattr *tb[TCA_NETEM_MAX + 1];
1da177e4 847 struct tc_netem_qopt *qopt;
54a4b05c
YY
848 struct clgstate old_clg;
849 int old_loss_model = CLG_RANDOM;
1da177e4 850 int ret;
10297b99 851
b03f4672 852 if (opt == NULL)
1da177e4
LT
853 return -EINVAL;
854
2c10b32b
TG
855 qopt = nla_data(opt);
856 ret = parse_attr(tb, TCA_NETEM_MAX, opt, netem_policy, sizeof(*qopt));
b03f4672
PM
857 if (ret < 0)
858 return ret;
859
54a4b05c
YY
860 /* backup q->clg and q->loss_model */
861 old_clg = q->clg;
862 old_loss_model = q->loss_model;
863
864 if (tb[TCA_NETEM_LOSS]) {
49545a77 865 ret = get_loss_clg(q, tb[TCA_NETEM_LOSS]);
54a4b05c
YY
866 if (ret) {
867 q->loss_model = old_loss_model;
868 return ret;
869 }
870 } else {
871 q->loss_model = CLG_RANDOM;
872 }
873
874 if (tb[TCA_NETEM_DELAY_DIST]) {
875 ret = get_dist_table(sch, tb[TCA_NETEM_DELAY_DIST]);
876 if (ret) {
877 /* recover clg and loss_model, in case of
878 * q->clg and q->loss_model were modified
879 * in get_loss_clg()
880 */
881 q->clg = old_clg;
882 q->loss_model = old_loss_model;
883 return ret;
884 }
885 }
886
50612537 887 sch->limit = qopt->limit;
10297b99 888
1da177e4
LT
889 q->latency = qopt->latency;
890 q->jitter = qopt->jitter;
891 q->limit = qopt->limit;
892 q->gap = qopt->gap;
0dca51d3 893 q->counter = 0;
1da177e4
LT
894 q->loss = qopt->loss;
895 q->duplicate = qopt->duplicate;
896
bb2f8cc0
SH
897 /* for compatibility with earlier versions.
898 * if gap is set, need to assume 100% probability
0dca51d3 899 */
a362e0a7
SH
900 if (q->gap)
901 q->reorder = ~0;
0dca51d3 902
265eb67f 903 if (tb[TCA_NETEM_CORR])
49545a77 904 get_correlation(q, tb[TCA_NETEM_CORR]);
1da177e4 905
265eb67f 906 if (tb[TCA_NETEM_REORDER])
49545a77 907 get_reorder(q, tb[TCA_NETEM_REORDER]);
1da177e4 908
265eb67f 909 if (tb[TCA_NETEM_CORRUPT])
49545a77 910 get_corrupt(q, tb[TCA_NETEM_CORRUPT]);
1da177e4 911
7bc0f28c 912 if (tb[TCA_NETEM_RATE])
49545a77 913 get_rate(q, tb[TCA_NETEM_RATE]);
7bc0f28c 914
6a031f67
YY
915 if (tb[TCA_NETEM_RATE64])
916 q->rate = max_t(u64, q->rate,
917 nla_get_u64(tb[TCA_NETEM_RATE64]));
918
e4ae004b
ED
919 if (tb[TCA_NETEM_ECN])
920 q->ecn = nla_get_u32(tb[TCA_NETEM_ECN]);
921
661b7972 922 return ret;
1da177e4
LT
923}
924
1e90474c 925static int netem_init(struct Qdisc *sch, struct nlattr *opt)
1da177e4
LT
926{
927 struct netem_sched_data *q = qdisc_priv(sch);
928 int ret;
929
930 if (!opt)
931 return -EINVAL;
932
59cb5c67 933 qdisc_watchdog_init(&q->watchdog, sch);
1da177e4 934
661b7972 935 q->loss_model = CLG_RANDOM;
1da177e4 936 ret = netem_change(sch, opt);
50612537 937 if (ret)
250a65f7 938 pr_info("netem: change failed\n");
1da177e4
LT
939 return ret;
940}
941
942static void netem_destroy(struct Qdisc *sch)
943{
944 struct netem_sched_data *q = qdisc_priv(sch);
945
59cb5c67 946 qdisc_watchdog_cancel(&q->watchdog);
50612537
ED
947 if (q->qdisc)
948 qdisc_destroy(q->qdisc);
6373a9a2 949 dist_free(q->delay_dist);
1da177e4
LT
950}
951
661b7972 952static int dump_loss_model(const struct netem_sched_data *q,
953 struct sk_buff *skb)
954{
955 struct nlattr *nest;
956
957 nest = nla_nest_start(skb, TCA_NETEM_LOSS);
958 if (nest == NULL)
959 goto nla_put_failure;
960
961 switch (q->loss_model) {
962 case CLG_RANDOM:
963 /* legacy loss model */
964 nla_nest_cancel(skb, nest);
965 return 0; /* no data */
966
967 case CLG_4_STATES: {
968 struct tc_netem_gimodel gi = {
969 .p13 = q->clg.a1,
970 .p31 = q->clg.a2,
971 .p32 = q->clg.a3,
972 .p14 = q->clg.a4,
973 .p23 = q->clg.a5,
974 };
975
1b34ec43
DM
976 if (nla_put(skb, NETEM_LOSS_GI, sizeof(gi), &gi))
977 goto nla_put_failure;
661b7972 978 break;
979 }
980 case CLG_GILB_ELL: {
981 struct tc_netem_gemodel ge = {
982 .p = q->clg.a1,
983 .r = q->clg.a2,
984 .h = q->clg.a3,
985 .k1 = q->clg.a4,
986 };
987
1b34ec43
DM
988 if (nla_put(skb, NETEM_LOSS_GE, sizeof(ge), &ge))
989 goto nla_put_failure;
661b7972 990 break;
991 }
992 }
993
994 nla_nest_end(skb, nest);
995 return 0;
996
997nla_put_failure:
998 nla_nest_cancel(skb, nest);
999 return -1;
1000}
1001
1da177e4
LT
1002static int netem_dump(struct Qdisc *sch, struct sk_buff *skb)
1003{
1004 const struct netem_sched_data *q = qdisc_priv(sch);
861d7f74 1005 struct nlattr *nla = (struct nlattr *) skb_tail_pointer(skb);
1da177e4
LT
1006 struct tc_netem_qopt qopt;
1007 struct tc_netem_corr cor;
0dca51d3 1008 struct tc_netem_reorder reorder;
c865e5d9 1009 struct tc_netem_corrupt corrupt;
7bc0f28c 1010 struct tc_netem_rate rate;
1da177e4
LT
1011
1012 qopt.latency = q->latency;
1013 qopt.jitter = q->jitter;
1014 qopt.limit = q->limit;
1015 qopt.loss = q->loss;
1016 qopt.gap = q->gap;
1017 qopt.duplicate = q->duplicate;
1b34ec43
DM
1018 if (nla_put(skb, TCA_OPTIONS, sizeof(qopt), &qopt))
1019 goto nla_put_failure;
1da177e4
LT
1020
1021 cor.delay_corr = q->delay_cor.rho;
1022 cor.loss_corr = q->loss_cor.rho;
1023 cor.dup_corr = q->dup_cor.rho;
1b34ec43
DM
1024 if (nla_put(skb, TCA_NETEM_CORR, sizeof(cor), &cor))
1025 goto nla_put_failure;
0dca51d3
SH
1026
1027 reorder.probability = q->reorder;
1028 reorder.correlation = q->reorder_cor.rho;
1b34ec43
DM
1029 if (nla_put(skb, TCA_NETEM_REORDER, sizeof(reorder), &reorder))
1030 goto nla_put_failure;
0dca51d3 1031
c865e5d9
SH
1032 corrupt.probability = q->corrupt;
1033 corrupt.correlation = q->corrupt_cor.rho;
1b34ec43
DM
1034 if (nla_put(skb, TCA_NETEM_CORRUPT, sizeof(corrupt), &corrupt))
1035 goto nla_put_failure;
c865e5d9 1036
6a031f67 1037 if (q->rate >= (1ULL << 32)) {
2a51c1e8
ND
1038 if (nla_put_u64_64bit(skb, TCA_NETEM_RATE64, q->rate,
1039 TCA_NETEM_PAD))
6a031f67
YY
1040 goto nla_put_failure;
1041 rate.rate = ~0U;
1042 } else {
1043 rate.rate = q->rate;
1044 }
90b41a1c
HPP
1045 rate.packet_overhead = q->packet_overhead;
1046 rate.cell_size = q->cell_size;
1047 rate.cell_overhead = q->cell_overhead;
1b34ec43
DM
1048 if (nla_put(skb, TCA_NETEM_RATE, sizeof(rate), &rate))
1049 goto nla_put_failure;
7bc0f28c 1050
e4ae004b
ED
1051 if (q->ecn && nla_put_u32(skb, TCA_NETEM_ECN, q->ecn))
1052 goto nla_put_failure;
1053
661b7972 1054 if (dump_loss_model(q, skb) != 0)
1055 goto nla_put_failure;
1056
861d7f74 1057 return nla_nest_end(skb, nla);
1da177e4 1058
1e90474c 1059nla_put_failure:
861d7f74 1060 nlmsg_trim(skb, nla);
1da177e4
LT
1061 return -1;
1062}
1063
10f6dfcf 1064static int netem_dump_class(struct Qdisc *sch, unsigned long cl,
1065 struct sk_buff *skb, struct tcmsg *tcm)
1066{
1067 struct netem_sched_data *q = qdisc_priv(sch);
1068
50612537 1069 if (cl != 1 || !q->qdisc) /* only one class */
10f6dfcf 1070 return -ENOENT;
1071
1072 tcm->tcm_handle |= TC_H_MIN(1);
1073 tcm->tcm_info = q->qdisc->handle;
1074
1075 return 0;
1076}
1077
1078static int netem_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
1079 struct Qdisc **old)
1080{
1081 struct netem_sched_data *q = qdisc_priv(sch);
1082
86a7996c 1083 *old = qdisc_replace(sch, new, &q->qdisc);
10f6dfcf 1084 return 0;
1085}
1086
1087static struct Qdisc *netem_leaf(struct Qdisc *sch, unsigned long arg)
1088{
1089 struct netem_sched_data *q = qdisc_priv(sch);
1090 return q->qdisc;
1091}
1092
1093static unsigned long netem_get(struct Qdisc *sch, u32 classid)
1094{
1095 return 1;
1096}
1097
1098static void netem_put(struct Qdisc *sch, unsigned long arg)
1099{
1100}
1101
1102static void netem_walk(struct Qdisc *sch, struct qdisc_walker *walker)
1103{
1104 if (!walker->stop) {
1105 if (walker->count >= walker->skip)
1106 if (walker->fn(sch, 1, walker) < 0) {
1107 walker->stop = 1;
1108 return;
1109 }
1110 walker->count++;
1111 }
1112}
1113
1114static const struct Qdisc_class_ops netem_class_ops = {
1115 .graft = netem_graft,
1116 .leaf = netem_leaf,
1117 .get = netem_get,
1118 .put = netem_put,
1119 .walk = netem_walk,
1120 .dump = netem_dump_class,
1121};
1122
20fea08b 1123static struct Qdisc_ops netem_qdisc_ops __read_mostly = {
1da177e4 1124 .id = "netem",
10f6dfcf 1125 .cl_ops = &netem_class_ops,
1da177e4
LT
1126 .priv_size = sizeof(struct netem_sched_data),
1127 .enqueue = netem_enqueue,
1128 .dequeue = netem_dequeue,
77be155c 1129 .peek = qdisc_peek_dequeued,
1da177e4
LT
1130 .init = netem_init,
1131 .reset = netem_reset,
1132 .destroy = netem_destroy,
1133 .change = netem_change,
1134 .dump = netem_dump,
1135 .owner = THIS_MODULE,
1136};
1137
1138
1139static int __init netem_module_init(void)
1140{
eb229c4c 1141 pr_info("netem: version " VERSION "\n");
1da177e4
LT
1142 return register_qdisc(&netem_qdisc_ops);
1143}
1144static void __exit netem_module_exit(void)
1145{
1146 unregister_qdisc(&netem_qdisc_ops);
1147}
1148module_init(netem_module_init)
1149module_exit(netem_module_exit)
1150MODULE_LICENSE("GPL");