feat: Detect clock source (#923)

.github/workflows/build.yml

@@ -54,7 +54,7 @@ jobs:
           labels: |
             org.opencontainers.image.title=${{ vars.NAME }}
         env:
-          DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest        
+          DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index
       - 
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
@@ -78,7 +78,7 @@ jobs:
           context: .
           push: true
           provenance: false
-          platforms: linux/amd64
+          platforms: linux/amd64,linux/arm64
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           annotations: ${{ steps.meta.outputs.annotations }}

Dockerfile

@@ -35,12 +35,16 @@ RUN set -eu && extra="" && \
         dnsmasq \
         fakeroot \
         net-tools \
+        e2fsprogs \
         qemu-utils \
+        iputils-ping \
         ca-certificates \
         netcat-openbsd \
         qemu-system-x86 \
         "$extra" && \
     apt-get clean && \
+    mkdir -p /etc/qemu && \
+    echo "allow br0" > /etc/qemu/bridge.conf && \
     unlink /etc/nginx/sites-enabled/default && \
     sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf && \
     echo "$VERSION_ARG" > /run/version && \
@@ -49,7 +53,7 @@ RUN set -eu && extra="" && \
 COPY --chmod=755 ./src /run/
 COPY --chmod=755 ./web /var/www/
 COPY --chmod=755 --from=builder /qemu-host.bin /run/host.bin
-COPY --chmod=744 ./web/nginx.conf /etc/nginx/sites-enabled/web.conf
+COPY --chmod=744 ./web/conf/nginx.conf /etc/nginx/sites-enabled/web.conf
 
 VOLUME /storage
 EXPOSE 22 139 445 5000

compose.yml

@@ -1,16 +1,17 @@
 services:
-    dsm:
+  dsm:
-        container_name: dsm
+    container_name: dsm
-        image: vdsm/virtual-dsm:latest
+    image: vdsm/virtual-dsm
-        environment:
+    environment:
-            DISK_SIZE: "16G"
+      DISK_SIZE: "16G"
-        devices:
+    devices:
-            - /dev/kvm
+      - /dev/kvm
-            - /dev/net/tun
+      - /dev/net/tun
-        cap_add:
+    cap_add:
-            - NET_ADMIN
+      - NET_ADMIN
-        ports:
+    ports:
-            - 5000:5000
+      - 5000:5000
-        volumes:
+    volumes:
-            - /var/dsm:/storage
+      - ./dsm:/storage
-        stop_grace_period: 2m
+    restart: always
+    stop_grace_period: 2m

kubernetes.yml

@@ -10,58 +10,68 @@ spec:
     requests:
       storage: 16Gi
 ---
-apiVersion: v1
+apiVersion: apps/v1
-kind: Pod
+kind: Deployment
 metadata:
   name: dsm
   labels:
     name: dsm
 spec:
-  containers:
+  replicas: 1
-  - name: dsm
+  selector:
-    image: vdsm/virtual-dsm
+    matchLabels:
-    env:
+      app: dsm
-    - name: RAM_SIZE
+  template:
-      value: "1G"
+    metadata:
-    - name: CPU_CORES
+      labels:
-      value: "1"
+        app: dsm
-    - name: DISK_SIZE
+    spec:
-      value: "16G"
+      containers:
-    ports:
+      - name: dsm
-    - containerPort: 5000
+        image: vdsm/virtual-dsm
-    securityContext:
+        env:
-      capabilities:
+        - name: DISK_SIZE
-        add:
+          value: "16G"
-        - NET_ADMIN
+        ports:
-      privileged: true
+          - containerPort: 5000
-    volumeMounts:
+            name: http
-    - mountPath: /storage
+            protocol: TCP
-      name: storage
+        securityContext:
-    - mountPath: /dev/kvm
+          capabilities:
-      name: dev-kvm
+            add:
-    - mountPath: /dev/net/tun
+            - NET_ADMIN
-      name: dev-tun
+          privileged: true
-  terminationGracePeriodSeconds: 120
+        volumeMounts:
-  volumes:
+        - mountPath: /storage
-  - name: storage
+          name: storage
-    persistentVolumeClaim:
+        - mountPath: /dev/kvm
-      claimName: dsm-pvc
+          name: dev-kvm
-  - hostPath:
+        - mountPath: /dev/net/tun
-      path: /dev/kvm
+          name: dev-tun
-    name: dev-kvm
+      terminationGracePeriodSeconds: 120
-  - hostPath:
+      volumes:
-      path: /dev/net/tun
+      - name: storage
-      type: CharDevice
+        persistentVolumeClaim:
-    name: dev-tun
+          claimName: dsm-pvc
+      - hostPath:
+          path: /dev/kvm
+        name: dev-kvm
+      - hostPath:
+          path: /dev/net/tun
+          type: CharDevice
+        name: dev-tun
 ---
 apiVersion: v1
 kind: Service
 metadata:
   name: dsm
 spec:
+  internalTrafficPolicy: Cluster
   ports:
-  - name: tcp-5000
+    - name: http
-    port: 5000
+      port: 5000
+      protocol: TCP
+      targetPort: 5000
   selector:
-    name: dsm
+    app: dsm
-  type: NodePort
+  type: ClusterIP

readme.md

@@ -39,14 +39,15 @@ services:
     ports:
       - 5000:5000
     volumes:
-      - /var/dsm:/storage
+      - ./dsm:/storage
+    restart: always
     stop_grace_period: 2m
 ```
 
 Via Docker CLI:
 
 ```bash
-docker run -it --rm -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
+docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v ${PWD:-.}/dsm:/storage --stop-timeout 120 vdsm/virtual-dsm
 ```
 
 Via Kubernetes:
@@ -83,10 +84,10 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   ```yaml
   volumes:
-    - /var/dsm:/storage
+    - ./dsm:/storage
   ```
 
-  Replace the example path `/var/dsm` with the desired storage folder.
+  Replace the example path `./dsm` with the desired storage folder or named volume.
  
 ### How do I change the size of the disk?
 
@@ -111,9 +112,6 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     DISK_FMT: "qcow2"
   ```
 
-> [!NOTE]
-> This may reduce the write performance of the disk.
-
 ### How do I add multiple disks?
 
   To create additional disks, modify your compose file like this:
@@ -123,8 +121,8 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     DISK2_SIZE: "32G"
     DISK3_SIZE: "64G"
   volumes:
-    - /home/example:/storage2
+    - ./example2:/storage2
-    - /mnt/data/example:/storage3
+    - ./example3:/storage3
   ```
 
 ### How do I pass-through a disk?
@@ -222,7 +220,7 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   After configuring the container for [macvlan](#how-do-i-assign-an-individual-ip-address-to-the-container), it is possible for DSM to become part of your home network by requesting an IP from your router, just like your other devices.
 
-  To enable this mode, add the following lines to your compose file:
+  To enable this mode, in which the container and DSM will have separate IP addresses, add the following lines to your compose file:
 
   ```yaml
   environment:
@@ -233,9 +231,6 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     - 'c *:* rwm'
   ```
 
-> [!NOTE]
-> In this mode, the container and DSM will each have their own separate IPs.
-
 ### How do I pass-through the GPU?
 
   To pass-through your Intel GPU, add the following lines to your compose file:
@@ -247,19 +242,19 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     - /dev/dri
   ```
 
-> [!TIP]
+> [!NOTE]
-> This can be used to enable the facial recognition function in Synology Photos for example.
+> This can be used to enable the facial recognition function in Synology Photos, but does not provide hardware transcoding for video.
 
 ### How do I install a specific version of vDSM?
 
-  By default, version 7.2 will be installed, but if you prefer an older version, you can add its download URL to your compose file as follows:
+  By default, version 7.2 will be installed, but if you prefer an older version, you can add the download URL of the `.pat` file to your compose file as follows:
 
   ```yaml
   environment:
     URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
   ```
 
-  With this method, it is even possible to switch between different versions while keeping all your file data intact.
+  With this method, it is even possible to switch back and forth between versions while keeping your file data intact.
 
   If you don't have internet access, it's also possible to skip the download by setting URL to:
 
@@ -268,7 +263,7 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     URL: "DSM_VirtualDSM_42218.pat"
   ```
 
-  after placing a file called `DSM_VirtualDSM_42218.pat` in your `/storage` folder.
+  after placing a copy of [DSM_VirtualDSM_42218.pat](https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat) in the root of your `/storage` folder.
 
 ### What are the differences compared to the standard DSM?
 

src/disk.sh

@@ -427,12 +427,13 @@ addDisk () {
   [ -z "$DISK_SPACE" ] && DISK_SPACE="16G"
   DISK_SPACE=$(echo "${DISK_SPACE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
   [[ -z "${DISK_SPACE//[0-9]}" ]] && DISK_SPACE="${DISK_SPACE}G"
-  DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
 
-  if (( DATA_SIZE < 1 )); then
+  if ! numfmt --from=iec "$DISK_SPACE" &>/dev/null; then
     error "Invalid value for ${DISK_DESC^^}_SIZE: $DISK_SPACE" && exit 73
   fi
 
+  DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
+
   if (( DATA_SIZE < 6442450944 )); then
     error "Please increase ${DISK_DESC^^}_SIZE to at least 6 GB." && exit 73
   fi

src/entry.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-APP="Virtual DSM"
+: "${APP:="Virtual DSM"}"
-SUPPORT="https://github.com/vdsm/virtual-dsm"
+: "${SUPPORT:="https://github.com/vdsm/virtual-dsm"}"
 
 cd /run
 

src/network.sh

@@ -4,6 +4,7 @@ set -Eeuo pipefail
 # Docker environment variables
 
 : "${MAC:=""}"
+: "${MTU:=""}"
 : "${DHCP:="N"}"
 : "${NETWORK:="Y"}"
 : "${USER_PORTS:=""}"
@@ -58,6 +59,12 @@ configureDHCP() {
       fi ;;
   esac
 
+  if [[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]]; then
+    if ! ip link set dev "$VM_NET_TAP" mtu "$MTU"; then
+      warn "Failed to set MTU size.."
+    fi
+  fi
+
   while ! ip link set "$VM_NET_TAP" up; do
     info "Waiting for MAC address $VM_NET_MAC to become available..."
     sleep 2
@@ -192,7 +199,6 @@ configureNAT() {
   fi
 
   # Create a bridge with a static IP for the VM guest
-
   { ip link add dev dockerbridge type bridge ; rc=$?; } || :
 
   if (( rc != 0 )); then
@@ -213,6 +219,18 @@ configureNAT() {
     error "$tuntap" && return 1
   fi
 
+  if [[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]]; then
+    if ! ip link set dev "$VM_NET_TAP" mtu "$MTU"; then
+      warn "Failed to set MTU size.."
+    fi
+  fi
+
+  GATEWAY_MAC=$(echo "$VM_NET_MAC" | md5sum | sed 's/^\(..\)\(..\)\(..\)\(..\)\(..\).*$/02:\1:\2:\3:\4:\5/')
+
+  if ! ip link set dev "$VM_NET_TAP" address "$GATEWAY_MAC"; then
+    warn "Failed to set gateway MAC address.."
+  fi
+
   while ! ip link set "$VM_NET_TAP" up promisc on; do
     info "Waiting for TAP to become available..."
     sleep 2
@@ -260,6 +278,22 @@ configureNAT() {
   return 0
 }
 
+closeBridge() {
+
+  local pid="/var/run/dnsmasq.pid"
+  [ -s "$pid" ] && pKill "$(<"$pid")"
+
+  [[ "${NETWORK,,}" == "user"* ]] && return 0
+
+  ip link set "$VM_NET_TAP" down promisc off &> null || true
+  ip link delete "$VM_NET_TAP" &> null || true
+
+  ip link set dockerbridge down &> null || true
+  ip link delete dockerbridge &> null || true
+
+  return 0
+}
+
 closeNetwork() {
 
   if [[ "$DHCP" == [Yy1]* ]]; then
@@ -275,26 +309,16 @@ closeNetwork() {
   exec 30<&- || true
   exec 40<&- || true
 
-  if [[ "$DHCP" == [Yy1]* ]]; then
+  if [[ "$DHCP" != [Yy1]* ]]; then
 
-    ip link set "$VM_NET_TAP" down || true
+    closeBridge
-    ip link delete "$VM_NET_TAP" || true
+    return 0
-
-  else
-
-    local pid="/var/run/dnsmasq.pid"
-    [ -s "$pid" ] && pKill "$(<"$pid")"
-
-    [[ "${NETWORK,,}" == "user"* ]] && return 0
-
-    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
 
+  ip link set "$VM_NET_TAP" down || true
+  ip link delete "$VM_NET_TAP" || true
+
   return 0
 }
 
@@ -338,6 +362,20 @@ getInfo() {
     error "$ADD_ERR -e \"VM_NET_DEV=NAME\" to specify another interface name." && exit 27
   fi
 
+  if [ -z "$MTU" ]; then
+    MTU=$(cat "/sys/class/net/$VM_NET_DEV/mtu")
+  fi
+
+  if [ "$MTU" -gt "1500" ]; then
+    info "MTU size is too large: $MTU, ignoring..." && MTU="0"
+  fi
+
+  if [[ "${ADAPTER,,}" != "virtio-net-pci" ]]; then
+    if [[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]]; then
+      warn "MTU size is $MTU, but cannot be set for $ADAPTER adapters!" && MTU="0"
+    fi
+  fi
+
   if [ -z "$VM_NET_MAC" ]; then
     local file="$STORAGE/dsm.mac"
     [ -s "$file" ] && VM_NET_MAC=$(<"$file")
@@ -380,7 +418,10 @@ getInfo
 html "Initializing network..."
 
 if [[ "$DEBUG" == [Yy1]* ]]; then
-  info "Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC"
+  mtu=$(cat "/sys/class/net/$VM_NET_DEV/mtu")
+  line="Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC  MTU: $mtu"
+  [[ "$MTU" != "0" ]] && [[ "$MTU" != "$mtu" ]] && line+=" ($MTU)"
+  info "$line"
   [ -f /etc/resolv.conf ] && grep '^nameserver*' /etc/resolv.conf
   echo
 fi
@@ -389,6 +430,11 @@ if [[ "$IP" == "172.17."* ]]; then
   warn "your container IP starts with 172.17.* which will cause conflicts when you install the Container Manager package inside DSM!"
 fi
 
+if [[ -d "/sys/class/net/$VM_NET_TAP" ]]; then
+    info "Lingering interface will be removed..."
+    ip link delete "$VM_NET_TAP" || true
+fi
+
 if [[ "$DHCP" == [Yy1]* ]]; then
 
   checkOS
@@ -418,15 +464,10 @@ else
     # Configure for tap interface
     if ! configureNAT; then
 
+      closeBridge
       NETWORK="user"
       warn "falling back to usermode networking! Performance will be bad and port mapping will not work."
 
-      ip link set "$VM_NET_TAP" down promisc off &> null || true
-      ip link delete "$VM_NET_TAP" &> null || true
-
-      ip link set dockerbridge down &> null || true
-      ip link delete dockerbridge &> null || true
-
     fi
 
   fi
@@ -440,6 +481,7 @@ else
 
 fi
 
-NET_OPTS+=" -device $ADAPTER,romfile=,netdev=hostnet0,mac=$VM_NET_MAC,id=net0"
+NET_OPTS+=" -device $ADAPTER,id=net0,netdev=hostnet0,romfile=,mac=$VM_NET_MAC"
+[[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]] && NET_OPTS+=",host_mtu=$MTU"
 
 return 0

src/proc.sh

@@ -9,6 +9,23 @@ set -Eeuo pipefail
 : "${CPU_MODEL:=""}"
 : "${DEF_MODEL:="qemu64"}"
 
+CLOCKSOURCE="tsc"
+[[ "${ARCH,,}" == "arm64" ]] && CLOCKSOURCE="arch_sys_counter"
+CLOCK="/sys/devices/system/clocksource/clocksource0/current_clocksource"
+
+if [ ! -f "$CLOCK" ]; then
+  warn "file \"$CLOCK\" cannot not found?"
+else
+  result=$(<"$CLOCK")
+  case "${result,,}" in
+    "${CLOCKSOURCE,,}" ) ;;
+    "kvm-clock" ) info "Nested KVM virtualization detected.." ;;
+    "hyperv_clocksource_tsc_page" ) info "Nested Hyper-V virtualization detected.." ;;
+    "hpet" ) warn "unsupported clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'" ;;
+    *) warn "unexpected clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'" ;;
+  esac
+fi
+
 if [[ "${ARCH,,}" != "amd64" ]]; then
   KVM="N"
   warn "your CPU architecture is ${ARCH^^} and cannot provide KVM acceleration for x64 instructions, this will cause a major loss of performance."
@@ -47,7 +64,6 @@ fi
 if [[ "$KVM" != [Nn]* ]]; then
 
   CPU_FEATURES="kvm=on,l3-cache=on,+hypervisor"
-  CLOCK="/sys/devices/system/clocksource/clocksource0/current_clocksource"
   KVM_OPTS=",accel=kvm -enable-kvm -global kvm-pit.lost_tick_policy=discard"
 
   if ! grep -qw "sse4_2" <<< "$flags"; then
@@ -61,15 +77,6 @@ if [[ "$KVM" != [Nn]* ]]; then
     CPU_FEATURES+=",migratable=no"
   fi
 
-  if [ -f "$CLOCK" ]; then
-    CLOCK=$(<"$CLOCK")
-    if [[ "${CLOCK,,}" != "tsc" ]]; then
-      warn "unexpected clocksource: $CLOCK"
-    fi
-  else
-    warn "file \"$CLOCK\" cannot not found?"
-  fi
-
   if grep -qw "svm" <<< "$flags"; then
 
     # AMD processor
@@ -127,7 +134,7 @@ else
 fi
 
 if [ -z "$HOST_CPU" ]; then
-  HOST_CPU=$(lscpu | grep -m 1 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+  [[ "${CPU,,}" != "unknown" ]] && HOST_CPU="$CPU"
 fi
 
 if [ -n "$HOST_CPU" ]; then

src/reset.sh

@@ -17,7 +17,6 @@ echo "❯ For support visit $SUPPORT"
 
 : "${TZ:=""}"              # System local timezone
 : "${DEBUG:="N"}"          # Disable debugging mode
-: "${COMMIT:="N"}"         # Commit to local image
 : "${COUNTRY:=""}"         # Country code for mirror
 : "${CONSOLE:="N"}"        # Disable console mode
 : "${ALLOCATE:=""}"        # Preallocate diskspace
@@ -64,12 +63,18 @@ if [ -z "${CPU// /}" ] && grep -qi "model:" <<< "$CPI"; then
 fi
 
 CPU="${CPU// CPU/}"
+CPU="${CPU// 8 Core/}"
 CPU="${CPU// 16 Core/}"
+CPU="${CPU// 32 Core/}"
+CPU="${CPU// 64 Core/}"
 CPU="${CPU// Processor/}"
 CPU="${CPU// Quad core/}"
 CPU="${CPU// Core TM/ Core}"
 CPU="${CPU// with Radeon Graphics/}"
+CPU="${CPU// with Radeon Vega Graphics/}"
+
 [ -z "${CPU// /}" ] && CPU="Unknown"
+[[ -n ${CPU_CORES//[0-9]} ]] && error "Invalid amount of CPU_CORES: $CPU_CORES" && exit 15
 
 # Check system
 
@@ -81,13 +86,13 @@ fi
 
 # Check folder
 
-if [[ "$COMMIT" != [Nn]* ]]; then
+if [[ "${COMMIT:-}" == [Yy1]* ]]; then
   STORAGE="/local"
   mkdir -p "$STORAGE"
-else
+fi
-  if [ ! -d "$STORAGE" ]; then
+
-    error "Storage folder ($STORAGE) not found!" && exit 13
+if [ ! -d "$STORAGE" ]; then
-  fi
+  error "Storage folder ($STORAGE) not found!" && exit 13
 fi
 
 # Check filesystem
@@ -102,8 +107,16 @@ fi
 RAM_SPARE=500000000
 RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
 RAM_TOTAL=$(free -b | grep -m 1 Mem: | awk '{print $2}')
+
+if [[ -z ${RAM_SIZE//[0-9]} ]]; then
+  [ "$RAM_SIZE" -lt "130" ] && RAM_SIZE="${RAM_SIZE}G" || RAM_SIZE="${RAM_SIZE}M"
+fi
+
 RAM_SIZE=$(echo "${RAM_SIZE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+! numfmt --from=iec "$RAM_SIZE" &>/dev/null && error "Invalid RAM size: $RAM_SIZE" && exit 16
 RAM_WANTED=$(numfmt --from=iec "$RAM_SIZE")
+[ "$RAM_WANTED" -lt "136314880 " ] && error "Invalid RAM size: $RAM_SIZE" && exit 16
+
 AVAIL_GB=$(( RAM_AVAIL/1073741824 ))
 TOTAL_GB=$(( (RAM_TOTAL + 1073741823)/1073741824 ))
 WANTED_GB=$(( (RAM_WANTED + 1073741823)/1073741824 ))
@@ -121,6 +134,8 @@ echo
 
 # Check memory
 
+[[ "${FS,,}" == "zfs" ]] && RAM_CHECK="N"
+
 if [[ "$RAM_CHECK" != [Nn]* ]]; then
   if (( (RAM_WANTED + RAM_SPARE) > RAM_AVAIL )); then
     error "Your configured RAM_SIZE of $WANTED_GB GB is too high for the $AVAIL_GB GB of memory available, please set a lower value."