pktgen: adjust flag NO_TIMESTAMP to be more pktgen compliant
[deliverable/linux.git] / Documentation / networking / pktgen.txt
CommitLineData
1da177e4
LT
1
2
3 HOWTO for the linux packet generator
4 ------------------------------------
5
4e081e0c
BH
6Enable CONFIG_NET_PKTGEN to compile and build pktgen either in-kernel
7or as a module. A module is preferred; modprobe pktgen if needed. Once
ca5b542c
BH
8running, pktgen creates a thread for each CPU with affinity to that CPU.
9Monitoring and controlling is done via /proc. It is easiest to select a
10suitable sample script and configure that.
1da177e4
LT
11
12On a dual CPU:
13
14ps aux | grep pkt
15root 129 0.3 0.0 0 0 ? SW 2003 523:20 [pktgen/0]
16root 130 0.3 0.0 0 0 ? SW 2003 509:50 [pktgen/1]
17
18
2fe0ae78 19For monitoring and control pktgen creates:
1da177e4
LT
20 /proc/net/pktgen/pgctrl
21 /proc/net/pktgen/kpktgend_X
22 /proc/net/pktgen/ethX
23
24
9ceb87fc
JDB
25Tuning NIC for max performance
26==============================
27
ca5b542c 28The default NIC settings are (likely) not tuned for pktgen's artificial
9ceb87fc
JDB
29overload type of benchmarking, as this could hurt the normal use-case.
30
31Specifically increasing the TX ring buffer in the NIC:
32 # ethtool -G ethX tx 1024
33
34A larger TX ring can improve pktgen's performance, while it can hurt
35in the general case, 1) because the TX ring buffer might get larger
ca5b542c 36than the CPU's L1/L2 cache, 2) because it allows more queueing in the
9ceb87fc
JDB
37NIC HW layer (which is bad for bufferbloat).
38
ca5b542c 39One should hesitate to conclude that packets/descriptors in the HW
9ceb87fc 40TX ring cause delay. Drivers usually delay cleaning up the
ca5b542c
BH
41ring-buffers for various performance reasons, and packets stalling
42the TX ring might just be waiting for cleanup.
9ceb87fc 43
ca5b542c
BH
44This cleanup issue is specifically the case for the driver ixgbe
45(Intel 82599 chip). This driver (ixgbe) combines TX+RX ring cleanups,
9ceb87fc
JDB
46and the cleanup interval is affected by the ethtool --coalesce setting
47of parameter "rx-usecs".
48
ca5b542c 49For ixgbe use e.g. "30" resulting in approx 33K interrupts/sec (1/30*10^6):
9ceb87fc
JDB
50 # ethtool -C ethX rx-usecs 30
51
52
1da177e4
LT
53Viewing threads
54===============
55/proc/net/pktgen/kpktgend_0
56Name: kpktgend_0 max_before_softirq: 10000
57Running:
58Stopped: eth1
59Result: OK: max_before_softirq=10000
60
ca5b542c
BH
61Most important are the devices assigned to the thread. Note that a
62device can only belong to one thread.
1da177e4
LT
63
64
65Viewing devices
66===============
67
ca5b542c
BH
68The Params section holds configured information. The Current section
69holds running statistics. The Result is printed after a run or after
70interruption. Example:
1da177e4
LT
71
72/proc/net/pktgen/eth1
73
74Params: count 10000000 min_pkt_size: 60 max_pkt_size: 60
75 frags: 0 delay: 0 clone_skb: 1000000 ifname: eth1
76 flows: 0 flowlen: 0
77 dst_min: 10.10.11.2 dst_max:
78 src_min: src_max:
79 src_mac: 00:00:00:00:00:00 dst_mac: 00:04:23:AC:FD:82
80 udp_src_min: 9 udp_src_max: 9 udp_dst_min: 9 udp_dst_max: 9
81 src_mac_count: 0 dst_mac_count: 0
82 Flags:
83Current:
84 pkts-sofar: 10000000 errors: 39664
85 started: 1103053986245187us stopped: 1103053999346329us idle: 880401us
86 seq_num: 10000011 cur_dst_mac_offset: 0 cur_src_mac_offset: 0
87 cur_saddr: 0x10a0a0a cur_daddr: 0x20b0a0a
88 cur_udp_dst: 9 cur_udp_src: 9
89 flows: 0
90Result: OK: 13101142(c12220741+d880401) usec, 10000000 (60byte,0frags)
91 763292pps 390Mb/sec (390805504bps) errors: 39664
92
5d3f083d
ML
93Configuring threads and devices
94================================
7c95a9d9
BH
95This is done via the /proc interface, and most easily done via pgset
96as defined in the sample scripts.
1da177e4
LT
97
98Examples:
99
100 pgset "clone_skb 1" sets the number of copies of the same packet
101 pgset "clone_skb 0" use single SKB for all transmits
38b2cf29
AS
102 pgset "burst 8" uses xmit_more API to queue 8 copies of the same
103 packet and update HW tx queue tail pointer once.
104 "burst 1" is the default
1da177e4
LT
105 pgset "pkt_size 9014" sets packet size to 9014
106 pgset "frags 5" packet will consist of 5 fragments
107 pgset "count 200000" sets number of packets to send, set to zero
d0f19d82 108 for continuous sends until explicitly stopped.
1da177e4
LT
109
110 pgset "delay 5000" adds delay to hard_start_xmit(). nanoseconds
111
112 pgset "dst 10.0.0.1" sets IP destination address
113 (BEWARE! This generator is very aggressive!)
114
115 pgset "dst_min 10.0.0.1" Same as dst
116 pgset "dst_max 10.0.0.254" Set the maximum destination IP.
117 pgset "src_min 10.0.0.1" Set the minimum (or only) source IP.
118 pgset "src_max 10.0.0.254" Set the maximum source IP.
119 pgset "dst6 fec0::1" IPV6 destination address
120 pgset "src6 fec0::2" IPV6 source address
121 pgset "dstmac 00:00:00:00:00:00" sets MAC destination address
122 pgset "srcmac 00:00:00:00:00:00" sets MAC source address
123
896a7cf8
ED
124 pgset "queue_map_min 0" Sets the min value of tx queue interval
125 pgset "queue_map_max 7" Sets the max value of tx queue interval, for multiqueue devices
126 To select queue 1 of a given device,
127 use queue_map_min=1 and queue_map_max=1
128
1da177e4
LT
129 pgset "src_mac_count 1" Sets the number of MACs we'll range through.
130 The 'minimum' MAC is what you set with srcmac.
131
132 pgset "dst_mac_count 1" Sets the number of MACs we'll range through.
133 The 'minimum' MAC is what you set with dstmac.
134
135 pgset "flag [name]" Set a flag to determine behaviour. Current flags
72f8e06f
MK
136 are: IPSRC_RND # IP source is random (between min/max)
137 IPDST_RND # IP destination is random
138 UDPSRC_RND, UDPDST_RND,
139 MACSRC_RND, MACDST_RND
140 TXSIZE_RND, IPV6,
f0e82fd0 141 MPLS_RND, VID_RND, SVID_RND
72f8e06f 142 FLOW_SEQ,
896a7cf8
ED
143 QUEUE_MAP_RND # queue map random
144 QUEUE_MAP_CPU # queue map mirrors smp_processor_id()
72f8e06f
MK
145 UDPCSUM,
146 IPSEC # IPsec encapsulation (needs CONFIG_XFRM)
147 NODE_ALLOC # node specific memory allocation
f1f00d8f 148 NO_TIMESTAMP # disable timestamping
896a7cf8 149
e5f79d11 150 pgset spi SPI_VALUE Set specific SA used to transform packet.
1da177e4
LT
151
152 pgset "udp_src_min 9" set UDP source port min, If < udp_src_max, then
153 cycle through the port range.
154
155 pgset "udp_src_max 9" set UDP source port max.
156 pgset "udp_dst_min 9" set UDP destination port min, If < udp_dst_max, then
157 cycle through the port range.
158 pgset "udp_dst_max 9" set UDP destination port max.
159
ca6549af
SW
160 pgset "mpls 0001000a,0002000a,0000000a" set MPLS labels (in this example
161 outer label=16,middle label=32,
162 inner label=0 (IPv4 NULL)) Note that
163 there must be no spaces between the
164 arguments. Leading zeros are required.
165 Do not set the bottom of stack bit,
fa00e7e1 166 that's done automatically. If you do
ca6549af
SW
167 set the bottom of stack bit, that
168 indicates that you want to randomly
169 generate that address and the flag
170 MPLS_RND will be turned on. You
171 can have any mix of random and fixed
172 labels in the label stack.
173
174 pgset "mpls 0" turn off mpls (or any invalid argument works too!)
175
f0e82fd0
FF
176 pgset "vlan_id 77" set VLAN ID 0-4095
177 pgset "vlan_p 3" set priority bit 0-7 (default 0)
178 pgset "vlan_cfi 0" set canonical format identifier 0-1 (default 0)
179
180 pgset "svlan_id 22" set SVLAN ID 0-4095
181 pgset "svlan_p 3" set priority bit 0-7 (default 0)
182 pgset "svlan_cfi 0" set canonical format identifier 0-1 (default 0)
183
184 pgset "vlan_id 9999" > 4095 remove vlan and svlan tags
185 pgset "svlan 9999" > 4095 remove svlan tag
186
187
188 pgset "tos XX" set former IPv4 TOS field (e.g. "tos 28" for AF11 no ECN, default 00)
189 pgset "traffic_class XX" set former IPv6 TRAFFIC CLASS (e.g. "traffic_class B8" for EF no ECN, default 00)
190
1da177e4
LT
191 pgset stop aborts injection. Also, ^C aborts generator.
192
43d28b65
DT
193 pgset "rate 300M" set rate to 300 Mb/s
194 pgset "ratep 1000000" set rate to 1Mpps
1da177e4 195
7c95a9d9
BH
196Sample scripts
197==============
1da177e4 198
7c95a9d9
BH
199A collection of small tutorial scripts for pktgen is in the
200samples/pktgen directory:
1da177e4
LT
201
202pktgen.conf-1-1 # 1 CPU 1 dev
203pktgen.conf-1-2 # 1 CPU 2 dev
204pktgen.conf-2-1 # 2 CPU's 1 dev
205pktgen.conf-2-2 # 2 CPU's 2 dev
206pktgen.conf-1-1-rdos # 1 CPU 1 dev w. route DoS
207pktgen.conf-1-1-ip6 # 1 CPU 1 dev ipv6
208pktgen.conf-1-1-ip6-rdos # 1 CPU 1 dev ipv6 w. route DoS
209pktgen.conf-1-1-flows # 1 CPU 1 dev multiple flows.
210
ca5b542c
BH
211Run in shell: ./pktgen.conf-X-Y
212This does all the setup including sending.
1da177e4
LT
213
214
215Interrupt affinity
216===================
ca5b542c
BH
217Note that when adding devices to a specific CPU it is a good idea to
218also assign /proc/irq/XX/smp_affinity so that the TX interrupts are bound
219to the same CPU. This reduces cache bouncing when freeing skbs.
1da177e4 220
e5f79d11
FD
221Enable IPsec
222============
ca5b542c
BH
223Default IPsec transformation with ESP encapsulation plus transport mode
224can be enabled by simply setting:
e5f79d11
FD
225
226pgset "flag IPSEC"
227pgset "flows 1"
228
229To avoid breaking existing testbed scripts for using AH type and tunnel mode,
ca5b542c 230you can use "pgset spi SPI_VALUE" to specify which transformation mode
e5f79d11
FD
231to employ.
232
1da177e4
LT
233
234Current commands and configuration options
235==========================================
236
237** Pgcontrol commands:
238
239start
240stop
241
242** Thread commands:
243
244add_device
245rem_device_all
246max_before_softirq
247
248
249** Device commands:
250
251count
252clone_skb
253debug
254
255frags
256delay
257
258src_mac_count
259dst_mac_count
260
261pkt_size
262min_pkt_size
263max_pkt_size
264
ca6549af
SW
265mpls
266
1da177e4
LT
267udp_src_min
268udp_src_max
269
270udp_dst_min
271udp_dst_max
272
273flag
274 IPSRC_RND
1da177e4
LT
275 IPDST_RND
276 UDPSRC_RND
277 UDPDST_RND
278 MACSRC_RND
279 MACDST_RND
72f8e06f
MK
280 TXSIZE_RND
281 IPV6
282 MPLS_RND
283 VID_RND
284 SVID_RND
285 FLOW_SEQ
286 QUEUE_MAP_RND
287 QUEUE_MAP_CPU
288 UDPCSUM
e5f79d11 289 IPSEC
72f8e06f 290 NODE_ALLOC
f1f00d8f 291 NO_TIMESTAMP
1da177e4
LT
292
293dst_min
294dst_max
295
296src_min
297src_max
298
299dst_mac
300src_mac
301
302clear_counters
303
304dst6
305src6
306
307flows
308flowlen
309
43d28b65
DT
310rate
311ratep
312
1da177e4
LT
313References:
314ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
315ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
316
317Paper from Linux-Kongress in Erlangen 2004.
318ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
319
320Thanks to:
321Grant Grundler for testing on IA-64 and parisc, Harald Welte, Lennert Buytenhek
322Stephen Hemminger, Andi Kleen, Dave Miller and many others.
323
324
ca6549af 325Good luck with the linux net-development.
This page took 0.841748 seconds and 5 git commands to generate.