tests: Preparation of enabling integration tests for AArch64

This commit adds supporting components and code for enabling the
AArch64 integration tests, including:

1. A Linux kernel config file to build kernel on AArch64 machines.

2. Refactoring the `run_integration_test.sh` to architecture
specific scripts for readability.

Signed-off-by: Henry Wang <Henry.Wang@arm.com>

scripts/dev_cli.sh

@@ -7,7 +7,7 @@
 CLI_NAME="Cloud Hypervisor"
 
 CTR_IMAGE_TAG="cloudhypervisor/dev"
-CTR_IMAGE_VERSION="v3"
+CTR_IMAGE_VERSION="v4"
 CTR_IMAGE="${CTR_IMAGE_TAG}:${CTR_IMAGE_VERSION}"
 
 DOCKER_RUNTIME="docker"
@@ -320,7 +320,7 @@ cmd_tests() {
 	       --env USER="root" \
 	       --env CH_LIBC="${libc}" \
 	       "$CTR_IMAGE" \
-	       ./scripts/run_integration_tests.sh "$@" || fix_dir_perms $? || exit $?
+	       ./scripts/run_integration_tests_$(uname -m).sh "$@" || fix_dir_perms $? || exit $?
     fi
 
     fix_dir_perms $?

scripts/run_integration_tests_aarch64.sh

@@ -0,0 +1,226 @@
+#!/bin/bash
+set -x
+
+source $HOME/.cargo/env
+
+export BUILD_TARGET=${BUILD_TARGET-aarch64-unknown-linux-gnu}
+
+WORKLOADS_DIR="$HOME/workloads"
+mkdir -p "$WORKLOADS_DIR"
+
+cp scripts/sha1sums-aarch64 $WORKLOADS_DIR
+
+BIONIC_OS_IMAGE_DOWNLOAD_NAME="bionic-server-cloudimg-arm64.img" \
+BIONIC_OS_IMAGE_DOWNLOAD_URL="https://cloudhypervisorstorage.blob.core.windows.net/images/$BIONIC_OS_IMAGE_DOWNLOAD_NAME"
+BIONIC_OS_DOWNLOAD_IMAGE="$WORKLOADS_DIR/$BIONIC_OS_IMAGE_DOWNLOAD_NAME"
+if [ ! -f "$BIONIC_OS_DOWNLOAD_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    time wget --quiet $BIONIC_OS_IMAGE_DOWNLOAD_URL || exit 1
+    popd
+fi
+
+BIONIC_OS_RAW_IMAGE_NAME="bionic-server-cloudimg-arm64.raw" \
+BIONIC_OS_RAW_IMAGE="$WORKLOADS_DIR/$BIONIC_OS_RAW_IMAGE_NAME"
+if [ ! -f "$BIONIC_OS_RAW_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    time qemu-img convert -p -f qcow2 -O raw $BIONIC_OS_IMAGE_DOWNLOAD_NAME $BIONIC_OS_RAW_IMAGE_NAME || exit 1
+    popd
+fi
+
+# Convert the raw image to qcow2 image to remove compressed blocks from the disk. Therefore letting the
+# qcow2 format image can be directly used in the integration test.
+BIONIC_OS_QCOW2_IMAGE_UNCOMPRESSED_NAME="bionic-server-cloudimg-arm64.qcow2" \
+BIONIC_OS_QCOW2_UNCOMPRESSED_IMAGE="$WORKLOADS_DIR/$BIONIC_OS_QCOW2_IMAGE_UNCOMPRESSED_NAME"
+if [ ! -f "$BIONIC_OS_QCOW2_UNCOMPRESSED_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    time qemu-img convert -p -f raw -O qcow2 $BIONIC_OS_RAW_IMAGE_NAME $BIONIC_OS_QCOW2_UNCOMPRESSED_IMAGE || exit 1
+    popd
+fi
+
+FOCAL_OS_IMAGE_DOWNLOAD_NAME="focal-server-cloudimg-arm64.img" \
+FOCAL_OS_IMAGE_DOWNLOAD_URL="https://cloudhypervisorstorage.blob.core.windows.net/images/$FOCAL_OS_IMAGE_DOWNLOAD_NAME"
+FOCAL_OS_DOWNLOAD_IMAGE="$WORKLOADS_DIR/$FOCAL_OS_IMAGE_DOWNLOAD_NAME"
+if [ ! -f "$FOCAL_OS_DOWNLOAD_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    time wget --quiet $FOCAL_OS_IMAGE_DOWNLOAD_URL || exit 1
+    popd
+fi
+
+FOCAL_OS_RAW_IMAGE_NAME="focal-server-cloudimg-arm64.raw" \
+FOCAL_OS_RAW_IMAGE="$WORKLOADS_DIR/$FOCAL_OS_RAW_IMAGE_NAME"
+if [ ! -f "$FOCAL_OS_RAW_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    time qemu-img convert -p -f qcow2 -O raw $FOCAL_OS_IMAGE_DOWNLOAD_NAME $FOCAL_OS_RAW_IMAGE_NAME || exit 1
+    popd
+fi
+
+# Convert the raw image to qcow2 image to remove compressed blocks from the disk. Therefore letting the
+# qcow2 format image can be directly used in the integration test.
+FOCAL_OS_QCOW2_IMAGE_UNCOMPRESSED_NAME="focal-server-cloudimg-arm64.qcow2" \
+FOCAL_OS_QCOW2_UNCOMPRESSED_IMAGE="$WORKLOADS_DIR/$FOCAL_OS_QCOW2_IMAGE_UNCOMPRESSED_NAME"
+if [ ! -f "$FOCAL_OS_QCOW2_UNCOMPRESSED_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    time qemu-img convert -p -f raw -O qcow2 $FOCAL_OS_RAW_IMAGE_NAME $FOCAL_OS_QCOW2_UNCOMPRESSED_IMAGE || exit 1
+    popd
+fi
+
+ALPINE_MINIROOTFS_URL="http://dl-cdn.alpinelinux.org/alpine/v3.11/releases/aarch64/alpine-minirootfs-3.11.3-aarch64.tar.gz"
+ALPINE_MINIROOTFS_TARBALL="$WORKLOADS_DIR/alpine-minirootfs-aarch64.tar.gz"
+if [ ! -f "$ALPINE_MINIROOTFS_TARBALL" ]; then
+    pushd $WORKLOADS_DIR
+    time wget --quiet $ALPINE_MINIROOTFS_URL -O $ALPINE_MINIROOTFS_TARBALL || exit 1
+    popd
+fi
+
+ALPINE_INITRAMFS_IMAGE="$WORKLOADS_DIR/alpine_initramfs.img"
+if [ ! -f "$ALPINE_INITRAMFS_IMAGE" ]; then
+    pushd $WORKLOADS_DIR
+    mkdir alpine-minirootfs
+    tar xf "$ALPINE_MINIROOTFS_TARBALL" -C alpine-minirootfs
+    cat > alpine-minirootfs/init <<-EOF
+		#! /bin/sh
+		mount -t devtmpfs dev /dev
+		echo \$TEST_STRING > /dev/console
+		poweroff -f
+	EOF
+    chmod +x alpine-minirootfs/init
+    cd alpine-minirootfs
+    find . -print0 |
+        cpio --null --create --verbose --owner root:root --format=newc > "$ALPINE_INITRAMFS_IMAGE"
+    popd
+fi
+
+pushd $WORKLOADS_DIR
+sha1sum sha1sums-aarch64 --check
+if [ $? -ne 0 ]; then
+    echo "sha1sum validation of images failed, remove invalid images to fix the issue."
+    exit 1
+fi
+popd
+
+# Build custom kernel based on virtio-pmem and virtio-fs upstream patches
+PE_IMAGE="$WORKLOADS_DIR/Image"
+
+LINUX_CUSTOM_DIR="$WORKLOADS_DIR/linux-custom"
+
+build_custom_linux_kernel() {
+    SRCDIR=$PWD
+    pushd $WORKLOADS_DIR
+    time git clone --depth 1 "https://github.com/cloud-hypervisor/linux.git" -b "virtio-fs-virtio-iommu-virtio-mem-5.6-rc4" $LINUX_CUSTOM_DIR
+    cp $SRCDIR/resources/linux-config-aarch64 $LINUX_CUSTOM_DIR/.config
+    popd
+
+    pushd $LINUX_CUSTOM_DIR
+    time make -j `nproc`
+    cp arch/arm64/boot/Image $WORKLOADS_DIR/Image || exit 1
+    popd
+}
+
+if [ ! -f "$PE_IMAGE" ]; then
+    build_custom_linux_kernel
+else
+    SRCDIR=$PWD
+    if [ "$PE_IMAGE" -ot "$SRCDIR/resources/linux-config-aarch64" ]; then
+        build_custom_linux_kernel
+    fi
+fi
+
+if [ -d "$LINUX_CUSTOM_DIR" ]; then
+    rm -rf $LINUX_CUSTOM_DIR
+fi
+
+VIRTIOFSD="$WORKLOADS_DIR/virtiofsd"
+QEMU_DIR="qemu_build"
+
+if [ ! -f "$VIRTIOFSD" ]; then
+    pushd $WORKLOADS_DIR
+    git clone --depth 1 "https://github.com/sboeuf/qemu.git" -b "virtio-fs" $QEMU_DIR
+    pushd $QEMU_DIR
+    time ./configure --prefix=$PWD --target-list=aarch64-softmmu
+    time make virtiofsd -j `nproc`
+    cp virtiofsd $VIRTIOFSD || exit 1
+    popd
+    rm -rf $QEMU_DIR
+    sudo setcap cap_dac_override,cap_sys_admin+epi "virtiofsd" || exit 1
+    popd
+fi
+
+BLK_IMAGE="$WORKLOADS_DIR/blk.img"
+MNT_DIR="mount_image"
+if [ ! -f "$BLK_IMAGE" ]; then
+   pushd $WORKLOADS_DIR
+   fallocate -l 16M $BLK_IMAGE
+   mkfs.ext4 -j $BLK_IMAGE
+   mkdir $MNT_DIR
+   sudo mount -t ext4 $BLK_IMAGE $MNT_DIR
+   sudo bash -c "echo bar > $MNT_DIR/foo" || exit 1
+   sudo umount $BLK_IMAGE
+   rm -r $MNT_DIR
+   popd
+fi
+
+SHARED_DIR="$WORKLOADS_DIR/shared_dir"
+if [ ! -d "$SHARED_DIR" ]; then
+    mkdir -p $SHARED_DIR
+    echo "foo" > "$SHARED_DIR/file1"
+    echo "bar" > "$SHARED_DIR/file3" || exit 1
+fi
+
+BUILD_TARGET="aarch64-unknown-linux-${CH_LIBC}"
+CFLAGS=""
+TARGET_CC=""
+if [[ "${BUILD_TARGET}" == "aarch64-unknown-linux-musl" ]]; then
+TARGET_CC="musl-gcc"
+CFLAGS="-I /usr/include/aarch64-linux-musl/ -idirafter /usr/include/"
+fi
+
+sed -i 's/"with-serde",\ //g' hypervisor/Cargo.toml
+
+cargo_args=("$@")
+cargo_args+=("--no-default-features")
+cargo_args+=("--features mmio")
+cargo build --release --target $BUILD_TARGET ${cargo_args[@]}
+strip target/$BUILD_TARGET/release/cloud-hypervisor
+strip target/$BUILD_TARGET/release/vhost_user_net
+strip target/$BUILD_TARGET/release/ch-remote
+
+# Copy for non-privileged net test
+cp target/$BUILD_TARGET/release/cloud-hypervisor target/$BUILD_TARGET/release/cloud-hypervisor-unprivileged
+
+sudo setcap cap_net_admin+ep target/$BUILD_TARGET/release/cloud-hypervisor
+sudo setcap cap_net_admin+ep target/$BUILD_TARGET/release/vhost_user_net
+
+# Enable KSM with some reasonable parameters so that it won't take too long
+# for the memory to be merged between two processes.
+sudo bash -c "echo 1000000 > /sys/kernel/mm/ksm/pages_to_scan"
+sudo bash -c "echo 10 > /sys/kernel/mm/ksm/sleep_millisecs"
+sudo bash -c "echo 1 > /sys/kernel/mm/ksm/run"
+
+sudo adduser $USER kvm
+newgrp kvm << EOF
+export RUST_BACKTRACE=1
+EOF
+RES=$?
+
+if [ $RES -eq 0 ]; then
+    # virtio-mmio based testing
+    cargo build --release --target $BUILD_TARGET --no-default-features --features "mmio"
+    strip target/$BUILD_TARGET/release/cloud-hypervisor
+    strip target/$BUILD_TARGET/release/vhost_user_net
+    strip target/$BUILD_TARGET/release/ch-remote
+
+    sudo setcap cap_net_admin+ep target/$BUILD_TARGET/release/cloud-hypervisor
+
+    # Ensure test binary has the same caps as the cloud-hypervisor one
+    time cargo test --no-run --no-default-features --features "integration_tests,mmio" -- --nocapture || exit 1
+    ls target/debug/deps/cloud_hypervisor-* | xargs -n 1 sudo setcap cap_net_admin+ep
+
+    newgrp kvm << EOF
+export RUST_BACKTRACE=1
+time cargo test --no-default-features --features "integration_tests,mmio" "tests::parallel::test_aarch64_pe_boot" -- --nocapture
+EOF
+
+    RES=$?
+fi
+
+exit $RES

scripts/run_integration_tests_x86_64.sh

@@ -8,7 +8,7 @@ export BUILD_TARGET=${BUILD_TARGET-x86_64-unknown-linux-gnu}
 WORKLOADS_DIR="$HOME/workloads"
 mkdir -p "$WORKLOADS_DIR"
 
-cp scripts/sha1sums $WORKLOADS_DIR
+cp scripts/sha1sums-x86_64 $WORKLOADS_DIR
 
 FW_URL=$(curl --silent https://api.github.com/repos/cloud-hypervisor/rust-hypervisor-firmware/releases/latest | grep "browser_download_url" | grep -o 'https://.*[^ "]')
 FW="$WORKLOADS_DIR/hypervisor-fw"
@@ -80,7 +80,7 @@ if [ ! -f "$ALPINE_INITRAMFS_IMAGE" ]; then
 fi
 
 pushd $WORKLOADS_DIR
-sha1sum sha1sums --check
+sha1sum sha1sums-x86_64 --check
 if [ $? -ne 0 ]; then
     echo "sha1sum validation of images failed, remove invalid images to fix the issue."
     exit 1
@@ -98,7 +98,7 @@ if [ ! -f "$VMLINUX_IMAGE" ] || [ ! -f "$VMLINUX_PVH_IMAGE" ]; then
     SRCDIR=$PWD
     pushd $WORKLOADS_DIR
     time git clone --depth 1 "https://github.com/cloud-hypervisor/linux.git" -b "virtio-fs-virtio-iommu-virtio-mem-5.6-rc4" $LINUX_CUSTOM_DIR
-    cp $SRCDIR/resources/linux-config $LINUX_CUSTOM_DIR/.config
+    cp $SRCDIR/resources/linux-config-x86_64 $LINUX_CUSTOM_DIR/.config
     popd
 fi
 

scripts/sha1sums-aarch64

@@ -0,0 +1,7 @@
+6fee67adbfed8db7a225be23ee9d90b5bd7f19e6  bionic-server-cloudimg-arm64.img
+786fe1c33588334e92b35c65e414da068df180bc  bionic-server-cloudimg-arm64.raw
+34039f2fc4242acff0d42af82fbee91070978da3  bionic-server-cloudimg-arm64.qcow2
+e4addb6e212a298144f9eb0eb6e36019d013f0e7  alpine-minirootfs-aarch64.tar.gz
+b94d74e4af195ee3fbd1e2b8fce46e034b6120e6  focal-server-cloudimg-arm64.img
+b48be83f4d507563cef24f22c70655d287ce3ef9  focal-server-cloudimg-arm64.raw
+af0bba59337bb28079ce40f15c534f1efed6f99b  focal-server-cloudimg-arm64.qcow2