feat: Improve support for unprivileged hosts (including LXC) (#479)

* * Add fakeroot to extract the dsm system without elevated permissions
* Remove obsolete docker variable "DEV" used to exclude extraction of device nodes

* feat: Detect unprivileged container

* fix: Use fakeroot for mke2fs

---------

Co-authored-by: Kroese <kroese@users.noreply.github.com>

Dockerfile

@@ -9,11 +9,13 @@ FROM qemux/qemu-host as builder
 
 FROM debian:trixie-slim
 
+ARG TARGETPLATFORM
 ARG DEBCONF_NOWARNINGS="yes"
 ARG DEBIAN_FRONTEND noninteractive
 
-RUN apt-get update && apt-get -y upgrade && \
+RUN apt-get update && apt-get -y upgrade \
-    apt-get --no-install-recommends -y install \
+    && if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
+    && apt-get --no-install-recommends -y install \
         jq \
         tini \
         curl \
@@ -27,11 +29,13 @@ RUN apt-get update && apt-get -y upgrade && \
         iptables \
         iproute2 \
         dnsmasq \
+        fakeroot \        
         net-tools \
         qemu-utils \
         ca-certificates \
         netcat-openbsd \
         qemu-system-x86 \
+        "$extra" \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 

docker-compose.yml

@@ -18,6 +18,6 @@ services:
         ports:
             - 5000:5000
         volumes:
-            - /opt/dsm:/storage
+            - /var/dsm:/storage
         restart: on-failure
         stop_grace_period: 2m

readme.md

@@ -39,7 +39,7 @@ services:
     ports:
       - 5000:5000
     volumes:
-      - /opt/dsm:/storage
+      - /var/dsm:/storage
     restart: on-failure
     stop_grace_period: 2m
 ```
@@ -65,14 +65,14 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
   * ### How do I change the location of the virtual disk?
 
-    To change the virtual disk's location from the default Docker volume, include the following bind mount in your compose file:
+    To change the location of the virtual disk, include the following bind mount in your compose file:
 
     ```yaml
     volumes:
-      - /home/user/data:/storage
+      - /var/dsm:/storage
     ```
 
-    Replace the example path `/home/user/data` with the desired storage folder.
+    Replace the example path `/var/dsm` with the desired storage folder.
 
   * ### How do I add multiple disks?
 
@@ -89,18 +89,23 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
   * ### How do I create a growable disk?
 
-    By default, the entire capacity of the disk is reserved in advance. To create a growable disk that only allocates space that is actually used, add the following environment variable:
+    By default, the entire capacity of the disk is reserved in advance.
+
+    To create a growable disk that only allocates space that is actually used, add the following environment variables:
 
     ```yaml
     environment:
+      ALLOCATE: "N"
       DISK_FMT: "qcow2"
     ```
 
-    This can also be used to convert any existing disks to the ```qcow2``` format.
+    Please note that this may reduce the write performance of the disk.
 
   * ### How do I increase the amount of CPU or RAM?
 
-    By default, a single core and 1 GB of RAM are allocated to the container. To increase this, add the following environment variables:
+    By default, a single core and 1 GB of RAM are allocated to the container.
+
+    To increase this, add the following environment variables:
 
     ```yaml
     environment:
@@ -170,7 +175,7 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
       - 'c *:* rwm'
     ```
 
-    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.
+    Please note that even if you don't want DHCP, it's still recommended to enable this feature as it prevents NAT issues and increases performance by using a `macvtap` interface. In that case just set a static IP from the DSM control panel after you enabled this mode.
 
   * ### How do I passthrough the GPU?
 

src/check.sh

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+: ${VM_NET_DEV:='eth0'}
+
 [ ! -f "/run/qemu.pid" ] && echo "QEMU not running yet.." && exit 0
 [ -f "/run/qemu.count" ] && echo "QEMU is shutting down.." && exit 1
 
@@ -10,7 +12,18 @@ file="/run/dsm.url"
 location=$(cat "$file")
 
 if ! curl -m 20 -ILfSs "http://$location/" > /dev/null; then
-  echo "Failed to reach page at http://$location" && exit 1
+
+  if [[ "$location" == "20.20"* ]]; then
+    ip="20.20.20.1"
+    port="${location##*:}"
+    echo "Failed to reach DSM at port $port"
+  else
+    echo "Failed to reach DSM at http://$location"
+    ip=$(ip address show dev "$VM_NET_DEV" | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
+  fi
+
+  echo "You might need to whitelist IP $ip in the DSM firewall." && exit 1
+
 fi
 
 echo "Healthcheck OK"

src/config.sh

@@ -1,29 +1,9 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -Eeuo pipefail
 
-KVM_ERR=""
-KVM_OPTS=""
-
-if [ -e /dev/kvm ] && sh -c 'echo -n > /dev/kvm' &> /dev/null; then
-  if ! grep -q -e vmx -e svm /proc/cpuinfo; then
-    KVM_ERR="(vmx/svm disabled)"
-  fi
-else
-  [ -e /dev/kvm ] && KVM_ERR="(no write access)" || KVM_ERR="(device file missing)"
-fi
-
-if [ -n "$KVM_ERR" ]; then
-  if [ "$ARCH" == "amd64" ]; then
-    error "KVM acceleration not detected $KVM_ERR, see the FAQ about this."
-    [[ "$DEBUG" != [Yy1]* ]] && exit 88
-  fi
-else
-  KVM_OPTS=",accel=kvm -enable-kvm -cpu host"
-fi
-
 DEF_OPTS="-nographic -nodefaults -boot strict=on -display none"
 RAM_OPTS=$(echo "-m $RAM_SIZE" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
-CPU_OPTS="-smp $CPU_CORES,sockets=1,dies=1,cores=$CPU_CORES,threads=1"
+CPU_OPTS="-cpu $CPU_MODEL -smp $CPU_CORES,sockets=1,dies=1,cores=$CPU_CORES,threads=1"
 MAC_OPTS="-machine type=q35,usb=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
 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"

src/cpu.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Docker environment variables
+
+: ${HOST_CPU:=''}
+: ${CPU_MODEL:='host'}
+: ${CPU_FEATURES:='+ssse3,+sse4.1,+sse4.2'}
+
+KVM_ERR=""
+KVM_OPTS=""
+
+if [[ "$ARCH" == "amd64" && "$KVM" != [Nn]* ]]; then
+
+  if [ -e /dev/kvm ] && sh -c 'echo -n > /dev/kvm' &> /dev/null; then
+    if ! grep -q -e vmx -e svm /proc/cpuinfo; then
+      KVM_ERR="(vmx/svm disabled)"
+    fi
+  else
+    [ -e /dev/kvm ] && KVM_ERR="(no write access)" || KVM_ERR="(device file missing)"
+  fi
+
+  if [ -n "$KVM_ERR" ]; then
+    error "KVM acceleration not detected $KVM_ERR, this will cause a major loss of performance."
+    error "See the FAQ on how to enable it, or skip this error by setting KVM=N (not recommended)."
+    [[ "$DEBUG" != [Yy1]* ]] && exit 88
+    [[ "$CPU_MODEL" == "host"* ]] && CPU_MODEL="max,$CPU_FEATURES"
+  else
+    KVM_OPTS=",accel=kvm -enable-kvm"
+  fi
+
+  if [ -n "$KVM_OPTS" ]; then
+    if ! grep -qE '^flags.* (sse4_2)' /proc/cpuinfo; then
+      error "Your host CPU does not have the SSE4.2 instruction set that Virtual DSM requires to boot."
+      error "Disable KVM by setting KVM=N to emulate a compatible CPU, at the cost of performance."
+      [[ "$DEBUG" != [Yy1]* ]] && exit 89
+    fi
+  fi
+
+else
+
+  [[ "$CPU_MODEL" == "host"* ]] && CPU_MODEL="max,$CPU_FEATURES"
+
+fi
+
+if [ -z "$HOST_CPU" ]; then
+  HOST_CPU=$(lscpu | grep 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+fi
+
+if [ -n "$HOST_CPU" ]; then
+  HOST_CPU="${HOST_CPU%%,*},,"
+else
+  HOST_CPU="QEMU, Virtual CPU,"
+  if [ "$ARCH" == "amd64" ]; then
+    HOST_CPU="$HOST_CPU X86_64"
+  else
+    HOST_CPU="$HOST_CPU $ARCH"
+  fi
+fi
+
+return 0

src/disk.sh

@@ -8,6 +8,7 @@ set -Eeuo pipefail
 : ${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
+: ${DISK_FLAGS:=''}             # Specifies the options for use with the qcow2 disk format
 
 BOOT="$STORAGE/$BASE.boot.img"
 SYSTEM="$STORAGE/$BASE.system.img"
@@ -16,10 +17,11 @@ SYSTEM="$STORAGE/$BASE.system.img"
 [ ! -f "$SYSTEM" ] && error "Virtual DSM system-image does not exist ($SYSTEM)" && exit 82
 
 DISK_OPTS="\
-    -device virtio-scsi-pci,id=hw-synoboot,bus=pcie.0,addr=0xa \
+    -object iothread,id=io1 -object iothread,id=io2 \
+    -device virtio-scsi-pci,id=hw-synoboot,iothread=io1,bus=pcie.0,addr=0xa \
     -drive file=$BOOT,if=none,id=drive-synoboot,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
     -device scsi-hd,bus=hw-synoboot.0,channel=0,scsi-id=0,lun=0,drive=drive-synoboot,id=synoboot0,rotation_rate=$DISK_ROTATION,bootindex=1 \
-    -device virtio-scsi-pci,id=hw-synosys,bus=pcie.0,addr=0xb \
+    -device virtio-scsi-pci,id=hw-synosys,iothread=io1,bus=pcie.0,addr=0xb \
     -drive file=$SYSTEM,if=none,id=drive-synosys,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
     -device scsi-hd,bus=hw-synosys.0,channel=0,scsi-id=0,lun=0,drive=drive-synosys,id=synosys0,rotation_rate=$DISK_ROTATION,bootindex=2"
 
@@ -34,7 +36,7 @@ fmt2ext() {
       echo "img"
       ;;
     *)
-      error "Unrecognized disk format: $DISK_FMT" && exit 88
+      error "Unrecognized disk format: $DISK_FMT" && exit 78
       ;;
   esac
 }
@@ -50,7 +52,7 @@ ext2fmt() {
       echo "raw"
       ;;
     *)
-      error "Unrecognized file extension: .$DISK_EXT" && exit 88
+      error "Unrecognized file extension: .$DISK_EXT" && exit 78
       ;;
   esac
 }
@@ -70,128 +72,230 @@ getSize() {
       qemu-img info "$DISK_FILE" -f "$DISK_FMT" | grep '^virtual size: ' | sed 's/.*(\(.*\) bytes)/\1/'
       ;;
     *)
-      error "Unrecognized disk format: $DISK_FMT" && exit 88
+      error "Unrecognized disk format: $DISK_FMT" && exit 78
       ;;
   esac
 }
 
-resizeDisk() {
-  local DISK_FILE=$1
-  local CUR_SIZE=$2
-  local DATA_SIZE=$3
-  local DISK_SPACE=$4
-  local DISK_DESC=$5
-  local DISK_FMT=$6
-  local GB REQ FAIL SPACE SPACE_GB
-
-  GB=$(( (CUR_SIZE + 1073741823)/1073741824 ))
-  info "Resizing $DISK_DESC from ${GB}G to $DISK_SPACE .."
-  FAIL="Could not resize $DISK_FMT file of $DISK_DESC ($DISK_FILE) from ${GB}G to $DISK_SPACE .."
-
-  REQ=$((DATA_SIZE-CUR_SIZE))
-  (( REQ < 1 )) && error "Shrinking disks is not supported!" && exit 84
-
-  case "${DISK_FMT,,}" in
-    raw)
-      if [[ "$ALLOCATE" == [Nn]* ]]; then
-
-        # Resize file by changing its length
-        if ! truncate -s "$DISK_SPACE" "$DISK_FILE"; then
-          error "$FAIL" && exit 85
-        fi
-
-      else
-
-        # Check free diskspace
-        SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
-        SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-
-        if (( REQ > SPACE )); then
-          error "Not enough free space to resize $DISK_DESC to $DISK_SPACE in $DIR, it has only $SPACE_GB GB available.."
-          error "Please specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation by setting DISK_FMT to \"qcow2\"." && exit 84
-        fi
-
-        # Resize file by allocating more space
-        if ! fallocate -l "$DISK_SPACE" "$DISK_FILE"; then
-          if ! truncate -s "$DISK_SPACE" "$DISK_FILE"; then
-            error "$FAIL" && exit 85
-          fi
-        fi
-
-      fi
-      ;;
-    qcow2)
-      if ! qemu-img resize -f "$DISK_FMT" "$DISK_FILE" "$DISK_SPACE" ; then
-        error "$FAIL" && exit 85
-      fi
-      ;;
-  esac
-}
-
-convertDisk() {
-  local CONV_FLAGS="-p"
-  local SOURCE_FILE=$1
-  local SOURCE_FMT=$2
-  local DST_FILE=$3
-  local DST_FMT=$4
-
-  case "$DST_FMT" in
-    qcow2)
-      CONV_FLAGS="$CONV_FLAGS -c"
-      ;;
-  esac
-
-  # shellcheck disable=SC2086
-  qemu-img convert $CONV_FLAGS -f "$SOURCE_FMT" -O "$DST_FMT" -- "$SOURCE_FILE" "$DST_FILE"
-}
-
 createDisk() {
   local DISK_FILE=$1
   local DISK_SPACE=$2
   local DISK_DESC=$3
   local DISK_FMT=$4
-  local GB FAIL SPACE SPACE_GB
+  local DATA_SIZE DIR SPACE
 
-  FAIL="Could not create a $DISK_SPACE $DISK_FMT file for $DISK_DESC ($DISK_FILE)"
+  DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
+
+  if [[ "$ALLOCATE" != [Nn]* ]]; then
+
+    # Check free diskspace
+    DIR=$(dirname "$DISK_FILE")
+    SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
+
+    if (( DATA_SIZE > SPACE )); then
+      local SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
+      error "Not enough free space to create a $DISK_DESC of $DISK_SPACE in $DIR, it has only $SPACE_GB GB available..."
+      error "Please specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation by setting ALLOCATE=N." && exit 76
+    fi
+  fi
+
+  info "Creating a $DISK_TYPE $DISK_DESC image in $DISK_FMT format with a size of $DISK_SPACE..."
+  local FAIL="Could not create a $DISK_TYPE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
       if [[ "$ALLOCATE" == [Nn]* ]]; then
 
         # Create an empty file
-        if ! truncate -s "$DISK_SPACE" "$DISK_FILE"; then
+        if ! truncate -s "$DATA_SIZE" "$DISK_FILE"; then
           rm -f "$DISK_FILE"
-          error "$FAIL" && exit 87
+          error "$FAIL" && exit 77
         fi
 
       else
 
-        # Check free diskspace
-        SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
-        SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-
-        if (( DATA_SIZE > SPACE )); then
-          error "Not enough free space to create a $DISK_DESC of $DISK_SPACE in $DIR, it has only $SPACE_GB GB available.."
-          error "Please specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation by setting DISK_FMT to \"qcow2\"." && exit 86
-        fi
-
         # Create an empty file
-        if ! fallocate -l "$DISK_SPACE" "$DISK_FILE"; then
+        if ! fallocate -l "$DATA_SIZE" "$DISK_FILE"; then
-          if ! truncate -s "$DISK_SPACE" "$DISK_FILE"; then
+          if ! truncate -s "$DATA_SIZE" "$DISK_FILE"; then
             rm -f "$DISK_FILE"
-            error "$FAIL" && exit 87
+            error "$FAIL" && exit 77
           fi
         fi
 
       fi
       ;;
     qcow2)
-      if ! qemu-img create -f "$DISK_FMT" -- "$DISK_FILE" "$DISK_SPACE" ; then
+      local DISK_OPTS="$DISK_ALLOC"
+      [ -n "$DISK_FLAGS" ] && DISK_OPTS="$DISK_OPTS,$DISK_FLAGS"
+      if ! qemu-img create -f "$DISK_FMT" -o "$DISK_OPTS" -- "$DISK_FILE" "$DATA_SIZE" ; then
         rm -f "$DISK_FILE"
-        error "$FAIL" && exit 89
+        error "$FAIL" && exit 70
       fi
       ;;
   esac
+
+  return 0
+}
+
+resizeDisk() {
+  local DISK_FILE=$1
+  local DISK_SPACE=$2
+  local DISK_DESC=$3
+  local DISK_FMT=$4
+  local CUR_SIZE DATA_SIZE DIR SPACE
+
+  CUR_SIZE=$(getSize "$DISK_FILE")
+  DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
+  local REQ=$((DATA_SIZE-CUR_SIZE))
+  (( REQ < 1 )) && error "Shrinking disks is not supported yet, please increase ${DISK_DESC^^}_SIZE." && exit 71
+
+  if [[ "$ALLOCATE" != [Nn]* ]]; then
+
+    # Check free diskspace
+    DIR=$(dirname "$DISK_FILE")
+    SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
+
+    if (( REQ > SPACE )); then
+      local SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
+      error "Not enough free space to resize $DISK_DESC to $DISK_SPACE in $DIR, it has only $SPACE_GB GB available.."
+      error "Please specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation by setting ALLOCATE=N." && exit 74
+    fi
+  fi
+
+  local GB=$(( (CUR_SIZE + 1073741823)/1073741824 ))
+  info "Resizing $DISK_DESC from ${GB}G to $DISK_SPACE..."
+  local FAIL="Could not resize the $DISK_TYPE $DISK_FMT $DISK_DESC image from ${GB}G to $DISK_SPACE ($DISK_FILE)"
+
+  case "${DISK_FMT,,}" in
+    raw)
+      if [[ "$ALLOCATE" == [Nn]* ]]; then
+
+        # Resize file by changing its length
+        if ! truncate -s "$DATA_SIZE" "$DISK_FILE"; then
+          error "$FAIL" && exit 75
+        fi
+
+      else
+
+        # Resize file by allocating more space
+        if ! fallocate -l "$DATA_SIZE" "$DISK_FILE"; then
+          if ! truncate -s "$DATA_SIZE" "$DISK_FILE"; then
+            error "$FAIL" && exit 75
+          fi
+        fi
+
+      fi
+      ;;
+    qcow2)
+      if ! qemu-img resize -f "$DISK_FMT" "--$DISK_ALLOC" "$DISK_FILE" "$DATA_SIZE" ; then
+        error "$FAIL" && exit 72
+      fi
+      ;;
+  esac
+
+  return 0
+}
+
+convertDisk() {
+  local SOURCE_FILE=$1
+  local SOURCE_FMT=$2
+  local DST_FILE=$3
+  local DST_FMT=$4
+  local DISK_BASE=$5
+  local DISK_DESC=$6
+  local CONV_FLAGS="-p"
+  local DISK_OPTS="$DISK_ALLOC"
+  local TMP_FILE="$DISK_BASE.tmp"
+  local DIR CUR_SIZE SPACE
+
+  [ -f "$DST_FILE" ] && error "Conversion failed, destination file $DST_FILE already exists?" && exit 79
+  [ ! -f "$SOURCE_FILE" ] && error "Conversion failed, source file $SOURCE_FILE does not exists?" && exit 79
+
+  if [[ "$ALLOCATE" != [Nn]* ]]; then
+
+    # Check free diskspace
+    DIR=$(dirname "$TMP_FILE")
+    CUR_SIZE=$(getSize "$SOURCE_FILE")
+    SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
+
+    if (( CUR_SIZE > SPACE )); then
+      local SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
+      error "Not enough free space to convert $DISK_DESC to $DST_FMT in $DIR, it has only $SPACE_GB GB available..."
+      error "Please free up some disk space or disable preallocation by setting ALLOCATE=N." && exit 76
+    fi
+  fi
+
+  info "Converting $DISK_DESC to $DST_FMT, please wait until completed..."
+
+  if [[ "$DST_FMT" != "raw" ]]; then
+      if [[ "$ALLOCATE" == [Nn]* ]]; then
+        CONV_FLAGS="$CONV_FLAGS -c"
+      fi
+      [ -n "$DISK_FLAGS" ] && DISK_OPTS="$DISK_OPTS,$DISK_FLAGS"
+  fi
+
+  rm -f "$TMP_FILE"
+
+  # shellcheck disable=SC2086
+  if ! qemu-img convert -f "$SOURCE_FMT" $CONV_FLAGS -o "$DISK_OPTS" -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
+  fi
+
+  if [[ "$DST_FMT" == "raw" ]]; then
+      if [[ "$ALLOCATE" != [Nn]* ]]; then
+        CUR_SIZE=$(stat -c%s "$TMP_FILE")
+        if ! fallocate -l "$CUR_SIZE" "$TMP_FILE"; then
+            info "Failed to allocate $CUR_SIZE bytes for $TMP_FILE"
+        fi
+      fi
+  fi
+
+  rm -f "$SOURCE_FILE"
+  mv "$TMP_FILE" "$DST_FILE"
+
+  info "Conversion of $DISK_DESC to $DST_FMT completed succesfully!"
+
+  return 0
+}
+
+checkFS () {
+  local DISK_FILE=$1
+  local DIR FS FA
+
+  DIR=$(dirname "$DISK_FILE")
+  [ ! -d "$DIR" ] && return 0
+
+  FS=$(stat -f -c %T "$DIR")
+
+  if [[ "$FS" == "overlay"* ]]; then
+    info "Warning: the filesystem of $DIR is OverlayFS, this usually means it was binded to an invalid path!"
+  fi
+
+  if [[ "$FS" == "xfs" || "$FS" == "zfs" || "$FS" == "btrfs" || "$FS" == "bcachefs" ]]; then
+    local FLAG="nocow"
+    if [[ "$DISK_FLAGS" != *"$FLAG="* ]]; then
+      if [ -z "$DISK_FLAGS" ]; then
+        DISK_FLAGS="$FLAG=on"
+      else
+        DISK_FLAGS="$DISK_FLAGS,$FLAG=on"
+      fi
+    fi
+
+    if [ -f "$DISK_FILE" ] ; then
+      FA=$(lsattr "$DISK_FILE")
+      [[ "$FA" == *"C"* ]] && FA=$(lsattr -d "$DIR")
+    else
+      FA=$(lsattr -d "$DIR")
+    fi
+
+    if [[ "$FA" != *"C"* ]]; then
+      info "Warning: the filesystem of $DIR is ${FS^^}, and COW (copy on write) is not disabled for that folder!"
+      info "This will negatively affect performance, please empty the folder and disable COW (chattr +C <path>)."
+    fi
+  fi
+
+  return 0
 }
 
 addDisk () {
@@ -203,27 +307,27 @@ addDisk () {
   local DISK_INDEX=$6
   local DISK_ADDRESS=$7
   local DISK_FMT=$8
-  local FS DIR CUR_SIZE DATA_SIZE DISK_FILE
+  local DISK_FILE="$DISK_BASE.$DISK_EXT"
+  local DIR DATA_SIZE PREV_FMT PREV_EXT CUR_SIZE
 
-  DISK_FILE="$DISK_BASE.$DISK_EXT"
   DIR=$(dirname "$DISK_FILE")
   [ ! -d "$DIR" ] && return 0
 
-  FS=$(stat -f -c %T "$DIR")
-  if [[ "$FS" == "overlay"* ]]; then
-    info "Warning: the filesystem of $DIR is OverlayFS, this usually means it was binded to an invalid path!"
-  fi
-
   [ -z "$DISK_SPACE" ] && DISK_SPACE="16G"
-  DISK_SPACE=$(echo "$DISK_SPACE" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+  DISK_SPACE=$(echo "${DISK_SPACE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
   DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
 
   if (( DATA_SIZE < 6442450944 )); then
-    error "Please increase ${DISK_DESC^^}_SIZE to at least 6 GB." && exit 83
+    if (( DATA_SIZE < 1 )); then
+      error "Invalid value for ${DISK_DESC^^}_SIZE: $DISK_SPACE" && exit 73
+    else
+      error "Please increase ${DISK_DESC^^}_SIZE to at least 6 GB." && exit 73
+    fi
   fi
 
+  checkFS "$DISK_FILE" || exit $?
+
   if ! [ -f "$DISK_FILE" ] ; then
-    local PREV_EXT PREV_FMT PREV_FILE TMP_FILE
 
     if [[ "${DISK_FMT,,}" != "raw" ]]; then
       PREV_FMT="raw"
@@ -231,24 +335,9 @@ addDisk () {
       PREV_FMT="qcow2"
     fi
     PREV_EXT="$(fmt2ext "$PREV_FMT")"
-    PREV_FILE="$DISK_BASE.$PREV_EXT"
 
-    if [ -f "$PREV_FILE" ] ; then
+    if [ -f "$DISK_BASE.$PREV_EXT" ] ; then
-
+      convertDisk "$DISK_BASE.$PREV_EXT" "$PREV_FMT" "$DISK_FILE" "$DISK_FMT" "$DISK_BASE" "$DISK_DESC" || exit $?
-      info "Detected that ${DISK_DESC^^}_FMT changed from \"$PREV_FMT\" to \"$DISK_FMT\"."
-      info "Starting conversion of $DISK_DESC to this new format, please wait until completed..."
-
-      TMP_FILE="$DISK_BASE.tmp"
-      rm -f "$TMP_FILE"
-
-      if ! convertDisk "$PREV_FILE" "$PREV_FMT" "$TMP_FILE" "$DISK_FMT" ; then
-        rm -f "$TMP_FILE"
-        error "Failed to convert $DISK_DESC to $DISK_FMT format." && exit 89
-      fi
-
-      mv "$TMP_FILE" "$DISK_FILE"
-      rm -f "$PREV_FILE"
-      info "Conversion of $DISK_DESC completed succesfully!"
     fi
   fi
 
@@ -256,8 +345,8 @@ addDisk () {
 
     CUR_SIZE=$(getSize "$DISK_FILE")
 
-    if [ "$DATA_SIZE" -gt "$CUR_SIZE" ]; then
+    if (( DATA_SIZE > CUR_SIZE )); then
-      resizeDisk "$DISK_FILE" "$CUR_SIZE" "$DATA_SIZE" "$DISK_SPACE" "$DISK_DESC" "$DISK_FMT" || exit $?
+      resizeDisk "$DISK_FILE" "$DISK_SPACE" "$DISK_DESC" "$DISK_FMT" || exit $?
     fi
 
   else
@@ -267,7 +356,7 @@ addDisk () {
   fi
 
   DISK_OPTS="$DISK_OPTS \
-    -device virtio-scsi-pci,id=hw-$DISK_ID,bus=pcie.0,addr=$DISK_ADDRESS \
+    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
     -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 \
     -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"
 
@@ -276,6 +365,14 @@ addDisk () {
 
 DISK_EXT="$(fmt2ext "$DISK_FMT")" || exit $?
 
+if [[ "$ALLOCATE" == [Nn]* ]]; then
+  DISK_TYPE="growable"
+  DISK_ALLOC="preallocation=off"
+else
+  DISK_TYPE="preallocated"
+  DISK_ALLOC="preallocation=falloc"
+fi
+
 DISK1_FILE="$STORAGE/data"
 if [[ ! -f "$DISK1_FILE.img" ]] && [[ -f "$STORAGE/data${DISK_SIZE}.img" ]]; then
   # Fallback for legacy installs
@@ -336,7 +433,7 @@ addDevice () {
   [ ! -b "$DISK_DEV" ] && error "Device $DISK_DEV cannot be found! Please add it to the 'devices' section of your compose file." && exit 55
 
   DISK_OPTS="$DISK_OPTS \
-    -device virtio-scsi-pci,id=hw-$DISK_ID,bus=pcie.0,addr=$DISK_ADDRESS \
+    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
     -drive file=$DISK_DEV,if=none,id=drive-$DISK_ID,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
     -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"
 

src/entry.sh

@@ -11,6 +11,7 @@ cd /run
 . disk.sh       # Initialize disks
 . network.sh    # Initialize network
 . gpu.sh        # Initialize graphics
+. cpu.sh        # Initialize processor
 . serial.sh     # Initialize serialport
 . power.sh      # Configure shutdown
 . config.sh     # Configure arguments

src/gpu.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -Eeuo pipefail
 
 if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then

src/install.sh

@@ -2,7 +2,6 @@
 set -Eeuo pipefail
 
 : ${URL:=''}    # URL of the PAT file to be downloaded.
-: ${DEV:='Y'}   # Controls whether device nodes are created.
 
 if [ -f "$STORAGE"/dsm.ver ]; then
   BASE=$(cat "$STORAGE/dsm.ver")
@@ -33,13 +32,7 @@ if [ -z "$DL" ]; then
   [[ "${COUNTRY^^}" == "CN" ]] && DL="$DL_CHINA" || DL="$DL_GLOBAL"
 fi
 
-if [ -z "$URL" ]; then
+[ -z "$URL" ] && URL="$DL/release/7.2.1/69057-1/DSM_VirtualDSM_69057.pat"
-  if [ "$ARCH" == "amd64" ]; then
-    URL="$DL/release/7.2.1/69057-1/DSM_VirtualDSM_69057.pat"
-  else
-    URL="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
-  fi
-fi
 
 BASE=$(basename "$URL" .pat)
 
@@ -61,6 +54,13 @@ FS=$(stat -f -c %T "$STORAGE")
 if [[ "$FS" == "overlay"* ]]; then
   info "Warning: the filesystem of $STORAGE is OverlayFS, this usually means it was binded to an invalid path!"
 fi
+if [[ "$FS" == "xfs" || "$FS" == "zfs" || "$FS" == "btrfs" || "$FS" == "bcachefs" ]]; then
+  FA=$(lsattr -d "$STORAGE")
+  if [[ "$FA" != *"C"* ]]; then
+    info "Warning: the filesystem of $STORAGE is ${FS^^}, and COW (copy on write) is not disabled for that folder!"
+    info "This will negatively affect performance, please empty the folder and disable COW (chattr +C <path>)."
+  fi
+fi
 
 if [[ "$FS" != "fat"* && "$FS" != "vfat"* && "$FS" != "exfat"* && \
         "$FS" != "ntfs"* && "$FS" != "fuse"* && "$FS" != "msdos"* ]]; then
@@ -99,6 +99,7 @@ fi
 
 # Download the required files from the Synology website
 
+ROOT="Y"
 RDC="$STORAGE/dsm.rd"
 
 if [ ! -f "$RDC" ]; then
@@ -138,14 +139,12 @@ if [ -f "$RDC" ]; then
   { xz -dc <"$RDC" >"$TMP/rd" 2>/dev/null; rc=$?; } || :
   (( rc != 1 )) && error "Failed to unxz $RDC, reason $rc" && exit 91
 
-  if [[ "$DEV" == [Nn]* ]]; then
-    # Exclude dev/ from cpio extract
-    { (cd "$TMP" && cpio -it < "$TMP/rd" | grep -Ev 'dev/' | while read -r entry; do cpio -idm "$entry" < "$TMP/rd" 2>/dev/null; done); rc=$?; } || :
-    (( rc != 0 )) && error "Failed to extract $RDC, reason $rc" && exit 92
-  else
   { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-    (( rc != 0 )) && error "Failed to extract $RDC, reason $rc"
+
-    (( rc != 0 )) && error "If the container runs unprivileged, please set DEV=N to exclude device nodes." && exit 92
+  if (( rc != 0 )); then
+    ROOT="N"
+    { (cd "$TMP" && fakeroot cpio -idmu <"$TMP/rd" 2>/dev/null); rc=$?; } || :
+    (( rc != 0 )) && error "Failed to extract $RDC, reason $rc" && exit 92
   fi
 
   mkdir -p /run/extract
@@ -198,17 +197,14 @@ 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
 
-  [ "$ARCH" != "amd64" ] && addPackage "qemu-user" "QEMU"
-
-  info "Install: Extracting downloaded image..."
-
   export LD_LIBRARY_PATH="/run/extract"
 
   if [ "$ARCH" == "amd64" ]; then
@@ -242,16 +238,16 @@ SYSTEM_SIZE=4954537983
 # Check free diskspace
 SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
 SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-(( SYSTEM_SIZE > SPACE )) && error "Not enough free space to create a 4 GB system disk, have only $SPACE_GB GB available." && exit 87
+(( SYSTEM_SIZE > SPACE )) && error "Not enough free space to create a 4 GB system disk, have only $SPACE_GB GB available." && exit 97
 
 if ! fallocate -l "$SYSTEM_SIZE" "$SYSTEM"; then
   if ! truncate -s "$SYSTEM_SIZE" "$SYSTEM"; then
-    rm -f "$SYSTEM" && error "Could not allocate a file for the system disk." && exit 88
+    rm -f "$SYSTEM" && error "Could not allocate a file for the system disk." && exit 98
   fi
 fi
 
 # Check if file exists
-[ ! -f "$SYSTEM" ] && error "System disk does not exist ($SYSTEM)" && exit 89
+[ ! -f "$SYSTEM" ] && error "System disk does not exist ($SYSTEM)" && exit 99
 
 # Check the filesize
 SIZE=$(stat -c%s "$SYSTEM")
@@ -273,32 +269,47 @@ sfdisk -q "$SYSTEM" < "$PART"
 
 info "Install: Extracting system partition..."
 
+LABEL="1.44.1-42218"
+OFFSET="1048576" # 2048 * 512
+NUMBLOCKS="622560" # (4980480 * 512) / 4096
+
 MOUNT="$TMP/system"
 rm -rf "$MOUNT" && mkdir -p "$MOUNT"
 
 mv "$HDA.tgz" "$HDA.txz"
 
-if [[ "$DEV" == [Nn]* ]]; then
+if [[ "$ROOT" != [Nn]* ]]; then
-  # Exclude dev/ from tar extract
+
-  tar xpfJ "$HDA.txz" --absolute-names --exclude="dev" -C "$MOUNT/"
-else
   tar xpfJ "$HDA.txz" --absolute-names -C "$MOUNT/"
+
 fi
 
 [ -d "$PKG" ] && mv "$PKG/" "$MOUNT/.SynoUpgradePackages/"
 rm -f "$MOUNT/.SynoUpgradePackages/ActiveInsight-"*
 
 [ -f "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
-[ -f "$IDB.txz" ] && tar xpfJ "$IDB.txz" --absolute-names -C "$MOUNT/usr/syno/synoman/indexdb/"
+
+if [ -f "$IDB.txz" ]; then
+  INDEX_DB="$MOUNT/usr/syno/synoman/indexdb/"
+  mkdir -p "$INDEX_DB"
+  tar xpfJ "$IDB.txz" --absolute-names -C "$INDEX_DB"
+fi
+
+if [[ "$ROOT" != [Nn]* ]]; then
 
   info "Install: Installing system partition..."
 
-LABEL="1.44.1-42218"
-OFFSET="1048576" # 2048 * 512
-NUMBLOCKS="622560" # (4980480 * 512) / 4096
-
   mke2fs -q -t ext4 -b 4096 -d "$MOUNT/" -L "$LABEL" -F -E "offset=$OFFSET" "$SYSTEM" "$NUMBLOCKS"
 
+else
+
+  fakeroot -- bash -c "set -Eeu;\
+        tar xpfJ $HDA.txz --absolute-names --skip-old-files -C $MOUNT/;\
+        printf '%b%s%b' '\E[1;34m❯ \E[1;36m' 'Install: Installing system partition...' '\E[0m\n';\
+        mke2fs -q -t ext4 -b 4096 -d $MOUNT/ -L $LABEL -F -E offset=$OFFSET $SYSTEM $NUMBLOCKS"
+
+fi
+
 rm -rf "$MOUNT"
 
 echo "$BASE" > "$STORAGE"/dsm.ver

src/network.sh

@@ -187,7 +187,7 @@ if [ ! -c /dev/net/tun ]; then
   chmod 666 /dev/net/tun
 fi
 
-[ ! -c /dev/net/tun ] && error "TUN network interface not available..." && exit 85
+[ ! -c /dev/net/tun ] && error "TUN network interface not available..." && exit 25
 
 # Create the necessary file structure for /dev/vhost-net
 if [ ! -c /dev/vhost-net ]; then
@@ -212,7 +212,7 @@ if [[ "$DHCP" == [Yy1]* ]]; then
     if [[ "$DEBUG" == [Yy1]* ]]; then
       info "Warning: Are you sure the container is on a macvlan network?"
     else
-      error "You can only enable DHCP while the container is on a macvlan network!" && exit 86
+      error "You can only enable DHCP while the container is on a macvlan network!" && exit 26
     fi
   fi
 

src/power.sh

@@ -4,9 +4,9 @@ set -Eeuo pipefail
 # Configure QEMU for graceful shutdown
 
 QEMU_PORT=7100
-QEMU_TIMEOUT=50
+QEMU_TIMEOUT=55
-QEMU_PID=/run/qemu.pid
+QEMU_PID="/run/qemu.pid"
-QEMU_COUNT=/run/qemu.count
+QEMU_COUNT="/run/qemu.count"
 
 rm -f "$QEMU_PID"
 rm -f "$QEMU_COUNT"
@@ -52,22 +52,25 @@ _graceful_shutdown() {
 
   while [ "$(cat $QEMU_COUNT)" -lt "$QEMU_TIMEOUT" ]; do
 
-    # Increase the counter
-    echo $(($(cat $QEMU_COUNT)+1)) > "$QEMU_COUNT"
-
     # Try to connect to qemu
-    if echo 'info version'| nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 ; then
+    if ! echo 'info version'| nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 ; then
-
+      break
-      sleep 1
-
-      cnt="$(cat $QEMU_COUNT)/$QEMU_TIMEOUT"
-      [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt)"
-
     fi
 
+    # Increase the counter
+    cnt=$(($(cat $QEMU_COUNT)+1))
+    echo $cnt > "$QEMU_COUNT"
+
+    [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt/$QEMU_TIMEOUT)"
+
   done
 
+  if [ "$(cat $QEMU_COUNT)" -ge "$QEMU_TIMEOUT" ]; then
+    echo && error "Shutdown timeout reached, forcefully quitting.."
+  else
     echo && echo "❯ Quitting..."
+  fi
+
   echo 'quit' | nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 || true
 
   { pkill -f print.sh || true; } 2>/dev/null

src/print.sh

@@ -1,12 +1,16 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+: ${DHCP:='N'}
+: ${VM_NET_DEV:='eth0'}
+
 info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n" >&2; }
 error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
 
 file="/run/dsm.url"
 shutdown="/run/qemu.count"
 url="http://127.0.0.1:2210/read?command=10"
+
 resp_err="Guest returned an invalid response:"
 jq_err="Failed to parse response from guest: jq error"
 
@@ -19,11 +23,9 @@ do
   sleep 3
 
   [ -f "$shutdown" ] && exit 1
-
-  # Healthcheck may have intervened
   [ -f "$file" ] && break
 
-  # Retrieve IP from guest VM
+  # Retrieve network info from guest VM
   { json=$(curl -m 20 -sk "$url"); rc=$?; } || :
 
   [ -f "$shutdown" ] && exit 1
@@ -46,7 +48,11 @@ do
   { ip=$(echo "$json" | jq -r '.data.data.ip.data[] | select((.name=="eth0") and has("ip")).ip'); rc=$?; } || :
   (( rc != 0 )) && error "$jq_err $rc ( $json )" && continue
   [[ "$ip" == "null" ]] && error "$resp_err $json" && continue
-  [ -z "$ip" ] && continue
+
+  if [ -z "$ip" ]; then
+    [[ "$DHCP" == [Yy1]* ]] && continue
+    ip="20.20.20.21"
+  fi
 
   echo "$ip:$port" > $file
 
@@ -62,7 +68,7 @@ if [[ "$location" != "20.20"* ]]; then
 
 else
 
-  ip=$(ip address show dev eth0 | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
+  ip=$(ip address show dev "$VM_NET_DEV" | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
   port="${location##*:}"
 
   if [[ "$ip" == "172."* ]]; then

src/reset.sh

@@ -11,10 +11,11 @@ trap 'error "Status $? while: $BASH_COMMAND (line $LINENO/$BASH_LINENO)"' ERR
 
 # Docker environment variables
 
-: ${GPU:='N'}           # Enable GPU passthrough
+: ${GPU:='N'}           # Disable GPU passthrough
-: ${DEBUG:='N'}         # Enable debugging mode
+: ${KVM:='Y'}           # Enable KVM acceleration
+: ${DEBUG:='N'}         # Disable debugging mode
 : ${COUNTRY:=''}        # Country code for mirror
-: ${CONSOLE:='N'}       # Start in console mode
+: ${CONSOLE:='N'}       # Disable console mode
 : ${ALLOCATE:='Y'}      # Preallocate diskspace
 : ${ARGUMENTS:=''}      # Extra QEMU parameters
 : ${CPU_CORES:='1'}     # Amount of CPU cores
@@ -42,6 +43,7 @@ rm -f /run/qemu.count
 # Cleanup dirs
 
 rm -rf /tmp/dsm
+rm -f /tmp/server.*
 rm -rf "$STORAGE/tmp"
 
 # Helper functions

src/serial.sh

@@ -1,29 +1,14 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${HOST_CPU:=''}
 : ${HOST_MAC:=''}
 : ${HOST_DEBUG:=''}
 : ${HOST_SERIAL:=''}
 : ${HOST_MODEL:=''}
 : ${GUEST_SERIAL:=''}
 
-if [ -z "$HOST_CPU" ]; then
-  HOST_CPU=$(lscpu | grep 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
-fi
-
-if [ -n "$HOST_CPU" ]; then
-  HOST_CPU="$HOST_CPU,,"
-else
-  if [ "$ARCH" == "amd64" ]; then
-    HOST_CPU="QEMU, Virtual CPU, X86_64"
-  else
-    HOST_CPU="QEMU, Virtual CPU, $ARCH"
-  fi
-fi
-
 HOST_ARGS=()
 HOST_ARGS+=("-cpu=$CPU_CORES")
 HOST_ARGS+=("-cpu_arch=$HOST_CPU")