run_hck_client.sh

#!/bin/bash

# Copyright (c) 2013, Daynix Computing LTD (www.daynix.com)
# All rights reserved.
#
# Maintained by oss@daynix.com
#
# This file is a part of VirtHCK, please see the wiki page
# on https://github.com/daynix/VirtHCK/wiki for more.
#
# This code is licensed under standard 3-clause BSD license.
# See file LICENSE supplied with this package for the full license text.

CLIENT_NUM=$2

echo "Starting HCK client #${CLIENT_NUM}"

# Run the config file passed here
. $1

client_ctrl_ifname()
{
  echo cc${CLIENT_NUM}_${UNIQUE_ID}
}

client_test_ifname()
{
  DEVICE_NUM=$1

  echo t${DEVICE_NUM}c${CLIENT_NUM}_${UNIQUE_ID}
}

client_ctrl_mac()
{
  echo 56:${UID_FIRST}:${UID_SECOND}:0${CLIENT_NUM}:cc:cc
}

client_transfer_mac()
{
  echo 56:${UID_FIRST}:${UID_SECOND}:0${CLIENT_NUM}:aa:aa
}

client_test_mac()
{
  DEVICE_NUM=$1

  echo 56:${UID_FIRST}:${UID_SECOND}:0${CLIENT_NUM}:0${DEVICE_NUM}:c${CLIENT_NUM}
}

client_cpus()
{
  VAR_NAME=CLIENT${CLIENT_NUM}_CPUS
  eval echo \$${VAR_NAME}
}

client_memory()
{
  VAR_NAME=CLIENT${CLIENT_NUM}_MEMORY
  eval echo \$${VAR_NAME}
}
graphics_cmd()
{
  VAR_NAME=GRAPHICS_CLIENT${CLIENT_NUM}
  eval echo \$${VAR_NAME}
}

monitor_cmd()
{
  VAR_NAME=MONITOR_CLIENT${CLIENT_NUM}
  eval echo \$${VAR_NAME}
}

usb_cmd()
{
    eval IMAGE_PATH=\$CLIENT${CLIENT_NUM}_USB_DEV
    if [ ! -z ${IMAGE_PATH} ]
    then
        echo "-device piix3-usb-uhci -drive file=${IMAGE_PATH},if=none,id=usb${CLIENT_NUM} -device usb-storage,drive=usb${CLIENT_NUM}"
    fi
}

virtionet_speed()
{
    if [ ! -z "${VIRTIONET_SPEED}" ]
    then
        echo ",speed=${VIRTIONET_SPEED}"
    fi
}

extra_params_cmd()
{
    if [ ! -z "${TEST_DEV_EXTRA_PARAMS}" ]
    then
        echo -n ",${TEST_DEV_EXTRA_PARAMS}"
    fi
    if [ "$vIOMMU" = "on" ]
    then
        echo ",iommu_platform=on,ats=on"
    fi
}

cdrom_cmd()
{
    eval VAR_NAME=\$CDROM_CLIENT${CLIENT_NUM}
    if [ ! -z "${VAR_NAME}" ]
    then
        echo "-cdrom ${VAR_NAME}"
    fi
}

bios_cmd()
{
    eval VAR_NAME=\$BIOS_CLIENT${CLIENT_NUM}
    if [ ! -z "${VAR_NAME}" ]
    then
        echo "-bios ${VAR_NAME}"
    fi
}

extra_cmd()
{
  VAR_NAME=CLIENT${CLIENT_NUM}_EXTRA
  eval echo \$${VAR_NAME}
}

netdev_queues_num()
{
  VAR_NAME=CLIENT${CLIENT_NUM}_NETDEV_QUEUES
  eval echo \$${VAR_NAME}
}

client_mq_device_param()
{
  VAR_NAME=CLIENT${CLIENT_NUM}_MQ_DEVICE_PARAM
  eval echo \$${VAR_NAME}
}

image_name()
{
  VAR_NAME=CLIENT${CLIENT_NUM}_IMAGE
  eval echo \$${VAR_NAME}
}

