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