fix: CPU detection (#697)

.dockerignore

@@ -6,7 +6,10 @@
 .gitmodules
 Dockerfile
 Dockerfile.archive
+compose.yml
+compose.yaml
 docker-compose.yml
+docker-compose.yaml
 
 *.md
 

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -0,0 +1,64 @@
+name: "\U0001F41E Bug Report"
+description: Create a report to help us improve the container
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+      - label: I have searched the existing issues
+        required: true
+  - type: input
+    id: cpu
+    attributes:
+      label: Machine specifications
+      description: The processor and RAM amount in your machine.
+      placeholder: e.g. Intel N5105 / 16 GB 
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: The Linux distribution and kernel version as shown by `uname -a`.
+      placeholder: e.g. Ubuntu 24.04 / Kernel 6.8.0-22-generic
+    validations:
+      required: true
+  - type: input
+    id: docker
+    attributes:
+      label: Docker version
+      description: The Docker version as shown by `docker -v`.
+      placeholder: e.g. Docker version 26.0.1, build d260a54
+    validations:
+      required: true
+  - type: textarea
+    id: summary
+    attributes:
+      label: Description
+      description: A clear and concise description of the problem.
+    validations:
+      required: true
+  - type: textarea
+    id: compose
+    attributes:
+      label: Docker compose
+      description: The Docker compose file (or otherwise `run` command).
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Docker log
+      description: The Docker logfile of the container.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: Screenshots (optional)
+      description: Screenshots of the problem.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

@@ -0,0 +1,37 @@
+name: "\U0001F680 Feature request"
+description: Suggest an idea for improving the container
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your proposal related to a problem?
+      description: |
+        Provide a clear and concise description of what the problem is.
+        For example, "I'm always frustrated when..."
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like.
+      description: |
+        Provide a clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered.
+      description: |
+        Let us know about other solutions you've tried or researched.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: |
+        Is there anything else you can add about the proposal?
+        You might want to link to related issues here, if you haven't already.

.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -0,0 +1,17 @@
+name: "? Question"
+description: General questions about the container
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Have a question about this container?
+        Please make sure to check the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md) first!
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What's the question you have about the container?
+    validations:
+      required: true

Dockerfile

@@ -1,4 +1,4 @@
-FROM qemux/qemu-host as builder
+FROM qemux/qemu-host:2.04 as builder
 
 #  FROM golang as builder
 #  WORKDIR /
@@ -14,9 +14,9 @@ ARG DEBCONF_NOWARNINGS "yes"
 ARG DEBIAN_FRONTEND "noninteractive"
 ARG DEBCONF_NONINTERACTIVE_SEEN "true"
 
-RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
-    && apt-get update \
-    && apt-get --no-install-recommends -y install \
+RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi && \
+    apt-get update && \
+    apt-get --no-install-recommends -y install \
         jq \
         tini \
         curl \
@@ -37,11 +37,11 @@ RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
         ca-certificates \
         netcat-openbsd \
         qemu-system-x86 \
-        "$extra" \
-    && apt-get clean \
-    && unlink /etc/nginx/sites-enabled/default \
-    && sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf \
-    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+        "$extra" && \
+    apt-get clean && \
+    unlink /etc/nginx/sites-enabled/default && \
+    sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 COPY ./src /run/
 COPY ./web /var/www/

readme.md

@@ -21,7 +21,7 @@ Virtual DSM in a Docker container.
  
 ## Usage
 
-Via `docker-compose.yml`
+Via Docker Compose:
 
 ```yaml
 version: "3"
@@ -43,7 +43,7 @@ services:
     stop_grace_period: 2m
 ```
 
