man/man8/tc-netem.8

   1 .TH NETEM 8 "25 November 2011" "iproute2" "Linux"
   2 .SH NAME
   3 NetEm \- Network Emulator
   4 .SH SYNOPSIS
   5 .B "tc qdisc ... dev"
   6 .IR dev " ] "
   7 .BR "add netem"
   8 .I OPTIONS
   9
  10 .IR OPTIONS " := [ " LIMIT " ] [ " DELAY " ] [ " LOSS \
  11 " ] [ " CORRUPT " ] [ " DUPLICATION " ] [ " REORDERING " ]"
  12
  13 .IR LIMIT " := "
  14 .B limit
  15 .I packets
  16
  17 .IR DELAY " := "
  18 .BI delay
  19 .IR TIME " [ " JITTER " [ " CORRELATION " ]]]"
  20 .br
  21        [
  22 .BR distribution " { "uniform " | " normal " | " pareto " |  " paretonormal " } ]"
  23
  24 .IR LOSS " := "
  25 .BR loss " { "
  26 .BI random
  27 .IR PERCENT " [ " CORRELATION " ]  |"
  28 .br
  29 .RB "               " state
  30 .IR p13 " [ " p31 " [ " p32 " [ " p23 " [ " p14 "]]]] |"
  31 .br
  32 .RB "               " gemodel
  33 .IR p " [ " r " [ " 1-h " [ " 1-k " ]]]"
  34 .BR " }"
  35
  36 .IR CORRUPT " := "
  37 .B corrupt
  38 .IR PERCENT " [ " CORRELATION " ]]"
  39
  40 .IR DUPLICATION " := "
  41 .B duplicate
  42 .IR PERCENT " [ " CORRELATION " ]]"
  43
  44 .IR REODERING " := "
  45 .B reorder
  46 .IR PERCENT " [ " CORRELATION " ] [ "
  47 .B gap
  48 .IR DISTANCE " ]"
  49
  50 .SH DESCRIPTION
  51 NetEm is an enhancement of the Linux traffic control facilities
  52 that allow to add delay, packet loss, duplication and more other
  53 characteristics to packets outgoing from a selected network
  54 interface. NetEm is build using the existing Quality Of Service (QOS)
  55 and Differentiated Services (diffserv) facilities in the Linux
  56 kernel.
  57
  58 .SH netem OPTIONS
  59 netem has the following options:
  60
  61 .SS limit packets
  62
  63 limits the effect of selected options to the indicated number of next packets.
  64
  65 .SS delay
  66 adds the chosen delay to the packets outgoing to chosen network interface. The
  67 optional parameters allows to introduce a delay variation and a correlation.
  68 Delay and jitter values are expressed in ms while correlation is percentage.
  69
  70 .SS distribution
  71 allow the choose the delay distribution. If not specified, the default
  72 distribution is normal. Additional parameters allow to consider situations in
  73 which network has variable delays depending on traffic flows concurring on the
  74 same path, that causes severeal delay peaks and a tail.
  75
  76 .SS loss random
  77 adds an independent loss probability to the packets outgoing from the chosen
  78 network interface. It is also possibile to add a correlation, but this option
  79 is now deprecated due to the noticed bad behaviour.
  80
  81 .SS loss state
  82 adds packet losses according to the 4-state Markov using the transition
  83 probabilities as input parameters. The parameters p13 is mandatory and if used
  84 alone corresponds to the Bernoulli model. The optional parameters allows to
  85 extend the model to 2-state (p31), 3-state (p23 and p32) and 4-state (p14).
  86 State 1 corresponds to good reception, State 4 to independent losses, State 3
  87 to burst losses and State 2 to good reception within a burst.
  88
  89 .SS loss gemodel
  90 adds packet losses according to the Gilbert-Elliot loss model or its special
  91 cases (Gilbert, Simple Gilbert and Bernoulli). To use the Bernoulli model, the
  92 only needed parameter is p while the the others will be set to the default
  93 values r=1-p, 1-h=1 and 1-k=0. The parameters needed for the Simple Gilbert
  94 model are two (p and r), while three parameters (p, r, 1-h) are needed for the
  95 Gilbert model and four (p, r, 1-h and 1-k) are needed for the Gilbert-Elliot
  96 model. As known, p and r are the transition probabilities between the bad and
  97 the good states, 1-h is the loss probability in the bad state and 1-k is the
  98 loss probability in the good state.
  99
 100 .SS corrupt
 101 allows the emulate the random noise introducing an error in a random position
 102 for a chosen percent of packets. It is also possible to add a correlation
 103 through the proper parameter.
 104
 105 .SS duplicate
 106 using this option the chosen percent of packets is duplicated before queueing
 107 them. It is also possible to add a correlation through the proper parameter.
 108
 109 .SS reorder
 110 there are two ways to use this option:
 111
 112 .B "reorder gap"
 113 .I 5 10
 114 .br
 115 in this first example every 5th (10th, 15th) packet is sent immediately while
 116 other packets are delayed by 10 ms
 117
 118 .B reorder
 119 .I 25% 50%
 120 .br
 121 in this second example 25% of packets are sent immediately (with correlation of
 122 50%) while the other are delayed by 10 ms.
 123
 124 .SH LIMITATIONS
 125 The main known limitation of Netem are related to timer granularity, since
 126 Linux is not a real-time operating system.
 127
 128 .SH SOURCES
 129 .IP " 1. " 4
 130 Hemminger S. , "Network Emulation with NetEm", Open Source Development Lab,
 131 April 2005
 132 (http://devresources.linux-foundation.org/shemminger/netem/LCA2005_paper.pdf)
 133
 134 .IP " 2. " 4
 135 Netem page from Linux foundation, (http://www.linuxfoundation.org/en/Net:Netem)
 136
 137 .IP " 3. " 4
 138 Salsano S., Ludovici F., Ordine A., "Definition of a general and intuitive loss
 139 model for packet networks and its implementation in the Netem module in the
 140 Linux kernel", available at http://netgroup.uniroma2.it/NetemCLG
 141
 142 .SH SEE ALSO
 143 .BR tc (8),
 144 .BR tc-tbf (8)
 145
 146 .SH AUTHOR
 147 Netem was written by Stephen Hemminger at Linux foundation and is based on NISTnet.
 148 This manpage was created by Fabio Ludovici <fabio.ludovici at yahoo dot it> and
 149 Hagen Paul Pfeifer <hagen@jauu.net>