sch_netem.c 22.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6
/*
 * net/sched/sch_netem.c	Network emulator
 *
 * 		This program is free software; you can redistribute it and/or
 * 		modify it under the terms of the GNU General Public License
 * 		as published by the Free Software Foundation; either version
7
 * 		2 of the License.
L
Linus Torvalds 已提交
8 9
 *
 *  		Many of the algorithms and ideas for this came from
10
 *		NIST Net which is not copyrighted.
L
Linus Torvalds 已提交
11 12 13 14 15 16
 *
 * Authors:	Stephen Hemminger <shemminger@osdl.org>
 *		Catalin(ux aka Dino) BOIE <catab at umbrella dot ro>
 */

#include <linux/module.h>
17
#include <linux/slab.h>
L
Linus Torvalds 已提交
18 19 20 21
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/skbuff.h>
22
#include <linux/vmalloc.h>
L
Linus Torvalds 已提交
23 24
#include <linux/rtnetlink.h>

25
#include <net/netlink.h>
L
Linus Torvalds 已提交
26 27
#include <net/pkt_sched.h>

28
#define VERSION "1.3"
S
Stephen Hemminger 已提交
29

L
Linus Torvalds 已提交
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/*	Network Emulation Queuing algorithm.
	====================================

	Sources: [1] Mark Carson, Darrin Santay, "NIST Net - A Linux-based
		 Network Emulation Tool
		 [2] Luigi Rizzo, DummyNet for FreeBSD

	 ----------------------------------------------------------------

	 This started out as a simple way to delay outgoing packets to
	 test TCP but has grown to include most of the functionality
	 of a full blown network emulator like NISTnet. It can delay
	 packets and add random jitter (and correlation). The random
	 distribution can be loaded from a table as well to provide
	 normal, Pareto, or experimental curves. Packet loss,
	 duplication, and reordering can also be emulated.

	 This qdisc does not do classification that can be handled in
	 layering other disciplines.  It does not need to do bandwidth
	 control either since that can be handled by using token
	 bucket or other rate control.
51 52 53 54 55 56 57 58 59 60 61 62 63 64

     Correlated Loss Generator models

	Added generation of correlated loss according to the
	"Gilbert-Elliot" model, a 4-state markov model.

	References:
	[1] NetemCLG Home http://netgroup.uniroma2.it/NetemCLG
	[2] S. Salsano, F. Ludovici, A. Ordine, "Definition of a general
	and intuitive loss model for packet networks and its implementation
	in the Netem module in the Linux kernel", available in [1]

	Authors: Stefano Salsano <stefano.salsano at uniroma2.it
		 Fabio Ludovici <fabio.ludovici at yahoo.it>
L
Linus Torvalds 已提交
65 66 67 68
*/

struct netem_sched_data {
	struct Qdisc	*qdisc;
69
	struct qdisc_watchdog watchdog;
L
Linus Torvalds 已提交
70

71 72 73
	psched_tdiff_t latency;
	psched_tdiff_t jitter;

L
Linus Torvalds 已提交
74 75 76 77 78
	u32 loss;
	u32 limit;
	u32 counter;
	u32 gap;
	u32 duplicate;
79
	u32 reorder;
80
	u32 corrupt;
L
Linus Torvalds 已提交
81 82

	struct crndstate {
83 84
		u32 last;
		u32 rho;
85
	} delay_cor, loss_cor, dup_cor, reorder_cor, corrupt_cor;
L
Linus Torvalds 已提交
86 87 88 89 90

	struct disttable {
		u32  size;
		s16 table[0];
	} *delay_dist;
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

	enum  {
		CLG_RANDOM,
		CLG_4_STATES,
		CLG_GILB_ELL,
	} loss_model;

	/* Correlated Loss Generation models */
	struct clgstate {
		/* state of the Markov chain */
		u8 state;

		/* 4-states and Gilbert-Elliot models */
		u32 a1;	/* p13 for 4-states or p for GE */
		u32 a2;	/* p31 for 4-states or r for GE */
		u32 a3;	/* p32 for 4-states or h for GE */
		u32 a4;	/* p14 for 4-states or 1-k for GE */
		u32 a5; /* p23 used only in 4-states */
	} clg;

L
Linus Torvalds 已提交
111 112 113 114 115 116 117
};

/* Time stamp put into socket buffer control block */
struct netem_skb_cb {
	psched_time_t	time_to_send;
};

118 119
static inline struct netem_skb_cb *netem_skb_cb(struct sk_buff *skb)
{
120 121 122
	BUILD_BUG_ON(sizeof(skb->cb) <
		sizeof(struct qdisc_skb_cb) + sizeof(struct netem_skb_cb));
	return (struct netem_skb_cb *)qdisc_skb_cb(skb)->data;
123 124
}

