feat: Install GPU drivers

feat: Install GPU drivers

.github/workflows/build.yml

@@ -12,7 +12,6 @@ on:
       - '.dockerignore'
       - '.github/**'
       - '.github/workflows/**'
-      - 'Dockerfile'
 
 jobs:
   shellcheck:
@@ -28,10 +27,10 @@ jobs:
     steps:
       - 
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       -
@@ -54,13 +53,13 @@ jobs:
           echo "build_date=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_OUTPUT
       -
         name: Login into Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       -
         name: Login to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}

.github/workflows/check.yml

@@ -7,7 +7,7 @@ jobs:
     name: shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master
 env:

.github/workflows/hub.yml

@@ -12,7 +12,7 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - 
       name: Docker Hub Description
       uses: peter-evans/dockerhub-description@v3

Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/qemu-tools/qemu-host as builder
+FROM qemux/qemu-host as builder
 
 #  FROM golang as builder
 #  WORKDIR /
@@ -14,25 +14,24 @@ ARG DEBIAN_FRONTEND noninteractive
 
 RUN apt-get update && apt-get -y upgrade && \
     apt-get --no-install-recommends -y install \
-	curl \
-	cpio \
-	wget \
-	fdisk \
-	unzip \
-	socat \	
-	procps \
-	dnsmasq \
-	xz-utils \
-	iptables \
-	iproute2 \
-	net-tools \
-	btrfs-progs \
-	netcat-openbsd \
-	ca-certificates \
-	qemu-system-x86 \
+        curl \
+        cpio \
+        wget \
+        fdisk \
+        unzip \
+        socat \
+        procps \
+        xz-utils \
+        iptables \
+        iproute2 \
+        dnsmasq \
+        net-tools \
+        ca-certificates \
+        netcat-openbsd \
+        qemu-system-x86 \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-    
+
 COPY run/*.sh /run/
 COPY agent/*.sh /agent/
 
@@ -44,7 +43,7 @@ VOLUME /storage
 
 EXPOSE 22
 EXPOSE 80
-EXPOSE 139 
+EXPOSE 139
 EXPOSE 445
 EXPOSE 5000
 

agent/agent.sh

@@ -124,7 +124,7 @@ else
 
 fi
 
-delay=5000
+delay=500
 elapsed=$((($(date +%s%N) - ts)/1000000))
 
 if [[ delay -gt elapsed ]]; then
@@ -143,9 +143,11 @@ else
   MSG="http://${IP}:5000"
 fi
 
+echo ""
 info "--------------------------------------------------------"
 info " You can now login to DSM at ${MSG}"
 info "--------------------------------------------------------"
+echo ""
 
 # Wait for NMI interrupt as a shutdown signal
 

docker-compose.yml

@@ -10,6 +10,8 @@ services:
         devices:
             - /dev/kvm
             - /dev/vhost-net
+        device_cgroup_rules:
+            - 'c *:* rwm'
         cap_add:
             - NET_ADMIN        
         ports:

readme.md

@@ -60,6 +60,8 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
     environment:
         DISK_SIZE: "256G"
     ```
+    
+    This can also be used to resize the existing disk to a larger capacity without data loss. 
 
   * ### How do I change the location of the virtual disk?
 
@@ -152,10 +154,10 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
     devices:
         - /dev/vhost-net
     device_cgroup_rules:
-        - 'c 511:* rwm'
+        - 'c *:* rwm'
     ```
 
-    Please note that the exact `cgroup` rule number may vary depending on your system, but the log output will indicate the correct number in the event of an error.
+    Please note that even if you don't need DHCP, it's still recommended to enable this feature as it prevents NAT issues and increases performance by using a `macvtap` interface.
 
   * ### How do I install a specific version of vDSM?
 
@@ -163,11 +165,22 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
     ```yaml
     environment:
-        URL: "https://global.synologydownload.com/download/DSM/release/7.1.1/42962-1/DSM_VirtualDSM_42962.pat"
+        URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
     ```
 
     With this method, you are able to switch between different versions while keeping your file data.
 
+  * ### How do I passthrough my GPU?
+
+    To enable this feature, add the following lines to your compose file:
+
+    ```yaml
+    environment:
+        GPU: "Y"
+    devices:
+        - /dev/dri
+    ```
+
   * ### What are the differences compared to the standard DSM?
 
     There are only two minor differences: the Virtual Machine Manager package is not provided, and Surveillance Station doesn't include any free licenses.
@@ -176,7 +189,7 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
     Yes, this project contains only open-source code and does not distribute any copyrighted material. Neither does it try to circumvent any copyright protection measures. So under all applicable laws, this project would be considered legal. 
     
-    However, by installing Synology's Virtual DSM, you must accept their end-user license agreement, which does not permit installation on non-Synology hardware. So only run this project on an official Synology NAS via the Container Manager package, as any other use will be a violation of their terms and conditions.
+    However, by installing Synology's Virtual DSM, you must accept their end-user license agreement, which does not permit installation on non-Synology hardware. So only run this project on an official Synology NAS, as any other use will be a violation of their terms and conditions.
 
 ## Disclaimer
 
@@ -189,4 +202,4 @@ Only run this container on Synology hardware, any other use is not permitted by
 [Build]: https://github.com/kroese/virtual-dsm/actions/workflows/build.yml/badge.svg
 [Size]: https://img.shields.io/docker/image-size/kroese/virtual-dsm/latest?color=066da5&label=size
 [Pulls]: https://img.shields.io/docker/pulls/kroese/virtual-dsm.svg?style=flat&label=pulls&logo=docker
-[Version]: https://img.shields.io/docker/v/kroese/virtual-dsm?arch=amd64&sort=date&color=066da5
+[Version]: https://img.shields.io/docker/v/kroese/virtual-dsm/latest?arch=amd64&sort=semver&color=066da5

run/disk.sh

@@ -39,13 +39,15 @@ if [ -f "${DATA}" ]; then
     if [[ "${ALLOCATE}" == [Nn]* ]]; then
 
       # Resize file by changing its length
-      truncate -s "${DATA_SIZE}" "${DATA}"; 
+      if ! truncate -s "${DATA_SIZE}" "${DATA}"; then
+        error "Could not resize the file for the virtual disk." && exit 85
+      fi
 
     else
 
       REQ=$((DATA_SIZE-OLD_SIZE))
 
-      # Check free diskspace    
+      # Check free diskspace
       SPACE=$(df --output=avail -B 1 "${STORAGE}" | tail -n 1)
 
       if (( REQ > SPACE )); then
@@ -55,7 +57,9 @@ if [ -f "${DATA}" ]; then
 
       # Resize file by allocating more space
       if ! fallocate -l "${DATA_SIZE}" "${DATA}"; then
-        error "Could not allocate a file for the virtual disk." && exit 85
+        if ! truncate -s "${DATA_SIZE}" "${DATA}"; then
+          error "Could not resize the file for the virtual disk." && exit 85
+        fi
       fi
 
       if [[ "${ALLOCATE}" == [Zz]* ]]; then
@@ -84,7 +88,10 @@ if [ ! -f "${DATA}" ]; then
   if [[ "${ALLOCATE}" == [Nn]* ]]; then
 
     # Create an empty file
-    truncate -s "${DATA_SIZE}" "${DATA}"
+    if ! truncate -s "${DATA_SIZE}" "${DATA}"; then
+      rm -f "${DATA}"
+      error "Could not create a file for the virtual disk." && exit 87
+    fi
 
   else
 
@@ -98,8 +105,10 @@ if [ ! -f "${DATA}" ]; then
 
     # Create an empty file
     if ! fallocate -l "${DATA_SIZE}" "${DATA}"; then
-      rm -f "${DATA}"
-      error "Could not allocate a file for the virtual disk." && exit 87
+      if ! truncate -s "${DATA_SIZE}" "${DATA}"; then
+        rm -f "${DATA}"
+        error "Could not create a file for the virtual disk." && exit 87
+      fi
     fi
 
     if [[ "${ALLOCATE}" == [Zz]* ]]; then
@@ -116,7 +125,7 @@ if [ ! -f "${DATA}" ]; then
   fi
 
   # Format as BTRFS filesystem
-  mkfs.btrfs -q -L data -d single -m dup "${DATA}" > /dev/null
+  # mkfs.btrfs -q -L data -d single -m dup "${DATA}" > /dev/null
 
 fi
 

run/install.sh

@@ -10,7 +10,7 @@ DL="https://global.synologydownload.com/download/DSM"
 if [ -z "$URL" ]; then
 
   if [ "$ARCH" == "amd64" ]; then
-    URL="$DL/release/7.2/64561/DSM_VirtualDSM_64561.pat"
+    URL="$DL/release/7.2/64570-1/DSM_VirtualDSM_64570.pat"
   else
     URL="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
   fi
@@ -31,13 +31,20 @@ rm -f "$STORAGE"/"$BASE".agent
 rm -f "$STORAGE"/"$BASE".boot.img
 rm -f "$STORAGE"/"$BASE".system.img
 
-TMP="$STORAGE/tmp"
-RDC="$STORAGE/dsm.rd"
-
+TMP="/tmp/dsm"
+FS=$(stat -f -c %T "$STORAGE")
+[[ "$FS" == "ext"* ]] && TMP="$STORAGE/tmp"
 rm -rf "$TMP" && mkdir -p "$TMP"
 
+# Check free diskspace
+MIN_SPACE=5842450944
+SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
+(( MIN_SPACE > SPACE )) && error "Not enough free space for installation." && exit 95
+
 [[ "${DEBUG}" == [Yy1]* ]] && set -x
 
+RDC="$STORAGE/dsm.rd"
+
 if [ ! -f "${RDC}" ]; then
 
   info "Install: Downloading installer..."
@@ -95,7 +102,7 @@ if [ -f "${RDC}" ]; then
     cp "$TMP/usr/lib/libc.so.6" /lib64/
     cp "$TMP/usr/lib/libpthread.so.0" /lib64/
     cp "$TMP/usr/lib/ld-linux-x86-64.so.2" /lib64/
-  fi  
+  fi
 
   mv /run/extract/scemd /run/extract/syno_extract_system_patch
   chmod +x /run/extract/syno_extract_system_patch
@@ -120,28 +127,36 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
-info "Install: Extracting downloaded image..."
-
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
+  info "Install: Extracting downloaded image..."
   tar xpf "$PAT" -C "$TMP/."
 
 else
 
+  export DEBCONF_NOWARNINGS="yes"
+  export DEBIAN_FRONTEND="noninteractive"
+
   if [ "$ARCH" != "amd64" ]; then
 
-    export DEBCONF_NOWARNINGS="yes"
-    export DEBIAN_FRONTEND="noninteractive"
+    info "Install: Installing QEMU..."
 
-    apt-get -qq update
-    apt-get -qq -y upgrade
+    apt-get -qq update && apt-get -qq -y upgrade
     apt-get -qq --no-install-recommends -y install qemu-user > /dev/null
 
-    export DEBIAN_FRONTEND=""
-    export DEBCONF_NOWARNINGS=""
+  fi
+
+  if [[ "${GPU}" == [Yy1]* ]] && [[ "$ARCH" == "amd64" ]]; then
+
+    info "Install: Installing GPU drivers..."
+
+    apt-get -qq update && apt-get -qq -y upgrade
+    apt-get -qq --no-install-recommends -y install xserver-xorg-video-intel > /dev/null
 
   fi
 
+  info "Install: Extracting downloaded image..."
+
   export LD_LIBRARY_PATH="/run/extract"
 
   if [ "$ARCH" == "amd64" ]; then
@@ -179,7 +194,9 @@ SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
 (( SYSTEM_SIZE > SPACE )) && error "Not enough free space to create a 4 GB system disk." && exit 87
 
 if ! fallocate -l "${SYSTEM_SIZE}" "${SYSTEM}"; then
-  rm -f "${SYSTEM}" && error "Could not allocate a file for the system disk." && exit 88
+  if ! truncate -s "${SYSTEM_SIZE}" "${SYSTEM}"; then
+    rm -f "${SYSTEM}" && error "Could not allocate a file for the system disk." && exit 88
+  fi
 fi
 
 if [[ "${ALLOCATE}" == [Zz]* ]]; then
@@ -248,6 +265,11 @@ mke2fs -q -t ext4 -b 4096 -d "$MOUNT/" -L "$LABEL" -F -E "offset=$OFFSET" "$SYST
 rm -rf "$MOUNT"
 
 echo "$BASE" > "$STORAGE"/dsm.ver
+
+# Check free diskspace
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
+(( MIN_SPACE > SPACE )) && error "Not enough free space in storage folder." && exit 94
+
 mv -f "$PAT" "$STORAGE"/"$BASE".pat
 mv -f "$BOOT" "$STORAGE"/"$BASE".boot.img
 mv -f "$SYSTEM" "$STORAGE"/"$BASE".system.img

run/network.sh

@@ -31,7 +31,10 @@ configureDHCP() {
     error "and that the NET_ADMIN capability has been added to the container config: --cap-add NET_ADMIN" && exit 16
   fi
 
-  ip link set "${VM_NET_TAP}" up
+  while ! ip link set "${VM_NET_TAP}" up; do
+    info "Waiting for address to become available..."
+    sleep 2
+  done
 
   TAP_NR=$(</sys/class/net/"${VM_NET_TAP}"/ifindex)
   TAP_PATH="/dev/tap${TAP_NR}"
@@ -127,17 +130,28 @@ configureNAT () {
   fi
 
   ip address add ${VM_NET_IP%.*}.1/24 broadcast ${VM_NET_IP%.*}.255 dev dockerbridge
-  ip link set dockerbridge up
+
+  while ! ip link set dockerbridge up; do
+    info "Waiting for address to become available..."
+    sleep 2
+  done
 
   # QEMU Works with taps, set tap to the bridge created
   ip tuntap add dev "${VM_NET_TAP}" mode tap
-  ip link set "${VM_NET_TAP}" up promisc on
+
+  while ! ip link set "${VM_NET_TAP}" up promisc on; do
+    info "Waiting for tap to become available..."
+    sleep 2
+  done
+
   ip link set dev "${VM_NET_TAP}" master dockerbridge
 
   # Add internet connection to the VM
+  IP=$(ip address show dev "${VM_NET_DEV}" | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
+
   iptables -t nat -A POSTROUTING -o "${VM_NET_DEV}" -j MASQUERADE
-  iptables -t nat -A PREROUTING -i "${VM_NET_DEV}" -p tcp  -j DNAT --to $VM_NET_IP
-  iptables -t nat -A PREROUTING -i "${VM_NET_DEV}" -p udp  -j DNAT --to $VM_NET_IP
+  iptables -t nat -A PREROUTING -i "${VM_NET_DEV}" -d "${IP}" -p tcp  -j DNAT --to $VM_NET_IP
+  iptables -t nat -A PREROUTING -i "${VM_NET_DEV}" -d "${IP}" -p udp  -j DNAT --to $VM_NET_IP
 
   if (( KERNEL > 4 )); then
     # Hack for guest VMs complaining about "bad udp checksums in 5 packets"
@@ -165,6 +179,24 @@ configureNAT () {
   return 0
 }
 
+closeNetwork () {
+
+  if [[ "${DHCP}" == [Yy1]* ]]; then
+
+    ip link set "${VM_NET_TAP}" down || true
+    ip link delete "${VM_NET_TAP}" || true
+
+  else
+
+    ip link set "${VM_NET_TAP}" down promisc off || true
+    ip link delete "${VM_NET_TAP}" || true
+
+    ip link set dockerbridge down || true
+    ip link delete dockerbridge || true
+
+  fi
+}
+
 # ######################################
 #  Configure Network
 # ######################################

run/power.sh

@@ -81,6 +81,8 @@ _graceful_shutdown() {
   echo && echo "❯ Quitting..."
   echo 'quit' | nc -q 1 -w 1 localhost "${QEMU_MONPORT}" >/dev/null 2>&1 || true
 
+  closeNetwork
+
   return
 }
 

run/run.sh

@@ -4,8 +4,10 @@ set -Eeuo pipefail
 # Docker environment variables
 
 : ${URL:=''}            # URL of the PAT file
+: ${GPU:='N'}         # Enable GPU passthrough
 : ${DEBUG:='N'}         # Enable debug mode
 : ${ALLOCATE:='Y'}      # Preallocate diskspace
+: ${ARGUMENTS:=''}      # Extra QEMU parameters
 : ${CPU_CORES:='1'}     # Amount of CPU cores
 : ${DISK_SIZE:='16G'}   # Initial data disk size
 : ${RAM_SIZE:='512M'}   # Maximum RAM amount
@@ -21,7 +23,9 @@ trap 'error "Status $? while: ${BASH_COMMAND} (line $LINENO/$BASH_LINENO)"' ERR
 
 STORAGE="/storage"
 KERNEL=$(uname -r | cut -b 1)
+MINOR=$(uname -r | cut -d '.' -f2)
 ARCH=$(dpkg --print-architecture)
+VERS=$(qemu-system-x86_64 --version | head -n 1 | cut -d '(' -f 1)
 
 [ ! -d "$STORAGE" ] && error "Storage folder (${STORAGE}) not found!" && exit 13
 
@@ -78,21 +82,26 @@ EXTRA_OPTS="-device virtio-balloon-pci,id=balloon0,bus=pcie.0,addr=0x4"
 EXTRA_OPTS="$EXTRA_OPTS -object rng-random,id=objrng0,filename=/dev/urandom"
 EXTRA_OPTS="$EXTRA_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
 
-ARGS="${DEF_OPTS} ${CPU_OPTS} ${RAM_OPTS} ${MAC_OPTS} ${MON_OPTS} ${SERIAL_OPTS} ${NET_OPTS} ${DISK_OPTS} ${EXTRA_OPTS}"
+if [[ "${GPU}" == [Yy1]* ]]; then
+  DEF_OPTS="-nodefaults -boot strict=on -display egl-headless,rendernode=/dev/dri/renderD128"
+  DEF_OPTS="${DEF_OPTS} -device virtio-vga,id=video0,max_outputs=1,bus=pcie.0,addr=0x1"
+fi
+
+ARGS="${DEF_OPTS} ${CPU_OPTS} ${RAM_OPTS} ${MAC_OPTS} ${MON_OPTS} ${SERIAL_OPTS} ${NET_OPTS} ${DISK_OPTS} ${EXTRA_OPTS} ${ARGUMENTS}"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')
 
 trap - ERR
 
 set -m
 (
-  [[ "${DEBUG}" == [Yy1]* ]] && set -x
+  [[ "${DEBUG}" == [Yy1]* ]] && info "$VERS" && set -x
   qemu-system-x86_64 ${ARGS:+ $ARGS} & echo $! > "${_QEMU_PID}"
   { set +x; } 2>/dev/null
 )
 set +m
 
-if (( KERNEL > 4 )); then
-  pidwait -F "${_QEMU_PID}" & wait $!
-else
-  tail --pid "$(cat "${_QEMU_PID}")" --follow /dev/null & wait $!
-fi
+#if (( KERNEL > 5 )) || ( (( KERNEL == 5 )) && (( MINOR > 2 )) ); then
+#  pidwait -F "${_QEMU_PID}" & wait $!
+#else
+
+tail --pid "$(cat "${_QEMU_PID}")" --follow /dev/null & wait $!

run/serial.sh

@@ -4,10 +4,12 @@ set -Eeuo pipefail
 # Docker environment variables
 
 : ${HOST_CPU:=''}
+: ${HOST_MAC:=''}
 : ${HOST_BUILD:=''}
 : ${HOST_DEBUG:=''}
 : ${HOST_SERIAL:=''}
 : ${GUEST_SERIAL:=''}
+: ${HOST_MODEL:=''}
 : ${HOST_VERSION:=''}
 : ${HOST_TIMESTAMP:=''}
 
@@ -26,10 +28,12 @@ else
 fi
 
 HOST_ARGS=()
+HOST_ARGS+=("-cpu=${CPU_CORES}")
 HOST_ARGS+=("-cpu_arch=${HOST_CPU}")
 
-[ -n "$CPU_CORES" ] && HOST_ARGS+=("-cpu=${CPU_CORES}")
+[ -n "$HOST_MAC" ] && HOST_ARGS+=("-mac=${HOST_MAC}")
 [ -n "$HOST_BUILD" ] && HOST_ARGS+=("-build=${HOST_BUILD}")
+[ -n "$HOST_MODEL" ] && HOST_ARGS+=("-model=${HOST_MODEL}")
 [ -n "$HOST_SERIAL" ] && HOST_ARGS+=("-hostsn=${HOST_SERIAL}")
 [ -n "$GUEST_SERIAL" ] && HOST_ARGS+=("-guestsn=${GUEST_SERIAL}")
 [ -n "$HOST_VERSION" ] && HOST_ARGS+=("-version=${HOST_VERSION}")
@@ -41,7 +45,7 @@ if [[ "${HOST_DEBUG}" == [Yy1]* ]]; then
   { set +x; } 2>/dev/null
   echo
 else
-  ./run/host.bin "${HOST_ARGS[@]}" > /dev/null 2>&1 &
+  ./run/host.bin "${HOST_ARGS[@]}" 2> /dev/null &
 fi
 
 # Configure serial ports