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