L
Linus Torvalds 已提交
125 126 127 128 129 130 131 132 133 134 135 136 137
/* init_crandom - initialize correlated random number generator
 * Use entropy source for initial seed.
 */
static void init_crandom(struct crndstate *state, unsigned long rho)
{
	state->rho = rho;
	state->last = net_random();
}

/* get_crandom - correlated random number generator
 * Next number depends on last value.
 * rho is scaled to avoid floating point.
 */
138
static u32 get_crandom(struct crndstate *state)
L
Linus Torvalds 已提交
139 140 141 142
{
	u64 value, rho;
	unsigned long answer;

S
Stephen Hemminger 已提交
143
	if (state->rho == 0)	/* no correlation */
L
Linus Torvalds 已提交
144 145 146 147 148 149 150 151 152
		return net_random();

	value = net_random();
	rho = (u64)state->rho + 1;
	answer = (value * ((1ull<<32) - rho) + state->last * rho) >> 32;
	state->last = answer;
	return answer;
}

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
/* loss_4state - 4-state model loss generator
 * Generates losses according to the 4-state Markov chain adopted in
 * the GI (General and Intuitive) loss model.
 */
static bool loss_4state(struct netem_sched_data *q)
{
	struct clgstate *clg = &q->clg;
	u32 rnd = net_random();

	/*
	 * Makes a comparision between rnd and the transition
	 * probabilities outgoing from the current state, then decides the
	 * next state and if the next packet has to be transmitted or lost.
	 * The four states correspond to:
	 *   1 => successfully transmitted packets within a gap period
	 *   4 => isolated losses within a gap period
	 *   3 => lost packets within a burst period
	 *   2 => successfully transmitted packets within a burst period
	 */
	switch (clg->state) {
	case 1:
		if (rnd < clg->a4) {
			clg->state = 4;
			return true;
		} else if (clg->a4 < rnd && rnd < clg->a1) {
			clg->state = 3;
			return true;
		} else if (clg->a1 < rnd)
			clg->state = 1;

		break;
	case 2:
		if (rnd < clg->a5) {
			clg->state = 3;
			return true;
		} else
			clg->state = 2;

		break;
	case 3:
		if (rnd < clg->a3)
			clg->state = 2;
		else if (clg->a3 < rnd && rnd < clg->a2 + clg->a3) {
			clg->state = 1;
			return true;
		} else if (clg->a2 + clg->a3 < rnd) {
			clg->state = 3;
			return true;
		}
		break;
	case 4:
		clg->state = 1;
		break;
	}

	return false;
}

/* loss_gilb_ell - Gilbert-Elliot model loss generator
 * Generates losses according to the Gilbert-Elliot loss model or
 * its special cases  (Gilbert or Simple Gilbert)
 *
 * Makes a comparision between random number and the transition
 * probabilities outgoing from the current state, then decides the
 * next state. A second random number is extracted and the comparision
 * with the loss probability of the current state decides if the next
 * packet will be transmitted or lost.
 */
static bool loss_gilb_ell(struct netem_sched_data *q)
{
	struct clgstate *clg = &q->clg;

	switch (clg->state) {
	case 1:
		if (net_random() < clg->a1)
			clg->state = 2;
		if (net_random() < clg->a4)
			return true;
	case 2:
		if (net_random() < clg->a2)
			clg->state = 1;
		if (clg->a3 > net_random())
			return true;
	}

	return false;
}

static bool loss_event(struct netem_sched_data *q)
{
	switch (q->loss_model) {
	case CLG_RANDOM:
		/* Random packet drop 0 => none, ~0 => all */
		return q->loss && q->loss >= get_crandom(&q->loss_cor);

	case CLG_4_STATES:
		/* 4state loss model algorithm (used also for GI model)
		* Extracts a value from the markov 4 state loss generator,
		* if it is 1 drops a packet and if needed writes the event in
		* the kernel logs
		*/
		return loss_4state(q);

	case CLG_GILB_ELL:
		/* Gilbert-Elliot loss model algorithm
		* Extracts a value from the Gilbert-Elliot loss generator,
		* if it is 1 drops a packet and if needed writes the event in
		* the kernel logs
		*/
		return loss_gilb_ell(q);
	}

	return false;	/* not reached */
}


L
Linus Torvalds 已提交
269 270 271 272
/* tabledist - return a pseudo-randomly distributed value with mean mu and
 * std deviation sigma.  Uses table lookup to approximate the desired
 * distribution, and a uniformly-distributed pseudo-random source.
 */
