#! /usr/bin/atf-sh
#	$NetBSD: net_common.sh,v 1.18.2.4 2018/02/26 00:41:13 snj Exp $
#
# Copyright (c) 2016 Internet Initiative Japan Inc.
# All rights reserved.
#
# 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#

#
# Common utility functions for tests/net
#

HIJACKING="env LD_PRELOAD=/usr/lib/librumphijack.so \
    RUMPHIJACK=path=/rump,socket=all:nolocal,sysctl=yes"
ONEDAYISH="(23h5[0-9]m|1d0h0m)[0-9]+s ?"

extract_new_packets()
{
	local bus=$1
	local old=./.__old

	if [ ! -f $old ]; then
		old=/dev/null
	fi

	shmif_dumpbus -p - $bus 2>/dev/null| \
	    tcpdump -n -e -r - 2>/dev/null > ./.__new
	diff -u $old ./.__new |grep '^+' |cut -d '+' -f 2 > ./.__diff
	mv -f ./.__new ./.__old
	cat ./.__diff
}

check_route()
{
	local target=$1
	local gw=$2
	local flags=${3:-\.\+}
	local ifname=${4:-\.\+}

	target=$(echo $target |sed 's/\./\\./g')
	if [ "$gw" = "" ]; then
		gw=".+"
	else
		gw=$(echo $gw |sed 's/\./\\./g')
	fi

	atf_check -s exit:0 -e ignore \
	    -o match:"^$target +$gw +$flags +- +- +.+ +$ifname" \
	    rump.netstat -rn
}

check_route_flags()
{

	check_route "$1" "" "$2" ""
}

check_route_gw()
{

	check_route "$1" "$2" "" ""
}

check_route_no_entry()
{
	local target=$(echo $1 |sed 's/\./\\./g')

	atf_check -s exit:0 -e ignore -o not-match:"^$target" \
	    rump.netstat -rn
}

get_linklocal_addr()
{

	export RUMP_SERVER=${1}
	rump.ifconfig ${2} inet6 |
	    awk "/fe80/ {sub(/%$2/, \"\"); sub(/\\/[0-9]*/, \"\"); print \$2;}"
	unset RUMP_SERVER

	return 0
}

get_macaddr()
{

	env RUMP_SERVER=${1} \
	    rump.ifconfig ${2} |awk '/address/ {print $2;}'
}

HTTPD_PID=./.__httpd.pid
start_httpd()
{
	local sock=$1
	local ip=$2
	local backup=$RUMP_SERVER

	export RUMP_SERVER=$sock

	# start httpd in daemon mode
	atf_check -s exit:0 env LD_PRELOAD=/usr/lib/librumphijack.so \
	    /usr/libexec/httpd -P $HTTPD_PID -i $ip -b -s $(pwd)

	export RUMP_SERVER=$backup

	sleep 3
}

stop_httpd()
{

	if [ -f $HTTPD_PID ]; then
		kill -9 $(cat $HTTPD_PID)
		rm -f $HTTPD_PID
		sleep 1
	fi
}

NC_PID=./.__nc.pid
start_nc_server()
{
	local sock=$1
	local port=$2
	local outfile=$3
	local proto=${4:-ipv4}
	local backup=$RUMP_SERVER
	local pid= opts=

	export RUMP_SERVER=$sock

	if [ $proto = ipv4 ]; then
		opts="-l -4"
	else
		opts="-l -6"
	fi

	env LD_PRELOAD=/usr/lib/librumphijack.so \
	    nc $opts $port > $outfile &
	pid=$!
	echo $pid > $NC_PID

	if [ $proto = ipv4 ]; then
		$DEBUG && rump.netstat -a -f inet
	else
		$DEBUG && rump.netstat -a -f inet6
	fi

	export RUMP_SERVER=$backup

	sleep 1
}

stop_nc_server()
{

	if [ -f $NC_PID ]; then
		kill -9 $(cat $NC_PID)
		rm -f $NC_PID
		sleep 1
	fi
}

BASIC_LIBS="-lrumpnet -lrumpnet_net -lrumpnet_netinet \
    -lrumpnet_shmif -lrumpdev"
FS_LIBS="$BASIC_LIBS -lrumpvfs -lrumpfs_ffs"
CRYPTO_LIBS="$BASIC_LIBS -lrumpvfs -lrumpdev_opencrypto \
    -lrumpkern_z -lrumpkern_crypto"
NPF_LIBS="$BASIC_LIBS -lrumpvfs -lrumpdev_bpf -lrumpnet_npf"

# We cannot keep variables between test phases, so need to store in files
_rump_server_socks=./.__socks
_rump_server_ifaces=./.__ifaces
_rump_server_buses=./.__buses

