#	$NetBSD: net_common.sh,v 1.11 2017/01/10 05:55:34 ozaki-r 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
#

setglobal HIJACKING = '"env LD_PRELOAD=/usr/lib/librumphijack.so RUMPHIJACK=sysctl=yes'"

proc extract_new_packets
{
	local bus=$1
	local old=./.__old

	if test ! -f $old {
		setglobal old = '/dev/null'
	}

	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
}

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

	setglobal target = $[echo $target |sed 's/\./\\./g]
	if test $gw = "" {
		setglobal gw = '".+'"
	} else {
		setglobal gw = $[echo $gw |sed 's/\./\\./g]
	}

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

proc check_route_flags
{

	check_route $1 "" $2 ""
}

proc check_route_gw
{

	check_route $1 $2 "" ""
}

proc 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
}

proc 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
}

proc get_macaddr
{

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

setglobal HTTPD_PID = './.__httpd.pid'
proc 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
}

proc stop_httpd
{

	if test -f $HTTPD_PID {
		kill -9 $[cat $HTTPD_PID]
		rm -f $HTTPD_PID
		sleep 1
	}
}

setglobal BASIC_LIBS = '"-lrumpnet -lrumpnet_net -lrumpnet_netinet \
    -lrumpnet_shmif -lrumpdev'"
setglobal FS_LIBS = ""$BASIC_LIBS -lrumpvfs -lrumpfs_ffs""

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

proc _rump_server_start_common
{
	local sock=$1
	local libs=

	shift 1
	setglobal libs = "$ifsjoin(ARGV)"

	atf_check -s exit:0 rump_server $libs $sock

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

proc rump_server_start
{
	local sock=$1
	local _libs=
	local libs="$BASIC_LIBS"

	shift 1
	setglobal _libs = "$ifsjoin(ARGV)"

	for lib in [$_libs] {
		setglobal libs = ""$libs -lrumpnet_$lib""
	}

	_rump_server_start_common $sock $libs

	return 0
}

proc rump_server_fs_start
{
	local sock=$1
	local _libs=
	local libs="$FS_LIBS"

	shift 1
	setglobal _libs = "$ifsjoin(ARGV)"

	for lib in [$_libs] {
		setglobal libs = ""$libs -lrumpnet_$lib""
	}

	_rump_server_start_common $sock $libs

	return 0
}

proc 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
}

proc 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]] {
		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
	}

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

	return 0
}

proc rump_server_halt_servers
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_socks
	for sock in [$[cat $_rump_server_socks]] {
		env RUMP_SERVER=$sock rump.halt
	}
	export RUMP_SERVER=$backup

	return 0
}

proc rump_server_dump_servers
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_socks
	for sock in [$[cat $_rump_server_socks]] {
		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
	}
	export RUMP_SERVER=$backup

	if test -f rump_server.core {
		gdb -ex bt /usr/bin/rump_server rump_server.core
		strings rump_server.core |grep panic
	}
	return 0
}

proc rump_server_dump_buses
{

	if test ! -f $_rump_server_buses {
		return 0
	}

	$DEBUG && cat $_rump_server_buses
	for bus in [$[cat $_rump_server_buses]] {
		echo "### Dumping $bus"
		shmif_dumpbus -p - $bus 2>/dev/null| tcpdump -n -e -r -
	}
	return 0
}

proc cleanup
{

	rump_server_halt_servers
}

proc dump
{

	rump_server_dump_servers
	rump_server_dump_buses
}