273 274 275
static psched_tdiff_t tabledist(psched_tdiff_t mu, psched_tdiff_t sigma,
				struct crndstate *state,
				const struct disttable *dist)
L
Linus Torvalds 已提交
276
{
277 278 279
	psched_tdiff_t x;
	long t;
	u32 rnd;
L
Linus Torvalds 已提交
280 281 282 283 284 285 286

	if (sigma == 0)
		return mu;

	rnd = get_crandom(state);

	/* default uniform distribution */
287
	if (dist == NULL)
L
Linus Torvalds 已提交
288 289 290 291 292 293 294 295 296 297 298 299
		return (rnd % (2*sigma)) - sigma + mu;

	t = dist->table[rnd % dist->size];
	x = (sigma % NETEM_DIST_SCALE) * t;
	if (x >= 0)
		x += NETEM_DIST_SCALE/2;
	else
		x -= NETEM_DIST_SCALE/2;

	return  x / NETEM_DIST_SCALE + (sigma / NETEM_DIST_SCALE) * t + mu;
}

300 301 302 303 304 305
/*
 * Insert one skb into qdisc.
 * Note: parent depends on return value to account for queue length.
 * 	NET_XMIT_DROP: queue length didn't change.
 *      NET_XMIT_SUCCESS: one skb was queued.
 */
L
Linus Torvalds 已提交
306 307 308
static int netem_enqueue(struct sk_buff *skb, struct Qdisc *sch)
{
	struct netem_sched_data *q = qdisc_priv(sch);
309 310
	/* We don't fill cb now as skb_unshare() may invalidate it */
	struct netem_skb_cb *cb;
311
	struct sk_buff *skb2;
L
Linus Torvalds 已提交
312
	int ret;
313
	int count = 1;
L
Linus Torvalds 已提交
314

315 316 317 318
	/* Random duplication */
	if (q->duplicate && q->duplicate >= get_crandom(&q->dup_cor))
		++count;

319 320
	/* Drop packet? */
	if (loss_event(q))
321 322 323
		--count;

	if (count == 0) {
L
Linus Torvalds 已提交
324 325
		sch->qstats.drops++;
		kfree_skb(skb);
326
		return NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
L
Linus Torvalds 已提交
327 328
	}

329 330
	skb_orphan(skb);

331 332 333 334 335 336
	/*
	 * If we need to duplicate packet, then re-insert at top of the
	 * qdisc tree, since parent queuer expects that only one
	 * skb will be queued.
	 */
	if (count > 1 && (skb2 = skb_clone(skb, GFP_ATOMIC)) != NULL) {
337
		struct Qdisc *rootq = qdisc_root(sch);
338 339 340
		u32 dupsave = q->duplicate; /* prevent duplicating a dup... */
		q->duplicate = 0;

341
		qdisc_enqueue_root(skb2, rootq);
342
		q->duplicate = dupsave;
L
Linus Torvalds 已提交
343 344
	}

345 346 347 348 349 350 351
	/*
	 * Randomized packet corruption.
	 * Make copy if needed since we are modifying
	 * If packet is going to be hardware checksummed, then
	 * do it now in software before we mangle it.
	 */
	if (q->corrupt && q->corrupt >= get_crandom(&q->corrupt_cor)) {
352 353 354
		if (!(skb = skb_unshare(skb, GFP_ATOMIC)) ||
		    (skb->ip_summed == CHECKSUM_PARTIAL &&
		     skb_checksum_help(skb))) {
355 356 357 358 359 360 361
			sch->qstats.drops++;
			return NET_XMIT_DROP;
		}

		skb->data[net_random() % skb_headlen(skb)] ^= 1<<(net_random() % 8);
	}

362
	cb = netem_skb_cb(skb);
E
Eric Dumazet 已提交
363 364
	if (q->gap == 0 ||		/* not doing reordering */
	    q->counter < q->gap ||	/* inside last reordering gap */
365
	    q->reorder < get_crandom(&q->reorder_cor)) {
366
		psched_time_t now;
S
Stephen Hemminger 已提交
367 368 369 370 371
		psched_tdiff_t delay;

		delay = tabledist(q->latency, q->jitter,
				  &q->delay_cor, q->delay_dist);

372
		now = psched_get_time();
373
		cb->time_to_send = now + delay;
L
Linus Torvalds 已提交
374
		++q->counter;
375
		ret = qdisc_enqueue(skb, q->qdisc);
L
Linus Torvalds 已提交
376
	} else {
377
		/*
378 379 380
		 * Do re-ordering by putting one out of N packets at the front
		 * of the queue.
		 */
381
		cb->time_to_send = psched_get_time();
382
		q->counter = 0;
383 384 385 386 387

		__skb_queue_head(&q->qdisc->q, skb);
		q->qdisc->qstats.backlog += qdisc_pkt_len(skb);
		q->qdisc->qstats.requeues++;
		ret = NET_XMIT_SUCCESS;
L
Linus Torvalds 已提交
388 389
	}

390 391 392 393 394
	if (ret != NET_XMIT_SUCCESS) {
		if (net_xmit_drop_count(ret)) {
			sch->qstats.drops++;
			return ret;
		}
395
	}
L
Linus Torvalds 已提交
396

397 398
	sch->q.qlen++;
	return NET_XMIT_SUCCESS;
L
Linus Torvalds 已提交
399 400
}

