1# 2# Common functions used by pktgen scripts 3# - Depending on bash 3 (or higher) syntax 4# 5# Author: Jesper Dangaaard Brouer 6# License: GPL 7 8## -- General shell logging cmds -- 9function err() { 10 local exitcode=$1 11 shift 12 echo "ERROR: $@" >&2 13 exit $exitcode 14} 15 16function warn() { 17 echo "WARN : $@" >&2 18} 19 20function info() { 21 if [[ -n "$VERBOSE" ]]; then 22 echo "INFO : $@" >&2 23 fi 24} 25 26## -- Pktgen proc config commands -- ## 27export PROC_DIR=/proc/net/pktgen 28# 29# Three different shell functions for configuring the different 30# components of pktgen: 31# pg_ctrl(), pg_thread() and pg_set(). 32# 33# These functions correspond to pktgens different components. 34# * pg_ctrl() control "pgctrl" (/proc/net/pktgen/pgctrl) 35# * pg_thread() control the kernel threads and binding to devices 36# * pg_set() control setup of individual devices 37function pg_ctrl() { 38 local proc_file="pgctrl" 39 proc_cmd ${proc_file} "$@" 40} 41 42function pg_thread() { 43 local thread=$1 44 local proc_file="kpktgend_${thread}" 45 shift 46 proc_cmd ${proc_file} "$@" 47} 48 49function pg_set() { 50 local dev=$1 51 local proc_file="$dev" 52 shift 53 proc_cmd ${proc_file} "$@" 54} 55 56# More generic replacement for pgset(), that does not depend on global 57# variable for proc file. 58function proc_cmd() { 59 local result 60 local proc_file=$1 61 # after shift, the remaining args are contained in $@ 62 shift 63 local proc_ctrl=${PROC_DIR}/$proc_file 64 if [[ ! -e "$proc_ctrl" ]]; then 65 err 3 "proc file:$proc_ctrl does not exists (dev added to thread?)" 66 else 67 if [[ ! -w "$proc_ctrl" ]]; then 68 err 4 "proc file:$proc_ctrl not writable, not root?!" 69 fi 70 fi 71 72 if [[ "$DEBUG" == "yes" ]]; then 73 echo "cmd: $@ > $proc_ctrl" 74 fi 75 # Quoting of "$@" is important for space expansion 76 echo "$@" > "$proc_ctrl" 77 local status=$? 78 79 result=$(grep "Result: OK:" $proc_ctrl) 80 # Due to pgctrl, cannot use exit code $? from grep 81 if [[ "$result" == "" ]]; then 82 grep "Result:" $proc_ctrl >&2 83 fi 84 if (( $status != 0 )); then 85 err 5 "Write error($status) occurred cmd: \"$@ > $proc_ctrl\"" 86 fi 87} 88 89# Old obsolete "pgset" function, with slightly improved err handling 90function pgset() { 91 local result 92 93 if [[ "$DEBUG" == "yes" ]]; then 94 echo "cmd: $1 > $PGDEV" 95 fi 96 echo $1 > $PGDEV 97 local status=$? 98 99 result=`cat $PGDEV | fgrep "Result: OK:"` 100 if [[ "$result" == "" ]]; then 101 cat $PGDEV | fgrep Result: 102 fi 103 if (( $status != 0 )); then 104 err 5 "Write error($status) occurred cmd: \"$1 > $PGDEV\"" 105 fi 106} 107 108## -- General shell tricks -- 109 110function root_check_run_with_sudo() { 111 # Trick so, program can be run as normal user, will just use "sudo" 112 # call as root_check_run_as_sudo "$@" 113 if [ "$EUID" -ne 0 ]; then 114 if [ -x $0 ]; then # Directly executable use sudo 115 info "Not root, running with sudo" 116 sudo "$0" "$@" 117 exit $? 118 fi 119 err 4 "cannot perform sudo run of $0" 120 fi 121} 122 123# Exact input device's NUMA node info 124function get_iface_node() 125{ 126 local node=$(</sys/class/net/$1/device/numa_node) 127 if [[ $node == -1 ]]; then 128 echo 0 129 else 130 echo $node 131 fi 132} 133 134# Given an Dev/iface, get its queues' irq numbers 135function get_iface_irqs() 136{ 137 local IFACE=$1 138 local queues="${IFACE}-.*TxRx" 139 140 irqs=$(grep "$queues" /proc/interrupts | cut -f1 -d:) 141 [ -z "$irqs" ] && irqs=$(grep $IFACE /proc/interrupts | cut -f1 -d:) 142 [ -z "$irqs" ] && irqs=$(for i in `ls -Ux /sys/class/net/$IFACE/device/msi_irqs` ;\ 143 do grep "$i:.*TxRx" /proc/interrupts | grep -v fdir | cut -f 1 -d : ;\ 144 done) 145 [ -z "$irqs" ] && err 3 "Could not find interrupts for $IFACE" 146 147 echo $irqs 148} 149 150# Given a NUMA node, return cpu ids belonging to it. 151function get_node_cpus() 152{ 153 local node=$1 154 local node_cpu_list 155 local node_cpu_range_list=`cut -f1- -d, --output-delimiter=" " \ 156 /sys/devices/system/node/node$node/cpulist` 157 158 for cpu_range in $node_cpu_range_list 159 do 160 node_cpu_list="$node_cpu_list "`seq -s " " ${cpu_range//-/ }` 161 done 162 163 echo $node_cpu_list 164} 165 166# Given a single or range of port(s), return minimum and maximum port number. 167function parse_ports() 168{ 169 local port_str=$1 170 local port_list 171 local min_port 172 local max_port 173 174 IFS="-" read -ra port_list <<< $port_str 175 176 min_port=${port_list[0]} 177 max_port=${port_list[1]:-$min_port} 178 179 echo $min_port $max_port 180} 181 182# Given a minimum and maximum port, verify port number. 183function validate_ports() 184{ 185 local min_port=$1 186 local max_port=$2 187 188 # 0 < port < 65536 189 if [[ $min_port -gt 0 && $min_port -lt 65536 ]]; then 190 if [[ $max_port -gt 0 && $max_port -lt 65536 ]]; then 191 if [[ $min_port -le $max_port ]]; then 192 return 0 193 fi 194 fi 195 fi 196 197 err 5 "Invalid port(s): $min_port-$max_port" 198} 199