feat: Support simpler QMP configuration (#1403)

.github/workflows/check.yml

@@ -27,7 +27,7 @@ jobs:
                 -e SC2153
           -
             name: Lint Dockerfile
-            uses: hadolint/hadolint-action@v3.4.0
+            uses: hadolint/hadolint-action@v3.5.0
             with:
               dockerfile: Dockerfile
               ignore: DL3008,DL3067

Dockerfile

@@ -1,9 +1,8 @@
 # syntax=docker/dockerfile:1
 
-FROM qemux/qemu-host:2.06 AS host
 FROM scratch
 
-COPY --from=qemux/qemu:7.45 / /
+COPY --from=qemux/qemu:7.49 / /
 
 ARG VERSION_ARG="0.0"
 ARG VERSION_CSTRUCT="4.7"
@@ -34,8 +33,8 @@ EOF
 
 COPY --chmod=755 ./src /run/
 COPY --chmod=755 ./web /var/www/
-COPY --chmod=755 --from=host /qemu-host.bin /run/host.bin
 COPY --chmod=744 ./web/conf/nginx.conf /etc/nginx/default.conf
+COPY --chmod=755 --from=qemux/qemu-host:2.06 /qemu-host.bin /run/host.bin
 ADD --chmod=775 https://raw.githubusercontent.com/sud0woodo/patology/refs/heads/main/patology.py /run/extract.py
 
 VOLUME /storage

docs/environment.md

@@ -25,6 +25,7 @@ An empty default means the variable is unset and its value is determined automat
 | `HOST_CPU` |  | CPU name reported to DSM. Selected automatically when unset. |
 | `KVM` | `Y` | Enables KVM hardware acceleration. |
 | `RAM_SIZE` | `2G` | Amount of RAM assigned to DSM, such as `2G`, `4G`, `half`, or `max`. |
+| `RAM_BACKEND` |  | Guest RAM backing mechanism, set `memfd` for memfd-backed memory. |
 | `RAM_CHECK` | `Y` | Checks whether enough host memory is available before starting DSM. |
 
 ## 💾 Storage
@@ -33,7 +34,7 @@ An empty default means the variable is unset and its value is determined automat
 |---|---|---|
 | `DISK_SIZE` | `256G` | Size of the main data disk. |
 | `DISK_FMT` | `raw` | Disk image format: `raw` or `qcow2`. |
-| `DISK_TYPE` | `scsi` | Disk device type, such as `sata`, `scsi`, `nvme`, or `blk`. |
+| `DISK_TYPE` | `scsi` | Disk device type, such as `ide`, `scsi`, or `blk`. |
 | `DISK_CACHE` | `none` | Disk cache mode, such as `none` or `writeback`. |
 | `DISK_IO` | `native` | Disk I/O mode, such as `native`, `threads`, or `io_uring`. |
 | `DISK_DISCARD` | `unmap` | Discard/TRIM mode for the primary disk. |
@@ -71,9 +72,9 @@ An empty default means the variable is unset and its value is determined automat
 | Variable | Default | Description |
 |---|---|---|
 | `DISPLAY` | `none` | Display backend, such as `vnc`, `disabled`, or `none`. |
-| `LOSSY` | `N` | Enables lossy VNC compression to reduce bandwidth usage. |
 | `VGA` | `none` | QEMU video adapter model. |
-| `GPU` | `N` | Enables Intel iGPU acceleration. |
+| `GPU` | `N` | Enables GPU acceleration. |
+| `VRAM_SIZE` | `4G` | Virtual GPU memory budget. |
 | `RENDERNODE` | `/dev/dri/renderD128` | Render node used for GPU acceleration. |
 
 ## 🎈 Memory Ballooning
@@ -109,6 +110,6 @@ Also see [Dynamic memory allocation](https://github.com/qemus/qemu/blob/master/d
 | `DEBUG` | `N` | Enables verbose debug output. |
 | `TRACE` | `N` | Enables shell command tracing. |
 | `HOST_DEBUG` | `N` | Enables debug output for the DSM host helper. |
-| `MONITOR` |  | QEMU monitor configuration. |
-| `QMP` |  | QEMU Machine Protocol configuration. |
+| `MONITOR` |  | QEMU monitor, such as `/storage/monitor.sock` or `4444`. |
+| `QMP` |  | QEMU Machine Protocol, such as `/storage/qmp.sock` or `4444`. |
 | `ARGUMENTS` |  | Additional raw arguments appended to the QEMU command line. |

readme.md

@@ -201,9 +201,9 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     - 'c *:* rwm'
   ```
 
-### How do I pass through the GPU?
+### How do I enable GPU acceleration?
 
-  To pass through your Intel GPU, add the following lines to your compose file:
+  To enable GPU acceleration using an Intel or AMD GPU, add the following lines to your compose file:
 
   ```yaml
   environment:
@@ -212,8 +212,24 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     - /dev/dri
   ```
 
-> [!NOTE]
-> This can be used to enable the facial recognition function in Synology Photos, but does not provide hardware transcoding for video.
+  For NVIDIA GPUs, the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) must be installed on the host and the GPU must be exposed to the container:
+
+  ```yaml
+  environment:
+    GPU: "Y"
+    NVIDIA_DRIVER_CAPABILITIES: "all"
+
+  deploy:
+    resources:
+      reservations:
+        devices:
+          - driver: nvidia
+            count: all
+            capabilities:
+              - gpu
+  ```
+
+  GPU acceleration can be used to enable the facial recognition function in Synology Photos, but currently does not provide hardware transcoding for video yet.
 
 ### How do I enable dynamic memory allocation?
 

src/config.sh

@@ -1,12 +1,18 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+: "${RNG:=""}"
 : "${QMP:=""}"
 : "${UUID:=""}"
 : "${MONITOR:=""}"
 
-DEF_OPTS="-nodefaults -boot strict=on"
-DEV_OPTS=""
+msg="Configuring QEMU..."
+enabled "$DEBUG" && echo "$msg"
+
+# Sanitize variables
+QMP=$(strip "$QMP")
+UUID=$(strip "$UUID")
+MONITOR=$(strip "$MONITOR")
 
 configureProcessor() {
 
@@ -25,16 +31,54 @@ configureMemory() {
   return 0
 }
 
+normalizeSocket() {
+
+  local value="$1"
+  local backend="${value%%,*}"
+
+  if [[ "$backend" == *.sock && "$backend" != *:* ]]; then
+    value="unix:$value"
+    [[ ",$value," == *,server=* ]] || value+=",server=on"
+    if [[ ",$value," != *,wait=* ]] && [[ ",$value," != *,server=off,* ]]; then
+      value+=",wait=off"
+    fi
+  fi
+
+  echo "$value"
+}
+
+normalizePort() {
+
+  local value="$1"
+  local protocol="$2"
+
+  if [[ "$value" =~ ^[0-9]+$ ]]; then
+    value="$protocol:0.0.0.0:$value,server=on,wait=off"
+  fi
+
+  echo "$value"
+}
+
 configureMonitor() {
 
   MON_OPTS=""
-  [ -n "$QMP" ] && MON_OPTS+=" -qmp $QMP"
-  [ -n "$MONITOR" ] && MON_OPTS+=" -monitor $MONITOR"
 
-  MON_OPTS+=" -name $PROCESS,process=$PROCESS,debug-threads=on"
-  MON_OPTS+=" -pidfile $QEMU_PID"
+  if [ -n "$MONITOR" ]; then
+    MONITOR=$(normalizePort "$MONITOR" "telnet")
+    MONITOR=$(normalizeSocket "$MONITOR")
+    MON_OPTS+=" -monitor $MONITOR"
+  fi
+
+  if [ -n "$QMP" ]; then
+    QMP=$(normalizePort "$QMP" "tcp")
+    QMP=$(normalizeSocket "$QMP")
+    MON_OPTS+=" -qmp $QMP"
+  fi
+
+  ID_OPTS="-name ${APP// /-},process=$PROCESS"
+  PID_OPTS="-pidfile $QEMU_PID"
+
   MON_OPTS="${MON_OPTS# }"
-
   return 0
 }
 
@@ -48,36 +92,44 @@ configureMachine() {
   MAC_OPTS="-machine type=$MACHINE,smm=$smm,usb=off"
   MAC_OPTS+=",vmport=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
 
-  UUID=$(strip "$UUID")
-  [ -n "$UUID" ] && MAC_OPTS+=" -uuid $UUID"
-  [ -n "${SM_BIOS:-}" ] && MAC_OPTS+=" $SM_BIOS"
+  [ -n "$UUID" ] && ID_OPTS+=" -uuid $UUID"
+  [ -n "${SM_BIOS:-}" ] && ID_OPTS+=" $SM_BIOS"
 
   return 0
 }
 
-configureVirtioDevices() {
+configureDevices() {
 
   local bus
   bus=$(getPciBus)
 
+  DEV_OPTS=""
+
+  if ! disabled "$RNG"; then
+    DEV_OPTS+=" -object rng-random,id=objrng0,filename=/dev/urandom"
+    DEV_OPTS+=" -device virtio-rng-pci,rng=objrng0,id=rng0,bus=$bus,addr=0x1c"
+  fi
+
   # Keep the existing balloon device by default. When dynamic ballooning is
   # enabled, expose guest statistics and a dedicated QMP control socket.
   if ! enabled "${BALLOONING:-}"; then
-    DEV_OPTS="-device virtio-balloon-pci,id=balloon0,bus=$bus,addr=0x4"
+    DEV_OPTS+=" -device virtio-balloon-pci,id=balloon0,bus=$bus,addr=0x4"
   else
     MON_OPTS+=" -qmp unix:${BALLOONING_SOCKET},server=on,wait=off"
-    DEV_OPTS="-device virtio-balloon-pci,free-page-reporting=on,guest-stats-polling-interval=1,id=balloon0,bus=$bus,addr=0x4"
+    DEV_OPTS+=" -device virtio-balloon-pci,free-page-reporting=on,guest-stats-polling-interval=1,id=balloon0,bus=$bus,addr=0x4"
   fi
 
-  DEV_OPTS+=" -object rng-random,id=objrng0,filename=/dev/urandom"
-  DEV_OPTS+=" -device virtio-rng-pci,rng=objrng0,id=rng0,bus=$bus,addr=0x1c"
+  DEV_OPTS="${DEV_OPTS# }"
 
   return 0
 }
 
 buildArguments() {
 
-  ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $BOOT_OPTS $DEV_OPTS $ARGUMENTS"
+  local default="-nodefaults"
+  local boot="-boot strict=on"
+
+  ARGS="$default $MAC_OPTS $CPU_OPTS $RAM_OPTS $ID_OPTS $PID_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $boot $BOOT_OPTS $DEV_OPTS $ARGUMENTS"
 
   # Collapse whitespace after optional argument groups are assembled so empty
   # features cannot leave malformed spacing in the final QEMU command.
@@ -92,7 +144,7 @@ configureMemory
 configureMonitor
 configureMachine
 configureProcessor
-configureVirtioDevices
+configureDevices
 
 buildArguments
 

src/display.sh

@@ -1,69 +0,0 @@
-#!/usr/bin/env bash
-set -Eeuo pipefail
-
-# Docker environment variables
-
-: "${GPU:="N"}"         # GPU passthrough
-: "${VGA:="virtio"}"    # VGA adaptor
-: "${DISPLAY:="none"}"  # Display type
-: "${LOSSY:="N"}"       # Lossy VNC compression
-: "${RENDERNODE:="/dev/dri/renderD128"}"  # Render node
-
-# Sanitize variables
-VGA=$(strip "$VGA")
-LOSSY=$(strip "$LOSSY")
-DISPLAY=$(strip "$DISPLAY")
-RENDERNODE=$(strip "$RENDERNODE")
-
-CPU_VENDOR=$(lscpu | awk '/Vendor ID/{print $3}')
-
-# The accelerated Intel render-node path is restricted to x86 Intel hosts;
-# other platforms retain the normal QEMU display backend.
-if ! enabled "$GPU" || isAmdCpu || [[ "$ARCH" != "amd64" ]]; then
-
-  # A disabled frontend also removes the emulated VGA device to keep the guest
-  # hardware layout headless.
-  [[ "${DISPLAY,,}" == "none" ]] && VGA="none"
-
-  if enabled "$LOSSY" && [[ "${DISPLAY,,}" == vnc=* ]]; then
-    DISPLAY+=",lossy=on"
-  fi
-
-  DISPLAY_OPTS="-display ${DISPLAY} -vga ${VGA}"
-  return 0
-
-fi
-
-msg="Configuring display drivers..."
-
-html "$msg"
-enabled "$DEBUG" && echo "$msg"
-
-DISPLAY_OPTS="-display egl-headless,rendernode=${RENDERNODE}"
-DISPLAY_OPTS+=" -vga $VGA"
-
-[ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
-
-# Extract the card number from the render node
-# Linux renderD128 corresponds to card0; derive both device minors because
-# container device bindings may expose only the render node.
-CARD_NUMBER=$(echo "$RENDERNODE" | grep -oP '(?<=renderD)\d+')
-CARD_DEVICE="/dev/dri/card$((CARD_NUMBER - 128))"
-
-if [ ! -c "$CARD_DEVICE" ]; then
-  if mknod "$CARD_DEVICE" c 226 $((CARD_NUMBER - 128)); then
-    chmod 666 "$CARD_DEVICE"
-  fi
-fi
-
-if [ ! -c "$RENDERNODE" ]; then
-  if mknod "$RENDERNODE" c 226 "$CARD_NUMBER"; then
-    chmod 666 "$RENDERNODE"
-  fi
-fi
-
-if [ ! -c "$RENDERNODE" ] || [ ! -r "$RENDERNODE" ] || [ ! -w "$RENDERNODE" ]; then
-  warn "render device '${RENDERNODE}' is unavailable or inaccessible."
-fi
-
-return 0

src/prepare.sh

@@ -12,8 +12,8 @@ addSystemDisks() {
   setOwner "$boot" || warn "failed to set the owner for \"$boot\" !"
   setOwner "$system" || warn "failed to set the owner for \"$system\" !"
 
-  DISK_OPTS+=$(createDevice "$boot" "$DISK_TYPE" "1" "0xa" "raw" "$DISK_IO" "$DISK_CACHE" "" "" "synoboot")
-  DISK_OPTS+=$(createDevice "$system" "$DISK_TYPE" "2" "0xb" "raw" "$DISK_IO" "$DISK_CACHE" "" "" "synosys")
+  DISK_OPTS+=$(createDevice "$boot" "$DISK_TYPE" "1" "0xa" "raw" "" "" "synoboot")
+  DISK_OPTS+=$(createDevice "$system" "$DISK_TYPE" "2" "0xb" "raw" "" "" "synosys")
 
   return 0
 }