trace_file_name()
{
    VAR_NAME=CLIENT${CLIENT_NUM}_TRACE_EVENTS
    eval echo \$${VAR_NAME}
}

trace_cmd()
{
    FILE_NAME=`trace_file_name`

    if [ ! -z  "${FILE_NAME}" ]
    then
        echo "-trace events=${FILE_NAME}"
    fi
}

log_option()
{
    VAR_NAME=CLIENT${CLIENT_NUM}_LOG
    eval echo \$${VAR_NAME}
}

log_file_name()
{
    if [ z`log_option` = zon ]
    then
        mkdir -p $LOGS_DIR/client${CLIENT_NUM} > /dev/null 2>&1
        FILE_NAME=$LOGS_DIR/client${CLIENT_NUM}/`timestamp`-client${CLIENT_NUM}.log
        echo `readlink -f $FILE_NAME`
    fi
}

log_cmd()
{
    FILE_NAME=`log_file_name`

    if [ ! -z  "${FILE_NAME}" ]
    then
        echo Logging output to ${FILE_NAME} 1>&2
        echo "tee ${FILE_NAME}"
    else
        echo "cat"
    fi
}

pid_file()
{
    if [ ! -z "${PID_FILE}" ]
    then
        echo "-pidfile ${PID_FILE}"
    fi
}

#Machine type related difference
case $MACHINE_TYPE in
    q35 )
        CTRL_BUS_NAME=pcie
        BUS_NAME=root1
        DISABLE_S3_PARAM=ICH9-LPC.disable_s3
        DISABLE_S4_PARAM=ICH9-LPC.disable_s4
        #Windows 2012R2 crashes during boot on Q35 machine with UUID set
        MACHINE_UUID=""
        PCIE_ROOT_PORT="-device pcie-root-port,slot=3,chassis=1,addr=0x4,bus=pcie.0,id=root1.0"
        ;;
    * )
        BUS_NAME=pci
        CTRL_BUS_NAME=pci
        DISABLE_S3_PARAM=PIIX4_PM.disable_s3
        DISABLE_S4_PARAM=PIIX4_PM.disable_s4
        if [ "$DISABLE_UUIDS" != "true" ]; then
            MACHINE_UUID="-uuid CDEF127c-8795-4e67-95da-8dd0a88${UNIQUE_ID}${CLIENT_NUM}"
        fi
        ;;
esac

test_image_name()
{
  local IMAGE_NUM=$1

  echo $(dirname `image_name`)/client${CLIENT_NUM}_test_image${IMAGE_NUM}.qcow2
}

run_virtiofs_deamon()
{
  FS_DEAMON_SOCKET=/tmp/vhostqemu_${UNIQUE_ID}
  mkdir -p ${VIOFSD_SHARE}
  echo Running virtiofsdeamon...
  sudo rm -f /tmp/vhostqemu_${UNIQUE_ID}${CLIENT_NUM}
  ${FS_DEAMON_BIN} --socket-path=${FS_DEAMON_SOCKET}${CLIENT_NUM} -o source=${VIOFSD_SHARE} -o cache=always --daemonize
}

prepare_test_image()
{
  local IMAGE_NUM=$1
  local TEST_IMAGE_SIZE=30G
  local TEST_IMAGE_NAME=`test_image_name ${IMAGE_NUM}`

  if [ ! -f "${TEST_IMAGE_NAME}" ]
  then
    if [ -n "${FILESYSTEM_TESTS_IMAGE}" ] && [ -f "${FILESYSTEM_TESTS_IMAGE}" ]
    then
      echo Copying base test image of ${FILESYSTEM_TESTS_IMAGE} to ${TEST_IMAGE_NAME}...
      cp ${FILESYSTEM_TESTS_IMAGE} ${TEST_IMAGE_NAME}
    else
      echo Creating test image of ${TEST_IMAGE_SIZE} ${TEST_IMAGE_NAME}...
      ${QEMU_IMG_BIN} create -f qcow2 ${TEST_IMAGE_NAME} ${TEST_IMAGE_SIZE}
    fi
  fi
}

