Documentation/networking/pktgen.txt

   1
   2
   3                   HOWTO for the linux packet generator
   4                   ------------------------------------
   5
   6 Date: 041221
   7
   8 Enable CONFIG_NET_PKTGEN to compile and build pktgen.o either in kernel
   9 or as module. Module is preferred. insmod pktgen if needed. Once running
  10 pktgen creates a thread on each CPU where each thread has affinty it's CPU.
  11 Monitoring and controlling is done via /proc. Easiest to select a suitable
  12 a sample script and configure.
  13
  14 On a dual CPU:
  15
  16 ps aux | grep pkt
  17 root       129  0.3  0.0     0    0 ?        SW    2003 523:20 [pktgen/0]
  18 root       130  0.3  0.0     0    0 ?        SW    2003 509:50 [pktgen/1]
  19
  20
  21 For montoring and control pktgen creates:
  22         /proc/net/pktgen/pgctrl
  23         /proc/net/pktgen/kpktgend_X
  24         /proc/net/pktgen/ethX
  25
  26
  27 Viewing threads
  28 ===============
  29 /proc/net/pktgen/kpktgend_0
  30 Name: kpktgend_0  max_before_softirq: 10000
  31 Running:
  32 Stopped: eth1
  33 Result: OK: max_before_softirq=10000
  34
  35 Most important the devices assigend to thread. Note! A device can only belong
  36 to one thread.
  37
  38
  39 Viewing devices
  40 ===============
  41
  42 Parm section holds configured info. Current hold running stats.
  43 Result is printed after run or after interruption. Example:
  44
  45 /proc/net/pktgen/eth1
  46
  47 Params: count 10000000  min_pkt_size: 60  max_pkt_size: 60
  48      frags: 0  delay: 0  clone_skb: 1000000  ifname: eth1
  49      flows: 0 flowlen: 0
  50      dst_min: 10.10.11.2  dst_max:
  51      src_min:   src_max:
  52      src_mac: 00:00:00:00:00:00  dst_mac: 00:04:23:AC:FD:82
  53      udp_src_min: 9  udp_src_max: 9  udp_dst_min: 9  udp_dst_max: 9
  54      src_mac_count: 0  dst_mac_count: 0
  55      Flags:
  56 Current:
  57      pkts-sofar: 10000000  errors: 39664
  58      started: 1103053986245187us  stopped: 1103053999346329us idle: 880401us
  59      seq_num: 10000011  cur_dst_mac_offset: 0  cur_src_mac_offset: 0
  60      cur_saddr: 0x10a0a0a  cur_daddr: 0x20b0a0a
  61      cur_udp_dst: 9  cur_udp_src: 9
  62      flows: 0
  63 Result: OK: 13101142(c12220741+d880401) usec, 10000000 (60byte,0frags)
  64   763292pps 390Mb/sec (390805504bps) errors: 39664
  65
  66 Confguring threads and devices
  67 ==============================
  68 This is done via the /proc interface easiest done via pgset in the scripts
  69
  70 Examples:
  71
  72  pgset "clone_skb 1"     sets the number of copies of the same packet
  73  pgset "clone_skb 0"     use single SKB for all transmits
  74  pgset "pkt_size 9014"   sets packet size to 9014
  75  pgset "frags 5"         packet will consist of 5 fragments
  76  pgset "count 200000"    sets number of packets to send, set to zero
  77                          for continious sends untill explicitl stopped.
  78
  79  pgset "delay 5000"      adds delay to hard_start_xmit(). nanoseconds
  80
  81  pgset "dst 10.0.0.1"    sets IP destination address
  82                          (BEWARE! This generator is very aggressive!)
  83
  84  pgset "dst_min 10.0.0.1"            Same as dst
  85  pgset "dst_max 10.0.0.254"          Set the maximum destination IP.
  86  pgset "src_min 10.0.0.1"            Set the minimum (or only) source IP.
  87  pgset "src_max 10.0.0.254"          Set the maximum source IP.
  88  pgset "dst6 fec0::1"     IPV6 destination address
  89  pgset "src6 fec0::2"     IPV6 source address
  90  pgset "dstmac 00:00:00:00:00:00"    sets MAC destination address
  91  pgset "srcmac 00:00:00:00:00:00"    sets MAC source address
  92
  93  pgset "src_mac_count 1" Sets the number of MACs we'll range through.
  94                          The 'minimum' MAC is what you set with srcmac.
  95
  96  pgset "dst_mac_count 1" Sets the number of MACs we'll range through.
  97                          The 'minimum' MAC is what you set with dstmac.
  98
  99  pgset "flag [name]"     Set a flag to determine behaviour.  Current flags
 100                          are: IPSRC_RND #IP Source is random (between min/max),
 101                               IPDST_RND, UDPSRC_RND,
 102                               UDPDST_RND, MACSRC_RND, MACDST_RND
 103
 104  pgset "udp_src_min 9"   set UDP source port min, If < udp_src_max, then
 105                          cycle through the port range.
 106
 107  pgset "udp_src_max 9"   set UDP source port max.
 108  pgset "udp_dst_min 9"   set UDP destination port min, If < udp_dst_max, then
 109                          cycle through the port range.
 110  pgset "udp_dst_max 9"   set UDP destination port max.
 111
 112  pgset stop               aborts injection. Also, ^C aborts generator.
 113
 114
 115 Example scripts
 116 ===============
 117
 118 A collection of small tutorial scripts for pktgen is in expamples dir.
 119
 120 pktgen.conf-1-1                  # 1 CPU 1 dev
 121 pktgen.conf-1-2                  # 1 CPU 2 dev
 122 pktgen.conf-2-1                  # 2 CPU's 1 dev
 123 pktgen.conf-2-2                  # 2 CPU's 2 dev
 124 pktgen.conf-1-1-rdos             # 1 CPU 1 dev w. route DoS
 125 pktgen.conf-1-1-ip6              # 1 CPU 1 dev ipv6
 126 pktgen.conf-1-1-ip6-rdos         # 1 CPU 1 dev ipv6  w. route DoS
 127 pktgen.conf-1-1-flows            # 1 CPU 1 dev multiple flows.
 128
 129 Run in shell: ./pktgen.conf-X-Y It does all the setup including sending.
 130
 131
 132 Interrupt affinity
 133 ===================
 134 Note when adding devices to a specific CPU there good idea to also assign
 135 /proc/irq/XX/smp_affinity so the TX-interrupts gets bound to the same CPU.
 136 as this reduces cache bouncing when freeing skb's.
 137
 138
 139 Current commands and configuration options
 140 ==========================================
 141
 142 ** Pgcontrol commands:
 143
 144 start
 145 stop
 146
 147 ** Thread commands:
 148
 149 add_device
 150 rem_device_all
 151 max_before_softirq
 152
 153
 154 ** Device commands:
 155
 156 count
 157 clone_skb
 158 debug
 159
 160 frags
 161 delay
 162
 163 src_mac_count
 164 dst_mac_count
 165
 166 pkt_size
 167 min_pkt_size
 168 max_pkt_size
 169
 170 udp_src_min
 171 udp_src_max
 172
 173 udp_dst_min
 174 udp_dst_max
 175
 176 flag
 177   IPSRC_RND
 178   TXSIZE_RND
 179   IPDST_RND
 180   UDPSRC_RND
 181   UDPDST_RND
 182   MACSRC_RND
 183   MACDST_RND
 184
 185 dst_min
 186 dst_max
 187
 188 src_min
 189 src_max
 190
 191 dst_mac
 192 src_mac
 193
 194 clear_counters
 195
 196 dst6
 197 src6
 198
 199 flows
 200 flowlen
 201
 202 References:
 203 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
 204 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
 205
 206 Paper from Linux-Kongress in Erlangen 2004.
 207 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
 208
 209 Thanks to:
 210 Grant Grundler for testing on IA-64 and parisc, Harald Welte,  Lennert Buytenhek
 211 Stephen Hemminger, Andi Kleen, Dave Miller and many others.
 212
 213
 214 Good luck with the linux net-development.