[mirror_ubuntu-jammy-kernel.git] / samples / pktgen / pktgen_sample03_burst_single_flow.sh

#!/bin/bash
# SPDX-License-Identifier: GPL-2.0
#
# Script for max single flow performance
#  - If correctly tuned[1], single CPU 10G wirespeed small pkts is possible[2]
#
# Using pktgen "burst" option (use -b $N)
#  - To boost max performance
#  - Avail since: kernel v3.18
#   * commit 38b2cf2982dc73 ("net: pktgen: packet bursting via skb->xmit_more")
#  - This avoids writing the HW tailptr on every driver xmit
#  - The performance boost is impressive, see commit and blog [2]
#
# Notice: On purpose generates a single (UDP) flow towards target,
#   reason behind this is to only overload/activate a single CPU on
#   target host.  And no randomness for pktgen also makes it faster.
#
# Tuning see:
#  [1] http://netoptimizer.blogspot.dk/2014/06/pktgen-for-network-overload-testing.html
#  [2] http://netoptimizer.blogspot.dk/2014/10/unlocked-10gbps-tx-wirespeed-smallest.html
#
basedir=`dirname $0`
source ${basedir}/functions.sh
root_check_run_with_sudo "$@"

# Parameter parsing via include
source ${basedir}/parameters.sh
# Set some default params, if they didn't get set
if [ -z "$DEST_IP" ]; then
    [ -z "$IP6" ] && DEST_IP="198.18.0.42" || DEST_IP="FD00::1"
fi
[ -z "$DST_MAC" ]   && DST_MAC="90:e2:ba:ff:ff:ff"
[ -z "$BURST" ]     && BURST=32
[ -z "$CLONE_SKB" ] && CLONE_SKB="0" # No need for clones when bursting
[ -z "$COUNT" ]     && COUNT="0" # Zero means indefinitely
if [ -n "$DEST_IP" ]; then
    validate_addr${IP6} $DEST_IP
    read -r DST_MIN DST_MAX <<< $(parse_addr${IP6} $DEST_IP)
fi
if [ -n "$DST_PORT" ]; then
    read -r UDP_DST_MIN UDP_DST_MAX <<< $(parse_ports $DST_PORT)
    validate_ports $UDP_DST_MIN $UDP_DST_MAX
fi

# Base Config
DELAY="0"  # Zero means max speed

# General cleanup everything since last run
pg_ctrl "reset"

# Threads are specified with parameter -t value in $THREADS
for ((thread = $F_THREAD; thread <= $L_THREAD; thread++)); do
    dev=${DEV}@${thread}

    # Add remove all other devices and add_device $dev to thread
    pg_thread $thread "rem_device_all"
    pg_thread $thread "add_device" $dev

    # Base config
    pg_set $dev "flag QUEUE_MAP_CPU"
    pg_set $dev "count $COUNT"
    pg_set $dev "clone_skb $CLONE_SKB"
    pg_set $dev "pkt_size $PKT_SIZE"
    pg_set $dev "delay $DELAY"
    pg_set $dev "flag NO_TIMESTAMP"

    # Destination
    pg_set $dev "dst_mac $DST_MAC"
    pg_set $dev "dst${IP6}_min $DST_MIN"
    pg_set $dev "dst${IP6}_max $DST_MAX"

    if [ -n "$DST_PORT" ]; then
	# Single destination port or random port range
	pg_set $dev "flag UDPDST_RND"
	pg_set $dev "udp_dst_min $UDP_DST_MIN"
	pg_set $dev "udp_dst_max $UDP_DST_MAX"
    fi

    # Setup burst, for easy testing -b 0 disable bursting
    # (internally in pktgen default and minimum burst=1)
    if [[ ${BURST} -ne 0 ]]; then
	pg_set $dev "burst $BURST"
    else
	info "$dev: Not using burst"
    fi
done

# Run if user hits control-c
function control_c() {
    # Print results
    for ((thread = $F_THREAD; thread <= $L_THREAD; thread++)); do
	dev=${DEV}@${thread}
	echo "Device: $dev"
	cat /proc/net/pktgen/$dev | grep -A2 "Result:"
    done
}
# trap keyboard interrupt (Ctrl-C)
trap control_c SIGINT

echo "Running... ctrl^C to stop" >&2
pg_ctrl "start"
Commit	Line	Data
1d73ba16	1	#!/bin/bash
b2441318	2	# SPDX-License-Identifier: GPL-2.0
1d73ba16 JDB	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
0f06a678 MKL	29	if [ -z "$DEST_IP" ]; then
	30	[ -z "$IP6" ] && DEST_IP="198.18.0.42" \|\| DEST_IP="FD00::1"
	31	fi
1d73ba16 JDB	32	[ -z "$DST_MAC" ] && DST_MAC="90:e2:ba:ff:ff:ff"
1d73ba16 JDB	33	[ -z "$BURST" ] && BURST=32
9efc44d7	34	[ -z "$CLONE_SKB" ] && CLONE_SKB="0" # No need for clones when bursting
69137ea6	35	[ -z "$COUNT" ] && COUNT="0" # Zero means indefinitely
40f843ee DL	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
6e32a74a	40	if [ -n "$DST_PORT" ]; then
723d2904 DL	41	read -r UDP_DST_MIN UDP_DST_MAX <<< $(parse_ports $DST_PORT)
723d2904 DL	42	validate_ports $UDP_DST_MIN $UDP_DST_MAX
6e32a74a	43	fi
1d73ba16 JDB	44
	45	# Base Config
	46	DELAY="0" # Zero means max speed
1d73ba16 JDB	47
	48	# General cleanup everything since last run
	49	pg_ctrl "reset"
	50
	51	# Threads are specified with parameter -t value in $THREADS
e0e16672	52	for ((thread = $F_THREAD; thread <= $L_THREAD; thread++)); do
1d73ba16 JDB	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"
40f843ee DL	69	pg_set $dev "dst${IP6}_min $DST_MIN"
40f843ee DL	70	pg_set $dev "dst${IP6}_max $DST_MAX"
1d73ba16	71
6e32a74a DL	72	if [ -n "$DST_PORT" ]; then
	73	# Single destination port or random port range
	74	pg_set $dev "flag UDPDST_RND"
723d2904 DL	75	pg_set $dev "udp_dst_min $UDP_DST_MIN"
723d2904 DL	76	pg_set $dev "udp_dst_max $UDP_DST_MAX"
6e32a74a DL	77	fi
6e32a74a DL	78
1d73ba16 JDB	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
e0e16672	91	for ((thread = $F_THREAD; thread <= $L_THREAD; thread++)); do
1d73ba16 JDB	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"