2 # Common functions used by pktgen scripts
3 # - Depending on bash 3 (or higher) syntax
5 # Author: Jesper Dangaaard Brouer
10 ## -- General shell logging cmds --
23 if [[ -n "$VERBOSE" ]]; then
28 ## -- Pktgen proc config commands -- ##
29 export PROC_DIR=/proc/net/pktgen
31 # Three different shell functions for configuring the different
32 # components of pktgen:
33 # pg_ctrl(), pg_thread() and pg_set().
35 # These functions correspond to pktgens different components.
36 # * pg_ctrl() control "pgctrl" (/proc/net/pktgen/pgctrl)
37 # * pg_thread() control the kernel threads and binding to devices
38 # * pg_set() control setup of individual devices
40 local proc_file="pgctrl"
41 proc_cmd ${proc_file} "$@"
44 function pg_thread() {
46 local proc_file="kpktgend_${thread}"
48 proc_cmd ${proc_file} "$@"
53 local proc_file="$dev"
55 proc_cmd ${proc_file} "$@"
58 # More generic replacement for pgset(), that does not depend on global
59 # variable for proc file.
64 # after shift, the remaining args are contained in $@
66 local proc_ctrl=${PROC_DIR}/$proc_file
67 if [[ ! -e "$proc_ctrl" ]]; then
68 err 3 "proc file:$proc_ctrl does not exists (dev added to thread?)"
70 if [[ ! -w "$proc_ctrl" ]]; then
71 err 4 "proc file:$proc_ctrl not writable, not root?!"
75 if [[ "$DEBUG" == "yes" ]]; then
76 echo "cmd: $@ > $proc_ctrl"
78 # Quoting of "$@" is important for space expansion
79 echo "$@" > "$proc_ctrl" || status=$?
81 if [[ "$proc_file" != "pgctrl" ]]; then
82 result=$(grep "Result: OK:" $proc_ctrl) || true
83 if [[ "$result" == "" ]]; then
84 grep "Result:" $proc_ctrl >&2
87 if (( $status != 0 )); then
88 err 5 "Write error($status) occurred cmd: \"$@ > $proc_ctrl\""
92 # Old obsolete "pgset" function, with slightly improved err handling
96 if [[ "$DEBUG" == "yes" ]]; then
97 echo "cmd: $1 > $PGDEV"
102 result=`cat $PGDEV | fgrep "Result: OK:"`
103 if [[ "$result" == "" ]]; then
104 cat $PGDEV | fgrep Result:
106 if (( $status != 0 )); then
107 err 5 "Write error($status) occurred cmd: \"$1 > $PGDEV\""
111 [[ $EUID -eq 0 ]] && trap 'pg_ctrl "reset"' EXIT
113 ## -- General shell tricks --
115 function root_check_run_with_sudo() {
116 # Trick so, program can be run as normal user, will just use "sudo"
117 # call as root_check_run_as_sudo "$@"
118 if [ "$EUID" -ne 0 ]; then
119 if [ -x $0 ]; then # Directly executable use sudo
120 info "Not root, running with sudo"
124 err 4 "cannot perform sudo run of $0"
128 # Exact input device's NUMA node info
129 function get_iface_node()
131 local node=$(</sys/class/net/$1/device/numa_node)
132 if [[ $node == -1 ]]; then
139 # Given an Dev/iface, get its queues' irq numbers
140 function get_iface_irqs()
143 local queues="${IFACE}-.*TxRx"
145 irqs=$(grep "$queues" /proc/interrupts | cut -f1 -d:)
146 [ -z "$irqs" ] && irqs=$(grep $IFACE /proc/interrupts | cut -f1 -d:)
147 [ -z "$irqs" ] && irqs=$(for i in `ls -Ux /sys/class/net/$IFACE/device/msi_irqs` ;\
148 do grep "$i:.*TxRx" /proc/interrupts | grep -v fdir | cut -f 1 -d : ;\
150 [ -z "$irqs" ] && err 3 "Could not find interrupts for $IFACE"
155 # Given a NUMA node, return cpu ids belonging to it.
156 function get_node_cpus()
160 local node_cpu_range_list=`cut -f1- -d, --output-delimiter=" " \
161 /sys/devices/system/node/node$node/cpulist`
163 for cpu_range in $node_cpu_range_list
165 node_cpu_list="$node_cpu_list "`seq -s " " ${cpu_range//-/ }`
171 # Given a single or range of port(s), return minimum and maximum port number.
172 function parse_ports()
179 IFS="-" read -ra port_list <<< $port_str
181 min_port=${port_list[0]}
182 max_port=${port_list[1]:-$min_port}
184 echo $min_port $max_port
187 # Given a minimum and maximum port, verify port number.
188 function validate_ports()
194 if [[ $min_port -gt 0 && $min_port -lt 65536 ]]; then
195 if [[ $max_port -gt 0 && $max_port -lt 65536 ]]; then
196 if [[ $min_port -le $max_port ]]; then
202 err 5 "Invalid port(s): $min_port-$max_port"