2 # SPDX-License-Identifier: LGPL-2.1-or-later
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.
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
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
19 ln -s /usr
/bin
/ld.bfd
"$HOME"/bin
/ld
20 PATH
="$HOME/bin:$PATH"
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
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.
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
44 # If nothing works, fail early.
45 echo "*** Could not find a valid locale that supports UTF-8. ***" >&2
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
59 # CentOS Stream 8 includes bpftool 4.18.0 which is lower than what we need. However, they've backported the
60 # specific feature we need ("gen skeleton") to this version, so we replace bpftool with a script that reports
61 # version 5.6.0 to satisfy meson which makes bpf work on CentOS Stream 8 as well.
62 if [ "$(grep '^ID=' /etc/os-release)" = "ID=\"centos\"" ] && [ "$(grep '^VERSION=' /etc/os-release)" = "VERSION=\"8\"" ]; then
63 cp /usr
/sbin
/bpftool
/usr
/sbin
/bpftool.real
64 cat >/usr
/sbin
/bpftool
<<EOF
66 if [ "\$1" = --version ]; then
69 exec /usr/sbin/bpftool.real \$@
72 chmod +x
/usr
/sbin
/bpftool
75 if [ ! -f "$BUILDDIR"/build.ninja
] ; then
76 sysvinit_path
=$
(realpath
/etc
/init.d
)
78 init_path
=$
(realpath
/sbin
/init
2>/dev
/null
)
79 if [ -z "$init_path" ] ; then
82 rootprefix
=${init_path%/lib/systemd/systemd}
83 rootprefix
=/${rootprefix#/}
86 meson setup
"$BUILDDIR" \
87 -D "sysvinit-path=$sysvinit_path" \
88 -D "rootprefix=$rootprefix" \
90 -D translations
=false \
91 -D version-tag
="${VERSION_TAG}" \
93 -D b_sanitize
="${SANITIZERS:-none}" \
94 -D install-tests
=true \
103 -D environment-d
=true \
122 -D nss-myhostname
=true \
123 -D nss-mymachines
=true \
124 -D nss-resolve
=true \
125 -D nss-systemd
=true \
136 -D xdg-autostart
=true \
137 -D translations
=true \
147 -D libcryptsetup
=true \
155 -D cryptolib
=openssl \
166 -D kernel-install
=true \
168 -D bpf-framework
=true
173 if [ "$WITH_TESTS" = 1 ] ; then
175 getent group
$id >/dev
/null ||
echo "g testgroup$id $id -" | .
/systemd-sysusers
-
178 if [ -n "$SANITIZERS" ]; then
179 export ASAN_OPTIONS
="$ASAN_OPTIONS"
180 export UBSAN_OPTIONS
="$UBSAN_OPTIONS"
186 meson
test --print-errorlogs --timeout-multiplier=$TIMEOUT_MULTIPLIER
190 # Ubuntu Focal is stuck with meson 0.53.0.
191 if [ "$(meson -v | cut -d . -f 2)" -gt 53 ] ; then
192 meson
install -C "$BUILDDIR" --quiet --no-rebuild --only-changed
194 meson
install -C "$BUILDDIR" --no-rebuild --only-changed
197 mkdir
-p "$DESTDIR"/etc
199 cat >"$DESTDIR"/etc
/issue
<<EOF
200 \S (built from systemd tree)
201 Kernel \r on an \m (\l)
205 if [ -n "$IMAGE_ID" ] ; then
206 mkdir
-p "$DESTDIR"/usr
/lib
208 -e '/^IMAGE_ID=/!p' \
209 -e "\$aIMAGE_ID=$IMAGE_ID" <"/usr/lib/os-release" >"${DESTDIR}/usr/lib/os-release"
211 OSRELEASEFILE
="$DESTDIR"/usr
/lib
/os-release
213 OSRELEASEFILE
=/usr
/lib
/os-release
217 if [ -n "$IMAGE_VERSION" ] ; then
218 mkdir
-p "$DESTDIR"/usr
/lib
220 -e '/^IMAGE_VERSION=/!p' \
221 -e "\$aIMAGE_VERSION=$IMAGE_VERSION" <$OSRELEASEFILE >"/tmp/os-release.tmp"
223 cat /tmp
/os-release.tmp
>"$DESTDIR"/usr
/lib
/os-release
224 rm /tmp
/os-release.tmp
227 # If $CI_BUILD is set, copy over the CI service which executes a service check
228 # after boot and then shuts down the machine
229 if [ -n "$CI_BUILD" ]; then
230 mkdir
-p "$DESTDIR/usr/lib/systemd/system"
231 cp -v "$SRCDIR/test/mkosi-check-and-shutdown.service" "$DESTDIR/usr/lib/systemd/system/mkosi-check-and-shutdown.service"
232 cp -v "$SRCDIR/test/mkosi-check-and-shutdown.sh" "$DESTDIR/usr/lib/systemd/mkosi-check-and-shutdown.sh"
233 chmod +x
"$DESTDIR/usr/lib/systemd/mkosi-check-and-shutdown.sh"
236 if [ -n "$SANITIZERS" ]; then
237 LD_PRELOAD
=$
(ldd
$BUILDDIR/systemd |
grep libasan.so |
awk '{print $3}')
239 mkdir
-p "$DESTDIR/etc/systemd/system.conf.d"
241 cat >"$DESTDIR/etc/systemd/system.conf.d/10-asan.conf" <<EOF
243 ManagerEnvironment=ASAN_OPTIONS=$ASAN_OPTIONS\\
244 UBSAN_OPTIONS=$UBSAN_OPTIONS\\
245 LD_PRELOAD=$LD_PRELOAD
246 DefaultEnvironment=ASAN_OPTIONS=$ASAN_OPTIONS\\
247 UBSAN_OPTIONS=$UBSAN_OPTIONS\\
248 LD_PRELOAD=$LD_PRELOAD
251 # ASAN logs to stderr by default. However, journald's stderr is connected to /dev/null, so we lose
252 # all the ASAN logs. To rectify that, let's connect journald's stdout to the console so that any
253 # sanitizer failures appear directly on the user's console.
254 mkdir
-p "$DESTDIR/etc/systemd/system/systemd-journald.service.d"
256 cat >"$DESTDIR/etc/systemd/system/systemd-journald.service.d/10-stdout-tty.conf" <<EOF
261 # Both systemd and util-linux's login call vhangup() on /dev/console which disconnects all users.
262 # This means systemd-journald can't log to /dev/console even if we configure `StandardOutput=tty`. As
263 # a workaround, we modify console-getty.service to disable systemd's vhangup() and disallow login
264 # from calling vhangup() so that journald's ASAN logs correctly end up in the console.
266 mkdir
-p "$DESTDIR/etc/systemd/system/console-getty.service.d"
268 cat >"$DESTDIR/etc/systemd/system/console-getty.service.d/10-no-vhangup.conf" <<EOF
271 CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
275 # Make sure services aren't enabled by default on Debian/Ubuntu.
276 mkdir
-p "$DESTDIR/etc/systemd/system-preset"
277 echo "disable *" >"$DESTDIR/etc/systemd/system-preset/99-mkosi.preset"
279 if [ -d mkosi.kernel
/ ]; then
280 cd "$SRCDIR/mkosi.kernel"
281 mkdir
-p "$BUILDDIR/mkosi.kernel"
283 # Ensure fast incremental builds by fixating these values which usually change for each build.
284 export KBUILD_BUILD_TIMESTAMP
="Fri Jun 5 15:58:00 CEST 2015"
285 export KBUILD_BUILD_HOST
="mkosi"
287 scripts
/kconfig
/merge_config.sh
-O "$BUILDDIR/mkosi.kernel" \
288 ..
/mkosi.kernel.config \
289 tools
/testing
/selftests
/bpf
/config.x86_64 \
290 tools
/testing
/selftests
/bpf
/config
292 make O
="$BUILDDIR/mkosi.kernel" -j "$(nproc)"
294 KERNEL_RELEASE
="$(make O=$BUILDDIR/mkosi.kernel -s kernelrelease)"
295 mkdir
-p "$DESTDIR/usr/lib/modules/$KERNEL_RELEASE"
296 make O
="$BUILDDIR/mkosi.kernel" INSTALL_HDR_PATH
=/usr headers_install
297 make O
="$BUILDDIR/mkosi.kernel" INSTALL_MOD_PATH
="$DESTDIR/usr" modules_install
298 make O
="$BUILDDIR/mkosi.kernel" INSTALL_PATH
="$DESTDIR/usr/lib/modules/$KERNEL_RELEASE" install
299 mkdir
-p "$DESTDIR/usr/lib/kernel/selftests"
300 make -C tools
/testing
/selftests
-j "$(nproc)" O
="$BUILDDIR/mkosi.kernel" KSFT_INSTALL_PATH
="$DESTDIR/usr/lib/kernel/selftests" SKIP_TARGETS
="" install
302 ln -sf /usr
/lib
/kernel
/selftests
/bpf
/bpftool
"$DESTDIR/usr/bin/bpftool"