Merge tag 'iommu-updates-v4.6' of git://git.kernel.org/pub/scm/linux/kernel/git/joro...
[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);
371 skb->next = NULL;
372 skb->prev = NULL;
373 kfree_skb(skb);
374 }
375}
376
960fb66e 377static void tfifo_enqueue(struct sk_buff *nskb, struct Qdisc *sch)
50612537 378{
aec0a40a 379 struct netem_sched_data *q = qdisc_priv(sch);
50612537 380 psched_time_t tnext = netem_skb_cb(nskb)->time_to_send;
aec0a40a 381 struct rb_node **p = &q->t_root.rb_node, *parent = NULL;
50612537 382
aec0a40a
ED
383 while (*p) {
384 struct sk_buff *skb;
50612537 385
aec0a40a
ED
386 parent = *p;
387 skb = netem_rb_to_skb(parent);
960fb66e 388 if (tnext >= netem_skb_cb(skb)->time_to_send)
aec0a40a
ED
389 p = &parent->rb_right;
390 else
391 p = &parent->rb_left;
50612537 392 }
56b17425
ED
393 rb_link_node(&nskb->rbnode, parent, p);
394 rb_insert_color(&nskb->rbnode, &q->t_root);
aec0a40a 395 sch->q.qlen++;
50612537
ED
396}
397
0afb51e7
SH
398/*
399 * Insert one skb into qdisc.
400 * Note: parent depends on return value to account for queue length.
401 * NET_XMIT_DROP: queue length didn't change.
402 * NET_XMIT_SUCCESS: one skb was queued.
403 */
1da177e4
LT
404static int netem_enqueue(struct sk_buff *skb, struct Qdisc *sch)
405{
406 struct netem_sched_data *q = qdisc_priv(sch);
89e1df74
GC
407 /* We don't fill cb now as skb_unshare() may invalidate it */
408 struct netem_skb_cb *cb;
0afb51e7 409 struct sk_buff *skb2;
0afb51e7 410 int count = 1;
1da177e4 411
0afb51e7
SH
412 /* Random duplication */
413 if (q->duplicate && q->duplicate >= get_crandom(&q->dup_cor))
414 ++count;
415
661b7972 416 /* Drop packet? */
e4ae004b
ED
417 if (loss_event(q)) {
418 if (q->ecn && INET_ECN_set_ce(skb))
25331d6c 419 qdisc_qstats_drop(sch); /* mark packet */
e4ae004b
ED
420 else
421 --count;
422 }
0afb51e7 423 if (count == 0) {
25331d6c 424 qdisc_qstats_drop(sch);
1da177e4 425 kfree_skb(skb);
c27f339a 426 return NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
1da177e4
LT
427 }
428
5a308f40
ED
429 /* If a delay is expected, orphan the skb. (orphaning usually takes
430 * place at TX completion time, so _before_ the link transit delay)
5a308f40
ED
431 */
432 if (q->latency || q->jitter)
f2f872f9 433 skb_orphan_partial(skb);
4e8a5201 434
0afb51e7
SH
435 /*
436 * If we need to duplicate packet, then re-insert at top of the
437 * qdisc tree, since parent queuer expects that only one
438 * skb will be queued.
439 */
440 if (count > 1 && (skb2 = skb_clone(skb, GFP_ATOMIC)) != NULL) {
7698b4fc 441 struct Qdisc *rootq = qdisc_root(sch);
0afb51e7 442 u32 dupsave = q->duplicate; /* prevent duplicating a dup... */
0afb51e7 443
b396cca6
ED
444 q->duplicate = 0;
445 rootq->enqueue(skb2, rootq);
0afb51e7 446 q->duplicate = dupsave;
1da177e4
LT
447 }
448
c865e5d9
SH
449 /*
450 * Randomized packet corruption.
451 * Make copy if needed since we are modifying
452 * If packet is going to be hardware checksummed, then
453 * do it now in software before we mangle it.
454 */
455 if (q->corrupt && q->corrupt >= get_crandom(&q->corrupt_cor)) {
f64f9e71
JP
456 if (!(skb = skb_unshare(skb, GFP_ATOMIC)) ||
457 (skb->ip_summed == CHECKSUM_PARTIAL &&
116a0fc3
ED
458 skb_checksum_help(skb)))
459 return qdisc_drop(skb, sch);
c865e5d9 460
63862b5b
AH
461 skb->data[prandom_u32() % skb_headlen(skb)] ^=
462 1<<(prandom_u32() % 8);
c865e5d9
SH
463 }
464
960fb66e
ED
465 if (unlikely(skb_queue_len(&sch->q) >= sch->limit))
466 return qdisc_reshape_fail(skb, sch);
467
25331d6c 468 qdisc_qstats_backlog_inc(sch, skb);
960fb66e 469
5f86173b 470 cb = netem_skb_cb(skb);
cc7ec456 471 if (q->gap == 0 || /* not doing reordering */
a42b4799 472 q->counter < q->gap - 1 || /* inside last reordering gap */
f64f9e71 473 q->reorder < get_crandom(&q->reorder_cor)) {
0f9f32ac 474 psched_time_t now;
07aaa115
SH
475 psched_tdiff_t delay;
476
477 delay = tabledist(q->latency, q->jitter,
478 &q->delay_cor, q->delay_dist);
479
3bebcda2 480 now = psched_get_time();
7bc0f28c
HPP
481
482 if (q->rate) {
aec0a40a 483 struct sk_buff *last;
7bc0f28c 484
aec0a40a
ED
485 if (!skb_queue_empty(&sch->q))
486 last = skb_peek_tail(&sch->q);
487 else
488 last = netem_rb_to_skb(rb_last(&q->t_root));
489 if (last) {
7bc0f28c 490 /*
a13d3104
JN
491 * Last packet in queue is reference point (now),
492 * calculate this time bonus and subtract
7bc0f28c
HPP
493 * from delay.
494 */
aec0a40a 495 delay -= netem_skb_cb(last)->time_to_send - now;
a13d3104 496 delay = max_t(psched_tdiff_t, 0, delay);
aec0a40a 497 now = netem_skb_cb(last)->time_to_send;
7bc0f28c 498 }
a13d3104 499
8cfd88d6 500 delay += packet_len_2_sched_time(qdisc_pkt_len(skb), q);
7bc0f28c
HPP
501 }
502
7c59e25f 503 cb->time_to_send = now + delay;
aec0a40a 504 cb->tstamp_save = skb->tstamp;
1da177e4 505 ++q->counter;
960fb66e 506 tfifo_enqueue(skb, sch);
1da177e4 507 } else {
10297b99 508 /*
0dca51d3
SH
509 * Do re-ordering by putting one out of N packets at the front
510 * of the queue.
511 */
3bebcda2 512 cb->time_to_send = psched_get_time();
0dca51d3 513 q->counter = 0;
8ba25dad 514
50612537 515 __skb_queue_head(&sch->q, skb);
eb101924 516 sch->qstats.requeues++;
378a2f09 517 }
1da177e4 518
10f6dfcf 519 return NET_XMIT_SUCCESS;
1da177e4
LT
520}
521
cc7ec456 522static unsigned int netem_drop(struct Qdisc *sch)
1da177e4
LT
523{
524 struct netem_sched_data *q = qdisc_priv(sch);
50612537 525 unsigned int len;
1da177e4 526
50612537 527 len = qdisc_queue_drop(sch);
aec0a40a
ED
528
529 if (!len) {
530 struct rb_node *p = rb_first(&q->t_root);
531
532 if (p) {
533 struct sk_buff *skb = netem_rb_to_skb(p);
534
535 rb_erase(p, &q->t_root);
536 sch->q.qlen--;
537 skb->next = NULL;
538 skb->prev = NULL;
25331d6c 539 qdisc_qstats_backlog_dec(sch, skb);
aec0a40a
ED
540 kfree_skb(skb);
541 }
542 }
50612537
ED
543 if (!len && q->qdisc && q->qdisc->ops->drop)
544 len = q->qdisc->ops->drop(q->qdisc);
545 if (len)
25331d6c 546 qdisc_qstats_drop(sch);
50612537 547
1da177e4
LT
548 return len;
549}
550
1da177e4
LT
551static struct sk_buff *netem_dequeue(struct Qdisc *sch)
552{
553 struct netem_sched_data *q = qdisc_priv(sch);
554 struct sk_buff *skb;
aec0a40a 555 struct rb_node *p;
1da177e4 556
fd245a4a 557 if (qdisc_is_throttled(sch))
11274e5a
SH
558 return NULL;
559
50612537 560tfifo_dequeue:
aec0a40a 561 skb = __skb_dequeue(&sch->q);
771018e7 562 if (skb) {
25331d6c 563 qdisc_qstats_backlog_dec(sch, skb);
0ad2a836 564deliver:
aec0a40a
ED
565 qdisc_unthrottled(sch);
566 qdisc_bstats_update(sch, skb);
567 return skb;
568 }
569 p = rb_first(&q->t_root);
570 if (p) {
36b7bfe0
ED
571 psched_time_t time_to_send;
572
aec0a40a 573 skb = netem_rb_to_skb(p);
0f9f32ac
SH
574
575 /* if more time remaining? */
36b7bfe0
ED
576 time_to_send = netem_skb_cb(skb)->time_to_send;
577 if (time_to_send <= psched_get_time()) {
aec0a40a
ED
578 rb_erase(p, &q->t_root);
579
580 sch->q.qlen--;
0ad2a836 581 qdisc_qstats_backlog_dec(sch, skb);
aec0a40a
ED
582 skb->next = NULL;
583 skb->prev = NULL;
584 skb->tstamp = netem_skb_cb(skb)->tstamp_save;
03c05f0d 585
8caf1539
JP
586#ifdef CONFIG_NET_CLS_ACT
587 /*
588 * If it's at ingress let's pretend the delay is
589 * from the network (tstamp will be updated).
590 */
591 if (G_TC_FROM(skb->tc_verd) & AT_INGRESS)
592 skb->tstamp.tv64 = 0;
593#endif
10f6dfcf 594
50612537
ED
595 if (q->qdisc) {
596 int err = qdisc_enqueue(skb, q->qdisc);
597
598 if (unlikely(err != NET_XMIT_SUCCESS)) {
599 if (net_xmit_drop_count(err)) {
25331d6c 600 qdisc_qstats_drop(sch);
2ccccf5f
WC
601 qdisc_tree_reduce_backlog(sch, 1,
602 qdisc_pkt_len(skb));
50612537
ED
603 }
604 }
605 goto tfifo_dequeue;
606 }
aec0a40a 607 goto deliver;
07aaa115 608 }
11274e5a 609
50612537
ED
610 if (q->qdisc) {
611 skb = q->qdisc->ops->dequeue(q->qdisc);
612 if (skb)
613 goto deliver;
614 }
36b7bfe0 615 qdisc_watchdog_schedule(&q->watchdog, time_to_send);
0f9f32ac
SH
616 }
617
50612537
ED
618 if (q->qdisc) {
619 skb = q->qdisc->ops->dequeue(q->qdisc);
620 if (skb)
621 goto deliver;
622 }
0f9f32ac 623 return NULL;
1da177e4
LT
624}
625
1da177e4
LT
626static void netem_reset(struct Qdisc *sch)
627{
628 struct netem_sched_data *q = qdisc_priv(sch);
629
50612537 630 qdisc_reset_queue(sch);
ff704050 631 tfifo_reset(sch);
50612537
ED
632 if (q->qdisc)
633 qdisc_reset(q->qdisc);
59cb5c67 634 qdisc_watchdog_cancel(&q->watchdog);
1da177e4
LT
635}
636
6373a9a2 637static void dist_free(struct disttable *d)
638{
4cb28970 639 kvfree(d);
6373a9a2 640}
641
1da177e4
LT
642/*
643 * Distribution data is a variable size payload containing
644 * signed 16 bit values.
645 */
1e90474c 646static int get_dist_table(struct Qdisc *sch, const struct nlattr *attr)
1da177e4
LT
647{
648 struct netem_sched_data *q = qdisc_priv(sch);
6373a9a2 649 size_t n = nla_len(attr)/sizeof(__s16);
1e90474c 650 const __s16 *data = nla_data(attr);
7698b4fc 651 spinlock_t *root_lock;
1da177e4
LT
652 struct disttable *d;
653 int i;
6373a9a2 654 size_t s;
1da177e4 655
df173bda 656 if (n > NETEM_DIST_MAX)
1da177e4
LT
657 return -EINVAL;
658
6373a9a2 659 s = sizeof(struct disttable) + n * sizeof(s16);
bb52c7ac 660 d = kmalloc(s, GFP_KERNEL | __GFP_NOWARN);
6373a9a2 661 if (!d)
662 d = vmalloc(s);
1da177e4
LT
663 if (!d)
664 return -ENOMEM;
665
666 d->size = n;
667 for (i = 0; i < n; i++)
668 d->table[i] = data[i];
10297b99 669
102396ae 670 root_lock = qdisc_root_sleeping_lock(sch);
7698b4fc
DM
671
672 spin_lock_bh(root_lock);
bb52c7ac 673 swap(q->delay_dist, d);
7698b4fc 674 spin_unlock_bh(root_lock);
bb52c7ac
ED
675
676 dist_free(d);
1da177e4
LT
677 return 0;
678}
679
49545a77 680static void get_correlation(struct netem_sched_data *q, const struct nlattr *attr)
1da177e4 681{
1e90474c 682 const struct tc_netem_corr *c = nla_data(attr);
1da177e4 683
1da177e4
LT
684 init_crandom(&q->delay_cor, c->delay_corr);
685 init_crandom(&q->loss_cor, c->loss_corr);
686 init_crandom(&q->dup_cor, c->dup_corr);
1da177e4
LT
687}
688
49545a77 689static void get_reorder(struct netem_sched_data *q, const struct nlattr *attr)
0dca51d3 690{
1e90474c 691 const struct tc_netem_reorder *r = nla_data(attr);
0dca51d3 692
0dca51d3
SH
693 q->reorder = r->probability;
694 init_crandom(&q->reorder_cor, r->correlation);
0dca51d3
SH
695}
696
49545a77 697static void get_corrupt(struct netem_sched_data *q, const struct nlattr *attr)
c865e5d9 698{
1e90474c 699 const struct tc_netem_corrupt *r = nla_data(attr);
c865e5d9 700
c865e5d9
SH
701 q->corrupt = r->probability;
702 init_crandom(&q->corrupt_cor, r->correlation);
c865e5d9
SH
703}
704
49545a77 705static void get_rate(struct netem_sched_data *q, const struct nlattr *attr)
7bc0f28c 706{
7bc0f28c
HPP
707 const struct tc_netem_rate *r = nla_data(attr);
708
709 q->rate = r->rate;
90b41a1c
HPP
710 q->packet_overhead = r->packet_overhead;
711 q->cell_size = r->cell_size;
809fa972 712 q->cell_overhead = r->cell_overhead;
90b41a1c
HPP
713 if (q->cell_size)
714 q->cell_size_reciprocal = reciprocal_value(q->cell_size);
809fa972
HFS
715 else
716 q->cell_size_reciprocal = (struct reciprocal_value) { 0 };
7bc0f28c
HPP
717}
718
49545a77 719static int get_loss_clg(struct netem_sched_data *q, const struct nlattr *attr)
661b7972 720{
661b7972 721 const struct nlattr *la;
722 int rem;
723
724 nla_for_each_nested(la, attr, rem) {
725 u16 type = nla_type(la);
726
833fa743 727 switch (type) {
661b7972 728 case NETEM_LOSS_GI: {
729 const struct tc_netem_gimodel *gi = nla_data(la);
730
2494654d 731 if (nla_len(la) < sizeof(struct tc_netem_gimodel)) {
661b7972 732 pr_info("netem: incorrect gi model size\n");
733 return -EINVAL;
734 }
735
736 q->loss_model = CLG_4_STATES;
737
3fbac2a8 738 q->clg.state = TX_IN_GAP_PERIOD;
661b7972 739 q->clg.a1 = gi->p13;
740 q->clg.a2 = gi->p31;
741 q->clg.a3 = gi->p32;
742 q->clg.a4 = gi->p14;
743 q->clg.a5 = gi->p23;
744 break;
745 }
746
747 case NETEM_LOSS_GE: {
748 const struct tc_netem_gemodel *ge = nla_data(la);
749
2494654d 750 if (nla_len(la) < sizeof(struct tc_netem_gemodel)) {
751 pr_info("netem: incorrect ge model size\n");
661b7972 752 return -EINVAL;
753 }
754
755 q->loss_model = CLG_GILB_ELL;
3fbac2a8 756 q->clg.state = GOOD_STATE;
661b7972 757 q->clg.a1 = ge->p;
758 q->clg.a2 = ge->r;
759 q->clg.a3 = ge->h;
760 q->clg.a4 = ge->k1;
761 break;
762 }
763
764 default:
765 pr_info("netem: unknown loss type %u\n", type);
766 return -EINVAL;
767 }
768 }
769
770 return 0;
771}
772
27a3421e
PM
773static const struct nla_policy netem_policy[TCA_NETEM_MAX + 1] = {
774 [TCA_NETEM_CORR] = { .len = sizeof(struct tc_netem_corr) },
775 [TCA_NETEM_REORDER] = { .len = sizeof(struct tc_netem_reorder) },
776 [TCA_NETEM_CORRUPT] = { .len = sizeof(struct tc_netem_corrupt) },
7bc0f28c 777 [TCA_NETEM_RATE] = { .len = sizeof(struct tc_netem_rate) },
661b7972 778 [TCA_NETEM_LOSS] = { .type = NLA_NESTED },
e4ae004b 779 [TCA_NETEM_ECN] = { .type = NLA_U32 },
6a031f67 780 [TCA_NETEM_RATE64] = { .type = NLA_U64 },
27a3421e
PM
781};
782
2c10b32b
TG
783static int parse_attr(struct nlattr *tb[], int maxtype, struct nlattr *nla,
784 const struct nla_policy *policy, int len)
785{
786 int nested_len = nla_len(nla) - NLA_ALIGN(len);
787
661b7972 788 if (nested_len < 0) {
789 pr_info("netem: invalid attributes len %d\n", nested_len);
2c10b32b 790 return -EINVAL;
661b7972 791 }
792
2c10b32b
TG
793 if (nested_len >= nla_attr_size(0))
794 return nla_parse(tb, maxtype, nla_data(nla) + NLA_ALIGN(len),
795 nested_len, policy);
661b7972 796
2c10b32b
TG
797 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
798 return 0;
799}
800
c865e5d9 801/* Parse netlink message to set options */
1e90474c 802static int netem_change(struct Qdisc *sch, struct nlattr *opt)
1da177e4
LT
803{
804 struct netem_sched_data *q = qdisc_priv(sch);
b03f4672 805 struct nlattr *tb[TCA_NETEM_MAX + 1];
1da177e4 806 struct tc_netem_qopt *qopt;
54a4b05c
YY
807 struct clgstate old_clg;
808 int old_loss_model = CLG_RANDOM;
1da177e4 809 int ret;
10297b99 810
b03f4672 811 if (opt == NULL)
1da177e4
LT
812 return -EINVAL;
813
2c10b32b
TG
814 qopt = nla_data(opt);
815 ret = parse_attr(tb, TCA_NETEM_MAX, opt, netem_policy, sizeof(*qopt));
b03f4672
PM
816 if (ret < 0)
817 return ret;
818
54a4b05c
YY
819 /* backup q->clg and q->loss_model */
820 old_clg = q->clg;
821 old_loss_model = q->loss_model;
822
823 if (tb[TCA_NETEM_LOSS]) {
49545a77 824 ret = get_loss_clg(q, tb[TCA_NETEM_LOSS]);
54a4b05c
YY
825 if (ret) {
826 q->loss_model = old_loss_model;
827 return ret;
828 }
829 } else {
830 q->loss_model = CLG_RANDOM;
831 }
832
833 if (tb[TCA_NETEM_DELAY_DIST]) {
834 ret = get_dist_table(sch, tb[TCA_NETEM_DELAY_DIST]);
835 if (ret) {
836 /* recover clg and loss_model, in case of
837 * q->clg and q->loss_model were modified
838 * in get_loss_clg()
839 */
840 q->clg = old_clg;
841 q->loss_model = old_loss_model;
842 return ret;
843 }
844 }
845
50612537 846 sch->limit = qopt->limit;
10297b99 847
1da177e4
LT
848 q->latency = qopt->latency;
849 q->jitter = qopt->jitter;
850 q->limit = qopt->limit;
851 q->gap = qopt->gap;
0dca51d3 852 q->counter = 0;
1da177e4
LT
853 q->loss = qopt->loss;
854 q->duplicate = qopt->duplicate;
855
bb2f8cc0
SH
856 /* for compatibility with earlier versions.
857 * if gap is set, need to assume 100% probability
0dca51d3 858 */
a362e0a7
SH
859 if (q->gap)
860 q->reorder = ~0;
0dca51d3 861
265eb67f 862 if (tb[TCA_NETEM_CORR])
49545a77 863 get_correlation(q, tb[TCA_NETEM_CORR]);
1da177e4 864
265eb67f 865 if (tb[TCA_NETEM_REORDER])
49545a77 866 get_reorder(q, tb[TCA_NETEM_REORDER]);
1da177e4 867
265eb67f 868 if (tb[TCA_NETEM_CORRUPT])
49545a77 869 get_corrupt(q, tb[TCA_NETEM_CORRUPT]);
1da177e4 870
7bc0f28c 871 if (tb[TCA_NETEM_RATE])
49545a77 872 get_rate(q, tb[TCA_NETEM_RATE]);
7bc0f28c 873
6a031f67
YY
874 if (tb[TCA_NETEM_RATE64])
875 q->rate = max_t(u64, q->rate,
876 nla_get_u64(tb[TCA_NETEM_RATE64]));
877
e4ae004b
ED
878 if (tb[TCA_NETEM_ECN])
879 q->ecn = nla_get_u32(tb[TCA_NETEM_ECN]);
880
661b7972 881 return ret;
1da177e4
LT
882}
883
1e90474c 884static int netem_init(struct Qdisc *sch, struct nlattr *opt)
1da177e4
LT
885{
886 struct netem_sched_data *q = qdisc_priv(sch);
887 int ret;
888
889 if (!opt)
890 return -EINVAL;
891
59cb5c67 892 qdisc_watchdog_init(&q->watchdog, sch);
1da177e4 893
661b7972 894 q->loss_model = CLG_RANDOM;
1da177e4 895 ret = netem_change(sch, opt);
50612537 896 if (ret)
250a65f7 897 pr_info("netem: change failed\n");
1da177e4
LT
898 return ret;
899}
900
901static void netem_destroy(struct Qdisc *sch)
902{
903 struct netem_sched_data *q = qdisc_priv(sch);
904
59cb5c67 905 qdisc_watchdog_cancel(&q->watchdog);
50612537
ED
906 if (q->qdisc)
907 qdisc_destroy(q->qdisc);
6373a9a2 908 dist_free(q->delay_dist);
1da177e4
LT
909}
910
661b7972 911static int dump_loss_model(const struct netem_sched_data *q,
912 struct sk_buff *skb)
913{
914 struct nlattr *nest;
915
916 nest = nla_nest_start(skb, TCA_NETEM_LOSS);
917 if (nest == NULL)
918 goto nla_put_failure;
919
920 switch (q->loss_model) {
921 case CLG_RANDOM:
922 /* legacy loss model */
923 nla_nest_cancel(skb, nest);
924 return 0; /* no data */
925
926 case CLG_4_STATES: {
927 struct tc_netem_gimodel gi = {
928 .p13 = q->clg.a1,
929 .p31 = q->clg.a2,
930 .p32 = q->clg.a3,
931 .p14 = q->clg.a4,
932 .p23 = q->clg.a5,
933 };
934
1b34ec43
DM
935 if (nla_put(skb, NETEM_LOSS_GI, sizeof(gi), &gi))
936 goto nla_put_failure;
661b7972 937 break;
938 }
939 case CLG_GILB_ELL: {
940 struct tc_netem_gemodel ge = {
941 .p = q->clg.a1,
942 .r = q->clg.a2,
943 .h = q->clg.a3,
944 .k1 = q->clg.a4,
945 };
946
1b34ec43
DM
947 if (nla_put(skb, NETEM_LOSS_GE, sizeof(ge), &ge))
948 goto nla_put_failure;
661b7972 949 break;
950 }
951 }
952
953 nla_nest_end(skb, nest);
954 return 0;
955
956nla_put_failure:
957 nla_nest_cancel(skb, nest);
958 return -1;
959}
960
1da177e4
LT
961static int netem_dump(struct Qdisc *sch, struct sk_buff *skb)
962{
963 const struct netem_sched_data *q = qdisc_priv(sch);
861d7f74 964 struct nlattr *nla = (struct nlattr *) skb_tail_pointer(skb);
1da177e4
LT
965 struct tc_netem_qopt qopt;
966 struct tc_netem_corr cor;
0dca51d3 967 struct tc_netem_reorder reorder;
c865e5d9 968 struct tc_netem_corrupt corrupt;
7bc0f28c 969 struct tc_netem_rate rate;
1da177e4
LT
970
971 qopt.latency = q->latency;
972 qopt.jitter = q->jitter;
973 qopt.limit = q->limit;
974 qopt.loss = q->loss;
975 qopt.gap = q->gap;
976 qopt.duplicate = q->duplicate;
1b34ec43
DM
977 if (nla_put(skb, TCA_OPTIONS, sizeof(qopt), &qopt))
978 goto nla_put_failure;
1da177e4
LT
979
980 cor.delay_corr = q->delay_cor.rho;
981 cor.loss_corr = q->loss_cor.rho;
982 cor.dup_corr = q->dup_cor.rho;
1b34ec43
DM
983 if (nla_put(skb, TCA_NETEM_CORR, sizeof(cor), &cor))
984 goto nla_put_failure;
0dca51d3
SH
985
986 reorder.probability = q->reorder;
987 reorder.correlation = q->reorder_cor.rho;
1b34ec43
DM
988 if (nla_put(skb, TCA_NETEM_REORDER, sizeof(reorder), &reorder))
989 goto nla_put_failure;
0dca51d3 990
c865e5d9
SH
991 corrupt.probability = q->corrupt;
992 corrupt.correlation = q->corrupt_cor.rho;
1b34ec43
DM
993 if (nla_put(skb, TCA_NETEM_CORRUPT, sizeof(corrupt), &corrupt))
994 goto nla_put_failure;
c865e5d9 995
6a031f67
YY
996 if (q->rate >= (1ULL << 32)) {
997 if (nla_put_u64(skb, TCA_NETEM_RATE64, q->rate))
998 goto nla_put_failure;
999 rate.rate = ~0U;
1000 } else {
1001 rate.rate = q->rate;
1002 }
90b41a1c
HPP
1003 rate.packet_overhead = q->packet_overhead;
1004 rate.cell_size = q->cell_size;
1005 rate.cell_overhead = q->cell_overhead;
1b34ec43
DM
1006 if (nla_put(skb, TCA_NETEM_RATE, sizeof(rate), &rate))
1007 goto nla_put_failure;
7bc0f28c 1008
e4ae004b
ED
1009 if (q->ecn && nla_put_u32(skb, TCA_NETEM_ECN, q->ecn))
1010 goto nla_put_failure;
1011
661b7972 1012 if (dump_loss_model(q, skb) != 0)
1013 goto nla_put_failure;
1014
861d7f74 1015 return nla_nest_end(skb, nla);
1da177e4 1016
1e90474c 1017nla_put_failure:
861d7f74 1018 nlmsg_trim(skb, nla);
1da177e4
LT
1019 return -1;
1020}
1021
10f6dfcf 1022static int netem_dump_class(struct Qdisc *sch, unsigned long cl,
1023 struct sk_buff *skb, struct tcmsg *tcm)
1024{
1025 struct netem_sched_data *q = qdisc_priv(sch);
1026
50612537 1027 if (cl != 1 || !q->qdisc) /* only one class */
10f6dfcf 1028 return -ENOENT;
1029
1030 tcm->tcm_handle |= TC_H_MIN(1);
1031 tcm->tcm_info = q->qdisc->handle;
1032
1033 return 0;
1034}
1035
1036static int netem_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
1037 struct Qdisc **old)
1038{
1039 struct netem_sched_data *q = qdisc_priv(sch);
1040
86a7996c 1041 *old = qdisc_replace(sch, new, &q->qdisc);
10f6dfcf 1042 return 0;
1043}
1044
1045static struct Qdisc *netem_leaf(struct Qdisc *sch, unsigned long arg)
1046{
1047 struct netem_sched_data *q = qdisc_priv(sch);
1048 return q->qdisc;
1049}
1050
1051static unsigned long netem_get(struct Qdisc *sch, u32 classid)
1052{
1053 return 1;
1054}
1055
1056static void netem_put(struct Qdisc *sch, unsigned long arg)
1057{
1058}
1059
1060static void netem_walk(struct Qdisc *sch, struct qdisc_walker *walker)
1061{
1062 if (!walker->stop) {
1063 if (walker->count >= walker->skip)
1064 if (walker->fn(sch, 1, walker) < 0) {
1065 walker->stop = 1;
1066 return;
1067 }
1068 walker->count++;
1069 }
1070}
1071
1072static const struct Qdisc_class_ops netem_class_ops = {
1073 .graft = netem_graft,
1074 .leaf = netem_leaf,
1075 .get = netem_get,
1076 .put = netem_put,
1077 .walk = netem_walk,
1078 .dump = netem_dump_class,
1079};
1080
20fea08b 1081static struct Qdisc_ops netem_qdisc_ops __read_mostly = {
1da177e4 1082 .id = "netem",
10f6dfcf 1083 .cl_ops = &netem_class_ops,
1da177e4
LT
1084 .priv_size = sizeof(struct netem_sched_data),
1085 .enqueue = netem_enqueue,
1086 .dequeue = netem_dequeue,
77be155c 1087 .peek = qdisc_peek_dequeued,
1da177e4
LT
1088 .drop = netem_drop,
1089 .init = netem_init,
1090 .reset = netem_reset,
1091 .destroy = netem_destroy,
1092 .change = netem_change,
1093 .dump = netem_dump,
1094 .owner = THIS_MODULE,
1095};
1096
1097
1098static int __init netem_module_init(void)
1099{
eb229c4c 1100 pr_info("netem: version " VERSION "\n");
1da177e4
LT
1101 return register_qdisc(&netem_qdisc_ops);
1102}
1103static void __exit netem_module_exit(void)
1104{
1105 unregister_qdisc(&netem_qdisc_ops);
1106}
1107module_init(netem_module_init)
1108module_exit(netem_module_exit)
1109MODULE_LICENSE("GPL");