mirror of
https://github.com/vdsm/virtual-dsm.git
synced 2026-08-28 20:06:05 +00:00
356 lines
9.0 KiB
Bash
356 lines
9.0 KiB
Bash
#!/usr/bin/env bash
|
||
set -Eeuo pipefail
|
||
|
||
trap 'error "Status $? while: $BASH_COMMAND (line $LINENO/$BASH_LINENO)"' ERR
|
||
enabled "${TRACE:-}" && set -o functrace && trap 'echo "# $BASH_COMMAND" >&2' DEBUG
|
||
|
||
[ ! -f "/run/entry.sh" ] && error "Script must be run inside the container!" && exit 11
|
||
[ "$(id -u)" -ne "0" ] && error "Script must be executed with root privileges." && exit 12
|
||
|
||
# Docker environment variables
|
||
|
||
: "${TZ:=""}" # System timezone
|
||
: "${KVM:="Y"}" # KVM acceleration
|
||
: "${DEBUG:="N"}" # Disable debugging mode
|
||
: "${COUNTRY:=""}" # Country code for mirror
|
||
: "${MACHINE:="q35"}" # Machine type selection
|
||
: "${ALLOCATE:=""}" # Preallocate diskspace
|
||
: "${ARGUMENTS:=""}" # Extra QEMU parameters
|
||
: "${CPU_CORES:="2"}" # Amount of CPU cores
|
||
: "${RAM_SIZE:="2G"}" # Maximum RAM amount
|
||
: "${RAM_CHECK:="Y"}" # Check available RAM
|
||
: "${DISK_SIZE:="16G"}" # Initial data disk size
|
||
: "${STORAGE:="/storage"}" # Storage folder location
|
||
|
||
detectEngine() {
|
||
|
||
if [ -f "/run/.containerenv" ]; then
|
||
ENGINE="${container:-}"
|
||
|
||
if [[ "${ENGINE,,}" == *"podman"* ]]; then
|
||
ENGINE="Podman"
|
||
else
|
||
[ -z "$ENGINE" ] && ENGINE="Kubernetes"
|
||
fi
|
||
elif [ -f "/.dockerenv" ]; then
|
||
ENGINE="Docker"
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
detectRootless() {
|
||
|
||
local uid_map
|
||
|
||
uid_map=$(awk '{$1=$1; print}' /proc/self/uid_map 2>/dev/null || true)
|
||
|
||
if [[ "$uid_map" == "0 0 4294967295" ]]; then
|
||
ROOTLESS="N"
|
||
else
|
||
ROOTLESS="Y"
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
checkPrivileged() {
|
||
|
||
local cap_bnd
|
||
local last_cap
|
||
# Get the capability bounding set
|
||
cap_bnd=$(grep '^CapBnd:' /proc/$$/status | awk '{print $2}')
|
||
cap_bnd=$(printf "%d" "0x${cap_bnd}")
|
||
|
||
# Get the last capability number
|
||
last_cap=$(cat /proc/sys/kernel/cap_last_cap)
|
||
|
||
# Calculate the maximum capability value
|
||
local max_cap=$(((1 << (last_cap + 1)) - 1))
|
||
|
||
if [ "$cap_bnd" -eq "$max_cap" ]; then
|
||
PRIVILEGED="Y"
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
normalizeCpuCores() {
|
||
|
||
CPU_CORES=$(strip "$CPU_CORES")
|
||
[ -z "$CPU_CORES" ] && CPU_CORES=2
|
||
[[ "${CPU_CORES,,}" == "max" ]] && CPU_CORES="$CORES"
|
||
[[ "${CPU_CORES,,}" == "half" ]] && CPU_CORES=$(( CORES / 2 ))
|
||
[ -z "${CPU_CORES##*[!0-9]*}" ] && error "Invalid amount of CPU_CORES: $CPU_CORES" && exit 15
|
||
|
||
[ "$CPU_CORES" -lt "1" ] && CPU_CORES=1
|
||
if [ "$CPU_CORES" -gt "$CORES" ]; then
|
||
warn "The amount for CPU_CORES (${CPU_CORES}) exceeds the amount of logical cores available (${CORES}) and will be limited."
|
||
CPU_CORES="$CORES"
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
checkStorage() {
|
||
|
||
# Check system
|
||
|
||
QEMU_DIR="/run/shm"
|
||
|
||
if [ ! -d "/dev/shm" ]; then
|
||
error "Directory /dev/shm not found!" && exit 14
|
||
else
|
||
[ ! -d "$QEMU_DIR" ] && ln -s /dev/shm "$QEMU_DIR"
|
||
fi
|
||
|
||
QEMU_PID="$QEMU_DIR/qemu.pid"
|
||
|
||
# Check folder
|
||
|
||
if [[ "${STORAGE,,}" != "/storage" ]]; then
|
||
mkdir -p "$STORAGE"
|
||
fi
|
||
|
||
if [ ! -d "$STORAGE" ]; then
|
||
error "Storage folder ($STORAGE) not found!" && exit 13
|
||
fi
|
||
|
||
if [ ! -w "$STORAGE" ]; then
|
||
msg="Storage folder ($STORAGE) is not writeable!"
|
||
msg+=" If SELinux is active, you need to add the \":Z\" flag to the bind mount."
|
||
error "$msg" && exit 13
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
checkFilesystem() {
|
||
|
||
# Check filesystem
|
||
FS=$(stat -f -c %T "$STORAGE")
|
||
|
||
if [[ "${FS,,}" == "ecryptfs" || "${FS,,}" == "tmpfs" ]]; then
|
||
DISK_IO="threads"
|
||
DISK_CACHE="writeback"
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
finiteMemoryLimit() {
|
||
|
||
local limit="$1"
|
||
local sentinel="4611686018427387904"
|
||
local i
|
||
|
||
[[ "$limit" =~ ^[0-9]+$ ]] || return 1
|
||
|
||
(( ${#limit} < ${#sentinel} )) && return 0
|
||
(( ${#limit} > ${#sentinel} )) && return 1
|
||
|
||
for (( i=0; i<${#sentinel}; i++ )); do
|
||
local left="${limit:i:1}"
|
||
local right="${sentinel:i:1}"
|
||
|
||
(( left < right )) && return 0
|
||
(( left > right )) && return 1
|
||
done
|
||
|
||
return 1
|
||
}
|
||
|
||
getMemoryInfo() {
|
||
|
||
local limit="" current=""
|
||
local host_total host_avail
|
||
|
||
host_total=$(free -b | awk '/^Mem:/ {print $2; exit}')
|
||
host_avail=$(free -b | awk '/^Mem:/ {print $7; exit}')
|
||
|
||
RAM_TOTAL="$host_total"
|
||
RAM_AVAIL="$host_avail"
|
||
|
||
if [ -r /sys/fs/cgroup/memory.max ] && [ -r /sys/fs/cgroup/memory.current ]; then
|
||
limit=$(< /sys/fs/cgroup/memory.max)
|
||
current=$(< /sys/fs/cgroup/memory.current)
|
||
elif [ -r /sys/fs/cgroup/memory/memory.limit_in_bytes ] && [ -r /sys/fs/cgroup/memory/memory.usage_in_bytes ]; then
|
||
limit=$(< /sys/fs/cgroup/memory/memory.limit_in_bytes)
|
||
current=$(< /sys/fs/cgroup/memory/memory.usage_in_bytes)
|
||
fi
|
||
|
||
if finiteMemoryLimit "$limit" && [[ "$current" =~ ^[0-9]+$ ]]; then
|
||
(( limit < RAM_TOTAL )) && RAM_TOTAL="$limit"
|
||
|
||
local available=$(( limit - current ))
|
||
(( available < 0 )) && available=0
|
||
(( available < RAM_AVAIL )) && RAM_AVAIL="$available"
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
normalizeRamSize() {
|
||
|
||
# Read host and container memory limits.
|
||
getMemoryInfo
|
||
|
||
RAM_SPARE=500000000
|
||
RAM_MINIMUM=136314880
|
||
|
||
RAM_SIZE=$(strip "$RAM_SIZE")
|
||
RAM_SIZE="${RAM_SIZE// /}"
|
||
[ -z "$RAM_SIZE" ] && RAM_SIZE="2G"
|
||
|
||
if [[ "${RAM_SIZE,,}" != "max" && "${RAM_SIZE,,}" != "half" ]]; then
|
||
|
||
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
|
||
wanted=$(numfmt --from=iec "$RAM_SIZE")
|
||
[ "$wanted" -lt "$RAM_MINIMUM" ] && error "RAM_SIZE is too low: $RAM_SIZE" && exit 16
|
||
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
checkKvm() {
|
||
|
||
# Check KVM support
|
||
|
||
if [[ "${PLATFORM,,}" == "x64" ]]; then
|
||
TARGET="amd64"
|
||
else
|
||
TARGET="arm64"
|
||
fi
|
||
|
||
if disabled "$KVM"; then
|
||
warn "KVM acceleration is disabled, this will cause the machine to run about 10 times slower!"
|
||
else
|
||
if [[ "${ARCH,,}" != "$TARGET" ]]; then
|
||
KVM="N"
|
||
warn "your CPU architecture is ${ARCH^^} and cannot provide KVM acceleration for ${PLATFORM^^} instructions, so the machine will run about 10 times slower."
|
||
fi
|
||
fi
|
||
|
||
if ! disabled "$KVM"; then
|
||
|
||
KVM_ERR=""
|
||
|
||
if [ ! -e /dev/kvm ]; then
|
||
KVM_ERR="(/dev/kvm is missing)"
|
||
else
|
||
if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
|
||
KVM_ERR="(/dev/kvm is unwriteable)"
|
||
else
|
||
if [[ "${PLATFORM,,}" == "x64" ]]; then
|
||
flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
|
||
if ! grep -qw "vmx\|svm" <<< "$flags"; then
|
||
KVM_ERR="(not enabled in BIOS)"
|
||
fi
|
||
if ! grep -qw "sse4_2" <<< "$flags"; then
|
||
error "Your CPU does not have the SSE4 instruction set that Virtual DSM requires!"
|
||
! enabled "$DEBUG" && exit 88
|
||
fi
|
||
fi
|
||
fi
|
||
fi
|
||
|
||
if [ -n "$KVM_ERR" ]; then
|
||
KVM="N"
|
||
if [[ "$OSTYPE" =~ ^darwin ]]; then
|
||
warn "you are using macOS which has no KVM support, so the machine will run about 10 times slower."
|
||
else
|
||
kernel=$(uname -a)
|
||
case "${kernel,,}" in
|
||
*"microsoft"* )
|
||
error "Please bind '/dev/kvm' as a volume in the optional container settings when using Docker Desktop." ;;
|
||
*"synology"* )
|
||
error "Please make sure that Synology VMM (Virtual Machine Manager) is installed and that '/dev/kvm' is binded to this container." ;;
|
||
*)
|
||
error "KVM acceleration is not available $KVM_ERR, this will cause the machine to run about 10 times slower."
|
||
error "See the FAQ for possible causes, or disable acceleration by adding the \"KVM=N\" variable (not recommended)." ;;
|
||
esac
|
||
! enabled "$DEBUG" && exit 88
|
||
fi
|
||
fi
|
||
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
# Sanitize variables
|
||
TZ=$(strip "$TZ")
|
||
STORAGE=$(strip "$STORAGE")
|
||
COUNTRY=$(strip "$COUNTRY")
|
||
DISK_SIZE=$(strip "$DISK_SIZE")
|
||
|
||
# Helper variables
|
||
ROOTLESS="N"
|
||
PRIVILEGED="N"
|
||
ENGINE="Docker"
|
||
PROCESS="${APP,,}"
|
||
PROCESS="${PROCESS// /-}"
|
||
|
||
detectEngine
|
||
detectRootless
|
||
|
||
echo "❯ Starting $APP for $ENGINE v$(</etc/version)..."
|
||
echo "❯ For support visit $SUPPORT"
|
||
|
||
checkPrivileged
|
||
|
||
INFO="/run/shm/msg.html"
|
||
PAGE="/run/shm/index.html"
|
||
TEMPLATE="/var/www/index.html"
|
||
FOOTER1="$APP for $ENGINE v$(</etc/version)"
|
||
FOOTER2="<a href='$SUPPORT'>$SUPPORT</a>"
|
||
|
||
SOCKETS=1
|
||
CPU=$(cpu)
|
||
SYS=$(uname -r)
|
||
ARCH=$(dpkg --print-architecture)
|
||
IFS=. read -r KERNEL MINOR _ <<< "$SYS"
|
||
CORES=$(grep -c '^processor' /proc/cpuinfo)
|
||
|
||
if grep -qi "socket(s)" <<< "$(lscpu)"; then
|
||
SOCKETS=$(lscpu | grep -m 1 -i 'socket(s)' | awk '{print $2}')
|
||
[ -z "${SOCKETS##*[!0-9]*}" ] && SOCKETS=1
|
||
[ "$SOCKETS" -lt "1" ] && SOCKETS=1
|
||
fi
|
||
|
||
normalizeCpuCores
|
||
checkStorage
|
||
checkFilesystem
|
||
normalizeRamSize
|
||
|
||
# Print system info
|
||
SYS="${SYS/-generic/}"
|
||
FS="${FS/UNKNOWN //}"
|
||
FS="${FS/ext2\/ext3/ext4}"
|
||
FS=$(echo "$FS" | sed 's/[)(]//g')
|
||
SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
|
||
SPACE_GB=$(formatBytes "$SPACE" "down")
|
||
AVAIL_MEM=$(formatBytes "$RAM_AVAIL" "down")
|
||
TOTAL_MEM=$(formatBytes "$RAM_TOTAL" "up")
|
||
|
||
echo "❯ CPU: ${CPU} | RAM: ${AVAIL_MEM/ GB/}/$TOTAL_MEM | DISK: $SPACE_GB (${FS}) | KERNEL: ${SYS}"
|
||
echo
|
||
|
||
checkKvm
|
||
|
||
# Cleanup files
|
||
rm -f "$QEMU_DIR"/dsm.url
|
||
rm -f "$QEMU_DIR"/{qemu.*,*.{pid,sock,pipe}}
|
||
|
||
# Cleanup dirs
|
||
rm -rf /tmp/dsm
|
||
rm -rf "$STORAGE/tmp"
|
||
|
||
return 0
|