projects / mirror_ubuntu-focal-kernel.git / blame
| Commit | Line | Data |
|---|---|---|
| b64b0d1e JDB |
1 | Sample and benchmark scripts for pktgen (packet generator) |
| 2 | ========================================================== | |
| 3 | This directory contains some pktgen sample and benchmark scripts, that | |
| 4 | can easily be copied and adjusted for your own use-case. | |
| 5 | ||
| 6 | General doc is located in kernel: Documentation/networking/pktgen.txt | |
| 7 | ||
| 8 | Helper include files | |
| 9 | ==================== | |
| 10 | This directory contains two helper shell files, that can be "included" | |
| 11 | by shell source'ing. Namely "functions.sh" and "parameters.sh". | |
| 12 | ||
| 13 | Common parameters | |
| 14 | ----------------- | |
| 15 | The parameters.sh file support easy and consistant parameter parsing | |
| 16 | across the sample scripts. Usage example is printed on errors:: | |
| 17 | ||
| 18 | Usage: ./pktgen_sample01_simple.sh [-vx] -i ethX | |
| 19 | -i : ($DEV) output interface/device (required) | |
| 20 | -s : ($PKT_SIZE) packet size | |
| 21 | -d : ($DEST_IP) destination IP | |
| 22 | -m : ($DST_MAC) destination MAC-addr | |
| 6e32a74a | 23 | -p : ($DST_PORT) destination PORT range (e.g. 433-444) is also allowed |
| b64b0d1e | 24 | -t : ($THREADS) threads to start |
| e0e16672 | 25 | -f : ($F_THREAD) index of first thread (zero indexed CPU number) |
| b64b0d1e | 26 | -c : ($SKB_CLONE) SKB clones send before alloc new SKB |
| 69137ea6 | 27 | -n : ($COUNT) num messages to send per thread, 0 means indefinitely |
| b64b0d1e JDB |
28 | -b : ($BURST) HW level bursting of SKBs |
| 29 | -v : ($VERBOSE) verbose | |
| 30 | -x : ($DEBUG) debug | |
| 31 | ||
| 32 | The global variable being set is also listed. E.g. the required | |
| 33 | interface/device parameter "-i" sets variable $DEV. | |
| 34 | ||
| 35 | Common functions | |
| 36 | ---------------- | |
| 37 | The functions.sh file provides; Three different shell functions for | |
| 38 | configuring the different components of pktgen: pg_ctrl(), pg_thread() | |
| 39 | and pg_set(). | |
| 40 | ||
| 41 | These functions correspond to pktgens different components. | |
| 42 | * pg_ctrl() control "pgctrl" (/proc/net/pktgen/pgctrl) | |
| 43 | * pg_thread() control the kernel threads and binding to devices | |
| 44 | * pg_set() control setup of individual devices | |
| 45 | ||
| 46 | See sample scripts for usage examples. |