if [ x"${CLIENT_WORLD_ACCESS}" = xon ]; then
    WORLD_NET_IFACE="-netdev tap,id=hostnet9,script=${HCK_ROOT}/hck_world_bridge_ifup_${UNIQUE_ID}.sh,downscript=no,ifname=tmp_${UNIQUE_ID}_${CLIENT_NUM}
                     -device ${WORLD_NET_DEVICE},netdev=hostnet9,mac=22:11:11:0${CLIENT_NUM}:${UID_FIRST}:${UID_SECOND},id=tmp_${UNIQUE_ID}_${CLIENT_NUM}"
fi

IDE_STORAGE_PAIR="-drive file=`image_name`$(set_qcow2_l2_cache `image_name`),if=none,id=ide_${UNIQUE_ID}_${CLIENT_NUM}${DRIVE_CACHE_OPTION}
                  -device ide-hd,drive=ide_${UNIQUE_ID}_${CLIENT_NUM},serial=${CLIENT_NUM}1${UNIQUE_ID}"

if [ "$IS_PHYSICAL" = "false" ]; then    # in case of a virtual device

    case $TEST_DEV_TYPE in
    network)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"

       TEST_NET_MAC_ADDRESS=`client_test_mac 1`
       TEST_DEVICE_ID=""
       case ${TEST_NETWORK_INTERFACE} in
       tap)
          TAP_DEVICE="-netdev tap,id=hostnet2,vhost=${VHOST_STATE},script=${HCK_ROOT}/hck_test_bridge_ifup_${UNIQUE_ID}.sh,downscript=no,ifname=`client_test_ifname 1`,queues=$(netdev_queues_num)"
          TEST_DEVICE_ID=",id=`client_test_ifname 1`"
          ;;
       macvtap)
          UNIQ_DESCR=$(( ${CLIENT_NUM} + ${UNIQUE_ID} ))
          TAP_ID=`enslave_test_iface_macvtap ${TEST_BR_NAME} ${UNIQ_DESCR} ${TEST_NET_MAC_ADDRESS}`
          eval "exec ${UNIQ_DESCR}<>${TAP_ID}"
          # Attention:  ifname=, script=, downscript=, vnet_hdr=, helper=, queues=, fds=, and vhostfds= are invalid with fd=
          TAP_DEVICE="-netdev tap,id=hostnet2,vhost=${VHOST_STATE},fd=${UNIQ_DESCR}"
          ;;
       * )
          echo NETWORK INTERFACE IS NOT IMPLEMENTED
          exit 1
          ;;
       esac
       TEST_NET_DEVICES="${TAP_DEVICE}
                         -device ${TEST_DEV_NAME}`extra_params_cmd``virtionet_speed`,netdev=hostnet2,mac=${TEST_NET_MAC_ADDRESS},bus=${BUS_NAME}.0$(client_mq_device_param)${TEST_DEVICE_ID}"
       ;;
    bootstorage)
       BOOT_STORAGE_PAIR="-drive file=`image_name`$(set_qcow2_l2_cache `image_name`),if=none,id=vio_block${DRIVE_CACHE_OPTION}
                          -device ${TEST_DEV_NAME}`extra_params_cmd`,bus=${BUS_NAME}.0,drive=vio_block,serial=${CLIENT_NUM}1${UNIQUE_ID}"
       ;;
    storage-blk)
       prepare_test_image 1
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_STORAGE_PAIR="-drive file=`test_image_name 1`$(set_qcow2_l2_cache `test_image_name 1`),if=none,format=qcow2,id=virtio_blk${DRIVE_CACHE_OPTION}
                          -device ${TEST_DEV_NAME}`extra_params_cmd`,bus=${BUS_NAME}.0,drive=virtio_blk,serial=${CLIENT_NUM}0${UNIQUE_ID}"
       ;;
    storage-scsi)
       prepare_test_image 1
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_STORAGE_PAIR="-drive file=`test_image_name 1`$(set_qcow2_l2_cache `test_image_name 1`),if=none,format=qcow2,id=virtio_scsi${DRIVE_CACHE_OPTION}
                          -device ${TEST_DEV_NAME}`extra_params_cmd`,id=scsi,bus=${BUS_NAME}.0
                          -device scsi-hd,drive=virtio_scsi,serial=${CLIENT_NUM}0${UNIQUE_ID}"
       ;;
    fs-filter)
       prepare_test_image 1
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_STORAGE_PAIR="-drive file=`test_image_name 1`$(set_qcow2_l2_cache `test_image_name 1`),if=none,format=qcow2,id=fs_filter${DRIVE_CACHE_OPTION}
                          -device ide-hd,drive=fs_filter,serial=${CLIENT_NUM}0${UNIQUE_ID}"
       ;;
    serial)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_SERIAL_DEVICES="-device ${TEST_DEV_NAME}`extra_params_cmd`,bus=${BUS_NAME}.0,id=virtio_serial_pci0"
       ;;
    balloon)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_BALLOON_DEVICE="-device ${TEST_DEV_NAME}`extra_params_cmd`,bus=${BUS_NAME}.0"
       ;;
    pvpanic)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_BALLOON_DEVICE="-device ${TEST_DEV_NAME}`extra_params_cmd`"
       ;;
    vioinput)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_BALLOON_DEVICE="-device ${TEST_DEV_NAME}`extra_params_cmd`,bus=${BUS_NAME}.0"
       ;;
    rng)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_RNG_DEVICE="-device ${TEST_DEV_NAME}`extra_params_cmd`,bus=${BUS_NAME}.0"
       ;;
    vsock)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_VSOCK_DEVICE="-device ${TEST_DEV_NAME}`extra_params_cmd`,id=vhost-vsock-pci0,guest-cid=${CLIENT_NUM}0${UNIQUE_ID},bus=${BUS_NAME}.0"
       ;;
    usb|usb3)
       if [ "$TEST_DEV_TYPE" = "usb" ]; then
	       usbkind=usb-ehci
       else
	       usbkind=nec-usb-xhci
       fi
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_STORAGE_PAIR="
        -device ${usbkind},id=vhck_ehci
        -drive if=none,id=usbdisk1,file=`test_image_name 1`,format=qcow2
        -device ${TEST_DEV_NAME}`extra_params_cmd`,bus=vhck_ehci.0,drive=usbdisk1,id=vhck_usbdisk1,serial=${CLIENT_NUM}1${UNIQUE_ID}
        -drive if=none,id=usbdisk2,file=`test_image_name 2`,format=qcow2
        -device ${TEST_DEV_NAME}`extra_params_cmd`,bus=vhck_ehci.0,drive=usbdisk2,id=vhck_usbdisk2",serial=${CLIENT_NUM}2${UNIQUE_ID}

        prepare_test_image 1
        prepare_test_image 2
        ;;
    ivshmem)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_IVSHMEM_DEVICE="-chardev socket,path=${IVSHMEM_SOCKET},id=ivshmemid -device ${TEST_DEV_NAME}`extra_params_cmd`,chardev=ivshmemid"
       ;;
    viofs)
       run_virtiofs_deamon
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_VIRTFS_DEVICE="
         -chardev socket,id=virtiofsid,path=${FS_DEAMON_SOCKET}${CLIENT_NUM}
         -object memory-backend-file,id=mem,size=`client_memory`,mem-path=/dev/shm,share=on -numa node,memdev=mem
         -device ${TEST_DEV_NAME}`extra_params_cmd`,queue-size=1024,chardev=virtiofsid,tag=myfs,bus=${BUS_NAME}.0"
       ;;
    video)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
        ;;
    viocrypt)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_VIOCRYPT_DEVICE="-object cryptodev-backend-builtin,id=cryptodev0 -device ${TEST_DEV_NAME},id=crypto0,cryptodev=cryptodev0"
       ;;
    viogpu)
       BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
       TEST_VIOGPU_DEVICE="-device ${TEST_DEV_NAME}`extra_params_cmd`,edid=off,bus=${BUS_NAME}.0"
       ;;

      * )
       echo "NOT IMPLEMENTED"
       exit 1
        ;;
    esac

