functions.sh 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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. set -o errexit
  8. ## -- General shell logging cmds --
  9. function err() {
  10. local exitcode=$1
  11. shift
  12. echo "ERROR: $@" >&2
  13. exit $exitcode
  14. }
  15. function warn() {
  16. echo "WARN : $@" >&2
  17. }
  18. function info() {
  19. if [[ -n "$VERBOSE" ]]; then
  20. echo "INFO : $@" >&2
  21. fi
  22. }
  23. ## -- Pktgen proc config commands -- ##
  24. export PROC_DIR=/proc/net/pktgen
  25. #
  26. # Three different shell functions for configuring the different
  27. # components of pktgen:
  28. # pg_ctrl(), pg_thread() and pg_set().
  29. #
  30. # These functions correspond to pktgens different components.
  31. # * pg_ctrl() control "pgctrl" (/proc/net/pktgen/pgctrl)
  32. # * pg_thread() control the kernel threads and binding to devices
  33. # * pg_set() control setup of individual devices
  34. function pg_ctrl() {
  35. local proc_file="pgctrl"
  36. proc_cmd ${proc_file} "$@"
  37. }
  38. function pg_thread() {
  39. local thread=$1
  40. local proc_file="kpktgend_${thread}"
  41. shift
  42. proc_cmd ${proc_file} "$@"
  43. }
  44. function pg_set() {
  45. local dev=$1
  46. local proc_file="$dev"
  47. shift
  48. proc_cmd ${proc_file} "$@"
  49. }
  50. # More generic replacement for pgset(), that does not depend on global
  51. # variable for proc file.
  52. function proc_cmd() {
  53. local result
  54. local proc_file=$1
  55. local status=0
  56. # after shift, the remaining args are contained in $@
  57. shift
  58. local proc_ctrl=${PROC_DIR}/$proc_file
  59. if [[ ! -e "$proc_ctrl" ]]; then
  60. err 3 "proc file:$proc_ctrl does not exists (dev added to thread?)"
  61. else
  62. if [[ ! -w "$proc_ctrl" ]]; then
  63. err 4 "proc file:$proc_ctrl not writable, not root?!"
  64. fi
  65. fi
  66. if [[ "$DEBUG" == "yes" ]]; then
  67. echo "cmd: $@ > $proc_ctrl"
  68. fi
  69. # Quoting of "$@" is important for space expansion
  70. echo "$@" > "$proc_ctrl" || status=$?
  71. if [[ "$proc_file" != "pgctrl" ]]; then
  72. result=$(grep "Result: OK:" $proc_ctrl) || true
  73. if [[ "$result" == "" ]]; then
  74. grep "Result:" $proc_ctrl >&2
  75. fi
  76. fi
  77. if (( $status != 0 )); then
  78. err 5 "Write error($status) occurred cmd: \"$@ > $proc_ctrl\""
  79. fi
  80. }
  81. # Old obsolete "pgset" function, with slightly improved err handling
  82. function pgset() {
  83. local result
  84. if [[ "$DEBUG" == "yes" ]]; then
  85. echo "cmd: $1 > $PGDEV"
  86. fi
  87. echo $1 > $PGDEV
  88. local status=$?
  89. result=`cat $PGDEV | fgrep "Result: OK:"`
  90. if [[ "$result" == "" ]]; then
  91. cat $PGDEV | fgrep Result:
  92. fi
  93. if (( $status != 0 )); then
  94. err 5 "Write error($status) occurred cmd: \"$1 > $PGDEV\""
  95. fi
  96. }
  97. [[ $EUID -eq 0 ]] && trap 'pg_ctrl "reset"' EXIT
  98. ## -- General shell tricks --
  99. function root_check_run_with_sudo() {
  100. # Trick so, program can be run as normal user, will just use "sudo"
  101. # call as root_check_run_as_sudo "$@"
  102. if [ "$EUID" -ne 0 ]; then
  103. if [ -x $0 ]; then # Directly executable use sudo
  104. info "Not root, running with sudo"
  105. sudo "$0" "$@"
  106. exit $?
  107. fi
  108. err 4 "cannot perform sudo run of $0"
  109. fi
  110. }
  111. # Exact input device's NUMA node info
  112. function get_iface_node()
  113. {
  114. local node=$(</sys/class/net/$1/device/numa_node)
  115. if [[ $node == -1 ]]; then
  116. echo 0
  117. else
  118. echo $node
  119. fi
  120. }
  121. # Given an Dev/iface, get its queues' irq numbers
  122. function get_iface_irqs()
  123. {
  124. local IFACE=$1
  125. local queues="${IFACE}-.*TxRx"
  126. irqs=$(grep "$queues" /proc/interrupts | cut -f1 -d:)
  127. [ -z "$irqs" ] && irqs=$(grep $IFACE /proc/interrupts | cut -f1 -d:)
  128. [ -z "$irqs" ] && irqs=$(for i in `ls -Ux /sys/class/net/$IFACE/device/msi_irqs` ;\
  129. do grep "$i:.*TxRx" /proc/interrupts | grep -v fdir | cut -f 1 -d : ;\
  130. done)
  131. [ -z "$irqs" ] && err 3 "Could not find interrupts for $IFACE"
  132. echo $irqs
  133. }
  134. # Given a NUMA node, return cpu ids belonging to it.
  135. function get_node_cpus()
  136. {
  137. local node=$1
  138. local node_cpu_list
  139. local node_cpu_range_list=`cut -f1- -d, --output-delimiter=" " \
  140. /sys/devices/system/node/node$node/cpulist`
  141. for cpu_range in $node_cpu_range_list
  142. do
  143. node_cpu_list="$node_cpu_list "`seq -s " " ${cpu_range//-/ }`
  144. done
  145. echo $node_cpu_list
  146. }
  147. # Check $1 is in between $2, $3 ($2 <= $1 <= $3)
  148. function in_between() { [[ ($1 -ge $2) && ($1 -le $3) ]] ; }
  149. # Extend shrunken IPv6 address.
  150. # fe80::42:bcff:fe84:e10a => fe80:0:0:0:42:bcff:fe84:e10a
  151. function extend_addr6()
  152. {
  153. local addr=$1
  154. local sep=: sep2=::
  155. local sep_cnt=$(tr -cd $sep <<< $1 | wc -c)
  156. local shrink
  157. # separator count should be (2 <= $sep_cnt <= 7)
  158. if ! (in_between $sep_cnt 2 7); then
  159. err 5 "Invalid IP6 address: $1"
  160. fi
  161. # if shrink '::' occurs multiple, it's malformed.
  162. shrink=( $(egrep -o "$sep{2,}" <<< $addr) )
  163. if [[ ${#shrink[@]} -ne 0 ]]; then
  164. if [[ ${#shrink[@]} -gt 1 || ( ${shrink[0]} != $sep2 ) ]]; then
  165. err 5 "Invalid IP6 address: $1"
  166. fi
  167. fi
  168. # add 0 at begin & end, and extend addr by adding :0
  169. [[ ${addr:0:1} == $sep ]] && addr=0${addr}
  170. [[ ${addr: -1} == $sep ]] && addr=${addr}0
  171. echo "${addr/$sep2/$(printf ':0%.s' $(seq $[8-sep_cnt])):}"
  172. }
  173. # Given a single IP(v4/v6) address, whether it is valid.
  174. function validate_addr()
  175. {
  176. # check function is called with (funcname)6
  177. [[ ${FUNCNAME[1]: -1} == 6 ]] && local IP6=6
  178. local bitlen=$[ IP6 ? 128 : 32 ]
  179. local len=$[ IP6 ? 8 : 4 ]
  180. local max=$[ 2**(len*2)-1 ]
  181. local net prefix
  182. local addr sep
  183. IFS='/' read net prefix <<< $1
  184. [[ $IP6 ]] && net=$(extend_addr6 $net)
  185. # if prefix exists, check (0 <= $prefix <= $bitlen)
  186. if [[ -n $prefix ]]; then
  187. if ! (in_between $prefix 0 $bitlen); then
  188. err 5 "Invalid prefix: /$prefix"
  189. fi
  190. fi
  191. # set separator for each IP(v4/v6)
  192. [[ $IP6 ]] && sep=: || sep=.
  193. IFS=$sep read -a addr <<< $net
  194. # array length
  195. if [[ ${#addr[@]} != $len ]]; then
  196. err 5 "Invalid IP$IP6 address: $1"
  197. fi
  198. # check each digit (0 <= $digit <= $max)
  199. for digit in "${addr[@]}"; do
  200. [[ $IP6 ]] && digit=$[ 16#$digit ]
  201. if ! (in_between $digit 0 $max); then
  202. err 5 "Invalid IP$IP6 address: $1"
  203. fi
  204. done
  205. return 0
  206. }
  207. function validate_addr6() { validate_addr $@ ; }
  208. # Given a single IP(v4/v6) or CIDR, return minimum and maximum IP addr.
  209. function parse_addr()
  210. {
  211. # check function is called with (funcname)6
  212. [[ ${FUNCNAME[1]: -1} == 6 ]] && local IP6=6
  213. local net prefix
  214. local min_ip max_ip
  215. IFS='/' read net prefix <<< $1
  216. [[ $IP6 ]] && net=$(extend_addr6 $net)
  217. if [[ -z $prefix ]]; then
  218. min_ip=$net
  219. max_ip=$net
  220. else
  221. # defining array for converting Decimal 2 Binary
  222. # 00000000 00000001 00000010 00000011 00000100 ...
  223. local d2b='{0..1}{0..1}{0..1}{0..1}{0..1}{0..1}{0..1}{0..1}'
  224. [[ $IP6 ]] && d2b+=$d2b
  225. eval local D2B=($d2b)
  226. local bitlen=$[ IP6 ? 128 : 32 ]
  227. local remain=$[ bitlen-prefix ]
  228. local octet=$[ IP6 ? 16 : 8 ]
  229. local min_mask max_mask
  230. local min max
  231. local ip_bit
  232. local ip sep
  233. # set separator for each IP(v4/v6)
  234. [[ $IP6 ]] && sep=: || sep=.
  235. IFS=$sep read -ra ip <<< $net
  236. min_mask="$(printf '1%.s' $(seq $prefix))$(printf '0%.s' $(seq $remain))"
  237. max_mask="$(printf '0%.s' $(seq $prefix))$(printf '1%.s' $(seq $remain))"
  238. # calculate min/max ip with &,| operator
  239. for i in "${!ip[@]}"; do
  240. digit=$[ IP6 ? 16#${ip[$i]} : ${ip[$i]} ]
  241. ip_bit=${D2B[$digit]}
  242. idx=$[ octet*i ]
  243. min[$i]=$[ 2#$ip_bit & 2#${min_mask:$idx:$octet} ]
  244. max[$i]=$[ 2#$ip_bit | 2#${max_mask:$idx:$octet} ]
  245. [[ $IP6 ]] && { min[$i]=$(printf '%X' ${min[$i]});
  246. max[$i]=$(printf '%X' ${max[$i]}); }
  247. done
  248. min_ip=$(IFS=$sep; echo "${min[*]}")
  249. max_ip=$(IFS=$sep; echo "${max[*]}")
  250. fi
  251. echo $min_ip $max_ip
  252. }
  253. function parse_addr6() { parse_addr $@ ; }
  254. # Given a single or range of port(s), return minimum and maximum port number.
  255. function parse_ports()
  256. {
  257. local port_str=$1
  258. local port_list
  259. local min_port
  260. local max_port
  261. IFS="-" read -ra port_list <<< $port_str
  262. min_port=${port_list[0]}
  263. max_port=${port_list[1]:-$min_port}
  264. echo $min_port $max_port
  265. }
  266. # Given a minimum and maximum port, verify port number.
  267. function validate_ports()
  268. {
  269. local min_port=$1
  270. local max_port=$2
  271. # 1 <= port <= 65535
  272. if (in_between $min_port 1 65535); then
  273. if (in_between $max_port 1 65535); then
  274. if [[ $min_port -le $max_port ]]; then
  275. return 0
  276. fi
  277. fi
  278. fi
  279. err 5 "Invalid port(s): $min_port-$max_port"
  280. }