linux/samples/pktgen
Mauro Carvalho Chehab c1e4535f24 docs: networking: convert pktgen.txt to ReST
- add SPDX header;
- adjust title markup;
- use bold markups on a few places;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
2020-04-30 12:56:37 -07:00
..
functions.sh samples: pktgen: add helper functions for IP(v4/v6) CIDR parsing 2019-10-07 09:26:32 -04:00
parameters.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_bench_xmit_mode_netif_receive.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_bench_xmit_mode_queue_xmit.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_sample01_simple.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_sample02_multiqueue.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_sample03_burst_single_flow.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_sample04_many_flows.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_sample05_flow_per_thread.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
pktgen_sample06_numa_awared_queue_irq_affinity.sh samples: pktgen: allow to specify destination IP range (CIDR) 2019-10-07 09:26:32 -04:00
README.rst docs: networking: convert pktgen.txt to ReST 2020-04-30 12:56:37 -07:00

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.