E
Eric Dumazet 已提交
401
static unsigned int netem_drop(struct Qdisc *sch)
L
Linus Torvalds 已提交
402 403
{
	struct netem_sched_data *q = qdisc_priv(sch);
404
	unsigned int len = 0;
L
Linus Torvalds 已提交
405

406
	if (q->qdisc->ops->drop && (len = q->qdisc->ops->drop(q->qdisc)) != 0) {
L
Linus Torvalds 已提交
407 408 409 410 411 412 413 414 415 416 417
		sch->q.qlen--;
		sch->qstats.drops++;
	}
	return len;
}

static struct sk_buff *netem_dequeue(struct Qdisc *sch)
{
	struct netem_sched_data *q = qdisc_priv(sch);
	struct sk_buff *skb;

418
	if (qdisc_is_throttled(sch))
419 420
		return NULL;

421
	skb = q->qdisc->ops->peek(q->qdisc);
422
	if (skb) {
423
		const struct netem_skb_cb *cb = netem_skb_cb(skb);
424
		psched_time_t now = psched_get_time();
425 426

		/* if more time remaining? */
P
Patrick McHardy 已提交
427
		if (cb->time_to_send <= now) {
428 429
			skb = qdisc_dequeue_peeked(q->qdisc);
			if (unlikely(!skb))
430 431
				return NULL;

432 433 434 435 436 437 438 439
#ifdef CONFIG_NET_CLS_ACT
			/*
			 * If it's at ingress let's pretend the delay is
			 * from the network (tstamp will be updated).
			 */
			if (G_TC_FROM(skb->tc_verd) & AT_INGRESS)
				skb->tstamp.tv64 = 0;
#endif
440

441
			sch->q.qlen--;
442 443
			qdisc_unthrottled(sch);
			qdisc_bstats_update(sch, skb);
444
			return skb;
S
Stephen Hemminger 已提交
445
		}
446 447

		qdisc_watchdog_schedule(&q->watchdog, cb->time_to_send);
448 449 450
	}

	return NULL;
L
Linus Torvalds 已提交
451 452 453 454 455 456 457 458
}

static void netem_reset(struct Qdisc *sch)
{
	struct netem_sched_data *q = qdisc_priv(sch);

	qdisc_reset(q->qdisc);
	sch->q.qlen = 0;
459
	qdisc_watchdog_cancel(&q->watchdog);
L
Linus Torvalds 已提交
460 461
}

462 463 464 465 466 467 468 469 470 471
static void dist_free(struct disttable *d)
{
	if (d) {
		if (is_vmalloc_addr(d))
			vfree(d);
		else
			kfree(d);
	}
}

L
Linus Torvalds 已提交
472 473 474 475
/*
 * Distribution data is a variable size payload containing
 * signed 16 bit values.
 */
476
static int get_dist_table(struct Qdisc *sch, const struct nlattr *attr)
L
Linus Torvalds 已提交
477 478
{
	struct netem_sched_data *q = qdisc_priv(sch);
479
	size_t n = nla_len(attr)/sizeof(__s16);
480
	const __s16 *data = nla_data(attr);
481
	spinlock_t *root_lock;
L
Linus Torvalds 已提交
482 483
	struct disttable *d;
	int i;
484
	size_t s;
L
Linus Torvalds 已提交
485

S
stephen hemminger 已提交
486
	if (n > NETEM_DIST_MAX)
L
Linus Torvalds 已提交
487 488
		return -EINVAL;

489 490 491 492
	s = sizeof(struct disttable) + n * sizeof(s16);
	d = kmalloc(s, GFP_KERNEL);
	if (!d)
		d = vmalloc(s);
L
Linus Torvalds 已提交
493 494 495 496 497 498
	if (!d)
		return -ENOMEM;

	d->size = n;
	for (i = 0; i < n; i++)
		d->table[i] = data[i];
499

500
	root_lock = qdisc_root_sleeping_lock(sch);
501 502

	spin_lock_bh(root_lock);
503
	dist_free(q->delay_dist);
504
	q->delay_dist = d;
505
	spin_unlock_bh(root_lock);
L
Linus Torvalds 已提交
506 507 508
	return 0;
}

