fix: Shellcheck (#509)

* fix: Device detection

readme.md

@@ -169,8 +169,6 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
     ```yaml
     environment:
       DHCP: "Y"
-    devices:
-      - /dev/vhost-net
     device_cgroup_rules:
       - 'c *:* rwm'
     ```

src/check.sh

@@ -3,8 +3,8 @@ 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
+[ ! -f "/run/qemu.pid" ] && echo "QEMU not running yet.." && exit 0
 
 file="/run/dsm.url"
 [ ! -f  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1

src/cpu.sh

@@ -7,10 +7,11 @@ set -Eeuo pipefail
 : ${CPU_MODEL:='host'}
 : ${CPU_FEATURES:='+ssse3,+sse4.1,+sse4.2'}
 
-KVM_ERR=""
+[ "$ARCH" != "amd64" ] && KVM="N"
-KVM_OPTS=""
 
-if [[ "$ARCH" == "amd64" && "$KVM" != [Nn]* ]]; then
+if [[ "$KVM" != [Nn]* ]]; then
+
+  KVM_ERR=""
 
   if [ -e /dev/kvm ] && sh -c 'echo -n > /dev/kvm' &> /dev/null; then
     if ! grep -q -e vmx -e svm /proc/cpuinfo; then
@@ -21,25 +22,35 @@ if [[ "$ARCH" == "amd64" && "$KVM" != [Nn]* ]]; then
   fi
 
   if [ -n "$KVM_ERR" ]; then
+    KVM="N"
     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)."
+    error "See the FAQ on how to enable it, or continue without KVM 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
+fi
-    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."
+if [[ "$KVM" != [Nn]* ]]; then
-      error "Disable KVM by setting KVM=N to emulate a compatible CPU, at the cost of performance."
+
-      [[ "$DEBUG" != [Yy1]* ]] && exit 89
+  KVM_OPTS=",accel=kvm -enable-kvm"
-    fi
+
+  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
 
 else
 
-  [[ "$CPU_MODEL" == "host"* ]] && CPU_MODEL="max,$CPU_FEATURES"
+  KVM_OPTS=""
+
+  if [[ "$CPU_MODEL" == "host"* ]]; then
+    if [[ "$ARCH" == "amd64" ]]; then
+      CPU_MODEL="max,$CPU_FEATURES"
+    else
+      CPU_MODEL="qemu64,$CPU_FEATURES"
+    fi
+  fi
 
 fi
 

src/disk.sh

@@ -123,10 +123,6 @@ createDisk() {
           error "$FAIL" && exit 77
         fi
         { chattr +C "$DISK_FILE"; } || :
-        FA=$(lsattr "$DISK_FILE")
-        if [[ "$FA" != *"C"* ]]; then
-          error "Failed to disable COW for $DISK_DESC image $DISK_FILE on ${FS^^} filesystem (returned $FA)"
-        fi
       fi
 
       if [[ "$ALLOCATE" == [Nn]* ]]; then
@@ -159,17 +155,16 @@ createDisk() {
         rm -f "$DISK_FILE"
         error "$FAIL" && exit 70
       fi
-
-      if isCow "$FS"; then
-        FA=$(lsattr "$DISK_FILE")
-        if [[ "$FA" != *"C"* ]]; then
-          error "Failed to disable COW for $DISK_DESC image $DISK_FILE on ${FS^^} filesystem (returned $FA)"
-        fi
-      fi
-
       ;;
   esac
 
+  if isCow "$FS"; then
+    FA=$(lsattr "$DISK_FILE")
+    if [[ "$FA" != *"C"* ]]; then
+      error "Failed to disable COW for $DISK_DESC image $DISK_FILE on ${FS^^} filesystem (returned $FA)"
+    fi
+  fi
+
   return 0
 }
 
@@ -328,7 +323,7 @@ checkFS () {
     if [ -f "$DISK_FILE" ]; then
       FA=$(lsattr "$DISK_FILE")
       if [[ "$FA" != *"C"* ]]; then
-        info "Warning: COW (copy on write) is not disabled for the $DISK_DESC image file $DISK_FILE, this is recommended on ${FS^^} filesystems!"
+        info "Warning: COW (copy on write) is not disabled for $DISK_DESC image file $DISK_FILE, this is recommended on ${FS^^} filesystems!"
       fi
     fi
   fi

src/entry.sh

@@ -23,12 +23,31 @@ if [[ "$CONSOLE" == [Yy]* ]]; then
   exit $?
 fi
 
-set -m
+[[ "$DEBUG" == [Yy1]* ]] && info "$VERS" && set -x
-(
+msg=$(qemu-system-x86_64 -daemonize -pidfile "$QEMU_PID" ${ARGS:+ $ARGS})
-  [[ "$DEBUG" == [Yy1]* ]] && info "$VERS" && set -x
+{ set +x; } 2>/dev/null
-  qemu-system-x86_64 ${ARGS:+ $ARGS} & echo $! > "$QEMU_PID"
-  { set +x; } 2>/dev/null
-)
-set +m
 
-tail --pid "$(cat "$QEMU_PID")" --follow /dev/null & wait $!
+if [[ "$msg" != "char"* ||  "$msg" != *"serial0)" ]]; then
+  echo "$msg"
+fi
+
+dev="${msg#*/dev/p}"
+dev="/dev/p${dev%% *}"
+
+if [ ! -c "$dev" ]; then
+  dev=$(echo 'info chardev' | nc -q 1 -w 1 localhost "$QEMU_PORT" | tr -d '\000')
+  dev="${dev#*charserial0}"
+  dev="${dev#*pty:}"
+  dev="${dev%%$'\n'*}"
+  dev="${dev%%$'\r'*}"
+fi
+
+if [ ! -c "$dev" ]; then
+  error "Device '$dev' not found!"
+  finish 34
+fi
+
+cat "$dev" 2>/dev/null & wait $! || true
+
+sleep 1
+finish 0

src/gpu.sh

@@ -8,16 +8,17 @@ fi
 [ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
 
 if [ ! -c /dev/dri/card0 ]; then
-  mknod /dev/dri/card0 c 226 0
+  if mknod /dev/dri/card0 c 226 0; then
+    chmod 666 /dev/dri/card0
+  fi
 fi
 
 if [ ! -c /dev/dri/renderD128 ]; then
-  mknod /dev/dri/renderD128 c 226 128
+  if mknod /dev/dri/renderD128 c 226 128; then
+    chmod 666 /dev/dri/renderD128
+  fi
 fi
 
-chmod 666 /dev/dri/card0
-chmod 666 /dev/dri/renderD128
-
 addPackage "xserver-xorg-video-intel" "Intel GPU drivers"
 addPackage "qemu-system-modules-opengl" "OpenGL module"
 

src/install.sh

@@ -205,12 +205,7 @@ else
 
 fi
 
-HDA="$TMP/hda1"
+info "Install: Preparing system partition..."
-IDB="$TMP/indexdb"
-PKG="$TMP/packages"
-HDP="$TMP/synohdpack_img"
-
-[ ! -f "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
 
 BOOT=$(find "$TMP" -name "*.bin.zip")
 [ ! -f "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
@@ -271,15 +266,18 @@ PART="$TMP/partition.fdisk"
 
 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"
 
+info "Install: Extracting system partition..."
+
+HDA="$TMP/hda1"
+IDB="$TMP/indexdb"
+PKG="$TMP/packages"
+HDP="$TMP/synohdpack_img"
+
+[ ! -f "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
+
 mv "$HDA.tgz" "$HDA.txz"
 
 if [[ "$ROOT" != [Nn]* ]]; then
@@ -299,6 +297,10 @@ if [ -f "$IDB.txz" ]; then
   tar xpfJ "$IDB.txz" --absolute-names -C "$INDEX_DB"
 fi
 
+LABEL="1.44.1-42218"
+OFFSET="1048576" # 2048 * 512
+NUMBLOCKS="622560" # (4980480 * 512) / 4096
+
 if [[ "$ROOT" != [Nn]* ]]; then
 
   info "Install: Installing system partition..."

src/network.sh

@@ -15,6 +15,8 @@ set -Eeuo pipefail
 : ${DNSMASQ:='/usr/sbin/dnsmasq'}
 : ${DNSMASQ_CONF_DIR:='/etc/dnsmasq.d'}
 
+ADD_ERR="Please add the following setting to your container:"
+
 # ######################################
 #  Functions
 # ######################################
@@ -27,7 +29,7 @@ configureDHCP() {
 
   if (( rc != 0 )); then
     error "Cannot create macvtap interface. Please make sure the network type is 'macvlan' and not 'ipvlan',"
-    error "and that the NET_ADMIN capability has been added to the container config: --cap-add NET_ADMIN" && exit 16
+    error "and that the NET_ADMIN capability has been added to the container: --cap-add NET_ADMIN" && exit 16
   fi
 
   while ! ip link set "$VM_NET_TAP" up; do
@@ -53,15 +55,13 @@ configureDHCP() {
   { exec 30>>"$TAP_PATH"; rc=$?; } 2>/dev/null || :
 
   if (( rc != 0 )); then
-    error "Cannot create TAP interface ($rc). Please add the following docker settings to your "
+    error "Cannot create TAP interface ($rc). $ADD_ERR --device-cgroup-rule='c *:* rwm'" && exit 21
-    error "container: --device-cgroup-rule='c $MAJOR:* rwm' --device=/dev/vhost-net" && exit 21
   fi
 
   { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
 
   if (( rc != 0 )); then
-    error "VHOST can not be found ($rc). Please add the following "
+    error "VHOST can not be found ($rc). $ADD_ERR --device=/dev/vhost-net" && exit 22
-    error "docker setting to your container: --device=/dev/vhost-net" && exit 22
   fi
 
   NET_OPTS="-netdev tap,id=hostnet0,vhost=on,vhostfd=40,fd=30"
@@ -100,8 +100,7 @@ configureNAT () {
   { ip link add dev dockerbridge type bridge ; rc=$?; } || :
 
   if (( rc != 0 )); then
-    error "Capability NET_ADMIN has not been set most likely. Please add the "
+    error "Failed to create bridge. $ADD_ERR --cap-add NET_ADMIN" && exit 23
-    error "following docker setting to your container: --cap-add NET_ADMIN" && exit 23
   fi
 
   ip address add ${VM_NET_IP%.*}.1/24 broadcast ${VM_NET_IP%.*}.255 dev dockerbridge
@@ -138,7 +137,7 @@ configureNAT () {
   if [[ $(< /proc/sys/net/ipv4/ip_forward) -eq 0 ]]; then
     { sysctl -w net.ipv4.ip_forward=1 ; rc=$?; } || :
     if (( rc != 0 )); then
-      error "Please add the following docker setting to your container: --sysctl net.ipv4.ip_forward=1" && exit 24
+      error "IP forwarding is disabled. $ADD_ERR --sysctl net.ipv4.ip_forward=1" && exit 24
     fi
   fi
 
@@ -154,16 +153,19 @@ configureNAT () {
 
 closeNetwork () {
 
+  exec 30<&- || true
+  exec 40<&- || true
+
   if [[ "$DHCP" == [Yy1]* ]]; then
 
-    { pkill -f server.sh || true; } 2>/dev/null
+    fKill "server.sh"
 
     ip link set "$VM_NET_TAP" down || true
     ip link delete "$VM_NET_TAP" || true
 
   else
 
-    { pkill -f dnsmasq || true; } 2>/dev/null
+    fKill "dnsmasq"
 
     ip link set "$VM_NET_TAP" down promisc off || true
     ip link delete "$VM_NET_TAP" || true
@@ -178,7 +180,7 @@ closeNetwork () {
 #  Configure Network
 # ######################################
 
-{ pkill -f server.sh || true; } 2>/dev/null
+fKill "server.sh"
 
 # Create the necessary file structure for /dev/net/tun
 if [ ! -c /dev/net/tun ]; then
@@ -189,7 +191,7 @@ if [ ! -c /dev/net/tun ]; then
 fi
 
 if [ ! -c /dev/net/tun ]; then
-  error "Please add the following docker settings to your container: --device=/dev/net/tun" && exit 25
+  error "TUN device missing. $ADD_ERR --cap-add NET_ADMIN" && exit 25
 fi
 
 # Create the necessary file structure for /dev/vhost-net
@@ -213,9 +215,7 @@ fi
 if [[ "$DHCP" == [Yy1]* ]]; then
 
   if [[ "$GATEWAY" == "172."* ]]; then
-    if [[ "$DEBUG" == [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 26
     fi
   fi

src/power.sh

@@ -3,38 +3,92 @@ set -Eeuo pipefail
 
 # Configure QEMU for graceful shutdown
 
+API_CMD=6
+API_TIMEOUT=50
+API_HOST="127.0.0.1:2210"
+
 QEMU_PORT=7100
-QEMU_TIMEOUT=55
+QEMU_TIMEOUT=50
 QEMU_PID="/run/qemu.pid"
 QEMU_COUNT="/run/qemu.count"
 
+if [[ "$KVM" == [Nn]* ]]; then
+  API_TIMEOUT=$(( API_TIMEOUT*2 ))
+  QEMU_TIMEOUT=$(( QEMU_TIMEOUT*2 ))
+fi
+
 rm -f "$QEMU_PID"
 rm -f "$QEMU_COUNT"
 
-_trap(){
+_trap() {
-    func="$1" ; shift
+  func="$1" ; shift
-    for sig ; do
+  for sig ; do
-        trap "$func $sig" "$sig"
+    trap "$func $sig" "$sig"
+  done
+}
+
+finish() {
+
+  local pid
+  local reason=$1
+
+  if [ -f "$QEMU_PID" ]; then
+
+    pid="$(cat "$QEMU_PID")"
+    echo && error "Forcefully terminating QEMU process, reason: $reason..."
+    { kill -15 "$pid" || true; } 2>/dev/null
+
+    while isAlive "$pid"; do
+      sleep 1
+      # Workaround for zombie pid
+      [ ! -f "$QEMU_PID" ] && break
     done
+  fi
+
+  fKill "print.sh"
+  fKill "host.bin"
+
+  closeNetwork
+
+  sleep 1
+  echo && echo "❯ Shutdown completed!"
+
+  exit "$reason"
 }
 
 _graceful_shutdown() {
 
-  set +e
+  local code=$?
-  local cnt response
+  local pid cnt response
 
-  [ ! -f "$QEMU_PID" ] && exit 130
+  set +e
-  [ -f "$QEMU_COUNT" ] && return
+
+  if [ -f "$QEMU_COUNT" ]; then
+    echo && info "Ignored $1 signal, already shutting down..."
+    return
+  fi
 
   echo 0 > "$QEMU_COUNT"
   echo && info "Received $1 signal, sending shutdown command..."
 
+  if [ ! -f "$QEMU_PID" ]; then
+    echo && error "QEMU PID file does not exist?"
+    finish "$code" && return "$code"
+  fi
+
+  pid="$(cat "$QEMU_PID")"
+
+  if ! isAlive "$pid"; then
+    echo && error "QEMU process does not exist?"
+    finish "$code" && return "$code"
+  fi
+
   # Don't send the powerdown signal because vDSM ignores ACPI signals
   # echo 'system_powerdown' | nc -q 1 -w 1 localhost "${QEMU_PORT}" > /dev/null
 
   # Send shutdown command to guest agent via serial port
-  url="http://127.0.0.1:2210/read?command=6&timeout=50"
+  url="http://$API_HOST/read?command=$API_CMD&timeout=$API_TIMEOUT"
-  response=$(curl -sk -m 52 -S "$url" 2>&1)
+  response=$(curl -sk -m "$(( API_TIMEOUT+2 ))" -S "$url" 2>&1)
 
   if [[ "$response" =~ "\"success\"" ]]; then
 
@@ -43,19 +97,17 @@ _graceful_shutdown() {
   else
 
     response="${response#*message\"\: \"}"
-    echo && error "Failed to send shutdown command: ${response%%\"*}"
+    [ -z "$response" ] && response="second signal"
-
+    echo && error "Forcefully terminating because of: ${response%%\"*}"
-    kill -15 "$(cat "$QEMU_PID")"
+    { kill -15 "$pid" || true; } 2>/dev/null
-    pkill -f qemu-system-x86_64 || true
 
   fi
 
   while [ "$(cat $QEMU_COUNT)" -lt "$QEMU_TIMEOUT" ]; do
 
-    # Try to connect to qemu
+    ! isAlive "$pid" && break
-    if ! echo 'info version'| nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 ; then
+
-      break
+    sleep 1
-    fi
 
     # Increase the counter
     cnt=$(($(cat $QEMU_COUNT)+1))
@@ -63,23 +115,16 @@ _graceful_shutdown() {
 
     [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt/$QEMU_TIMEOUT)"
 
+    # Workaround for zombie pid
+    [ ! -f "$QEMU_PID" ] && break
+
   done
 
   if [ "$(cat $QEMU_COUNT)" -ge "$QEMU_TIMEOUT" ]; then
-    echo && error "Shutdown timeout reached, forcefully quitting.."
+    echo && error "Shutdown timeout reached!"
-  else
-    echo && echo "❯ Quitting..."
   fi
 
-  echo 'quit' | nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 || true
+  finish "$code" && return "$code"
-
-  { pkill -f print.sh || true; } 2>/dev/null
-  { pkill -f host.bin || true; } 2>/dev/null
-
-  closeNetwork
-  sleep 1
-
-  return
 }
 
 _trap _graceful_shutdown SIGTERM SIGHUP SIGINT SIGABRT SIGQUIT

src/reset.sh

@@ -49,8 +49,41 @@ rm -rf "$STORAGE/tmp"
 
 # Helper functions
 
-getCountry () {
+isAlive() {
+  local pid=$1
 
+  if kill -0 "$pid" 2>/dev/null; then
+    return 0
+  fi
+
+  return 1
+}
+
+pKill() {
+  local pid=$1
+
+  { kill -15 "$pid" || true; } 2>/dev/null
+
+  while isAlive "$pid"; do
+    sleep 0.1
+  done
+
+  return 0
+}
+
+fKill () {
+  local name=$1
+
+  { pkill -f "$name" || true; } 2>/dev/null
+
+  while pgrep -f -l "$name" >/dev/null; do
+    sleep 0.1
+  done
+
+  return 0
+}
+
+getCountry () {
   local url=$1
   local query=$2
   local rc json result
@@ -87,7 +120,6 @@ setCountry () {
 }
 
 addPackage () {
-
   local pkg=$1
   local desc=$2
 

src/serial.sh

@@ -47,10 +47,9 @@ done
 # Configure serial ports
 
 SERIAL_OPTS="\
-        -serial mon:stdio \
-        -device virtio-serial-pci,id=virtio-serial0,bus=pcie.0,addr=0x3 \
         -chardev pty,id=charserial0 \
         -device isa-serial,chardev=charserial0,id=serial0 \
+        -device virtio-serial-pci,id=virtio-serial0,bus=pcie.0,addr=0x3 \
         -chardev socket,id=charchannel0,host=127.0.0.1,port=12345,reconnect=10 \
         -device virtserialport,bus=virtio-serial0.0,nr=1,chardev=charchannel0,id=channel0,name=vchannel"