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 [ -z "$WS_ROOT" ] ; then
 252     echo "ERROR: WS_ROOT environment variable not set!" >&2
 253     echo "       Please set WS_ROOT to VPP workspace root directory." >&2
 254     exit 1
 255 fi
 256
 257 if [[ "$(grep bin_PROGRAMS $WS_ROOT/src/vcl.am)" = "" ]] ; then
 258     $WS_ROOT/extras/vagrant/vcl_test.sh $WS_ROOT $USER
 259     (cd $WS_ROOT; make build)
 260 fi
 261
 262 if [ ! -d $vpp_dir ] ; then
 263     echo "ERROR: Missing VPP$title_dbg bin directory!" >&2
 264     echo "       $vpp_dir" >&2
 265     env_test_failed="true"
 266 fi
 267
 268 if [[ $run_test =~ .*"_preload" ]] ; then
 269    if [ ! -d $lib64_dir ] ; then
 270        echo "ERROR: Missing VPP$title_dbg lib64 directory!" >&2
 271        echo "       $lib64_dir" >&2
 272    elif [ ! -d $VCL_LDPRELOAD_LIB_DIR ] ; then
 273        echo "ERROR: Missing VCL LD_PRELOAD Library directory!" >&2
 274        echo "       $VCL_LDPRELOAD_LIB_DIR" >&2
 275        env_test_failed="true"
 276    elif [ ! -f $VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib ] ; then
 277        echo "ERROR: Missing VCL LD_PRELOAD library!" >&2
 278        echo "       $VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib" >&2
 279        env_test_failed="true"
 280    fi
 281 fi
 282
 283 if [ ! -f $vpp_dir$vpp_app ] ; then
 284     echo "ERROR: Missing VPP$title_dbg Application!" >&2
 285     echo "       $vpp_dir$vpp_app" >&2
 286     env_test_failed="true"
 287 fi
 288
 289 if [ ! -f $vpp_dir$sock_srvr_app ] && [ ! $iperf3 -eq 1 ] ; then
 290     echo "ERROR: Missing$title_dbg Socket Server Application!" >&2
 291     echo "       $vpp_dir$sock_srvr_app" >&2
 292     env_test_failed="true"
 293 fi
 294
 295 if [ ! -f $vpp_dir$sock_clnt_app ] && [ ! $iperf3 -eq 1 ] ; then
 296     echo "ERROR: Missing$title_dbg Socket Client Application!" >&2
 297     echo "       $vpp_dir$sock_clnt_app" >&2
 298     env_test_failed="true"
 299 fi
 300
 301 if [[ $run_test =~ "docker_".* ]] ; then
 302     if [ $emacs_client -eq 1 ] || [ $emacs_server -eq 1 ] || [ $gdb_client -eq 1 ] || [ $gdb_server -eq 1 ] ; then
 303
 304         echo "WARNING: gdb is not currently supported in docker."
 305         echo "         Ignoring client/server gdb options."
 306         emacs_client=0
 307         emacs_server=0
 308         gdb_client=0
 309         gdb_server=0
 310     fi
 311 fi
 312
 313 if [[ $run_test =~ .*"_vcl" ]] && [ $iperf3 -eq 1 ] ; then
 314     echo "ERROR: Invalid option 'i' for test $run_test!"
 315     echo "       iperf3 is not compiled with the VCL library."
 316     env_test_failed="true"
 317 fi
 318
 319 if [ -n "$mult_host"] && [ ! -f "$dpdk_devbind" ] ; then
 320     echo "ERROR: Can't find dpdk-devbind.py!"
 321     echo "       Run \"cd \$WS_ROOT; make dpdk-install-dev\" to install it."
 322     echo
 323     env_test_failed="true"
 324 fi
 325
 326 if [ -n "$env_test_failed" ] ; then
 327     exit 1
 328 fi
 329
 330 if [ -f "$VCL_CONFIG" ] ; then
 331     vcl_config="$(basename $VCL_CONFIG)"
 332     vcl_config_dir="$(dirname $VCL_CONFIG)/"
 333     api_prefix="$(egrep -s '^\s*api-prefix \w+' $VCL_CONFIG | tail -1 | awk -e '{print $2}')"
 334     if [ -n "$api_prefix" ] ; then
 335         api_segment=" api-segment { gid $user_gid prefix $api_prefix }"
 336     fi
 337 fi
 338 if [ -n "$VCL_APP_NAMESPACE_ID" ] && [ -n "$VCL_APP_NAMESPACE_SECRET" ] ; then
 339     namespace_id="$VCL_APP_NAMESPACE_ID"
 340     namespace_secret="$VCL_APP_NAMESPACE_SECRET"
 341 fi
 342
 343 if [ -z "$api_segment" ] ; then
 344     api_segment=" api-segment { gid $user_gid }"
 345 fi
 346 vpp_args="unix { interactive full-coredump coredump-size unlimited exec $tmp_vpp_exec_file}${api_segment}"
 347
 348 if [ $iperf3 -eq 1 ] ; then
 349     app_dir="$(dirname $(which iperf3))/"
 350     srvr_app=$iperf_srvr_app
 351     clnt_app=$iperf_clnt_app
 352     if [[ $run_test =~ "docker_".* ]] ; then
 353         unset -v app_dir
 354         sock_srvr_port=5201
 355         docker_app_dir="networkstatic/"
 356         unset -v docker_os
 357     fi
 358 else
 359     app_dir="$vpp_dir"
 360     srvr_app="$sock_srvr_app $sock_srvr_port"
 361     clnt_app="$sock_clnt_app${sock_clnt_options} \$srvr_addr $sock_srvr_port"
 362 fi
 363
 364
 365 verify_no_vpp() {
 366     local grep_for_vpp="ps -eaf|grep -v grep|grep \"bin/vpp\""
 367
 368     if [ -n "$api_prefix" ] ; then
 369         grep_for_vpp="$grep_for_vpp|grep \"prefix $api_prefix\""
 370     fi
 371     local running_vpp="$(eval $grep_for_vpp)"
 372     if [ -n "$running_vpp" ] ; then
 373         echo "ERROR: Please kill the following vpp instance(s):"
 374         echo
 375         echo $running_vpp
 376         echo
 377         exit 1
 378     fi
 379     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]*"
 380     sudo rm -f $clean_devshm
 381     devshm_files="$(ls -l $clean_devshm 2>/dev/null | grep $(whoami))"
 382     if [ "$devshm_files" != "" ] ; then
 383         echo "ERROR: Please remove the following $vpp_shm_dir files:"
 384         for file in "$devshm_files" ; do
 385             echo "  $file"
 386         done
 387         exit 1
 388     fi
 389     if [ ! -d "$vpp_run_dir" ] ; then
 390         sudo mkdir $vpp_run_dir
 391         sudo chown root:$USER $vpp_run_dir
 392     fi
 393     if [ -n "$multi_host" ] ; then
 394         vpp_eth_pci_id="$(ls -ld /sys/class/net/$vpp_eth_name/device | awk '{print $11}' | cut -d/ -f4)"
 395         if [ -z "$vpp_eth_pci_id" ] ; then
 396             echo "ERROR: Missing ethernet interface $vpp_eth_name!"
 397             usage
 398         fi
 399         printf -v bus "%x" "0x$(echo $vpp_eth_pci_id | cut -d: -f2)"
 400         printf -v slot "%x" "0x$(echo $vpp_eth_pci_id | cut -d: -f3 | cut -d. -f1)"
 401         printf -v func "%x" "0x$(echo $vpp_eth_pci_id | cut -d. -f2)"
 402
 403         vpp_eth_kernel_driver="$(basename $(ls -l /sys/bus/pci/devices/$vpp_eth_pci_id/driver | awk '{print $11}'))"
 404         if [ -z "$vpp_eth_kernel_driver" ] ; then
 405             echo "ERROR: Missing kernel driver for $vpp_eth_name!"
 406             usage
 407         fi
 408         case $vpp_eth_kernel_driver in
 409             e1000)
 410                 vpp_eth_ifname="GigabitEthernet$bus/$slot/$func" ;;
 411             ixgbe)
 412                 vpp_eth_ifname="TenGigabitEthernet$bus/$slot/$func" ;;
 413             i40e)
 414                 vpp_eth_ifname="FortyGigabitEthernet$bus/$slot/$func" ;;
 415             *)
 416                 echo "ERROR: Unknown ethernet kernel driver $vpp_eth_kernel_driver!"
 417                 usage ;;
 418         esac
 419
 420         vpp_eth_ip4_addr="$(ip -4 -br addr show $vpp_eth_name | awk '{print $3}')"
 421         if [ -z "$vpp_eth_ip4_addr" ] ; then
 422             if [ "$multi_host" = "server" ] ; then
 423                 vpp_eth_ip4_addr="10.10.10.10/24"
 424             else
 425                 vpp_eth_ip4_addr="10.10.10.11/24"
 426             fi
 427         fi
 428         if [ $use_ipv6 -eq 1 ] && [ -z "$vpp_eth_ip6_addr" ] ; then
 429             echo "ERROR: No inet6 address configured for $vpp_eth_name!"
 430             usage
 431         fi
 432         vpp_args="$vpp_args plugins { path ${lib64_dir}vpp_plugins } dpdk { dev $vpp_eth_pci_id }"
 433
 434         sudo ifconfig $vpp_eth_name down 2> /dev/null
 435         echo "Configuring VPP to use $vpp_eth_name ($vpp_eth_pci_id), inet addr $vpp_eth_ip4_addr"
 436
 437         cat <<EOF >> $tmp_vpp_exec_file
 438 set int state $vpp_eth_ifname up
 439 set int ip addr $vpp_eth_ifname $vpp_eth_ip4_addr
 440 EOF
 441
 442     fi
 443
 444     if [ -n "$namespace_id" ] ; then
 445         cat <<EOF >> $tmp_vpp_exec_file
 446 session enable
 447 app ns add id $namespace_id secret $namespace_secret sw_if_index 0
 448 EOF
 449     fi
 450
 451     cat <<EOF >> $tmp_vpp_exec_file
 452 show version
 453 show version verbose
 454 show cpu
 455 show int
 456 EOF
 457 }
 458
 459 verify_no_docker_containers() {
 460     if (( $(which docker | wc -l) < 1 )) ; then
 461         echo "ERROR: docker is not installed!"
 462         echo "See https://docs.docker.com/engine/installation/linux/ubuntu/"
 463         echo " or https://docs.docker.com/engine/installation/linux/centos/"
 464         exit 1
 465     fi
 466     if (( $(docker ps | wc -l) > 1 )) ; then
 467         echo "ERROR: Run the following to kill all docker containers:"
 468         echo "docker kill \$(docker ps -q)"
 469         echo
 470         docker ps
 471         exit 1
 472     fi
 473 }
 474
 475 set_pre_cmd() {
 476     # arguments
 477     #   $1 : emacs flag
 478     #   $2 : gdb flag
 479     #   $3 : optional LD_PRELOAD library pathname
 480     local -i emacs=$1
 481     local -i gdb=$2
 482
 483     if [ $emacs -eq 1 ] ; then
 484         write_gdb_cmdfile $tmp_gdb_cmdfile $gdb_cmdfile $emacs $3
 485         pre_cmd="$gdb_in_emacs "
 486     elif [ $gdb -eq 1 ] ; then
 487         write_gdb_cmdfile $tmp_gdb_cmdfile $gdb_cmdfile $emacs $3
 488         pre_cmd="gdb -x $tmp_gdb_cmdfile --args "
 489     elif [ -z $3 ] ; then
 490         unset -v pre_cmd
 491     else
 492         docker_ld_preload="-e LD_PRELOAD=$3 "
 493         pre_cmd="LD_PRELOAD=$3 "
 494     fi
 495 }
 496
 497 write_script_header() {
 498     # arguments
 499     #   $1 : command script file
 500     #   $2 : gdb command file
 501     #   $3 : title
 502     #   $4 : optional command string (typically "sleep 2")
 503     echo "$bash_header" > $1
 504     echo -e "#\n# $1 generated on $(date)\n#" >> $1
 505     if [ $leave_tmp_files -eq 0 ] ; then
 506         if [ -n "$multi_host" ] ; then
 507             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
 508         else
 509             echo "trap \"rm -f $1 $2 $tmp_vpp_exec_file\" $trap_signals" >> $1
 510         fi
 511     fi
 512     if [ -n "$VCL_CONFIG" ] ; then
 513         echo "export VCL_CONFIG=${vcl_config_dir}${vcl_config}" >> $1
 514     fi
 515     if [ -n "$VCL_DEBUG" ] ; then
 516         echo "export VCL_DEBUG=$VCL_DEBUG" >> $1
 517     fi
 518     if [ -n "$namespace_id" ] ; then
 519         echo "export VCL_APP_NAMESPACE_ID=\"$namespace_id\"" >> $1
 520         echo "export VCL_APP_NAMESPACE_SECRET=\"$namespace_secret\"" >> $1
 521     fi
 522     if [ -n "$VCL_APP_SCOPE_LOCAL" ] || [ -z "$multi_host" ] ; then
 523         echo "export VCL_APP_SCOPE_LOCAL=true" >> $1
 524     fi
 525     if [ -n "$VCL_APP_SCOPE_GLOBAL" ] || [ -n "$multi_host" ] ; then
 526         echo "export VCL_APP_SCOPE_GLOBAL=true" >> $1
 527     fi
 528     if [ -n "$VCL_APP_PROXY_TRANSPORT_TCP" ] ; then
 529         echo "export VCL_APP_PROXY_TRANSPORT_TCP=true" >> $1
 530     fi
 531     if [ -n "$VCL_APP_PROXY_TRANSPORT_UDP" ] ; then
 532         echo "export VCL_APP_PROXY_TRANSPORT_UDP=true" >> $1
 533     fi
 534     if [ "$pre_cmd" = "$gdb_in_emacs " ] ; then
 535         if [ -n "$multi_host" ] && [[ $3 =~ "VPP".* ]] ; then
 536             cat <<EOF >> $1
 537 $gdb_in_emacs() {
 538     sudo emacs --eval "(gdb \"gdb -x $2 -i=mi --args \$*\")" --eval "(setq frame-title-format \"$3\")"
 539 }
 540 EOF
 541         else
 542             cat <<EOF >> $1
 543 $gdb_in_emacs() {
 544     emacs --eval "(gdb \"gdb -x $2 -i=mi --args \$*\")" --eval "(setq frame-title-format \"$3\")"
 545 }
 546 EOF
 547         fi
 548     fi
 549     if [ -n "$4" ] ; then
 550         echo "$4" >> $1
 551     fi
 552 }
 553
 554 write_script_footer() {
 555     # arguments
 556     #   $1 : command script file
 557     #   $2 : perf flag indicating to run bash before exit
 558     local -i perf=$2
 559     if [ $bash_after_exit -eq 1 ] || [ $perf -eq 1 ] ; then
 560         echo "bash" >> $1
 561     fi
 562 }
 563
 564 write_gdb_cmdfile() {
 565     # arguments
 566     #   $1 : gdb command file
 567     #   $2 : User specified gdb cmdfile
 568     #   $3 : emacs flag
 569     #   $4 : optional LD_PRELOAD library pathname.
 570     local -i emacs=$3
 571
 572     echo "# $1 generated on $(date)" > $1
 573     echo "#" >> $1
 574     echo "set confirm off" >> $1
 575     if [ -n "$4" ] ; then
 576         echo "set exec-wrapper env LD_PRELOAD=$4" >> $1
 577         # echo "start" >> $1
 578     fi
 579
 580     if [ ! -f $2 ] ; then
 581         echo -n "# " >> $1
 582     fi
 583     echo "source $2" >> $1
 584     if [ $emacs -eq 0 ] ; then
 585         echo "run" >> $1
 586     fi
 587 }
 588
 589 native_kernel() {
 590     banner="Running NATIVE-KERNEL socket test"
 591     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 592         title1="SERVER$title_dbg (Native-Kernel Socket Test)"
 593         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 594         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 595         set_pre_cmd $emacs_server $gdb_server
 596         write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 597         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd1_file
 598         write_script_footer $cmd1_file $perf_server
 599         chmod +x $cmd1_file
 600     fi
 601
 602     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 603         title2="CLIENT$title_dbg (Native-Kernel Socket Test)"
 604         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 605         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 606         set_pre_cmd $emacs_client $gdb_client
 607         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 608         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd2_file
 609         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd2_file
 610         write_script_footer $cmd2_file $perf_client
 611         chmod +x $cmd2_file
 612
 613     fi
 614 }
 615
 616 native_preload() {
 617     verify_no_vpp
 618     banner="Running NATIVE-PRELOAD socket test"
 619     ld_preload="$VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib "
 620
 621     title1="VPP$title_dbg (Native-Preload Socket Test)"
 622     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 623     gdb_cmdfile=$VPP_GDB_CMDFILE
 624     set_pre_cmd $emacs_vpp $gdb_vpp
 625     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 626     if [ -n "$multi_host" ] && [ $emacs_vpp -eq 0 ] ; then
 627         echo -n "sudo " >> $cmd1_file
 628     fi
 629     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args " >> $cmd1_file
 630     write_script_footer $cmd1_file $perf_vpp
 631     chmod +x $cmd1_file
 632
 633     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 634         title2="SERVER$title_dbg (Native-Preload Socket Test)"
 635         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 636         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 637         set_pre_cmd $emacs_server $gdb_server $ld_preload
 638         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 639         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$VCL_LDPRELOAD_LIB_DIR:$LD_LIBRARY_PATH\"" >> $cmd2_file
 640         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd2_file
 641         write_script_footer $cmd2_file $perf_server
 642         chmod +x $cmd2_file
 643     fi
 644
 645     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 646         title3="CLIENT$title_dbg (Native-Preload Socket Test)"
 647         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 648         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 649         set_pre_cmd $emacs_client $gdb_client $ld_preload
 650         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 4"
 651         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$VCL_LDPRELOAD_LIB_DIR:$LD_LIBRARY_PATH\"" >> $cmd3_file
 652         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd3_file
 653         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd3_file
 654         write_script_footer $cmd3_file $perf_client
 655         chmod +x $cmd3_file
 656     fi
 657 }
 658
 659 native_vcl() {
 660     verify_no_vpp
 661     banner="Running NATIVE-VCL socket test"
 662
 663     title1="VPP$title_dbg (Native-VCL Socket Test)"
 664     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 665     gdb_cmdfile=$VPP_GDB_CMDFILE
 666     set_pre_cmd $emacs_vpp $gdb_vpp
 667     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 668     if [ -n "$multi_host" ] && [ $emacs_vpp -eq 0 ] ; then
 669         echo -n "sudo " >> $cmd1_file
 670     fi
 671     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args " >> $cmd1_file
 672     write_script_footer $cmd1_file $perf_vpp
 673     chmod +x $cmd1_file
 674
 675     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 676         title2="SERVER$title_dbg (Native-VCL Socket Test)"
 677         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 678         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 679         set_pre_cmd $emacs_server $gdb_server
 680         if [ "$multi_host" = "server" ] ; then
 681             delay="sleep 10"
 682         else
 683             delay="sleep 2"
 684         fi
 685         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "$delay"
 686         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$LD_LIBRARY_PATH\"" >> $cmd2_file
 687         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd2_file
 688         write_script_footer $cmd2_file $perf_server
 689         chmod +x $cmd2_file
 690     fi
 691
 692     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 693         title3="CLIENT$title_dbg (Native-VCL Socket Test)"
 694         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 695         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 696         set_pre_cmd $emacs_client $gdb_client
 697         if [ "$multi_host" = "client" ] ; then
 698             delay="sleep 10"
 699         else
 700             delay="sleep 4"
 701         fi
 702         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "$delay"
 703         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$LD_LIBRARY_PATH\"" >> $cmd3_file
 704         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd3_file
 705         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd3_file
 706         write_script_footer $cmd3_file $perf_client
 707         chmod +x $cmd3_file
 708     fi
 709 }
 710
 711 docker_kernel() {
 712     verify_no_docker_containers
 713     banner="Running DOCKER-KERNEL socket test"
 714
 715     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 716         title1="SERVER$title_dbg (Docker-Native Socket Test)"
 717         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 718         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 719         set_pre_cmd $emacs_server $gdb_server
 720         write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 721         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
 722         write_script_footer $cmd1_file $perf_server
 723         chmod +x $cmd1_file
 724     fi
 725
 726     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 727         title2="CLIENT$title_dbg (Docker-Native Socket Test)"
 728         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 729         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 730         set_pre_cmd $emacs_client $gdb_client
 731         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 732         echo "$get_docker_server_ip4addr" >> $cmd2_file
 733         echo "docker run -it --cpuset-cpus='4-7' -v $vpp_dir:$docker_vpp_dir $docker_os ${docker_app_dir}${clnt_app}" >> $cmd2_file
 734         write_script_footer $cmd2_file $perf_client
 735         chmod +x $cmd2_file
 736     fi
 737 }
 738
 739 docker_preload() {
 740     verify_no_vpp
 741     verify_no_docker_containers
 742     banner="Running DOCKER-PRELOAD socket test"
 743     docker_ld_preload_dir="/vcl-ldpreload/"
 744     ld_preload_dir="$VCL_LDPRELOAD_LIB_DIR"
 745     ld_preload="$docker_ld_preload_dir$vcl_ldpreload_lib "
 746     docker_ld_preload_lib="$docker_ld_preload_dir$vcl_ldpreload_lib "
 747
 748     title1="VPP$title_dbg (Docker-Preload Socket Test)"
 749     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 750     gdb_cmdfile=$VPP_GDB_CMDFILE
 751     set_pre_cmd $emacs_vpp $gdb_vpp
 752     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 753     if [ -n "$multi_host" ] ; then
 754         echo -n "sudo " >> $cmd1_file
 755     fi
 756     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args" >> $cmd1_file
 757     write_script_footer $cmd1_file $perf_vpp
 758     chmod +x $cmd1_file
 759
 760     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 761         title2="SERVER$title_dbg (Docker-Preload Socket Test)"
 762         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 763         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 764         set_pre_cmd $emacs_server $gdb_server $docker_ld_preload_lib
 765         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 766         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
 767         write_script_footer $cmd2_file $perf_server
 768         chmod +x $cmd2_file
 769     fi
 770
 771     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 772         title3="CLIENT$title_dbg (Docker-Preload Socket Test)"
 773         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 774         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 775         set_pre_cmd $emacs_client $gdb_client $docker_ld_preload_lib
 776         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 4"
 777         echo "$get_docker_server_ip4addr" >> $cmd3_file
 778         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
 779         write_script_footer $cmd3_file $perf_client
 780         chmod +x $cmd3_file
 781     fi
 782 }
 783
 784 docker_vcl() {
 785     verify_no_vpp
 786     verify_no_docker_containers
 787     banner="Running DOCKER-VCL socket test"
 788
 789     title1="VPP$title_dbg (Docker-VCL Socket Test)"
 790     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 791     gdb_cmdfile=$VPP_GDB_CMDFILE
 792     set_pre_cmd $emacs_vpp $gdb_vpp
 793     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 794     if [ -n "$multi_host" ] ; then
 795         echo -n "sudo " >> $cmd1_file
 796     fi
 797     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args" >> $cmd1_file
 798     write_script_footer $cmd1_file $perf_vpp
 799     chmod +x $cmd1_file
 800
 801     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 802         title2="SERVER$title_dbg (Docker-VCL Socket Test)"
 803         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 804         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 805         set_pre_cmd $emacs_server $gdb_server
 806         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 807         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
 808         write_script_footer $cmd2_file $perf_server
 809         chmod +x $cmd2_file
 810     fi
 811
 812     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 813         title3="CLIENT$title_dbg (Docker-VCL Socket Test)"
 814         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 815         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 816         set_pre_cmd $emacs_client $gdb_client
 817         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 3"
 818         echo "$get_docker_server_ip4addr" >> $cmd3_file
 819         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
 820         write_script_footer $cmd3_file $perf_client
 821         chmod +x $cmd3_file
 822     fi
 823 }
 824
 825 if [[ $run_test ]] ; then
 826     eval $run_test
 827 else
 828     echo "ERROR: Please specify a test to run!" >&2
 829     usage;
 830 fi
 831
 832 if (( $(which xfce4-terminal | wc -l) > 0 )) ; then
 833     xterm_cmd="xfce4-terminal --geometry $xterm_geom"
 834     if [[ $use_tabs ]] ; then
 835         declare -a tab_cmd_files
 836         declare -a tab_titles
 837         declare -i i=0
 838
 839         if [ -x "$cmd1_file" ] ; then
 840             tab_cmd_files[$i]="$cmd1_file"
 841             tab_titles[$i]="$title1"
 842             (( i++ ))
 843         fi
 844         if [ -x "$cmd2_file" ] ; then
 845             tab_cmd_files[$i]="$cmd2_file"
 846             tab_titles[$i]="$title2"
 847             (( i++ ))
 848         fi
 849         if [ -x "$cmd3_file" ] ; then
 850             tab_cmd_files[$i]="$cmd3_file"
 851             tab_titles[$i]="$title3"
 852         fi
 853
 854         if [ -n "${tab_cmd_files[2]}" ] ; then
 855             $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]}"
 856         elif [ -n "${tab_cmd_files[1]}" ] ; then
 857             $xterm_cmd --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}" --tab --title "${tab_titles[1]}" --command "${tab_cmd_files[1]}"
 858
 859         else
 860             $xterm_cmd --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}"
 861         fi
 862
 863     else
 864         if [ -x "$cmd1_file" ] ; then
 865             ($xterm_cmd --title "$title1" --command "$cmd1_file" &)
 866         fi
 867         if [ -x "$cmd2_file" ] ; then
 868             ($xterm_cmd --title "$title2" --command "$cmd2_file" &)
 869         fi
 870         if [ -x "$cmd3_file" ] ; then
 871             ($xterm_cmd --title "$title3" --command "$cmd3_file" &)
 872         fi
 873     fi
 874
 875 else
 876     if [[ $use_tabs ]] ; then
 877         echo "Sorry, plain ol' xterm doesn't support tabs."
 878     fi
 879     xterm_cmd="xterm -fs 10 -geometry $xterm_geom"
 880     if [ -x "$cmd1_file" ] ; then
 881         ($xterm_cmd -title "$title1" -e "$cmd1_file" &)
 882     fi
 883     if [ -x "$cmd2_file" ] ; then
 884         ($xterm_cmd -title "$title2" -e "$cmd2_file" &)
 885     fi
 886     if [ -x "$cmd3_file" ] ; then
 887         ($xterm_cmd -title "$title3" -e "$cmd3_file" &)
 888     fi
 889 fi
 890
 891 sleep 1