[net-next-2.6.git] / Documentation / networking / pktgen.txt



                  HOWTO for the linux packet generator 
                  ------------------------------------

Date: 041221

Enable CONFIG_NET_PKTGEN to compile and build pktgen.o either in kernel
or as module. Module is preferred. insmod pktgen if needed. Once running
pktgen creates a thread on each CPU where each thread has affinity to its CPU.
Monitoring and controlling is done via /proc. Easiest to select a suitable 
a sample script and configure.

On a dual CPU:

ps aux | grep pkt
root       129  0.3  0.0     0    0 ?        SW    2003 523:20 [pktgen/0]
root       130  0.3  0.0     0    0 ?        SW    2003 509:50 [pktgen/1]


For monitoring and control pktgen creates:
	/proc/net/pktgen/pgctrl
	/proc/net/pktgen/kpktgend_X
        /proc/net/pktgen/ethX


Viewing threads
===============
/proc/net/pktgen/kpktgend_0 
Name: kpktgend_0  max_before_softirq: 10000
Running: 
Stopped: eth1 
Result: OK: max_before_softirq=10000

Most important the devices assigned to thread. Note! A device can only belong 
to one thread.


Viewing devices
===============

Parm section holds configured info. Current hold running stats. 
Result is printed after run or after interruption. Example:

/proc/net/pktgen/eth1       

Params: count 10000000  min_pkt_size: 60  max_pkt_size: 60
     frags: 0  delay: 0  clone_skb: 1000000  ifname: eth1
     flows: 0 flowlen: 0
     dst_min: 10.10.11.2  dst_max: 
     src_min:   src_max: 
     src_mac: 00:00:00:00:00:00  dst_mac: 00:04:23:AC:FD:82
     udp_src_min: 9  udp_src_max: 9  udp_dst_min: 9  udp_dst_max: 9
     src_mac_count: 0  dst_mac_count: 0 
     Flags: 
Current:
     pkts-sofar: 10000000  errors: 39664
     started: 1103053986245187us  stopped: 1103053999346329us idle: 880401us
     seq_num: 10000011  cur_dst_mac_offset: 0  cur_src_mac_offset: 0
     cur_saddr: 0x10a0a0a  cur_daddr: 0x20b0a0a
     cur_udp_dst: 9  cur_udp_src: 9
     flows: 0
Result: OK: 13101142(c12220741+d880401) usec, 10000000 (60byte,0frags)
  763292pps 390Mb/sec (390805504bps) errors: 39664

Configuring threads and devices
================================
This is done via the /proc interface easiest done via pgset in the scripts

