]>
Commit | Line | Data |
---|---|---|
c8f9061f BB |
1 | #!/bin/sh |
2 | # | |
3 | # A simple script to load/unload the ZFS module stack. | |
c9c0d073 | 4 | # |
c9c0d073 | 5 | |
c8f9061f | 6 | BASE_DIR=$(dirname "$0") |
c9c0d073 | 7 | SCRIPT_COMMON=common.sh |
c8f9061f BB |
8 | if [ -f "${BASE_DIR}/${SCRIPT_COMMON}" ]; then |
9 | . "${BASE_DIR}/${SCRIPT_COMMON}" | |
c9c0d073 | 10 | else |
c8f9061f | 11 | echo "Missing helper script ${SCRIPT_COMMON}" && exit 1 |
c9c0d073 BB |
12 | fi |
13 | ||
14 | PROG=zfs.sh | |
c8f9061f BB |
15 | VERBOSE="no" |
16 | UNLOAD="no" | |
ef57371a | 17 | STACK_TRACER="no" |
c8f9061f BB |
18 | |
19 | ZED_PIDFILE=${ZED_PIDFILE:-/var/run/zed.pid} | |
20 | LDMOD=${LDMOD:-/sbin/modprobe} | |
21 | ||
22 | KMOD_ZLIB_DEFLATE=${KMOD_ZLIB_DEFLATE:-zlib_deflate} | |
23 | KMOD_ZLIB_INFLATE=${KMOD_ZLIB_INFLATE:-zlib_inflate} | |
24 | KMOD_SPL=${KMOD_SPL:-spl} | |
c8f9061f BB |
25 | KMOD_ZAVL=${KMOD_ZAVL:-zavl} |
26 | KMOD_ZNVPAIR=${KMOD_ZNVPAIR:-znvpair} | |
27 | KMOD_ZUNICODE=${KMOD_ZUNICODE:-zunicode} | |
28 | KMOD_ZCOMMON=${KMOD_ZCOMMON:-zcommon} | |
d99a0153 | 29 | KMOD_ZLUA=${KMOD_ZLUA:-zlua} |
c8f9061f BB |
30 | KMOD_ICP=${KMOD_ICP:-icp} |
31 | KMOD_ZFS=${KMOD_ZFS:-zfs} | |
a3640486 | 32 | KMOD_FREEBSD=${KMOD_FREEBSD:-openzfs} |
10b3c7f5 | 33 | KMOD_ZZSTD=${KMOD_ZZSTD:-zzstd} |
c8f9061f | 34 | |
c9c0d073 BB |
35 | |
36 | usage() { | |
37 | cat << EOF | |
38 | USAGE: | |
ef57371a | 39 | $0 [hvudS] [module-options] |
c9c0d073 BB |
40 | |
41 | DESCRIPTION: | |
42 | Load/unload the ZFS module stack. | |
43 | ||
44 | OPTIONS: | |
45 | -h Show this message | |
46 | -v Verbose | |
47 | -u Unload modules | |
ef57371a | 48 | -S Enable kernel stack tracer |
c9c0d073 BB |
49 | EOF |
50 | } | |
51 | ||
ef57371a | 52 | while getopts 'hvuS' OPTION; do |
c9c0d073 BB |
53 | case $OPTION in |
54 | h) | |
55 | usage | |
56 | exit 1 | |
57 | ;; | |
58 | v) | |
c8f9061f | 59 | VERBOSE="yes" |
c9c0d073 BB |
60 | ;; |
61 | u) | |
c8f9061f | 62 | UNLOAD="yes" |
c9c0d073 | 63 | ;; |
ef57371a TN |
64 | S) |
65 | STACK_TRACER="yes" | |
66 | ;; | |
c9c0d073 BB |
67 | ?) |
68 | usage | |
69 | exit | |
70 | ;; | |
71 | esac | |
72 | done | |
73 | ||
c8f9061f BB |
74 | kill_zed() { |
75 | if [ -f "$ZED_PIDFILE" ]; then | |
76 | PID=$(cat "$ZED_PIDFILE") | |
77 | kill "$PID" | |
78 | fi | |
79 | } | |
80 | ||
a3640486 | 81 | check_modules_linux() { |
ea49beba GDN |
82 | LOADED_MODULES="" |
83 | MISSING_MODULES="" | |
c8f9061f | 84 | |
10b3c7f5 MN |
85 | for KMOD in $KMOD_SPL $KMOD_ZAVL $KMOD_ZNVPAIR $KMOD_ZUNICODE $KMOD_ZCOMMON \ |
86 | $KMOD_ZLUA $KMOD_ZZSTD $KMOD_ICP $KMOD_ZFS; do | |
c8f9061f BB |
87 | NAME=$(basename "$KMOD" .ko) |
88 | ||
3da3488e | 89 | if lsmod | grep -E -q "^${NAME}"; then |
c8f9061f BB |
90 | LOADED_MODULES="$LOADED_MODULES\t$NAME\n" |
91 | fi | |
92 | ||
93 | if ! modinfo "$KMOD" >/dev/null 2>&1; then | |
94 | MISSING_MODULES="$MISSING_MODULES\t${KMOD}\n" | |
95 | fi | |
96 | done | |
97 | ||
98 | if [ -n "$LOADED_MODULES" ]; then | |
99 | printf "Unload the kernel modules by running '%s -u':\n" "$PROG" | |
100 | printf "%b" "$LOADED_MODULES" | |
101 | exit 1 | |
102 | fi | |
103 | ||
104 | if [ -n "$MISSING_MODULES" ]; then | |
105 | printf "The following kernel modules can not be found:\n" | |
106 | printf "%b" "$MISSING_MODULES" | |
107 | exit 1 | |
108 | fi | |
109 | ||
110 | return 0 | |
111 | } | |
112 | ||
a3640486 | 113 | load_module_linux() { |
ea49beba | 114 | KMOD=$1 |
c8f9061f BB |
115 | |
116 | FILE=$(modinfo "$KMOD" | awk '/^filename:/ {print $2}') | |
117 | VERSION=$(modinfo "$KMOD" | awk '/^version:/ {print $2}') | |
118 | ||
119 | if [ "$VERBOSE" = "yes" ]; then | |
120 | echo "Loading: $FILE ($VERSION)" | |
121 | fi | |
122 | ||
123 | $LDMOD "$KMOD" >/dev/null 2>&1 | |
3da3488e | 124 | # shellcheck disable=SC2181 |
c8f9061f BB |
125 | if [ $? -ne 0 ]; then |
126 | echo "Failed to load $KMOD" | |
127 | return 1 | |
128 | fi | |
129 | ||
130 | return 0 | |
131 | } | |
132 | ||
a3640486 RM |
133 | load_modules_freebsd() { |
134 | kldload "$KMOD_FREEBSD" || return 1 | |
135 | ||
136 | if [ "$VERBOSE" = "yes" ]; then | |
137 | echo "Successfully loaded ZFS module stack" | |
138 | fi | |
139 | ||
140 | return 0 | |
141 | } | |
142 | ||
143 | load_modules_linux() { | |
c8f9061f BB |
144 | mkdir -p /etc/zfs |
145 | ||
133a5c65 BB |
146 | if modinfo "$KMOD_ZLIB_DEFLATE" >/dev/null 2>&1; then |
147 | modprobe "$KMOD_ZLIB_DEFLATE" >/dev/null 2>&1 | |
148 | fi | |
149 | ||
150 | if modinfo "$KMOD_ZLIB_INFLATE">/dev/null 2>&1; then | |
151 | modprobe "$KMOD_ZLIB_INFLATE" >/dev/null 2>&1 | |
152 | fi | |
c8f9061f | 153 | |
93ce2b4c | 154 | for KMOD in $KMOD_SPL $KMOD_ZAVL $KMOD_ZNVPAIR \ |
10b3c7f5 MN |
155 | $KMOD_ZUNICODE $KMOD_ZCOMMON $KMOD_ZLUA $KMOD_ZZSTD \ |
156 | $KMOD_ICP $KMOD_ZFS; do | |
a3640486 | 157 | load_module_linux "$KMOD" || return 1 |
c8f9061f BB |
158 | done |
159 | ||
160 | if [ "$VERBOSE" = "yes" ]; then | |
161 | echo "Successfully loaded ZFS module stack" | |
162 | fi | |
163 | ||
164 | return 0 | |
165 | } | |
166 | ||
a3640486 | 167 | unload_module_linux() { |
ea49beba | 168 | KMOD=$1 |
c8f9061f BB |
169 | |
170 | NAME=$(basename "$KMOD" .ko) | |
171 | FILE=$(modinfo "$KMOD" | awk '/^filename:/ {print $2}') | |
172 | VERSION=$(modinfo "$KMOD" | awk '/^version:/ {print $2}') | |
173 | ||
174 | if [ "$VERBOSE" = "yes" ]; then | |
175 | echo "Unloading: $KMOD ($VERSION)" | |
176 | fi | |
177 | ||
178 | rmmod "$NAME" || echo "Failed to unload $NAME" | |
179 | ||
180 | return 0 | |
181 | } | |
182 | ||
a3640486 RM |
183 | unload_modules_freebsd() { |
184 | kldunload "$KMOD_FREEBSD" || echo "Failed to unload $KMOD_FREEBSD" | |
185 | ||
186 | if [ "$VERBOSE" = "yes" ]; then | |
187 | echo "Successfully unloaded ZFS module stack" | |
188 | fi | |
189 | ||
190 | return 0 | |
191 | } | |
192 | ||
193 | unload_modules_linux() { | |
10b3c7f5 MN |
194 | for KMOD in $KMOD_ZFS $KMOD_ICP $KMOD_ZZSTD $KMOD_ZLUA $KMOD_ZCOMMON \ |
195 | $KMOD_ZUNICODE $KMOD_ZNVPAIR $KMOD_ZAVL $KMOD_SPL; do | |
c8f9061f | 196 | NAME=$(basename "$KMOD" .ko) |
3da3488e | 197 | USE_COUNT=$(lsmod | grep -E "^${NAME} " | awk '{print $3}') |
c8f9061f BB |
198 | |
199 | if [ "$USE_COUNT" = "0" ] ; then | |
a3640486 | 200 | unload_module_linux "$KMOD" || return 1 |
9312e0fd | 201 | elif [ "$USE_COUNT" != "" ] ; then |
92286311 AM |
202 | echo "Module ${NAME} is still in use!" |
203 | return 1 | |
c8f9061f BB |
204 | fi |
205 | done | |
206 | ||
133a5c65 BB |
207 | if modinfo "$KMOD_ZLIB_DEFLATE" >/dev/null 2>&1; then |
208 | modprobe -r "$KMOD_ZLIB_DEFLATE" >/dev/null 2>&1 | |
209 | fi | |
210 | ||
211 | if modinfo "$KMOD_ZLIB_INFLATE">/dev/null 2>&1; then | |
212 | modprobe -r "$KMOD_ZLIB_INFLATE" >/dev/null 2>&1 | |
213 | fi | |
214 | ||
c8f9061f BB |
215 | if [ "$VERBOSE" = "yes" ]; then |
216 | echo "Successfully unloaded ZFS module stack" | |
217 | fi | |
218 | ||
219 | return 0 | |
220 | } | |
221 | ||
a3640486 | 222 | stack_clear_linux() { |
ea49beba GDN |
223 | STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size |
224 | STACK_TRACER_ENABLED=/proc/sys/kernel/stack_tracer_enabled | |
c8f9061f | 225 | |
ef57371a | 226 | if [ "$STACK_TRACER" = "yes" ] && [ -e "$STACK_MAX_SIZE" ]; then |
c8f9061f BB |
227 | echo 1 >"$STACK_TRACER_ENABLED" |
228 | echo 0 >"$STACK_MAX_SIZE" | |
229 | fi | |
230 | } | |
231 | ||
a3640486 | 232 | stack_check_linux() { |
ea49beba GDN |
233 | STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size |
234 | STACK_TRACE=/sys/kernel/debug/tracing/stack_trace | |
a7ed98d8 | 235 | STACK_LIMIT=15362 |
c8f9061f BB |
236 | |
237 | if [ -e "$STACK_MAX_SIZE" ]; then | |
238 | STACK_SIZE=$(cat "$STACK_MAX_SIZE") | |
239 | ||
240 | if [ "$STACK_SIZE" -ge "$STACK_LIMIT" ]; then | |
241 | echo | |
242 | echo "Warning: max stack size $STACK_SIZE bytes" | |
243 | cat "$STACK_TRACE" | |
244 | fi | |
245 | fi | |
246 | } | |
247 | ||
c552fbc5 | 248 | if [ "$(id -u)" != 0 ]; then |
c8f9061f BB |
249 | echo "Must run as root" |
250 | exit 1 | |
c9c0d073 BB |
251 | fi |
252 | ||
a3640486 RM |
253 | UNAME=$(uname -s) |
254 | ||
c8f9061f | 255 | if [ "$UNLOAD" = "yes" ]; then |
9e246ac3 | 256 | kill_zed |
b9f6a490 | 257 | umount -t zfs -a |
a3640486 RM |
258 | case $UNAME in |
259 | FreeBSD) | |
260 | unload_modules_freebsd | |
261 | ;; | |
262 | Linux) | |
263 | stack_check_linux | |
264 | unload_modules_linux | |
265 | ;; | |
266 | esac | |
c9c0d073 | 267 | else |
a3640486 RM |
268 | case $UNAME in |
269 | FreeBSD) | |
270 | load_modules_freebsd | |
271 | ;; | |
272 | Linux) | |
273 | stack_clear_linux | |
274 | check_modules_linux | |
275 | load_modules_linux "$@" | |
276 | udevadm trigger | |
277 | udevadm settle | |
278 | ;; | |
279 | esac | |
c9c0d073 BB |
280 | fi |
281 | ||
282 | exit 0 |