resources: Scripts to build disk with gem5 driver

This change adds scripts to build disk-images that include an
installation of gem5-bridge kernel object so that m5 memory can
be mapped without the need for sudo access. This is necessary
when benchmarks should not be run with sudo permission, e.g.
when using MPI runtimes. Additionally, it further breaks down
the installation steps to more granular steps that are easier
to understand and potentially debug.

Author: mahyarsamani

src/ubuntu-generic-diskimages/BUILDING.md renamed to src/ubuntu-generic-disk-images/BUILDING.md

@@ -29,7 +29,21 @@ if [[ "$ubuntu_version" != "22.04" && "$ubuntu_version" != "24.04" ]]; then
     exit 1
 fi
 
-# make the flash0.sh file
+# Create a dictionary to store the path to the kernel modules for each Ubuntu version
+declare -A kernel_modules_paths
+kernel_modules_paths["22.04"]="modules/u2204"
+kernel_modules_paths["24.04"]="modules/u2404/"
+
+# Get the path to the kernel modules for the specified Ubuntu version
+kernel_modules_path=${kernel_modules_paths[$ubuntu_version]}
+pushd $kernel_modules_path
+./copy_modules.sh
+popd
+
+# Store the image name from the second command line argument or default to "arm-ubuntu"
+image_name="${2:-arm-ubuntu}"
+
+# make the flash0.img file
 cd ./files
 dd if=/dev/zero of=flash0.img bs=1M count=64
 dd if=/usr/share/qemu-efi-aarch64/QEMU_EFI.fd of=flash0.img conv=notrunc
@@ -39,4 +53,4 @@ cd ..
 ./packer init ./packer-scripts/arm-ubuntu.pkr.hcl
 
 # Build the image with the specified Ubuntu version
-./packer build -var "ubuntu_version=${ubuntu_version}" ./packer-scripts/arm-ubuntu.pkr.hcl
+./packer build -var "ubuntu_version=${ubuntu_version}" -var "image_name=${image_name}" ./packer-scripts/arm-ubuntu.pkr.hcl

src/ubuntu-generic-diskimages/README.md renamed to src/ubuntu-generic-disk-images/README.md

@@ -15,6 +15,25 @@ 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
+
+# see if this modprode fails or not
+# print warning if it fails, gem5-bridge module is not going to work, you will need sudo for running exit events
+
 # gem5-bridge exit signifying that kernel is booted
 # This will cause the simulation to exit. Note that this will
 # cause qemu to fail.

src/ubuntu-generic-diskimages/build-arm.sh renamed to src/ubuntu-generic-disk-images/build-arm.sh

@@ -0,0 +1,3 @@
+[Service]
+ExecStart=
+ExecStart=-/sbin/agetty --autologin gem5 --keep-baud 115200,38400,9600 %I $TERM

src/ubuntu-generic-diskimages/files/arm/after_boot.sh renamed to src/ubuntu-generic-disk-images/files/arm/after_boot.sh

@@ -70,7 +70,7 @@ autoinstall:
       type: format
       id: format-0
     - device: disk-vda
-      size: 4257218560
+      size: 20909654016
       wipe: superblock
       flag: ''
       number: 2
@@ -92,4 +92,4 @@ autoinstall:
       type: mount
       id: mount-0
   updates: security
-  version: 1
+  version: 1