xref: /linux/tools/testing/selftests/net/lib.sh (revision 10407eebe8861802d5117956604f94d364df85d5) 
1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0
3
4net_dir=$(dirname "$(readlink -e "${BASH_SOURCE[0]}")")
5source "$net_dir/lib/sh/defer.sh"
6
7##############################################################################
8# Defines
9
10: "${WAIT_TIMEOUT:=20}"
11
12# Whether to pause on after a failure.
13: "${PAUSE_ON_FAIL:=no}"
14
15BUSYWAIT_TIMEOUT=$((WAIT_TIMEOUT * 1000)) # ms
16
17# Kselftest framework constants.
18ksft_pass=0
19ksft_fail=1
20ksft_xfail=2
21ksft_skip=4
22
23# namespace list created by setup_ns
24NS_LIST=()
25
26# Exit status to return at the end. Set in case one of the tests fails.
27EXIT_STATUS=0
28# Per-test return value. Clear at the beginning of each test.
29RET=0
30
31##############################################################################
32# Helpers
33
34__ksft_status_merge()
35{
36	local a=$1; shift
37	local b=$1; shift
38	local -A weights
39	local weight=0
40
41	local i
42	for i in "$@"; do
43		weights[$i]=$((weight++))
44	done
45
46	if [[ ${weights[$a]} -ge ${weights[$b]} ]]; then
47		echo "$a"
48		return 0
49	else
50		echo "$b"
51		return 1
52	fi
53}
54
55ksft_status_merge()
56{
57	local a=$1; shift
58	local b=$1; shift
59
60	__ksft_status_merge "$a" "$b" \
61		$ksft_pass $ksft_xfail $ksft_skip $ksft_fail
62}
63
64ksft_exit_status_merge()
65{
66	local a=$1; shift
67	local b=$1; shift
68
69	__ksft_status_merge "$a" "$b" \
70		$ksft_xfail $ksft_pass $ksft_skip $ksft_fail
71}
72
73loopy_wait()
74{
75	local sleep_cmd=$1; shift
76	local timeout_ms=$1; shift
77
78	local start_time="$(date -u +%s%3N)"
79	while true
80	do
81		local out
82		if out=$("$@"); then
83			echo -n "$out"
84			return 0
85		fi
86
87		local current_time="$(date -u +%s%3N)"
88		if ((current_time - start_time > timeout_ms)); then
89			echo -n "$out"
90			return 1
91		fi
92
93		$sleep_cmd
94	done
95}
96
97busywait()
98{
99	local timeout_ms=$1; shift
100
101	loopy_wait : "$timeout_ms" "$@"
102}
103
104# timeout in seconds
105slowwait()
106{
107	local timeout_sec=$1; shift
108
109	loopy_wait "sleep 0.1" "$((timeout_sec * 1000))" "$@"
110}
111
112until_counter_is()
113{
114	local expr=$1; shift
115	local current=$("$@")
116
117	echo $((current))
118	((current $expr))
119}
120
121busywait_for_counter()
122{
123	local timeout=$1; shift
124	local delta=$1; shift
125
126	local base=$("$@")
127	busywait "$timeout" until_counter_is ">= $((base + delta))" "$@"
128}
129
130slowwait_for_counter()
131{
132	local timeout=$1; shift
133	local delta=$1; shift
134
135	local base=$("$@")
136	slowwait "$timeout" until_counter_is ">= $((base + delta))" "$@"
137}
138
139# Check for existence of tools which are built as part of selftests
140# but may also already exist in $PATH
141check_gen_prog()
142{
143	local prog_name=$1; shift
144
145	if ! which $prog_name >/dev/null 2>/dev/null; then
146		PATH=$PWD:$PATH
147		if ! which $prog_name >/dev/null; then
148			echo "'$prog_name' command not found; skipping tests"
149			exit $ksft_skip
150		fi
151	fi
152}
153
154remove_ns_list()
155{
156	local item=$1
157	local ns
158	local ns_list=("${NS_LIST[@]}")
159	NS_LIST=()
160
161	for ns in "${ns_list[@]}"; do
162		if [ "${ns}" != "${item}" ]; then
163			NS_LIST+=("${ns}")
164		fi
165	done
166}
167
168cleanup_ns()
169{
170	local ns=""
171	local ret=0
172
173	for ns in "$@"; do
174		[ -z "${ns}" ] && continue
175		ip netns pids "${ns}" 2> /dev/null | xargs -r kill || true
176		ip netns delete "${ns}" &> /dev/null || true
177		if ! busywait $BUSYWAIT_TIMEOUT ip netns list \| grep -vq "^$ns$" &> /dev/null; then
178			echo "Warn: Failed to remove namespace $ns"
179			ret=1
180		else
181			remove_ns_list "${ns}"
182		fi
183	done
184
185	return $ret
186}
187
188cleanup_all_ns()
189{
190	cleanup_ns "${NS_LIST[@]}"
191}
192
193# setup netns with given names as prefix. e.g
194# setup_ns local remote
195setup_ns()
196{
197	local ns_name=""
198	local ns_list=()
199	for ns_name in "$@"; do
200		# avoid conflicts with local var: internal error
201		if [ "${ns_name}" = "ns_name" ]; then
202			echo "Failed to setup namespace '${ns_name}': invalid name"
203			cleanup_ns "${ns_list[@]}"
204			exit $ksft_fail
205		fi
206
207		# Some test may setup/remove same netns multi times
208		if [ -z "${!ns_name}" ]; then
209			eval "${ns_name}=${ns_name,,}-$(mktemp -u XXXXXX)"
210		else
211			cleanup_ns "${!ns_name}"
212		fi
213
214		if ! ip netns add "${!ns_name}"; then
215			echo "Failed to create namespace $ns_name"
216			cleanup_ns "${ns_list[@]}"
217			return $ksft_skip
218		fi
219		ip -n "${!ns_name}" link set lo up
220		ip netns exec "${!ns_name}" sysctl -wq net.ipv4.conf.all.rp_filter=0
221		ip netns exec "${!ns_name}" sysctl -wq net.ipv4.conf.default.rp_filter=0
222		ns_list+=("${!ns_name}")
223	done
224	NS_LIST+=("${ns_list[@]}")
225}
226
227in_all_ns()
228{
229	local ret=0
230	local ns_list=("${NS_LIST[@]}")
231
232	for ns in "${ns_list[@]}"; do
233		ip netns exec "${ns}" "$@"
234		(( ret = ret || $? ))
235	done
236
237	return "${ret}"
238}
239
240# Create netdevsim with given id and net namespace.
241create_netdevsim() {
242    local id="$1"
243    local ns="$2"
244
245    modprobe netdevsim &> /dev/null
246    udevadm settle
247
248    echo "$id 1" | ip netns exec $ns tee /sys/bus/netdevsim/new_device >/dev/null
249    local dev=$(ip netns exec $ns ls /sys/bus/netdevsim/devices/netdevsim$id/net)
250    ip -netns $ns link set dev $dev name nsim$id
251    ip -netns $ns link set dev nsim$id up
252
253    echo nsim$id
254}
255
256create_netdevsim_port() {
257    local nsim_id="$1"
258    local ns="$2"
259    local port_id="$3"
260    local perm_addr="$4"
261    local orig_dev
262    local new_dev
263    local nsim_path
264
265    nsim_path="/sys/bus/netdevsim/devices/netdevsim$nsim_id"
266
267    echo "$port_id $perm_addr" | ip netns exec "$ns" tee "$nsim_path"/new_port > /dev/null || return 1
268
269    orig_dev=$(ip netns exec "$ns" find "$nsim_path"/net/ -maxdepth 1 -name 'e*' | tail -n 1)
270    orig_dev=$(basename "$orig_dev")
271    new_dev="nsim${nsim_id}p$port_id"
272
273    ip -netns "$ns" link set dev "$orig_dev" name "$new_dev"
274    ip -netns "$ns" link set dev "$new_dev" up
275
276    echo "$new_dev"
277}
278
279# Remove netdevsim with given id.
280cleanup_netdevsim() {
281    local id="$1"
282
283    if [ -d "/sys/bus/netdevsim/devices/netdevsim$id/net" ]; then
284        echo "$id" > /sys/bus/netdevsim/del_device
285    fi
286}
287
288tc_rule_stats_get()
289{
290	local dev=$1; shift
291	local pref=$1; shift
292	local dir=${1:-ingress}; shift
293	local selector=${1:-.packets}; shift
294
295	tc -j -s filter show dev $dev $dir pref $pref \
296	    | jq ".[] | select(.options.actions) |
297		  .options.actions[].stats$selector"
298}
299
300tc_rule_handle_stats_get()
301{
302	local id=$1; shift
303	local handle=$1; shift
304	local selector=${1:-.packets}; shift
305	local netns=${1:-""}; shift
306
307	tc $netns -j -s filter show $id \
308	    | jq ".[] | select(.options.handle == $handle) | \
309		  .options.actions[0].stats$selector"
310}
311
312# attach a qdisc with two children match/no-match and a flower filter to match
313tc_set_flower_counter() {
314	local -r ns=$1
315	local -r ipver=$2
316	local -r dev=$3
317	local -r flower_expr=$4
318
319	tc -n $ns qdisc add dev $dev root handle 1: prio bands 2 \
320			priomap 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
321
322	tc -n $ns qdisc add dev $dev parent 1:1 handle 11: pfifo
323	tc -n $ns qdisc add dev $dev parent 1:2 handle 12: pfifo
324
325	tc -n $ns filter add dev $dev parent 1: protocol ipv$ipver \
326			flower $flower_expr classid 1:2
327}
328
329tc_get_flower_counter() {
330	local -r ns=$1
331	local -r dev=$2
332
333	tc -n $ns -j -s qdisc show dev $dev handle 12: | jq .[0].packets
334}
335
336ret_set_ksft_status()
337{
338	local ksft_status=$1; shift
339	local msg=$1; shift
340
341	RET=$(ksft_status_merge $RET $ksft_status)
342	if (( $? )); then
343		retmsg=$msg
344	fi
345}
346
347log_test_result()
348{
349	local test_name=$1; shift
350	local opt_str=$1; shift
351	local result=$1; shift
352	local retmsg=$1
353
354	printf "TEST: %-60s  [%s]\n" "$test_name $opt_str" "$result"
355	if [[ $retmsg ]]; then
356		printf "\t%s\n" "$retmsg"
357	fi
358}
359
360pause_on_fail()
361{
362	if [[ $PAUSE_ON_FAIL == yes ]]; then
363		echo "Hit enter to continue, 'q' to quit"
364		read a
365		[[ $a == q ]] && exit 1
366	fi
367}
368
369handle_test_result_pass()
370{
371	local test_name=$1; shift
372	local opt_str=$1; shift
373
374	log_test_result "$test_name" "$opt_str" " OK "
375}
376
377handle_test_result_fail()
378{
379	local test_name=$1; shift
380	local opt_str=$1; shift
381
382	log_test_result "$test_name" "$opt_str" FAIL "$retmsg"
383	pause_on_fail
384}
385
386handle_test_result_xfail()
387{
388	local test_name=$1; shift
389	local opt_str=$1; shift
390
391	log_test_result "$test_name" "$opt_str" XFAIL "$retmsg"
392	pause_on_fail
393}
394
395handle_test_result_skip()
396{
397	local test_name=$1; shift
398	local opt_str=$1; shift
399
400	log_test_result "$test_name" "$opt_str" SKIP "$retmsg"
401}
402
403log_test()
404{
405	local test_name=$1
406	local opt_str=$2
407
408	if [[ $# -eq 2 ]]; then
409		opt_str="($opt_str)"
410	fi
411
412	if ((RET == ksft_pass)); then
413		handle_test_result_pass "$test_name" "$opt_str"
414	elif ((RET == ksft_xfail)); then
415		handle_test_result_xfail "$test_name" "$opt_str"
416	elif ((RET == ksft_skip)); then
417		handle_test_result_skip "$test_name" "$opt_str"
418	else
419		handle_test_result_fail "$test_name" "$opt_str"
420	fi
421
422	EXIT_STATUS=$(ksft_exit_status_merge $EXIT_STATUS $RET)
423	return $RET
424}
425
426log_test_skip()
427{
428	RET=$ksft_skip retmsg= log_test "$@"
429}
430
431log_test_xfail()
432{
433	RET=$ksft_xfail retmsg= log_test "$@"
434}
435
436log_info()
437{
438	local msg=$1
439
440	echo "INFO: $msg"
441}
442
443tests_run()
444{
445	local current_test
446
447	for current_test in ${TESTS:-$ALL_TESTS}; do
448		in_defer_scope \
449			$current_test
450	done
451}
452
453# Whether FAILs should be interpreted as XFAILs. Internal.
454FAIL_TO_XFAIL=
455
456check_err()
457{
458	local err=$1
459	local msg=$2
460
461	if ((err)); then
462		if [[ $FAIL_TO_XFAIL = yes ]]; then
463			ret_set_ksft_status $ksft_xfail "$msg"
464		else
465			ret_set_ksft_status $ksft_fail "$msg"
466		fi
467	fi
468}
469
470check_fail()
471{
472	local err=$1
473	local msg=$2
474
475	check_err $((!err)) "$msg"
476}
477
478check_err_fail()
479{
480	local should_fail=$1; shift
481	local err=$1; shift
482	local what=$1; shift
483
484	if ((should_fail)); then
485		check_fail $err "$what succeeded, but should have failed"
486	else
487		check_err $err "$what failed"
488	fi
489}
490
491xfail()
492{
493	FAIL_TO_XFAIL=yes "$@"
494}
495
496xfail_on_slow()
497{
498	if [[ $KSFT_MACHINE_SLOW = yes ]]; then
499		FAIL_TO_XFAIL=yes "$@"
500	else
501		"$@"
502	fi
503}
504
505omit_on_slow()
506{
507	if [[ $KSFT_MACHINE_SLOW != yes ]]; then
508		"$@"
509	fi
510}
511
512xfail_on_veth()
513{
514	local dev=$1; shift
515	local kind
516
517	kind=$(ip -j -d link show dev $dev |
518			jq -r '.[].linkinfo.info_kind')
519	if [[ $kind = veth ]]; then
520		FAIL_TO_XFAIL=yes "$@"
521	else
522		"$@"
523	fi
524}
525
526mac_get()
527{
528	local if_name=$1
529
530	run_on "$if_name" \
531		ip -j link show dev "$if_name" | jq -r '.[]["address"]'
532}
533
534kill_process()
535{
536	local pid=$1; shift
537
538	# Suppress noise from killing the process.
539	{ kill $pid && wait $pid; } 2>/dev/null
540}
541
542check_command()
543{
544	local cmd=$1; shift
545
546	if [[ ! -x "$(command -v "$cmd")" ]]; then
547		log_test_skip "$cmd not installed"
548		return $EXIT_STATUS
549	fi
550}
551
552require_command()
553{
554	local cmd=$1; shift
555
556	if ! check_command "$cmd"; then
557		exit $EXIT_STATUS
558	fi
559}
560
561adf_ip_link_add()
562{
563	local name=$1; shift
564
565	ip link add name "$name" "$@" && \
566		defer ip link del dev "$name"
567}
568
569adf_ip_link_set_master()
570{
571	local member=$1; shift
572	local master=$1; shift
573
574	ip link set dev "$member" master "$master" && \
575		defer ip link set dev "$member" nomaster
576}
577
578adf_ip_link_set_addr()
579{
580	local name=$1; shift
581	local addr=$1; shift
582
583	local old_addr=$(mac_get "$name")
584	ip link set dev "$name" address "$addr" && \
585		defer ip link set dev "$name" address "$old_addr"
586}
587
588ip_link_has_flag()
589{
590	local name=$1; shift
591	local flag=$1; shift
592
593	local state=$(ip -j link show "$name" |
594		      jq --arg flag "$flag" 'any(.[].flags[]; . == $flag)')
595	[[ $state == true ]]
596}
597
598ip_link_is_up()
599{
600	ip_link_has_flag "$1" UP
601}
602
603adf_ip_link_set_up()
604{
605	local name=$1; shift
606
607	if ! ip_link_is_up "$name"; then
608		ip link set dev "$name" up && \
609			defer ip link set dev "$name" down
610	fi
611}
612
613adf_ip_link_set_down()
614{
615	local name=$1; shift
616
617	if ip_link_is_up "$name"; then
618		ip link set dev "$name" down && \
619			defer ip link set dev "$name" up
620	fi
621}
622
623adf_ip_addr_add()
624{
625	local name=$1; shift
626
627	ip addr add dev "$name" "$@" && \
628		defer ip addr del dev "$name" "$@"
629}
630
631adf_ip_route_add()
632{
633	ip route add "$@" && \
634		defer ip route del "$@"
635}
636
637adf_bridge_vlan_add()
638{
639	bridge vlan add "$@" && \
640		defer bridge vlan del "$@"
641}
642
643wait_local_port_listen()
644{
645	local listener_ns="${1}"
646	local port="${2}"
647	local protocol="${3}"
648	local pattern
649	local i
650
651	pattern=":$(printf "%04X" "${port}") "
652
653	# for tcp protocol additionally check the socket state
654	[ ${protocol} = "tcp" ] && pattern="${pattern}0A"
655	for i in $(seq 10); do
656		if ip netns exec "${listener_ns}" awk '{print $2" "$4}' \
657		   /proc/net/"${protocol}"* | grep -q "${pattern}"; then
658			break
659		fi
660		sleep 0.1
661	done
662}
663
664cmd_jq()
665{
666	local cmd=$1
667	local jq_exp=$2
668	local jq_opts=$3
669	local ret
670	local output
671
672	output="$($cmd)"
673	# it the command fails, return error right away
674	ret=$?
675	if [[ $ret -ne 0 ]]; then
676		return $ret
677	fi
678	output=$(echo $output | jq -r $jq_opts "$jq_exp")
679	ret=$?
680	if [[ $ret -ne 0 ]]; then
681		return $ret
682	fi
683	echo $output
684	# return success only in case of non-empty output
685	[ ! -z "$output" ]
686}
687
688run_on()
689{
690	shift; "$@"
691}
692