-# This file implements common functions for all boot methods
+# This file implements common functions for all boot scripts
+# Rerun with sudo if needed
+[ $(id -u) = 0 ] || exec sudo $0 $@
+
+export ACTION="$(basename $0)"
+
+# Function to write a message and exit with error code
die() {
echo "$*" >&2
exit 1
}
+beginswith() {
+ [ "$1" != "${1#$2}" ]
+}
+
+# Function to setup subhost name and log file
+subhost_name() {
+ CONFIG="$1"
+ [ -r "$CONFIG" ] || die "Cannot use $CONFIG"
+ config NAME "$(basename $CONFIG .conf)"
+ config LOG /tmp/oly-$NAME.log
+}
+
+# Function to set up all subhost configuration
+subhost_config() {
+
+ config BASE
+ BASE="$(cd $(dirname $CONFIG); realpath $BASE)"
+ [ -z "$BASE" ] && die "BASE is unset; bogus $CONFIG ?"
+ [ -d "$BASE" ] || die "$BASE is not a directory; bogus $CONFIG ?"
+ cd "$BASE" || die "$BASE is inaccessible"
+
+ config CABLES ""
+ config LIVE "$BASE/live"
+ config UPPER "$BASE/root"
+ config WORK "$BASE/work"
+ config LOWER "/"
+ config START "networking ssh"
+ config PREMOUNT "$PROGRAMDIR/overlay-premount"
+ config POSTMOUNT "$PROGRAMDIR/overlay-postmount"
+ config INIT "$PROGRAMDIR/overlay-init"
+ config RAM_SIZE 50M
+}
+
+# function to reverse the $* words
+reverse() {
+ local OUT=""
+ for w in $* ; do OUT="$w $OUT" ; done
+ echo "${OUT% }"
+}
+
# grab and set a configuration variable
# $1 = variable, [ $2 = default .. error otherwise ]
config() {
- eval $1="$(sed "/^$1=.*/{s|^$1=||;b};d" $CONFIG)"
- [ -z "$(eval echo "\$$1")" ] || return 0
- [ $# -lt 2 ] && die "Missing $1=... in $CONFIG"
- eval $1="'$2'"
- eval echo "$1=\$$1"
+ local V W
+ read V <<EOF
+$(sed "/^$1=.*/{s|^$1=||;s|^\\s*||;s|\\s*\$||;b};d" $CONFIG)
+EOF
+ if [ -z "$V" ] ; then
+ [ $# -lt 2 ] && die "Missing $1=... in $CONFIG"
+ V="$2" # use the given default
+ elif [ -z "${V##!*}" ] ; then
+ read W <<EOF
+$(${V#!})
+EOF
+ [ -z "$W" ] && die "bad $1 config: $V"
+ V="$W"
+ fi
+ eval $1="'$V'"
+ eval echo "$1=$V" >&2
}
# Install a default $1/etc/network/interfaces on the subhost root $1
# Setup the network namespace for the given $CABLES
# $1=netns ( $2="br=mac" .. )
+# br is optional, mac is optional.
+# If mac is .N then it's taken as vlan tag on prior outer interface
+# (with ifup configuration) and the inner interface is left alone.
setup_veth_cables() {
local NETNS BR IF MAC C i ADD
NETNS="$1"
for C in "$@" ; do
IF=$NETNS$i
MAC="${C#*=}"
- [ -z "$MAC" ] || MAC="address $MAC"
- ip link add $IF type veth peer name eth$i $MAC netns $NETNS
- ip link set $IF up
+ if [ -z "$MAC" ] ; then
+ # set up veth with "random" mac address
+ ip link add $IF type veth peer name eth$i netns $NETNS
+ elif [ -z "${MAC%%.*}" ] ; then
+ # set up a host vlan with specified tag on previous eth
+ i=$((i-1))
+ IF=$NETNS$i$MAC
+ ifup $IF
+ else
+ # set up veth with specified mac address
+ ip link add $IF type veth peer name eth$i address $MAC netns $NETNS
+ fi
BR="${C%=*}"
if [ -z "$BR" ] ; then
- ip link set $IF
- ifup $IF
+ ifup $IF || ip link set $IF up
else
+ ip link set $IF up
brctl addif $BR $IF
fi
i=$((i+1))
done
}
-# (name live system root work)
-# Set up an overlay fmr $name on $live, with a new tmpfs on its /run,
+# Set up an overlay for $name on $live, with a new tmpfs on its /run,
# and "install" a "reaper" as the upcoming pid 1
setup_overlay() {
- local LIVE="$2" LOWER="$3" UPPER="$4" ROOT
+ local NAME="$1" LIVE="$2" LOWER="$3" UPPER="$4" WORK="$5"
- if grep -q "$1 $2" /proc/mounts ; then
- die "$1 is already mounted"
- fi
+ echo setup_overlay "$NAME" "$LIVE" "$LOWER" "$UPPER" "$WORK"
- if [ -f "${UPPER%% *}" ] ; then
- if [ -x "${UPPER%% *}" ] ; then
- echo "${UPPER%% *} appears to be executable" >&2
- # Giving a program/script as UPPER= asks for running this
- # first, to make a root filesystem available. The script takes
- # ACTION "setup" and "teardown", and on "setup" it must tell
- # where the ROOT is set up.
- ROOT="$(env ACTION=setup $UPPER)"
- if [ ! -d "$ROOT" ] ; then
- # setup failed
- die "root setup failed: $UPPER"
- fi
- UPPER="$ROOT"
- ## Now falling down to "normal overlay" setup
- else
- die "${UPPER%% *} (root setup program/script) is not executable"
- fi
+ if grep -qE "^[^ ]+ $LIVE " /proc/mounts ; then
+ die "$LIVE already has a mount"
fi
- # LIVE is the same as LOWER then skip the overlay; just assume
- # a proper chroot system exists at LIVE.
- if [ "$LIVE" != "$LOWER" ] ; then
- # setup $UPPER/run
- mkdir -p "$UPPER/run"
- mount -t tmpfs -osize=100M tmpfs "$UPPER/run"
- mkdir -p "$UPPER/run/lock"
- # setup $UPPER/dev
- mkdir -p "$UPPER/dev"
- mount -t tmpfs -osize=100M tmpfs "$UPPER/dev"
- mknod -m 622 "$UPPER/dev/console" c 5 1
- mknod -m 666 "$UPPER/dev/null" c 1 3
- mknod -m 666 "$UPPER/dev/zero" c 1 5
- mknod -m 666 "$UPPER/dev/ptmx" c 5 2
- mknod -m 666 "$UPPER/dev/tty" c 5 0
- mknod -m 444 "$UPPER/dev/random" c 1 8
- mknod -m 444 "$UPPER/dev/urandom" c 1 9
- chown root:tty "$UPPER/dev/console"
- chown root:tty "$UPPER/dev/ptmx"
- chown root:tty "$UPPER/dev/tty"
- ln -sTf /proc/self/fd "$UPPER/dev/fd"
- ln -sTf /proc/self/fd/0 "$UPPER/dev/stdin"
- ln -sTf /proc/self/fd/1 "$UPPER/dev/stdout"
- ln -sTf /proc/self/fd/2 "$UPPER/dev/stderr"
- ln -sTf /proc/kcore "$UPPER/dev/core"
- mkdir "$UPPER/dev/shm"
- mkdir "$UPPER/dev/pts"
- chmod 1777 "$UPPER/dev/shm"
-
- # all good so far ; now avoid using the host's networking setup
- setup_networking "$UPPER"
+ [ -d "$UPPER" ] || die "UPPER=$UPPER is not a directory"
+ [ -d "$LOWER" ] || die "LOWER=LOWPER is not a directory"
+ [ -d "$LIVE" ] || die "LOWER=LOWPER is not a directory"
+ [ -x "${PREMOUNT%% *}" ] || die "PREMOUNT=${PREMOUNT%% *} not executable"
+ [ -f "${PREMOUNT%% *}" ] || die "PREMOUNT='$PREMOUNT' is not a command"
+ [ -x "${POSTMOUNT%% *}" ] || \
+ die "POSTMOUNT=${POSTMOUNT%% *} not executable"
+ [ -f "${POSTMOUNT%% *}" ] || \
+ die "POSTMOUNT='$POSTMOUNT' is not a command"
+
+ # UPPER is the same as LOWER then skip the overlay mount
+ if [ "$UPPER" != "$LOWER" ] ; then
+ # sanity check
+ [ -d "$WORK" ] || die "WORK=$WORK is not a directory"
+
+ env CONFIG="$CONFIG" $PREMOUNT "$UPPER"
OLY="-olowerdir=$3,upperdir=$UPPER,workdir=$5"
if ! mount -t overlay "$OLY" $1 $2 ; then
umount "$UPPER/run"
die "Cannot set up the overlay mount $2"
fi
+ elif [ "$LIVE" != "$UPPER" ] ; then
+ # With UPPER = LOWER we rather make a bind mount to LIVE
+ env CONFIG="$CONFIG" $PREMOUNT "$UPPER"
+ mount --bind $UPPER $LOWER
fi
- echo "Installing $OVERLAYDIR/reaper to $LIVE/.reaper"
- cp -p $OVERLAYDIR/reaper $LIVE/.reaper
-}
-
-start_services() {
- for S in "$@" ; do
- service $S start
+ grep ^SHARE= "$CONFIG" | while read A ; do
+ B="$(echo ${A#SHARE=})"
+ D="$(realpath "$B")"
+ [ "$D" = "$LOWER" ] && continue
+ if [ -d "$D" ] ; then
+ echo bind mount $D onto $LIVE$B
+ mkdir -p $LIVE$D
+ mount --bind $D $LIVE$B
+ fi
done
-}
-# find the upperdir option for an overlay mount line
-getupper() {
- sed 's/.*upperdir=\([^,]*\).*/\1/'
+ env CONFIG="$CONFIG" $POSTMOUNT "LIVE" "$UPPER"
}
-# Check if $1 is "live" and echo the
-# unshare and reaper process pids
+# Find the "unshare" process for $1 and echo the its pid and the pids
+# of its child processes.
is_live() {
local NAME=$1
local USPID="$(pgrep -f "unshare.* $NAME ")"
[ -z "$USPID" ] && return 1
- echo $USPID $(pgrep -f ".reaper $NAME")
+ echo "$USPID $(ps -hopid --ppid=$USPID)"
}
+# Find all overlay-boot processes and list their config files
list_running() {
- for C in $(pgrep -a overlay-boot | awk '{print $4}') ; do
- eval NAME="$(sed "/^NAME=.*/{s|^NAME=||;b};d" $C)"
- [ -z "$NAME" ] && NAME=$(basename $C .conf)
- echo $NAME
- done
+ pgrep -a overlay-boot | awk '{print $4}'
+}
+
+# Start cgroup v2 cpuset accounting if enabled.
+# Needs manual enabling, with:
+# mount -t cgroup2 cgroup2 /sys/fs/cgroup
+setup_cgroup2_accounting() {
+ local NAME="$1" ME="$2"
+ local ACCDIR="$(awk '$3 == "cgroup2" {print $2; exit}' /proc/mounts)"
+ [ -z "$ACCDIR" ] && return 0
+ mkdir -p "$ACCDIR/$NAME"
+ echo "$ME" > $ACCDIR/$NAME/cgroup.procs
}