Documentation/Manpages/trafgen.8

   1 =head1 NAME
   2
   3 trafgen - a high-performance zero-copy network packet generator
   4
   5 =head1 SYNOPSIS
   6
   7 trafgen [-d|--dev <netdev>][-c|--conf <file>][-J|--jumbo-support]
   8         [-n|--num <uint>][-r|--rand][-t|--gap <usec>]
   9         [-S|--ring-size <size>][-k|--kernel-pull <usec>][-b|--bind-cpu <cpu>]
  10         [-B|--unbind-cpu <cpu>][-H|--prio-high][-Q|--notouch-irq][-v|--version]
  11         [-h|--help]
  12
  13 =head1 DESCRIPTION
  14
  15 A high-performance network traffic generator that uses the zero-copy TX_RING
  16 for network I/O. For instance, on comodity Gigabit hardware up to 1,488,095 pps
  17 64 Byte pps have been achieved with trafgen.
  18
  19 =head1 OPTIONS
  20
  21 =over
  22
  23 =item trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0
  24
  25 Use packet configuration trafgen.txf, eth0 as transmission device and CPU0
  26 for binding the process.
  27
  28 =back
  29
  30 =head1 OPTIONS
  31
  32 =over
  33
  34 =item -h|--help
  35
  36 Print help text and lists all options.
  37
  38 =item -v|--version
  39
  40 Print version.
  41
  42 =item -d|--dev <netdev>
  43
  44 Device for transmission i.e., eth0.
  45
  46 =item -c|--conf <conf>
  47
  48 Path to packet configuration file.
  49
  50 =item -J|--jumbo-support
  51
  52 Support for 64KB Super Jumbo Frames
  53
  54 =item -n|--num <uint>
  55
  56 Number of packets to generate before exiting.
  57 0 means forever until SIGINT.
  58
  59 =item -r|--rand
  60
  61 Randomize packet selection process instead of round-robin.
  62
  63 =item -t|--gap <uint>
  64
  65 Interpacket gap in microseconds.
  66
  67 =item -S|--ring-size <size>
  68
  69 Manually set ring size to <size>: mmap space in KB/MB/GB.
  70
  71 =item -k|--kernel-pull <uint>
  72
  73 Kernel pull from user interval in microseconds.
  74 Default value is 10 microseconds.
  75
  76 =item -b|--bind-cpu <cpu>
  77
  78 Bind to specific CPU (or CPU-range).
  79
  80 =item -B|--unbind-cpu <cpu>
  81
  82 Forbid to use specific CPU (or CPU-range).
  83
  84 =item -H|--prio-high
  85
  86 Make this high priority process.
  87
  88 =item -Q|--notouch-irq
  89
  90 Do not touch IRQ CPU affinity of NIC.
  91
  92 =back
  93
  94 =head1 EXAMPLES
  95
  96 =over
  97
  98 =item Generate traffic defined in trafgen.txf on eth0 using CPU 0
  99
 100 trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0
 101
 102 =item Generate traffic on eth0 using CPU 0, wait 100 us between packets
 103
 104 trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0 --gap 100
 105
 106 =item Generate 100,000 packet on eth0 using CPU 0
 107
 108 trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0 --num 100000
 109
 110 =back
 111
 112 =head1 AUTHOR
 113
 114 Written by Daniel Borkmann <daniel@netsniff-ng.org>
 115
 116 =head1 DOCUMENTATION
 117
 118 Documentation by Emmanuel Roullit <emmanuel@netsniff-ng.org>
 119
 120 =head1 BUGS
 121
 122 Please report bugs to <bugs@netsniff-ng.org>
 123
 124 =cut