test/test-functions

   1 #!/bin/bash
   2 # -*- mode: shell-script; indent-tabs-mode: nil; sh-basic-offset: 4; -*-
   3 # ex: ts=8 sw=4 sts=4 et filetype=sh
   4 PATH=/sbin:/bin:/usr/sbin:/usr/bin
   5 export PATH
   6
   7 LOOKS_LIKE_DEBIAN=$(source /etc/os-release && [[ "$ID" = "debian" || " $ID_LIKE " = *" debian "* ]] && echo yes || true)
   8 LOOKS_LIKE_ARCH=$(source /etc/os-release && [[ "$ID" = "arch" || " $ID_LIKE " = *" arch "* ]] && echo yes || true)
   9 LOOKS_LIKE_SUSE=$(source /etc/os-release && [[ " $ID_LIKE " = *" suse "* ]] && echo yes || true)
  10 KERNEL_VER=${KERNEL_VER-$(uname -r)}
  11 KERNEL_MODS="/lib/modules/$KERNEL_VER/"
  12 QEMU_TIMEOUT="${QEMU_TIMEOUT:-infinity}"
  13 NSPAWN_TIMEOUT="${NSPAWN_TIMEOUT:-infinity}"
  14 TIMED_OUT=  # will be 1 after run_* if *_TIMEOUT is set and test timed out
  15 [[ "$LOOKS_LIKE_SUSE" ]] && FSTYPE="${FSTYPE:-btrfs}" || FSTYPE="${FSTYPE:-ext4}"
  16 UNIFIED_CGROUP_HIERARCHY="${UNIFIED_CGROUP_HIERARCHY:-default}"
  17 EFI_MOUNT="$(bootctl -p 2>/dev/null || echo /boot)"
  18
  19 if ! ROOTLIBDIR=$(pkg-config --variable=systemdutildir systemd); then
  20     echo "WARNING! Cannot determine rootlibdir from pkg-config, assuming /usr/lib/systemd" >&2
  21     ROOTLIBDIR=/usr/lib/systemd
  22 fi
  23
  24 PATH_TO_INIT=$ROOTLIBDIR/systemd
  25
  26 BASICTOOLS="test sh bash setsid loadkeys setfont login sulogin gzip sleep echo mount umount cryptsetup date dmsetup modprobe sed cmp tee rm true false chmod chown ln xargs"
  27 DEBUGTOOLS="df free ls stty cat ps ln ip route dmesg dhclient mkdir cp ping dhclient strace less grep id tty touch du sort hostname find"
  28
  29 STATEDIR="${BUILD_DIR:-.}/test/$(basename $(dirname $(realpath $0)))"
  30 STATEFILE="$STATEDIR/.testdir"
  31 TESTLOG="$STATEDIR/test.log"
  32
  33 is_built_with_asan() {
  34     if ! type -P objdump >/dev/null; then
  35         ddebug "Failed to find objdump. Assuming systemd hasn't been built with ASAN."
  36         return 1
  37     fi
  38
  39     # Borrowed from https://github.com/google/oss-fuzz/blob/cd9acd02f9d3f6e80011cc1e9549be526ce5f270/infra/base-images/base-runner/bad_build_check#L182
  40     local _asan_calls=$(objdump -dC $BUILD_DIR/systemd | egrep "callq\s+[0-9a-f]+\s+<__asan" -c)
  41     if (( $_asan_calls < 1000 )); then
  42         return 1
  43     else
  44         return 0
  45     fi
  46 }
  47
  48 IS_BUILT_WITH_ASAN=$(is_built_with_asan && echo yes || echo no)
  49
  50 if [[ "$IS_BUILT_WITH_ASAN" = "yes" ]]; then
  51     STRIP_BINARIES=no
  52     SKIP_INITRD=yes
  53     PATH_TO_INIT=$ROOTLIBDIR/systemd-under-asan
  54 fi
  55
  56 function find_qemu_bin() {
  57     # SUSE and Red Hat call the binary qemu-kvm. Debian and Gentoo call it kvm.
  58     # Either way, only use this version if we aren't running in KVM, because
  59     # nested KVM is flaky still.
  60     if [ `systemd-detect-virt -v` != kvm ] ; then
  61         [ "$QEMU_BIN" ] || QEMU_BIN=$(which -a kvm qemu-kvm 2>/dev/null | grep '^/' -m1)
  62     fi
  63
  64     [ "$ARCH" ] || ARCH=$(uname -m)
  65     case $ARCH in
  66     x86_64)
  67         # QEMU's own build system calls it qemu-system-x86_64
  68         [ "$QEMU_BIN" ] || QEMU_BIN=$(which -a qemu-system-x86_64 2>/dev/null | grep '^/' -m1)
  69         ;;
  70     i*86)
  71         # new i386 version of QEMU
  72         [ "$QEMU_BIN" ] || QEMU_BIN=$(which -a qemu-system-i386 2>/dev/null | grep '^/' -m1)
  73
  74         # i386 version of QEMU
  75         [ "$QEMU_BIN" ] || QEMU_BIN=$(which -a qemu 2>/dev/null | grep '^/' -m1)
  76         ;;
  77     ppc64*)
  78         [ "$QEMU_BIN" ] || QEMU_BIN=$(which -a qemu-system-$ARCH 2>/dev/null | grep '^/' -m1)
  79         ;;
  80     esac
  81
  82     if [ ! -e "$QEMU_BIN" ]; then
  83         echo "Could not find a suitable QEMU binary" >&2
  84         return 1
  85     fi
  86 }
  87
  88 # Return 0 if QEMU did run (then you must check the result state/logs for actual
  89 # success), or 1 if QEMU is not available.
  90 run_qemu() {
  91     if [ -f /etc/machine-id ]; then
  92         read MACHINE_ID < /etc/machine-id
  93         [ -z "$INITRD" ] && [ -e "$EFI_MOUNT/$MACHINE_ID/$KERNEL_VER/initrd" ] \
  94             && INITRD="$EFI_MOUNT/$MACHINE_ID/$KERNEL_VER/initrd"
  95         [ -z "$KERNEL_BIN" ] && [ -e "$EFI_MOUNT/$MACHINE_ID/$KERNEL_VER/linux" ] \
  96             && KERNEL_BIN="$EFI_MOUNT/$MACHINE_ID/$KERNEL_VER/linux"
  97     fi
  98
  99     if [[ ! "$KERNEL_BIN" ]]; then
 100         if [[ "$LOOKS_LIKE_ARCH" ]]; then
 101             KERNEL_BIN=/boot/vmlinuz-linux
 102         else
 103             KERNEL_BIN=/boot/vmlinuz-$KERNEL_VER
 104         fi
 105     fi
 106
 107     default_fedora_initrd=/boot/initramfs-${KERNEL_VER}.img
 108     default_debian_initrd=/boot/initrd.img-${KERNEL_VER}
 109     default_arch_initrd=/boot/initramfs-linux.img
 110     default_suse_initrd=/boot/initrd-${KERNEL_VER}
 111     if [[ ! "$INITRD" ]]; then
 112         if [[ -e "$default_fedora_initrd" ]]; then
 113             INITRD="$default_fedora_initrd"
 114         elif [[ "$LOOKS_LIKE_DEBIAN" && -e "$default_debian_initrd" ]]; then
 115             INITRD="$default_debian_initrd"
 116         elif [[ "$LOOKS_LIKE_ARCH" && -e "$default_arch_initrd" ]]; then
 117             INITRD="$default_arch_initrd"
 118         elif [[ "$LOOKS_LIKE_SUSE" && -e "$default_suse_initrd" ]]; then
 119             INITRD="$default_suse_initrd"
 120         fi
 121     fi
 122
 123     [ "$QEMU_SMP" ]   || QEMU_SMP=1
 124
 125     find_qemu_bin || return 1
 126
 127     local _cgroup_args
 128     if [[ "$UNIFIED_CGROUP_HIERARCHY" = "yes" ]]; then
 129         _cgroup_args="systemd.unified_cgroup_hierarchy=yes"
 130     elif [[ "$UNIFIED_CGROUP_HIERARCHY" = "no" ]]; then
 131         _cgroup_args="systemd.unified_cgroup_hierarchy=no systemd.legacy_systemd_cgroup_controller=yes"
 132     elif [[ "$UNIFIED_CGROUP_HIERARCHY" = "hybrid" ]]; then
 133         _cgroup_args="systemd.unified_cgroup_hierarchy=no systemd.legacy_systemd_cgroup_controller=no"
 134     elif [[ "$UNIFIED_CGROUP_HIERARCHY" != "default" ]]; then
 135         dfatal "Unknown UNIFIED_CGROUP_HIERARCHY. Got $UNIFIED_CGROUP_HIERARCHY, expected [yes|no|hybrid|default]"
 136         exit 1
 137     fi
 138
 139 if [[ "$LOOKS_LIKE_SUSE" ]]; then
 140     PARAMS+="rd.hostonly=0"
 141 else
 142     PARAMS+="ro"
 143 fi
 144
 145 KERNEL_APPEND="$PARAMS \
 146 root=/dev/sda1 \
 147 raid=noautodetect \
 148 loglevel=2 \
 149 init=$PATH_TO_INIT \
 150 console=ttyS0 \
 151 selinux=0 \
 152 printk.devkmsg=on \
 153 $_cgroup_args \
 154 $KERNEL_APPEND \
 155 "
 156
 157     QEMU_OPTIONS="-smp $QEMU_SMP \
 158 -net none \
 159 -m 512M \
 160 -nographic \
 161 -kernel $KERNEL_BIN \
 162 -drive format=raw,cache=unsafe,file=${TESTDIR}/rootdisk.img \
 163 "
 164
 165     if [[ "$INITRD" && "$SKIP_INITRD" != "yes" ]]; then
 166         QEMU_OPTIONS="$QEMU_OPTIONS -initrd $INITRD"
 167     fi
 168
 169     # Let's use KVM if it is available, but let's avoid using nested KVM as that is still flaky
 170     if [ -c /dev/kvm -a `systemd-detect-virt -v` != kvm ]; then
 171         QEMU_OPTIONS="$QEMU_OPTIONS -machine accel=kvm -enable-kvm -cpu host"
 172     fi
 173
 174     if [[ "$QEMU_TIMEOUT" != "infinity" ]]; then
 175         QEMU_BIN="timeout --foreground $QEMU_TIMEOUT $QEMU_BIN"
 176     fi
 177     (set -x; $QEMU_BIN $QEMU_OPTIONS -append "$KERNEL_APPEND")
 178     rc=$?
 179     if [ "$rc" = 124 ] && [ "$QEMU_TIMEOUT" != "infinity" ]; then
 180         derror "test timed out after $QEMU_TIMEOUT s"
 181         TIMED_OUT=1
 182     else
 183         [ "$rc" != 0 ] && derror "QEMU failed with exit code $rc"
 184     fi
 185     return 0
 186 }
 187
 188 # Return 0 if nspawn did run (then you must check the result state/logs for actual
 189 # success), or 1 if nspawn is not available.
 190 run_nspawn() {
 191     [[ -d /run/systemd/system ]] || return 1
 192
 193     local _nspawn_cmd="$BUILD_DIR/systemd-nspawn $NSPAWN_ARGUMENTS --register=no --kill-signal=SIGKILL --directory=$TESTDIR/$1 $PATH_TO_INIT $KERNEL_APPEND"
 194     if [[ "$NSPAWN_TIMEOUT" != "infinity" ]]; then
 195         _nspawn_cmd="timeout --foreground $NSPAWN_TIMEOUT $_nspawn_cmd"
 196     fi
 197
 198     if [[ "$UNIFIED_CGROUP_HIERARCHY" = "hybrid" ]]; then
 199         dwarn "nspawn doesn't support UNIFIED_CGROUP_HIERARCHY=hybrid, skipping"
 200         exit
 201     elif [[ "$UNIFIED_CGROUP_HIERARCHY" = "yes" || "$UNIFIED_CGROUP_HIERARCHY" = "no" ]]; then
 202         _nspawn_cmd="env UNIFIED_CGROUP_HIERARCHY=$UNIFIED_CGROUP_HIERARCHY $_nspawn_cmd"
 203     elif [[ "$UNIFIED_CGROUP_HIERARCHY" = "default" ]]; then
 204         _nspawn_cmd="env --unset=UNIFIED_CGROUP_HIERARCHY $_nspawn_cmd"
 205     else
 206         dfatal "Unknown UNIFIED_CGROUP_HIERARCHY. Got $UNIFIED_CGROUP_HIERARCHY, expected [yes|no|hybrid|default]"
 207         exit 1
 208     fi
 209
 210     (set -x; $_nspawn_cmd)
 211     rc=$?
 212     if [ "$rc" = 124 ] && [ "$NSPAWN_TIMEOUT" != "infinity" ]; then
 213         derror "test timed out after $NSPAWN_TIMEOUT s"
 214         TIMED_OUT=1
 215     else
 216         [ "$rc" != 0 ] && derror "nspawn failed with exit code $rc"
 217     fi
 218     return 0
 219 }
 220
 221 setup_basic_environment() {
 222     # create the basic filesystem layout
 223     setup_basic_dirs
 224
 225     install_systemd
 226     install_missing_libraries
 227     install_config_files
 228     create_rc_local
 229     install_basic_tools
 230     install_libnss
 231     install_pam
 232     install_dbus
 233     install_fonts
 234     install_keymaps
 235     install_terminfo
 236     install_execs
 237     install_fsck
 238     install_plymouth
 239     install_debug_tools
 240     install_ld_so_conf
 241     setup_selinux
 242     strip_binaries
 243     install_depmod_files
 244     generate_module_dependencies
 245     if [[ "$IS_BUILT_WITH_ASAN" = "yes" ]]; then
 246          create_asan_wrapper
 247     fi
 248 }
 249
 250 setup_selinux() {
 251     # don't forget KERNEL_APPEND='... selinux=1 ...'
 252     if [[ "$SETUP_SELINUX" != "yes" ]]; then
 253         ddebug "Don't setup SELinux"
 254         return 0
 255     fi
 256     ddebug "Setup SELinux"
 257     local _conf_dir=/etc/selinux
 258     local _fixfiles_tools="bash uname cat sort uniq awk grep egrep head expr find rm secon setfiles"
 259
 260     rm -rf $initdir/$_conf_dir
 261     if ! cp -ar $_conf_dir $initdir/$_conf_dir; then
 262         dfatal "Failed to copy $_conf_dir"
 263         exit 1
 264     fi
 265
 266     cat <<EOF >$initdir/etc/systemd/system/autorelabel.service
 267 [Unit]
 268 Description=Relabel all filesystems
 269 DefaultDependencies=no
 270 Requires=local-fs.target
 271 Conflicts=shutdown.target
 272 After=local-fs.target
 273 Before=sysinit.target shutdown.target
 274 ConditionSecurity=selinux
 275 ConditionPathExists=|/.autorelabel
 276
 277 [Service]
 278 ExecStart=/bin/sh -x -c 'echo 0 >/sys/fs/selinux/enforce && fixfiles -f -F relabel && rm /.autorelabel && systemctl --force reboot'
 279 Type=oneshot
 280 TimeoutSec=0
 281 RemainAfterExit=yes
 282 EOF
 283
 284     touch $initdir/.autorelabel
 285     mkdir -p $initdir/etc/systemd/system/basic.target.wants
 286     ln -fs autorelabel.service $initdir/etc/systemd/system/basic.target.wants/autorelabel.service
 287
 288     dracut_install $_fixfiles_tools
 289     dracut_install fixfiles
 290     dracut_install sestatus
 291 }
 292
 293 install_valgrind() {
 294     if ! type -p valgrind; then
 295         dfatal "Failed to install valgrind"
 296         exit 1
 297     fi
 298
 299     local _valgrind_bins=$(strace -e execve valgrind /bin/true 2>&1 >/dev/null | perl -lne 'print $1 if /^execve\("([^"]+)"/')
 300     dracut_install $_valgrind_bins
 301
 302     local _valgrind_libs=$(LD_DEBUG=files valgrind /bin/true 2>&1 >/dev/null | perl -lne 'print $1 if m{calling init: (/.*vgpreload_.*)}')
 303     dracut_install $_valgrind_libs
 304
 305     local _valgrind_dbg_and_supp=$(
 306         strace -e open valgrind /bin/true 2>&1 >/dev/null |
 307         perl -lne 'if (my ($fname) = /^open\("([^"]+).*= (?!-)\d+/) { print $fname if $fname =~ /debug|\.supp$/ }'
 308     )
 309     dracut_install $_valgrind_dbg_and_supp
 310 }
 311
 312 create_valgrind_wrapper() {
 313     local _valgrind_wrapper=$initdir/$ROOTLIBDIR/systemd-under-valgrind
 314     ddebug "Create $_valgrind_wrapper"
 315     cat >$_valgrind_wrapper <<EOF
 316 #!/bin/bash
 317
 318 mount -t proc proc /proc
 319 exec valgrind --leak-check=full --log-file=/valgrind.out $ROOTLIBDIR/systemd "\$@"
 320 EOF
 321     chmod 0755 $_valgrind_wrapper
 322 }
 323
 324 create_asan_wrapper() {
 325     local _asan_wrapper=$initdir/$ROOTLIBDIR/systemd-under-asan
 326     ddebug "Create $_asan_wrapper"
 327     cat >$_asan_wrapper <<EOF
 328 #!/bin/bash
 329
 330 set -x
 331
 332 DEFAULT_ASAN_OPTIONS=strict_string_checks=1:detect_stack_use_after_return=1:check_initialization_order=1:strict_init_order=1
 333 DEFAULT_UBSAN_OPTIONS=print_stacktrace=1:print_summary=1
 334 DEFAULT_ENVIRONMENT="ASAN_OPTIONS=\$DEFAULT_ASAN_OPTIONS UBSAN_OPTIONS=\$DEFAULT_UBSAN_OPTIONS:halt_on_error=1"
 335
 336 mount -t proc proc /proc
 337 mount -t sysfs sysfs /sys
 338 mount -o remount,rw /
 339
 340 PATH_TO_ASAN=\$(find / -name '*libasan*' | sed 1q)
 341 if [[ "\$PATH_TO_ASAN" ]]; then
 342   # A lot of services (most notably dbus) won't start without preloading libasan
 343   # See https://github.com/systemd/systemd/issues/5004
 344   DEFAULT_ENVIRONMENT="\$DEFAULT_ENVIRONMENT LD_PRELOAD=\$PATH_TO_ASAN"
 345 fi
 346 echo DefaultEnvironment=\$DEFAULT_ENVIRONMENT >>/etc/systemd/system.conf
 347
 348 # ASAN and syscall filters aren't compatible with each other.
 349 find / -name '*.service' -type f | xargs sed -i 's/^\\(MemoryDeny\\|SystemCall\\)/#\\1/'
 350
 351 # The redirection of ASAN reports to a file prevents them from ending up in /dev/null.
 352 # But, apparently, sometimes it doesn't work: https://github.com/google/sanitizers/issues/886.
 353 JOURNALD_CONF_DIR=/etc/systemd/system/systemd-journald.service.d
 354 mkdir -p "\$JOURNALD_CONF_DIR"
 355 printf "[Service]\nEnvironment=ASAN_OPTIONS=\$DEFAULT_ASAN_OPTIONS:log_path=/systemd-journald.asan.log\n" >"\$JOURNALD_CONF_DIR/env.conf"
 356
 357 export ASAN_OPTIONS=\$DEFAULT_ASAN_OPTIONS:log_path=/systemd.asan.log UBSAN_OPTIONS=\$DEFAULT_UBSAN_OPTIONS
 358 exec  $ROOTLIBDIR/systemd "\$@"
 359 EOF
 360
 361     chmod 0755 $_asan_wrapper
 362 }
 363
 364 create_strace_wrapper() {
 365     local _strace_wrapper=$initdir/$ROOTLIBDIR/systemd-under-strace
 366     ddebug "Create $_strace_wrapper"
 367     cat >$_strace_wrapper <<EOF
 368 #!/bin/bash
 369
 370 exec strace -D -o /strace.out $ROOTLIBDIR/systemd "\$@"
 371 EOF
 372     chmod 0755 $_strace_wrapper
 373 }
 374
 375 install_fsck() {
 376     dracut_install /sbin/fsck*
 377     dracut_install -o /bin/fsck*
 378
 379     # fskc.reiserfs calls reiserfsck. so, install it
 380     dracut_install -o reiserfsck
 381 }
 382
 383 install_dmevent() {
 384     instmods dm_crypt =crypto
 385     type -P dmeventd >/dev/null && dracut_install dmeventd
 386     inst_libdir_file "libdevmapper-event.so*"
 387     if [[ "$LOOKS_LIKE_DEBIAN" ]]; then
 388         # dmsetup installs 55-dm and 60-persistent-storage-dm on Debian/Ubuntu
 389         # and since buster/bionic 95-dm-notify.rules
 390         # see https://gitlab.com/debian-lvm/lvm2/blob/master/debian/patches/udev.patch
 391         inst_rules 55-dm.rules 60-persistent-storage-dm.rules 95-dm-notify.rules
 392     else
 393         inst_rules 10-dm.rules 13-dm-disk.rules 95-dm-notify.rules
 394     fi
 395 }
 396
 397 install_systemd() {
 398     # install compiled files
 399     local _ninja_bin=$(type -P ninja || type -P ninja-build)
 400     if [[ -z "$_ninja_bin" ]]; then
 401         dfatal "ninja was not found"
 402         exit 1
 403     fi
 404     (set -x; DESTDIR=$initdir "$_ninja_bin" -C $BUILD_DIR install)
 405     # remove unneeded documentation
 406     rm -fr $initdir/usr/share/{man,doc}
 407     # we strip binaries since debug symbols increase binaries size a lot
 408     # and it could fill the available space
 409     strip_binaries
 410
 411    [[ "$LOOKS_LIKE_SUSE" ]] && setup_suse
 412
 413     # enable debug logging in PID1
 414     echo LogLevel=debug >> $initdir/etc/systemd/system.conf
 415 }
 416
 417 get_ldpath() {
 418     local _bin="$1"
 419     objdump -p "$_bin" 2>/dev/null | awk "/R(UN)?PATH/ { print \"$initdir\" \$2 }" | paste -sd :
 420 }
 421
 422 install_missing_libraries() {
 423     # install possible missing libraries
 424     for i in $initdir{,/usr}/{sbin,bin}/* $initdir{,/usr}/lib/systemd/{,tests/{,manual/,unsafe/}}*; do
 425         LD_LIBRARY_PATH=$(get_ldpath $i) inst_libs $i
 426     done
 427 }
 428
 429 create_empty_image() {
 430     local _size=500
 431     if [[ "$STRIP_BINARIES" = "no" ]]; then
 432         _size=$((2*_size))
 433     fi
 434     rm -f "$TESTDIR/rootdisk.img"
 435     # Create the blank file to use as a root filesystem
 436     dd if=/dev/null of="$TESTDIR/rootdisk.img" bs=1M seek="$_size"
 437     LOOPDEV=$(losetup --show -P -f $TESTDIR/rootdisk.img)
 438     [ -b "$LOOPDEV" ] || return 1
 439     echo "LOOPDEV=$LOOPDEV" >> $STATEFILE
 440     sfdisk "$LOOPDEV" <<EOF
 441 ,$((_size-10))M
 442 ,
 443 EOF
 444
 445     udevadm settle
 446
 447     local _label="-L systemd"
 448     # mkfs.reiserfs doesn't know -L. so, use --label instead
 449     [[ "$FSTYPE" == "reiserfs" ]] && _label="--label systemd"
 450     if ! mkfs -t "${FSTYPE}" ${_label} "${LOOPDEV}p1" -q; then
 451         dfatal "Failed to mkfs -t ${FSTYPE}"
 452         exit 1
 453     fi
 454 }
 455
 456 check_result_nspawn() {
 457     local ret=1
 458     [[ -e $TESTDIR/$1/testok ]] && ret=0
 459     [[ -f $TESTDIR/$1/failed ]] && cp -a $TESTDIR/$1/failed $TESTDIR
 460     cp -a $TESTDIR/$1/var/log/journal $TESTDIR
 461     [[ -f $TESTDIR/failed ]] && cat $TESTDIR/failed
 462     ls -l $TESTDIR/journal/*/*.journal
 463     test -s $TESTDIR/failed && ret=$(($ret+1))
 464     [ -n "$TIMED_OUT" ] && ret=$(($ret+1))
 465     return $ret
 466 }
 467
 468 # can be overridden in specific test
 469 check_result_qemu() {
 470     local ret=1
 471     mkdir -p $TESTDIR/root
 472     mount ${LOOPDEV}p1 $TESTDIR/root
 473     [[ -e $TESTDIR/root/testok ]] && ret=0
 474     [[ -f $TESTDIR/root/failed ]] && cp -a $TESTDIR/root/failed $TESTDIR
 475     cp -a $TESTDIR/root/var/log/journal $TESTDIR
 476     umount $TESTDIR/root
 477     [[ -f $TESTDIR/failed ]] && cat $TESTDIR/failed
 478     ls -l $TESTDIR/journal/*/*.journal
 479     test -s $TESTDIR/failed && ret=$(($ret+1))
 480     [ -n "$TIMED_OUT" ] && ret=$(($ret+1))
 481     return $ret
 482 }
 483
 484 strip_binaries() {
 485     if [[ "$STRIP_BINARIES" = "no" ]]; then
 486         ddebug "Don't strip binaries"
 487         return 0
 488     fi
 489     ddebug "Strip binaries"
 490     find "$initdir" -executable -not -path '*/lib/modules/*.ko' -type f | xargs strip --strip-unneeded | ddebug
 491 }
 492
 493 create_rc_local() {
 494     mkdir -p $initdir/etc/rc.d
 495     cat >$initdir/etc/rc.d/rc.local <<EOF
 496 #!/bin/bash
 497 exit 0
 498 EOF
 499     chmod 0755 $initdir/etc/rc.d/rc.local
 500 }
 501
 502 install_execs() {
 503     ddebug "install any Execs from the service files"
 504     (
 505     export PKG_CONFIG_PATH=$BUILD_DIR/src/core/
 506     systemdsystemunitdir=$(pkg-config --variable=systemdsystemunitdir systemd)
 507     systemduserunitdir=$(pkg-config --variable=systemduserunitdir systemd)
 508     sed -r -n 's|^Exec[a-zA-Z]*=[@+!-]*([^ ]+).*|\1|gp' $initdir/{$systemdsystemunitdir,$systemduserunitdir}/*.service \
 509          | sort -u | while read i; do
 510          # some {rc,halt}.local scripts and programs are okay to not exist, the rest should
 511          inst $i || [ "${i%.local}" != "$i" ] || [ "${i%systemd-update-done}" != "$i" ]
 512      done
 513     )
 514 }
 515
 516 generate_module_dependencies() {
 517     if [[ -d $initdir/lib/modules/$KERNEL_VER ]] && \
 518         ! depmod -a -b "$initdir" $KERNEL_VER; then
 519             dfatal "\"depmod -a $KERNEL_VER\" failed."
 520             exit 1
 521     fi
 522 }
 523
 524 install_depmod_files() {
 525     inst /lib/modules/$KERNEL_VER/modules.order
 526     inst /lib/modules/$KERNEL_VER/modules.builtin
 527 }
 528
 529 install_plymouth() {
 530     # install plymouth, if found... else remove plymouth service files
 531     # if [ -x /usr/libexec/plymouth/plymouth-populate-initrd ]; then
 532     #     PLYMOUTH_POPULATE_SOURCE_FUNCTIONS="$TEST_BASE_DIR/test-functions" \
 533     #         /usr/libexec/plymouth/plymouth-populate-initrd -t $initdir
 534     #         dracut_install plymouth plymouthd
 535     # else
 536         rm -f $initdir/{usr/lib,etc}/systemd/system/plymouth* $initdir/{usr/lib,etc}/systemd/system/*/plymouth*
 537     # fi
 538 }
 539
 540 install_ld_so_conf() {
 541     cp -a /etc/ld.so.conf* $initdir/etc
 542     ldconfig -r "$initdir"
 543 }
 544
 545 install_config_files() {
 546     inst /etc/sysconfig/init || true
 547     inst /etc/passwd
 548     inst /etc/shadow
 549     inst /etc/login.defs
 550     inst /etc/group
 551     inst /etc/shells
 552     inst /etc/nsswitch.conf
 553     inst /etc/pam.conf || true
 554     inst /etc/securetty || true
 555     inst /etc/os-release
 556     inst /etc/localtime
 557     # we want an empty environment
 558     > $initdir/etc/environment
 559     > $initdir/etc/machine-id
 560     # set the hostname
 561     echo systemd-testsuite > $initdir/etc/hostname
 562     # fstab
 563     if [[ "$LOOKS_LIKE_SUSE" ]]; then
 564        ROOTMOUNT="/dev/sda1           /       ${FSTYPE}    rw 0 1"
 565     else
 566        ROOTMOUNT="LABEL=systemd           /       ${FSTYPE}    rw 0 1"
 567     fi
 568
 569     cat >$initdir/etc/fstab <<EOF
 570 $ROOTMOUNT
 571 EOF
 572 }
 573
 574 install_basic_tools() {
 575     [[ $BASICTOOLS ]] && dracut_install $BASICTOOLS
 576     dracut_install -o sushell
 577     # in Debian ldconfig is just a shell script wrapper around ldconfig.real
 578     dracut_install -o ldconfig.real
 579 }
 580
 581 install_debug_tools() {
 582     [[ $DEBUGTOOLS ]] && dracut_install $DEBUGTOOLS
 583 }
 584
 585 install_libnss() {
 586     # install libnss_files for login
 587     NSS_LIBS=$(LD_DEBUG=files getent passwd 2>&1 >/dev/null |sed -n '/calling init: .*libnss_/ {s!^.* /!/!; p}')
 588     dracut_install $NSS_LIBS
 589 }
 590
 591 install_dbus() {
 592     inst $ROOTLIBDIR/system/dbus.socket
 593
 594     # Fedora rawhide replaced dbus.service with dbus-daemon.service
 595     if [ -f $ROOTLIBDIR/system/dbus-daemon.service ]; then
 596         inst $ROOTLIBDIR/system/dbus-daemon.service
 597         # Alias symlink
 598         inst_symlink /etc/systemd/system/dbus.service
 599     else
 600         inst $ROOTLIBDIR/system/dbus.service
 601     fi
 602
 603     find \
 604         /etc/dbus-1 /usr/share/dbus-1 -xtype f \
 605         | while read file; do
 606         inst $file
 607     done
 608 }
 609
 610 install_pam() {
 611     (
 612     if [[ "$LOOKS_LIKE_DEBIAN" ]] && type -p dpkg-architecture &>/dev/null; then
 613         find "/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/security" -xtype f
 614     else
 615         find /lib*/security -xtype f
 616     fi
 617     find /etc/pam.d /etc/security -xtype f
 618     ) | while read file; do
 619         inst $file
 620     done
 621
 622     # pam_unix depends on unix_chkpwd.
 623     # see http://www.linux-pam.org/Linux-PAM-html/sag-pam_unix.html
 624     dracut_install -o unix_chkpwd
 625
 626     [[ "$LOOKS_LIKE_DEBIAN" ]] &&
 627         cp /etc/pam.d/systemd-user $initdir/etc/pam.d/
 628
 629     # set empty root password for easy debugging
 630     sed -i 's/^root:x:/root::/' $initdir/etc/passwd
 631 }
 632
 633 install_keymaps() {
 634     # The first three paths may be deprecated.
 635     # It seems now the last two paths are used by many distributions.
 636     for i in \
 637         /usr/lib/kbd/keymaps/include/* \
 638         /usr/lib/kbd/keymaps/i386/include/* \
 639         /usr/lib/kbd/keymaps/i386/qwerty/us.* \
 640         /usr/lib/kbd/keymaps/legacy/include/* \
 641         /usr/lib/kbd/keymaps/legacy/i386/qwerty/us.*; do
 642             [[ -f $i ]] || continue
 643             inst $i
 644     done
 645
 646     # When it takes any argument, then install more keymaps.
 647     if [[ -n $1 ]]; then
 648         for i in \
 649         /usr/lib/kbd/keymaps/i386/*/* \
 650         /usr/lib/kbd/keymaps/legacy/i386/*/*; do
 651             [[ -f $i ]] || continue
 652             inst $i
 653         done
 654     fi
 655 }
 656
 657 install_zoneinfo() {
 658     for i in /usr/share/zoneinfo/{,*/,*/*/}*; do
 659         [[ -f $i ]] || continue
 660         inst $i
 661     done
 662 }
 663
 664 install_fonts() {
 665     for i in \
 666         /usr/lib/kbd/consolefonts/eurlatgr* \
 667         /usr/lib/kbd/consolefonts/latarcyrheb-sun16*; do
 668             [[ -f $i ]] || continue
 669             inst $i
 670     done
 671 }
 672
 673 install_terminfo() {
 674     for _terminfodir in /lib/terminfo /etc/terminfo /usr/share/terminfo; do
 675         [ -f ${_terminfodir}/l/linux ] && break
 676     done
 677     dracut_install -o ${_terminfodir}/l/linux
 678 }
 679
 680 setup_testsuite() {
 681     cp $TEST_BASE_DIR/testsuite.target $initdir/etc/systemd/system/
 682     cp $TEST_BASE_DIR/end.service $initdir/etc/systemd/system/
 683
 684     mkdir -p $initdir/etc/systemd/system/testsuite.target.wants
 685     ln -fs $TEST_BASE_DIR/testsuite.service $initdir/etc/systemd/system/testsuite.target.wants/testsuite.service
 686     ln -fs $TEST_BASE_DIR/end.service $initdir/etc/systemd/system/testsuite.target.wants/end.service
 687
 688     # make the testsuite the default target
 689     ln -fs testsuite.target $initdir/etc/systemd/system/default.target
 690 }
 691
 692 setup_nspawn_root() {
 693     rm -fr $TESTDIR/nspawn-root
 694     ddebug "cp -ar $initdir $TESTDIR/nspawn-root"
 695     cp -ar $initdir $TESTDIR/nspawn-root
 696     # we don't mount in the nspawn root
 697     rm -f $TESTDIR/nspawn-root/etc/fstab
 698     if [[ "$RUN_IN_UNPRIVILEGED_CONTAINER" = "yes" ]]; then
 699         cp -ar $TESTDIR/nspawn-root $TESTDIR/unprivileged-nspawn-root
 700     fi
 701 }
 702
 703 setup_basic_dirs() {
 704     mkdir -p $initdir/run
 705     mkdir -p $initdir/etc/systemd/system
 706     mkdir -p $initdir/var/log/journal
 707
 708     for d in usr/bin usr/sbin bin etc lib "$libdir" sbin tmp usr var var/log dev proc sys sysroot root run run/lock run/initramfs; do
 709         if [ -L "/$d" ]; then
 710             inst_symlink "/$d"
 711         else
 712             inst_dir "/$d"
 713         fi
 714     done
 715
 716     ln -sfn /run "$initdir/var/run"
 717     ln -sfn /run/lock "$initdir/var/lock"
 718 }
 719
 720 inst_libs() {
 721     local _bin=$1
 722     local _so_regex='([^ ]*/lib[^/]*/[^ ]*\.so[^ ]*)'
 723     local _file _line
 724
 725     LC_ALL=C ldd "$_bin" 2>/dev/null | while read _line; do
 726         [[ $_line = 'not a dynamic executable' ]] && break
 727
 728         if [[ $_line =~ $_so_regex ]]; then
 729             _file=${BASH_REMATCH[1]}
 730             [[ -e ${initdir}/$_file ]] && continue
 731             inst_library "$_file"
 732             continue
 733         fi
 734
 735         if [[ $_line =~ not\ found ]]; then
 736             dfatal "Missing a shared library required by $_bin."
 737             dfatal "Run \"ldd $_bin\" to find out what it is."
 738             dfatal "$_line"
 739             dfatal "dracut cannot create an initrd."
 740             exit 1
 741         fi
 742     done
 743 }
 744
 745 import_testdir() {
 746     [[ -e $STATEFILE ]] && . $STATEFILE
 747     if [[ -z "$TESTDIR" ]] || [[ ! -d "$TESTDIR" ]]; then
 748         TESTDIR=$(mktemp --tmpdir=/var/tmp -d -t systemd-test.XXXXXX)
 749         echo "TESTDIR=\"$TESTDIR\"" > $STATEFILE
 750         export TESTDIR
 751     fi
 752 }
 753
 754 import_initdir() {
 755     initdir=$TESTDIR/root
 756     export initdir
 757 }
 758
 759 ## @brief Converts numeric logging level to the first letter of level name.
 760 #
 761 # @param lvl Numeric logging level in range from 1 to 6.
 762 # @retval 1 if @a lvl is out of range.
 763 # @retval 0 if @a lvl is correct.
 764 # @result Echoes first letter of level name.
 765 _lvl2char() {
 766     case "$1" in
 767         1) echo F;;
 768         2) echo E;;
 769         3) echo W;;
 770         4) echo I;;
 771         5) echo D;;
 772         6) echo T;;
 773         *) return 1;;
 774     esac
 775 }
 776
 777 ## @brief Internal helper function for _do_dlog()
 778 #
 779 # @param lvl Numeric logging level.
 780 # @param msg Message.
 781 # @retval 0 It's always returned, even if logging failed.
 782 #
 783 # @note This function is not supposed to be called manually. Please use
 784 # dtrace(), ddebug(), or others instead which wrap this one.
 785 #
 786 # This function calls _do_dlog() either with parameter msg, or if
 787 # none is given, it will read standard input and will use every line as
 788 # a message.
 789 #
 790 # This enables:
 791 # dwarn "This is a warning"
 792 # echo "This is a warning" | dwarn
 793 LOG_LEVEL=${LOG_LEVEL:-4}
 794
 795 dlog() {
 796     [ -z "$LOG_LEVEL" ] && return 0
 797     [ $1 -le $LOG_LEVEL ] || return 0
 798     local lvl="$1"; shift
 799     local lvlc=$(_lvl2char "$lvl") || return 0
 800
 801     if [ $# -ge 1 ]; then
 802         echo "$lvlc: $*"
 803     else
 804         while read line; do
 805             echo "$lvlc: " "$line"
 806         done
 807     fi
 808 }
 809
 810 ## @brief Logs message at TRACE level (6)
 811 #
 812 # @param msg Message.
 813 # @retval 0 It's always returned, even if logging failed.
 814 dtrace() {
 815     set +x
 816     dlog 6 "$@"
 817     [ -n "$debug" ] && set -x || :
 818 }
 819
 820 ## @brief Logs message at DEBUG level (5)
 821 #
 822 # @param msg Message.
 823 # @retval 0 It's always returned, even if logging failed.
 824 ddebug() {
 825 #    set +x
 826     dlog 5 "$@"
 827 #    [ -n "$debug" ] && set -x || :
 828 }
 829
 830 ## @brief Logs message at INFO level (4)
 831 #
 832 # @param msg Message.
 833 # @retval 0 It's always returned, even if logging failed.
 834 dinfo() {
 835     set +x
 836     dlog 4 "$@"
 837     [ -n "$debug" ] && set -x || :
 838 }
 839
 840 ## @brief Logs message at WARN level (3)
 841 #
 842 # @param msg Message.
 843 # @retval 0 It's always returned, even if logging failed.
 844 dwarn() {
 845     set +x
 846     dlog 3 "$@"
 847     [ -n "$debug" ] && set -x || :
 848 }
 849
 850 ## @brief Logs message at ERROR level (2)
 851 #
 852 # @param msg Message.
 853 # @retval 0 It's always returned, even if logging failed.
 854 derror() {
 855 #    set +x
 856     dlog 2 "$@"
 857 #    [ -n "$debug" ] && set -x || :
 858 }
 859
 860 ## @brief Logs message at FATAL level (1)
 861 #
 862 # @param msg Message.
 863 # @retval 0 It's always returned, even if logging failed.
 864 dfatal() {
 865     set +x
 866     dlog 1 "$@"
 867     [ -n "$debug" ] && set -x || :
 868 }
 869
 870
 871 # Generic substring function.  If $2 is in $1, return 0.
 872 strstr() { [ "${1#*$2*}" != "$1" ]; }
 873
 874 # normalize_path <path>
 875 # Prints the normalized path, where it removes any duplicated
 876 # and trailing slashes.
 877 # Example:
 878 # $ normalize_path ///test/test//
 879 # /test/test
 880 normalize_path() {
 881     shopt -q -s extglob
 882     set -- "${1//+(\/)//}"
 883     shopt -q -u extglob
 884     echo "${1%/}"
 885 }
 886
 887 # convert_abs_rel <from> <to>
 888 # Prints the relative path, when creating a symlink to <to> from <from>.
 889 # Example:
 890 # $ convert_abs_rel /usr/bin/test /bin/test-2
 891 # ../../bin/test-2
 892 # $ ln -s $(convert_abs_rel /usr/bin/test /bin/test-2) /usr/bin/test
 893 convert_abs_rel() {
 894     local __current __absolute __abssize __cursize __newpath
 895     local -i __i __level
 896
 897     set -- "$(normalize_path "$1")" "$(normalize_path "$2")"
 898
 899     # corner case #1 - self looping link
 900     [[ "$1" == "$2" ]] && { echo "${1##*/}"; return; }
 901
 902     # corner case #2 - own dir link
 903     [[ "${1%/*}" == "$2" ]] && { echo "."; return; }
 904
 905     IFS="/" __current=($1)
 906     IFS="/" __absolute=($2)
 907
 908     __abssize=${#__absolute[@]}
 909     __cursize=${#__current[@]}
 910
 911     while [[ ${__absolute[__level]} == ${__current[__level]} ]]
 912     do
 913         (( __level++ ))
 914         if (( __level > __abssize || __level > __cursize ))
 915         then
 916             break
 917         fi
 918     done
 919
 920     for ((__i = __level; __i < __cursize-1; __i++))
 921     do
 922         if ((__i > __level))
 923         then
 924             __newpath=$__newpath"/"
 925         fi
 926         __newpath=$__newpath".."
 927     done
 928
 929     for ((__i = __level; __i < __abssize; __i++))
 930     do
 931         if [[ -n $__newpath ]]
 932         then
 933             __newpath=$__newpath"/"
 934         fi
 935         __newpath=$__newpath${__absolute[__i]}
 936     done
 937
 938     echo "$__newpath"
 939 }
 940
 941
 942 # Install a directory, keeping symlinks as on the original system.
 943 # Example: if /lib points to /lib64 on the host, "inst_dir /lib/file"
 944 # will create ${initdir}/lib64, ${initdir}/lib64/file,
 945 # and a symlink ${initdir}/lib -> lib64.
 946 inst_dir() {
 947     [[ -e ${initdir}/"$1" ]] && return 0  # already there
 948
 949     local _dir="$1" _part="${1%/*}" _file
 950     while [[ "$_part" != "${_part%/*}" ]] && ! [[ -e "${initdir}/${_part}" ]]; do
 951         _dir="$_part $_dir"
 952         _part=${_part%/*}
 953     done
 954
 955     # iterate over parent directories
 956     for _file in $_dir; do
 957         [[ -e "${initdir}/$_file" ]] && continue
 958         if [[ -L $_file ]]; then
 959             inst_symlink "$_file"
 960         else
 961             # create directory
 962             mkdir -m 0755 -p "${initdir}/$_file" || return 1
 963             [[ -e "$_file" ]] && chmod --reference="$_file" "${initdir}/$_file"
 964             chmod u+w "${initdir}/$_file"
 965         fi
 966     done
 967 }
 968
 969 # $1 = file to copy to ramdisk
 970 # $2 (optional) Name for the file on the ramdisk
 971 # Location of the image dir is assumed to be $initdir
 972 # We never overwrite the target if it exists.
 973 inst_simple() {
 974     [[ -f "$1" ]] || return 1
 975     strstr "$1" "/" || return 1
 976
 977     local _src=$1 target="${2:-$1}"
 978     if ! [[ -d ${initdir}/$target ]]; then
 979         [[ -e ${initdir}/$target ]] && return 0
 980         [[ -L ${initdir}/$target ]] && return 0
 981         [[ -d "${initdir}/${target%/*}" ]] || inst_dir "${target%/*}"
 982     fi
 983     # install checksum files also
 984     if [[ -e "${_src%/*}/.${_src##*/}.hmac" ]]; then
 985         inst "${_src%/*}/.${_src##*/}.hmac" "${target%/*}/.${target##*/}.hmac"
 986     fi
 987     ddebug "Installing $_src"
 988     cp --sparse=always -pfL "$_src" "${initdir}/$target"
 989 }
 990
 991 # find symlinks linked to given library file
 992 # $1 = library file
 993 # Function searches for symlinks by stripping version numbers appended to
 994 # library filename, checks if it points to the same target and finally
 995 # prints the list of symlinks to stdout.
 996 #
 997 # Example:
 998 # rev_lib_symlinks libfoo.so.8.1
 999 # output: libfoo.so.8 libfoo.so
1000 # (Only if libfoo.so.8 and libfoo.so exists on host system.)
1001 rev_lib_symlinks() {
1002     [[ ! $1 ]] && return 0
1003
1004     local fn="$1" orig="$(readlink -f "$1")" links=''
1005
1006     [[ ${fn} =~ .*\.so\..* ]] || return 1
1007
1008     until [[ ${fn##*.} == so ]]; do
1009         fn="${fn%.*}"
1010         [[ -L ${fn} && $(readlink -f "${fn}") == ${orig} ]] && links+=" ${fn}"
1011     done
1012
1013     echo "${links}"
1014 }
1015
1016 # Same as above, but specialized to handle dynamic libraries.
1017 # It handles making symlinks according to how the original library
1018 # is referenced.
1019 inst_library() {
1020     local _src="$1" _dest=${2:-$1} _lib _reallib _symlink
1021     strstr "$1" "/" || return 1
1022     [[ -e $initdir/$_dest ]] && return 0
1023     if [[ -L $_src ]]; then
1024         # install checksum files also
1025         if [[ -e "${_src%/*}/.${_src##*/}.hmac" ]]; then
1026             inst "${_src%/*}/.${_src##*/}.hmac" "${_dest%/*}/.${_dest##*/}.hmac"
1027         fi
1028         _reallib=$(readlink -f "$_src")
1029         inst_simple "$_reallib" "$_reallib"
1030         inst_dir "${_dest%/*}"
1031         [[ -d "${_dest%/*}" ]] && _dest=$(readlink -f "${_dest%/*}")/${_dest##*/}
1032         ln -sfn $(convert_abs_rel "${_dest}" "${_reallib}") "${initdir}/${_dest}"
1033     else
1034         inst_simple "$_src" "$_dest"
1035     fi
1036
1037     # Create additional symlinks.  See rev_symlinks description.
1038     for _symlink in $(rev_lib_symlinks $_src) $(rev_lib_symlinks $_reallib); do
1039         [[ -e $initdir/$_symlink ]] || {
1040             ddebug "Creating extra symlink: $_symlink"
1041             inst_symlink $_symlink
1042         }
1043     done
1044 }
1045
1046 # find a binary.  If we were not passed the full path directly,
1047 # search in the usual places to find the binary.
1048 find_binary() {
1049     if [[ -z ${1##/*} ]]; then
1050         if [[ -x $1 ]] || { strstr "$1" ".so" && ldd $1 &>/dev/null; };  then
1051             echo $1
1052             return 0
1053         fi
1054     fi
1055
1056     type -P $1
1057 }
1058
1059 # Same as above, but specialized to install binary executables.
1060 # Install binary executable, and all shared library dependencies, if any.
1061 inst_binary() {
1062     local _bin _target
1063     _bin=$(find_binary "$1") || return 1
1064     _target=${2:-$_bin}
1065     [[ -e $initdir/$_target ]] && return 0
1066     [[ -L $_bin ]] && inst_symlink $_bin $_target && return 0
1067     local _file _line
1068     local _so_regex='([^ ]*/lib[^/]*/[^ ]*\.so[^ ]*)'
1069     # I love bash!
1070     LC_ALL=C ldd "$_bin" 2>/dev/null | while read _line; do
1071         [[ $_line = 'not a dynamic executable' ]] && break
1072
1073         if [[ $_line =~ $_so_regex ]]; then
1074             _file=${BASH_REMATCH[1]}
1075             [[ -e ${initdir}/$_file ]] && continue
1076             inst_library "$_file"
1077             continue
1078         fi
1079
1080         if [[ $_line =~ not\ found ]]; then
1081             dfatal "Missing a shared library required by $_bin."
1082             dfatal "Run \"ldd $_bin\" to find out what it is."
1083             dfatal "$_line"
1084             dfatal "dracut cannot create an initrd."
1085             exit 1
1086         fi
1087     done
1088     inst_simple "$_bin" "$_target"
1089 }
1090
1091 # same as above, except for shell scripts.
1092 # If your shell script does not start with shebang, it is not a shell script.
1093 inst_script() {
1094     local _bin
1095     _bin=$(find_binary "$1") || return 1
1096     shift
1097     local _line _shebang_regex
1098     read -r -n 80 _line <"$_bin"
1099     # If debug is set, clean unprintable chars to prevent messing up the term
1100     [[ $debug ]] && _line=$(echo -n "$_line" | tr -c -d '[:print:][:space:]')
1101     _shebang_regex='(#! *)(/[^ ]+).*'
1102     [[ $_line =~ $_shebang_regex ]] || return 1
1103     inst "${BASH_REMATCH[2]}" && inst_simple "$_bin" "$@"
1104 }
1105
1106 # same as above, but specialized for symlinks
1107 inst_symlink() {
1108     local _src=$1 _target=${2:-$1} _realsrc
1109     strstr "$1" "/" || return 1
1110     [[ -L $1 ]] || return 1
1111     [[ -L $initdir/$_target ]] && return 0
1112     _realsrc=$(readlink -f "$_src")
1113     if ! [[ -e $initdir/$_realsrc ]]; then
1114         if [[ -d $_realsrc ]]; then
1115             inst_dir "$_realsrc"
1116         else
1117             inst "$_realsrc"
1118         fi
1119     fi
1120     [[ ! -e $initdir/${_target%/*} ]] && inst_dir "${_target%/*}"
1121     [[ -d ${_target%/*} ]] && _target=$(readlink -f ${_target%/*})/${_target##*/}
1122     ln -sfn $(convert_abs_rel "${_target}" "${_realsrc}") "$initdir/$_target"
1123 }
1124
1125 # attempt to install any programs specified in a udev rule
1126 inst_rule_programs() {
1127     local _prog _bin
1128
1129     if grep -qE 'PROGRAM==?"[^ "]+' "$1"; then
1130         for _prog in $(grep -E 'PROGRAM==?"[^ "]+' "$1" | sed -r 's/.*PROGRAM==?"([^ "]+).*/\1/'); do
1131             if [ -x /lib/udev/$_prog ]; then
1132                 _bin=/lib/udev/$_prog
1133             else
1134                 _bin=$(find_binary "$_prog") || {
1135                     dinfo "Skipping program $_prog using in udev rule $(basename $1) as it cannot be found"
1136                     continue;
1137                 }
1138             fi
1139
1140             #dinfo "Installing $_bin due to it's use in the udev rule $(basename $1)"
1141             dracut_install "$_bin"
1142         done
1143     fi
1144 }
1145
1146 # udev rules always get installed in the same place, so
1147 # create a function to install them to make life simpler.
1148 inst_rules() {
1149     local _target=/etc/udev/rules.d _rule _found
1150
1151     inst_dir "/lib/udev/rules.d"
1152     inst_dir "$_target"
1153     for _rule in "$@"; do
1154         if [ "${rule#/}" = "$rule" ]; then
1155             for r in /lib/udev/rules.d /etc/udev/rules.d; do
1156                 if [[ -f $r/$_rule ]]; then
1157                     _found="$r/$_rule"
1158                     inst_simple "$_found"
1159                     inst_rule_programs "$_found"
1160                 fi
1161             done
1162         fi
1163         for r in '' ./ $dracutbasedir/rules.d/; do
1164             if [[ -f ${r}$_rule ]]; then
1165                 _found="${r}$_rule"
1166                 inst_simple "$_found" "$_target/${_found##*/}"
1167                 inst_rule_programs "$_found"
1168             fi
1169         done
1170         [[ $_found ]] || dinfo "Skipping udev rule: $_rule"
1171         _found=
1172     done
1173 }
1174
1175 # general purpose installation function
1176 # Same args as above.
1177 inst() {
1178     local _x
1179
1180     case $# in
1181         1) ;;
1182         2) [[ ! $initdir && -d $2 ]] && export initdir=$2
1183             [[ $initdir = $2 ]] && set $1;;
1184         3) [[ -z $initdir ]] && export initdir=$2
1185             set $1 $3;;
1186         *) dfatal "inst only takes 1 or 2 or 3 arguments"
1187             exit 1;;
1188     esac
1189     for _x in inst_symlink inst_script inst_binary inst_simple; do
1190         $_x "$@" && return 0
1191     done
1192     return 1
1193 }
1194
1195 # install any of listed files
1196 #
1197 # If first argument is '-d' and second some destination path, first accessible
1198 # source is installed into this path, otherwise it will installed in the same
1199 # path as source.  If none of listed files was installed, function return 1.
1200 # On first successful installation it returns with 0 status.
1201 #
1202 # Example:
1203 #
1204 # inst_any -d /bin/foo /bin/bar /bin/baz
1205 #
1206 # Lets assume that /bin/baz exists, so it will be installed as /bin/foo in
1207 # initramfs.
1208 inst_any() {
1209     local to f
1210
1211     [[ $1 = '-d' ]] && to="$2" && shift 2
1212
1213     for f in "$@"; do
1214         if [[ -e $f ]]; then
1215             [[ $to ]] && inst "$f" "$to" && return 0
1216             inst "$f" && return 0
1217         fi
1218     done
1219
1220     return 1
1221 }
1222
1223 # dracut_install [-o ] <file> [<file> ... ]
1224 # Install <file> to the initramfs image
1225 # -o optionally install the <file> and don't fail, if it is not there
1226 dracut_install() {
1227     local _optional=no
1228     if [[ $1 = '-o' ]]; then
1229         _optional=yes
1230         shift
1231     fi
1232     while (($# > 0)); do
1233         if ! inst "$1" ; then
1234             if [[ $_optional = yes ]]; then
1235                 dinfo "Skipping program $1 as it cannot be found and is" \
1236                     "flagged to be optional"
1237             else
1238                 dfatal "Failed to install $1"
1239                 exit 1
1240             fi
1241         fi
1242         shift
1243     done
1244 }
1245
1246 # Install a single kernel module along with any firmware it may require.
1247 # $1 = full path to kernel module to install
1248 install_kmod_with_fw() {
1249     # no need to go further if the module is already installed
1250
1251     [[ -e "${initdir}/lib/modules/$KERNEL_VER/${1##*/lib/modules/$KERNEL_VER/}" ]] \
1252         && return 0
1253
1254     [[ -e "$initdir/.kernelmodseen/${1##*/}" ]] && return 0
1255
1256     if [[ $omit_drivers ]]; then
1257         local _kmod=${1##*/}
1258         _kmod=${_kmod%.ko}
1259         _kmod=${_kmod/-/_}
1260         if [[ "$_kmod" =~ $omit_drivers ]]; then
1261             dinfo "Omitting driver $_kmod"
1262             return 1
1263         fi
1264         if [[ "${1##*/lib/modules/$KERNEL_VER/}" =~ $omit_drivers ]]; then
1265             dinfo "Omitting driver $_kmod"
1266             return 1
1267         fi
1268     fi
1269
1270     [ -d "$initdir/.kernelmodseen" ] && \
1271         > "$initdir/.kernelmodseen/${1##*/}"
1272
1273     inst_simple "$1" "/lib/modules/$KERNEL_VER/${1##*/lib/modules/$KERNEL_VER/}" \
1274         || return $?
1275
1276     local _modname=${1##*/} _fwdir _found _fw
1277     _modname=${_modname%.ko*}
1278     for _fw in $(modinfo -k $KERNEL_VER -F firmware $1 2>/dev/null); do
1279         _found=''
1280         for _fwdir in $fw_dir; do
1281             if [[ -d $_fwdir && -f $_fwdir/$_fw ]]; then
1282                 inst_simple "$_fwdir/$_fw" "/lib/firmware/$_fw"
1283                 _found=yes
1284             fi
1285         done
1286         if [[ $_found != yes ]]; then
1287             if ! grep -qe "\<${_modname//-/_}\>" /proc/modules; then
1288                 dinfo "Possible missing firmware \"${_fw}\" for kernel module" \
1289                     "\"${_modname}.ko\""
1290             else
1291                 dwarn "Possible missing firmware \"${_fw}\" for kernel module" \
1292                     "\"${_modname}.ko\""
1293             fi
1294         fi
1295     done
1296     return 0
1297 }
1298
1299 # Do something with all the dependencies of a kernel module.
1300 # Note that kernel modules depend on themselves using the technique we use
1301 # $1 = function to call for each dependency we find
1302 #      It will be passed the full path to the found kernel module
1303 # $2 = module to get dependencies for
1304 # rest of args = arguments to modprobe
1305 # _fderr specifies FD passed from surrounding scope
1306 for_each_kmod_dep() {
1307     local _func=$1 _kmod=$2 _cmd _modpath _options _found=0
1308     shift 2
1309     modprobe "$@" --ignore-install --show-depends $_kmod 2>&${_fderr} | (
1310         while read _cmd _modpath _options; do
1311             [[ $_cmd = insmod ]] || continue
1312             $_func ${_modpath} || exit $?
1313             _found=1
1314         done
1315         [[ $_found -eq 0 ]] && exit 1
1316         exit 0
1317     )
1318 }
1319
1320 # filter kernel modules to install certain modules that meet specific
1321 # requirements.
1322 # $1 = search only in subdirectory of /kernel/$1
1323 # $2 = function to call with module name to filter.
1324 #      This function will be passed the full path to the module to test.
1325 # The behavior of this function can vary depending on whether $hostonly is set.
1326 # If it is, we will only look at modules that are already in memory.
1327 # If it is not, we will look at all kernel modules
1328 # This function returns the full filenames of modules that match $1
1329 filter_kernel_modules_by_path () (
1330     local _modname _filtercmd
1331     if ! [[ $hostonly ]]; then
1332         _filtercmd='find "$KERNEL_MODS/kernel/$1" "$KERNEL_MODS/extra"'
1333         _filtercmd+=' "$KERNEL_MODS/weak-updates" -name "*.ko" -o -name "*.ko.gz"'
1334         _filtercmd+=' -o -name "*.ko.xz"'
1335         _filtercmd+=' 2>/dev/null'
1336     else
1337         _filtercmd='cut -d " " -f 1 </proc/modules|xargs modinfo -F filename '
1338         _filtercmd+='-k $KERNEL_VER 2>/dev/null'
1339     fi
1340     for _modname in $(eval $_filtercmd); do
1341         case $_modname in
1342             *.ko) "$2" "$_modname" && echo "$_modname";;
1343             *.ko.gz) gzip -dc "$_modname" > $initdir/$$.ko
1344                 $2 $initdir/$$.ko && echo "$_modname"
1345                 rm -f $initdir/$$.ko
1346                 ;;
1347             *.ko.xz) xz -dc "$_modname" > $initdir/$$.ko
1348                 $2 $initdir/$$.ko && echo "$_modname"
1349                 rm -f $initdir/$$.ko
1350                 ;;
1351         esac
1352     done
1353 )
1354 find_kernel_modules_by_path () (
1355     if ! [[ $hostonly ]]; then
1356         find "$KERNEL_MODS/kernel/$1" "$KERNEL_MODS/extra" "$KERNEL_MODS/weak-updates" \
1357           -name "*.ko" -o -name "*.ko.gz" -o -name "*.ko.xz" 2>/dev/null
1358     else
1359         cut -d " " -f 1 </proc/modules \
1360         | xargs modinfo -F filename -k $KERNEL_VER 2>/dev/null
1361     fi
1362 )
1363
1364 filter_kernel_modules () {
1365     filter_kernel_modules_by_path  drivers  "$1"
1366 }
1367
1368 find_kernel_modules () {
1369     find_kernel_modules_by_path  drivers
1370 }
1371
1372 # instmods [-c] <kernel module> [<kernel module> ... ]
1373 # instmods [-c] <kernel subsystem>
1374 # install kernel modules along with all their dependencies.
1375 # <kernel subsystem> can be e.g. "=block" or "=drivers/usb/storage"
1376 instmods() {
1377     [[ $no_kernel = yes ]] && return
1378     # called [sub]functions inherit _fderr
1379     local _fderr=9
1380     local _check=no
1381     if [[ $1 = '-c' ]]; then
1382         _check=yes
1383         shift
1384     fi
1385
1386     function inst1mod() {
1387         local _ret=0 _mod="$1"
1388         case $_mod in
1389             =*)
1390                 if [ -f $KERNEL_MODS/modules.${_mod#=} ]; then
1391                     ( [[ "$_mpargs" ]] && echo $_mpargs
1392                       cat "${KERNEL_MODS}/modules.${_mod#=}" ) \
1393                     | instmods
1394                 else
1395                     ( [[ "$_mpargs" ]] && echo $_mpargs
1396                       find "$KERNEL_MODS" -path "*/${_mod#=}/*" -printf '%f\n' ) \
1397                     | instmods
1398                 fi
1399                 ;;
1400             --*) _mpargs+=" $_mod" ;;
1401             i2o_scsi) return ;; # Do not load this diagnostic-only module
1402             *)
1403                 _mod=${_mod##*/}
1404                 # if we are already installed, skip this module and go on
1405                 # to the next one.
1406                 [[ -f "$initdir/.kernelmodseen/${_mod%.ko}.ko" ]] && return
1407
1408                 if [[ $omit_drivers ]] && [[ "$1" =~ $omit_drivers ]]; then
1409                     dinfo "Omitting driver ${_mod##$KERNEL_MODS}"
1410                     return
1411                 fi
1412                 # If we are building a host-specific initramfs and this
1413                 # module is not already loaded, move on to the next one.
1414                 [[ $hostonly ]] && ! grep -qe "\<${_mod//-/_}\>" /proc/modules \
1415                     && ! echo $add_drivers | grep -qe "\<${_mod}\>" \
1416                     && return
1417
1418                 # We use '-d' option in modprobe only if modules prefix path
1419                 # differs from default '/'.  This allows us to use Dracut with
1420                 # old version of modprobe which doesn't have '-d' option.
1421                 local _moddirname=${KERNEL_MODS%%/lib/modules/*}
1422                 [[ -n ${_moddirname} ]] && _moddirname="-d ${_moddirname}/"
1423
1424                 # ok, load the module, all its dependencies, and any firmware
1425                 # it may require
1426                 for_each_kmod_dep install_kmod_with_fw $_mod \
1427                     --set-version $KERNEL_VER ${_moddirname} $_mpargs
1428                 ((_ret+=$?))
1429                 ;;
1430         esac
1431         return $_ret
1432     }
1433
1434     function instmods_1() {
1435         local _mod _mpargs
1436         if (($# == 0)); then  # filenames from stdin
1437             while read _mod; do
1438                 inst1mod "${_mod%.ko*}" || {
1439                     if [ "$_check" = "yes" ]; then
1440                         dfatal "Failed to install $_mod"
1441                         return 1
1442                     fi
1443                 }
1444             done
1445         fi
1446         while (($# > 0)); do  # filenames as arguments
1447             inst1mod ${1%.ko*} || {
1448                 if [ "$_check" = "yes" ]; then
1449                     dfatal "Failed to install $1"
1450                     return 1
1451                 fi
1452             }
1453             shift
1454         done
1455         return 0
1456     }
1457
1458     local _ret _filter_not_found='FATAL: Module .* not found.'
1459     set -o pipefail
1460     # Capture all stderr from modprobe to _fderr. We could use {var}>...
1461     # redirections, but that would make dracut require bash4 at least.
1462     eval "( instmods_1 \"\$@\" ) ${_fderr}>&1" \
1463     | while read line; do [[ "$line" =~ $_filter_not_found ]] && echo $line || echo $line >&2 ;done | derror
1464     _ret=$?
1465     set +o pipefail
1466     return $_ret
1467 }
1468
1469 # inst_libdir_file [-n <pattern>] <file> [<file>...]
1470 # Install a <file> located on a lib directory to the initramfs image
1471 # -n <pattern> install non-matching files
1472 inst_libdir_file() {
1473     if [[ "$1" == "-n" ]]; then
1474         local _pattern=$1
1475         shift 2
1476         for _dir in $libdirs; do
1477             for _i in "$@"; do
1478                 for _f in "$_dir"/$_i; do
1479                     [[ "$_i" =~ $_pattern ]] || continue
1480                     [[ -e "$_i" ]] && dracut_install "$_i"
1481                 done
1482             done
1483         done
1484     else
1485         for _dir in $libdirs; do
1486             for _i in "$@"; do
1487                 for _f in "$_dir"/$_i; do
1488                     [[ -e "$_f" ]] && dracut_install "$_f"
1489                 done
1490             done
1491         done
1492     fi
1493 }
1494
1495 setup_suse() {
1496     ln -fs ../usr/bin/systemctl $initdir/bin/
1497     ln -fs ../usr/lib/systemd $initdir/lib/
1498     inst_simple "/usr/lib/systemd/system/haveged.service"
1499 }
1500
1501 # can be overridden in specific test
1502 test_cleanup() {
1503     umount $TESTDIR/root 2>/dev/null || true
1504     [[ $LOOPDEV ]] && losetup -d $LOOPDEV || true
1505     return 0
1506 }
1507
1508 test_run() {
1509     if [ -z "$TEST_NO_QEMU" ]; then
1510         if run_qemu; then
1511             check_result_qemu || return 1
1512         else
1513             dwarn "can't run QEMU, skipping"
1514         fi
1515     fi
1516     if [ -z "$TEST_NO_NSPAWN" ]; then
1517         if run_nspawn "nspawn-root"; then
1518             check_result_nspawn "nspawn-root" || return 1
1519         else
1520             dwarn "can't run systemd-nspawn, skipping"
1521         fi
1522
1523         if [[ "$RUN_IN_UNPRIVILEGED_CONTAINER" = "yes" ]]; then
1524             if NSPAWN_ARGUMENTS="-U --private-network $NSPAWN_ARGUMENTS" run_nspawn "unprivileged-nspawn-root"; then
1525                 check_result_nspawn "unprivileged-nspawn-root" || return 1
1526             else
1527                 dwarn "can't run systemd-nspawn, skipping"
1528             fi
1529         fi
1530     fi
1531     return 0
1532 }
1533
1534 do_test() {
1535     if [[ $UID != "0" ]]; then
1536         echo "TEST: $TEST_DESCRIPTION [SKIPPED]: not root" >&2
1537         exit 0
1538     fi
1539
1540 # Detect lib paths
1541     [[ $libdir ]] || for libdir in /lib64 /lib; do
1542         [[ -d $libdir ]] && libdirs+=" $libdir" && break
1543     done
1544
1545     [[ $usrlibdir ]] || for usrlibdir in /usr/lib64 /usr/lib; do
1546         [[ -d $usrlibdir ]] && libdirs+=" $usrlibdir" && break
1547     done
1548
1549     mkdir -p "$STATEDIR"
1550
1551     import_testdir
1552     import_initdir
1553
1554     while (($# > 0)); do
1555         case $1 in
1556             --run)
1557                 echo "TEST RUN: $TEST_DESCRIPTION"
1558                 test_run
1559                 ret=$?
1560                 if (( $ret == 0 )); then
1561                     echo "TEST RUN: $TEST_DESCRIPTION [OK]"
1562                 else
1563                     echo "TEST RUN: $TEST_DESCRIPTION [FAILED]"
1564                 fi
1565                 exit $ret;;
1566             --setup)
1567                 echo "TEST SETUP: $TEST_DESCRIPTION"
1568                 test_setup
1569                 ;;
1570             --clean)
1571                 echo "TEST CLEANUP: $TEST_DESCRIPTION"
1572                 test_cleanup
1573                 rm -fr "$TESTDIR"
1574                 rm -f "$STATEFILE"
1575                 ;;
1576             --all)
1577                 ret=0
1578                 echo -n "TEST: $TEST_DESCRIPTION ";
1579                 (
1580                     test_setup && test_run
1581                     ret=$?
1582                     test_cleanup
1583                     rm -fr "$TESTDIR"
1584                     rm -f "$STATEFILE"
1585                     exit $ret
1586                 ) </dev/null >"$TESTLOG" 2>&1 || ret=$?
1587                 if [ $ret -eq 0 ]; then
1588                     rm "$TESTLOG"
1589                     echo "[OK]"
1590                 else
1591                     echo "[FAILED]"
1592                     echo "see $TESTLOG"
1593                 fi
1594                 exit $ret;;
1595             *) break ;;
1596         esac
1597         shift
1598     done
1599 }