# $FreeBSD$
#
# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
#
# Copyright (c) 2021 Rubicon Communications, LLC (Netgate)
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.

. $(atf_get_srcdir)/utils.subr
. $(atf_get_srcdir)/runner.subr

pipe_head()
{
	atf_set descr 'Basic pipe test'
	atf_set require.user root
}

pipe_body()
{
	fw=$1
	firewall_init $fw
	dummynet_init $fw

	epair=$(vnet_mkepair)
	vnet_mkjail alcatraz ${epair}b

	ifconfig ${epair}a 192.0.2.1/24 up
	jexec alcatraz ifconfig ${epair}b 192.0.2.2/24 up

	# Sanity check
	atf_check -s exit:0 -o ignore ping -i .1 -c 3 -s 1200 192.0.2.2

	jexec alcatraz dnctl pipe 1 config bw 30Byte/s

	firewall_config alcatraz ${fw} \
		"ipfw"	\
			"ipfw add 1000 pipe 1 ip from any to any"

	# single ping succeeds just fine
	atf_check -s exit:0 -o ignore ping -c 1 192.0.2.2

	# Saturate the link
	ping -i .1 -c 5 -s 1200 192.0.2.2

	# We should now be hitting the limits and get this packet dropped.
	atf_check -s exit:2 -o ignore ping -c 1 -s 1200 192.0.2.2
}

pipe_cleanup()
{
	firewall_cleanup $1
}

pipe_v6_head()
{
	atf_set descr 'Basic IPv6 pipe test'
	atf_set require.user root
}

pipe_v6_body()
{
	fw=$1
	firewall_init $fw
	dummynet_init $fw

	epair=$(vnet_mkepair)
	vnet_mkjail alcatraz ${epair}b

	ifconfig ${epair}a inet6 2001:db8:42::1/64 up no_dad
	jexec alcatraz ifconfig ${epair}b inet6 2001:db8:42::2/64 up no_dad

	# Sanity check
	atf_check -s exit:0 -o ignore ping6 -i .1 -c 3 -s 1200 2001:db8:42::2

	jexec alcatraz dnctl pipe 1 config bw 100Byte/s

	firewall_config alcatraz ${fw} \
		"ipfw"	\
			"ipfw add 1000 pipe 1 ip6 from any to any"

	# Single ping succeeds
	atf_check -s exit:0 -o ignore ping6 -c 1 2001:db8:42::2

	# Saturate the link
	ping6 -i .1 -c 5 -s 1200 2001:db8:42::2

	# We should now be hitting the limit and get this packet dropped.
	atf_check -s exit:2 -o ignore ping6 -c 1 -s 1200 2001:db8:42::2
}

pipe_v6_cleanup()
{
	firewall_cleanup $1
}

queue_head()
{
	atf_set descr 'Basic queue test'
	atf_set require.user root
}

queue_body()
{
	fw=$1
	firewall_init $fw
	dummynet_init $fw

	epair=$(vnet_mkepair)
	vnet_mkjail alcatraz ${epair}b

	ifconfig ${epair}a 192.0.2.1/24 up
	jexec alcatraz ifconfig ${epair}b 192.0.2.2/24 up
	jexec alcatraz /usr/sbin/inetd -p inetd-alcatraz.pid \
	    $(atf_get_srcdir)/../pf/echo_inetd.conf

	# Sanity check
	atf_check -s exit:0 -o ignore ping -i .1 -c 3 -s 1200 192.0.2.2

	reply=$(echo "foo" | nc -w 5 -N 192.0.2.2 7)
	if [ "$reply" != "foo" ];
	then
		atf_fail "Echo sanity check failed"
	fi

	jexec alcatraz dnctl pipe 1 config bw 200Byte/s
	jexec alcatraz dnctl sched 1 config pipe 1 type qfq
	jexec alcatraz dnctl queue 1 config sched 1 weight 99
	jexec alcatraz dnctl queue 2 config sched 1 weight 1

	firewall_config alcatraz ${fw} \
		"ipfw"	\
			"ipfw add queue 2 icmp from any to any" \
			"ipfw add queue 1 tcp from any to any"

	# Single ping succeeds
	atf_check -s exit:0 -o ignore ping -c 1 192.0.2.2

	# Uncongested TCP works.
	reply=$(echo "foo" | nc -w 5 -N 192.0.2.2 7)
	if [ "$reply" != "foo" ];
	then
		atf_fail "Failed TCP test without other traffic."
	fi

	# Saturate the link
	ping -i .01 -s 1200 192.0.2.2 &

	# We should now be hitting the limits and get this packet dropped.
	#atf_check -s exit:2 -o ignore ping -c 1 -W 1 -s 1200 192.0.2.2
	atf_check -s exit:2 -o ignore ping -c 1 -s 1200 192.0.2.2

	for i in `seq 0 4`
	do
		# TCP should still just pass
		reply=$(echo "foo" | nc -w 10 -N 192.0.2.2 7)
		if [ "$reply" != "foo" ];
		then
			atf_fail "Failed to prioritise traffic on iteration $i"
		fi
	done

	# This will fail if we don't differentiate the traffic
	firewall_config alcatraz ${fw} \
		"ipfw"	\
			"ipfw add 1000 queue 1 ip from any to any"

	reply=$(echo "foo" | nc -w 10 -N 192.0.2.2 7)
	if [ "$reply" == "foo" ];
	then
		atf_fail "TCP still made it through, even when not prioritised"
	fi
}