509
static void get_correlation(struct Qdisc *sch, const struct nlattr *attr)
L
Linus Torvalds 已提交
510 511
{
	struct netem_sched_data *q = qdisc_priv(sch);
512
	const struct tc_netem_corr *c = nla_data(attr);
L
Linus Torvalds 已提交
513 514 515 516 517 518

	init_crandom(&q->delay_cor, c->delay_corr);
	init_crandom(&q->loss_cor, c->loss_corr);
	init_crandom(&q->dup_cor, c->dup_corr);
}

519
static void get_reorder(struct Qdisc *sch, const struct nlattr *attr)
520 521
{
	struct netem_sched_data *q = qdisc_priv(sch);
522
	const struct tc_netem_reorder *r = nla_data(attr);
523 524 525 526 527

	q->reorder = r->probability;
	init_crandom(&q->reorder_cor, r->correlation);
}

528
static void get_corrupt(struct Qdisc *sch, const struct nlattr *attr)
529 530
{
	struct netem_sched_data *q = qdisc_priv(sch);
531
	const struct tc_netem_corrupt *r = nla_data(attr);
532 533 534 535 536

	q->corrupt = r->probability;
	init_crandom(&q->corrupt_cor, r->correlation);
}

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
static int get_loss_clg(struct Qdisc *sch, const struct nlattr *attr)
{
	struct netem_sched_data *q = qdisc_priv(sch);
	const struct nlattr *la;
	int rem;

	nla_for_each_nested(la, attr, rem) {
		u16 type = nla_type(la);

		switch(type) {
		case NETEM_LOSS_GI: {
			const struct tc_netem_gimodel *gi = nla_data(la);

			if (nla_len(la) != sizeof(struct tc_netem_gimodel)) {
				pr_info("netem: incorrect gi model size\n");
				return -EINVAL;
			}

			q->loss_model = CLG_4_STATES;

			q->clg.state = 1;
			q->clg.a1 = gi->p13;
			q->clg.a2 = gi->p31;
			q->clg.a3 = gi->p32;
			q->clg.a4 = gi->p14;
			q->clg.a5 = gi->p23;
			break;
		}

		case NETEM_LOSS_GE: {
			const struct tc_netem_gemodel *ge = nla_data(la);

			if (nla_len(la) != sizeof(struct tc_netem_gemodel)) {
				pr_info("netem: incorrect gi model size\n");
				return -EINVAL;
			}

			q->loss_model = CLG_GILB_ELL;
			q->clg.state = 1;
			q->clg.a1 = ge->p;
			q->clg.a2 = ge->r;
			q->clg.a3 = ge->h;
			q->clg.a4 = ge->k1;
			break;
		}

		default:
			pr_info("netem: unknown loss type %u\n", type);
			return -EINVAL;
		}
	}

	return 0;
}

592 593 594 595
static const struct nla_policy netem_policy[TCA_NETEM_MAX + 1] = {
	[TCA_NETEM_CORR]	= { .len = sizeof(struct tc_netem_corr) },
	[TCA_NETEM_REORDER]	= { .len = sizeof(struct tc_netem_reorder) },
	[TCA_NETEM_CORRUPT]	= { .len = sizeof(struct tc_netem_corrupt) },
596
	[TCA_NETEM_LOSS]	= { .type = NLA_NESTED },
597 598
};

599 600 601 602 603
static int parse_attr(struct nlattr *tb[], int maxtype, struct nlattr *nla,
		      const struct nla_policy *policy, int len)
{
	int nested_len = nla_len(nla) - NLA_ALIGN(len);

604 605
	if (nested_len < 0) {
		pr_info("netem: invalid attributes len %d\n", nested_len);
606
		return -EINVAL;
607 608
	}

609 610 611
	if (nested_len >= nla_attr_size(0))
		return nla_parse(tb, maxtype, nla_data(nla) + NLA_ALIGN(len),
				 nested_len, policy);
612

613 614 615 616
	memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
	return 0;
}

