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 affinity to its 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 monitoring 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 assigned 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 Configuring 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 continuous sends until explicitly 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 "queue_map_min 0" Sets the min value of tx queue interval
  94  pgset "queue_map_max 7" Sets the max value of tx queue interval, for multiqueue devices
  95                          To select queue 1 of a given device,
  96                          use queue_map_min=1 and queue_map_max=1
  97
  98  pgset "src_mac_count 1" Sets the number of MACs we'll range through.
  99                          The 'minimum' MAC is what you set with srcmac.
 100
 101  pgset "dst_mac_count 1" Sets the number of MACs we'll range through.
 102                          The 'minimum' MAC is what you set with dstmac.
 103
 104  pgset "flag [name]"     Set a flag to determine behaviour.  Current flags
 105                          are: IPSRC_RND #IP Source is random (between min/max),
 106                               IPDST_RND, UDPSRC_RND,
 107                               UDPDST_RND, MACSRC_RND, MACDST_RND
 108                               MPLS_RND, VID_RND, SVID_RND
 109                               QUEUE_MAP_RND # queue map random
 110                               QUEUE_MAP_CPU # queue map mirrors smp_processor_id()
 111                               IPSEC # Make IPsec encapsulation for packet
 112
 113  pgset spi SPI_VALUE     Set specific SA used to transform packet.
 114
 115  pgset "udp_src_min 9"   set UDP source port min, If < udp_src_max, then
 116                          cycle through the port range.
 117
 118  pgset "udp_src_max 9"   set UDP source port max.
 119  pgset "udp_dst_min 9"   set UDP destination port min, If < udp_dst_max, then
 120                          cycle through the port range.
 121  pgset "udp_dst_max 9"   set UDP destination port max.
 122
 123  pgset "mpls 0001000a,0002000a,0000000a" set MPLS labels (in this example
 124                                          outer label=16,middle label=32,
 125                                          inner label=0 (IPv4 NULL)) Note that
 126                                          there must be no spaces between the
 127                                          arguments. Leading zeros are required.
 128                                          Do not set the bottom of stack bit,
 129                                          that's done automatically. If you do
 130                                          set the bottom of stack bit, that
 131                                          indicates that you want to randomly
 132                                          generate that address and the flag
 133                                          MPLS_RND will be turned on. You
 134                                          can have any mix of random and fixed
 135                                          labels in the label stack.
 136
 137  pgset "mpls 0"           turn off mpls (or any invalid argument works too!)
 138
 139  pgset "vlan_id 77"       set VLAN ID 0-4095
 140  pgset "vlan_p 3"         set priority bit 0-7 (default 0)
 141  pgset "vlan_cfi 0"       set canonical format identifier 0-1 (default 0)
 142
 143  pgset "svlan_id 22"      set SVLAN ID 0-4095
 144  pgset "svlan_p 3"        set priority bit 0-7 (default 0)
 145  pgset "svlan_cfi 0"      set canonical format identifier 0-1 (default 0)
 146
 147  pgset "vlan_id 9999"     > 4095 remove vlan and svlan tags
 148  pgset "svlan 9999"       > 4095 remove svlan tag
 149
 150
 151  pgset "tos XX"           set former IPv4 TOS field (e.g. "tos 28" for AF11 no ECN, default 00)
 152  pgset "traffic_class XX" set former IPv6 TRAFFIC CLASS (e.g. "traffic_class B8" for EF no ECN, default 00)
 153
 154  pgset stop               aborts injection. Also, ^C aborts generator.
 155
 156  pgset "rate 300M"        set rate to 300 Mb/s
 157  pgset "ratep 1000000"    set rate to 1Mpps
 158
 159 Example scripts
 160 ===============
 161
 162 A collection of small tutorial scripts for pktgen is in examples dir.
 163
 164 pktgen.conf-1-1                  # 1 CPU 1 dev
 165 pktgen.conf-1-2                  # 1 CPU 2 dev
 166 pktgen.conf-2-1                  # 2 CPU's 1 dev
 167 pktgen.conf-2-2                  # 2 CPU's 2 dev
 168 pktgen.conf-1-1-rdos             # 1 CPU 1 dev w. route DoS
 169 pktgen.conf-1-1-ip6              # 1 CPU 1 dev ipv6
 170 pktgen.conf-1-1-ip6-rdos         # 1 CPU 1 dev ipv6  w. route DoS
 171 pktgen.conf-1-1-flows            # 1 CPU 1 dev multiple flows.
 172
 173 Run in shell: ./pktgen.conf-X-Y It does all the setup including sending.
 174
 175
 176 Interrupt affinity
 177 ===================
 178 Note when adding devices to a specific CPU there good idea to also assign
 179 /proc/irq/XX/smp_affinity so the TX-interrupts gets bound to the same CPU.
 180 as this reduces cache bouncing when freeing skb's.
 181
 182 Enable IPsec
 183 ============
 184 Default IPsec transformation with ESP encapsulation plus Transport mode
 185 could be enabled by simply setting:
 186
 187 pgset "flag IPSEC"
 188 pgset "flows 1"
 189
 190 To avoid breaking existing testbed scripts for using AH type and tunnel mode,
 191 user could use "pgset spi SPI_VALUE" to specify which formal of transformation
 192 to employ.
 193
 194
 195 Current commands and configuration options
 196 ==========================================
 197
 198 ** Pgcontrol commands:
 199
 200 start
 201 stop
 202
 203 ** Thread commands:
 204
 205 add_device
 206 rem_device_all
 207 max_before_softirq
 208
 209
 210 ** Device commands:
 211
 212 count
 213 clone_skb
 214 debug
 215
 216 frags
 217 delay
 218
 219 src_mac_count
 220 dst_mac_count
 221
 222 pkt_size
 223 min_pkt_size
 224 max_pkt_size
 225
 226 mpls
 227
 228 udp_src_min
 229 udp_src_max
 230
 231 udp_dst_min
 232 udp_dst_max
 233
 234 flag
 235   IPSRC_RND
 236   TXSIZE_RND
 237   IPDST_RND
 238   UDPSRC_RND
 239   UDPDST_RND
 240   MACSRC_RND
 241   MACDST_RND
 242   IPSEC
 243
 244 dst_min
 245 dst_max
 246
 247 src_min
 248 src_max
 249
 250 dst_mac
 251 src_mac
 252
 253 clear_counters
 254
 255 dst6
 256 src6
 257
 258 flows
 259 flowlen
 260
 261 rate
 262 ratep
 263
 264 References:
 265 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
 266 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
 267
 268 Paper from Linux-Kongress in Erlangen 2004.
 269 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
 270
 271 Thanks to:
 272 Grant Grundler for testing on IA-64 and parisc, Harald Welte,  Lennert Buytenhek
 273 Stephen Hemminger, Andi Kleen, Dave Miller and many others.
 274
 275
 276 Good luck with the linux net-development.