queue_cleanup()
{
	rm -f inetd-alcatraz.pid
	firewall_cleanup $1
}

queue_v6_head()
{
	atf_set descr 'Basic queue test'
	atf_set require.user root
}

queue_v6_body()
{
	fw=$1
	firewall_init $fw
	dummynet_init $fw

	epair=$(vnet_mkepair)
	epair_link=$(vnet_mkepair)
	vnet_mkjail alcatraz ${epair}b ${epair_link}a
	vnet_mkjail srv ${epair_link}b

set -x

	ifconfig ${epair}a inet6 2001:db8:42::1/64 no_dad up
	route add -6 2001:db8:43::/64 2001:db8:42::2

	jexec alcatraz ifconfig ${epair}b inet6 2001:db8:42::2 no_dad up
	jexec alcatraz ifconfig ${epair_link}a inet6 2001:db8:43::2 no_dad up
	jexec alcatraz sysctl net.inet6.ip6.forwarding=1

	jexec srv ifconfig ${epair_link}b inet6 2001:db8:43::1 no_dad up
	jexec srv route add -6 default 2001:db8:43::2
	jexec srv /usr/sbin/inetd -p inetd-alcatraz.pid \
	    $(atf_get_srcdir)/../pf/echo_inetd.conf

	# Sanity check
	atf_check -s exit:0 -o ignore ping6 -i .1 -c 3 -s 1200 2001:db8:42::2
	atf_check -s exit:0 -o ignore ping6 -i .1 -c 3 -s 1200 2001:db8:43::2
	atf_check -s exit:0 -o ignore ping6 -i .1 -c 3 -s 1200 2001:db8:43::1

	reply=$(echo "foo" | nc -w 5 -N 2001:db8:43::1 7)
	if [ "$reply" != "foo" ];
	then
		atf_fail "Echo sanity check failed"
	fi

	jexec alcatraz dnctl pipe 1 config bw 300Byte/s queue 5 mask proto 0xff
	jexec alcatraz dnctl sched 1 config pipe 1 type wf2q+ mask proto 0xff 
	jexec alcatraz dnctl queue 1 config sched 1 weight 99 queue 5 mask proto 0xff
	jexec alcatraz dnctl queue 2 config sched 1 weight 1 queue 5 mask proto 0xff

	firewall_config alcatraz ${fw} \
		"ipfw"	\
			"ipfw add queue 2 ipv6-icmp from any to any icmp6types 128,129" \
			"ipfw add queue 1 tcp from any to any"

	# Single ping succeeds
	atf_check -s exit:0 -o ignore ping6 -c 3 2001:db8:43::1

	# Unsaturated TCP succeeds
	reply=$(echo "foo" | nc -w 5 -N 2001:db8:43::1 7)
	if [ "$reply" != "foo" ];
	then
		atf_fail "Unsaturated echo failed"
	fi

	# Saturate the link
	ping6 -i .01 -s 1200 2001:db8:43::1 &
	
	# Give that a chance to fill the queue & pipe
	sleep 1

	jexec alcatraz ipfw show

	# We should now be hitting the limits and get this packet dropped.
	atf_check -s exit:2 -o ignore ping6 -c 1 -W 1 -s 1200 2001:db8:43::1

	# TCP should still just pass
	for i in `seq 0 4`
	do
		reply=$(echo "foo $i" | nc -w 10 -N 2001:db8:43::1 7)
		if [ "$reply" != "foo $i" ];
		then
			atf_fail "Failed to prioritise traffic on interation $i"
		fi
		sleep 1
	done

	jexec alcatraz ipfw flush
	# This will fail if we don't differentiate the traffic
	firewall_config alcatraz ${fw} \
		"ipfw"	\
			"ipfw add queue 1 ipv6-icmp from any to any icmp6types 128,129" \
			"ipfw add queue 2 tcp from any to any"

	# Carry over state?
	killall ping6
	ping6 -i .01 -s 1200 2001:db8:43::1 &
	sleep 1

	reply=$(echo "baz" | nc -w 10 -N 2001:db8:43::1 7)
	if [ "$reply" == "baz" ];
	then
		jexec alcatraz ipfw show
		atf_fail "TCP still made it through, even when not prioritised"
	fi
}

queue_v6_cleanup()
{
	rm -f inetd-alcatraz.pid
	firewall_cleanup $1
}

setup_tests		\
	pipe		\
		ipfw	\
	pipe_v6		\
		ipfw	\
	queue		\
		ipfw	\
	queue_v6	\
		ipfw