From a5b3a1d6dd39e86e07790d1febcebe1d25248094 Mon Sep 17 00:00:00 2001
From: Zhang Junyang <junyang@stu.pku.edu.cn>
Date: Mon, 4 Nov 2024 12:03:18 +0800
Subject: [PATCH] Unify the qemu arguments generation

---
 Makefile           |  5 +++--
 OSDK.toml          |  2 +-
 tools/qemu_args.sh | 37 ++++++++++++++++++++++++++-----------
 3 files changed, 30 insertions(+), 14 deletions(-)

diff --git a/Makefile b/Makefile
index 577913a69..c15aa79f1 100644
--- a/Makefile
+++ b/Makefile
@@ -11,6 +11,7 @@ BUILD_SYSCALL_TEST ?= 0
 ENABLE_KVM ?= 1
 INTEL_TDX ?= 0
 MEM ?= 8G
+OVMF ?= on
 RELEASE ?= 0
 RELEASE_LTO ?= 0
 LOG_LEVEL ?= error
@@ -59,7 +60,7 @@ CARGO_OSDK_ARGS += --init-args="/test/run_general_test.sh"
 else ifeq ($(AUTO_TEST), boot)
 CARGO_OSDK_ARGS += --init-args="/test/boot_hello.sh"
 else ifeq ($(AUTO_TEST), vsock)
-export VSOCK=1
+export VSOCK=on
 CARGO_OSDK_ARGS += --init-args="/test/run_vsock_test.sh"
 endif
 
@@ -234,7 +235,7 @@ ktest: initramfs $(CARGO_OSDK)
 	@# Exclude linux-bzimage-setup from ktest since it's hard to be unit tested
 	@for dir in $(OSDK_CRATES); do \
 		[ $$dir = "ostd/libs/linux-bzimage/setup" ] && continue; \
-		(cd $$dir && cargo osdk test) || exit 1; \
+		(cd $$dir && OVMF=off cargo osdk test) || exit 1; \
 		tail --lines 10 qemu.log | grep -q "^\\[ktest runner\\] All crates tested." \
 			|| (echo "Test failed" && exit 1); \
 	done
diff --git a/OSDK.toml b/OSDK.toml
index b9ea2878a..26783a1f4 100644
--- a/OSDK.toml
+++ b/OSDK.toml
@@ -9,7 +9,7 @@ method = "grub-rescue-iso"
 protocol = "multiboot2"
 
 [qemu]
-args = "$(./tools/qemu_args.sh normal -ovmf)"
+args = "$(./tools/qemu_args.sh normal)"
 
 # Special options for running
 [run.boot]
diff --git a/tools/qemu_args.sh b/tools/qemu_args.sh
index ea5cecd2f..3edc3471d 100755
--- a/tools/qemu_args.sh
+++ b/tools/qemu_args.sh
@@ -3,9 +3,20 @@
 # SPDX-License-Identifier: MPL-2.0
 
 # This script is used to generate QEMU arguments for OSDK.
-# The positional argument $1 is the scheme.
-# A switch "-ovmf" can be passed as an argument to enable OVMF.
-# The enrivonmental variable VSOCK can be passed as 1 to trigger vsock module.
+# Usage: `qemu_args.sh [scheme]`
+#  - scheme: "normal", "microvm" or "iommu";
+# Other arguments are configured via environmental variables:
+#  - OVMF: "on" or "off";
+#  - NETDEV: "user" or "tap";
+#  - VHOST: "off" or "on";
+#  - VSOCK: "off" or "on";
+#  - SMP: number of CPUs;
+#  - MEM: amount of memory, e.g. "8G".
+
+OVMF=${OVMF:-"on"}
+VHOST=${VHOST:-"off"}
+VSOCK=${VSOCK:-"off"}
+NETDEV=${NETDEV:-"user"}
 
 SSH_RAND_PORT=${SSH_PORT:-$(shuf -i 1024-65535 -n 1)}
 NGINX_RAND_PORT=${NGINX_PORT:-$(shuf -i 1024-65535 -n 1)}
@@ -17,7 +28,7 @@ LMBENCH_TCP_LAT_RAND_PORT=${LMBENCH_TCP_LAT_PORT:-$(shuf -i 1024-65535 -n 1)}
 # QEMU_OPT_ARG_DUMP_PACKETS="-object filter-dump,id=filter0,netdev=net01,file=virtio-net.pcap"
 
 if [[ "$NETDEV" =~ "user" ]]; then
-    echo "[\$1] Forwarded QEMU guest port: $SSH_RAND_PORT->22; $NGINX_RAND_PORT->8080 $REDIS_RAND_PORT->6379 $IPERF_RAND_PORT->5201 $LMBENCH_TCP_LAT_RAND_PORT->31234" 1>&2
+    echo "[$1] Forwarded QEMU guest port: $SSH_RAND_PORT->22; $NGINX_RAND_PORT->8080 $REDIS_RAND_PORT->6379 $IPERF_RAND_PORT->5201 $LMBENCH_TCP_LAT_RAND_PORT->31234" 1>&2
     NETDEV_ARGS="-netdev user,id=net01,hostfwd=tcp::$SSH_RAND_PORT-:22,hostfwd=tcp::$NGINX_RAND_PORT-:8080,hostfwd=tcp::$REDIS_RAND_PORT-:6379,hostfwd=tcp::$IPERF_RAND_PORT-:5201,hostfwd=tcp::$LMBENCH_TCP_LAT_RAND_PORT-:31234"
 elif [[ "$NETDEV" =~ "tap" ]]; then 
     THIS_SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
@@ -79,7 +90,7 @@ MICROVM_QEMU_ARGS="\
     -device virtconsole,chardev=mux \
 "
 
-if [ "$VSOCK" = "1" ]; then
+if [ "$VSOCK" = "on" ]; then
     # RAND_CID=$(shuf -i 3-65535 -n 1)
     RAND_CID=3
     echo "[$1] Launched QEMU VM with CID $RAND_CID" 1>&2
@@ -103,12 +114,16 @@ if [ "$1" = "microvm" ]; then
     exit 0
 fi
 
-if [ "$1" = "-ovmf" ] || [ "$2" = "-ovmf" ]; then
-    OVMF_PATH="/usr/share/OVMF"
-    QEMU_ARGS="${QEMU_ARGS}\
-        -drive if=pflash,format=raw,unit=0,readonly=on,file=$OVMF_PATH/OVMF_CODE.fd \
-        -drive if=pflash,format=raw,unit=1,file=$OVMF_PATH/OVMF_VARS.fd \
-    "
+if [ "$OVMF" = "on" ]; then
+    if [ "$1" = "test" ]; then
+        echo "We use QEMU direct boot for testing, which does not support OVMF, ignoring OVMF" 1>&2
+    else
+        OVMF_PATH="/usr/share/OVMF"
+        QEMU_ARGS="${QEMU_ARGS} \
+            -drive if=pflash,format=raw,unit=0,readonly=on,file=$OVMF_PATH/OVMF_CODE.fd \
+            -drive if=pflash,format=raw,unit=1,file=$OVMF_PATH/OVMF_VARS.fd \
+        "
+    fi
 fi
 
 echo $QEMU_ARGS