samples: pktgen: allow to specify destination IP range (CIDR)
[sfrench/cifs-2.6.git] / samples / pktgen / pktgen_sample03_burst_single_flow.sh
1 #!/bin/bash
2 # SPDX-License-Identifier: GPL-2.0
3 #
4 # Script for max single flow performance
5 #  - If correctly tuned[1], single CPU 10G wirespeed small pkts is possible[2]
6 #
7 # Using pktgen "burst" option (use -b $N)
8 #  - To boost max performance
9 #  - Avail since: kernel v3.18
10 #   * commit 38b2cf2982dc73 ("net: pktgen: packet bursting via skb->xmit_more")
11 #  - This avoids writing the HW tailptr on every driver xmit
12 #  - The performance boost is impressive, see commit and blog [2]
13 #
14 # Notice: On purpose generates a single (UDP) flow towards target,
15 #   reason behind this is to only overload/activate a single CPU on
16 #   target host.  And no randomness for pktgen also makes it faster.
17 #
18 # Tuning see:
19 #  [1] http://netoptimizer.blogspot.dk/2014/06/pktgen-for-network-overload-testing.html
20 #  [2] http://netoptimizer.blogspot.dk/2014/10/unlocked-10gbps-tx-wirespeed-smallest.html
21 #
22 basedir=`dirname $0`
23 source ${basedir}/functions.sh
24 root_check_run_with_sudo "$@"
25
26 # Parameter parsing via include
27 source ${basedir}/parameters.sh
28 # Set some default params, if they didn't get set
29 if [ -z "$DEST_IP" ]; then
30     [ -z "$IP6" ] && DEST_IP="198.18.0.42" || DEST_IP="FD00::1"
31 fi
32 [ -z "$DST_MAC" ]   && DST_MAC="90:e2:ba:ff:ff:ff"
33 [ -z "$BURST" ]     && BURST=32
34 [ -z "$CLONE_SKB" ] && CLONE_SKB="0" # No need for clones when bursting
35 [ -z "$COUNT" ]     && COUNT="0" # Zero means indefinitely
36 if [ -n "$DEST_IP" ]; then
37     validate_addr${IP6} $DEST_IP
38     read -r DST_MIN DST_MAX <<< $(parse_addr${IP6} $DEST_IP)
39 fi
40 if [ -n "$DST_PORT" ]; then
41     read -r UDP_DST_MIN UDP_DST_MAX <<< $(parse_ports $DST_PORT)
42     validate_ports $UDP_DST_MIN $UDP_DST_MAX
43 fi
44
45 # Base Config
46 DELAY="0"  # Zero means max speed
47
48 # General cleanup everything since last run
49 pg_ctrl "reset"
50
51 # Threads are specified with parameter -t value in $THREADS
52 for ((thread = $F_THREAD; thread <= $L_THREAD; thread++)); do
53     dev=${DEV}@${thread}
54
55     # Add remove all other devices and add_device $dev to thread
56     pg_thread $thread "rem_device_all"
57     pg_thread $thread "add_device" $dev
58
59     # Base config
60     pg_set $dev "flag QUEUE_MAP_CPU"
61     pg_set $dev "count $COUNT"
62     pg_set $dev "clone_skb $CLONE_SKB"
63     pg_set $dev "pkt_size $PKT_SIZE"
64     pg_set $dev "delay $DELAY"
65     pg_set $dev "flag NO_TIMESTAMP"
66
67     # Destination
68     pg_set $dev "dst_mac $DST_MAC"
69     pg_set $dev "dst${IP6}_min $DST_MIN"
70     pg_set $dev "dst${IP6}_max $DST_MAX"
71
72     if [ -n "$DST_PORT" ]; then
73         # Single destination port or random port range
74         pg_set $dev "flag UDPDST_RND"
75         pg_set $dev "udp_dst_min $UDP_DST_MIN"
76         pg_set $dev "udp_dst_max $UDP_DST_MAX"
77     fi
78
79     # Setup burst, for easy testing -b 0 disable bursting
80     # (internally in pktgen default and minimum burst=1)
81     if [[ ${BURST} -ne 0 ]]; then
82         pg_set $dev "burst $BURST"
83     else
84         info "$dev: Not using burst"
85     fi
86 done
87
88 # Run if user hits control-c
89 function control_c() {
90     # Print results
91     for ((thread = $F_THREAD; thread <= $L_THREAD; thread++)); do
92         dev=${DEV}@${thread}
93         echo "Device: $dev"
94         cat /proc/net/pktgen/$dev | grep -A2 "Result:"
95     done
96 }
97 # trap keyboard interrupt (Ctrl-C)
98 trap control_c SIGINT
99
100 echo "Running... ctrl^C to stop" >&2
101 pg_ctrl "start"