resources: Update disk image source to add hypercall and gem5bridge-driver (#69)

This PR updates the disk image build source for the X86 and Arm base Ubuntu and NPB disk images. The built disk images will now use hypercalls instead of classic exits, and will now also use the gem5 bridge driver, which allows for `gem5-bridge` commands to be run without the use of `sudo`. Both hypercalls and the gem5 bridge driver were introduced in gem5 v25.0.

The build process for the base Ubuntu disk images supports Ubuntu 24.04 and 22.04, and the build process for the NPB disk images supports Ubuntu 24.04 only.

Author: Harshil2107

src/npb-24.04-imgs/arm-npb.pkr.hcl

@@ -35,8 +35,8 @@ source "qemu" "initialize" {
   format           = "raw"
   headless         = "true"
   disk_image       = "true"
-  iso_checksum     = "sha256:eb94422a3908c6c5183c03666b278b6e8bcfbde04da3d7c3bb5374bc82e0ef48"
-  iso_urls         = ["./arm-ubuntu-24.04-20240823"]
+  iso_checksum     = "sha256:71698e2b3e424402b49f92f667a73eb372ed24cf0e1751099ee1c6c4f1944483"
+  iso_urls         = ["./arm-ubuntu-24.04-20250515"]
   memory           = "8192"
   output_directory = "disk-image-arm-npb"
   qemu_binary      = "/usr/bin/qemu-system-aarch64"

src/npb-24.04-imgs/build-arm.sh

@@ -14,10 +14,11 @@ dd if=/usr/share/qemu-efi-aarch64/QEMU_EFI.fd of=flash0.img conv=notrunc
 cd ..
 
 # get the  base image from gem5 resource
-if [! -f ./arm-ubuntu-24.04-20240823 ]; then
-    wget https://storage.googleapis.com/dist.gem5.org/dist/develop/images/arm/ubuntu-24-04/arm-ubuntu-24.04-20240823.gz
-    gunzip arm-ubuntu-24.04-20240823.gz 
+if [! -f ./arm-ubuntu-24.04-20250515 ]; then
+  wget https://gem5resources.blob.core.windows.net/dist-gem5-org/dist/develop/images/arm/ubuntu-24-04/arm-ubuntu-24.04-20250515.gz
+  gunzip arm-ubuntu-24.04-20250515.gz
 fi
+
 # Install the needed plugins
 ./packer init arm-npb.pkr.hcl
 

src/npb-24.04-imgs/build-x86.sh

@@ -11,10 +11,11 @@ if [ ! -f ./packer ]; then
     rm packer_${PACKER_VERSION}_linux_amd64.zip;
 fi
 
-if [! -f ./x86-ubuntu-24-04-v2 ]; then
-    wget https://storage.googleapis.com/dist.gem5.org/dist/develop/images/x86/ubuntu-24-04/x86-ubuntu-24-04-v2.gz
-    gunzip x86-ubuntu-24-04-v2.gz
+if [! -f ./x86-ubuntu-24.04-20250515 ]; then
+  wget https://gem5resources.blob.core.windows.net/dist-gem5-org/dist/develop/images/x86/ubuntu-24-04/x86-ubuntu-24.04-20250515.gz
+  gunzip x86-ubuntu-24.04-20250515.gz
 fi
+
 # Install the needed plugins
 ./packer init x86-npb.pkr.hcl
 

src/npb-24.04-imgs/npb-with-roi/NPB/NPB3.4-OMP/common/hooks.c

@@ -51,11 +51,11 @@ void m5_work_begin_interface_()
 {
 
     printf(" -------------------- ROI BEGIN -------------------- \n");
-    m5_work_begin_addr(0,0);
+    m5_hypercall_addr(4);
 }
 
 void m5_work_end_interface_()
 {
-    m5_work_end_addr(0,0);
+    m5_hypercall_addr(5);
     printf(" -------------------- ROI END -------------------- \n");
 }

src/npb-24.04-imgs/scripts/post-installation.sh

@@ -16,9 +16,14 @@ make clean
 make suite M5_ANNOTATION=1
 echo "Disabling network by default"
 echo "See README.md for instructions on how to enable network"
-mv /etc/netplan/50-cloud-init.yaml /etc/netplan/50-cloud-init.yaml.bak
+
+if [ -f /etc/netplan/50-cloud-init.yaml ]; then
+    mv /etc/netplan/50-cloud-init.yaml /etc/netplan/50-cloud-init.yaml.bak
+elif [ -f /etc/netplan/00-installer-config.yaml ]; then
+    mv /etc/netplan/00-installer-config.yaml /etc/netplan/00-installer-config.yaml.bak
+    netplan apply
+fi
+
 # Disable systemd service that waits for network to be online
 systemctl disable systemd-networkd-wait-online.service
 systemctl mask systemd-networkd-wait-online.service
-
-netplan apply

src/npb-24.04-imgs/x86-npb.pkr.hcl

@@ -36,8 +36,8 @@ source "qemu" "initialize" {
   format           = "raw"
   headless         = "true"
   disk_image       = "true"
-  iso_checksum     = "sha256:6cedf26ebf281b823b24722341d3a2ab1f1ba26b10b536916d3f23cf92a8f4b5"
-  iso_urls         = ["./x86-ubuntu-24-04-v2"]
+  iso_checksum     = "sha256:58dfdabfd2510657776ad946c8c4e9cceacbd0806414690598a4f4808c2349b6"
+  iso_urls         = ["./x86-ubuntu-24.04-20250515"]
   memory           = "8192"
   output_directory = "disk-image-x86-npb"
   qemu_binary      = "/usr/bin/qemu-system-x86_64"

src/ubuntu-generic-diskimages/BUILDING.md

@@ -14,7 +14,7 @@
 
 # gem5-bridge exit signifying that after_boot.sh is running
 printf "In after_boot.sh...\n"
-gem5-bridge --addr=0x10010000 exit # TODO: Make this a specialized event.
+gem5-bridge --addr=0x10010000 hypercall 2
 
 # Read /proc/cmdline and parse options
 
@@ -51,7 +51,7 @@ else
             /tmp/script
             printf "Done running script from gem5-bridge, exiting.\n"
             rm -f /tmp/script
-            gem5-bridge --addr=0x10010000 exit
+            gem5-bridge --addr=0x10010000 hypercall 3
         fi
     fi
 fi

src/ubuntu-generic-diskimages/files/arm/after_boot.sh

@@ -15,11 +15,27 @@ mount -t sysfs /sys /sys
 cmdline=$(cat /proc/cmdline)
 no_systemd=false
 
+# Load gem5_bridge driver
+## Default parameters (ARM64)
+gem5_bridge_baseaddr=0x10010000
+gem5_bridge_rangesize=0x10000
+## Try to read overloads from kernel arguments
+if [[ $cmdline =~ gem5_bridge_baseaddr=([[:alnum:]]+) ]]; then
+    gem5_bridge_baseaddr=${BASH_REMATCH[1]}
+fi
+if [[ $cmdline =~ gem5_bridge_rangesize=([[:alnum:]]+) ]]; then
+    gem5_bridge_rangesize=${BASH_REMATCH[1]}
+fi
+## Insert driver
+modprobe gem5_bridge \
+    gem5_bridge_baseaddr=$gem5_bridge_baseaddr \
+    gem5_bridge_rangesize=$gem5_bridge_rangesize
+
 # gem5-bridge exit signifying that kernel is booted
 # This will cause the simulation to exit. Note that this will
 # cause qemu to fail.
 printf "Kernel booted, In gem5 init...\n"
-gem5-bridge --addr=0x10010000 exit # TODO: Make this a specialized event.
+gem5-bridge --addr=0x10010000 hypercall 1
 
 if [[ $cmdline == *"no_systemd"* ]]; then
     no_systemd=true