fs-lib: add ability to choose fsck tools

[thirdparty/dracut.git] / modules.d / 99fs-lib / fs-lib.sh

#!/bin/sh
# -*- mode: shell-script; indent-tabs-mode: nil; sh-basic-offset: 4; -*-
# ex: ts=8 sw=4 sts=4 et filetype=sh

type getarg >/dev/null 2>&1 || . /lib/dracut-lib.sh

fsck_ask_reboot() {
    info "note - fsck suggests reboot, if you"
    info "leave shell, booting will continue normally"
    emergency_shell -n "(reboot ?)"
}

fsck_ask_err() {
    warn "*** An error occurred during the file system check."
    warn "*** Dropping you to a shell; the system will try"
    warn "*** to mount the filesystem(s), when you leave the shell."
    emergency_shell -n "(Repair filesystem)"
}

# inherits: _ret _drv _out
fsck_tail() {
    [ $_ret -gt 0 ] && warn "$_drv returned with $_ret"
    if [ $_ret -ge 4 ]; then
        [ -n "$_out" ] && echo "$_out"|vwarn
        fsck_ask_err
    else
        [ -n "$_out" ] && echo "$_out"|vinfo
        [ $_ret -ge 2 ] && fsck_ask_reboot
    fi
}

# note: this function sets _drv of the caller
fsck_able() {
    case "$1" in
        xfs) {
                type xfs_db &&
                type xfs_repair &&
                type xfs_check &&
                type mount &&
                type umount
            } >/dev/null 2>&1 &&
            _drv="_drv=none fsck_drv_xfs" &&
            return 0
            ;;
        ext?)
            type e2fsck >/dev/null 2>&1 &&
            _drv="_drv=e2fsck fsck_drv_com" &&
            return 0
            ;;
        jfs)
            type jfs_fsck >/dev/null 2>&1 &&
            _drv="_drv=jfs_fsck fsck_drv_com" &&
            return 0
            ;;
        reiserfs)
            type reiserfsck >/dev/null 2>&1 &&
            _drv="_drv=reiserfsck fsck_drv_com" &&
            return 0
            ;;
        btrfs)
            type btrfsck >/dev/null 2>&1 &&
            _drv="_drv=none fsck_drv_btrfs" &&
            return 0
            ;;
        *)
            type fsck >/dev/null 2>&1 &&
            _drv="_drv=fsck fsck_drv_std" &&
            return 0
            ;;
    esac

    return 1
}

# note: all drivers inherit: _drv _fop _dev

fsck_drv_xfs() {
    local _ret

    # fs must be cleanly mounted (and umounted) first, before attempting any
    # xfs tools - if this works, nothing else should be needed
    # note, that user is always dropped into the shell, if the filesystem is
    # not mountable or if -f flag is found among _fop
    mkdir -p /tmp/.xfs

    info "trying to mount $_dev"
    if mount -t xfs "$_dev" "/tmp/.xfs" >/dev/null 2>&1; then
        _ret=0
        info "xfs: $_dev is clean"
        umount "$_dev" >/dev/null 2>&1
    else
        _ret=4
        warn "*** $_dev is unmountable"
    fi
    if [ $_ret -gt 0 ] || strstr "$_fop" "-f"; then
        warn "*** Dropping you to a shell. You have"
        warn "*** xfs_repair and xfs_check (xfs_db) available."
        warn "*** Note that if xfs didn't mount properly, it's"
        warn "*** probably pretty serious condition."
        emergency_shell -n "(Repair filesystem)"
    fi

    rm -r /tmp/.xfs
    return $_ret
}

fsck_drv_btrfs() {
    local _ret

    # fs must be cleanly mounted (and umounted) first, before attempting any
    # btrfs tools - if this works, nothing else should be needed
    # note, that user is always dropped into the shell, if the filesystem is
    # not mountable or if -f flag is found among _fop
    mkdir -p /tmp/.btrfs

    info "trying to mount $_dev"
    if mount -t btrfs "$_dev" "/tmp/.btrfs" >/dev/null 2>&1; then
        _ret=0
        info "btrfs: $_dev is clean"
        umount "$_dev" >/dev/null 2>&1
    else
        _ret=4
        warn "*** $_dev is unmountable"
    fi
    if [ $_ret -gt 0 ] || strstr "$_fop" "-f"; then
        warn "*** Dropping you to a shell. You have"
        warn "*** btrfsck available."
        warn "*** Note that if btrfs didn't mount properly, it's"
        warn "*** probably pretty serious condition."
        emergency_shell -n "(Repair filesystem)"
    fi

    rm -r /tmp/.btrfs
    return $_ret
}


# common code for checkers that follow usual subset of options and return codes
fsck_drv_com() {
    local _ret
    local _out

    if ! strstr "$_fop" "-[ynap]"; then
        _fop="-a ${_fop}"
    fi

    info "issuing $_drv $_fop $_dev"
    # we enforce non-interactive run, so $() is fine
    _out=$($_drv $_fop "$_dev")
    _ret=$?
    fsck_tail

    return $_ret
}

# code for generic fsck, if the filesystem checked is "unknown" to us
fsck_drv_std() {
    local _ret
    local _out
    unset _out

    info "issuing fsck $_fop $_dev"
    # note, we don't enforce -a here, thus fsck is being run (in theory)
    # interactively; otherwise some tool might complain about lack of terminal
    # (and using -a might not be safe)
    fsck $_fop "$_dev" >/dev/console 2>&1
    _ret=$?
    fsck_tail

    return $_ret
}

# checks single filesystem, relying on specific "driver"; we don't rely on
# automatic checking based on fstab, so empty one is passed;
# takes 3 arguments - device, filesystem, additional fsck options;
# first 2 arguments are mandatory (fs may be auto or "")
# returns 255 if filesystem wasn't checked at all (e.g. due to lack of
# necessary tools or insufficient options)
fsck_single() {
    local FSTAB_FILE=/etc/fstab.empty
    local _dev="$1"
    local _fs="${2:-auto}"
    local _fop="$3"
    local _drv

    [ $# -lt 2 ] && return 255

    _fs=$(det_fs "$_dev" "$_fs")
    fsck_able "$_fs" || return 255

    info "Checking $_fs: $_dev"
    export FSTAB_FILE
    eval "$_drv" "\"$_dev\"" "\"$_fop\""
    return $?
}

# takes list of filesystems to check in parallel; we don't rely on automatic
# checking based on fstab, so empty one is passed
fsck_batch() {
    local FSTAB_FILE=/etc/fstab.empty
    local _drv=fsck
    local _dev
    local _ret
    local _out

    [ $# -eq 0 ] || ! type fsck >/dev/null 2>&1 && return 255

    info "Checking filesystems (fsck -M -T -a):"
    for _dev in "$@"; do
        info "    $_dev"
    done

    export FSTAB_FILE
    _out="$(fsck -M -T "$@" -- -a)"
    _ret=$?

    fsck_tail

    return $_ret
}

# verify supplied filesystem type:
# if user provided the fs and we couldn't find it, assume user is right
# if we found the fs, assume we're right
det_fs() {
    local _dev="$1"
    local _orig="${2:-auto}"
    local _fs

    _fs=$(udevadm info --query=env --name="$_dev" | \
    while read line; do
        if str_starts $line "ID_FS_TYPE="; then
            echo ${line#ID_FS_TYPE=}
            break
        fi
    done)
    _fs=${_fs:-auto}

    if [ "$_fs" = "auto" ]; then
        _fs="$_orig"
    fi
    echo "$_fs"
}