DEBUG_SYSCTL_ENTRIES="net.inet.arp.debug net.inet6.icmp6.nd6_debug \
    net.inet.ipsec.debug"

IPSEC_KEY_DEBUG=${IPSEC_KEY_DEBUG:-false}

_rump_server_start_common()
{
	local sock=$1
	local libs=
	local backup=$RUMP_SERVER

	shift 1
	libs="$*"

	atf_check -s exit:0 rump_server $libs $sock

	if $DEBUG; then
		# Enable debugging features in the kernel
		export RUMP_SERVER=$sock
		for ent in $DEBUG_SYSCTL_ENTRIES; do
			if rump.sysctl -q $ent; then
				atf_check -s exit:0 rump.sysctl -q -w $ent=1
			fi
		done
		export RUMP_SERVER=$backup
	fi
	if $IPSEC_KEY_DEBUG; then
		# Enable debugging features in the kernel
		export RUMP_SERVER=$sock
		if rump.sysctl -q net.key.debug; then
			atf_check -s exit:0 \
			    rump.sysctl -q -w net.key.debug=0xffff
		fi
		export RUMP_SERVER=$backup
	fi

	echo $sock >> $_rump_server_socks
	$DEBUG && cat $_rump_server_socks
}

rump_server_start()
{
	local sock=$1
	local _libs=
	local libs="$BASIC_LIBS"

	shift 1
	_libs="$*"

	for lib in $_libs; do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_fs_start()
{
	local sock=$1
	local _libs=
	local libs="$FS_LIBS"

	shift 1
	_libs="$*"

	for lib in $_libs; do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_crypto_start()
{
	local sock=$1
	local _libs=
	local libs="$CRYPTO_LIBS"

	shift 1
	_libs="$*"

	for lib in $_libs; do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_npf_start()
{
	local sock=$1
	local _libs=
	local libs="$NPF_LIBS"

	shift 1
	_libs="$*"

	for lib in $_libs; do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_add_iface()
{
	local sock=$1
	local ifname=$2
	local bus=$3
	local backup=$RUMP_SERVER

	export RUMP_SERVER=$sock
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname linkstr $bus
	export RUMP_SERVER=$backup

	echo $sock $ifname >> $_rump_server_ifaces
	$DEBUG && cat $_rump_server_ifaces

	echo $bus >> $_rump_server_buses
	cat $_rump_server_buses |sort -u >./.__tmp
	mv -f ./.__tmp $_rump_server_buses
	$DEBUG && cat $_rump_server_buses

	return 0
}

rump_server_destroy_ifaces()
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_ifaces

	# Try to dump states before destroying interfaces
	for sock in $(cat $_rump_server_socks); do
		export RUMP_SERVER=$sock
		atf_check -s exit:0 -o ignore rump.ifconfig
		atf_check -s exit:0 -o ignore rump.netstat -nr
		# XXX still need hijacking
		atf_check -s exit:0 -o ignore $HIJACKING rump.netstat -i -a
		atf_check -s exit:0 -o ignore rump.arp -na
		atf_check -s exit:0 -o ignore rump.ndp -na
		atf_check -s exit:0 -o ignore $HIJACKING ifmcstat
	done

	# XXX using pipe doesn't work. See PR bin/51667
	#cat $_rump_server_ifaces | while read sock ifname; do
	while read sock ifname; do
		export RUMP_SERVER=$sock
		if rump.ifconfig -l |grep -q $ifname; then
			atf_check -s exit:0 rump.ifconfig $ifname destroy
		fi
		atf_check -s exit:0 -o ignore rump.ifconfig
	done < $_rump_server_ifaces
	export RUMP_SERVER=$backup

	return 0
}

rump_server_halt_servers()
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_socks
	for sock in $(cat $_rump_server_socks); do
		env RUMP_SERVER=$sock rump.halt
	done
	export RUMP_SERVER=$backup

	return 0
}

rump_server_dump_servers()
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_socks
	for sock in $(cat $_rump_server_socks); do
		echo "### Dumping $sock"
		export RUMP_SERVER=$sock
		rump.ifconfig
		rump.netstat -nr
		# XXX still need hijacking
		$HIJACKING rump.netstat -i -a
		rump.arp -na
		rump.ndp -na
		$HIJACKING ifmcstat
		$HIJACKING dmesg
	done
	export RUMP_SERVER=$backup

	if [ -f rump_server.core ]; then
		gdb -ex bt /usr/bin/rump_server rump_server.core
		strings rump_server.core |grep panic
	fi
	return 0
}

rump_server_dump_buses()
{

	if [ ! -f $_rump_server_buses ]; then
		return 0
	fi

	$DEBUG && cat $_rump_server_buses
	for bus in $(cat $_rump_server_buses); do
		echo "### Dumping $bus"
		shmif_dumpbus -p - $bus 2>/dev/null| tcpdump -n -e -r -
	done
	return 0
}

cleanup()
{

	rump_server_halt_servers
}

dump()
{

	rump_server_dump_servers
	rump_server_dump_buses
}

skip_if_qemu()
{
	if sysctl machdep.cpu_brand 2>/dev/null | grep QEMU >/dev/null 2>&1
	then
	    atf_skip "unreliable under qemu, skip until PR kern/43997 fixed"
	fi
}

test_create_destroy_common()
{
	local sock=$1
	local ifname=$2
	local test_address=${3:-false}
	local ipv4="10.0.0.1/24"
	local ipv6="fc00::1"

	export RUMP_SERVER=$sock

	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname down
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	# Destroy while UP
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	if ! $test_address; then
		return
	fi

	# With an IPv4 address
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname inet $ipv4
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	# With an IPv6 address
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname inet6 $ipv6
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	unset RUMP_SERVER
}
#	$NetBSD: t_arp.sh,v 1.22.6.2 2018/04/08 06:09:12 snj Exp $
#
# Copyright (c) 2015 The NetBSD Foundation, Inc.
# All rights reserved.
#
# 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#

SOCKSRC=unix://commsock1
SOCKDST=unix://commsock2
IP4SRC=10.0.1.1
IP4SRC2=10.0.1.5
IP4NET=10.0.1.0
IP4DST=10.0.1.2
IP4DST_PROXYARP1=10.0.1.3
IP4DST_PROXYARP2=10.0.1.4

DEBUG=${DEBUG:-false}
TIMEOUT=1

atf_test_case arp_cache_expiration_5s cleanup
atf_test_case arp_cache_expiration_10s cleanup
atf_test_case arp_command cleanup
atf_test_case arp_garp cleanup
atf_test_case arp_garp_without_dad cleanup
atf_test_case arp_cache_overwriting cleanup
atf_test_case arp_proxy_arp_pub cleanup
atf_test_case arp_proxy_arp_pubproxy cleanup
atf_test_case arp_link_activation cleanup
atf_test_case arp_static cleanup

arp_cache_expiration_5s_head()
{
	atf_set "descr" "Tests for ARP cache expiration (5s)"
	atf_set "require.progs" "rump_server"
}

arp_cache_expiration_10s_head()
{
	atf_set "descr" "Tests for ARP cache expiration (10s)"
	atf_set "require.progs" "rump_server"
}

arp_command_head()
{
	atf_set "descr" "Tests for arp_commands of arp(8)"
	atf_set "require.progs" "rump_server"
}

arp_garp_head()
{
	atf_set "descr" "Tests for GARP"
	atf_set "require.progs" "rump_server"
}

arp_garp_without_dad_head()
{

	atf_set "descr" "Tests for GARP with DAD disabled"
	atf_set "require.progs" "rump_server"
}

arp_cache_overwriting_head()
{
	atf_set "descr" "Tests for behavior of overwriting ARP caches"
	atf_set "require.progs" "rump_server"
}

arp_proxy_arp_pub_head()
{
	atf_set "descr" "Tests for Proxy ARP (pub)"
	atf_set "require.progs" "rump_server"
}

arp_proxy_arp_pubproxy_head()
{
	atf_set "descr" "Tests for Proxy ARP (pub proxy)"
	atf_set "require.progs" "rump_server"
}

arp_link_activation_head()
{
	atf_set "descr" "Tests for activating a new MAC address"
	atf_set "require.progs" "rump_server"
}

arp_static_head()
{

	atf_set "descr" "Tests for static ARP entries"
	atf_set "require.progs" "rump_server"
}

setup_dst_server()
{

	rump_server_add_iface $SOCKDST shmif0 bus1
	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 rump.ifconfig shmif0 inet $IP4DST/24
	atf_check -s exit:0 rump.ifconfig shmif0 up
	atf_check -s exit:0 rump.ifconfig -w 10

	$DEBUG && rump.ifconfig shmif0
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
}

setup_src_server()
{
	local keep=${1:-0}

	export RUMP_SERVER=$SOCKSRC

	# Adjust ARP parameters
	if [ $keep != 0 ]; then
		atf_check -s exit:0 -o ignore \
		    rump.sysctl -w net.inet.arp.keep=$keep
	fi

	# Setup an interface
	rump_server_add_iface $SOCKSRC shmif0 bus1
	atf_check -s exit:0 rump.ifconfig shmif0 inet $IP4SRC/24
	atf_check -s exit:0 rump.ifconfig shmif0 up
	atf_check -s exit:0 rump.ifconfig -w 10

	# Sanity check
	$DEBUG && rump.ifconfig shmif0
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4SRC
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST
}

test_cache_expiration()
{
	local arp_keep=$1
	local bonus=2

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server $arp_keep

	#
	# Check if a cache is expired expectedly
	#
	export RUMP_SERVER=$SOCKSRC
	atf_check -s exit:0 -o ignore rump.ping -n -w $TIMEOUT -c 1 $IP4DST

	$DEBUG && rump.arp -n -a
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4SRC
	# Should be cached
	atf_check -s exit:0 -o ignore rump.arp -n $IP4DST
	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o match:"$IP4DST" rump.netstat -nr -f inet

	atf_check -s exit:0 sleep $(($arp_keep + $bonus))

	$DEBUG && rump.arp -n -a
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4SRC
	# Should be expired
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST
}

arp_cache_expiration_5s_body()
{

	test_cache_expiration 5
	rump_server_destroy_ifaces
}

arp_cache_expiration_10s_body()
{

	test_cache_expiration 10
	rump_server_destroy_ifaces
}

check_arp_static_entry()
{
	local ip=$1
	local mac=$2
	local type=$3
	local flags=

	atf_check -s exit:0 -o match:"$mac" rump.arp -n $ip
	if [ $type = 'permanent' ]; then
		atf_check -s exit:0 -o match:'permanent' rump.arp -n $ip
		check_route $ip "$mac" UHLS shmif0
	else
		atf_check -s exit:0 -o not-match:'permanent' rump.arp -n $ip
		check_route $ip "$mac" UHL shmif0
	fi
}

arp_command_body()
{
	local arp_keep=5
	local bonus=2

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server $arp_keep

	export RUMP_SERVER=$SOCKSRC

	# Add and delete a static entry
	$DEBUG && rump.arp -n -a
	atf_check -s exit:0 -o ignore rump.arp -s 10.0.1.10 b2:a0:20:00:00:10
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	check_arp_static_entry 10.0.1.10 'b2:a0:20:00:00:10' permanent
	atf_check -s exit:0 -o ignore rump.arp -d 10.0.1.10
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.10
	check_route_no_entry 10.0.1.10

	# Add multiple entries via a file
	cat - > ./list <<-EOF
	10.0.1.11 b2:a0:20:00:00:11
	10.0.1.12 b2:a0:20:00:00:12
	10.0.1.13 b2:a0:20:00:00:13
	10.0.1.14 b2:a0:20:00:00:14
	10.0.1.15 b2:a0:20:00:00:15
	EOF
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o ignore rump.arp -f ./list
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	check_arp_static_entry 10.0.1.11 'b2:a0:20:00:00:11' permanent
	check_arp_static_entry 10.0.1.12 'b2:a0:20:00:00:12' permanent
	check_arp_static_entry 10.0.1.13 'b2:a0:20:00:00:13' permanent
	check_arp_static_entry 10.0.1.14 'b2:a0:20:00:00:14' permanent
	check_arp_static_entry 10.0.1.15 'b2:a0:20:00:00:15' permanent

	# Test arp -a
	atf_check -s exit:0 -o match:'10.0.1.11' rump.arp -n -a
	atf_check -s exit:0 -o match:'10.0.1.12' rump.arp -n -a
	atf_check -s exit:0 -o match:'10.0.1.13' rump.arp -n -a
	atf_check -s exit:0 -o match:'10.0.1.14' rump.arp -n -a
	atf_check -s exit:0 -o match:'10.0.1.15' rump.arp -n -a

	# Flush all entries
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o ignore rump.arp -d -a
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.11
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.12
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.13
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.14
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.15
	atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.1
	check_route_no_entry 10.0.1.11
	check_route_no_entry 10.0.1.12
	check_route_no_entry 10.0.1.13
	check_route_no_entry 10.0.1.14
	check_route_no_entry 10.0.1.15

	# Test temp option
	$DEBUG && rump.arp -n -a
	atf_check -s exit:0 -o ignore rump.arp -s 10.0.1.10 b2:a0:20:00:00:10 temp
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	check_arp_static_entry 10.0.1.10 'b2:a0:20:00:00:10' temp

	# Hm? the cache doesn't expire...
	atf_check -s exit:0 sleep $(($arp_keep + $bonus))
	$DEBUG && rump.arp -n -a
	$DEBUG && rump.netstat -nr -f inet
	#atf_check -s not-exit:0 -e ignore rump.arp -n 10.0.1.10

	rump_server_destroy_ifaces
}

make_pkt_str_arpreq()
{
	local target=$1
	local sender=$2
	pkt="> ff:ff:ff:ff:ff:ff, ethertype ARP \(0x0806\), length 42:"
	pkt="$pkt Request who-has $target tell $sender, length 28"
	echo $pkt
}

test_garp_common()
{
	local no_dad=$1
	local pkt=

	rump_server_start $SOCKSRC

	export RUMP_SERVER=$SOCKSRC

	if $no_dad; then
		atf_check -s exit:0 -o match:'3 -> 0' \
		    rump.sysctl -w net.inet.ip.dad_count=0
	fi

	# Setup an interface
	rump_server_add_iface $SOCKSRC shmif0 bus1
	atf_check -s exit:0 rump.ifconfig shmif0 inet 10.0.0.1/24
	atf_check -s exit:0 rump.ifconfig shmif0 up
	$DEBUG && rump.ifconfig shmif0

	atf_check -s exit:0 sleep 1
	extract_new_packets bus1 > ./out

	#
	# Assign an address to an interface without IFF_UP
	#
	# A GARP packet is sent for the primary address
	pkt=$(make_pkt_str_arpreq 10.0.0.1 10.0.0.1)
	atf_check -s exit:0 -o match:"$pkt" cat ./out

	atf_check -s exit:0 rump.ifconfig shmif0 down
	atf_check -s exit:0 rump.ifconfig shmif0 inet 10.0.0.2/24 alias

	atf_check -s exit:0 sleep 1
	extract_new_packets bus1 > ./out

	# A GARP packet is sent for the alias address
	pkt=$(make_pkt_str_arpreq 10.0.0.2 10.0.0.2)
	atf_check -s exit:0 -o match:"$pkt" cat ./out

	# Clean up
	atf_check -s exit:0 rump.ifconfig shmif0 inet 10.0.0.1/24 delete
	atf_check -s exit:0 rump.ifconfig shmif0 inet 10.0.0.2/24 delete

	#
	# Assign an address to an interface with IFF_UP
	#
	atf_check -s exit:0 rump.ifconfig shmif0 up

	# Primary address
	atf_check -s exit:0 rump.ifconfig shmif0 inet 10.0.0.3/24

	atf_check -s exit:0 sleep 1
	extract_new_packets bus1 > ./out

	pkt=$(make_pkt_str_arpreq 10.0.0.3 10.0.0.3)
	if $no_dad; then
		# A GARP packet is sent
		atf_check -s exit:0 -o match:"$pkt" cat ./out
	else
		# No GARP packet is sent
		atf_check -s exit:0 -o not-match:"$pkt" cat ./out
	fi

	# Alias address
	atf_check -s exit:0 rump.ifconfig shmif0 inet 10.0.0.4/24 alias

	atf_check -s exit:0 sleep 1
	extract_new_packets bus1 > ./out

	pkt=$(make_pkt_str_arpreq 10.0.0.4 10.0.0.4)
	if $no_dad; then
		# A GARP packet is sent
		atf_check -s exit:0 -o match:"$pkt" cat ./out
	else
		# No GARP packet is sent
		atf_check -s exit:0 -o not-match:"$pkt" cat ./out
	fi

	rump_server_destroy_ifaces
}

arp_garp_body()
{

	test_garp_common false
}

arp_garp_without_dad_body()
{

	test_garp_common true
}

arp_cache_overwriting_body()
{
	local bonus=2

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	export RUMP_SERVER=$SOCKSRC

	# Cannot overwrite a permanent cache
	atf_check -s exit:0 rump.arp -s $IP4DST b2:a0:20:00:00:ff
	$DEBUG && rump.arp -n -a
	atf_check -s not-exit:0 -e match:'File exists' \
	    rump.arp -s $IP4DST b2:a0:20:00:00:fe
	# cleanup
	atf_check -s exit:0 rump.arp -d $IP4DST

	atf_check -s exit:0 -o ignore rump.ping -n -w $TIMEOUT -c 1 $IP4DST
	$DEBUG && rump.arp -n -a
	# Can overwrite a dynamic cache
	atf_check -s exit:0 -o ignore rump.arp -s $IP4DST b2:a0:20:00:00:00
	$DEBUG && rump.arp -n -a
	atf_check -s exit:0 -o match:'b2:a0:20:00:00:00' rump.arp -n $IP4DST
	atf_check -s exit:0 -o match:'permanent' rump.arp -n $IP4DST

	atf_check -s exit:0 -o ignore rump.arp -s 10.0.1.10 b2:a0:20:00:00:10 temp
	$DEBUG && rump.arp -n -a
	atf_check -s exit:0 -o match:'b2:a0:20:00:00:10' rump.arp -n 10.0.1.10
	atf_check -s exit:0 -o not-match:'permanent' rump.arp -n 10.0.1.10
	# Can overwrite a temp cache
	atf_check -s exit:0 -o ignore rump.arp -s 10.0.1.10 b2:a0:20:00:00:ff
	atf_check -s exit:0 -o match:'b2:a0:20:00:00:ff' rump.arp -n 10.0.1.10
	$DEBUG && rump.arp -n -a

	rump_server_destroy_ifaces
}

make_pkt_str_arprep()
{
	local ip=$1
	local mac=$2
	pkt="ethertype ARP (0x0806), length 42: "
	pkt="Reply $ip is-at $mac, length 28"
	echo $pkt
}

make_pkt_str_garp()
{
	local ip=$1
	local mac=$2
	local pkt=
	pkt="$mac > ff:ff:ff:ff:ff:ff, ethertype ARP (0x0806),"
	pkt="$pkt length 42: Request who-has $ip tell $ip, length 28"
	echo $pkt
}

test_proxy_arp()
{
	local opts= title= flags=
	local type=$1

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST tap

	setup_dst_server
	setup_src_server

	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 -o ignore rump.sysctl -w net.inet.ip.forwarding=1
	macaddr_dst=$(get_macaddr $SOCKDST shmif0)

	if [ "$type" = "pub" ]; then
		opts="pub"
	else
		opts="pub proxy"
	fi
	# Always proxy only since migrating to lltable/llentry
	title='permanent published \(proxy only\)'

	#
	# Test#1: First setup an endpoint then create proxy arp entry
	#
	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 rump.ifconfig tap1 create
	atf_check -s exit:0 rump.ifconfig tap1 $IP4DST_PROXYARP1/24 up
	atf_check -s exit:0 rump.ifconfig -w 10

	# Try to ping (should fail w/o proxy arp)
	export RUMP_SERVER=$SOCKSRC
	atf_check -s not-exit:0 -o ignore -e ignore \
	    rump.ping -n -w 1 -c 1 $IP4DST_PROXYARP1

	# Flushing
	extract_new_packets bus1 > ./out

	# Set up proxy ARP entry
	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 -o ignore \
	    rump.arp -s $IP4DST_PROXYARP1 $macaddr_dst $opts
	atf_check -s exit:0 -o match:"$title" rump.arp -n $IP4DST_PROXYARP1

	# Try to ping
	export RUMP_SERVER=$SOCKSRC
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST_PROXYARP1

	extract_new_packets bus1 > ./out
	$DEBUG && cat ./out

	pkt1=$(make_pkt_str_arprep $IP4DST_PROXYARP1 $macaddr_dst)
	pkt2=$(make_pkt_str_garp $IP4DST_PROXYARP1 $macaddr_dst)
	atf_check -s exit:0 -x "cat ./out |grep -q -e '$pkt1' -e '$pkt2'"

	#
	# Test#2: Create proxy arp entry then set up an endpoint
	#
	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 -o ignore \
	    rump.arp -s $IP4DST_PROXYARP2 $macaddr_dst $opts
	atf_check -s exit:0 -o match:"$title" rump.arp -n $IP4DST_PROXYARP2
	$DEBUG && rump.netstat -nr -f inet

	# Try to ping (should fail because no endpoint exists)
	export RUMP_SERVER=$SOCKSRC
	atf_check -s not-exit:0 -o ignore -e ignore \
	    rump.ping -n -w 1 -c 1 $IP4DST_PROXYARP2

	extract_new_packets bus1 > ./out
	$DEBUG && cat ./out

	# ARP reply should be sent
	pkt=$(make_pkt_str_arprep $IP4DST_PROXYARP2 $macaddr_dst)
	atf_check -s exit:0 -x "cat ./out |grep -q '$pkt'"

	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 rump.ifconfig tap2 create
	atf_check -s exit:0 rump.ifconfig tap2 $IP4DST_PROXYARP2/24 up
	atf_check -s exit:0 rump.ifconfig -w 10

	# Try to ping
	export RUMP_SERVER=$SOCKSRC
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST_PROXYARP2
}

arp_proxy_arp_pub_body()
{

	test_proxy_arp pub
	rump_server_destroy_ifaces
}

arp_proxy_arp_pubproxy_body()
{

	test_proxy_arp pubproxy
	rump_server_destroy_ifaces
}

arp_link_activation_body()
{
	local bonus=2

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	# flush old packets
	extract_new_packets bus1 > ./out

	export RUMP_SERVER=$SOCKSRC

	atf_check -s exit:0 -o ignore rump.ifconfig shmif0 link \
	    b2:a1:00:00:00:01

	atf_check -s exit:0 sleep 1
	extract_new_packets bus1 > ./out
	$DEBUG && cat ./out

	pkt=$(make_pkt_str_arpreq $IP4SRC $IP4SRC)
	atf_check -s exit:0 -o not-match:"$pkt" cat ./out

	atf_check -s exit:0 -o ignore rump.ifconfig shmif0 link \
	    b2:a1:00:00:00:02 active

	atf_check -s exit:0 sleep 1
	extract_new_packets bus1 > ./out
	$DEBUG && cat ./out

	pkt=$(make_pkt_str_arpreq $IP4SRC $IP4SRC)
	atf_check -s exit:0 -o match:"b2:a1:00:00:00:02 $pkt" cat ./out

	rump_server_destroy_ifaces
}

arp_static_body()
{
	local macaddr_src=

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	macaddr_src=$(get_macaddr $SOCKSRC shmif0)

	# Set a (valid) static ARP entry for the src server
	export RUMP_SERVER=$SOCKDST
	$DEBUG && rump.arp -n -a
	atf_check -s exit:0 -o ignore rump.arp -s $IP4SRC $macaddr_src
	$DEBUG && rump.arp -n -a

	# Test receiving an ARP request with the static ARP entry (as spa/sha)
	export RUMP_SERVER=$SOCKSRC
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST

	rump_server_destroy_ifaces
}

arp_cache_expiration_5s_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_cache_expiration_10s_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_command_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_garp_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_garp_without_dad_cleanup()
{

	$DEBUG && dump
	cleanup
}

arp_cache_overwriting_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_proxy_arp_pub_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_proxy_arp_pubproxy_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_link_activation_cleanup()
{
	$DEBUG && dump
	cleanup
}

arp_static_cleanup()
{
	$DEBUG && dump
	cleanup
}

atf_test_case arp_rtm cleanup
arp_rtm_head()
{

	atf_set "descr" "Tests for routing messages on operations of ARP entries"
	atf_set "require.progs" "rump_server"
}

arp_rtm_body()
{
	local macaddr_src= macaddr_dst=
	local file=./tmp
	local pid= str=

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	macaddr_src=$(get_macaddr $SOCKSRC shmif0)
	macaddr_dst=$(get_macaddr $SOCKDST shmif0)

	export RUMP_SERVER=$SOCKSRC

	# Test ping and a resulting routing message (RTM_ADD)
	rump.route -n monitor -c 1 > $file &
	pid=$?
	sleep 1
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST
	wait $pid
	$DEBUG && cat $file

	str="RTM_ADD.+<UP,HOST,DONE,LLINFO,CLONED>"
	atf_check -s exit:0 -o match:"$str" cat $file
	str="<DST,GATEWAY>"
	atf_check -s exit:0 -o match:"$str" cat $file
	str="$IP4DST link#2"
	atf_check -s exit:0 -o match:"$str" cat $file

	# Test arp -d and resulting routing messages (RTM_DELETE)
	rump.route -n monitor -c 2 > $file &
	pid=$?
	sleep 1
	atf_check -s exit:0 -o ignore rump.arp -d $IP4DST
	wait $pid
	$DEBUG && cat $file

	str="RTM_DELETE.+<HOST,DONE,LLINFO,CLONED>"
	atf_check -s exit:0 -o match:"$str" grep -A 3 RTM_DELETE $file
	str="<DST,GATEWAY>"
	atf_check -s exit:0 -o match:"$str" grep -A 3 RTM_DELETE $file
	str="$IP4DST $macaddr_dst"
	atf_check -s exit:0 -o match:"$str" grep -A 3 RTM_DELETE $file

	rump_server_destroy_ifaces
}

arp_rtm_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_test_case arp_purge_on_route_change cleanup
arp_purge_on_route_change_head()
{

	atf_set "descr" "Tests if ARP entries are removed on route change"
	atf_set "require.progs" "rump_server"
}

arp_purge_on_route_change_body()
{

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	rump_server_add_iface $SOCKSRC shmif1 bus1
	export RUMP_SERVER=$SOCKSRC
	atf_check -s exit:0 rump.ifconfig shmif1 inet $IP4SRC2/24
	atf_check -s exit:0 rump.ifconfig -w 10

	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST
	$DEBUG && rump.arp -na
	atf_check -s exit:0 -o ignore \
	    rump.route change -net $IP4NET -ifp shmif1
	$DEBUG && rump.netstat -nr -f inet
	$DEBUG && rump.arp -na
	# The entry was already removed on route change
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST

	rump_server_destroy_ifaces
}

arp_purge_on_route_change_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_test_case arp_purge_on_route_delete cleanup
arp_purge_on_route_delete_head()
{

	atf_set "descr" "Tests if ARP entries are removed on route delete"
	atf_set "require.progs" "rump_server"
}

arp_purge_on_route_delete_body()
{

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST
	$DEBUG && rump.arp -na

	atf_check -s exit:0 -o ignore rump.route delete -net $IP4NET
	$DEBUG && rump.netstat -nr -f inet
	$DEBUG && rump.arp -na

	# The entry was already removed on route delete
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST

	rump_server_destroy_ifaces
}

arp_purge_on_route_delete_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_test_case arp_purge_on_ifdown cleanup
arp_purge_on_ifdown_head()
{

	atf_set "descr" "Tests if ARP entries are removed on interface down"
	atf_set "require.progs" "rump_server"
}

arp_purge_on_ifdown_body()
{

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST
	atf_check -s exit:0 -o match:'shmif0' rump.arp -n $IP4DST

	# Shutdown the interface
	atf_check -s exit:0 rump.ifconfig shmif0 down
	$DEBUG && rump.netstat -nr -f inet
	$DEBUG && rump.arp -na

	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST

	rump_server_destroy_ifaces
}

arp_purge_on_ifdown_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_test_case arp_stray_entries cleanup
arp_stray_entries_head()
{

	atf_set "descr" "Tests if ARP entries are removed on route change"
	atf_set "require.progs" "rump_server"
}

arp_stray_entries_body()
{

	rump_server_start $SOCKSRC
	rump_server_start $SOCKDST

	setup_dst_server
	setup_src_server

	rump_server_add_iface $SOCKSRC shmif1 bus1

	export RUMP_SERVER=$SOCKSRC
	atf_check -s exit:0 rump.ifconfig shmif1 inet $IP4SRC2/24
	atf_check -s exit:0 rump.ifconfig -w 10

	$DEBUG && rump.netstat -nr -f inet
	atf_check -s exit:0 -o ignore rump.ping -n -w 1 -c 1 $IP4DST
	$DEBUG && rump.arp -na
	atf_check -s exit:0 -o match:'shmif0' rump.arp -n $IP4DST
	atf_check -s exit:0 -o not-match:'shmif1' rump.arp -n $IP4DST

	# Clean up
	atf_check -s exit:0 -o ignore rump.arp -da
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST

	# ping from a different source address
	atf_check -s exit:0 -o ignore \
	    rump.ping -n -w 1 -c 1 -I $IP4SRC2 $IP4DST
	$DEBUG && rump.arp -na
	atf_check -s exit:0 -o match:'shmif0' rump.arp -n $IP4DST
	# ARP reply goes back via shmif1, so a cache is created on shmif1
	atf_check -s exit:0 -o match:'shmif1' rump.arp -n $IP4DST

	# Clean up by arp -da
	atf_check -s exit:0 -o ignore rump.arp -da
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST

	# ping from a different source address again
	atf_check -s exit:0 -o ignore \
	    rump.ping -n -w 1 -c 1 -I $IP4SRC2 $IP4DST
	atf_check -s exit:0 -o match:'shmif0' rump.arp -n $IP4DST
	# ARP reply doen't come
	atf_check -s exit:0 -o not-match:'shmif1' rump.arp -n $IP4DST

	# Cleanup caches on the destination
	export RUMP_SERVER=$SOCKDST
	atf_check -s exit:0 -o ignore rump.arp -da
	export RUMP_SERVER=$SOCKSRC

	# ping from a different source address again
	atf_check -s exit:0 -o ignore \
	    rump.ping -n -w 1 -c 1 -I $IP4SRC2 $IP4DST
	atf_check -s exit:0 -o match:'shmif0' rump.arp -n $IP4DST
	# ARP reply goes back via shmif1
	atf_check -s exit:0 -o match:'shmif1' rump.arp -n $IP4DST

	# Clean up by arp -d <ip>
	atf_check -s exit:0 -o ignore rump.arp -d $IP4DST
	# Both entries should be deleted
	atf_check -s not-exit:0 -e match:'no entry' rump.arp -n $IP4DST

	rump_server_destroy_ifaces
}

arp_stray_entries_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_init_test_cases()
{
	atf_add_test_case arp_cache_expiration_5s
	atf_add_test_case arp_cache_expiration_10s
	atf_add_test_case arp_command
	atf_add_test_case arp_garp
	atf_add_test_case arp_garp_without_dad
	atf_add_test_case arp_cache_overwriting
	atf_add_test_case arp_proxy_arp_pub
	atf_add_test_case arp_proxy_arp_pubproxy
	atf_add_test_case arp_link_activation
	atf_add_test_case arp_static
	atf_add_test_case arp_rtm
	atf_add_test_case arp_purge_on_route_change
	atf_add_test_case arp_purge_on_route_delete
	atf_add_test_case arp_purge_on_ifdown
	atf_add_test_case arp_stray_entries
}
