path: root/tests/sys/net/routing/test_routing.sh

#
# Copyright (c) 2026 Pouria Mousavizadeh Tehrani <pouria@FreeBSD.org>
#
# SPDX-License-Identifier: BSD-2-Clause
#

. $(atf_get_srcdir)/../../common/vnet.subr

jq_rtentry()
{
	local route="$1"

	jq -r '.statistics."route-information"."route-table"."rt-family".[]."rt-entry".[] |
	    select(.destination == "'${route}'")'
}

jq_nhop_filter()
{
	local nhop="$1"
	local weight="$2"
	local metric="$3"

	jq -r 'select(.gateway == "'${nhop}'") |
	    select(.weight == '${weight}') |
	    select(.metric == '${metric}') |
	    .gateway'
}

jq_get_ifaof_nhop()
{
	local nhop_id="$1"
	local aifp_name="$2"

	jq -r '.statistics."route-nhop-information"."nhop-table"."rt-family".[]."nh-entry".[] |
	    select(.index == '${nhop_id}') |
	    select(."address-interface-name" == "'${aifp_name}'") |
	    .ifa'
}

atf_test_case "add_lowest_metric" "cleanup"
add_lowest_metric_head()
{
	atf_set descr 'Create 4 routes to same dst and verify the lowest metric wins'
	atf_set require.user root
	atf_set require.progs jq
}
add_lowest_metric_body()
{
	local epair laddr route nhop1 nhop2 nhop3

	laddr="3fff::1"
	route="3fff:a::"
	nhop1="3fff::1"
	nhop2="3fff::2"
	nhop3="3fff::3"

	vnet_init
	epair=$(vnet_mkepair)

	atf_check -o ignore \
	    ifconfig ${epair}a inet6 ${laddr} up

	# Create an ECMP route with metric 2
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop2} -weight 10 -metric 2
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop3} -weight 10 -metric 2

	# Validate routes
	atf_check -o save:netstat \
	    netstat -rn6 --libxo json
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 10 2)
	atf_check_equal "$output" "$nhop2"
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop3} 10 2)
	atf_check_equal "$output" "$nhop3"

	# Create a route with metric 3
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop1} -metric 3
	# Verify that nhop1 is not the best route
	atf_check -o not-match:".*gateway: ${nhop1}.*" \
	    route -n6 get -net ${route}/64

	# Create a route to the same nhop with same metric 3 and verify it fails
	atf_check -s exit:1 -o ignore -e match:".*exists.*" \
	    route -6 add -net ${route}/64 -gateway ${nhop1} -metric 3

	# Create a route to an existing nhop with lower metric
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop1} -metric 1
	# Verify that nhop1 is now the best route
	atf_check -o match:".*gateway: ${nhop1}.*" \
	    route -n6 get -net ${route}/64
}
add_lowest_metric_cleanup()
{
	vnet_cleanup
}

atf_test_case "add_default_metric" "cleanup"
add_default_metric_head()
{
	atf_set descr 'Create a route and verify the default metric is set'
	atf_set require.user root
	atf_set require.progs jq
}
add_default_metric_body()
{
	local epair laddr route nhop1

	laddr="3fff::1"
	route="3fff:a::"
	nhop1="3fff::1"

	vnet_init
	epair=$(vnet_mkepair)

	atf_check -o ignore \
	    ifconfig ${epair}a inet6 ${laddr} up

	# Create a route without specifying its metric
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop1}

	# Verify the route has the default metric of 1
	atf_check -o save:netstat \
	    netstat -rn6 --libxo json
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop1} 1 1)
	atf_check_equal "$output" "$nhop1"
}
add_default_metric_cleanup()
{
	vnet_cleanup
}

