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
 112
 113  pgset "udp_src_min 9"   set UDP source port min, If < udp_src_max, then
 114                          cycle through the port range.
 115
 116  pgset "udp_src_max 9"   set UDP source port max.
 117  pgset "udp_dst_min 9"   set UDP destination port min, If < udp_dst_max, then
 118                          cycle through the port range.
 119  pgset "udp_dst_max 9"   set UDP destination port max.
 120
 121  pgset "mpls 0001000a,0002000a,0000000a" set MPLS labels (in this example
 122                                          outer label=16,middle label=32,
 123                                          inner label=0 (IPv4 NULL)) Note that
 124                                          there must be no spaces between the
 125                                          arguments. Leading zeros are required.
 126                                          Do not set the bottom of stack bit,
 127                                          that's done automatically. If you do
 128                                          set the bottom of stack bit, that
 129                                          indicates that you want to randomly
 130                                          generate that address and the flag
 131                                          MPLS_RND will be turned on. You
 132                                          can have any mix of random and fixed
 133                                          labels in the label stack.
 134
 135  pgset "mpls 0"           turn off mpls (or any invalid argument works too!)
 136
 137  pgset "vlan_id 77"       set VLAN ID 0-4095
 138  pgset "vlan_p 3"         set priority bit 0-7 (default 0)
 139  pgset "vlan_cfi 0"       set canonical format identifier 0-1 (default 0)
 140
 141  pgset "svlan_id 22"      set SVLAN ID 0-4095
 142  pgset "svlan_p 3"        set priority bit 0-7 (default 0)
 143  pgset "svlan_cfi 0"      set canonical format identifier 0-1 (default 0)
 144
 145  pgset "vlan_id 9999"     > 4095 remove vlan and svlan tags
 146  pgset "svlan 9999"       > 4095 remove svlan tag
 147
 148
 149  pgset "tos XX"           set former IPv4 TOS field (e.g. "tos 28" for AF11 no ECN, default 00)
 150  pgset "traffic_class XX" set former IPv6 TRAFFIC CLASS (e.g. "traffic_class B8" for EF no ECN, default 00)
 151
 152  pgset stop               aborts injection. Also, ^C aborts generator.
 153
 154  pgset "rate 300M"        set rate to 300 Mb/s
 155  pgset "ratep 1000000"    set rate to 1Mpps
 156
 157 Example scripts
 158 ===============
 159
 160 A collection of small tutorial scripts for pktgen is in examples dir.
 161
 162 pktgen.conf-1-1                  # 1 CPU 1 dev
 163 pktgen.conf-1-2                  # 1 CPU 2 dev
 164 pktgen.conf-2-1                  # 2 CPU's 1 dev
 165 pktgen.conf-2-2                  # 2 CPU's 2 dev
 166 pktgen.conf-1-1-rdos             # 1 CPU 1 dev w. route DoS
 167 pktgen.conf-1-1-ip6              # 1 CPU 1 dev ipv6
 168 pktgen.conf-1-1-ip6-rdos         # 1 CPU 1 dev ipv6  w. route DoS
 169 pktgen.conf-1-1-flows            # 1 CPU 1 dev multiple flows.
 170
 171 Run in shell: ./pktgen.conf-X-Y It does all the setup including sending.
 172
 173
 174 Interrupt affinity
 175 ===================
 176 Note when adding devices to a specific CPU there good idea to also assign
 177 /proc/irq/XX/smp_affinity so the TX-interrupts gets bound to the same CPU.
 178 as this reduces cache bouncing when freeing skb's.
 179
 180
 181 Current commands and configuration options
 182 ==========================================
 183
 184 ** Pgcontrol commands:
 185
 186 start
 187 stop
 188
 189 ** Thread commands:
 190
 191 add_device
 192 rem_device_all
 193 max_before_softirq
 194
 195
 196 ** Device commands:
 197
 198 count
 199 clone_skb
 200 debug
 201
 202 frags
 203 delay
 204
 205 src_mac_count
 206 dst_mac_count
 207
 208 pkt_size
 209 min_pkt_size
 210 max_pkt_size
 211
 212 mpls
 213
 214 udp_src_min
 215 udp_src_max
 216
 217 udp_dst_min
 218 udp_dst_max
 219
 220 flag
 221   IPSRC_RND
 222   TXSIZE_RND
 223   IPDST_RND
 224   UDPSRC_RND
 225   UDPDST_RND
 226   MACSRC_RND
 227   MACDST_RND
 228
 229 dst_min
 230 dst_max
 231
 232 src_min
 233 src_max
 234
 235 dst_mac
 236 src_mac
 237
 238 clear_counters
 239
 240 dst6
 241 src6
 242
 243 flows
 244 flowlen
 245
 246 rate
 247 ratep
 248
 249 References:
 250 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
 251 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
 252
 253 Paper from Linux-Kongress in Erlangen 2004.
 254 ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
 255
 256 Thanks to:
 257 Grant Grundler for testing on IA-64 and parisc, Harald Welte,  Lennert Buytenhek
 258 Stephen Hemminger, Andi Kleen, Dave Miller and many others.
 259
 260
 261 Good luck with the linux net-development.