vde-2/man/wirefilter.1

   1 .TH WIREFILTER 1 "December 6, 2006" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 wirefilter \- Wire packet filter for Virtual Distributed Ethernet
   4 .SH SYNOPSIS
   5 .B wirefilter
   6
   7 [\fB\-l\fI loss\fR]
   8 [\fB\-d\fI delay\fR]
   9 [\fB\-D\fI dup\fR]
  10 [\fB\-b\fI bandwidth\fR]
  11 [\fB\-s\fI interface_speed\fR]
  12 [\fB\-c\fI channel_capacity\fR]
  13 [\fB\-n\fI noise_factor\fR]
  14 [\fB\-m\fI mtu_size\fR]
  15 [\fB\-M\fI mgmt socket\fR]
  16 [\fB\-v\fI vde_plug1:vde_plug2\fR]
  17 [\fB-N\fR]
  18 .br
  19 .SH DESCRIPTION
  20 A
  21 \fBwirefilter\fP
  22 is able to emulate delays and packet loss on virtual wires.
  23 e.g.:
  24
  25 .B
  26 dpipe vde_plug /tmp/s1 = wirefilter -l 10 = vde_plug /tmp/s2
  27
  28 creates a wire between two vde_switches (with sockets /tmp/s1 and /tmp/s2
  29 respectively). This cable looses 10% of the packets in each direction.
  30
  31 The same cable can be created using:
  32
  33 .B
  34 wirefilter -v /tmp/s1:/tmp/s2 -l 10
  35
  36 .SH OPTIONS
  37 .TP
  38 .B \-l "\fIloss\fP"
  39 percentage of loss as a floating point number. It is possible to specify
  40 different loss percentage for the two channels: LR20.5 means 20.5% of packet
  41 flowing left to right are lost, RL10 means 10% from right to left.
  42 .TP
  43 .B \-d "\fIdelay\fP"
  44 Extra delay (in milliseconds). This delay is added to the real communication delay.
  45 Packets are temporarily stored and resent after the delay.
  46 It is possible to specify different values for LR and RL like in the previous option.
  47 When the delay is specified as two numbers with a + in between, the first is the standard
  48 delay and the second is a random variation. 1000+500 means that the delay can be
  49 randomly chosen between half second and 1.5 seconds.
  50 .TP
  51 .B \-D "\fIdup\fP"
  52 percentage of dup packet. It has the same syntax of -l. Do not use dup factor 100%
  53 because it means that each packet is sent infinite times.
  54 .TP
  55 .B \-b "\fIbandwidth\fP"
  56 Channel bandwidth in Bytes/sec. It has the same syntax of -d. It is also possible to
  57 use suffixes K,M,G to abbreviate 2^10, 2^20, 2^30.
  58 128K means 128KBytes/sec. 128+64K means 64i to 196KBytes/sec.
  59 Sender is not prevented from sending packets, delivery is delayed to limit the bandwidth
  60 to the desired value. (Like a bottleneck along the path)
  61 .TP
  62 .B \-s "\fIspeed\fP"
  63 Interface speed in Bytes/sec. It has the same syntax of -b. Input is blocked for
  64 the tramission time of the packet, thus the sender is prevented from sending too fast.
  65 .TP
  66 .B \-c "\fIcapacity\fP"
  67 Channel capacity (in Bytes): maximum size of the packet queue. Exceeding packets
  68 are discarded.
  69 .TP
  70 .B \-n "\fInoise factor\fP"
  71 Number of bits damaged/one megabyte.
  72 .TP
  73 .B \-m "\fImtu size\fP"
  74 Packets longer than mtu_size are discarded.
  75 .TP
  76 .B \-N
  77 nofifo. with -N packets can be reordered.
  78 .TP
  79 .B \-M "\fImgmt socket\fP"
  80 the unix socket where the parameters (loss percentage, delay etc) can be checked and
  81 changed runtime. unixterm(1) can be used as a remote terminal for wirefilter.
  82 .TP
  83 .B \-v "\fIvde_plug1:vde_plug2\fP"
  84 If this option is used, the two local vde_plugs (vde_plug1 and vde_plug2) will be connected each other instead of stdin/stdout,
  85 using the libvdeplug libraries.
  86 .SH NOTICE
  87 Virtual Distributed Ethernet is not related in any way with
  88 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
  89 i.e. the German "Association for Electrical, Electronic & Information
  90 Technologies").
  91
  92 .SH SEE ALSO
  93 \fBvde_switch\fP(1),
  94 \fBvdeq\fP(1).
  95 \fBdpipe\fP(1).
  96 \fBunixterm\fP(1).
  97 .br
  98 .SH AUTHOR
  99 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>