atf_test_case "delete_route_with_metric" "cleanup"
delete_route_with_metric_head()
{
	atf_set descr 'Create multiple routes to same dst and delete routes with specific metric'
	atf_set require.user root
	atf_set require.progs jq
}
delete_route_with_metric_body()
{
	local epair laddr route nhop1 nhop2

	laddr="3fff::1"
	route="3fff:a::"
	nhop1="3fff::1"
	nhop2="3fff::2"

	vnet_init
	epair=$(vnet_mkepair)

	atf_check -o ignore \
	    ifconfig ${epair}a inet6 ${laddr} up

	# Create two groups of ECMP routes with metric 2 and 3, and
	# another route with metric 4.
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop1} -metric 3
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop1} -weight 10 -metric 2
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop2} -weight 10 -metric 2
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop2} -metric 3
	atf_check -o ignore \
	    route -6 add -net ${route}/64 -gateway ${nhop2} -metric 4

	# Validate we have 5 routes
	atf_check -o save:netstat \
	    netstat -rn6 --libxo json
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop1} 1 3)
	atf_check_equal "$output" "$nhop1"
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop1} 10 2)
	atf_check_equal "$output" "$nhop1"
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 10 2)
	atf_check_equal "$output" "$nhop2"
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 1 3)
	atf_check_equal "$output" "$nhop2"
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 1 4)
	atf_check_equal "$output" "$nhop2"

	# Delete one of the nexthops of them best ECMP route
	# Test that deleting a route by specifying gateway + metric works.
	atf_check -o ignore \
	    route -n6 delete -net ${route}/64 -gateway ${nhop2} -metric 2

	# Verify that nhop1 is the best route now
	atf_check -o match:".*gateway: ${nhop1}.*" \
	    route -n6 get -net ${route}/64

	# But other route with nhops2 should exists.
	atf_check -o save:netstat \
	    netstat -rn6 --libxo json
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 1 3)
	atf_check_equal "$output" "$nhop2"
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 1 4)
	atf_check_equal "$output" "$nhop2"

	# Delete routes with nhop1 as nexthop without specifying metric.
	# Test that deleting a route by gateway removes all routes with
	# that gateway, regardless of metric value.
	atf_check -o ignore \
	    route -n6 delete -net ${route}/64 -gateway ${nhop1}

	# Verify that nhop2 is the best route now
	atf_check -o match:".*gateway: ${nhop2}.*" \
	    route -n6 get -net ${route}/64

	# Delete routes with metric 3 without specifying their gateway.
	# Test that deleting a route by metric removes all routes with
	# that metric, regardless of gateway value.
	atf_check -o ignore \
	    route -n6 delete -net ${route}/64 -metric 3

	# Verify that nhop2 is still the best route with metric of 4
	atf_check -o match:".*gateway: ${nhop2}.*" \
	    route -n6 get -net ${route}/64
	output=$(cat netstat | jq_rtentry ${route}/64 | jq_nhop_filter ${nhop2} 1 4)
	atf_check_equal "$output" "$nhop2"
}
delete_route_with_metric_cleanup()
{
	vnet_cleanup
}

