summaryrefslogblamecommitdiff
path: root/samples/pktgen/README.rst
blob: f9c53ca5cf93431ab042d00f121ac1749c37393f (plain) (tree) 
b64b0d1e6495 ^





c1e4535f24bc ^

b64b0d1e6495 ^














40f843ee5e17 ^

b64b0d1e6495 ^

6e32a74a6f15 ^

b64b0d1e6495 ^

e0e16672ee9e ^

b64b0d1e6495 ^

69137ea60c9d ^

b64b0d1e6495 ^



















1
2
3
4
5

6

7
8
9
10
11
12
13
14
15
16
17
18
19
20

21

22

23

24

25

26

27

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46





                                                                      
                                                                     













                                                                      
                                                                             
                                        
                                                                         
                                    
                                                                   
                                                        
                                                                         


















                                                                      
Sample and benchmark scripts for pktgen (packet generator)
==========================================================
This directory contains some pktgen sample and benchmark scripts, that
can easily be copied and adjusted for your own use-case.

General doc is located in kernel: Documentation/networking/pktgen.rst

Helper include files
====================
This directory contains two helper shell files, that can be "included"
by shell source'ing.  Namely "functions.sh" and "parameters.sh".

Common parameters
-----------------
The parameters.sh file support easy and consistant parameter parsing
across the sample scripts.  Usage example is printed on errors::

 Usage: ./pktgen_sample01_simple.sh [-vx] -i ethX
  -i : ($DEV)       output interface/device (required)
  -s : ($PKT_SIZE)  packet size
  -d : ($DEST_IP)   destination IP. CIDR (e.g. 198.18.0.0/15) is also allowed
  -m : ($DST_MAC)   destination MAC-addr
  -p : ($DST_PORT)  destination PORT range (e.g. 433-444) is also allowed
  -t : ($THREADS)   threads to start
  -f : ($F_THREAD)  index of first thread (zero indexed CPU number)
  -c : ($SKB_CLONE) SKB clones send before alloc new SKB
  -n : ($COUNT)     num messages to send per thread, 0 means indefinitely
  -b : ($BURST)     HW level bursting of SKBs
  -v : ($VERBOSE)   verbose
  -x : ($DEBUG)     debug

The global variable being set is also listed.  E.g. the required
interface/device parameter "-i" sets variable $DEV.

Common functions
----------------
The functions.sh file provides; Three different shell functions for
configuring the different components of pktgen: pg_ctrl(), pg_thread()
and pg_set().

These functions correspond to pktgens different components.
 * pg_ctrl()   control "pgctrl" (/proc/net/pktgen/pgctrl)
 * pg_thread() control the kernel threads and binding to devices
 * pg_set()    control setup of individual devices

See sample scripts for usage examples.