Examples:

 pgset "clone_skb 1"     sets the number of copies of the same packet
 pgset "clone_skb 0"     use single SKB for all transmits
 pgset "pkt_size 9014"   sets packet size to 9014
 pgset "frags 5"         packet will consist of 5 fragments
 pgset "count 200000"    sets number of packets to send, set to zero
                         for continuous sends until explicitly stopped.

 pgset "delay 5000"      adds delay to hard_start_xmit(). nanoseconds

 pgset "dst 10.0.0.1"    sets IP destination address
                         (BEWARE! This generator is very aggressive!)

 pgset "dst_min 10.0.0.1"            Same as dst
 pgset "dst_max 10.0.0.254"          Set the maximum destination IP.
 pgset "src_min 10.0.0.1"            Set the minimum (or only) source IP.
 pgset "src_max 10.0.0.254"          Set the maximum source IP.
 pgset "dst6 fec0::1"     IPV6 destination address
 pgset "src6 fec0::2"     IPV6 source address
 pgset "dstmac 00:00:00:00:00:00"    sets MAC destination address
 pgset "srcmac 00:00:00:00:00:00"    sets MAC source address

 pgset "queue_map_min 0" Sets the min value of tx queue interval
 pgset "queue_map_max 7" Sets the max value of tx queue interval, for multiqueue devices
                         To select queue 1 of a given device,
                         use queue_map_min=1 and queue_map_max=1

 pgset "src_mac_count 1" Sets the number of MACs we'll range through.  
                         The 'minimum' MAC is what you set with srcmac.

 pgset "dst_mac_count 1" Sets the number of MACs we'll range through.
                         The 'minimum' MAC is what you set with dstmac.

 pgset "flag [name]"     Set a flag to determine behaviour.  Current flags
                         are: IPSRC_RND #IP Source is random (between min/max),
                              IPDST_RND, UDPSRC_RND,
                              UDPDST_RND, MACSRC_RND, MACDST_RND 
                              MPLS_RND, VID_RND, SVID_RND
                              QUEUE_MAP_RND # queue map random
                              QUEUE_MAP_CPU # queue map mirrors smp_processor_id()


 pgset "udp_src_min 9"   set UDP source port min, If < udp_src_max, then
                         cycle through the port range.

 pgset "udp_src_max 9"   set UDP source port max.
 pgset "udp_dst_min 9"   set UDP destination port min, If < udp_dst_max, then
                         cycle through the port range.
 pgset "udp_dst_max 9"   set UDP destination port max.

 pgset "mpls 0001000a,0002000a,0000000a" set MPLS labels (in this example
                                         outer label=16,middle label=32,
					 inner label=0 (IPv4 NULL)) Note that
					 there must be no spaces between the
					 arguments. Leading zeros are required.
					 Do not set the bottom of stack bit,
					 that's done automatically. If you do
					 set the bottom of stack bit, that
					 indicates that you want to randomly
					 generate that address and the flag
					 MPLS_RND will be turned on. You
					 can have any mix of random and fixed
					 labels in the label stack.

 pgset "mpls 0"		  turn off mpls (or any invalid argument works too!)

 pgset "vlan_id 77"       set VLAN ID 0-4095
 pgset "vlan_p 3"         set priority bit 0-7 (default 0)
 pgset "vlan_cfi 0"       set canonical format identifier 0-1 (default 0)

 pgset "svlan_id 22"      set SVLAN ID 0-4095
 pgset "svlan_p 3"        set priority bit 0-7 (default 0)
 pgset "svlan_cfi 0"      set canonical format identifier 0-1 (default 0)

 pgset "vlan_id 9999"     > 4095 remove vlan and svlan tags
 pgset "svlan 9999"       > 4095 remove svlan tag


 pgset "tos XX"           set former IPv4 TOS field (e.g. "tos 28" for AF11 no ECN, default 00)
 pgset "traffic_class XX" set former IPv6 TRAFFIC CLASS (e.g. "traffic_class B8" for EF no ECN, default 00)

 pgset stop    	          aborts injection. Also, ^C aborts generator.


Example scripts
===============

A collection of small tutorial scripts for pktgen is in examples dir.

pktgen.conf-1-1                  # 1 CPU 1 dev 
pktgen.conf-1-2                  # 1 CPU 2 dev
pktgen.conf-2-1                  # 2 CPU's 1 dev 
pktgen.conf-2-2                  # 2 CPU's 2 dev
pktgen.conf-1-1-rdos             # 1 CPU 1 dev w. route DoS 
pktgen.conf-1-1-ip6              # 1 CPU 1 dev ipv6
pktgen.conf-1-1-ip6-rdos         # 1 CPU 1 dev ipv6  w. route DoS
pktgen.conf-1-1-flows            # 1 CPU 1 dev multiple flows.

Run in shell: ./pktgen.conf-X-Y It does all the setup including sending. 


Interrupt affinity
===================
Note when adding devices to a specific CPU there good idea to also assign 
/proc/irq/XX/smp_affinity so the TX-interrupts gets bound to the same CPU.
as this reduces cache bouncing when freeing skb's.


Current commands and configuration options
==========================================

** Pgcontrol commands:

start
stop

** Thread commands:

add_device
rem_device_all
max_before_softirq


** Device commands:

count
clone_skb
debug

frags
delay

src_mac_count
dst_mac_count

pkt_size 
min_pkt_size
max_pkt_size

mpls

udp_src_min
udp_src_max

udp_dst_min
udp_dst_max

flag
  IPSRC_RND
  TXSIZE_RND
  IPDST_RND
  UDPSRC_RND
  UDPDST_RND
  MACSRC_RND
  MACDST_RND

dst_min
dst_max

src_min
src_max

dst_mac
src_mac

clear_counters

dst6
src6

flows
flowlen

References:
ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/

Paper from Linux-Kongress in Erlangen 2004.
ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf

Thanks to:
Grant Grundler for testing on IA-64 and parisc, Harald Welte,  Lennert Buytenhek
Stephen Hemminger, Andi Kleen, Dave Miller and many others.


Good luck with the linux net-development.
Commit	Line	Data
1da177e4 LT	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
3f6dee9b	10	pktgen creates a thread on each CPU where each thread has affinity to its CPU.
1da177e4 LT	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
2fe0ae78	21	For monitoring and control pktgen creates:
1da177e4 LT	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
3f6dee9b	35	Most important the devices assigned to thread. Note! A device can only belong
1da177e4 LT	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
5d3f083d ML	66	Configuring threads and devices
5d3f083d ML	67	================================
1da177e4 LT	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
d0f19d82	77	for continuous sends until explicitly stopped.
1da177e4 LT	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
896a7cf8 ED	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
1da177e4 LT	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
f0e82fd0	108	MPLS_RND, VID_RND, SVID_RND
896a7cf8 ED	109	QUEUE_MAP_RND # queue map random
	110	QUEUE_MAP_CPU # queue map mirrors smp_processor_id()
	111
1da177e4 LT	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
ca6549af SW	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,
fa00e7e1	127	that's done automatically. If you do
ca6549af SW	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
f0e82fd0 FF	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
1da177e4 LT	152	pgset stop aborts injection. Also, ^C aborts generator.
	153
	154
	155	Example scripts
	156	===============
	157
fff9289b	158	A collection of small tutorial scripts for pktgen is in examples dir.
1da177e4 LT	159
	160	pktgen.conf-1-1 # 1 CPU 1 dev
	161	pktgen.conf-1-2 # 1 CPU 2 dev
	162	pktgen.conf-2-1 # 2 CPU's 1 dev
	163	pktgen.conf-2-2 # 2 CPU's 2 dev
	164	pktgen.conf-1-1-rdos # 1 CPU 1 dev w. route DoS
	165	pktgen.conf-1-1-ip6 # 1 CPU 1 dev ipv6
	166	pktgen.conf-1-1-ip6-rdos # 1 CPU 1 dev ipv6 w. route DoS
	167	pktgen.conf-1-1-flows # 1 CPU 1 dev multiple flows.
	168
	169	Run in shell: ./pktgen.conf-X-Y It does all the setup including sending.
	170
	171
	172	Interrupt affinity
	173	===================
	174	Note when adding devices to a specific CPU there good idea to also assign
	175	/proc/irq/XX/smp_affinity so the TX-interrupts gets bound to the same CPU.
	176	as this reduces cache bouncing when freeing skb's.
	177
	178
	179	Current commands and configuration options
	180	==========================================
	181
	182	** Pgcontrol commands:
	183
	184	start
	185	stop
	186
	187	** Thread commands:
	188
	189	add_device
	190	rem_device_all
	191	max_before_softirq
	192
	193
	194	** Device commands:
	195
	196	count
	197	clone_skb
	198	debug
	199
	200	frags
	201	delay
	202
	203	src_mac_count
	204	dst_mac_count
	205
	206	pkt_size
	207	min_pkt_size
	208	max_pkt_size
	209
ca6549af SW	210	mpls
ca6549af SW	211
1da177e4 LT	212	udp_src_min
	213	udp_src_max
	214
	215	udp_dst_min
	216	udp_dst_max
	217
	218	flag
	219	IPSRC_RND
	220	TXSIZE_RND
	221	IPDST_RND
	222	UDPSRC_RND
	223	UDPDST_RND
	224	MACSRC_RND
	225	MACDST_RND
	226
	227	dst_min
	228	dst_max
	229
	230	src_min
	231	src_max
	232
	233	dst_mac
	234	src_mac
	235
	236	clear_counters
	237
	238	dst6
	239	src6
	240
	241	flows
	242	flowlen
	243
	244	References:
	245	ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/
	246	ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/examples/
	247
	248	Paper from Linux-Kongress in Erlangen 2004.
	249	ftp://robur.slu.se/pub/Linux/net-development/pktgen-testing/pktgen_paper.pdf
	250
	251	Thanks to:
	252	Grant Grundler for testing on IA-64 and parisc, Harald Welte, Lennert Buytenhek
	253	Stephen Hemminger, Andi Kleen, Dave Miller and many others.
	254
	255
ca6549af	256	Good luck with the linux net-development.