617
/* Parse netlink message to set options */
618
static int netem_change(struct Qdisc *sch, struct nlattr *opt)
L
Linus Torvalds 已提交
619 620
{
	struct netem_sched_data *q = qdisc_priv(sch);
621
	struct nlattr *tb[TCA_NETEM_MAX + 1];
L
Linus Torvalds 已提交
622 623
	struct tc_netem_qopt *qopt;
	int ret;
624

625
	if (opt == NULL)
L
Linus Torvalds 已提交
626 627
		return -EINVAL;

628 629
	qopt = nla_data(opt);
	ret = parse_attr(tb, TCA_NETEM_MAX, opt, netem_policy, sizeof(*qopt));
630 631 632
	if (ret < 0)
		return ret;

633
	ret = fifo_set_limit(q->qdisc, qopt->limit);
L
Linus Torvalds 已提交
634
	if (ret) {
635
		pr_info("netem: can't set fifo limit\n");
L
Linus Torvalds 已提交
636 637
		return ret;
	}
638

L
Linus Torvalds 已提交
639 640 641 642
	q->latency = qopt->latency;
	q->jitter = qopt->jitter;
	q->limit = qopt->limit;
	q->gap = qopt->gap;
643
	q->counter = 0;
L
Linus Torvalds 已提交
644 645 646
	q->loss = qopt->loss;
	q->duplicate = qopt->duplicate;

S
Stephen Hemminger 已提交
647 648
	/* for compatibility with earlier versions.
	 * if gap is set, need to assume 100% probability
649
	 */
650 651
	if (q->gap)
		q->reorder = ~0;
652

653 654
	if (tb[TCA_NETEM_CORR])
		get_correlation(sch, tb[TCA_NETEM_CORR]);
L
Linus Torvalds 已提交
655

656 657 658 659 660
	if (tb[TCA_NETEM_DELAY_DIST]) {
		ret = get_dist_table(sch, tb[TCA_NETEM_DELAY_DIST]);
		if (ret)
			return ret;
	}
661

662 663
	if (tb[TCA_NETEM_REORDER])
		get_reorder(sch, tb[TCA_NETEM_REORDER]);
L
Linus Torvalds 已提交
664

665 666
	if (tb[TCA_NETEM_CORRUPT])
		get_corrupt(sch, tb[TCA_NETEM_CORRUPT]);
L
Linus Torvalds 已提交
667

668 669 670 671 672
	q->loss_model = CLG_RANDOM;
	if (tb[TCA_NETEM_LOSS])
		ret = get_loss_clg(sch, tb[TCA_NETEM_LOSS]);

	return ret;
L
Linus Torvalds 已提交
673 674
}

675 676 677 678 679 680
/*
 * Special case version of FIFO queue for use by netem.
 * It queues in order based on timestamps in skb's
 */
struct fifo_sched_data {
	u32 limit;
S
Stephen Hemminger 已提交
681
	psched_time_t oldest;
682 683 684 685 686 687
};

static int tfifo_enqueue(struct sk_buff *nskb, struct Qdisc *sch)
{
	struct fifo_sched_data *q = qdisc_priv(sch);
	struct sk_buff_head *list = &sch->q;
688
	psched_time_t tnext = netem_skb_cb(nskb)->time_to_send;
689 690 691
	struct sk_buff *skb;

	if (likely(skb_queue_len(list) < q->limit)) {
S
Stephen Hemminger 已提交
692
		/* Optimize for add at tail */
P
Patrick McHardy 已提交
693
		if (likely(skb_queue_empty(list) || tnext >= q->oldest)) {
S
Stephen Hemminger 已提交
694 695 696 697
			q->oldest = tnext;
			return qdisc_enqueue_tail(nskb, sch);
		}

698
		skb_queue_reverse_walk(list, skb) {
699
			const struct netem_skb_cb *cb = netem_skb_cb(skb);
700

P
Patrick McHardy 已提交
701
			if (tnext >= cb->time_to_send)
702 703 704 705 706
				break;
		}

		__skb_queue_after(list, skb, nskb);

707
		sch->qstats.backlog += qdisc_pkt_len(nskb);
708 709 710 711

		return NET_XMIT_SUCCESS;
	}

S
Stephen Hemminger 已提交
712
	return qdisc_reshape_fail(nskb, sch);
713 714
}

715
static int tfifo_init(struct Qdisc *sch, struct nlattr *opt)
716 717 718 719
{
	struct fifo_sched_data *q = qdisc_priv(sch);

	if (opt) {
720 721
		struct tc_fifo_qopt *ctl = nla_data(opt);
		if (nla_len(opt) < sizeof(*ctl))
722 723 724 725
			return -EINVAL;

		q->limit = ctl->limit;
	} else
726
		q->limit = max_t(u32, qdisc_dev(sch)->tx_queue_len, 1);
727

728
	q->oldest = PSCHED_PASTPERFECT;
729 730 731 732 733 734 735 736
	return 0;
}

