xref: /linux/tools/testing/selftests/net/lib.sh (revision fe259a1bb26ec78842c975d992331705b0c2c2e8) 
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]} > ${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		ns_list+=("${!ns_name}")
221	done
222	NS_LIST+=("${ns_list[@]}")
223}
224
225# Create netdevsim with given id and net namespace.
226create_netdevsim() {
227    local id="$1"
228    local ns="$2"
229
230    modprobe netdevsim &> /dev/null
231    udevadm settle
232
233    echo "$id 1" | ip netns exec $ns tee /sys/bus/netdevsim/new_device >/dev/null
234    local dev=$(ip netns exec $ns ls /sys/bus/netdevsim/devices/netdevsim$id/net)
235    ip -netns $ns link set dev $dev name nsim$id
236    ip -netns $ns link set dev nsim$id up
237
238    echo nsim$id
239}
240
241# Remove netdevsim with given id.
242cleanup_netdevsim() {
243    local id="$1"
244
245    if [ -d "/sys/bus/netdevsim/devices/netdevsim$id/net" ]; then
246        echo "$id" > /sys/bus/netdevsim/del_device
247    fi
248}
249
250tc_rule_stats_get()
251{
252	local dev=$1; shift
253	local pref=$1; shift
254	local dir=${1:-ingress}; shift
255	local selector=${1:-.packets}; shift
256
257	tc -j -s filter show dev $dev $dir pref $pref \
258	    | jq ".[1].options.actions[].stats$selector"
259}
260
261tc_rule_handle_stats_get()
262{
263	local id=$1; shift
264	local handle=$1; shift
265	local selector=${1:-.packets}; shift
266	local netns=${1:-""}; shift
267
268	tc $netns -j -s filter show $id \
269	    | jq ".[] | select(.options.handle == $handle) | \
270		  .options.actions[0].stats$selector"
271}
272
273# attach a qdisc with two children match/no-match and a flower filter to match
274tc_set_flower_counter() {
275	local -r ns=$1
276	local -r ipver=$2
277	local -r dev=$3
278	local -r flower_expr=$4
279
280	tc -n $ns qdisc add dev $dev root handle 1: prio bands 2 \
281			priomap 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
282
283	tc -n $ns qdisc add dev $dev parent 1:1 handle 11: pfifo
284	tc -n $ns qdisc add dev $dev parent 1:2 handle 12: pfifo
285
286	tc -n $ns filter add dev $dev parent 1: protocol ipv$ipver \
287			flower $flower_expr classid 1:2
288}
289
290tc_get_flower_counter() {
291	local -r ns=$1
292	local -r dev=$2
293
294	tc -n $ns -j -s qdisc show dev $dev handle 12: | jq .[0].packets
295}
296
297ret_set_ksft_status()
298{
299	local ksft_status=$1; shift
300	local msg=$1; shift
301
302	RET=$(ksft_status_merge $RET $ksft_status)
303	if (( $? )); then
304		retmsg=$msg
305	fi
306}
307
308log_test_result()
309{
310	local test_name=$1; shift
311	local opt_str=$1; shift
312	local result=$1; shift
313	local retmsg=$1; shift
314
315	printf "TEST: %-60s  [%s]\n" "$test_name $opt_str" "$result"
316	if [[ $retmsg ]]; then
317		printf "\t%s\n" "$retmsg"
318	fi
319}
320
321pause_on_fail()
322{
323	if [[ $PAUSE_ON_FAIL == yes ]]; then
324		echo "Hit enter to continue, 'q' to quit"
325		read a
326		[[ $a == q ]] && exit 1
327	fi
328}
329
330handle_test_result_pass()
331{
332	local test_name=$1; shift
333	local opt_str=$1; shift
334
335	log_test_result "$test_name" "$opt_str" " OK "
336}
337
338handle_test_result_fail()
339{
340	local test_name=$1; shift
341	local opt_str=$1; shift
342
343	log_test_result "$test_name" "$opt_str" FAIL "$retmsg"
344	pause_on_fail
345}
346
347handle_test_result_xfail()
348{
349	local test_name=$1; shift
350	local opt_str=$1; shift
351
352	log_test_result "$test_name" "$opt_str" XFAIL "$retmsg"
353	pause_on_fail
354}
355
356handle_test_result_skip()
357{
358	local test_name=$1; shift
359	local opt_str=$1; shift
360
361	log_test_result "$test_name" "$opt_str" SKIP "$retmsg"
362}
363
364log_test()
365{
366	local test_name=$1
367	local opt_str=$2
368
369	if [[ $# -eq 2 ]]; then
370		opt_str="($opt_str)"
371	fi
372
373	if ((RET == ksft_pass)); then
374		handle_test_result_pass "$test_name" "$opt_str"
375	elif ((RET == ksft_xfail)); then
376		handle_test_result_xfail "$test_name" "$opt_str"
377	elif ((RET == ksft_skip)); then
378		handle_test_result_skip "$test_name" "$opt_str"
379	else
380		handle_test_result_fail "$test_name" "$opt_str"
381	fi
382
383	EXIT_STATUS=$(ksft_exit_status_merge $EXIT_STATUS $RET)
384	return $RET
385}
386
387log_test_skip()
388{
389	RET=$ksft_skip retmsg= log_test "$@"
390}
391
392log_test_xfail()
393{
394	RET=$ksft_xfail retmsg= log_test "$@"
395}
396
397log_info()
398{
399	local msg=$1
400
401	echo "INFO: $msg"
402}
403
404tests_run()
405{
406	local current_test
407
408	for current_test in ${TESTS:-$ALL_TESTS}; do
409		in_defer_scope \
410			$current_test
411	done
412}
413
414# Whether FAILs should be interpreted as XFAILs. Internal.
415FAIL_TO_XFAIL=
416
417check_err()
418{
419	local err=$1
420	local msg=$2
421
422	if ((err)); then
423		if [[ $FAIL_TO_XFAIL = yes ]]; then
424			ret_set_ksft_status $ksft_xfail "$msg"
425		else
426			ret_set_ksft_status $ksft_fail "$msg"
427		fi
428	fi
429}
430
431check_fail()
432{
433	local err=$1
434	local msg=$2
435
436	check_err $((!err)) "$msg"
437}
438
439check_err_fail()
440{
441	local should_fail=$1; shift
442	local err=$1; shift
443	local what=$1; shift
444
445	if ((should_fail)); then
446		check_fail $err "$what succeeded, but should have failed"
447	else
448		check_err $err "$what failed"
449	fi
450}
451
452xfail()
453{
454	FAIL_TO_XFAIL=yes "$@"
455}
456
457xfail_on_slow()
458{
459	if [[ $KSFT_MACHINE_SLOW = yes ]]; then
460		FAIL_TO_XFAIL=yes "$@"
461	else
462		"$@"
463	fi
464}
465
466omit_on_slow()
467{
468	if [[ $KSFT_MACHINE_SLOW != yes ]]; then
469		"$@"
470	fi
471}
472
473xfail_on_veth()
474{
475	local dev=$1; shift
476	local kind
477
478	kind=$(ip -j -d link show dev $dev |
479			jq -r '.[].linkinfo.info_kind')
480	if [[ $kind = veth ]]; then
481		FAIL_TO_XFAIL=yes "$@"
482	else
483		"$@"
484	fi
485}
486
487mac_get()
488{
489	local if_name=$1
490
491	ip -j link show dev $if_name | jq -r '.[]["address"]'
492}
493
494kill_process()
495{
496	local pid=$1; shift
497
498	# Suppress noise from killing the process.
499	{ kill $pid && wait $pid; } 2>/dev/null
500}
501
502check_command()
503{
504	local cmd=$1; shift
505
506	if [[ ! -x "$(command -v "$cmd")" ]]; then
507		log_test_skip "$cmd not installed"
508		return $EXIT_STATUS
509	fi
510}
511
512require_command()
513{
514	local cmd=$1; shift
515
516	if ! check_command "$cmd"; then
517		exit $EXIT_STATUS
518	fi
519}
520
521ip_link_add()
522{
523	local name=$1; shift
524
525	ip link add name "$name" "$@"
526	defer ip link del dev "$name"
527}
528
529ip_link_set_master()
530{
531	local member=$1; shift
532	local master=$1; shift
533
534	ip link set dev "$member" master "$master"
535	defer ip link set dev "$member" nomaster
536}
537
538ip_link_set_addr()
539{
540	local name=$1; shift
541	local addr=$1; shift
542
543	local old_addr=$(mac_get "$name")
544	ip link set dev "$name" address "$addr"
545	defer ip link set dev "$name" address "$old_addr"
546}
547
548ip_link_is_up()
549{
550	local name=$1; shift
551
552	local state=$(ip -j link show "$name" |
553		      jq -r '(.[].flags[] | select(. == "UP")) // "DOWN"')
554	[[ $state == "UP" ]]
555}
556
557ip_link_set_up()
558{
559	local name=$1; shift
560
561	if ! ip_link_is_up "$name"; then
562		ip link set dev "$name" up
563		defer ip link set dev "$name" down
564	fi
565}
566
567ip_link_set_down()
568{
569	local name=$1; shift
570
571	if ip_link_is_up "$name"; then
572		ip link set dev "$name" down
573		defer ip link set dev "$name" up
574	fi
575}
576
577ip_addr_add()
578{
579	local name=$1; shift
580
581	ip addr add dev "$name" "$@"
582	defer ip addr del dev "$name" "$@"
583}
584
585ip_route_add()
586{
587	ip route add "$@"
588	defer ip route del "$@"
589}
590
591bridge_vlan_add()
592{
593	bridge vlan add "$@"
594	defer bridge vlan del "$@"
595}
596