blob: 0e30c7845b2b316cb4bb7cdf32807aaf18a55610 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2
3 HOWTO for the linux packet generator
4 ------------------------------------
5
6Date: 041221
7
8Enable CONFIG_NET_PKTGEN to compile and build pktgen.o either in kernel
9or as module. Module is preferred. insmod pktgen if needed. Once running
Matt LaPlante3f6dee92006-10-03 22:45:33 +020010pktgen creates a thread on each CPU where each thread has affinity to its CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011Monitoring and controlling is done via /proc. Easiest to select a suitable
12a sample script and configure.
13
14On a dual CPU:
15
16ps aux | grep pkt
17root 129 0.3 0.0 0 0 ? SW 2003 523:20 [pktgen/0]
18root 130 0.3 0.0 0 0 ? SW 2003 509:50 [pktgen/1]
19
20
Matt LaPlante2fe0ae72006-10-03 22:50:39 +020021For monitoring and control pktgen creates:
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 /proc/net/pktgen/pgctrl
23 /proc/net/pktgen/kpktgend_X
24 /proc/net/pktgen/ethX
25
26
27Viewing threads
28===============
29/proc/net/pktgen/kpktgend_0
30Name: kpktgend_0 max_before_softirq: 10000
31Running:
32Stopped: eth1
33Result: OK: max_before_softirq=10000
34
Matt LaPlante3f6dee92006-10-03 22:45:33 +020035Most important the devices assigned to thread. Note! A device can only belong
Linus Torvalds1da177e2005-04-16 15:20:36 -070036to one thread.
37
38
39Viewing devices
40===============
41
42Parm section holds configured info. Current hold running stats.
43Result is printed after run or after interruption. Example:
44
45/proc/net/pktgen/eth1
46
47Params: 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:
56Current:
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
63Result: OK: 13101142(c12220741+d880401) usec, 10000000 (60byte,0frags)
64 763292pps 390Mb/sec (390805504bps) errors: 39664
65
Matt LaPlante5d3f0832006-11-30 05:21:10 +010066Configuring threads and devices
67================================
Linus Torvalds1da177e2005-04-16 15:20:36 -070068This is done via the /proc interface easiest done via pgset in the scripts
69
70Examples:
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
Adrian Bunkd0f19d82006-06-30 18:28:43 +020077 for continuous sends until explicitly stopped.
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
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
Eric Dumazet896a7cf2009-10-02 20:24:59 +000093 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 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
Mathias Krause72f8e062014-02-21 21:38:36 +0100105 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,
Francesco Fondellif0e82fd2006-09-27 16:33:05 -0700110 MPLS_RND, VID_RND, SVID_RND
Mathias Krause72f8e062014-02-21 21:38:36 +0100111 FLOW_SEQ,
Eric Dumazet896a7cf2009-10-02 20:24:59 +0000112 QUEUE_MAP_RND # queue map random
113 QUEUE_MAP_CPU # queue map mirrors smp_processor_id()
Mathias Krause72f8e062014-02-21 21:38:36 +0100114 UDPCSUM,
115 IPSEC # IPsec encapsulation (needs CONFIG_XFRM)
116 NODE_ALLOC # node specific memory allocation
Eric Dumazet896a7cf2009-10-02 20:24:59 +0000117
Fan Due5f79d12014-01-03 11:18:34 +0800118 pgset spi SPI_VALUE Set specific SA used to transform packet.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
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
Steven Whitehouseca6549a2006-03-23 01:10:26 -0800128 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,
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100134 that's done automatically. If you do
Steven Whitehouseca6549a2006-03-23 01:10:26 -0800135 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
Francesco Fondellif0e82fd2006-09-27 16:33:05 -0700144 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 pgset stop aborts injection. Also, ^C aborts generator.
160
Daniel Turull43d28b62010-06-09 22:49:57 +0000161 pgset "rate 300M" set rate to 300 Mb/s
162 pgset "ratep 1000000" set rate to 1Mpps
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164Example scripts
165===============
166
Matt LaPlantefff92892006-10-03 22:47:42 +0200167A collection of small tutorial scripts for pktgen is in examples dir.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169pktgen.conf-1-1 # 1 CPU 1 dev
170pktgen.conf-1-2 # 1 CPU 2 dev
171pktgen.conf-2-1 # 2 CPU's 1 dev
172pktgen.conf-2-2 # 2 CPU's 2 dev
173pktgen.conf-1-1-rdos # 1 CPU 1 dev w. route DoS
174pktgen.conf-1-1-ip6 # 1 CPU 1 dev ipv6
175pktgen.conf-1-1-ip6-rdos # 1 CPU 1 dev ipv6 w. route DoS
176pktgen.conf-1-1-flows # 1 CPU 1 dev multiple flows.
177
178Run in shell: ./pktgen.conf-X-Y It does all the setup including sending.
179
180
181Interrupt affinity
182===================
183Note 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.
185as this reduces cache bouncing when freeing skb's.
186
Fan Due5f79d12014-01-03 11:18:34 +0800187Enable IPsec
188============
189Default IPsec transformation with ESP encapsulation plus Transport mode
190could be enabled by simply setting:
191
192pgset "flag IPSEC"
193pgset "flows 1"
194
195To avoid breaking existing testbed scripts for using AH type and tunnel mode,
196user could use "pgset spi SPI_VALUE" to specify which formal of transformation
197to employ.
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200Current commands and configuration options
201==========================================
202
203** Pgcontrol commands:
204
205start
206stop
207
208** Thread commands:
209
210add_device
211rem_device_all
212max_before_softirq
213
214
215** Device commands:
216
217count
218clone_skb
219debug
220
221frags
222delay
223
224src_mac_count
225dst_mac_count
226
227pkt_size
228min_pkt_size
229max_pkt_size
230
Steven Whitehouseca6549a2006-03-23 01:10:26 -0800231mpls
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233udp_src_min
234udp_src_max
235
236udp_dst_min
237udp_dst_max
238
239flag
240 IPSRC_RND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 IPDST_RND
242 UDPSRC_RND
243 UDPDST_RND
244 MACSRC_RND
245 MACDST_RND
Mathias Krause72f8e062014-02-21 21:38:36 +0100246 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
Fan Due5f79d12014-01-03 11:18:34 +0800255 IPSEC
Mathias Krause72f8e062014-02-21 21:38:36 +0100256 NODE_ALLOC
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258dst_min
259dst_max
260
261src_min
262src_max
263
264dst_mac
265src_mac
266
267clear_counters
268
269dst6
270src6
271
272flows
273flowlen
274
Daniel Turull43d28b62010-06-09 22:49:57 +0000275rate
276ratep
277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278References:
279ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
280ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
281
282Paper from Linux-Kongress in Erlangen 2004.
283ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
284
285Thanks to:
286Grant Grundler for testing on IA-64 and parisc, Harald Welte, Lennert Buytenhek
287Stephen Hemminger, Andi Kleen, Dave Miller and many others.
288
289
Steven Whitehouseca6549a2006-03-23 01:10:26 -0800290Good luck with the linux net-development.