static int tfifo_dump(struct Qdisc *sch, struct sk_buff *skb)
{
	struct fifo_sched_data *q = qdisc_priv(sch);
	struct tc_fifo_qopt opt = { .limit = q->limit };

737
	NLA_PUT(skb, TCA_OPTIONS, sizeof(opt), &opt);
738 739
	return skb->len;

740
nla_put_failure:
741 742 743
	return -1;
}

744
static struct Qdisc_ops tfifo_qdisc_ops __read_mostly = {
745 746 747 748
	.id		=	"tfifo",
	.priv_size	=	sizeof(struct fifo_sched_data),
	.enqueue	=	tfifo_enqueue,
	.dequeue	=	qdisc_dequeue_head,
749
	.peek		=	qdisc_peek_head,
750 751 752 753 754 755 756
	.drop		=	qdisc_queue_drop,
	.init		=	tfifo_init,
	.reset		=	qdisc_reset_queue,
	.change		=	tfifo_init,
	.dump		=	tfifo_dump,
};

757
static int netem_init(struct Qdisc *sch, struct nlattr *opt)
L
Linus Torvalds 已提交
758 759 760 761 762 763 764
{
	struct netem_sched_data *q = qdisc_priv(sch);
	int ret;

	if (!opt)
		return -EINVAL;

765
	qdisc_watchdog_init(&q->watchdog, sch);
L
Linus Torvalds 已提交
766

767
	q->loss_model = CLG_RANDOM;
768
	q->qdisc = qdisc_create_dflt(sch->dev_queue, &tfifo_qdisc_ops,
769
				     TC_H_MAKE(sch->handle, 1));
L
Linus Torvalds 已提交
770
	if (!q->qdisc) {
771
		pr_notice("netem: qdisc create tfifo qdisc failed\n");
L
Linus Torvalds 已提交
772 773 774 775 776
		return -ENOMEM;
	}

	ret = netem_change(sch, opt);
	if (ret) {
777
		pr_info("netem: change failed\n");
L
Linus Torvalds 已提交
778 779 780 781 782 783 784 785 786
		qdisc_destroy(q->qdisc);
	}
	return ret;
}

static void netem_destroy(struct Qdisc *sch)
{
	struct netem_sched_data *q = qdisc_priv(sch);

787
	qdisc_watchdog_cancel(&q->watchdog);
L
Linus Torvalds 已提交
788
	qdisc_destroy(q->qdisc);
789
	dist_free(q->delay_dist);
L
Linus Torvalds 已提交
790 791
}

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
static int dump_loss_model(const struct netem_sched_data *q,
			   struct sk_buff *skb)
{
	struct nlattr *nest;

	nest = nla_nest_start(skb, TCA_NETEM_LOSS);
	if (nest == NULL)
		goto nla_put_failure;

	switch (q->loss_model) {
	case CLG_RANDOM:
		/* legacy loss model */
		nla_nest_cancel(skb, nest);
		return 0;	/* no data */

	case CLG_4_STATES: {
		struct tc_netem_gimodel gi = {
			.p13 = q->clg.a1,
			.p31 = q->clg.a2,
			.p32 = q->clg.a3,
			.p14 = q->clg.a4,
			.p23 = q->clg.a5,
		};

		NLA_PUT(skb, NETEM_LOSS_GI, sizeof(gi), &gi);
		break;
	}
	case CLG_GILB_ELL: {
		struct tc_netem_gemodel ge = {
			.p = q->clg.a1,
			.r = q->clg.a2,
			.h = q->clg.a3,
			.k1 = q->clg.a4,
		};

		NLA_PUT(skb, NETEM_LOSS_GE, sizeof(ge), &ge);
		break;
	}
	}

	nla_nest_end(skb, nest);
	return 0;

nla_put_failure:
	nla_nest_cancel(skb, nest);
	return -1;
}