else    # in case of physical device
    case $TEST_DEV_TYPE in
        network)
            BOOT_STORAGE_PAIR="${IDE_STORAGE_PAIR}"
           if [ $CLIENT_NUM -eq 1 ]; then
               TEST_NET_DEVICES="-device ${ASSIGNMENT},host=${CLIENT1_HOST_ADDRESS},$(client_mq_device_param)"
           fi
           if [ $CLIENT_NUM -eq 2 ]; then
               TEST_NET_DEVICES="-device ${ASSIGNMENT},host=${CLIENT2_HOST_ADDRESS},$(client_mq_device_param)"
           fi
        ;;

        * )
            echo "NOT IMPLEMENTED. Please note that physical device assignment is enabled."
            exit 1
        ;;
    esac
fi

if [ ${SHARE_ON_HOST} != "false" ] && [ -e "${SHARE_ON_HOST}/USE_SHARE" ]; then
  FILE_TRANSFER_SETUP="-netdev user,id=filenet0,net=${SHARE_ON_HOST_NET}.0/24,dhcpstart=${SHARE_ON_HOST_NET}.${CLIENT_NUM}00,smb=${SHARE_ON_HOST},smbserver=${SHARE_ON_HOST_NET}.1,restrict=on \
                       -device ${FILE_TRANSFER_DEVICE},netdev=filenet0,mac=`client_transfer_mac`"