-Via `docker run`
+Via Docker CLI:
 
 ```bash
 docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm

src/check.sh

@@ -4,13 +4,13 @@ set -Eeuo pipefail
 : "${NETWORK:="Y"}"
 
 [ -f "/run/shm/qemu.end" ] && echo "QEMU is shutting down.." && exit 1
-[ ! -f "/run/shm/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
+[ ! -s "/run/shm/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
 [[ "$NETWORK" != [Yy1]* ]] && echo "Networking is disabled.." && exit 0
 
 file="/run/shm/dsm.url"
 address="/run/shm/qemu.ip"
 
-[ ! -f  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+[ ! -s  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
 
 location=$(<"$file")
 

src/disk.sh

@@ -13,8 +13,8 @@ set -Eeuo pipefail
 BOOT="$STORAGE/$BASE.boot.img"
 SYSTEM="$STORAGE/$BASE.system.img"
 
-[ ! -f "$BOOT" ] && error "Virtual DSM boot-image does not exist ($BOOT)" && exit 81
-[ ! -f "$SYSTEM" ] && error "Virtual DSM system-image does not exist ($SYSTEM)" && exit 82
+[ ! -s "$BOOT" ] && error "Virtual DSM boot-image does not exist ($BOOT)" && exit 81
+[ ! -s "$SYSTEM" ] && error "Virtual DSM system-image does not exist ($SYSTEM)" && exit 82
 
 DISK_OPTS="\
     -object iothread,id=io2 \
@@ -386,7 +386,7 @@ addDisk () {
   FS=$(stat -f -c %T "$DIR")
   checkFS "$FS" "$DISK_FILE" "$DISK_DESC" || exit $?
 
-  if ! [ -f "$DISK_FILE" ] ; then
+  if ! [ -s "$DISK_FILE" ] ; then
 
     if [[ "${DISK_FMT,,}" != "raw" ]]; then
       PREV_FMT="raw"
@@ -395,12 +395,12 @@ addDisk () {
     fi
     PREV_EXT=$(fmt2ext "$PREV_FMT")
 
-    if [ -f "$DISK_BASE.$PREV_EXT" ] ; then
+    if [ -s "$DISK_BASE.$PREV_EXT" ] ; then
       convertDisk "$DISK_BASE.$PREV_EXT" "$PREV_FMT" "$DISK_FILE" "$DISK_FMT" "$DISK_BASE" "$DISK_DESC" "$FS" || exit $?
     fi
   fi
 
-  if [ -f "$DISK_FILE" ]; then
+  if [ -s "$DISK_FILE" ]; then
 
     CUR_SIZE=$(getSize "$DISK_FILE")
 

src/entry.sh

@@ -18,7 +18,7 @@ cd /run
 
 trap - ERR
 
-info "Booting $APP using $VERS..."
+info "Booting ${APP} on a ${CPU} using QEMU v${VERS} with kernel $(uname -r)..."
 [[ "$DEBUG" == [Yy1]* ]] && echo "Arguments: $ARGS" && echo
 
 if [[ "$CONSOLE" == [Yy]* ]]; then

src/install.sh

@@ -5,6 +5,7 @@ set -Eeuo pipefail
 
 if [ -f "$STORAGE/dsm.ver" ]; then
   BASE=$(<"$STORAGE/dsm.ver")
+  [ -z "$BASE" ] && BASE="DSM_VirtualDSM_69057"
 else
   # Fallback for old installs
   BASE="DSM_VirtualDSM_42962"
@@ -12,14 +13,14 @@ fi
 
 if [ -n "$URL" ]; then
   BASE=$(basename "$URL" .pat)
-  if [ ! -f "$STORAGE/$BASE.system.img" ]; then
+  if [ ! -s "$STORAGE/$BASE.system.img" ]; then
     BASE=$(basename "${URL%%\?*}" .pat)
     : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
     BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
   fi
 fi
 
-if [[ -f "$STORAGE/$BASE.boot.img" ]] && [[ -f "$STORAGE/$BASE.system.img" ]]; then
+if [[ -s "$STORAGE/$BASE.boot.img" ]] && [[ -s "$STORAGE/$BASE.system.img" ]]; then
   return 0  # Previous installation found
 fi
 
@@ -106,7 +107,7 @@ fi
 ROOT="Y"
 RDC="$STORAGE/dsm.rd"
 
-if [ ! -f "$RDC" ]; then
+if [ ! -s "$RDC" ]; then
 
   MSG="Downloading installer..."
   PRG="Downloading installer ([P])..."
@@ -118,18 +119,23 @@ if [ ! -f "$RDC" ]; then
   LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
 
   rm -f "$RD"
+  rm -f "$RDC"
   /run/progress.sh "$RD" "$PRG" &
   { curl -r "$POS" -sfk -S -o "$RD" "$LOC"; rc=$?; } || :
 
   fKill "progress.sh"
-  (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
 
-  SUM=$(md5sum "$RD" | cut -f 1 -d " ")
+  if (( rc != 0 )); then
+    (( rc != 22 )) && error "Failed to download $LOC, reason: $rc" && exit 60
+    SUM="skip"
+  else
+    SUM=$(md5sum "$RD" | cut -f 1 -d " ")
+  fi
 
   if [ "$SUM" != "$VERIFY" ]; then
 
     PAT="/install.pat"
-    rm "$RD"
+    rm -f "$RD"
     rm -f "$PAT"
 
     html "$MSG"
@@ -211,7 +217,7 @@ else
 
 fi
 
-[ ! -f "$PAT" ] && error "Failed to download $URL" && exit 69
+[ ! -s "$PAT" ] && error "Failed to download $URL" && exit 69
 
 SIZE=$(stat -c%s "$PAT")
 
@@ -248,7 +254,7 @@ MSG="Preparing system partition..."
 info "Install: $MSG" && html "$MSG"
 
 BOOT=$(find "$TMP" -name "*.bin.zip")
-[ ! -f "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
+[ ! -s "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
 
 BOOT=$(echo "$BOOT" | head -c -5)
 unzip -q -o "$BOOT".zip -d "$TMP"
@@ -309,15 +315,15 @@ IDB="$TMP/indexdb"
 PKG="$TMP/packages"
 HDP="$TMP/synohdpack_img"
 
-[ ! -f "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
+[ ! -s "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
 mv "$HDA.tgz" "$HDA.txz"
 
 [ -d "$PKG" ] && mv "$PKG/" "$MOUNT/.SynoUpgradePackages/"
 rm -f "$MOUNT/.SynoUpgradePackages/ActiveInsight-"*
 
-[ -f "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
+[ -s "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
 
-if [ -f "$IDB.txz" ]; then
+if [ -s "$IDB.txz" ]; then
   INDEX_DB="$MOUNT/usr/syno/synoman/indexdb/"
   mkdir -p "$INDEX_DB"
   tar xpfJ "$IDB.txz" --absolute-names -C "$INDEX_DB"

src/network.sh

@@ -114,7 +114,7 @@ configureNAT() {
   fi
 
   if [ ! -c /dev/net/tun ]; then
-    error "TUN device missing. $ADD_ERR --cap-add NET_ADMIN" && exit 25
+    error "TUN device missing. $ADD_ERR --device /dev/net/tun --cap-add NET_ADMIN" && exit 25
   fi
 
   # Check port forwarding flag
@@ -200,7 +200,7 @@ closeNetwork() {
   else
 
     local pid="/var/run/dnsmasq.pid"
-    [ -f "$pid" ] && pKill "$(<"$pid")"
+    [ -s "$pid" ] && pKill "$(<"$pid")"
 
     ip link set "$VM_NET_TAP" down promisc off || true
     ip link delete "$VM_NET_TAP" || true
@@ -228,9 +228,8 @@ getInfo() {
 
   if [ -z "$VM_NET_MAC" ]; then
     local file="$STORAGE/dsm.mac"
-    if [ -f "$file" ]; then
-      VM_NET_MAC=$(<"$file")
-    else
+    [ -s "$file" ] && VM_NET_MAC=$(<"$file")
+    if [ -z "$VM_NET_MAC" ]; then
       # Generate MAC address based on Docker container ID in hostname
       VM_NET_MAC=$(echo "$HOST" | md5sum | sed 's/^\(..\)\(..\)\(..\)\(..\)\(..\).*$/02:11:32:\3:\4:\5/')
       echo "${VM_NET_MAC^^}" > "$file"

src/power.sh

@@ -36,7 +36,7 @@ finish() {
 
   touch "$QEMU_END"
 
-  if [ -f "$QEMU_PID" ]; then
+  if [ -s "$QEMU_PID" ]; then
 
     pid=$(<"$QEMU_PID")
     echo && error "Forcefully terminating QEMU process, reason: $reason..."
@@ -45,7 +45,7 @@ finish() {
     while isAlive "$pid"; do
       sleep 1
       # Workaround for zombie pid
-      [ ! -f "$QEMU_PID" ] && break
+      [ ! -s "$QEMU_PID" ] && break
     done
   fi
 
@@ -64,7 +64,7 @@ terminal() {
 
   local dev=""
 
-  if [ -f "$QEMU_OUT" ]; then
+  if [ -s "$QEMU_OUT" ]; then
 
     local msg
     msg=$(<"$QEMU_OUT")
@@ -113,7 +113,7 @@ _graceful_shutdown() {
   touch "$QEMU_END"
   echo && info "Received $1 signal, sending shutdown command..."
 
-  if [ ! -f "$QEMU_PID" ]; then
+  if [ ! -s "$QEMU_PID" ]; then
     echo && error "QEMU PID file does not exist?"
     finish "$code" && return "$code"
   fi
@@ -157,7 +157,7 @@ _graceful_shutdown() {
     [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt/$QEMU_TIMEOUT)"
 
     # Workaround for zombie pid
-    [ ! -f "$QEMU_PID" ] && break
+    [ ! -s "$QEMU_PID" ] && break
 
   done
 

src/print.sh

@@ -21,7 +21,7 @@ resp_err="Guest returned an invalid response:"
 curl_err="Failed to connect to guest: curl error"
 jq_err="Failed to parse response from guest: jq error"
 
-while [ ! -f  "$file" ]
+while [ ! -s  "$file" ]
 do
 
   # Check if not shutting down
@@ -30,7 +30,7 @@ do
   sleep 3
 
   [ -f "$shutdown" ] && exit 1
-  [ -f "$file" ] && break
+  [ -s "$file" ] && break
 
   # Retrieve network info from guest VM
   { json=$(curl -m 20 -sk "$url"); rc=$?; } || :

src/proc.sh

@@ -21,7 +21,8 @@ if [[ "$KVM" != [Nn]* ]]; then
     if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
       KVM_ERR="(no write access)"
     else
-      if ! grep -q -e vmx -e svm /proc/cpuinfo; then
+      flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
+      if ! grep -qw "vmx\|svm" <<< "$flags"; then
         KVM_ERR="(vmx/svm disabled)"
       fi
     fi
@@ -41,7 +42,7 @@ if [[ "$KVM" != [Nn]* ]]; then
   CPU_FEATURES="kvm=on,l3-cache=on"
   KVM_OPTS=",accel=kvm -enable-kvm -global kvm-pit.lost_tick_policy=discard"
 
-  if ! grep -qE '^flags.* (sse4_2)' /proc/cpuinfo; then
+  if ! grep -qw "sse4_2" <<< "$flags"; then
     info "Your CPU does not have the SSE4 instruction set that Virtual DSM requires, it will be emulated..."
     [ -z "$CPU_MODEL" ] && CPU_MODEL="$DEF_MODEL"
     CPU_FEATURES="$CPU_FEATURES,+ssse3,+sse4.1,+sse4.2"

src/progress.sh

@@ -21,7 +21,7 @@ fi
 
 while true
 do
-  if [ -f "$file" ]; then
+  if [ -s "$file" ]; then
     bytes=$(du -sb "$file" | cut -f1)
     if (( bytes > 1000 )); then
       size=$(echo "$bytes" | numfmt --to=iec --suffix=B  | sed -r 's/([A-Z])/ \1/')

src/reset.sh

@@ -42,7 +42,8 @@ HOST=$(hostname -s)
 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)
+VERS=$(qemu-system-x86_64 --version | head -n 1 | cut -d '(' -f 1 | awk '{ print $NF }')
+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')
 
 # Check system