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 if [[ -z "$APPEND" ]]; then
112 if [[ $EUID -eq 0 ]]; then
113 # Cleanup pktgen setup on exit if thats not "append mode"
114 trap 'pg_ctrl "reset"' EXIT
118 ## -- General shell tricks --
120 function root_check_run_with_sudo() {
121 # Trick so, program can be run as normal user, will just use "sudo"
122 # call as root_check_run_as_sudo "$@"
123 if [ "$EUID" -ne 0 ]; then
124 if [ -x $0 ]; then # Directly executable use sudo
125 info "Not root, running with sudo"
129 err 4 "cannot perform sudo run of $0"
133 # Exact input device's NUMA node info
134 function get_iface_node()
136 local node=$(</sys/class/net/$1/device/numa_node)
137 if [[ $node == -1 ]]; then
144 # Given an Dev/iface, get its queues' irq numbers
145 function get_iface_irqs()
148 local queues="${IFACE}-.*TxRx"
150 irqs=$(grep "$queues" /proc/interrupts | cut -f1 -d:)
151 [ -z "$irqs" ] && irqs=$(grep $IFACE /proc/interrupts | cut -f1 -d:)
152 [ -z "$irqs" ] && irqs=$(for i in `ls -Ux /sys/class/net/$IFACE/device/msi_irqs` ;\
153 do grep "$i:.*TxRx" /proc/interrupts | grep -v fdir | cut -f 1 -d : ;\
155 [ -z "$irqs" ] && err 3 "Could not find interrupts for $IFACE"
160 # Given a NUMA node, return cpu ids belonging to it.
161 function get_node_cpus()
165 local node_cpu_range_list=`cut -f1- -d, --output-delimiter=" " \
166 /sys/devices/system/node/node$node/cpulist`
168 for cpu_range in $node_cpu_range_list
170 node_cpu_list="$node_cpu_list "`seq -s " " ${cpu_range//-/ }`
176 # Check $1 is in between $2, $3 ($2 <= $1 <= $3)
177 function in_between() { [[ ($1 -ge $2) && ($1 -le $3) ]] ; }
179 # Extend shrunken IPv6 address.
180 # fe80::42:bcff:fe84:e10a => fe80:0:0:0:42:bcff:fe84:e10a
181 function extend_addr6()
185 local sep_cnt=$(tr -cd $sep <<< $1 | wc -c)
188 # separator count should be (2 <= $sep_cnt <= 7)
189 if ! (in_between $sep_cnt 2 7); then
190 err 5 "Invalid IP6 address: $1"
193 # if shrink '::' occurs multiple, it's malformed.
194 shrink=( $(grep -E -o "$sep{2,}" <<< $addr) )
195 if [[ ${#shrink[@]} -ne 0 ]]; then
196 if [[ ${#shrink[@]} -gt 1 || ( ${shrink[0]} != $sep2 ) ]]; then
197 err 5 "Invalid IP6 address: $1"
201 # add 0 at begin & end, and extend addr by adding :0
202 [[ ${addr:0:1} == $sep ]] && addr=0${addr}
203 [[ ${addr: -1} == $sep ]] && addr=${addr}0
204 echo "${addr/$sep2/$(printf ':0%.s' $(seq $[8-sep_cnt])):}"
207 # Given a single IP(v4/v6) address, whether it is valid.
208 function validate_addr()
210 # check function is called with (funcname)6
211 [[ ${FUNCNAME[1]: -1} == 6 ]] && local IP6=6
212 local bitlen=$[ IP6 ? 128 : 32 ]
213 local len=$[ IP6 ? 8 : 4 ]
214 local max=$[ 2**(len*2)-1 ]
218 IFS='/' read net prefix <<< $1
219 [[ $IP6 ]] && net=$(extend_addr6 $net)
221 # if prefix exists, check (0 <= $prefix <= $bitlen)
222 if [[ -n $prefix ]]; then
223 if ! (in_between $prefix 0 $bitlen); then
224 err 5 "Invalid prefix: /$prefix"
228 # set separator for each IP(v4/v6)
229 [[ $IP6 ]] && sep=: || sep=.
230 IFS=$sep read -a addr <<< $net
233 if [[ ${#addr[@]} != $len ]]; then
234 err 5 "Invalid IP$IP6 address: $1"
237 # check each digit (0 <= $digit <= $max)
238 for digit in "${addr[@]}"; do
239 [[ $IP6 ]] && digit=$[ 16#$digit ]
240 if ! (in_between $digit 0 $max); then
241 err 5 "Invalid IP$IP6 address: $1"
248 function validate_addr6() { validate_addr $@ ; }
250 # Given a single IP(v4/v6) or CIDR, return minimum and maximum IP addr.
251 function parse_addr()
253 # check function is called with (funcname)6
254 [[ ${FUNCNAME[1]: -1} == 6 ]] && local IP6=6
258 IFS='/' read net prefix <<< $1
259 [[ $IP6 ]] && net=$(extend_addr6 $net)
261 if [[ -z $prefix ]]; then
265 # defining array for converting Decimal 2 Binary
266 # 00000000 00000001 00000010 00000011 00000100 ...
267 local d2b='{0..1}{0..1}{0..1}{0..1}{0..1}{0..1}{0..1}{0..1}'
268 [[ $IP6 ]] && d2b+=$d2b
269 eval local D2B=($d2b)
271 local bitlen=$[ IP6 ? 128 : 32 ]
272 local remain=$[ bitlen-prefix ]
273 local octet=$[ IP6 ? 16 : 8 ]
274 local min_mask max_mask
279 # set separator for each IP(v4/v6)
280 [[ $IP6 ]] && sep=: || sep=.
281 IFS=$sep read -ra ip <<< $net
283 min_mask="$(printf '1%.s' $(seq $prefix))$(printf '0%.s' $(seq $remain))"
284 max_mask="$(printf '0%.s' $(seq $prefix))$(printf '1%.s' $(seq $remain))"
286 # calculate min/max ip with &,| operator
287 for i in "${!ip[@]}"; do
288 digit=$[ IP6 ? 16#${ip[$i]} : ${ip[$i]} ]
289 ip_bit=${D2B[$digit]}
292 min[$i]=$[ 2#$ip_bit & 2#${min_mask:$idx:$octet} ]
293 max[$i]=$[ 2#$ip_bit | 2#${max_mask:$idx:$octet} ]
294 [[ $IP6 ]] && { min[$i]=$(printf '%X' ${min[$i]});
295 max[$i]=$(printf '%X' ${max[$i]}); }
298 min_ip=$(IFS=$sep; echo "${min[*]}")
299 max_ip=$(IFS=$sep; echo "${max[*]}")
305 function parse_addr6() { parse_addr $@ ; }
307 # Given a single or range of port(s), return minimum and maximum port number.
308 function parse_ports()
315 IFS="-" read -ra port_list <<< $port_str
317 min_port=${port_list[0]}
318 max_port=${port_list[1]:-$min_port}
320 echo $min_port $max_port
323 # Given a minimum and maximum port, verify port number.
324 function validate_ports()
330 if (in_between $min_port 1 65535); then
331 if (in_between $max_port 1 65535); then
332 if [[ $min_port -le $max_port ]]; then
338 err 5 "Invalid port(s): $min_port-$max_port"