fi

CTRL_NET_DEVICE="-netdev tap,id=hostnet0,script=${HCK_ROOT}/hck_ctrl_bridge_ifup_${UNIQUE_ID}.sh,downscript=no,ifname=`client_ctrl_ifname`
                 -device ${CTRL_NET_DEVICE},netdev=hostnet0,mac=`client_ctrl_mac`,addr=03,bus=${CTRL_BUS_NAME}.0,id=`client_ctrl_ifname`"

${QEMU_BIN} \
        ${QEMU_RUN_AS} \
        ${CTRL_NET_DEVICE} \
        ${PCIE_ROOT_PORT} \
        ${BOOT_STORAGE_PAIR} \
        ${TEST_STORAGE_PAIR} \
        ${TEST_NET_DEVICES} \
        ${FILE_TRANSFER_SETUP} \
        ${TEST_VIOGPU_DEVICE} \
        ${TEST_SERIAL_DEVICES} \
        ${TEST_BALLOON_DEVICE} \
        ${TEST_IVSHMEM_DEVICE} \
        ${TEST_VIRTFS_DEVICE} \
        ${TEST_RNG_DEVICE} \
        ${TEST_VSOCK_DEVICE} \
        ${TEST_VIOCRYPT_DEVICE} \
        ${WORLD_NET_IFACE} \
        ${IOMMU_DEVICE} \
        ${MACHINE_UUID} \
        -machine ${MACHINE_TYPE}${MACHINE_TYPE_EXTRAS} \
        -nodefaults -no-user-config \
        -m `client_memory` -smp `client_cpus`,cores=`client_cpus` -enable-kvm \
        -cpu qemu64,+x2apic,+fsgsbase${OPT_CPU_FLAGS},model=${VCPU_MODEL}${ENLIGHTENMENTS_OPTION} \
        -usb -device usb-tablet -boot ${BOOT_ORDER} \
        -global kvm-pit.lost_tick_policy=discard -rtc base=localtime,clock=host,driftfix=slew \
        -global ${DISABLE_S3_PARAM}=${S3_DISABLE_OPTION} -global ${DISABLE_S4_PARAM}=${S4_DISABLE_OPTION} \
        -name HCK-Client${CLIENT_NUM}_${UNIQUE_ID}_`hostname`_${TITLE_POSTFIX} \
        `cdrom_cmd` `bios_cmd` `pid_file` \
        `graphics_cmd` `monitor_cmd` ${SNAPSHOT_OPTION} `usb_cmd` `extra_cmd` \
        `trace_cmd` \
         2>&1 | `log_cmd`

if [ ${TEST_NETWORK_INTERFACE} = "macvtap" ]; then
  eval "exec ${UNIQ_DESCR}<>\&-"
  `delete_macvtap ${UNIQ_DESCR}`
fi