Documentation/networking/pktgen.rst

1 .. SPDX-License-Identifier: GPL-2.0
7 Enable CONFIG_NET_PKTGEN to compile and build pktgen either in-kernel
31 overload type of benchmarking, as this could hurt the normal use-case.
33 Specifically increasing the TX ring buffer in the NIC::
35  # ethtool -G ethX tx 1024
37 A larger TX ring can improve pktgen's performance, while it can hurt
38 in the general case, 1) because the TX ring buffer might get larger
43 TX ring cause delay.  Drivers usually delay cleaning up the
44 ring-buffers for various performance reasons, and packets stalling
45 the TX ring might just be waiting for cleanup.
48 (Intel 82599 chip).  This driver (ixgbe) combines TX+RX ring cleanups,
49 and the cleanup interval is affected by the ethtool --coalesce setting
50 of parameter "rx-usecs".
54  # ethtool -C ethX rx-usecs 30
72  * add_device DEVICE@NAME -- adds a single device
73  * rem_device_all         -- remove all associated devices
96 	frags: 0  delay: 0  clone_skb: 64  ifname: eth4@0
106 	pkts-sofar: 100000  errors: 0
107 	started: 623913381008us  stopped: 623913396439us idle: 25us
135 			 packet and update HW tx queue tail pointer once.
142  pgset "delay 5000"      adds delay to hard_start_xmit(). nanoseconds
156  pgset "queue_map_min 0" Sets the min value of tx queue interval
157  pgset "queue_map_max 7" Sets the max value of tx queue interval, for multiqueue devices
187  pgset "spi [SPI_VALUE]" Set specific SA used to transform packet.
213  pgset "vlan_id 77"       set VLAN ID 0-4095
214  pgset "vlan_p 3"         set priority bit 0-7 (default 0)
215  pgset "vlan_cfi 0"       set canonical format identifier 0-1 (default 0)
217  pgset "svlan_id 22"      set SVLAN ID 0-4095
218  pgset "svlan_p 3"        set priority bit 0-7 (default 0)
219  pgset "svlan_cfi 0"      set canonical format identifier 0-1 (default 0)
244  ./pktgen_sample01_simple.sh -i eth4 -m 00:1B:21:3C:9D:F8 -d 192.168.8.2
248   ./pktgen_sample01_simple.sh [-vx] -i ethX
250   -i : ($DEV)       output interface/device (required)
251   -s : ($PKT_SIZE)  packet size
252   -d : ($DEST_IP)   destination IP. CIDR (e.g. 198.18.0.0/15) is also allowed
253   -m : ($DST_MAC)   destination MAC-addr
254   -p : ($DST_PORT)  destination PORT range (e.g. 433-444) is also allowed
255   -t : ($THREADS)   threads to start
256   -f : ($F_THREAD)  index of first thread (zero indexed CPU number)
257   -c : ($SKB_CLONE) SKB clones send before alloc new SKB
258   -n : ($COUNT)     num messages to send per thread, 0 means indefinitely
259   -b : ($BURST)     HW level bursting of SKBs
260   -v : ($VERBOSE)   verbose
261   -x : ($DEBUG)     debug
262   -6 : ($IP6)       IPv6
263   -w : ($DELAY)     Tx Delay value (ns)
264   -a : ($APPEND)    Script will not reset generator's state, but will append its config
267 interface/device parameter "-i" sets variable $DEV.  Copy the
274 also assign /proc/irq/XX/smp_affinity so that the TX interrupts are bound
277 Plus using the device flag QUEUE_MAP_CPU, which maps the SKBs TX queue
289 you can use "pgset spi SPI_VALUE" to specify which transformation mode
295 To test with non-shared SKBs, remove the "SHARED" flag by simply setting::
326     delay
373     spi (ipsec)
410 - ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
411 - ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
413 Paper from Linux-Kongress in Erlangen 2004.
414 - ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
418 Grant Grundler for testing on IA-64 and parisc, Harald Welte,  Lennert Buytenhek
422 Good luck with the linux net-development.