test/scripts/socket_test.sh

   1 #! /bin/bash
   2 #
   3 # socket_test.sh -- script to run socket tests.
   4 #
   5 script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
   6 vpp_dir="$WS_ROOT/build-root/install-vpp-native/vpp/bin/"
   7 vpp_debug_dir="$WS_ROOT/build-root/install-vpp_debug-native/vpp/bin/"
   8 vpp_shm_dir="/dev/shm/"
   9 vpp_run_dir="/run/vpp"
  10 lib64_dir="$WS_ROOT/build-root/install-vpp-native/vpp/lib64/"
  11 lib64_debug_dir="$WS_ROOT/build-root/install-vpp_debug-native/vpp/lib64/"
  12 dpdk_devbind="/usr/share/dpdk/usertools/dpdk-devbind.py"
  13 docker_vpp_dir="/vpp/"
  14 docker_app_dir="/vpp/"
  15 docker_lib64_dir="/vpp-lib64/"
  16 docker_os="ubuntu"
  17 vcl_ldpreload_lib="libvcl_ldpreload.so.0.0.0"
  18 user_gid="$(id -g)"
  19 vpp_app="vpp"
  20 sock_srvr_app="sock_test_server"
  21 sock_clnt_app="sock_test_client"
  22 sock_srvr_addr="127.0.0.1"
  23 sock_srvr_port="22000"
  24 iperf_srvr_app="iperf3 -V4d -s"
  25 iperf_clnt_app="iperf3 -V4d -c \$srvr_addr"
  26 gdb_in_emacs="gdb_in_emacs"
  27 vcl_config="vcl.conf"
  28 vcl_config_dir="$WS_ROOT/src/vcl/"
  29 docker_vcl_config_dir="/etc/vpp/"
  30 xterm_geom="100x60"
  31 bash_header="#! /bin/bash"
  32 tmp_cmdfile_prefix="/tmp/socket_test_cmd"
  33 cmd1_file="${tmp_cmdfile_prefix}1.$$"
  34 cmd2_file="${tmp_cmdfile_prefix}2.$$"
  35 cmd3_file="${tmp_cmdfile_prefix}3.$$"
  36 vpp_eth_name="enp0s8"
  37 tmp_vpp_exec_file="/tmp/vpp_config.$$"
  38 tmp_gdb_cmdfile_prefix="/tmp/gdb_cmdfile"
  39 def_gdb_cmdfile_prefix="$WS_ROOT/extras/gdb/gdb_cmdfile"
  40 tmp_gdb_cmdfile_vpp="${tmp_gdb_cmdfile_prefix}_vpp.$$"
  41 tmp_gdb_cmdfile_client="${tmp_gdb_cmdfile_prefix}_vcl_client.$$"
  42 tmp_gdb_cmdfile_server="${tmp_gdb_cmdfile_prefix}_vcl_server.$$"
  43 get_docker_server_ip4addr='srvr_addr=$(docker network inspect bridge | grep IPv4Address | awk -e '\''{print $2}'\'' | sed -e '\''s,/16,,'\'' -e '\''s,",,g'\'' -e '\''s/,//'\'')'
  44 #' single quote to fix the confused emacs colorizer.
  45 trap_signals="SIGINT SIGTERM EXIT"
  46
  47 # Set default values for imported environment variables if they don't exist.
  48 #
  49 VPP_GDB_CMDFILE="${VPP_GDB_CMDFILE:-${def_gdb_cmdfile_prefix}.vpp}"
  50 VPPCOM_CLIENT_GDB_CMDFILE="${VPPCOM_CLIENT_GDB_CMDFILE:-${def_gdb_cmdfile_prefix}.vppcom_client}"
  51 VPPCOM_SERVER_GDB_CMDFILE="${VPPCOM_SERVER_GDB_CMDFILE:-${def_gdb_cmdfile_prefix}.vppcom_server}"
  52
  53 usage() {
  54     cat <<EOF
  55 Usage: socket_test.sh OPTIONS TEST
  56 TESTS:
  57   nk, native-kernel   Run server & client on host using kernel.
  58   nv, native-vcl      Run vpp, server & client on host using VppComLib.
  59   np, native-preload  Run vpp, server & client on host using LD_PRELOAD.
  60   dk, docker-kernel   Run server & client in docker using kernel stack.
  61   dv, docker-vcl      Run vpp on host, server & client in docker using VppComLib.
  62   dp, docker-preload  Run vpp on host, server & client in docker using LD_PRELOAD.
  63
  64 OPTIONS:
  65   -h                  Print this usage text.
  66   -l                  Leave ${tmp_cmdfile_prefix}* files after test run.
  67   -b                  Run bash after application exit.
  68   -d                  Run the vpp_debug version of all apps.
  69   -c                  Set VCL_CONFIG to use the vcl_test.conf file.
  70   -i                  Run iperf3 for client/server app in native tests.
  71   -n                  Name of ethernet for VPP to use in multi-host cfg.
  72   -6                  Use ipv6 addressing.
  73   -m c[lient]         Run client in multi-host cfg (server on remote host)
  74      s[erver]         Run server in multi-host cfg (client on remote host)
  75   -e a[ll]            Run all in emacs+gdb.
  76      c[lient]         Run client in emacs+gdb.
  77      s[erver]         Run server in emacs+gdb.
  78      v[pp]            Run vpp in emacs+gdb.
  79   -g a[ll]            Run all in gdb.
  80      c[lient]         Run client in gdb.
  81      s[erver]         Run server in gdb.
  82      v[pp]            Run vpp in gdb.
  83   -t                  Use tabs in one xterm if available (e.g. xfce4-terminal).
  84
  85 OPTIONS passed to client/server:
  86   -S <ip address>     Server IP address.
  87   -P <server port>    Server Port number.
  88   -E <data>           Run Echo test.
  89   -N <num-writes>     Test Cfg: number of writes.
  90   -R <rxbuf-size>     Test Cfg: rx buffer size.
  91   -T <txbuf-size>     Test Cfg: tx buffer size.
  92   -U                  Run Uni-directional test.
  93   -B                  Run Bi-directional test.
  94   -I <num-tst-socks>  Send data over multiple test sockets in parallel.
  95   -V                  Test Cfg: Verbose mode.
  96   -X                  Exit client/server after running test.
  97
  98 Environment variables:
  99   VCL_CONFIG                Pathname of vppcom configuration file.
 100   VPP_GDB_CMDFILE            Pathname of gdb command file for vpp.
 101   VPPCOM_CLIENT_GDB_CMDFILE  Pathname of gdb command file for client.
 102   VPPCOM_SERVER_GDB_CMDFILE  Pathname of gdb command file for server.
 103 EOF
 104     exit 1
 105 }
 106
 107 declare -i emacs_vpp=0
 108 declare -i emacs_client=0
 109 declare -i emacs_server=0
 110 declare -i gdb_vpp=0
 111 declare -i gdb_client=0
 112 declare -i gdb_server=0
 113 declare -i perf_vpp=0
 114 declare -i perf_client=0
 115 declare -i perf_server=0
 116 declare -i leave_tmp_files=0
 117 declare -i bash_after_exit=0
 118 declare -i iperf3=0
 119 declare -i use_ipv6=0
 120
 121 while getopts ":hitlbcd6n:m:e:g:p:E:I:N:P:R:S:T:UBVX" opt; do
 122     case $opt in
 123         h) usage ;;
 124         l) leave_tmp_files=1
 125            ;;
 126         b) bash_after_exit=1
 127            ;;
 128         i) iperf3=1
 129            ;;
 130         6) use_ipv6=1
 131            ;;
 132         t) xterm_geom="180x40"
 133            use_tabs="true"
 134            ;;
 135         c) VCL_CONFIG="${vcl_config_dir}vcl_test.conf"
 136            ;;
 137         d) title_dbg="-DEBUG"
 138            vpp_dir=$vpp_debug_dir
 139            lib64_dir=$lib64_debug_dir
 140            ;;
 141         e) if [ $OPTARG = "a" ] || [ $OPTARG = "all" ] ; then
 142                emacs_client=1
 143                emacs_server=1
 144                emacs_vpp=1
 145            elif [ $OPTARG = "c" ] || [ $OPTARG = "client" ] ; then
 146                emacs_client=1
 147            elif [ $OPTARG = "s" ] || [ $OPTARG = "server" ] ; then
 148                emacs_server=1
 149            elif [ $OPTARG = "v" ] || [ $OPTARG = "vpp" ] ; then
 150                emacs_vpp=1
 151            else
 152                echo "ERROR: Option -e unknown argument \'$OPTARG\'" >&2
 153                usage
 154            fi
 155            title_dbg="-DEBUG"
 156            vpp_dir=$vpp_debug_dir
 157            lib64_dir=$lib64_debug_dir
 158            ;;
 159         n) vpp_eth_name="$OPTARG"
 160            ;;
 161         m) if [ $OPTARG = "c" ] || [ $OPTARG = "client" ] ; then
 162                multi_host="client"
 163            elif [ $OPTARG = "s" ] || [ $OPTARG = "server" ] ; then
 164                multi_host="server"
 165            else
 166                echo "ERROR: Option -e unknown argument \'$OPTARG\'" >&2
 167                usage
 168            fi
 169            ;;
 170         g) if [ $OPTARG = "a" ] || [ $OPTARG = "all" ] ; then
 171                gdb_client=1
 172                gdb_server=1
 173                gdb_vpp=1
 174            elif [ $OPTARG = "c" ] || [ $OPTARG = "client" ] ; then
 175                gdb_client=1
 176            elif [ $OPTARG = "s" ] || [ $OPTARG = "server" ] ; then
 177                gdb_server=1
 178            elif [ $OPTARG = "v" ] || [ $OPTARG = "vpp" ] ; then
 179                gdb_vpp=1
 180            else
 181                echo "ERROR: Option -g unknown argument \'$OPTARG\'" >&2
 182                usage
 183            fi
 184            title_dbg="-DEBUG"
 185            vpp_dir=$vpp_debug_dir
 186            lib64_dir=$lib64_debug_dir
 187            ;;
 188         p) if [ $OPTARG = "a" ] || [ $OPTARG = "all" ] ; then
 189                perf_client=1
 190                perf_server=1
 191                perf_vpp=1
 192            elif [ $OPTARG = "c" ] || [ $OPTARG = "client" ] ; then
 193                perf_client=1
 194            elif [ $OPTARG = "s" ] || [ $OPTARG = "server" ] ; then
 195                perf_server=1
 196            elif [ $OPTARG = "v" ] || [ $OPTARG = "vpp" ] ; then
 197                perf_vpp=1
 198            else
 199                echo "ERROR: Option -p unknown argument \'$OPTARG\'" >&2
 200                usage
 201            fi
 202            echo "WARNING: -p options TBD"
 203            ;;
 204         S) sock_srvr_addr="$OPTARG"
 205            ;;
 206         P) sock_srvr_port="$OPTARG"
 207            ;;
 208 E|I|N|R|T) sock_clnt_options="$sock_clnt_options -$opt \"$OPTARG\""
 209            ;;
 210   U|B|V|X) sock_clnt_options="$sock_clnt_options -$opt"
 211            ;;
 212        \?)
 213            echo "ERROR: Invalid option: -$OPTARG" >&2
 214            usage
 215            ;;
 216         :)
 217            echo "ERROR: Option -$OPTARG requires an argument." >&2
 218            usage
 219            ;;
 220     esac
 221 done
 222
 223 shift $(( $OPTIND-1 ))
 224 while ! [[ $run_test ]] && (( $# > 0 )) ; do
 225     case $1 in
 226         "nk" | "native-kernel")
 227             run_test="native_kernel" ;;
 228         "np" | "native-preload")
 229             run_test="native_preload" ;;
 230         "nv" | "native-vcl")
 231             sock_srvr_app="vcl_test_server"
 232             sock_clnt_app="vcl_test_client"
 233             run_test="native_vcl" ;;
 234         "dk" | "docker-kernel")
 235             run_test="docker_kernel" ;;
 236         "dp" | "docker-preload")
 237             run_test="docker_preload" ;;
 238         "dv" | "docker-vcl")
 239             sock_srvr_app="vcl_test_server"
 240             sock_clnt_app="vcl_test_client"
 241             run_test="docker_vcl" ;;
 242         *)
 243             echo "ERROR: Unknown option '$1'!" >&2
 244             usage ;;
 245     esac
 246     shift
 247 done
 248
 249 VCL_LDPRELOAD_LIB_DIR="${VCL_LDPRELOAD_LIB_DIR:-$lib64_dir}"
 250
 251 if [ -n "$multi_host" ] ; then
 252     VCL_SESSION_SCOPE_GLOBAL=true
 253 else
 254     VCL_SESSION_SCOPE_LOCAL=true
 255 fi
 256
 257 if [ -z "$WS_ROOT" ] ; then
 258     echo "ERROR: WS_ROOT environment variable not set!" >&2
 259     echo "       Please set WS_ROOT to VPP workspace root directory." >&2
 260     exit 1
 261 fi
 262
 263 if [[ "$(grep bin_PROGRAMS $WS_ROOT/src/vcl.am)" = "" ]] ; then
 264     $WS_ROOT/extras/vagrant/vcl_test.sh $WS_ROOT $USER
 265     (cd $WS_ROOT; make build)
 266 fi
 267
 268 if [ ! -d $vpp_dir ] ; then
 269     echo "ERROR: Missing VPP$title_dbg bin directory!" >&2
 270     echo "       $vpp_dir" >&2
 271     env_test_failed="true"
 272 fi
 273
 274 if [[ $run_test =~ .*"_preload" ]] ; then
 275    if [ ! -d $lib64_dir ] ; then
 276        echo "ERROR: Missing VPP$title_dbg lib64 directory!" >&2
 277        echo "       $lib64_dir" >&2
 278    elif [ ! -d $VCL_LDPRELOAD_LIB_DIR ] ; then
 279        echo "ERROR: Missing VCL LD_PRELOAD Library directory!" >&2
 280        echo "       $VCL_LDPRELOAD_LIB_DIR" >&2
 281        env_test_failed="true"
 282    elif [ ! -f $VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib ] ; then
 283        echo "ERROR: Missing VCL LD_PRELOAD library!" >&2
 284        echo "       $VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib" >&2
 285        env_test_failed="true"
 286    fi
 287 fi
 288
 289 if [ ! -f $vpp_dir$vpp_app ] ; then
 290     echo "ERROR: Missing VPP$title_dbg Application!" >&2
 291     echo "       $vpp_dir$vpp_app" >&2
 292     env_test_failed="true"
 293 fi
 294
 295 if [ ! -f $vpp_dir$sock_srvr_app ] && [ ! $iperf3 -eq 1 ] ; then
 296     echo "ERROR: Missing$title_dbg Socket Server Application!" >&2
 297     echo "       $vpp_dir$sock_srvr_app" >&2
 298     env_test_failed="true"
 299 fi
 300
 301 if [ ! -f $vpp_dir$sock_clnt_app ] && [ ! $iperf3 -eq 1 ] ; then
 302     echo "ERROR: Missing$title_dbg Socket Client Application!" >&2
 303     echo "       $vpp_dir$sock_clnt_app" >&2
 304     env_test_failed="true"
 305 fi
 306
 307 if [[ $run_test =~ "docker_".* ]] ; then
 308     if [ $emacs_client -eq 1 ] || [ $emacs_server -eq 1 ] || [ $gdb_client -eq 1 ] || [ $gdb_server -eq 1 ] ; then
 309
 310         echo "WARNING: gdb is not currently supported in docker."
 311         echo "         Ignoring client/server gdb options."
 312         emacs_client=0
 313         emacs_server=0
 314         gdb_client=0
 315         gdb_server=0
 316     fi
 317 fi
 318
 319 if [[ $run_test =~ .*"_vcl" ]] && [ $iperf3 -eq 1 ] ; then
 320     echo "ERROR: Invalid option 'i' for test $run_test!"
 321     echo "       iperf3 is not compiled with the VCL library."
 322     env_test_failed="true"
 323 fi
 324
 325 if [ -n "$mult_host"] && [ ! -f "$dpdk_devbind" ] ; then
 326     echo "ERROR: Can't find dpdk-devbind.py!"
 327     echo "       Run \"cd \$WS_ROOT; make dpdk-install-dev\" to install it."
 328     echo
 329     env_test_failed="true"
 330 fi
 331
 332 if [ -n "$env_test_failed" ] ; then
 333     exit 1
 334 fi
 335
 336 if [ -f "$VCL_CONFIG" ] ; then
 337     vcl_config="$(basename $VCL_CONFIG)"
 338     vcl_config_dir="$(dirname $VCL_CONFIG)/"
 339     api_prefix="$(egrep -s '^\s*api-prefix \w+' $VCL_CONFIG | tail -1 | awk -e '{print $2}')"
 340     if [ -n "$api_prefix" ] ; then
 341         api_segment=" api-segment { gid $user_gid prefix $api_prefix }"
 342     fi
 343 fi
 344 if [ -n "$VCL_APP_NAMESPACE_ID" ] && [ -n "$VCL_APP_NAMESPACE_SECRET" ] ; then
 345     namespace_id="$VCL_APP_NAMESPACE_ID"
 346     namespace_secret="$VCL_APP_NAMESPACE_SECRET"
 347 fi
 348
 349 if [ -z "$api_segment" ] ; then
 350     api_segment=" api-segment { gid $user_gid }"
 351 fi
 352 vpp_args="unix { interactive exec $tmp_vpp_exec_file}${api_segment}"
 353
 354 if [ $iperf3 -eq 1 ] ; then
 355     app_dir="$(dirname $(which iperf3))/"
 356     srvr_app=$iperf_srvr_app
 357     clnt_app=$iperf_clnt_app
 358     if [[ $run_test =~ "docker_".* ]] ; then
 359         unset -v app_dir
 360         sock_srvr_port=5201
 361         docker_app_dir="networkstatic/"
 362         unset -v docker_os
 363     fi
 364 else
 365     app_dir="$vpp_dir"
 366     srvr_app="$sock_srvr_app $sock_srvr_port"
 367     clnt_app="$sock_clnt_app${sock_clnt_options} \$srvr_addr $sock_srvr_port"
 368 fi
 369
 370
 371 verify_no_vpp() {
 372     local grep_for_vpp="ps -eaf|grep -v grep|grep \"bin/vpp\""
 373
 374     if [ -n "$api_prefix" ] ; then
 375         grep_for_vpp="$grep_for_vpp|grep \"prefix $api_prefix\""
 376     fi
 377     local running_vpp="$(eval $grep_for_vpp)"
 378     if [ -n "$running_vpp" ] ; then
 379         echo "ERROR: Please kill the following vpp instance(s):"
 380         echo
 381         echo $running_vpp
 382         echo
 383         exit 1
 384     fi
 385     clean_devshm="$vpp_shm_dir*db $vpp_shm_dir*global_vm $vpp_shm_dir*vpe-api $vpp_shm_dir[0-9]*-[0-9]* $vpp_shm_dir*:segment[0-9]*"
 386     sudo rm -f $clean_devshm
 387     devshm_files="$(ls -l $clean_devshm 2>/dev/null | grep $(whoami))"
 388     if [ "$devshm_files" != "" ] ; then
 389         echo "ERROR: Please remove the following $vpp_shm_dir files:"
 390         for file in "$devshm_files" ; do
 391             echo "  $file"
 392         done
 393         exit 1
 394     fi
 395     if [ ! -d "$vpp_run_dir" ] ; then
 396         sudo mkdir $vpp_run_dir
 397         sudo chown root:$USER $vpp_run_dir
 398     fi
 399     if [ -n "$multi_host" ] ; then
 400         vpp_eth_pci_id="$(ls -ld /sys/class/net/$vpp_eth_name/device | awk '{print $11}' | cut -d/ -f4)"
 401         if [ -z "$vpp_eth_pci_id" ] ; then
 402             echo "ERROR: Missing ethernet interface $vpp_eth_name!"
 403             usage
 404         fi
 405         printf -v bus "%x" "0x$(echo $vpp_eth_pci_id | cut -d: -f2)"
 406         printf -v slot "%x" "0x$(echo $vpp_eth_pci_id | cut -d: -f3 | cut -d. -f1)"
 407         printf -v func "%x" "0x$(echo $vpp_eth_pci_id | cut -d. -f2)"
 408
 409         vpp_eth_kernel_driver="$(basename $(ls -l /sys/bus/pci/devices/$vpp_eth_pci_id/driver | awk '{print $11}'))"
 410         if [ -z "$vpp_eth_kernel_driver" ] ; then
 411             echo "ERROR: Missing kernel driver for $vpp_eth_name!"
 412             usage
 413         fi
 414         case $vpp_eth_kernel_driver in
 415             e1000)
 416                 vpp_eth_ifname="GigabitEthernet$bus/$slot/$func" ;;
 417             ixgbe)
 418                 vpp_eth_ifname="TenGigabitEthernet$bus/$slot/$func" ;;
 419             i40e)
 420                 vpp_eth_ifname="FortyGigabitEthernet$bus/$slot/$func" ;;
 421             *)
 422                 echo "ERROR: Unknown ethernet kernel driver $vpp_eth_kernel_driver!"
 423                 usage ;;
 424         esac
 425
 426         vpp_eth_ip4_addr="$(ip -4 -br addr show $vpp_eth_name | awk '{print $3}')"
 427         if [ -z "$vpp_eth_ip4_addr" ] ; then
 428             if [ "$multi_host" = "server" ] ; then
 429                 vpp_eth_ip4_addr="10.10.10.10/24"
 430             else
 431                 vpp_eth_ip4_addr="10.10.10.11/24"
 432             fi
 433         fi
 434         if [ $use_ipv6 -eq 1 ] && [ -z "$vpp_eth_ip6_addr" ] ; then
 435             echo "ERROR: No inet6 address configured for $vpp_eth_name!"
 436             usage
 437         fi
 438         vpp_args="$vpp_args plugins { path ${lib64_dir}vpp_plugins } dpdk { dev $vpp_eth_pci_id }"
 439
 440         sudo ifconfig $vpp_eth_name down 2> /dev/null
 441         echo "Configuring VPP to use $vpp_eth_name ($vpp_eth_pci_id), inet addr $vpp_eth_ip4_addr"
 442
 443         cat <<EOF >> $tmp_vpp_exec_file
 444 set int state $vpp_eth_ifname up
 445 set int ip addr $vpp_eth_ifname $vpp_eth_ip4_addr
 446 EOF
 447
 448     fi
 449
 450     if [ -n "$namespace_id" ] ; then
 451         cat <<EOF >> $tmp_vpp_exec_file
 452 session enable
 453 app ns add id $namespace_id secret $namespace_secret sw_if_index 0
 454 EOF
 455     fi
 456
 457     cat <<EOF >> $tmp_vpp_exec_file
 458 show version
 459 show version verbose
 460 show cpu
 461 show int
 462 EOF
 463 }
 464
 465 verify_no_docker_containers() {
 466     if (( $(which docker | wc -l) < 1 )) ; then
 467         echo "ERROR: docker is not installed!"
 468         echo "See https://docs.docker.com/engine/installation/linux/ubuntu/"
 469         echo " or https://docs.docker.com/engine/installation/linux/centos/"
 470         exit 1
 471     fi
 472     if (( $(docker ps | wc -l) > 1 )) ; then
 473         echo "ERROR: Run the following to kill all docker containers:"
 474         echo "docker kill \$(docker ps -q)"
 475         echo
 476         docker ps
 477         exit 1
 478     fi
 479 }
 480
 481 set_pre_cmd() {
 482     # arguments
 483     #   $1 : emacs flag
 484     #   $2 : gdb flag
 485     #   $3 : optional LD_PRELOAD library pathname
 486     local -i emacs=$1
 487     local -i gdb=$2
 488
 489     if [ $emacs -eq 1 ] ; then
 490         write_gdb_cmdfile $tmp_gdb_cmdfile $gdb_cmdfile $emacs $3
 491         pre_cmd="$gdb_in_emacs "
 492     elif [ $gdb -eq 1 ] ; then
 493         write_gdb_cmdfile $tmp_gdb_cmdfile $gdb_cmdfile $emacs $3
 494         pre_cmd="gdb -x $tmp_gdb_cmdfile -i=mi --args "
 495     elif [ -z $3 ] ; then
 496         unset -v pre_cmd
 497     else
 498         docker_ld_preload="-e LD_PRELOAD=$3 "
 499         pre_cmd="LD_PRELOAD=$3 "
 500     fi
 501 }
 502
 503 write_script_header() {
 504     # arguments
 505     #   $1 : command script file
 506     #   $2 : gdb command file
 507     #   $3 : title
 508     #   $4 : optional command string (typically "sleep 2")
 509     echo "$bash_header" > $1
 510     echo -e "#\n# $1 generated on $(date)\n#" >> $1
 511     if [ $leave_tmp_files -eq 0 ] ; then
 512         if [ -n "$multi_host" ] ; then
 513             echo "trap \"rm -f $1 $2 $tmp_vpp_exec_file; sudo $dpdk_devbind -b $vpp_eth_kernel_driver $vpp_eth_pci_id; sudo ifconfig $vpp_eth_name up\" $trap_signals" >> $1
 514         else
 515             echo "trap \"rm -f $1 $2 $tmp_vpp_exec_file\" $trap_signals" >> $1
 516         fi
 517     fi
 518     echo "export VCL_CONFIG=${vcl_config_dir}${vcl_config}" >> $1
 519     if [ -n "$namespace_id" ] ; then
 520         echo "export VCL_APP_NAMESPACE_ID=\"$namespace_id\"" >> $1
 521         echo "export VCL_APP_NAMESPACE_SECRET=\"$namespace_secret\"" >> $1
 522     fi
 523     if [ -n "$VCL_APP_SCOPE_LOCAL" ] ; then
 524         echo "export VCL_APP_SCOPE_LOCAL=true" >> $1
 525     fi
 526     if [ -n "$VCL_APP_SCOPE_GLOBAL" ] ; then
 527         echo "export VCL_APP_SCOPE_GLOBAL=true" >> $1
 528     fi
 529     if [ -n "$VCL_APP_PROXY_TRANSPORT_TCP" ] ; then
 530         echo "export VCL_APP_PROXY_TRANSPORT_TCP=true" >> $1
 531     fi
 532     if [ -n "$VCL_APP_PROXY_TRANSPORT_UDP" ] ; then
 533         echo "export VCL_APP_PROXY_TRANSPORT_UDP=true" >> $1
 534     fi
 535     if [ "$pre_cmd" = "$gdb_in_emacs " ] ; then
 536         if [ -n "$multi_host" ] && [[ $3 =~ "VPP".* ]] ; then
 537             cat <<EOF >> $1
 538 $gdb_in_emacs() {
 539     sudo emacs --eval "(gdb \"gdb -x $2 -i=mi --args \$*\")" --eval "(setq frame-title-format \"$3\")"
 540 }
 541 EOF
 542         else
 543             cat <<EOF >> $1
 544 $gdb_in_emacs() {
 545     emacs --eval "(gdb \"gdb -x $2 -i=mi --args \$*\")" --eval "(setq frame-title-format \"$3\")"
 546 }
 547 EOF
 548         fi
 549     fi
 550     if [ -n "$4" ] ; then
 551         echo "$4" >> $1
 552     fi
 553 }
 554
 555 write_script_footer() {
 556     # arguments
 557     #   $1 : command script file
 558     #   $2 : perf flag indicating to run bash before exit
 559     local -i perf=$2
 560     if [ $bash_after_exit -eq 1 ] || [ $perf -eq 1 ] ; then
 561         echo "bash" >> $1
 562     fi
 563 }
 564
 565 write_gdb_cmdfile() {
 566     # arguments
 567     #   $1 : gdb command file
 568     #   $2 : User specified gdb cmdfile
 569     #   $3 : emacs flag
 570     #   $4 : optional LD_PRELOAD library pathname.
 571     local -i emacs=$3
 572
 573     echo "# $1 generated on $(date)" > $1
 574     echo "#" >> $1
 575     echo "set confirm off" >> $1
 576     if [ -n "$4" ] ; then
 577         echo "set exec-wrapper env LD_PRELOAD=$4" >> $1
 578         echo "start" >> $1
 579     fi
 580
 581     if [ ! -f $2 ] ; then
 582         echo -n "# " >> $1
 583     fi
 584     echo "source $2" >> $1
 585     if [ $emacs -eq 0 ] ; then
 586         echo "run" >> $1
 587     fi
 588 }
 589
 590 native_kernel() {
 591     banner="Running NATIVE-KERNEL socket test"
 592     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 593         title1="SERVER$title_dbg (Native-Kernel Socket Test)"
 594         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 595         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 596         set_pre_cmd $emacs_server $gdb_server
 597         write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 598         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd1_file
 599         write_script_footer $cmd1_file $perf_server
 600         chmod +x $cmd1_file
 601     fi
 602
 603     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 604         title2="CLIENT$title_dbg (Native-Kernel Socket Test)"
 605         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 606         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 607         set_pre_cmd $emacs_client $gdb_client
 608         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 609         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd2_file
 610         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd2_file
 611         write_script_footer $cmd2_file $perf_client
 612         chmod +x $cmd2_file
 613
 614     fi
 615 }
 616
 617 native_preload() {
 618     verify_no_vpp
 619     banner="Running NATIVE-PRELOAD socket test"
 620     ld_preload="$VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib "
 621
 622     title1="VPP$title_dbg (Native-Preload Socket Test)"
 623     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 624     gdb_cmdfile=$VPP_GDB_CMDFILE
 625     set_pre_cmd $emacs_vpp $gdb_vpp
 626     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 627     if [ -n "$multi_host" ] && [ $emacs_vpp -eq 0 ] ; then
 628         echo -n "sudo " >> $cmd1_file
 629     fi
 630     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args " >> $cmd1_file
 631     write_script_footer $cmd1_file $perf_vpp
 632     chmod +x $cmd1_file
 633
 634     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 635         title2="SERVER$title_dbg (Native-Preload Socket Test)"
 636         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 637         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 638         set_pre_cmd $emacs_server $gdb_server $ld_preload
 639         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 640         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$VCL_LDPRELOAD_LIB_DIR:$LD_LIBRARY_PATH\"" >> $cmd2_file
 641         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd2_file
 642         write_script_footer $cmd2_file $perf_server
 643         chmod +x $cmd2_file
 644     fi
 645
 646     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 647         title3="CLIENT$title_dbg (Native-Preload Socket Test)"
 648         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 649         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 650         set_pre_cmd $emacs_client $gdb_client $ld_preload
 651         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 4"
 652         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$VCL_LDPRELOAD_LIB_DIR:$LD_LIBRARY_PATH\"" >> $cmd3_file
 653         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd3_file
 654         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd3_file
 655         write_script_footer $cmd3_file $perf_client
 656         chmod +x $cmd3_file
 657     fi
 658 }
 659
 660 native_vcl() {
 661     verify_no_vpp
 662     banner="Running NATIVE-VCL socket test"
 663
 664     title1="VPP$title_dbg (Native-VCL Socket Test)"
 665     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 666     gdb_cmdfile=$VPP_GDB_CMDFILE
 667     set_pre_cmd $emacs_vpp $gdb_vpp
 668     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 669     if [ -n "$multi_host" ] && [ $emacs_vpp -eq 0 ] ; then
 670         echo -n "sudo " >> $cmd1_file
 671     fi
 672     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args " >> $cmd1_file
 673     write_script_footer $cmd1_file $perf_vpp
 674     chmod +x $cmd1_file
 675
 676     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 677         title2="SERVER$title_dbg (Native-VCL Socket Test)"
 678         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 679         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 680         set_pre_cmd $emacs_server $gdb_server
 681         if [ "$multi_host" = "server" ] ; then
 682             delay="sleep 10"
 683         else
 684             delay="sleep 2"
 685         fi
 686         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "$delay"
 687         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$LD_LIBRARY_PATH\"" >> $cmd2_file
 688         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd2_file
 689         write_script_footer $cmd2_file $perf_server
 690         chmod +x $cmd2_file
 691     fi
 692
 693     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 694         title3="CLIENT$title_dbg (Native-VCL Socket Test)"
 695         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 696         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 697         set_pre_cmd $emacs_client $gdb_client
 698         if [ "$multi_host" = "client" ] ; then
 699             delay="sleep 10"
 700         else
 701             delay="sleep 4"
 702         fi
 703         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "$delay"
 704         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$LD_LIBRARY_PATH\"" >> $cmd3_file
 705         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd3_file
 706         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd3_file
 707         write_script_footer $cmd3_file $perf_client
 708         chmod +x $cmd3_file
 709     fi
 710 }
 711
 712 docker_kernel() {
 713     verify_no_docker_containers
 714     banner="Running DOCKER-KERNEL socket test"
 715
 716     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 717         title1="SERVER$title_dbg (Docker-Native Socket Test)"
 718         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 719         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 720         set_pre_cmd $emacs_server $gdb_server
 721         write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 722         echo "docker run -it --cpuset-cpus='4-7' --cpuset-cpus='4-7' -v $vpp_dir:$docker_vpp_dir -p $sock_srvr_port:$sock_srvr_port $docker_os ${docker_app_dir}${srvr_app}" >> $cmd1_file
 723         write_script_footer $cmd1_file $perf_server
 724         chmod +x $cmd1_file
 725     fi
 726
 727     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 728         title2="CLIENT$title_dbg (Docker-Native Socket Test)"
 729         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 730         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 731         set_pre_cmd $emacs_client $gdb_client
 732         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 733         echo "$get_docker_server_ip4addr" >> $cmd2_file
 734         echo "docker run -it --cpuset-cpus='4-7' -v $vpp_dir:$docker_vpp_dir $docker_os ${docker_app_dir}${clnt_app}" >> $cmd2_file
 735         write_script_footer $cmd2_file $perf_client
 736         chmod +x $cmd2_file
 737     fi
 738 }
 739
 740 docker_preload() {
 741     verify_no_vpp
 742     verify_no_docker_containers
 743     banner="Running DOCKER-PRELOAD socket test"
 744     docker_ld_preload_dir="/vcl-ldpreload/"
 745     ld_preload_dir="$VCL_LDPRELOAD_LIB_DIR"
 746     ld_preload="$docker_ld_preload_dir$vcl_ldpreload_lib "
 747     docker_ld_preload_lib="$docker_ld_preload_dir$vcl_ldpreload_lib "
 748
 749     title1="VPP$title_dbg (Docker-Preload Socket Test)"
 750     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 751     gdb_cmdfile=$VPP_GDB_CMDFILE
 752     set_pre_cmd $emacs_vpp $gdb_vpp
 753     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 754     if [ -n "$multi_host" ] ; then
 755         echo -n "sudo " >> $cmd1_file
 756     fi
 757     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args" >> $cmd1_file
 758     write_script_footer $cmd1_file $perf_vpp
 759     chmod +x $cmd1_file
 760
 761     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 762         title2="SERVER$title_dbg (Docker-Preload Socket Test)"
 763         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 764         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 765         set_pre_cmd $emacs_server $gdb_server $docker_ld_preload_lib
 766         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 767         echo "docker run -it -v $vpp_shm_dir:$vpp_shm_dir -v $vpp_dir:$docker_vpp_dir -v $lib64_dir:$docker_lib64_dir -v $ld_preload_dir:$docker_ld_preload_dir -v $vcl_config_dir:$docker_vcl_config_dir -p $sock_srvr_port:$sock_srvr_port -e VCL_CONFIG=${docker_vcl_config_dir}$vcl_config -e LD_LIBRARY_PATH=$docker_lib64_dir:$docker_ld_preload_dir ${docker_ld_preload}$docker_os ${docker_app_dir}${srvr_app}" >> $cmd2_file
 768         write_script_footer $cmd2_file $perf_server
 769         chmod +x $cmd2_file
 770     fi
 771
 772     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 773         title3="CLIENT$title_dbg (Docker-Preload Socket Test)"
 774         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 775         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 776         set_pre_cmd $emacs_client $gdb_client $docker_ld_preload_lib
 777         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 4"
 778         echo "$get_docker_server_ip4addr" >> $cmd3_file
 779         echo "docker run -it --cpuset-cpus='4-7' -v $vpp_shm_dir:$vpp_shm_dir -v $vpp_dir:$docker_vpp_dir -v $lib64_dir:$docker_lib64_dir  -v $ld_preload_dir:$docker_ld_preload_dir -v $vcl_config_dir:$docker_vcl_config_dir -e VCL_CONFIG=${docker_vcl_config_dir}$vcl_config -e LD_LIBRARY_PATH=$docker_lib64_dir ${docker_ld_preload}$docker_os ${docker_app_dir}${clnt_app}" >> $cmd3_file
 780         write_script_footer $cmd3_file $perf_client
 781         chmod +x $cmd3_file
 782     fi
 783 }
 784
 785 docker_vcl() {
 786     verify_no_vpp
 787     verify_no_docker_containers
 788     banner="Running DOCKER-VCL socket test"
 789
 790     title1="VPP$title_dbg (Docker-VCL Socket Test)"
 791     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 792     gdb_cmdfile=$VPP_GDB_CMDFILE
 793     set_pre_cmd $emacs_vpp $gdb_vpp
 794     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 795     if [ -n "$multi_host" ] ; then
 796         echo -n "sudo " >> $cmd1_file
 797     fi
 798     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args" >> $cmd1_file
 799     write_script_footer $cmd1_file $perf_vpp
 800     chmod +x $cmd1_file
 801
 802     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 803         title2="SERVER$title_dbg (Docker-VCL Socket Test)"
 804         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 805         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 806         set_pre_cmd $emacs_server $gdb_server
 807         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 808         echo "docker run -it --cpuset-cpus='4-7' -v $vpp_shm_dir:$vpp_shm_dir -v $vpp_dir:$docker_vpp_dir -v $lib64_dir:$docker_lib64_dir -v $vcl_config_dir:$docker_vcl_config_dir -p $sock_srvr_port:$sock_srvr_port -e VCL_CONFIG=${docker_vcl_config_dir}/$vcl_config -e LD_LIBRARY_PATH=$docker_lib64_dir $docker_os ${docker_app_dir}${srvr_app}" >> $cmd2_file
 809         write_script_footer $cmd2_file $perf_server
 810         chmod +x $cmd2_file
 811     fi
 812
 813     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 814         title3="CLIENT$title_dbg (Docker-VCL Socket Test)"
 815         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 816         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 817         set_pre_cmd $emacs_client $gdb_client
 818         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 3"
 819         echo "$get_docker_server_ip4addr" >> $cmd3_file
 820         echo "docker run -it --cpuset-cpus='4-7' -v $vpp_shm_dir:$vpp_shm_dir -v $vpp_dir:$docker_vpp_dir -v $lib64_dir:$docker_lib64_dir -v $vcl_config_dir:$docker_vcl_config_dir -e VCL_CONFIG=${docker_vcl_config_dir}/$vcl_config -e LD_LIBRARY_PATH=$docker_lib64_dir $docker_os ${docker_app_dir}${clnt_app}" >> $cmd3_file
 821         write_script_footer $cmd3_file $perf_client
 822         chmod +x $cmd3_file
 823     fi
 824 }
 825
 826 if [[ $run_test ]] ; then
 827     eval $run_test
 828 else
 829     echo "ERROR: Please specify a test to run!" >&2
 830     usage;
 831 fi
 832
 833 if (( $(which xfce4-terminal | wc -l) > 0 )) ; then
 834     xterm_cmd="xfce4-terminal --geometry $xterm_geom"
 835     if [[ $use_tabs ]] ; then
 836         declare -a tab_cmd_files
 837         declare -a tab_titles
 838         declare -i i=0
 839
 840         if [ -x "$cmd1_file" ] ; then
 841             tab_cmd_files[$i]="$cmd1_file"
 842             tab_titles[$i]="$title1"
 843             (( i++ ))
 844         fi
 845         if [ -x "$cmd2_file" ] ; then
 846             tab_cmd_files[$i]="$cmd2_file"
 847             tab_titles[$i]="$title2"
 848             (( i++ ))
 849         fi
 850         if [ -x "$cmd3_file" ] ; then
 851             tab_cmd_files[$i]="$cmd3_file"
 852             tab_titles[$i]="$title3"
 853         fi
 854
 855         if [ -n "${tab_cmd_files[2]}" ] ; then
 856             $xterm_cmd  --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}" --tab --title "${tab_titles[1]}" --command "${tab_cmd_files[1]}" --tab --title "${tab_titles[2]}" --command "${tab_cmd_files[2]}"
 857         elif [ -n "${tab_cmd_files[1]}" ] ; then
 858             $xterm_cmd --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}" --tab --title "${tab_titles[1]}" --command "${tab_cmd_files[1]}"
 859
 860         else
 861             $xterm_cmd --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}"
 862         fi
 863
 864     else
 865         if [ -x "$cmd1_file" ] ; then
 866             ($xterm_cmd --title "$title1" --command "$cmd1_file" &)
 867         fi
 868         if [ -x "$cmd2_file" ] ; then
 869             ($xterm_cmd --title "$title2" --command "$cmd2_file" &)
 870         fi
 871         if [ -x "$cmd3_file" ] ; then
 872             ($xterm_cmd --title "$title3" --command "$cmd3_file" &)
 873         fi
 874     fi
 875
 876 else
 877     if [[ $use_tabs ]] ; then
 878         echo "Sorry, plain ol' xterm doesn't support tabs."
 879     fi
 880     xterm_cmd="xterm -fs 10 -geometry $xterm_geom"
 881     if [ -x "$cmd1_file" ] ; then
 882         ($xterm_cmd -title "$title1" -e "$cmd1_file" &)
 883     fi
 884     if [ -x "$cmd2_file" ] ; then
 885         ($xterm_cmd -title "$title2" -e "$cmd2_file" &)
 886     fi
 887     if [ -x "$cmd3_file" ] ; then
 888         ($xterm_cmd -title "$title3" -e "$cmd3_file" &)
 889     fi
 890 fi
 891
 892 sleep 1