fix: Disable kernel networking in bridge mode (#656)

.github/workflows/build.yml

@@ -103,3 +103,15 @@ jobs:
           url: ${{ secrets.GITLAB_URL }}
           token: ${{ secrets.GITLAB_TOKEN }}
           username: ${{ secrets.GITLAB_USERNAME }}
+      -
+        name: Send mail
+        uses: action-pack/send-mail@v1
+        with:
+          to: ${{secrets.MAILTO}}
+          from: Github Actions <${{secrets.MAILTO}}>
+          connection_url: ${{secrets.MAIL_CONNECTION}}
+          subject: Build of ${{ github.event.repository.name }} v${{ steps.meta.outputs.version }} completed
+          body: |
+              The build job of ${{ github.event.repository.name }} v${{ steps.meta.outputs.version }} was completed successfully! 
+              
+              See https://github.com/${{ github.repository }}/actions for more information.

docker-compose.yml

@@ -5,12 +5,8 @@ services:
         image: vdsm/virtual-dsm:latest
         environment:
             DISK_SIZE: "16G"
-            RAM_SIZE: "1G"
-            CPU_CORES: "1"
         devices:
             - /dev/kvm
-        device_cgroup_rules:
-            - 'c *:* rwm'
         cap_add:
             - NET_ADMIN
         ports:

readme.md

@@ -1,6 +1,6 @@
 <h1 align="center">Virtual DSM<br />
 <div align="center">
-<img src="https://github.com/vdsm/virtual-dsm/raw/master/.github/screen.jpg" title="Screenshot" style="max-width:100%;" width="432" />
+<a href="https://github.com/vdsm/virtual-dsm"><img src="https://github.com/vdsm/virtual-dsm/raw/master/.github/screen.jpg" title="Screenshot" style="max-width:100%;" width="432" /></a>
 </div>
 <div align="center">
 
@@ -11,7 +11,7 @@
 
 </div></h1>
 
-Virtual DSM in a docker container.
+Virtual DSM in a Docker container.
 
 ## Features
 
@@ -46,7 +46,7 @@ services:
 Via `docker run`
 
 ```bash
-docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
+docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
 ```
 
 ## FAQ
@@ -189,16 +189,18 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
   After configuring the container for macvlan (see above), 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 feature, add the following lines to your compose file:
+  To enable this mode, add the following lines to your compose file:
 
   ```yaml
   environment:
     DHCP: "Y"
+  devices:
+    - /dev/vhost-net
   device_cgroup_rules:
     - 'c *:* rwm'
   ```
 
-  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.
+  Please note that even if you don't need DHCP, it's still recommended to enable this mode, as it prevents NAT issues and increases performance by using a `macvtap` interface. You can just set a static IP from the DSM control panel afterwards.
 
 * ### How do I pass-through the GPU?
 
@@ -232,7 +234,10 @@ 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, 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 container on an official Synology NAS, as any other use will be a violation of their terms and conditions.
+
+## Stars
+[![Stars](https://starchart.cc/vdsm/virtual-dsm.svg?variant=adaptive)](https://starchart.cc/vdsm/virtual-dsm)
 
 ## Disclaimer
 

src/check.sh

@@ -1,8 +1,11 @@
 #!/usr/bin/env bash
 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
+[[ "$NETWORK" != [Yy1]* ]] && echo "Networking is disabled.." && exit 0
 
 file="/run/shm/dsm.url"
 address="/run/shm/qemu.ip"

src/disk.sh

@@ -80,7 +80,7 @@ getSize() {
 isCow() {
   local FS=$1
 
-  if [[ "${FS,,}" == "xfs" || "${FS,,}" == "btrfs" || "${FS,,}" == "bcachefs" ]]; then
+  if [[ "${FS,,}" == "btrfs" ]]; then
     return 0
   fi
 
@@ -341,6 +341,21 @@ checkFS () {
   return 0
 }
 
+createDevice () {
+
+  local DISK_ID=$1
+  local DISK_FILE=$2
+  local DISK_INDEX=$3
+  local DISK_ADDRESS=$4
+  local DISK_FMT=$5
+
+  echo "-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 virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+    -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"
+
+  return 0
+}
+
 addDisk () {
   local DISK_ID=$1
   local DISK_BASE=$2
@@ -351,7 +366,7 @@ addDisk () {
   local DISK_ADDRESS=$7
   local DISK_FMT=$8
   local DISK_FILE="$DISK_BASE.$DISK_EXT"
-  local DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE
+  local DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE OPTS
 
   DIR=$(dirname "$DISK_FILE")
   [ ! -d "$DIR" ] && return 0
@@ -399,10 +414,8 @@ addDisk () {
 
   fi
 
-  DISK_OPTS="$DISK_OPTS \
-    -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"
+  OPTS=$(createDevice "$DISK_ID" "$DISK_FILE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT")
+  DISK_OPTS="$DISK_OPTS $OPTS"
 
   return 0
 }
@@ -418,10 +431,9 @@ addDevice () {
   [ -z "$DISK_DEV" ] && return 0
   [ ! -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,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"
+  local OPTS
+  OPTS=$(createDevice "$DISK_ID" "$DISK_DEV" "$DISK_INDEX" "$DISK_ADDRESS" "raw")
+  DISK_OPTS="$DISK_OPTS $OPTS"
 
   return 0
 }

src/entry.sh

@@ -32,4 +32,5 @@ terminal
 tail -fn +0 "$QEMU_LOG" 2>/dev/null &
 cat "$QEMU_TERM" 2>/dev/null & wait $! || :
 
-sleep 1 && finish 0
+sleep 1 & wait $!
+finish 0

src/install.sh

@@ -65,7 +65,11 @@ if [[ "${FS,,}" == "fuse"* ]]; then
   info "Warning: the filesystem of $STORAGE is FUSE, this extra layer will negatively affect performance!"
 fi
 
-if [[ "${FS,,}" != "fat"* && "${FS,,}" != "vfat"* && "${FS,,}" != "exfat"* && "${FS,,}" != "ntfs"* && "${FS,,}" != "msdos"* ]]; then
+if [[ "${FS,,}" == "fat"* || "${FS,,}" == "vfat"* || "${FS,,}" == "msdos"* ]]; then
+  error "Unable to install on $FS filesystems, please use a different filesystem for /storage." && exit 61
+fi
+
+if [[ "${FS,,}" != "exfat"* && "${FS,,}" != "ntfs"* && "${FS,,}" != "unknown"* ]]; then
   TMP="$STORAGE/tmp"
 else
   TMP="/tmp/dsm"
@@ -147,14 +151,14 @@ fi
 if [ -f "$RDC" ]; then
 
   { xz -dc <"$RDC" >"$TMP/rd" 2>/dev/null; rc=$?; } || :
-  (( rc != 1 )) && error "Failed to unxz $RDC, reason $rc" && exit 91
+  (( rc != 1 )) && error "Failed to unxz $RDC on $FS, reason $rc" && exit 91
 
   { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
 
   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
+    (( rc != 0 )) && error "Failed to extract $RDC on $FS, reason $rc" && exit 92
   fi
 
   rm -rf /run/extract && mkdir -p /run/extract
@@ -265,11 +269,11 @@ if ! touch "$SYSTEM"; then
   error "Could not create file $SYSTEM for the system disk." && exit 98
 fi
 
-if [[ "${FS,,}" == "xfs" || "${FS,,}" == "btrfs" || "${FS,,}" == "bcachefs" ]]; then
+if [[ "${FS,,}" == "btrfs" ]]; then
   { chattr +C "$SYSTEM"; } || :
   FA=$(lsattr "$SYSTEM")
   if [[ "$FA" != *"C"* ]]; then
-    error "Failed to disable COW for system image $SYSTEM on ${FS^^} filesystem (returned $FA)"
+    error "Failed to disable COW for system image $SYSTEM on ${FS^^} filesystem."
   fi
 fi
 

src/network.sh

@@ -5,6 +5,7 @@ set -Eeuo pipefail
 
 : "${MAC:=""}"
 : "${DHCP:="N"}"
+: "${NETWORK:="Y"}"
 
 : "${VM_NET_DEV:=""}"
 : "${VM_NET_TAP:="dsm"}"
@@ -23,8 +24,14 @@ ADD_ERR="Please add the following setting to your container:"
 
 configureDHCP() {
 
-  # Create a macvtap network for the VM guest
+  # Create the necessary file structure for /dev/vhost-net
+  if [ ! -c /dev/vhost-net ]; then
+    if mknod /dev/vhost-net c 10 238; then
+      chmod 660 /dev/vhost-net
+    fi
+  fi
 
+  # Create a macvtap network for the VM guest
   { ip link add link "$VM_NET_DEV" name "$VM_NET_TAP" address "$VM_NET_MAC" type macvtap mode bridge ; rc=$?; } || :
 
   if (( rc != 0 )); then
@@ -80,9 +87,13 @@ configureDNS() {
 
   # Set DNS server and gateway
   DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-option=option:dns-server,${VM_NET_IP%.*}.1 --dhcp-option=option:router,${VM_NET_IP%.*}.1"
-  DNSMASQ_OPTS=$(echo "$DNSMASQ_OPTS" | sed 's/\t/ /g' | tr -s ' ' | sed 's/^ *//')
 
+  # Add DNS entry for container
+  DNSMASQ_OPTS="$DNSMASQ_OPTS --address=/host.lan/${VM_NET_IP%.*}.1"
+
+  DNSMASQ_OPTS=$(echo "$DNSMASQ_OPTS" | sed 's/\t/ /g' | tr -s ' ' | sed 's/^ *//')
   [[ "$DEBUG" == [Yy1]* ]] && set -x
+
   if ! $DNSMASQ ${DNSMASQ_OPTS:+ $DNSMASQ_OPTS}; then
     error "Failed to start dnsmasq, reason: $?" && exit 29
   fi
@@ -156,8 +167,10 @@ configureNAT() {
 
   NET_OPTS="-netdev tap,ifname=$VM_NET_TAP,script=no,downscript=no,id=hostnet0"
 
-  { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
-  (( rc == 0 )) && NET_OPTS="$NET_OPTS,vhost=on,vhostfd=40"
+  if [ -c /dev/vhost-net ]; then
+    { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
+    (( rc == 0 )) && NET_OPTS="$NET_OPTS,vhost=on,vhostfd=40"
+  fi
 
   configureDNS
 
@@ -166,15 +179,21 @@ configureNAT() {
 
 closeNetwork() {
 
-  exec 30<&- || true
-  exec 40<&- || true
-
   if [[ "$DHCP" == [Yy1]* ]]; then
 
     # Shutdown nginx
     nginx -s stop 2> /dev/null
     fWait "nginx"
 
+  fi
+
+  [[ "$NETWORK" != [Yy1]* ]] && return 0
+
+  exec 30<&- || true
+  exec 40<&- || true
+
+  if [[ "$DHCP" == [Yy1]* ]]; then
+
     ip link set "$VM_NET_TAP" down || true
     ip link delete "$VM_NET_TAP" || true
 
@@ -208,11 +227,18 @@ getInfo() {
   fi
 
   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/')
+    local file="$STORAGE/dsm.mac"
+    if [ -f "$file" ]; then
+      VM_NET_MAC=$(<"$file")
+    else
+      # 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"
+    fi
   fi
 
-  VM_NET_MAC="${VM_NET_MAC,,//-/:}"
+  VM_NET_MAC="${VM_NET_MAC^^}"
+  VM_NET_MAC="${VM_NET_MAC//-/:}"
 
   if [[ ${#VM_NET_MAC} == 12 ]]; then
     m="$VM_NET_MAC"
@@ -234,10 +260,9 @@ getInfo() {
 #  Configure Network
 # ######################################
 
-if [ ! -c /dev/vhost-net ]; then
-  if mknod /dev/vhost-net c 10 238; then
-    chmod 660 /dev/vhost-net
-  fi
+if [[ "$NETWORK" != [Yy1]* ]]; then
+  NET_OPTS=""
+  return 0
 fi
 
 getInfo

src/power.sh

@@ -34,6 +34,8 @@ finish() {
   local pid
   local reason=$1
 
+  touch "$QEMU_END"
+
   if [ -f "$QEMU_PID" ]; then
 
     pid=$(<"$QEMU_PID")
@@ -168,6 +170,7 @@ _graceful_shutdown() {
 
 MON_OPTS="\
         -pidfile $QEMU_PID \
+        -name $PROCESS,process=$PROCESS,debug-threads=on \
         -monitor telnet:localhost:$QEMU_PORT,server,nowait,nodelay"
 
 if [[ "$CONSOLE" != [Yy]* ]]; then

src/print.sh

@@ -2,6 +2,9 @@
 set -Eeuo pipefail
 
 : "${DHCP:="N"}"
+: "${NETWORK:="Y"}"
+
+[[ "$NETWORK" != [Yy1]* ]] && exit 0
 
 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; }
@@ -101,3 +104,5 @@ info "-----------------------------------------------------------"
 info " You can now login to DSM at $msg"
 info "-----------------------------------------------------------"
 echo "" >&2
+
+exit 0

src/proc.sh

@@ -6,7 +6,8 @@ set -Eeuo pipefail
 : "${KVM:="Y"}"
 : "${HOST_CPU:=""}"
 : "${CPU_FLAGS:=""}"
-: "${CPU_MODEL:="host"}"
+: "${CPU_MODEL:=""}"
+: "${DEF_MODEL:="qemu64"}"
 
 [ "$ARCH" != "amd64" ] && KVM="N"
 
@@ -28,7 +29,7 @@ if [[ "$KVM" != [Nn]* ]]; then
 
   if [ -n "$KVM_ERR" ]; then
     KVM="N"
-    error "KVM acceleration not detected $KVM_ERR, this will cause a major loss of performance."
+    error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
     error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
     [[ "$DEBUG" != [Yy1]* ]] && exit 88
   fi
@@ -37,35 +38,54 @@ fi
 
 if [[ "$KVM" != [Nn]* ]]; then
 
-  CPU_FEATURES="kvm=on"
-  KVM_OPTS=",accel=kvm -enable-kvm"
+  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
-    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
+    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"
+  fi
+
+  if [ -z "$CPU_MODEL" ]; then
+    CPU_MODEL="host"
+    CPU_FEATURES="$CPU_FEATURES,migratable=no"
   fi
 
 else
 
   KVM_OPTS=""
-  CPU_FEATURES="+ssse3,+sse4.1,+sse4.2"
+  CPU_FEATURES="l3-cache=on"
 
-  if [[ "${CPU_MODEL,,}" == "host"* ]]; then
+  if [[ "$ARCH" == "amd64" ]]; then
+    KVM_OPTS=" -accel tcg,thread=multi"
+  fi
 
+  if [ -z "$CPU_MODEL" ]; then
     if [[ "$ARCH" == "amd64" ]]; then
       CPU_MODEL="max"
+      CPU_FEATURES="$CPU_FEATURES,migratable=no"
     else
-      CPU_MODEL="qemu64"
+      CPU_MODEL="$DEF_MODEL"
     fi
-
   fi
+
+  CPU_FEATURES="$CPU_FEATURES,+ssse3,+sse4.1,+sse4.2"
+
 fi
 
 if [ -z "$CPU_FLAGS" ]; then
-  CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES"
+  if [ -z "$CPU_FEATURES" ]; then
+    CPU_FLAGS="$CPU_MODEL"
+  else
+    CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES"
+  fi
 else
-  CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES,$CPU_FLAGS"
+  if [ -z "$CPU_FEATURES" ]; then
+    CPU_FLAGS="$CPU_MODEL,$CPU_FLAGS"
+  else
+    CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES,$CPU_FLAGS"
+  fi
 fi
 
 if [ -z "$HOST_CPU" ]; then

src/reset.sh

@@ -28,6 +28,9 @@ echo
 
 # Helper variables
 
+PROCESS="${APP,,}"
+PROCESS="${PROCESS// /-}"
+
 STORAGE="/storage"
 INFO="/run/shm/msg.html"
 PAGE="/run/shm/index.html"