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