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