atf_test_case "test_ecmp_routes_by_event" "cleanup"
test_ecmp_routes_by_event_head()
{
	atf_set descr 'Test reachability of ECMP routes when an ifp gets down'
	atf_set require.user root
}
test_ecmp_routes_by_event_body()
{
	local jname epair0 epair1 lo0_addr lo1_addr ep0_prefix ep1_prefix

	jname="ecmp_route_by_event"
	lo0_addr="3fff:a::1"
	lo1_addr="3fff:b::1"
	ep0_prefix="3fff:1::"
	ep1_prefix="3fff:2::"

	vnet_init
	epair0=$(vnet_mkepair)
	epair1=$(vnet_mkepair)

	vnet_mkjail ${jname} ${epair0}b
	atf_check -o ignore \
	    ifconfig ${epair1}b vnet ${jname}

	atf_check -o ignore \
	    ifconfig ${epair0}a inet6 ${ep0_prefix}a/127 up
	atf_check -o ignore \
	    ifconfig ${epair1}a inet6 ${ep1_prefix}a/127 up
	atf_check -o ignore \
	    ifconfig -j ${jname} ${epair0}b inet6 ${ep0_prefix}b/127 up
	atf_check -o ignore \
	    ifconfig -j ${jname} ${epair1}b inet6 ${ep1_prefix}b/127 up
	atf_check -o ignore \
	    ifconfig lo0 inet6 ${lo0_addr}/128 up
	atf_check -o ignore \
	    ifconfig -j ${jname} lo0 inet6 ${lo1_addr}/128 up

	# Create ECMP routes with via epair0 and epair1 to loopback
	atf_check -o ignore \
	    route -6 add -net ${lo1_addr}/128 -gateway ${ep0_prefix}b
	atf_check -o ignore \
	    route -6 add -net ${lo1_addr}/128 -gateway ${ep1_prefix}b
	atf_check -o ignore \
	    route -6j ${jname} add -net ${lo0_addr}/128 -gateway ${ep0_prefix}a
	atf_check -o ignore \
	    route -6j ${jname} add -net ${lo0_addr}/128 -gateway ${ep1_prefix}a

	# Check the connection
	atf_check -o ignore ping -c1 -t1 ${ep0_prefix}b
	atf_check -o ignore ping -c1 -t1 ${ep1_prefix}b
	atf_check -o ignore ping -c1 -t1 -S ${lo0_addr} ${lo1_addr}

	# Down one of the nexthop interfaces
	atf_check -o ignore \
	    ifconfig ${epair0}a down
	# Since epair doesn't support linkstate and we need to receive
	# the icmp reply, shutdown the other side of epair too
	atf_check -o ignore \
	    ifconfig -j${jname} ${epair0}b down

	# Test if our destination is still reachable
	sleep 0.01
	atf_check -o ignore ping -c1 -t1 -S ${lo0_addr} ${lo1_addr}

	# Do the same thing for other interface
	atf_check -o ignore \
	    ifconfig ${epair0}a up
	atf_check -o ignore \
	    ifconfig -j${jname} ${epair0}b up
	atf_check -o ignore \
	    ifconfig ${epair1}a down
	atf_check -o ignore \
	    ifconfig -j${jname} ${epair1}b down

	# Test if our destination is still reachable
	sleep 0.01
	atf_check -o ignore ping -c1 -t1 -S ${lo0_addr} ${lo1_addr}
}
test_ecmp_routes_by_event_cleanup()
{
	vnet_cleanup
}

atf_test_case "add_v4route_with_prefsrc" "cleanup"
add_v4route_with_prefsrc_head()
{
	atf_set descr 'Test prefsrc attribute on IPv4 route'
	atf_set require.user root
	atf_set require.progs jq
}
add_v4route_with_prefsrc_body()
{
	local jname epair0 lo0_addr ep0_prefix testprefix nhop_id ifa

	jname="add_v4route_with_prefsrc"
	lo0_addr="192.168.1.1"
	ep0_prefix="172.16.1."
	testprefix="10.0.0.0/24"

	vnet_init
	epair0=$(vnet_mkepair)

	vnet_mkjail ${jname} ${epair0}b

	atf_check ifconfig lo0 inet ${lo0_addr}/32 alias up
	atf_check ifconfig ${epair0}a inet ${ep0_prefix}1/30 up
	atf_check ifconfig -j ${jname} ${epair0}b inet ${ep0_prefix}2/30 up

	# Create an IPv4 route via epair0 with loopback address as its prefsrc
	atf_check -o ignore \
	    route -4 add -net ${testprefix} -gateway ${ep0_prefix}2 \
	    -prefsrc ${lo0_addr}

	# Check the connection
	atf_check -o ignore ping -c1 -t1 ${ep0_prefix}2

	# Verify that nexthop's ifa is set to our prefsrc
	atf_check -o save:netstat \
	    netstat -rn4 --libxo json
	nhop_id=$(cat netstat | jq_rtentry ${testprefix} | jq '."nhop-kidx"')
	atf_check -o save:netstat \
	    netstat -on4W --libxo json
	ifa=$(cat netstat | jq_get_ifaof_nhop ${nhop_id} lo0)
	atf_check_equal "$ifa" "$lo0_addr"
}
add_v4route_with_prefsrc_cleanup()
{
	vnet_cleanup
}

