mkosi.build

   1 #!/bin/sh
   2 # SPDX-License-Identifier: LGPL-2.1-or-later
   3 set -e
   4
   5 # This is a build script for OS image generation using mkosi (https://github.com/systemd/mkosi).
   6 # Simply invoke "mkosi" in the project directory to build an OS image.
   7
   8 ASAN_OPTIONS=strict_string_checks=1:detect_stack_use_after_return=1:check_initialization_order=1:strict_init_order=1:disable_coredump=0:use_madv_dontdump=1
   9 UBSAN_OPTIONS=print_stacktrace=1:print_summary=1:halt_on_error=1
  10
  11 # On Fedora "ld" is (unfortunately — if you ask me) managed via
  12 # "alternatives". Since we'd like to support building images in environments
  13 # with only /usr/ around (e.g. mkosi's UsrOnly=1 option), we have the problem
  14 # that /usr/bin/ld is a symlink that points to a non-existing file in
  15 # /etc/alternative/ in this mode. Let's work around this for now by manually
  16 # redirect "ld" to "ld.bfd", i.e. circumventing the /usr/bin/ld symlink.
  17 if [ ! -x /usr/bin/ld ] && [ -x /usr/bin/ld.bfd ]; then
  18         mkdir -p "$HOME"/bin
  19         ln -s /usr/bin/ld.bfd "$HOME"/bin/ld
  20         PATH="$HOME/bin:$PATH"
  21 fi
  22
  23 # If mkosi.builddir/ exists mkosi will set $BUILDDIR to it, let's then use it
  24 # as out-of-tree build dir. Otherwise, let's make up our own builddir.
  25 [ -z "$BUILDDIR" ] && BUILDDIR=build
  26
  27 # Meson uses Python 3 and requires a locale with an UTF-8 character map.
  28 # Not running under UTF-8 makes the `ninja test` step break with a CodecError.
  29 # So let's ensure we're running under UTF-8.
  30 #
  31 # If our current locale already is UTF-8, then we don't need to do anything:
  32 if [ "$(locale charmap 2>/dev/null)" != "UTF-8" ] ; then
  33         # Try using C.UTF-8 locale, if available. This locale is not shipped
  34         # by upstream glibc, so it's not available in all distros.
  35         # (In particular, it's not available in Arch Linux.)
  36         if locale -a | grep -q -E "C.UTF-8|C.utf8"; then
  37                 export LC_CTYPE=C.UTF-8
  38         # Finally, try something like en_US.UTF-8, which should be
  39         # available in Arch Linux, but is not present in Debian's
  40         # minimal image in our mkosi config.
  41         elif locale -a | grep -q en_US.utf8; then
  42                 export LC_CTYPE=en_US.UTF-8
  43         else
  44                 # If nothing works, fail early.
  45                 echo "*** Could not find a valid locale that supports UTF-8. ***" >&2
  46                 exit 1
  47         fi
  48 fi
  49
  50 # The bpftool script shipped by Ubuntu tries to find the actual program to run via querying `uname -r` and
  51 # using the current kernel version. This obviously doesn't work in containers. As a workaround, we override
  52 # the ubuntu script with a symlink to the first bpftool program we can find.
  53 for bpftool in /usr/lib/linux-tools/*/bpftool; do
  54         [ -x "$bpftool" ] || continue
  55         ln -sf "$bpftool" /usr/sbin/bpftool
  56         break
  57 done
  58
  59 if [ ! -f "$BUILDDIR"/build.ninja ] ; then
  60         sysvinit_path=$(realpath /etc/init.d)
  61
  62         init_path=$(realpath /sbin/init 2>/dev/null)
  63         if [ -z "$init_path" ] ; then
  64                 rootprefix=""
  65         else
  66                 rootprefix=${init_path%/lib/systemd/systemd}
  67                 rootprefix=/${rootprefix#/}
  68         fi
  69
  70         meson "$BUILDDIR" \
  71                 -D "sysvinit-path=$sysvinit_path" \
  72                 -D "rootprefix=$rootprefix" \
  73                 -D man=false \
  74                 -D translations=false \
  75                 -D version-tag="${VERSION_TAG}" \
  76                 -D mode=developer \
  77                 -D b_sanitize="${SANITIZERS:-none}" \
  78                 -D install-tests=true \
  79                 -D tests=unsafe \
  80                 -D slow-tests=true \
  81                 -D utmp=true \
  82                 -D hibernate=true \
  83                 -D ldconfig=true \
  84                 -D resolve=true \
  85                 -D efi=true \
  86                 -D tpm=true \
  87                 -D environment-d=true \
  88                 -D binfmt=true \
  89                 -D repart=true \
  90                 -D sysupdate=true \
  91                 -D coredump=true \
  92                 -D pstore=true \
  93                 -D oomd=true \
  94                 -D logind=true \
  95                 -D hostnamed=true \
  96                 -D localed=true \
  97                 -D machined=true \
  98                 -D portabled=true \
  99                 -D sysext=true \
 100                 -D userdb=true \
 101                 -D homed=true \
 102                 -D networkd=true \
 103                 -D timedated=true \
 104                 -D timesyncd=true \
 105                 -D remote=true \
 106                 -D nss-myhostname=true \
 107                 -D nss-mymachines=true \
 108                 -D nss-resolve=true \
 109                 -D nss-systemd=true \
 110                 -D firstboot=true \
 111                 -D randomseed=true \
 112                 -D backlight=true \
 113                 -D vconsole=true \
 114                 -D quotacheck=true \
 115                 -D sysusers=true \
 116                 -D tmpfiles=true \
 117                 -D importd=true \
 118                 -D hwdb=true \
 119                 -D rfkill=true \
 120                 -D xdg-autostart=true \
 121                 -D translations=true \
 122                 -D polkit=true \
 123                 -D acl=true \
 124                 -D audit=true \
 125                 -D blkid=true \
 126                 -D fdisk=true \
 127                 -D kmod=true  \
 128                 -D pam=true \
 129                 -D pwquality=true \
 130                 -D microhttpd=true \
 131                 -D libcryptsetup=true \
 132                 -D libcurl=true \
 133                 -D idn=true \
 134                 -D libidn2=true \
 135                 -D qrencode=true \
 136                 -D gcrypt=true \
 137                 -D gnutls=true \
 138                 -D openssl=true \
 139                 -D cryptolib=openssl \
 140                 -D p11kit=true \
 141                 -D libfido2=true \
 142                 -D tpm2=true \
 143                 -D elfutils=true \
 144                 -D zstd=true \
 145                 -D xkbcommon=true \
 146                 -D pcre2=true \
 147                 -D glib=true \
 148                 -D dbus=true \
 149                 -D gnu-efi=true \
 150                 -D kernel-install=true \
 151                 -D analyze=true \
 152                 -D bpf-framework=true
 153 fi
 154
 155 cd "$BUILDDIR"
 156 ninja "$@"
 157 if [ "$WITH_TESTS" = 1 ] ; then
 158         for id in 1 2 3; do
 159                 getent group $id >/dev/null || echo "g testgroup$id $id -" | ./systemd-sysusers -
 160         done
 161
 162         if [ -n "$SANITIZERS" ]; then
 163                 export ASAN_OPTIONS="$ASAN_OPTIONS"
 164                 export UBSAN_OPTIONS="$UBSAN_OPTIONS"
 165                 TIMEOUT_MULTIPLIER=3
 166         else
 167                 TIMEOUT_MULTIPLIER=1
 168         fi
 169
 170         meson test --print-errorlogs --timeout-multiplier=$TIMEOUT_MULTIPLIER
 171 fi
 172 cd "$SRCDIR"
 173
 174 # Ubuntu Focal is stuck with meson 0.53.0.
 175 if [ "$(meson -v | cut -d . -f 2)" -gt 53 ] ; then
 176         meson install -C "$BUILDDIR" --quiet --no-rebuild --only-changed
 177 else
 178         meson install -C "$BUILDDIR" --no-rebuild --only-changed
 179 fi
 180
 181 mkdir -p "$DESTDIR"/etc
 182
 183 cat >"$DESTDIR"/etc/issue <<EOF
 184 \S (built from systemd tree)
 185 Kernel \r on an \m (\l)
 186
 187 EOF
 188
 189 if [ -n "$IMAGE_ID" ] ; then
 190         mkdir -p "$DESTDIR"/usr/lib
 191         sed -n \
 192                 -e '/^IMAGE_ID=/!p' \
 193                 -e "\$aIMAGE_ID=$IMAGE_ID" <"/usr/lib/os-release" >"${DESTDIR}/usr/lib/os-release"
 194
 195         OSRELEASEFILE="$DESTDIR"/usr/lib/os-release
 196 else
 197         OSRELEASEFILE=/usr/lib/os-release
 198 fi
 199
 200
 201 if [ -n "$IMAGE_VERSION" ] ; then
 202         mkdir -p "$DESTDIR"/usr/lib
 203         sed -n \
 204                 -e '/^IMAGE_VERSION=/!p' \
 205                 -e "\$aIMAGE_VERSION=$IMAGE_VERSION" <$OSRELEASEFILE >"/tmp/os-release.tmp"
 206
 207         cat /tmp/os-release.tmp > "$DESTDIR"/usr/lib/os-release
 208         rm /tmp/os-release.tmp
 209 fi
 210
 211 # If $CI_BUILD is set, copy over the CI service which executes a service check
 212 # after boot and then shuts down the machine
 213 if [ -n "$CI_BUILD" ]; then
 214         mkdir -p "$DESTDIR/usr/lib/systemd/system"
 215         cp -v "$SRCDIR/test/mkosi-check-and-shutdown.service" "$DESTDIR/usr/lib/systemd/system/mkosi-check-and-shutdown.service"
 216         cp -v "$SRCDIR/test/mkosi-check-and-shutdown.sh" "$DESTDIR/usr/lib/systemd/mkosi-check-and-shutdown.sh"
 217         chmod +x "$DESTDIR/usr/lib/systemd/mkosi-check-and-shutdown.sh"
 218 fi
 219
 220 if [ -n "$SANITIZERS" ]; then
 221         LD_PRELOAD=$(ldd $BUILDDIR/systemd | grep libasan.so | awk '{print $3}')
 222
 223         mkdir -p "$DESTDIR/etc/systemd/system.conf.d"
 224
 225         cat > "$DESTDIR/etc/systemd/system.conf.d/10-asan.conf" <<EOF
 226 [Manager]
 227 ManagerEnvironment=ASAN_OPTIONS=$ASAN_OPTIONS\\
 228                    UBSAN_OPTIONS=$UBSAN_OPTIONS\\
 229                    LD_PRELOAD=$LD_PRELOAD
 230 DefaultEnvironment=ASAN_OPTIONS=$ASAN_OPTIONS\\
 231                    UBSAN_OPTIONS=$UBSAN_OPTIONS\\
 232                    LD_PRELOAD=$LD_PRELOAD
 233 EOF
 234
 235         # ASAN logs to stderr by default. However, journald's stderr is connected to /dev/null, so we lose
 236         # all the ASAN logs. To rectify that, let's connect journald's stdout to the console so that any
 237         # sanitizer failures appear directly on the user's console.
 238         mkdir -p "$DESTDIR/etc/systemd/system/systemd-journald.service.d"
 239
 240         cat > "$DESTDIR/etc/systemd/system/systemd-journald.service.d/10-stdout-tty.conf" <<EOF
 241 [Service]
 242 StandardOutput=tty
 243 EOF
 244
 245         # Both systemd and util-linux's login call vhangup() on /dev/console which disconnects all users.
 246         # This means systemd-journald can't log to /dev/console even if we configure `StandardOutput=tty`. As
 247         # a workaround, we modify console-getty.service to disable systemd's vhangup() and disallow login
 248         # from calling vhangup() so that journald's ASAN logs correctly end up in the console.
 249
 250         mkdir -p "$DESTDIR/etc/systemd/system/console-getty.service.d"
 251
 252         cat > "$DESTDIR/etc/systemd/system/console-getty.service.d/10-no-vhangup.conf" <<EOF
 253 [Service]
 254 TTYVHangup=no
 255 CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
 256 EOF
 257 fi
 258
 259 # Make sure services aren't enabled by default on Debian/Ubuntu.
 260 mkdir -p "$DESTDIR/etc/systemd/system-preset"
 261 echo "disable *" > "$DESTDIR/etc/systemd/system-preset/99-mkosi.preset"