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 vppcom_conf="vppcom.conf"
  28 vppcom_conf_dir="$WS_ROOT/src/uri/"
  29 docker_vppcom_conf_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 VPPCOM_CONF to use the vppcom_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   VPPCOM_CONF                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) VPPCOM_CONF="${vppcom_conf_dir}vppcom_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 "$VPPCOM_CONF" ] ; then
 331     vppcom_conf="$(basename $VPPCOM_CONF)"
 332     vppcom_conf_dir="$(dirname $VPPCOM_CONF)/"
 333     api_prefix="$(egrep -s '^\s*api-prefix \w+' $VPPCOM_CONF | 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 [ -z "$api_segment" ] ; then
 339     api_segment=" api-segment { gid $user_gid }"
 340 fi
 341 if [ -n "$multi_host" ] ; then
 342     sudo modprobe uio_pci_generic
 343     vpp_args="unix { interactive exec $tmp_vpp_exec_file}${api_segment}"
 344 else
 345     vpp_args="unix { interactive }${api_segment}"
 346 fi
 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
 445 verify_no_docker_containers() {
 446     if (( $(which docker | wc -l) < 1 )) ; then
 447         echo "ERROR: docker is not installed!"
 448         echo "See https://docs.docker.com/engine/installation/linux/ubuntu/"
 449         echo " or https://docs.docker.com/engine/installation/linux/centos/"
 450         exit 1
 451     fi
 452     if (( $(docker ps | wc -l) > 1 )) ; then
 453         echo "ERROR: Run the following to kill all docker containers:"
 454         echo "docker kill \$(docker ps -q)"
 455         echo
 456         docker ps
 457         exit 1
 458     fi
 459 }
 460
 461 set_pre_cmd() {
 462     # arguments
 463     #   $1 : emacs flag
 464     #   $2 : gdb flag
 465     #   $3 : optional LD_PRELOAD library pathname
 466     local -i emacs=$1
 467     local -i gdb=$2
 468
 469     if [ $emacs -eq 1 ] ; then
 470         write_gdb_cmdfile $tmp_gdb_cmdfile $gdb_cmdfile $emacs $3
 471         pre_cmd="$gdb_in_emacs "
 472     elif [ $gdb -eq 1 ] ; then
 473         write_gdb_cmdfile $tmp_gdb_cmdfile $gdb_cmdfile $emacs $3
 474         pre_cmd="gdb -x $tmp_gdb_cmdfile -i=mi --args "
 475     elif [ -z $3 ] ; then
 476         unset -v pre_cmd
 477     else
 478         docker_ld_preload="-e LD_PRELOAD=$3 "
 479         pre_cmd="LD_PRELOAD=$3 "
 480     fi
 481 }
 482
 483 write_script_header() {
 484     # arguments
 485     #   $1 : command script file
 486     #   $2 : gdb command file
 487     #   $3 : title
 488     #   $4 : optional command string (typically "sleep 2")
 489     echo "$bash_header" > $1
 490     echo -e "#\n# $1 generated on $(date)\n#" >> $1
 491     if [ $leave_tmp_files -eq 0 ] ; then
 492         if [ -n "$multi_host" ] ; then
 493             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
 494         else
 495             echo "trap \"rm -f $1 $2 $tmp_vpp_exec_file\" $trap_signals" >> $1
 496         fi
 497     fi
 498     echo "export VPPCOM_CONF=${vppcom_conf_dir}${vppcom_conf}" >> $1
 499     if [ "$pre_cmd" = "$gdb_in_emacs " ] ; then
 500         if [ -n "$multi_host" ] && [[ $3 =~ "VPP".* ]] ; then
 501             cat <<EOF >> $1
 502 $gdb_in_emacs() {
 503     sudo emacs --eval "(gdb \"gdb -x $2 -i=mi --args \$*\")" --eval "(setq frame-title-format \"$3\")"
 504 }
 505 EOF
 506         else
 507             cat <<EOF >> $1
 508 $gdb_in_emacs() {
 509     emacs --eval "(gdb \"gdb -x $2 -i=mi --args \$*\")" --eval "(setq frame-title-format \"$3\")"
 510 }
 511 EOF
 512         fi
 513     fi
 514     if [ -n "$4" ] ; then
 515         echo "$4" >> $1
 516     fi
 517 }
 518
 519 write_script_footer() {
 520     # arguments
 521     #   $1 : command script file
 522     #   $2 : perf flag indicating to run bash before exit
 523     local -i perf=$2
 524     if [ $bash_after_exit -eq 1 ] || [ $perf -eq 1 ] ; then
 525         echo "bash" >> $1
 526     fi
 527 }
 528
 529 write_gdb_cmdfile() {
 530     # arguments
 531     #   $1 : gdb command file
 532     #   $2 : User specified gdb cmdfile
 533     #   $3 : emacs flag
 534     #   $4 : optional LD_PRELOAD library pathname.
 535     local -i emacs=$3
 536
 537     echo "# $1 generated on $(date)" > $1
 538     echo "#" >> $1
 539     echo "set confirm off" >> $1
 540     if [ -n "$4" ] ; then
 541         echo "set exec-wrapper env LD_PRELOAD=$4" >> $1
 542         echo "start" >> $1
 543     fi
 544
 545     if [ ! -f $2 ] ; then
 546         echo -n "# " >> $1
 547     fi
 548     echo "source $2" >> $1
 549     if [ $emacs -eq 0 ] ; then
 550         echo "run" >> $1
 551     fi
 552 }
 553
 554 native_kernel() {
 555     banner="Running NATIVE-KERNEL socket test"
 556     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 557         title1="SERVER$title_dbg (Native-Kernel Socket Test)"
 558         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 559         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 560         set_pre_cmd $emacs_server $gdb_server
 561         write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 562         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd1_file
 563         write_script_footer $cmd1_file $perf_server
 564         chmod +x $cmd1_file
 565     fi
 566
 567     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 568         title2="CLIENT$title_dbg (Native-Kernel Socket Test)"
 569         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 570         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 571         set_pre_cmd $emacs_client $gdb_client
 572         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 573         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd2_file
 574         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd2_file
 575         write_script_footer $cmd2_file $perf_client
 576         chmod +x $cmd2_file
 577
 578     fi
 579 }
 580
 581 native_preload() {
 582     verify_no_vpp
 583     banner="Running NATIVE-PRELOAD socket test"
 584     ld_preload="$VCL_LDPRELOAD_LIB_DIR/$vcl_ldpreload_lib "
 585
 586     title1="VPP$title_dbg (Native-Preload Socket Test)"
 587     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 588     gdb_cmdfile=$VPP_GDB_CMDFILE
 589     set_pre_cmd $emacs_vpp $gdb_vpp
 590     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 591     if [ -n "$multi_host" ] && [ $emacs_vpp -eq 0 ] ; then
 592         echo -n "sudo " >> $cmd1_file
 593     fi
 594     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args " >> $cmd1_file
 595     write_script_footer $cmd1_file $perf_vpp
 596     chmod +x $cmd1_file
 597
 598     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 599         title2="SERVER$title_dbg (Native-Preload Socket Test)"
 600         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 601         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 602         set_pre_cmd $emacs_server $gdb_server $ld_preload
 603         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 604         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$VCL_LDPRELOAD_LIB_DIR:$LD_LIBRARY_PATH\"" >> $cmd2_file
 605         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd2_file
 606         write_script_footer $cmd2_file $perf_server
 607         chmod +x $cmd2_file
 608     fi
 609
 610     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 611         title3="CLIENT$title_dbg (Native-Preload Socket Test)"
 612         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 613         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 614         set_pre_cmd $emacs_client $gdb_client $ld_preload
 615         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 3"
 616         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$VCL_LDPRELOAD_LIB_DIR:$LD_LIBRARY_PATH\"" >> $cmd3_file
 617         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd3_file
 618         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd3_file
 619         write_script_footer $cmd3_file $perf_client
 620         chmod +x $cmd3_file
 621     fi
 622 }
 623
 624 native_vcl() {
 625     verify_no_vpp
 626     banner="Running NATIVE-VCL socket test"
 627
 628     title1="VPP$title_dbg (Native-VCL Socket Test)"
 629     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 630     gdb_cmdfile=$VPP_GDB_CMDFILE
 631     set_pre_cmd $emacs_vpp $gdb_vpp
 632     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 633     if [ -n "$multi_host" ] && [ $emacs_vpp -eq 0 ] ; then
 634         echo -n "sudo " >> $cmd1_file
 635     fi
 636     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args " >> $cmd1_file
 637     write_script_footer $cmd1_file $perf_vpp
 638     chmod +x $cmd1_file
 639
 640     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 641         title2="SERVER$title_dbg (Native-VCL Socket Test)"
 642         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 643         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 644         set_pre_cmd $emacs_server $gdb_server
 645         if [ "$multi_host" = "server" ] ; then
 646             delay="sleep 10"
 647         else
 648             delay="sleep 2"
 649         fi
 650         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "$delay"
 651         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$LD_LIBRARY_PATH\"" >> $cmd2_file
 652         echo "${pre_cmd}${app_dir}${srvr_app}" >> $cmd2_file
 653         write_script_footer $cmd2_file $perf_server
 654         chmod +x $cmd2_file
 655     fi
 656
 657     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 658         title3="CLIENT$title_dbg (Native-VCL Socket Test)"
 659         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 660         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 661         set_pre_cmd $emacs_client $gdb_client
 662         if [ "$multi_host" = "client" ] ; then
 663             delay="sleep 10"
 664         else
 665             delay="sleep 2"
 666         fi
 667         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "$delay"
 668         echo "export LD_LIBRARY_PATH=\"$lib64_dir:$LD_LIBRARY_PATH\"" >> $cmd3_file
 669         echo "srvr_addr=\"$sock_srvr_addr\"" >> $cmd3_file
 670         echo "${pre_cmd}${app_dir}${clnt_app}" >> $cmd3_file
 671         write_script_footer $cmd3_file $perf_client
 672         chmod +x $cmd3_file
 673     fi
 674 }
 675
 676 docker_kernel() {
 677     verify_no_docker_containers
 678     banner="Running DOCKER-KERNEL socket test"
 679
 680     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 681         title1="SERVER$title_dbg (Docker-Native Socket Test)"
 682         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 683         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 684         set_pre_cmd $emacs_server $gdb_server
 685         write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 686         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
 687         write_script_footer $cmd1_file $perf_server
 688         chmod +x $cmd1_file
 689     fi
 690
 691     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 692         title2="CLIENT$title_dbg (Docker-Native Socket Test)"
 693         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 694         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 695         set_pre_cmd $emacs_client $gdb_client
 696         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 697         echo "$get_docker_server_ip4addr" >> $cmd2_file
 698         echo "docker run -it --cpuset-cpus='4-7' -v $vpp_dir:$docker_vpp_dir $docker_os ${docker_app_dir}${clnt_app}" >> $cmd2_file
 699         write_script_footer $cmd2_file $perf_client
 700         chmod +x $cmd2_file
 701     fi
 702 }
 703
 704 docker_preload() {
 705     verify_no_vpp
 706     verify_no_docker_containers
 707     banner="Running DOCKER-PRELOAD socket test"
 708     docker_ld_preload_dir="/vcl-ldpreload/"
 709     ld_preload_dir="$VCL_LDPRELOAD_LIB_DIR"
 710     ld_preload="$docker_ld_preload_dir$vcl_ldpreload_lib "
 711     docker_ld_preload_lib="$docker_ld_preload_dir$vcl_ldpreload_lib "
 712
 713     title1="VPP$title_dbg (Docker-Preload Socket Test)"
 714     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 715     gdb_cmdfile=$VPP_GDB_CMDFILE
 716     set_pre_cmd $emacs_vpp $gdb_vpp
 717     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 718     if [ -n "$multi_host" ] ; then
 719         echo -n "sudo " >> $cmd1_file
 720     fi
 721     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args" >> $cmd1_file
 722     write_script_footer $cmd1_file $perf_vpp
 723     chmod +x $cmd1_file
 724
 725     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 726         title2="SERVER$title_dbg (Docker-Preload Socket Test)"
 727         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 728         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 729         set_pre_cmd $emacs_server $gdb_server $docker_ld_preload_lib
 730         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 731         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 $vppcom_conf_dir:$docker_vppcom_conf_dir -p $sock_srvr_port:$sock_srvr_port -e VPPCOM_CONF=${docker_vppcom_conf_dir}$vppcom_conf -e LD_LIBRARY_PATH=$docker_lib64_dir:$docker_ld_preload_dir ${docker_ld_preload}$docker_os ${docker_app_dir}${srvr_app}" >> $cmd2_file
 732         write_script_footer $cmd2_file $perf_server
 733         chmod +x $cmd2_file
 734     fi
 735
 736     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 737         title3="CLIENT$title_dbg (Docker-Preload Socket Test)"
 738         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 739         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 740         set_pre_cmd $emacs_client $gdb_client $docker_ld_preload_lib
 741         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 3"
 742         echo "$get_docker_server_ip4addr" >> $cmd3_file
 743         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 $vppcom_conf_dir:$docker_vppcom_conf_dir -e VPPCOM_CONF=${docker_vppcom_conf_dir}$vppcom_conf -e LD_LIBRARY_PATH=$docker_lib64_dir ${docker_ld_preload}$docker_os ${docker_app_dir}${clnt_app}" >> $cmd3_file
 744         write_script_footer $cmd3_file $perf_client
 745         chmod +x $cmd3_file
 746     fi
 747 }
 748
 749 docker_vcl() {
 750     verify_no_vpp
 751     verify_no_docker_containers
 752     banner="Running DOCKER-VCL socket test"
 753
 754     title1="VPP$title_dbg (Docker-VCL Socket Test)"
 755     tmp_gdb_cmdfile=$tmp_gdb_cmdfile_vpp
 756     gdb_cmdfile=$VPP_GDB_CMDFILE
 757     set_pre_cmd $emacs_vpp $gdb_vpp
 758     write_script_header $cmd1_file $tmp_gdb_cmdfile "$title1"
 759     if [ -n "$multi_host" ] ; then
 760         echo -n "sudo " >> $cmd1_file
 761     fi
 762     echo "${pre_cmd}$vpp_dir$vpp_app $vpp_args" >> $cmd1_file
 763     write_script_footer $cmd1_file $perf_vpp
 764     chmod +x $cmd1_file
 765
 766     if [ -z "$multi_host" ] || [ "$multi_host" = "server" ] ; then
 767         title2="SERVER$title_dbg (Docker-VCL Socket Test)"
 768         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_server
 769         gdb_cmdfile=$VPPCOM_SERVER_GDB_CMDFILE
 770         set_pre_cmd $emacs_server $gdb_server
 771         write_script_header $cmd2_file $tmp_gdb_cmdfile "$title2" "sleep 2"
 772         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 $vppcom_conf_dir:$docker_vppcom_conf_dir -p $sock_srvr_port:$sock_srvr_port -e VPPCOM_CONF=${docker_vppcom_conf_dir}/$vppcom_conf -e LD_LIBRARY_PATH=$docker_lib64_dir $docker_os ${docker_app_dir}${srvr_app}" >> $cmd2_file
 773         write_script_footer $cmd2_file $perf_server
 774         chmod +x $cmd2_file
 775     fi
 776
 777     if [ -z "$multi_host" ] || [ "$multi_host" = "client" ] ; then
 778         title3="CLIENT$title_dbg (Docker-VCL Socket Test)"
 779         tmp_gdb_cmdfile=$tmp_gdb_cmdfile_client
 780         gdb_cmdfile=$VPPCOM_CLIENT_GDB_CMDFILE
 781         set_pre_cmd $emacs_client $gdb_client
 782         write_script_header $cmd3_file $tmp_gdb_cmdfile "$title3" "sleep 3"
 783         echo "$get_docker_server_ip4addr" >> $cmd3_file
 784         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 $vppcom_conf_dir:$docker_vppcom_conf_dir -e VPPCOM_CONF=${docker_vppcom_conf_dir}/$vppcom_conf -e LD_LIBRARY_PATH=$docker_lib64_dir $docker_os ${docker_app_dir}${clnt_app}" >> $cmd3_file
 785         write_script_footer $cmd3_file $perf_client
 786         chmod +x $cmd3_file
 787     fi
 788 }
 789
 790 if [[ $run_test ]] ; then
 791     eval $run_test
 792 else
 793     echo "ERROR: Please specify a test to run!" >&2
 794     usage;
 795 fi
 796
 797 if (( $(which xfce4-terminal | wc -l) > 0 )) ; then
 798     xterm_cmd="xfce4-terminal --geometry $xterm_geom"
 799     if [[ $use_tabs ]] ; then
 800         declare -a tab_cmd_files
 801         declare -a tab_titles
 802         declare -i i=0
 803
 804         if [ -x "$cmd1_file" ] ; then
 805             tab_cmd_files[$i]="$cmd1_file"
 806             tab_titles[$i]="$title1"
 807             (( i++ ))
 808         fi
 809         if [ -x "$cmd2_file" ] ; then
 810             tab_cmd_files[$i]="$cmd2_file"
 811             tab_titles[$i]="$title2"
 812             (( i++ ))
 813         fi
 814         if [ -x "$cmd3_file" ] ; then
 815             tab_cmd_files[$i]="$cmd3_file"
 816             tab_titles[$i]="$title3"
 817         fi
 818
 819         if [ -n "${tab_cmd_files[2]}" ] ; then
 820             $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]}"
 821         elif [ -n "${tab_cmd_files[1]}" ] ; then
 822             $xterm_cmd --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}" --tab --title "${tab_titles[1]}" --command "${tab_cmd_files[1]}"
 823
 824         else
 825             $xterm_cmd --title "${tab_titles[0]}" --command "${tab_cmd_files[0]}"
 826         fi
 827
 828     else
 829         if [ -x "$cmd1_file" ] ; then
 830             ($xterm_cmd --title "$title1" --command "$cmd1_file" &)
 831         fi
 832         if [ -x "$cmd2_file" ] ; then
 833             ($xterm_cmd --title "$title2" --command "$cmd2_file" &)
 834         fi
 835         if [ -x "$cmd3_file" ] ; then
 836             ($xterm_cmd --title "$title3" --command "$cmd3_file" &)
 837         fi
 838     fi
 839
 840 else
 841     if [[ $use_tabs ]] ; then
 842         echo "Sorry, plain ol' xterm doesn't support tabs."
 843     fi
 844     xterm_cmd="xterm -fs 10 -geometry $xterm_geom"
 845     if [ -x "$cmd1_file" ] ; then
 846         ($xterm_cmd -title "$title1" -e "$cmd1_file" &)
 847     fi
 848     if [ -x "$cmd2_file" ] ; then
 849         ($xterm_cmd -title "$title2" -e "$cmd2_file" &)
 850     fi
 851     if [ -x "$cmd3_file" ] ; then
 852         ($xterm_cmd -title "$title3" -e "$cmd3_file" &)
 853     fi
 854 fi
 855
 856 sleep 1