feat: Detect clock source (#923)

compose.yml

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

kubernetes.yml

@@ -30,10 +30,6 @@ spec:
       - name: dsm
         image: vdsm/virtual-dsm
         env:
-        - name: RAM_SIZE
-          value: "1G"
-        - name: CPU_CORES
-          value: "1"
         - name: DISK_SIZE
           value: "16G"
         ports:

readme.md

@@ -39,7 +39,7 @@ services:
     ports:
       - 5000:5000
     volumes:
-      - /var/dsm:/storage
+      - ./dsm:/storage
     restart: always
     stop_grace_period: 2m
 ```
@@ -47,7 +47,7 @@ services:
 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:
@@ -84,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?
 
@@ -112,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:
@@ -124,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
-    - /mnt/data/example:/storage3
+    - ./example2:/storage2
+    - ./example3:/storage3
   ```
 
 ### How do I pass-through a disk?
@@ -245,8 +242,8 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     - /dev/dri
   ```
 
-> [!TIP]
-> This can be used to enable the facial recognition function in Synology Photos for example.
+> [!NOTE]
+> 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?
 

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/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
@@ -75,6 +74,7 @@ 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
 
@@ -86,13 +86,13 @@ fi
 
 # Check folder
 
-if [[ "$COMMIT" != [Nn]* ]]; then
+if [[ "${COMMIT:-}" == [Yy1]* ]]; then
   STORAGE="/local"
   mkdir -p "$STORAGE"
-else
-  if [ ! -d "$STORAGE" ]; then
-    error "Storage folder ($STORAGE) not found!" && exit 13
-  fi
+fi
+
+if [ ! -d "$STORAGE" ]; then
+  error "Storage folder ($STORAGE) not found!" && exit 13
 fi
 
 # Check filesystem
@@ -107,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 ))
@@ -126,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."