#!/usr/bin/env ksh
# :vi ts=4 sw=4 noet :
#==================================================================================
#    Copyright (c) 2019 Nokia
#    Copyright (c) 2018-2019 AT&T Intellectual Property.
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#==================================================================================
#

# ---------------------------------------------------------------------------------
#	Mnemonic:	run_lcall_test.ksh
#	Abstract:	This is a simple script to set up and run the basic send/receive
#				processes for some library validation on top of nano/nng. This
#				particular test starts the latency caller and latency receiver
#				processes such that they exchange messages and track the latency
#				from the caller's perepective (both outbound to receiver, and then
#				back.  Stats are presented at the end.   This test is NOT intended
#				to be used as a CI validation test.
#
#				The sender and receiver processes all have a 20s timeout (+/-)
#				which means that all messages must be sent, and acked within that
#				time or the processes will give up and report failure.  Keep in mind
#				that n messages with a delay value (-d) set will affect whether or
#				not the messages can be sent in the 20s timeout period.  There is
#				currently no provision to adjust the timeout other than by changing
#				the C source.  The default (100 msgs with 500 micro-sec delay) works
#				just fine for base testing.
#
#				Example command line:
#					# run with 10 caller threads sending 10,000 meessages each, 
#					# 5 receivers, and a 10 mu-s delay between each caller send
#					ksh ./run_lcall_test.ksh -d 10 -n 10000 -r 5 -c 10
#
#	Date:		28 May 2019
#	Author:		E. Scott Daniels
# ---------------------------------------------------------------------------------


# The sender and receivers are run asynch. Their exit statuses are captured in a
# file in order for the 'main' to pick them up easily.
#
function run_sender {
	if (( $nano_sender ))
	then
		echo "nanomsg not supportded"
		exit 1
	else
		./lcaller ${nmsg:-10} ${delay:-500} ${cthreads:-3} 
	fi
	echo $? >/tmp/PID$$.src		# must communicate state back via file b/c asynch
}

# $1 is the instance so we can keep logs separate
function run_rcvr {
	typeset port

	port=$(( 4460 + ${1:-0} ))
	export RMR_RTG_SVC=$(( 9990 + $1 ))
	if (( $nano_receiver ))
	then
		echo "nanomsg not supported"
		exit 1
	else
		./lreceiver $(( ((nmsg * cthreads)/nrcvrs) + 10 )) $port
	fi
	echo $? >/tmp/PID$$.$1.rrc
}

#	Drop a contrived route table in such that the sender sends each message to n
#	receivers.
#
function set_rt {
	typeset port=4460
	typeset groups="localhost:4460"
	for (( i=1; i < ${1:-3}; i++ ))
	do
		groups="$groups,localhost:$((port+i))"
	done

	cat <<endKat >lcall.rt
		newrt | start
		mse |0 | 0 | $groups
		mse |1 | 10 | $groups
		mse |2 | 20 | $groups
		rte |3 | $groups
		rte |4 | $groups
		rte |5 | $groups
		rte |6 | $groups
		rte |7 | $groups
		rte |8 | $groups
		rte |9 | $groups
		rte |10 | $groups
		rte |11 | $groups
		newrt | end
endKat
}

# ---------------------------------------------------------

if [[ ! -f local.rt ]]		# we need the real host name in the local.rt; build one from mask if not there
then
	hn=$(hostname)
	sed "s!%%hostname%%!$hn!" rt.mask >local.rt
fi

cthreads=3					# number of caller threads
nmsg=100					# total number of messages to be exchanged (-n value changes)
delay=500					# microsec sleep between msg 1,000,000 == 1s
nano_sender=0				# start nano version if set (-N)
nano_receiver=0
wait=1
rebuild=0
verbose=0
nrcvrs=3					# this is sane, but -r allows it to be set up
use_installed=0

while [[ $1 == -* ]]
do
	case $1 in
		-c)	cthreads=$2; shift;;
		-B)	rebuild=1;;
		-d)	delay=$2; shift;;
		-i)	use_installed=1;;
		-N)	echo "abort: nanomsg does not support epoll and thus cannot be used for mt-caller"
			echo ""
			exit 1;
			;;
		-n)	nmsg=$2; shift;;
		-r)	nrcvrs=$2; shift;;
		-v)	verbose=1;;

		*)	echo "unrecognised option: $1"
			echo "usage: $0 [-B] [-c caller-threads] [-d micor-sec-delay] [-i] [-n num-msgs] [-r num-receivers]"
			echo "  -B forces a rebuild which will use .build"
			echo "  -i will use installed libraries (/usr/local) and cause -B to be ignored if supplied)"
			exit 1
			;;
	esac

	shift
done

if (( verbose ))
then
	echo "2" >.verbose
	export RMR_VCTL_FILE=".verbose"
fi

if (( use_installed ))			# point at installed library
then
	export LD_LIBRARY_PATH=/usr/local/lib
	export LIBRARY_PATH=$LD_LIBRARY_PATH
else
	if (( rebuild ))
	then
		build_path=../../.build		# if we rebuild we can insist that it is in .build :)
		set -e
		ksh ./rebuild.ksh
		set +e
	else
		build_path=${BUILD_PATH:-"../../.build"}	# we prefer .build at the root level, but allow user option

		if [[ ! -d $build_path ]]
		then
			echo "cannot find build in: $build_path"
			echo "either create, and then build RMr, or set BUILD_PATH as an evironment var before running this"
			exit 1
		fi
	fi

	if [[ -d $build_path/lib64 ]]
	then
		export LD_LIBRARY_PATH=$build_path:$build_path/lib64
	else
		export LD_LIBRARY_PATH=$build_path:$build_path/lib
	fi
fi

export LIBRARY_PATH=$LD_LIBRARY_PATH
export RMR_SEED_RT=./lcall.rt

set_rt $nrcvrs						# set up the rt for n receivers

if (( rebuild )) || [[ ! -f ./lcaller ]]
then
	if ! make -B lcaller lreceiver >/dev/null 2>&1
	then
		echo "[FAIL] cannot find lcaller binary, and cannot make it.... humm?"
		exit 1
	fi
fi

for (( i=0; i < nrcvrs; i++ ))		# start the receivers with an instance number
do
	run_rcvr $i &
done

sleep 2				# let receivers init so we don't shoot at an empty target
run_sender &

wait


for (( i=0; i < nrcvrs; i++ ))		# collect return codes
do
	head -1 /tmp/PID$$.$i.rrc | read x
	(( rrc += x ))
done

head -1 /tmp/PID$$.src | read src

if (( !! (src + rrc) ))
then
	echo "[FAIL] sender rc=$src  receiver rc=$rrc"
else
	echo "[PASS] sender rc=$src  receiver rc=$rrc"
	rm -f lcall.rt
fi

rm /tmp/PID$$.*
rm -f .verbose

exit $(( !! (src + rrc) ))