feat: Add support for IDE disk drives (#81)

src/config.sh

@@ -50,4 +50,8 @@ if [[ "$RAM_CHECK" != [Nn]* ]]; then
 
 fi
 
+if [[ "$DEBUG" == [Yy1]* ]]; then
+  printf "Arguments:\n\n%s" "${ARGS// -/$'\n-'}" && echo
+fi
+
 return 0

src/disk.sh

@@ -5,26 +5,12 @@ set -Eeuo pipefail
 
 : "${DISK_IO:="native"}"          # I/O Mode, can be set to 'native', 'threads' or 'io_turing'
 : "${DISK_FMT:=""}"               # Disk file format, can be set to "raw" (default) or "qcow2"
+: "${DISK_TYPE:=""}"              # Device type to be used, choose "ide", "usb", "blk" or "scsi"
 : "${DISK_FLAGS:=""}"             # Specifies the options for use with the qcow2 disk format
 : "${DISK_CACHE:="none"}"         # Caching mode, can be set to 'writeback' for better performance
 : "${DISK_DISCARD:="on"}"         # Controls whether unmap (TRIM) commands are passed to the host.
 : "${DISK_ROTATION:="1"}"         # Rotation rate, set to 1 for SSD storage and increase for HDD
 
-[ ! -f "$BOOT" ] || [ ! -s "$BOOT" ] && BOOT="/dev/null"
-
-DISK_OPTS="-object iothread,id=io2"
-DISK_OPTS="$DISK_OPTS -drive id=cdrom0,media=cdrom,if=none,format=raw,readonly=on,file=$BOOT"
-DISK_OPTS="$DISK_OPTS -device virtio-scsi-pci,id=scsi0,iothread=io2,addr=0x5"
-DISK_OPTS="$DISK_OPTS -device scsi-cd,bus=scsi0.0,drive=cdrom0,bootindex=$BOOT_INDEX"
-
-DRIVERS="/drivers.iso"
-[ ! -f "$DRIVERS" ] || [ ! -s "$DRIVERS" ] && DRIVERS="$STORAGE/drivers.iso"
-[ ! -f "$DRIVERS" ] || [ ! -s "$DRIVERS" ] && DRIVERS="/run/drivers.iso"
-
-if [ -f "$DRIVERS" ]; then
-  DISK_OPTS="$DISK_OPTS -drive id=cdrom1,media=cdrom,if=none,format=raw,readonly=on,file=$DRIVERS -device usb-storage,drive=cdrom1"
-fi
-
 fmt2ext() {
   local DISK_FMT=$1
 
@@ -123,9 +109,9 @@ createDisk() {
   fi
 
   html "Creating a $DISK_DESC image..."
-  info "Creating a $DISK_SPACE $DISK_TYPE $DISK_DESC image in $DISK_FMT format..."
+  info "Creating a $DISK_SPACE $DISK_STYLE $DISK_DESC image in $DISK_FMT format..."
 
-  local FAIL="Could not create a $DISK_TYPE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
+  local FAIL="Could not create a $DISK_STYLE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
@@ -210,7 +196,7 @@ resizeDisk() {
   MSG="Resizing $DISK_DESC from ${GB}G to $DISK_SPACE..."
   info "$MSG" && html "$MSG"
 
-  local FAIL="Could not resize the $DISK_TYPE $DISK_FMT $DISK_DESC image from ${GB}G to $DISK_SPACE ($DISK_FILE)"
+  local FAIL="Could not resize the $DISK_STYLE $DISK_FMT $DISK_DESC image from ${GB}G to $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
@@ -293,7 +279,7 @@ convertDisk() {
   # shellcheck disable=SC2086
   if ! qemu-img convert -f "$SOURCE_FMT" $CONV_FLAGS -o "$DISK_PARAM" -O "$DST_FMT" -- "$SOURCE_FILE" "$TMP_FILE"; then
     rm -f "$TMP_FILE"
-    error "Failed to convert $DISK_TYPE $DISK_DESC image to $DST_FMT format in $DIR, is there enough space available?" && exit 79
+    error "Failed to convert $DISK_STYLE $DISK_DESC image to $DST_FMT format in $DIR, is there enough space available?" && exit 79
   fi
 
   if [[ "$DST_FMT" == "raw" ]]; then
@@ -356,28 +342,81 @@ checkFS () {
 }
 
 createDevice () {
-
+  local DISK_FILE=$1
-  local DISK_ID=$1
+  local DISK_TYPE=$2
-  local DISK_FILE=$2
   local DISK_INDEX=$3
   local DISK_ADDRESS=$4
   local DISK_FMT=$5
   local DISK_IO=$6
   local DISK_CACHE=$7
+  local DISK_ID="data$DISK_INDEX"
 
-  local result="-drive file=$DISK_FILE,if=none,id=drive-$DISK_ID,format=$DISK_FMT,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on"
+  local index=""
+  [ -n "$DISK_INDEX" ] && index=",bootindex=$DISK_INDEX"
+  local result="-drive file=$DISK_FILE,id=$DISK_ID,if=none,format=$DISK_FMT,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on"
 
+  case "${DISK_TYPE,,}" in
+    "usb" )
       result="$result \
-    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+      -device usb-storage,drive=${DISK_ID}${index}"
-    -device scsi-hd,bus=hw-$DISK_ID.0,channel=0,scsi-id=0,lun=0,drive=drive-$DISK_ID,id=$DISK_ID,rotation_rate=$DISK_ROTATION,bootindex=$DISK_INDEX"
+      ;;
-
+    "ide" )
+      result="$result \
+      -device ide-hd,drive=${DISK_ID},bus=ide.$DISK_INDEX,rotation_rate=$DISK_ROTATION${index}"
       echo "$result"
+      ;;
+    "blk" | "virtio-blk" )
+      result="$result \
+      -device virtio-blk-pci,drive=${DISK_ID},scsi=off,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}"
+      echo "$result"
+      ;;
+    "scsi" | "virtio-scsi" )
+      result="$result \
+      -device virtio-scsi-pci,id=${DISK_ID}b,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2 \
+      -device scsi-hd,drive=${DISK_ID},bus=${DISK_ID}b.0,channel=0,scsi-id=0,lun=0,rotation_rate=$DISK_ROTATION${index}"
+      echo "$result"
+      ;;
+  esac
+
+  return 0
+}
+
+addMedia () {
+  local DISK_FILE=$1
+  local DISK_TYPE=$2
+  local DISK_BUS=$3
+  local DISK_INDEX=$4
+  local DISK_ADDRESS=$5
+
+  local index=""
+  local DISK_ID="cdrom$DISK_BUS"
+  [ -n "$DISK_INDEX" ] && index=",bootindex=$DISK_INDEX"
+  local result="-drive file=$DISK_FILE,id=$DISK_ID,if=none,format=raw,media=cdrom,readonly=on"
+
+  case "${DISK_TYPE,,}" in
+    "usb" )
+      result="$result \
+      -device usb-storage,drive=${DISK_ID}${index}"
+      ;;
+    "ide" | "blk" | "virtio-blk" )
+      result="$result \
+      -device ide-cd,drive=${DISK_ID},bus=ide.${DISK_BUS}${index}"
+      echo "$result"
+      ;;
+    "scsi" | "virtio-scsi" )
+      result="$result \
+      -device virtio-scsi-pci,id=${DISK_ID}b,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2 \
+      -device scsi-cd,drive=${DISK_ID},bus=${DISK_ID}b.0${index}"
+      echo "$result"
+      ;;
+  esac
+
   return 0
 }
 
 addDisk () {
   local DISK_BASE=$1
-  local DISK_EXT=$2
+  local DISK_TYPE=$2
   local DISK_DESC=$3
   local DISK_SPACE=$4
   local DISK_INDEX=$5
@@ -385,9 +424,10 @@ addDisk () {
   local DISK_FMT=$7
   local DISK_IO=$8
   local DISK_CACHE=$9
-  local DISK_ID="userdata$DISK_INDEX"
+  local DISK_EXT DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE OPTS
+
+  DISK_EXT=$(fmt2ext "$DISK_FMT")
   local DISK_FILE="$DISK_BASE.$DISK_EXT"
-  local DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE OPTS
 
   DIR=$(dirname "$DISK_FILE")
   [ ! -d "$DIR" ] && return 0
@@ -436,25 +476,23 @@ addDisk () {
 
   fi
 
-  OPTS=$(createDevice "$DISK_ID" "$DISK_FILE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE")
+  OPTS=$(createDevice "$DISK_FILE" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE")
   DISK_OPTS="$DISK_OPTS $OPTS"
 
   return 0
 }
 
 addDevice () {
-
   local DISK_DEV=$1
-  local DISK_DESC=$2
+  local DISK_TYPE=$2
   local DISK_INDEX=$3
   local DISK_ADDRESS=$4
-  local DISK_ID="userdata$DISK_INDEX"
 
   [ -z "$DISK_DEV" ] && return 0
   [ ! -b "$DISK_DEV" ] && error "Device $DISK_DEV cannot be found! Please add it to the 'devices' section of your compose file." && exit 55
 
   local OPTS
-  OPTS=$(createDevice "$DISK_ID" "$DISK_DEV" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
+  OPTS=$(createDevice "$DISK_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
   DISK_OPTS="$DISK_OPTS $OPTS"
 
   return 0
@@ -462,6 +500,25 @@ addDevice () {
 
 html "Initializing disks..."
 
+case "${DISK_TYPE,,}" in
+  "" )
+    DISK_TYPE="scsi"
+  "ide" | "usb" | "blk" | "scsi" ) ;;
+  * ) error "Invalid DISK_TYPE, value \"$DISK_TYPE\" is unrecognized!" && exit 80 ;;
+esac
+
+[ ! -f "$BOOT" ] || [ ! -s "$BOOT" ] && BOOT="/dev/null"
+DISK_OPTS=$(addMedia "$BOOT" "$DISK_TYPE" "0" "$BOOT_INDEX" "0x5")
+
+DRIVERS="/drivers.iso"
+[ ! -f "$DRIVERS" ] || [ ! -s "$DRIVERS" ] && DRIVERS="$STORAGE/drivers.iso"
+[ ! -f "$DRIVERS" ] || [ ! -s "$DRIVERS" ] && DRIVERS="/run/drivers.iso"
+
+if [ -f "$DRIVERS" ]; then
+  DRIVER_OPTS=$(addMedia "$DRIVERS" "usb" "1" "" "0x6")
+  DISK_OPTS="$DISK_OPTS $DRIVER_OPTS"
+fi
+
 DISK1_FILE="$STORAGE/data"
 DISK2_FILE="/storage2/data2"
 DISK3_FILE="/storage3/data3"
@@ -475,17 +532,15 @@ if [ -z "$DISK_FMT" ]; then
   fi
 fi
 
-DISK_EXT=$(fmt2ext "$DISK_FMT")
-
 if [ -z "$ALLOCATE" ]; then
   ALLOCATE="N"
 fi
 
 if [[ "$ALLOCATE" == [Nn]* ]]; then
-  DISK_TYPE="growable"
+  DISK_STYLE="growable"
   DISK_ALLOC="preallocation=off"
 else
-  DISK_TYPE="preallocated"
+  DISK_STYLE="preallocated"
   DISK_ALLOC="preallocation=falloc"
 fi
 
@@ -510,28 +565,30 @@ fi
 [ -z "$DEVICE4" ] && [ -b "/dev/disk4" ] && DEVICE4="/dev/disk4"
 
 if [ -n "$DEVICE" ]; then
-  addDevice "$DEVICE" "device" "3" "0xa" || exit $?
+  addDevice "$DEVICE" "$DISK_TYPE" "3" "0xa" || exit $?
 else
-  addDisk "$DISK1_FILE" "$DISK_EXT" "disk" "$DISK_SIZE" "3" "0xa" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+  addDisk "$DISK1_FILE" "$DISK_TYPE" "disk" "$DISK_SIZE" "3" "0xa" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
 if [ -n "$DEVICE2" ]; then
-  addDevice "$DEVICE2" "device2" "4" "0xb" || exit $?
+  addDevice "$DEVICE2" "$DISK_TYPE" "4" "0xb" || exit $?
 else
-  addDisk "$DISK2_FILE" "$DISK_EXT" "disk2" "$DISK2_SIZE" "4" "0xb" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+  addDisk "$DISK2_FILE" "$DISK_TYPE" "disk2" "$DISK2_SIZE" "4" "0xb" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
 if [ -n "$DEVICE3" ]; then
-  addDevice "$DEVICE3" "device3" "5" "0xc" || exit $?
+  addDevice "$DEVICE3" "$DISK_TYPE" "5" "0xc" || exit $?
 else
-  addDisk "$DISK3_FILE" "$DISK_EXT" "disk3" "$DISK3_SIZE" "5" "0xc" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+  addDisk "$DISK3_FILE" "$DISK_TYPE" "disk3" "$DISK3_SIZE" "5" "0xc" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
 if [ -n "$DEVICE4" ]; then
-  addDevice "$DEVICE4" "device4" "6" "0xd" || exit $?
+  addDevice "$DEVICE4" "$DISK_TYPE" "6" "0xd" || exit $?
 else
-  addDisk "$DISK4_FILE" "$DISK_EXT" "disk4" "$DISK4_SIZE" "6" "0xd" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+  addDisk "$DISK4_FILE" "$DISK_TYPE" "disk4" "$DISK4_SIZE" "6" "0xd" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
+DISK_OPTS="$DISK_OPTS -object iothread,id=io2"
+
 html "Initialized disks successfully..."
 return 0

src/entry.sh

@@ -19,5 +19,4 @@ trap - ERR
 
 info "Booting image${BOOT_DESC}..."
 
-[[ "$DEBUG" == [Yy1]* ]] && set -x
 exec qemu-system-aarch64 ${ARGS:+ $ARGS}

src/network.sh

@@ -337,7 +337,7 @@ if [[ "$DHCP" == [Yy1]* ]]; then
 
 else
 
-  if [[ "$GATEWAY" != "172."* ]]; then
+  if [[ "$GATEWAY" != "172."* ]] && [[ "$GATEWAY" != "10."* ]]; then
     ! checkOS && exit 19
   fi