dracut

   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 #
   5 # Generator script for a dracut initramfs
   6 # Tries to retain some degree of compatibility with the command line
   7 # of the various mkinitrd implementations out there
   8 #
   9
  10 # Copyright 2005-2010 Red Hat, Inc.  All rights reserved.
  11 #
  12 # This program is free software; you can redistribute it and/or modify
  13 # it under the terms of the GNU General Public License as published by
  14 # the Free Software Foundation; either version 2 of the License, or
  15 # (at your option) any later version.
  16 #
  17 # This program is distributed in the hope that it will be useful,
  18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 # GNU General Public License for more details.
  21 #
  22 # You should have received a copy of the GNU General Public License
  23 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24 #
  25
  26 # store for logging
  27 dracut_args="$@"
  28
  29 usage() {
  30 #                                                       80x25 linebreak here ^
  31     cat << EOF
  32 Usage: $0 [OPTION]... <initramfs> <kernel-version>
  33 Creates initial ramdisk images for preloading modules
  34
  35   -f, --force           Overwrite existing initramfs file.
  36   -m, --modules [LIST]  Specify a space-separated list of dracut modules to
  37                          call when building the initramfs. Modules are located
  38                          in /usr/share/dracut/modules.d.
  39   -o, --omit [LIST]     Omit a space-separated list of dracut modules.
  40   -a, --add [LIST]      Add a space-separated list of dracut modules.
  41   -d, --drivers [LIST]  Specify a space-separated list of kernel modules to
  42                         exclusively include in the initramfs.
  43   --add-drivers [LIST]  Specify a space-separated list of kernel
  44                         modules to add to the initramfs.
  45   --filesystems [LIST]  Specify a space-separated list of kernel filesystem
  46                         modules to exclusively include in the generic
  47                         initramfs.
  48   -k, --kmoddir [DIR]   Specify the directory, where to look for kernel
  49                         modules
  50   --fwdir [DIR]         Specify additional directories, where to look for
  51                         firmwares, separated by :
  52   --kernel-only         Only install kernel drivers and firmware files
  53   --no-kernel           Do not install kernel drivers and firmware files
  54   --strip               Strip binaries in the initramfs
  55   --nostrip             Do not strip binaries in the initramfs (default)
  56   --mdadmconf           Include local /etc/mdadm.conf
  57   --nomdadmconf         Do not include local /etc/mdadm.conf
  58   --lvmconf             Include local /etc/lvm/lvm.conf
  59   --nolvmconf           Do not include local /etc/lvm/lvm.conf
  60   -h, --help            This message
  61   --debug               Output debug information of the build process
  62   -L, --stdlog [0-6]    Specify logging level (to standard error)
  63                          0 - suppress any messages
  64                          1 - only fatal errors
  65                          2 - all errors
  66                          3 - warnings
  67                          4 - info (default)
  68                          5 - debug info (here starts lots of output)
  69                          6 - trace info (and even more)
  70   -v, --verbose         Increase verbosity level (default is info(4))
  71   -q, --quiet           Decrease verbosity level (default is info(4))
  72   -c, --conf [FILE]     Specify configuration file to use.
  73                          Default: /etc/dracut.conf
  74   --confdir [DIR]       Specify configuration directory to use *.conf files
  75                          from. Default: /etc/dracut.conf.d
  76   -l, --local           Local mode. Use modules from the current working
  77                          directory instead of the system-wide installed in
  78                          /usr/share/dracut/modules.d.
  79                          Useful when running dracut from a git checkout.
  80   -H, --hostonly        Host-Only mode: Install only what is needed for
  81                          booting the local host instead of a generic host.
  82   --fstab               Use /etc/fstab to determine the root device.
  83   -i, --include [SOURCE] [TARGET]
  84                         Include the files in the SOURCE directory into the
  85                          Target directory in the final initramfs.
  86                         If SOURCE is a file, it will be installed to TARGET
  87                          in the final initramfs.
  88   -I, --install [LIST]  Install the space separated list of files into the
  89                          initramfs.
  90   --gzip                Compress the generated initramfs using gzip.
  91                          This will be done by default, unless another
  92                          compression option or --no-compress is passed.
  93   --bzip2               Compress the generated initramfs using bzip2.
  94                          Make sure your kernel has bzip2 decompression support
  95                          compiled in, otherwise you will not be able to boot.
  96   --lzma                Compress the generated initramfs using lzma.
  97                          Make sure your kernel has lzma support compiled in,
  98                          otherwise you will not be able to boot.
  99   --no-compress         Do not compress the generated initramfs.  This will
 100                          override any other compression options.
 101   --list-modules        List all available dracut modules.
 102 EOF
 103 }
 104
 105 # function push()
 106 # push values to a stack
 107 # $1 = stack variable
 108 # $2.. values
 109 # example:
 110 # push stack 1 2 "3 4"
 111 push() {
 112     local __stack=$1; shift
 113     for i in "$@"; do
 114         eval ${__stack}'[${#'${__stack}'[@]}]="$i"'
 115     done
 116 }
 117
 118 # function pop()
 119 # pops the last value from a stack
 120 # assigns value to second argument variable
 121 # or echo to stdout, if no second argument
 122 # $1 = stack variable
 123 # $2 = optional variable to store the value
 124 # example:
 125 # pop stack val
 126 # val=$(pop stack)
 127 pop() {
 128     local __stack=$1; shift
 129     local __resultvar=$1
 130     local myresult;
 131     # check for empty stack
 132     eval '[[ ${#'${__stack}'[@]} -eq 0 ]] && return 1'
 133
 134     eval myresult='${'${__stack}'[${#'${__stack}'[@]}-1]}'
 135
 136     if [[ "$__resultvar" ]]; then
 137         eval $__resultvar="'$myresult'"
 138     else
 139         echo "$myresult"
 140     fi
 141     eval unset ${__stack}'[${#'${__stack}'[@]}-1]'
 142     return 0
 143 }
 144
 145 # Little helper function for reading args from the commandline.
 146 # it automatically handles -a b and -a=b variants, and returns 1 if
 147 # we need to shift $3.
 148 read_arg() {
 149     # $1 = arg name
 150     # $2 = arg value
 151     # $3 = arg parameter
 152     local rematch='^[^=]*=(.*)$'
 153     if [[ $2 =~ $rematch ]]; then
 154         read "$1" <<< "${BASH_REMATCH[1]}"
 155     else
 156         read "$1" <<< "$3"
 157         # There is no way to shift our callers args, so
 158         # return 1 to indicate they should do it instead.
 159         return 1
 160     fi
 161 }
 162
 163 # Little helper function for reading args from the commandline to a stack.
 164 # it automatically handles -a b and -a=b variants, and returns 1 if
 165 # we need to shift $3.
 166 push_arg() {
 167     # $1 = arg name
 168     # $2 = arg value
 169     # $3 = arg parameter
 170     local rematch='^[^=]*=(.*)$'
 171     if [[ $2 =~ $rematch ]]; then
 172         push "$1" "${BASH_REMATCH[1]}"
 173     else
 174         push "$1" "$3"
 175         # There is no way to shift our callers args, so
 176         # return 1 to indicate they should do it instead.
 177         return 1
 178     fi
 179 }
 180
 181 kernel="unset"
 182 verbosity_mod_l=0
 183
 184 while (($# > 0)); do
 185     case ${1%%=*} in
 186         -a|--add)      push_arg add_dracutmodules_l  "$@" || shift;;
 187         --add-drivers) push_arg add_drivers_l        "$@" || shift;;
 188         -m|--modules)  push_arg dracutmodules_l      "$@" || shift;;
 189         -o|--omit)     push_arg omit_dracutmodules_l "$@" || shift;;
 190         -d|--drivers)  push_arg drivers_l            "$@" || shift;;
 191         --filesystems) push_arg filesystems_l        "$@" || shift;;
 192         -I|--install)  push_arg install_items        "$@" || shift;;
 193         --fwdir)       push_arg fw_dir_l             "$@" || shift;;
 194         -k|--kmoddir)  read_arg drivers_dir_l        "$@" || shift;;
 195         -c|--conf)     read_arg conffile             "$@" || shift;;
 196         --confdir)     read_arg confdir              "$@" || shift;;
 197         -L|--stdlog)   read_arg stdloglvl_l          "$@" || shift;;
 198         -f|--force)    force=yes;;
 199         --kernel-only) kernel_only="yes"; no_kernel="no";;
 200         --no-kernel)   kernel_only="no"; no_kernel="yes";;
 201         --strip)       do_strip_l="yes";;
 202         --nostrip)     do_strip_l="no";;
 203         --mdadmconf)   mdadmconf_l="yes";;
 204         --nomdadmconf) mdadmconf_l="no";;
 205         --lvmconf)     lvmconf_l="yes";;
 206         --nolvmconf)   lvmconf_l="no";;
 207         --debug)       debug="yes";;
 208         -v|--verbose)  ((verbosity_mod_l++));;
 209         -q|--quiet)    ((verbosity_mod_l--));;
 210         -l|--local)    allowlocal="yes" ;;
 211         -H|--hostonly) hostonly_l="yes" ;;
 212         --fstab)       use_fstab_l="yes" ;;
 213         -h|--help)     usage; exit 1 ;;
 214         -i|--include)  push include_src "$2"; push include_target "$3"; shift 2;;
 215         --bzip2)       [[ $compress != cat ]] && compress="bzip2 -9";;
 216         --lzma)        [[ $compress != cat ]] && compress="lzma -9";;
 217         --xz)          [[ $compress != cat ]] && compress="xz --check=crc32";;
 218         --no-compress) compress="cat";;
 219         --gzip)        if [[ $compress != cat ]]; then
 220             type pigz > /dev/null 2>&1 && compress="pigz -9" || \
 221                 compress="gzip -9"
 222             fi;;
 223         --list-modules)
 224             do_list="yes";
 225             ;;
 226         -*) printf "\nUnknown option: %s\n\n" "$1" >&2; usage; exit 1;;
 227         *)
 228             if ! [[ $outfile ]]; then
 229                 outfile=$1
 230             elif [[ $kernel = "unset" ]]; then
 231                 kernel=$1
 232             else
 233                 usage; exit 1;
 234             fi
 235             ;;
 236     esac
 237     shift
 238 done
 239 if ! [[ $kernel ]] || [[ $kernel = "unset" ]]; then
 240     kernel=$(uname -r)
 241 fi
 242 [[ $outfile ]] || outfile="/boot/initramfs-$kernel.img"
 243
 244 PATH=/sbin:/bin:/usr/sbin:/usr/bin
 245 export PATH
 246
 247 [[ $debug ]] && {
 248     export PS4='${BASH_SOURCE}@${LINENO}(${FUNCNAME[0]}): ';
 249     set -x
 250 }
 251
 252 [[ $dracutbasedir ]] || dracutbasedir=/usr/share/dracut
 253
 254 [[ $allowlocal && -f "$(readlink -f ${0%/*})/dracut-functions" ]] && \
 255     dracutbasedir="${0%/*}"
 256
 257 # if we were not passed a config file, try the default one
 258 if [[ ! -f $conffile ]]; then
 259     [[ $allowlocal ]] && conffile="$dracutbasedir/dracut.conf" || \
 260         conffile="/etc/dracut.conf"
 261 fi
 262
 263 if [[ ! -d $confdir ]]; then
 264     [[ $allowlocal ]] && confdir="$dracutbasedir/dracut.conf.d" || \
 265         confdir="/etc/dracut.conf.d"
 266 fi
 267
 268 # source our config file
 269 [[ -f $conffile ]] && . "$conffile"
 270
 271 # source our config dir
 272 if [[ $confdir && -d $confdir ]]; then
 273     for f in "$confdir"/*.conf; do
 274         [[ -e $f ]] && . "$f"
 275     done
 276 fi
 277
 278 # these optins add to the stuff in the config file
 279 if [[ ${#add_dracutmodules_l[@]} ]]; then
 280     while pop add_dracutmodules_l val; do
 281         add_dracutmodules+=" $val "
 282     done
 283 fi
 284
 285 if [[ ${#add_drivers_l[@]} ]]; then
 286     while pop add_drivers_l val; do
 287         add_drivers+=" $val "
 288     done
 289 fi
 290
 291 # these options override the stuff in the config file
 292 if [[ ${#dracutmodules_l[@]} ]]; then
 293     dracutmodules=''
 294     while pop dracutmodules_l val; do
 295         dracutmodules+="$val "
 296     done
 297 fi
 298
 299 if [[ ${#omit_dracutmodules_l[@]} ]]; then
 300     omit_dracutmodules=''
 301     while pop omit_dracutmodules_l val; do
 302         omit_dracutmodules+="$val "
 303     done
 304 fi
 305
 306 if [[ ${#drivers_l[@]} ]]; then
 307     drivers=''
 308     while pop drivers_l val; do
 309         drivers+="$val "
 310     done
 311 fi
 312
 313 if [[ ${#filesystems_l[@]} ]]; then
 314     filesystems=''
 315     while pop filesystems_l val; do
 316         filesystems+="$val "
 317     done
 318 fi
 319
 320 if [[ ${#fw_dir_l[@]} ]]; then
 321     fw_dir=''
 322     while pop fw_dir_l val; do
 323         fw_dir+="$val "
 324     done
 325 fi
 326
 327 [[ $stdloglvl_l ]] && stdloglvl=$stdloglvl_l
 328 stdloglvl=$((stdloglvl + verbosity_mod_l))
 329 ((stdloglvl > 6)) && stdloglvl=6
 330 ((stdloglvl < 0)) && stdloglvl=0
 331
 332 [[ $drivers_dir_l ]] && drivers_dir=$drivers_dir_l
 333 [[ $do_strip_l ]] && do_strip=$do_strip_l
 334 [[ $hostonly_l ]] && hostonly=$hostonly_l
 335 [[ $use_fstab_l ]] && use_fstab=$use_fstab_l
 336 [[ $mdadmconf_l ]] && mdadmconf=$mdadmconf_l
 337 [[ $lvmconf_l ]] && lvmconf=$lvmconf_l
 338 [[ $dracutbasedir ]] || dracutbasedir=/usr/share/dracut
 339 [[ $fw_dir ]] || fw_dir=/lib/firmware
 340 [[ $do_strip ]] || do_strip=no
 341 # eliminate IFS hackery when messing with fw_dir
 342 fw_dir=${fw_dir//:/ }
 343
 344 [[ $hostonly = yes ]] && hostonly="-h"
 345 [[ $hostonly != "-h" ]] && unset hostonly
 346 [[ $compress ]] || compress="gzip -9"
 347
 348 if [[ -f $dracutbasedir/dracut-functions ]]; then
 349     . $dracutbasedir/dracut-functions
 350 else
 351     echo "Cannot find $dracutbasedir/dracut-functions." >&2
 352     echo "Are you running from a git checkout?" >&2
 353     echo "Try passing -l as an argument to $0" >&2
 354     exit 1
 355 fi
 356
 357 dracutfunctions=$dracutbasedir/dracut-functions
 358 export dracutfunctions
 359
 360 ddebug "Executing $0 $dracut_args"
 361
 362 [[ $do_list = yes ]] && {
 363     for mod in $dracutbasedir/modules.d/*; do
 364         [[ -d $mod ]] || continue;
 365         [[ -e $mod/install || -e $mod/installkernel || \
 366             -e $mod/module-setup.sh ]] || continue
 367         echo ${mod##*/??}
 368     done
 369     exit 0
 370 }
 371
 372 # Detect lib paths
 373 [[ $libdir ]] || for libdir in /lib64 /lib; do
 374     [[ -d $libdir ]] && break
 375 done || {
 376     dfatal 'No lib directory?!!!'
 377     exit 1
 378 }
 379
 380 [[ $usrlibdir ]] || for usrlibdir in /usr/lib64 /usr/lib; do
 381     [[ -d $usrlibdir ]] && break
 382 done || dwarn 'No usr/lib directory!'
 383
 384 # This is kinda legacy -- eventually it should go away.
 385 case $dracutmodules in
 386     ""|auto) dracutmodules="all" ;;
 387 esac
 388
 389 abs_outfile=$(readlink -f "$outfile") && outfile="$abs_outfile"
 390
 391 srcmods="/lib/modules/$kernel/"
 392 [[ $drivers_dir ]] && {
 393     if vercmp $(modprobe --version | cut -d' ' -f3) lt 3.7; then
 394         dfatal 'To use --kmoddir option module-init-tools >= 3.7 is required.'
 395         exit 1
 396     fi
 397     srcmods="$drivers_dir"
 398 }
 399 export srcmods
 400
 401 if [[ -f $outfile && ! $force ]]; then
 402     dfatal "Will not override existing initramfs ($outfile) without --force"
 403     exit 1
 404 fi
 405
 406 outdir=${outfile%/*}
 407 if [[ ! -d "$outdir" ]]; then
 408     dfatal "Can't write $outfile: Directory $outdir does not exist."
 409     exit 1
 410 elif [[ ! -w "$outdir" ]]; then
 411     dfatal "No permission to write $outdir."
 412     exit 1
 413 elif [[ -f "$outfile" && ! -w "$outfile" ]]; then
 414     dfatal "No permission to write $outfile."
 415     exit 1
 416 fi
 417
 418 hookdirs="cmdline pre-udev pre-trigger netroot pre-mount"
 419 hookdirs+=" pre-pivot mount emergency"
 420
 421 [[ $TMPDIR && ! -w $TMPDIR ]] && unset TMPDIR
 422 readonly initdir=$(mktemp -d -t initramfs.XXXXXX)
 423
 424 # clean up after ourselves no matter how we die.
 425 trap 'ret=$?;rm -rf "$initdir";exit $ret;' EXIT
 426 # clean up after ourselves no matter how we die.
 427 trap 'exit 1;' SIGINT
 428
 429 # Need to be able to have non-root users read stuff (rpcbind etc)
 430 chmod 755 "$initdir"
 431
 432 export initdir hookdirs dracutbasedir dracutmodules drivers \
 433     fw_dir drivers_dir debug no_kernel kernel_only \
 434     add_drivers mdadmconf lvmconf filesystems \
 435     use_fstab libdir usrlibdir \
 436     stdloglvl sysloglvl fileloglvl kmsgloglvl logfile \
 437     debug
 438
 439 if [[ $kernel_only != yes ]]; then
 440     # Create some directory structure first
 441     for d in bin sbin usr/bin usr/sbin usr/lib etc \
 442         proc sys sysroot tmp dev/pts var/run; do
 443         inst_dir "/$d";
 444     done
 445 fi
 446
 447 # check all our modules to see if they should be sourced.
 448 # This builds a list of modules that we will install next.
 449 check_module_dir
 450
 451 # source our modules.
 452 for moddir in "$dracutbasedir/modules.d"/[0-9][0-9]*; do
 453     mod=${moddir##*/}; mod=${mod#[0-9][0-9]}
 454     if strstr "$mods_to_load" " $mod "; then
 455         dinfo "*** Including module: $mod ***"
 456         if [[ $kernel_only = yes ]]; then
 457             module_installkernel $mod
 458         else
 459             module_install $mod
 460             if [[ $no_kernel != yes ]]; then
 461                 module_installkernel $mod
 462             fi
 463         fi
 464         mods_to_load=${mods_to_load// $mod /}
 465     fi
 466 done
 467 unset moddir
 468 dinfo "*** Including modules' done ***"
 469
 470 ## final stuff that has to happen
 471
 472 # generate module dependencies for the initrd
 473 if [[ -d $initdir/lib/modules/$kernel ]] && \
 474     ! depmod -a -b "$initdir" $kernel; then
 475     dfatal "\"depmod -a $kernel\" failed."
 476     exit 1
 477 fi
 478
 479 while pop include_src src && pop include_target tgt; do
 480     if [[ $src && $tgt ]]; then
 481         if [[ -f $src ]]; then
 482             inst $src $tgt
 483         else
 484             ddebug "Including directory: $src"
 485             mkdir -p "${initdir}/${tgt}"
 486             cp -a -t "${initdir}/${tgt}" "$src"/*
 487         fi
 488     fi
 489 done
 490
 491 while pop install_items items; do
 492     for item in $items; do
 493         dracut_install "$item"
 494     done
 495 done
 496 unset item
 497
 498 # make sure that library links are correct and up to date
 499 dracut_install /etc/ld.so.conf /etc/ld.so.conf.d/*
 500 if ! ldconfig -r "$initdir"; then
 501     if [[ $UID = 0 ]]; then
 502         derror "ldconfig exited ungracefully"
 503     else
 504         derror "ldconfig might need uid=0 (root) for chroot()"
 505     fi
 506 fi
 507
 508 if (($maxloglvl >= 5)); then
 509     ddebug "Listing sizes of included files:"
 510     du -c "$initdir" | sort -n | ddebug
 511 fi
 512
 513 # strip binaries
 514 if [[ $do_strip = yes ]] ; then
 515     for p in strip grep find; do
 516         if ! type -P $p >/dev/null; then
 517             derror "Could not find '$p'. You should run $0 with '--nostrip'."
 518             do_strip=no
 519         fi
 520     done
 521 fi
 522
 523 if [[ $do_strip = yes ]] ; then
 524     for f in $(find "$initdir" -type f \
 525         \( -perm -0100 -or -perm -0010 -or -perm -0001 \
 526            -or -path '*/lib/modules/*.ko' \) ); do
 527         dinfo "Stripping $f"
 528         strip -g "$f" 2>/dev/null|| :
 529     done
 530 fi
 531
 532 type hardlink &>/dev/null && {
 533     hardlink "$initdir" 2>&1
 534 }
 535
 536 if ! ( cd "$initdir"; find . |cpio -R 0:0 -H newc -o --quiet | \
 537     $compress > "$outfile"; ); then
 538     dfatal "dracut: creation of $outfile failed"
 539     exit 1
 540 fi
 541
 542 dinfo "Wrote $outfile:"
 543 dinfo "$(ls -l "$outfile")"
 544
 545 exit 0