atf_test_case "add_v6route_with_prefsrc" "cleanup"
add_v6route_with_prefsrc_head()
{
	atf_set descr 'Test prefsrc attribute on IPv6 route'
	atf_set require.user root
	atf_set require.progs jq
}
add_v6route_with_prefsrc_body()
{
	local jname epair0 lo0_addr ep0_prefix testprefix nhop_id ifa

	jname="add_v6route_with_prefsrc"
	lo0_addr="3fff::1"
	ep0_prefix="3fff:a::"
	testprefix="2001:db8::/48"

	vnet_init
	epair0=$(vnet_mkepair)

	vnet_mkjail ${jname} ${epair0}b

	atf_check ifconfig lo0 inet6 ${lo0_addr}/128 up
	atf_check ifconfig ${epair0}a inet6 ${ep0_prefix}a/127 up
	atf_check ifconfig -j ${jname} ${epair0}b inet6 ${ep0_prefix}b/127 up

	# Create an IPv6 route via epair0 with loopback address as its prefsrc
	atf_check -o ignore \
	    route -6 add -net ${testprefix} -gateway ${ep0_prefix}b \
	    -prefsrc ${lo0_addr}

	# Check the connection
	atf_check -o ignore ping -c1 -t1 ${ep0_prefix}b

	# Verify that nexthop's ifa is set to our prefsrc
	atf_check -o save:netstat \
	    netstat -rn6 --libxo json
	nhop_id=$(cat netstat | jq_rtentry ${testprefix} | jq '."nhop-kidx"')
	atf_check -o save:netstat \
	    netstat -on6W --libxo json
	ifa=$(cat netstat | jq_get_ifaof_nhop ${nhop_id} lo0)
	atf_check_equal "$ifa" "$lo0_addr"
}
add_v6route_with_prefsrc_cleanup()
{
	vnet_cleanup
}

atf_test_case "add_v4v6route_with_prefsrc" "cleanup"
add_v4v6route_with_prefsrc_head()
{
	atf_set descr 'Test prefsrc attribute on IPv4 route over IPv6 nexthop'
	atf_set require.user root
	atf_set require.progs jq
}
add_v4v6route_with_prefsrc_body()
{
	local jname epair0 lo0_addr ep0_prefix testprefix nhop_id ifa

	jname="add_v4v6route_with_prefsrc"
	lo0_addr="192.168.1.1"
	ep0_prefix="3fff:a::"
	testprefix="10.0.0.0/24"

	vnet_init
	epair0=$(vnet_mkepair)

	vnet_mkjail ${jname} ${epair0}b

	atf_check ifconfig lo0 inet ${lo0_addr}/32 alias up
	atf_check ifconfig ${epair0}a inet6 ${ep0_prefix}a/127 up
	atf_check ifconfig -j ${jname} ${epair0}b inet6 ${ep0_prefix}b/127 up

	# Create an IPv4 route via epair0 with IPv6 nexthop
	# and loopback address as its prefsrc
	atf_check -o ignore \
	    route -4 add -net ${testprefix} -inet6 -gateway ${ep0_prefix}b \
	    -inet -prefsrc ${lo0_addr}

	# Check the connection
	atf_check -o ignore ping -c1 -t1 ${ep0_prefix}b

	# Verify that nexthop's ifa is set to our prefsrc
	atf_check -o save:netstat \
	    netstat -rn4 --libxo json
	nhop_id=$(cat netstat | jq_rtentry ${testprefix} | jq '."nhop-kidx"')
	atf_check -o save:netstat \
	    netstat -on6W --libxo json
	ifa=$(cat netstat | jq_get_ifaof_nhop ${nhop_id} lo0)
	atf_check_equal "$ifa" "$lo0_addr"
}
add_v4v6route_with_prefsrc_cleanup()
{
	vnet_cleanup
}

atf_init_test_cases()
{
	atf_add_test_case "add_lowest_metric"
	atf_add_test_case "add_default_metric"
	atf_add_test_case "delete_route_with_metric"
	atf_add_test_case "test_ecmp_routes_by_event"
	atf_add_test_case "add_v4route_with_prefsrc"
	atf_add_test_case "add_v6route_with_prefsrc"
	atf_add_test_case "add_v4v6route_with_prefsrc"
}