scripts/zfs.sh

   1 #!/bin/sh
   2 #
   3 # A simple script to load/unload the ZFS module stack.
   4 #
   5
   6 BASE_DIR=$(dirname "$0")
   7 SCRIPT_COMMON=common.sh
   8 if [ -f "${BASE_DIR}/${SCRIPT_COMMON}" ]; then
   9         . "${BASE_DIR}/${SCRIPT_COMMON}"
  10 else
  11         echo "Missing helper script ${SCRIPT_COMMON}" && exit 1
  12 fi
  13
  14 PROG=zfs.sh
  15 VERBOSE="no"
  16 UNLOAD="no"
  17
  18 ZED_PIDFILE=${ZED_PIDFILE:-/var/run/zed.pid}
  19 LDMOD=${LDMOD:-/sbin/modprobe}
  20
  21 KMOD_ZLIB_DEFLATE=${KMOD_ZLIB_DEFLATE:-zlib_deflate}
  22 KMOD_ZLIB_INFLATE=${KMOD_ZLIB_INFLATE:-zlib_inflate}
  23 KMOD_SPL=${KMOD_SPL:-spl}
  24 KMOD_SPLAT=${KMOD_SPLAT:-splat}
  25 KMOD_ZAVL=${KMOD_ZAVL:-zavl}
  26 KMOD_ZNVPAIR=${KMOD_ZNVPAIR:-znvpair}
  27 KMOD_ZUNICODE=${KMOD_ZUNICODE:-zunicode}
  28 KMOD_ZCOMMON=${KMOD_ZCOMMON:-zcommon}
  29 KMOD_ICP=${KMOD_ICP:-icp}
  30 KMOD_ZFS=${KMOD_ZFS:-zfs}
  31
  32
  33 usage() {
  34 cat << EOF
  35 USAGE:
  36 $0 [hvud] [module-options]
  37
  38 DESCRIPTION:
  39         Load/unload the ZFS module stack.
  40
  41 OPTIONS:
  42         -h      Show this message
  43         -v      Verbose
  44         -u      Unload modules
  45 EOF
  46 }
  47
  48 while getopts 'hvu' OPTION; do
  49         case $OPTION in
  50         h)
  51                 usage
  52                 exit 1
  53                 ;;
  54         v)
  55                 VERBOSE="yes"
  56                 ;;
  57         u)
  58                 UNLOAD="yes"
  59                 ;;
  60         ?)
  61                 usage
  62                 exit
  63                 ;;
  64         esac
  65 done
  66
  67 kill_zed() {
  68         if [ -f "$ZED_PIDFILE" ]; then
  69                 PID=$(cat "$ZED_PIDFILE")
  70                 kill "$PID"
  71         fi
  72 }
  73
  74 check_modules() {
  75         local LOADED_MODULES=""
  76         local MISSING_MODULES=""
  77
  78         for KMOD in $KMOD_SPL $KMOD_SPLAT $KMOD_ZAVL $KMOD_ZNVPAIR \
  79             $KMOD_ZUNICODE $KMOD_ZCOMMON $KMOD_ICP $KMOD_ZFS; do
  80                 NAME=$(basename "$KMOD" .ko)
  81
  82                 if lsmod | egrep -q "^${NAME}"; then
  83                         LOADED_MODULES="$LOADED_MODULES\t$NAME\n"
  84                 fi
  85
  86                 if ! modinfo "$KMOD" >/dev/null 2>&1; then
  87                         MISSING_MODULES="$MISSING_MODULES\t${KMOD}\n"
  88                 fi
  89         done
  90
  91         if [ -n "$LOADED_MODULES" ]; then
  92                 printf "Unload the kernel modules by running '%s -u':\n" "$PROG"
  93                 printf "%b" "$LOADED_MODULES"
  94                 exit 1
  95         fi
  96
  97         if [ -n "$MISSING_MODULES" ]; then
  98                 printf "The following kernel modules can not be found:\n"
  99                 printf "%b" "$MISSING_MODULES"
 100                 exit 1
 101         fi
 102
 103         return 0
 104 }
 105
 106 load_module() {
 107         local KMOD=$1
 108
 109         FILE=$(modinfo "$KMOD" | awk '/^filename:/ {print $2}')
 110         VERSION=$(modinfo "$KMOD" | awk '/^version:/ {print $2}')
 111
 112         if [ "$VERBOSE" = "yes" ]; then
 113                 echo "Loading: $FILE ($VERSION)"
 114         fi
 115
 116         $LDMOD "$KMOD" >/dev/null 2>&1
 117         if [ $? -ne 0 ]; then
 118                 echo "Failed to load $KMOD"
 119                 return 1
 120         fi
 121
 122         return 0
 123 }
 124
 125 load_modules() {
 126         mkdir -p /etc/zfs
 127
 128         modprobe "$KMOD_ZLIB_DEFLATE" >/dev/null
 129         modprobe "$KMOD_ZLIB_INFLATE" >/dev/null
 130
 131         for KMOD in $KMOD_SPL $KMOD_SPLAT $KMOD_ZAVL $KMOD_ZNVPAIR \
 132             $KMOD_ZUNICODE $KMOD_ZCOMMON $KMOD_ICP $KMOD_ZFS; do
 133                 load_module "$KMOD" || return 1
 134         done
 135
 136         if [ "$VERBOSE" = "yes" ]; then
 137                 echo "Successfully loaded ZFS module stack"
 138         fi
 139
 140         return 0
 141 }
 142
 143 unload_module() {
 144         local KMOD=$1
 145
 146         NAME=$(basename "$KMOD" .ko)
 147         FILE=$(modinfo "$KMOD" | awk '/^filename:/ {print $2}')
 148         VERSION=$(modinfo "$KMOD" | awk '/^version:/ {print $2}')
 149
 150         if [ "$VERBOSE" = "yes" ]; then
 151                 echo "Unloading: $KMOD ($VERSION)"
 152         fi
 153
 154         rmmod "$NAME" || echo "Failed to unload $NAME"
 155
 156         return 0
 157 }
 158
 159 unload_modules() {
 160         for KMOD in $KMOD_ZFS $KMOD_ICP $KMOD_ZCOMMON $KMOD_ZUNICODE \
 161             $KMOD_ZNVPAIR  $KMOD_ZAVL $KMOD_SPLAT $KMOD_SPL; do
 162                 NAME=$(basename "$KMOD" .ko)
 163                 USE_COUNT=$(lsmod | egrep "^${NAME} " | awk '{print $3}')
 164
 165                 if [ "$USE_COUNT" = "0" ] ; then
 166                         unload_module "$KMOD" || return 1
 167                 fi
 168         done
 169
 170         if [ "$VERBOSE" = "yes" ]; then
 171                 echo "Successfully unloaded ZFS module stack"
 172         fi
 173
 174         return 0
 175 }
 176
 177 stack_clear() {
 178         local STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size
 179         local STACK_TRACER_ENABLED=/proc/sys/kernel/stack_tracer_enabled
 180
 181         if [ -e "$STACK_MAX_SIZE" ]; then
 182                 echo 1 >"$STACK_TRACER_ENABLED"
 183                 echo 0 >"$STACK_MAX_SIZE"
 184         fi
 185 }
 186
 187 stack_check() {
 188         local STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size
 189         local STACK_TRACE=/sys/kernel/debug/tracing/stack_trace
 190         local STACK_LIMIT=7600
 191
 192         if [ -e "$STACK_MAX_SIZE" ]; then
 193                 STACK_SIZE=$(cat "$STACK_MAX_SIZE")
 194
 195                 if [ "$STACK_SIZE" -ge "$STACK_LIMIT" ]; then
 196                         echo
 197                         echo "Warning: max stack size $STACK_SIZE bytes"
 198                         cat "$STACK_TRACE"
 199                 fi
 200         fi
 201 }
 202
 203 if [ "$(id -u)" != 0 ]; then
 204         echo "Must run as root"
 205         exit 1
 206 fi
 207
 208 if [ "$UNLOAD" = "yes" ]; then
 209         kill_zed
 210         umount -t zfs -a
 211         stack_check
 212         unload_modules
 213 else
 214         stack_clear
 215         check_modules
 216         load_modules "$@"
 217         udevadm trigger
 218         udevadm settle
 219 fi
 220
 221 exit 0