L
Linus Torvalds 已提交
840 841 842
static int netem_dump(struct Qdisc *sch, struct sk_buff *skb)
{
	const struct netem_sched_data *q = qdisc_priv(sch);
S
stephen hemminger 已提交
843
	struct nlattr *nla = (struct nlattr *) skb_tail_pointer(skb);
L
Linus Torvalds 已提交
844 845
	struct tc_netem_qopt qopt;
	struct tc_netem_corr cor;
846
	struct tc_netem_reorder reorder;
847
	struct tc_netem_corrupt corrupt;
L
Linus Torvalds 已提交
848 849 850 851 852 853 854

	qopt.latency = q->latency;
	qopt.jitter = q->jitter;
	qopt.limit = q->limit;
	qopt.loss = q->loss;
	qopt.gap = q->gap;
	qopt.duplicate = q->duplicate;
855
	NLA_PUT(skb, TCA_OPTIONS, sizeof(qopt), &qopt);
L
Linus Torvalds 已提交
856 857 858 859

	cor.delay_corr = q->delay_cor.rho;
	cor.loss_corr = q->loss_cor.rho;
	cor.dup_corr = q->dup_cor.rho;
860
	NLA_PUT(skb, TCA_NETEM_CORR, sizeof(cor), &cor);
861 862 863

	reorder.probability = q->reorder;
	reorder.correlation = q->reorder_cor.rho;
864
	NLA_PUT(skb, TCA_NETEM_REORDER, sizeof(reorder), &reorder);
865

866 867
	corrupt.probability = q->corrupt;
	corrupt.correlation = q->corrupt_cor.rho;
868
	NLA_PUT(skb, TCA_NETEM_CORRUPT, sizeof(corrupt), &corrupt);
869

870 871 872
	if (dump_loss_model(q, skb) != 0)
		goto nla_put_failure;

S
stephen hemminger 已提交
873
	return nla_nest_end(skb, nla);
L
Linus Torvalds 已提交
874

875
nla_put_failure:
S
stephen hemminger 已提交
876
	nlmsg_trim(skb, nla);
L
Linus Torvalds 已提交
877 878 879
	return -1;
}

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
static int netem_dump_class(struct Qdisc *sch, unsigned long cl,
			  struct sk_buff *skb, struct tcmsg *tcm)
{
	struct netem_sched_data *q = qdisc_priv(sch);

	if (cl != 1) 	/* only one class */
		return -ENOENT;

	tcm->tcm_handle |= TC_H_MIN(1);
	tcm->tcm_info = q->qdisc->handle;

	return 0;
}

static int netem_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
		     struct Qdisc **old)
{
	struct netem_sched_data *q = qdisc_priv(sch);

	if (new == NULL)
		new = &noop_qdisc;

	sch_tree_lock(sch);
	*old = q->qdisc;
	q->qdisc = new;
	qdisc_tree_decrease_qlen(*old, (*old)->q.qlen);
	qdisc_reset(*old);
	sch_tree_unlock(sch);

	return 0;
}

static struct Qdisc *netem_leaf(struct Qdisc *sch, unsigned long arg)
{
	struct netem_sched_data *q = qdisc_priv(sch);
	return q->qdisc;
}

static unsigned long netem_get(struct Qdisc *sch, u32 classid)
{
	return 1;
}

static void netem_put(struct Qdisc *sch, unsigned long arg)
{
}

static void netem_walk(struct Qdisc *sch, struct qdisc_walker *walker)
{
	if (!walker->stop) {
		if (walker->count >= walker->skip)
			if (walker->fn(sch, 1, walker) < 0) {
				walker->stop = 1;
				return;
			}
		walker->count++;
	}
}

static const struct Qdisc_class_ops netem_class_ops = {
	.graft		=	netem_graft,
	.leaf		=	netem_leaf,
	.get		=	netem_get,
	.put		=	netem_put,
	.walk		=	netem_walk,
	.dump		=	netem_dump_class,
};

948
static struct Qdisc_ops netem_qdisc_ops __read_mostly = {
L
Linus Torvalds 已提交
949
	.id		=	"netem",
950
	.cl_ops		=	&netem_class_ops,
L
Linus Torvalds 已提交
951 952 953
	.priv_size	=	sizeof(struct netem_sched_data),
	.enqueue	=	netem_enqueue,
	.dequeue	=	netem_dequeue,
954
	.peek		=	qdisc_peek_dequeued,
L
Linus Torvalds 已提交
955 956 957 958 959 960 961 962 963 964 965 966
	.drop		=	netem_drop,
	.init		=	netem_init,
	.reset		=	netem_reset,
	.destroy	=	netem_destroy,
	.change		=	netem_change,
	.dump		=	netem_dump,
	.owner		=	THIS_MODULE,
};


static int __init netem_module_init(void)
{
S
Stephen Hemminger 已提交
967
	pr_info("netem: version " VERSION "\n");
L
Linus Torvalds 已提交
968 969 970 971 972 973 974 975 976
	return register_qdisc(&netem_qdisc_ops);
}
static void __exit netem_module_exit(void)
{
	unregister_qdisc(&netem_qdisc_ops);
}
module_init(netem_module_init)
module_exit(netem_module_exit)
MODULE_LICENSE("GPL");