Whamcloud - gitweb
LU-12616 obclass: fix MDS start/stop race
[fs/lustre-release.git] / lustre / tests / test-framework.sh
1 #!/bin/bash
2
3 trap 'print_summary && print_stack_trace | tee $TF_FAIL && \
4     echo "$TESTSUITE: FAIL: test-framework exiting on error"' ERR
5 set -e
6
7 export LANG=en_US
8 export REFORMAT=${REFORMAT:-""}
9 export WRITECONF=${WRITECONF:-""}
10 export VERBOSE=${VERBOSE:-false}
11 export GSS=${GSS:-false}
12 export GSS_SK=${GSS_SK:-false}
13 export GSS_KRB5=false
14 export GSS_PIPEFS=false
15 export SHARED_KEY=${SHARED_KEY:-false}
16 export SK_PATH=${SK_PATH:-/tmp/test-framework-keys}
17 export SK_OM_PATH=$SK_PATH'/tmp-request-mount'
18 export SK_MOUNTED=${SK_MOUNTED:-false}
19 export SK_FLAVOR=${SK_FLAVOR:-ski}
20 export SK_NO_KEY=${SK_NO_KEY:-true}
21 export SK_UNIQUE_NM=${SK_UNIQUE_NM:-false}
22 export SK_S2S=${SK_S2S:-false}
23 export SK_S2SNM=${SK_S2SNM:-TestFrameNM}
24 export SK_S2SNMCLI=${SK_S2SNMCLI:-TestFrameNMCli}
25 export SK_SKIPFIRST=${SK_SKIPFIRST:-true}
26 export IDENTITY_UPCALL=default
27 export QUOTA_AUTO=1
28 export FLAKEY=${FLAKEY:-true}
29 # specify environment variable containing batch job name for server statistics
30 export JOBID_VAR=${JOBID_VAR:-"procname_uid"}  # or "existing" or "disable"
31
32 #export PDSH="pdsh -S -Rssh -w"
33 export MOUNT_CMD=${MOUNT_CMD:-"mount -t lustre"}
34 export UMOUNT=${UMOUNT:-"umount -d"}
35
36 export LSNAPSHOT_CONF="/etc/ldev.conf"
37 export LSNAPSHOT_LOG="/var/log/lsnapshot.log"
38
39 # sles12 umount has a issue with -d option
40 [ -e /etc/SuSE-release ] && grep -w VERSION /etc/SuSE-release | grep -wq 12 && {
41         export UMOUNT="umount"
42 }
43
44 # function used by scripts run on remote nodes
45 LUSTRE=${LUSTRE:-$(cd $(dirname $0)/..; echo $PWD)}
46 . $LUSTRE/tests/functions.sh
47 . $LUSTRE/tests/yaml.sh
48
49 export LD_LIBRARY_PATH=${LUSTRE}/utils/.libs:${LUSTRE}/utils:${LD_LIBRARY_PATH}
50
51 LUSTRE_TESTS_CFG_DIR=${LUSTRE_TESTS_CFG_DIR:-${LUSTRE}/tests/cfg}
52
53 EXCEPT_LIST_FILE=${EXCEPT_LIST_FILE:-${LUSTRE_TESTS_CFG_DIR}/tests-to-skip.sh}
54
55 if [ -f "$EXCEPT_LIST_FILE" ]; then
56     echo "Reading test skip list from $EXCEPT_LIST_FILE"
57     cat $EXCEPT_LIST_FILE
58     . $EXCEPT_LIST_FILE
59 fi
60
61 # check config files for options in decreasing order of preference
62 [ -z "$MODPROBECONF" -a -f /etc/modprobe.d/lustre.conf ] &&
63     MODPROBECONF=/etc/modprobe.d/lustre.conf
64 [ -z "$MODPROBECONF" -a -f /etc/modprobe.d/Lustre ] &&
65     MODPROBECONF=/etc/modprobe.d/Lustre
66 [ -z "$MODPROBECONF" -a -f /etc/modprobe.conf ] &&
67     MODPROBECONF=/etc/modprobe.conf
68
69 sanitize_parameters() {
70         for i in DIR DIR1 DIR2 MOUNT MOUNT1 MOUNT2
71         do
72                 local path=${!i}
73                 if [ -d "$path" ]; then
74                         eval export $i=$(echo $path | sed -r 's/\/+$//g')
75                 fi
76         done
77 }
78 assert_DIR () {
79         local failed=""
80         [[ $DIR/ = $MOUNT/* ]] ||
81                 { failed=1 && echo "DIR=$DIR not in $MOUNT. Aborting."; }
82         [[ $DIR1/ = $MOUNT1/* ]] ||
83                 { failed=1 && echo "DIR1=$DIR1 not in $MOUNT1. Aborting."; }
84         [[ $DIR2/ = $MOUNT2/* ]] ||
85                 { failed=1 && echo "DIR2=$DIR2 not in $MOUNT2. Aborting"; }
86
87         [ -n "$failed" ] && exit 99 || true
88 }
89
90 usage() {
91     echo "usage: $0 [-r] [-f cfgfile]"
92     echo "       -r: reformat"
93
94     exit
95 }
96
97 print_summary () {
98         trap 0
99         [ -z "$DEFAULT_SUITES" ] && return 0
100         [ -n "$ONLY" ] && echo "WARNING: ONLY is set to $(echo $ONLY)"
101         local details
102         local form="%-13s %-17s %-9s %s %s\n"
103
104         printf "$form" "status" "script" "Total(sec)" "E(xcluded) S(low)"
105         echo "---------------------------------------------------------------"
106     for O in $DEFAULT_SUITES; do
107         O=$(echo $O  | tr "-" "_" | tr "[:lower:]" "[:upper:]")
108         [ "${!O}" = "no" ] && continue || true
109         local o=$(echo $O  | tr "[:upper:]_" "[:lower:]-")
110         local log=${TMP}/${o}.log
111         if is_sanity_benchmark $o; then
112             log=${TMP}/sanity-benchmark.log
113         fi
114         local slow=
115         local skipped=
116         local total=
117         local status=Unfinished
118         if [ -f $log ]; then
119                 skipped=$(grep excluded $log | awk '{ printf " %s", $3 }' |
120                         sed 's/test_//g')
121                 slow=$(egrep "^PASS|^FAIL" $log | tr -d "("| sed s/s\)$//g |
122                         sort -nr -k 3  | head -n5 |  awk '{ print $2":"$3"s" }')
123                 total=$(grep duration $log | awk '{ print $2 }')
124                 if [ "${!O}" = "done" ]; then
125                         status=Done
126                 fi
127                 if $DDETAILS; then
128                         local durations=$(egrep "^PASS|^FAIL" $log |
129                                 tr -d "("| sed s/s\)$//g |
130                                 awk '{ print $2":"$3"|" }')
131                         details=$(printf "%s\n%s %s %s\n" "$details" \
132                                 "DDETAILS" "$O" "$(echo $durations)")
133                 fi
134         fi
135         printf "$form" $status "$O" "${total}" "E=$skipped"
136         printf "$form" "-" "-" "-" "S=$(echo $slow)"
137     done
138
139     for O in $DEFAULT_SUITES; do
140         O=$(echo $O  | tr "-" "_" | tr "[:lower:]" "[:upper:]")
141         if [ "${!O}" = "no" ]; then
142             printf "$form" "Skipped" "$O" ""
143         fi
144     done
145
146     # print the detailed tests durations if DDETAILS=true
147     if $DDETAILS; then
148         echo "$details"
149     fi
150 }
151
152 # Get information about the Lustre environment. The information collected
153 # will be used in Lustre tests.
154 # usage: get_lustre_env
155 # input: No required or optional arguments
156 # output: No return values, environment variables are exported
157
158 get_lustre_env() {
159
160         export mds1_FSTYPE=${mds1_FSTYPE:-$(facet_fstype mds1)}
161         export ost1_FSTYPE=${ost1_FSTYPE:-$(facet_fstype ost1)}
162
163         export MGS_VERSION=$(lustre_version_code mgs)
164         export MDS1_VERSION=$(lustre_version_code mds1)
165         export OST1_VERSION=$(lustre_version_code ost1)
166         export CLIENT_VERSION=$(lustre_version_code client)
167 }
168
169 init_test_env() {
170         export LUSTRE=$(absolute_path $LUSTRE)
171         export TESTSUITE=$(basename $0 .sh)
172         export TEST_FAILED=false
173         export FAIL_ON_SKIP_ENV=${FAIL_ON_SKIP_ENV:-false}
174         export RPC_MODE=${RPC_MODE:-false}
175         export DO_CLEANUP=${DO_CLEANUP:-true}
176         export KEEP_ZPOOL=${KEEP_ZPOOL:-false}
177         export CLEANUP_DM_DEV=false
178         export PAGE_SIZE=$(get_page_size client)
179
180         export MKE2FS=$MKE2FS
181         if [ -z "$MKE2FS" ]; then
182                 if which mkfs.ldiskfs >/dev/null 2>&1; then
183                         export MKE2FS=mkfs.ldiskfs
184                 else
185                         export MKE2FS=mke2fs
186                 fi
187         fi
188
189         export DEBUGFS=$DEBUGFS
190         if [ -z "$DEBUGFS" ]; then
191                 if which debugfs.ldiskfs >/dev/null 2>&1; then
192                         export DEBUGFS=debugfs.ldiskfs
193                 else
194                         export DEBUGFS=debugfs
195                 fi
196         fi
197
198         export TUNE2FS=$TUNE2FS
199         if [ -z "$TUNE2FS" ]; then
200                 if which tunefs.ldiskfs >/dev/null 2>&1; then
201                         export TUNE2FS=tunefs.ldiskfs
202                 else
203                         export TUNE2FS=tune2fs
204                 fi
205         fi
206
207         export E2LABEL=$E2LABEL
208         if [ -z "$E2LABEL" ]; then
209                 if which label.ldiskfs >/dev/null 2>&1; then
210                         export E2LABEL=label.ldiskfs
211                 else
212                         export E2LABEL=e2label
213                 fi
214         fi
215
216         export DUMPE2FS=$DUMPE2FS
217         if [ -z "$DUMPE2FS" ]; then
218                 if which dumpfs.ldiskfs >/dev/null 2>&1; then
219                         export DUMPE2FS=dumpfs.ldiskfs
220                 else
221                         export DUMPE2FS=dumpe2fs
222                 fi
223         fi
224
225         export E2FSCK=$E2FSCK
226         if [ -z "$E2FSCK" ]; then
227                 if which fsck.ldiskfs >/dev/null 2>&1; then
228                         export E2FSCK=fsck.ldiskfs
229                 else
230                          export E2FSCK=e2fsck
231                 fi
232         fi
233
234         export RESIZE2FS=$RESIZE2FS
235         if [ -z "$RESIZE2FS" ]; then
236                 if which resizefs.ldiskfs >/dev/null 2>&1; then
237                         export RESIZE2FS=resizefs.ldiskfs
238                 else
239                         export RESIZE2FS=resize2fs
240                 fi
241         fi
242
243         export LFSCK_ALWAYS=${LFSCK_ALWAYS:-"no"} # check fs after test suite
244         export FSCK_MAX_ERR=4   # File system errors left uncorrected
245
246         export ZFS=${ZFS:-zfs}
247         export ZPOOL=${ZPOOL:-zpool}
248         export ZDB=${ZDB:-zdb}
249         export PARTPROBE=${PARTPROBE:-partprobe}
250
251         #[ -d /r ] && export ROOT=${ROOT:-/r}
252         export TMP=${TMP:-$ROOT/tmp}
253         export TESTSUITELOG=${TMP}/${TESTSUITE}.log
254         export LOGDIR=${LOGDIR:-${TMP}/test_logs/$(date +%s)}
255         export TESTLOG_PREFIX=$LOGDIR/$TESTSUITE
256
257         export HOSTNAME=${HOSTNAME:-$(hostname -s)}
258         if ! echo $PATH | grep -q $LUSTRE/utils; then
259                 export PATH=$LUSTRE/utils:$PATH
260         fi
261         if ! echo $PATH | grep -q $LUSTRE/utils/gss; then
262                 export PATH=$LUSTRE/utils/gss:$PATH
263         fi
264         if ! echo $PATH | grep -q $LUSTRE/tests; then
265                 export PATH=$LUSTRE/tests:$PATH
266         fi
267         if ! echo $PATH | grep -q $LUSTRE/../lustre-iokit/sgpdd-survey; then
268                 export PATH=$LUSTRE/../lustre-iokit/sgpdd-survey:$PATH
269         fi
270         export LST=${LST:-"$LUSTRE/../lnet/utils/lst"}
271         [ ! -f "$LST" ] && export LST=$(which lst)
272         export SGPDDSURVEY=${SGPDDSURVEY:-"$LUSTRE/../lustre-iokit/sgpdd-survey/sgpdd-survey")}
273         [ ! -f "$SGPDDSURVEY" ] && export SGPDDSURVEY=$(which sgpdd-survey)
274         export MCREATE=${MCREATE:-mcreate}
275         export MULTIOP=${MULTIOP:-multiop}
276         # Ubuntu, at least, has a truncate command in /usr/bin
277         # so fully path our truncate command.
278         export TRUNCATE=${TRUNCATE:-$LUSTRE/tests/truncate}
279         export FSX=${FSX:-$LUSTRE/tests/fsx}
280         export MDSRATE=${MDSRATE:-"$LUSTRE/tests/mpi/mdsrate"}
281         [ ! -f "$MDSRATE" ] && export MDSRATE=$(which mdsrate 2> /dev/null)
282         if ! echo $PATH | grep -q $LUSTRE/tests/racer; then
283                 export PATH=$LUSTRE/tests/racer:$PATH:
284         fi
285         if ! echo $PATH | grep -q $LUSTRE/tests/mpi; then
286                 export PATH=$LUSTRE/tests/mpi:$PATH
287         fi
288         export RSYNC_RSH=${RSYNC_RSH:-rsh}
289
290         export LCTL=${LCTL:-"$LUSTRE/utils/lctl"}
291         [ ! -f "$LCTL" ] && export LCTL=$(which lctl)
292         export LFS=${LFS:-"$LUSTRE/utils/lfs"}
293         [ ! -f "$LFS" ] && export LFS=$(which lfs)
294         SETSTRIPE=${SETSTRIPE:-"$LFS setstripe"}
295         GETSTRIPE=${GETSTRIPE:-"$LFS getstripe"}
296
297         export PERM_CMD=${PERM_CMD:-"$LCTL conf_param"}
298
299         export L_GETIDENTITY=${L_GETIDENTITY:-"$LUSTRE/utils/l_getidentity"}
300         if [ ! -f "$L_GETIDENTITY" ]; then
301                 if `which l_getidentity > /dev/null 2>&1`; then
302                         export L_GETIDENTITY=$(which l_getidentity)
303                 else
304                         export L_GETIDENTITY=NONE
305                 fi
306         fi
307         export LL_DECODE_FILTER_FID=${LL_DECODE_FILTER_FID:-"$LUSTRE/utils/ll_decode_filter_fid"}
308         [ ! -f "$LL_DECODE_FILTER_FID" ] && export LL_DECODE_FILTER_FID="ll_decode_filter_fid"
309         export LL_DECODE_LINKEA=${LL_DECODE_LINKEA:-"$LUSTRE/utils/ll_decode_linkea"}
310         [ ! -f "$LL_DECODE_LINKEA" ] && export LL_DECODE_LINKEA="ll_decode_linkea"
311         export MKFS=${MKFS:-"$LUSTRE/utils/mkfs.lustre"}
312         [ ! -f "$MKFS" ] && export MKFS="mkfs.lustre"
313         export TUNEFS=${TUNEFS:-"$LUSTRE/utils/tunefs.lustre"}
314         [ ! -f "$TUNEFS" ] && export TUNEFS="tunefs.lustre"
315         export CHECKSTAT="${CHECKSTAT:-"checkstat -v"} "
316         export LUSTRE_RMMOD=${LUSTRE_RMMOD:-$LUSTRE/scripts/lustre_rmmod}
317         [ ! -f "$LUSTRE_RMMOD" ] &&
318                 export LUSTRE_RMMOD=$(which lustre_rmmod 2> /dev/null)
319         export LUSTRE_ROUTES_CONVERSION=${LUSTRE_ROUTES_CONVERSION:-$LUSTRE/scripts/lustre_routes_conversion}
320         [ ! -f "$LUSTRE_ROUTES_CONVERSION" ] &&
321                 export LUSTRE_ROUTES_CONVERSION=$(which lustre_routes_conversion 2> /dev/null)
322         export LFS_MIGRATE=${LFS_MIGRATE:-$LUSTRE/scripts/lfs_migrate}
323         [ ! -f "$LFS_MIGRATE" ] &&
324                 export LFS_MIGRATE=$(which lfs_migrate 2> /dev/null)
325         export LR_READER=${LR_READER:-"$LUSTRE/utils/lr_reader"}
326         [ ! -f "$LR_READER" ] &&
327                 export LR_READER=$(which lr_reader 2> /dev/null)
328         [ -z "$LR_READER" ] && export LR_READER="/usr/sbin/lr_reader"
329         export LSOM_SYNC=${LSOM_SYNC:-"$LUSTRE/utils/llsom_sync"}
330         [ ! -f "$LSOM_SYNC" ] &&
331                 export LSOM_SYNC=$(which llsom_sync 2> /dev/null)
332         [ -z "$LSOM_SYNC" ] && export LSOM_SYNC="/usr/sbin/llsom_sync"
333         export NAME=${NAME:-local}
334         export LGSSD=${LGSSD:-"$LUSTRE/utils/gss/lgssd"}
335         [ "$GSS_PIPEFS" = "true" ] && [ ! -f "$LGSSD" ] &&
336                 export LGSSD=$(which lgssd)
337         export LSVCGSSD=${LSVCGSSD:-"$LUSTRE/utils/gss/lsvcgssd"}
338         [ ! -f "$LSVCGSSD" ] && export LSVCGSSD=$(which lsvcgssd 2> /dev/null)
339         export KRB5DIR=${KRB5DIR:-"/usr/kerberos"}
340         export DIR2
341         export SAVE_PWD=${SAVE_PWD:-$LUSTRE/tests}
342         export AT_MAX_PATH
343         export LDEV=${LDEV:-"$LUSTRE/scripts/ldev"}
344         [ ! -f "$LDEV" ] && export LDEV=$(which ldev 2> /dev/null)
345
346         export DMSETUP=${DMSETUP:-dmsetup}
347         export DM_DEV_PATH=${DM_DEV_PATH:-/dev/mapper}
348         export LOSETUP=${LOSETUP:-losetup}
349
350         if [ "$ACCEPTOR_PORT" ]; then
351                 export PORT_OPT="--port $ACCEPTOR_PORT"
352         fi
353
354         if $SHARED_KEY; then
355                 $RPC_MODE || echo "Using GSS shared-key feature"
356                 which lgss_sk > /dev/null 2>&1 ||
357                         error_exit "built with lgss_sk disabled! SEC=$SEC"
358                 GSS=true
359                 GSS_SK=true
360                 SEC=$SK_FLAVOR
361         fi
362
363         case "x$SEC" in
364                 xkrb5*)
365                 $RPC_MODE || echo "Using GSS/krb5 ptlrpc security flavor"
366                 which lgss_keyring > /dev/null 2>&1 ||
367                         error_exit "built with gss disabled! SEC=$SEC"
368                 GSS=true
369                 GSS_KRB5=true
370                 ;;
371         esac
372
373         case "x$IDUP" in
374                 xtrue)
375                         IDENTITY_UPCALL=true
376                         ;;
377                 xfalse)
378                         IDENTITY_UPCALL=false
379                         ;;
380         esac
381
382         export LOAD_MODULES_REMOTE=${LOAD_MODULES_REMOTE:-false}
383
384         # Paths on remote nodes, if different
385         export RLUSTRE=${RLUSTRE:-$LUSTRE}
386         export RPWD=${RPWD:-$PWD}
387         export I_MOUNTED=${I_MOUNTED:-"no"}
388         export AUSTER_CLEANUP=${AUSTER_CLEANUP:-false}
389         if [ ! -f /lib/modules/$(uname -r)/kernel/fs/lustre/mdt.ko -a \
390              ! -f /lib/modules/$(uname -r)/updates/kernel/fs/lustre/mdt.ko -a \
391              ! -f /lib/modules/$(uname -r)/extra/kernel/fs/lustre/mdt.ko -a \
392              ! -f $LUSTRE/mdt/mdt.ko ]; then
393             export CLIENTMODSONLY=yes
394         fi
395
396         export SHUTDOWN_ATTEMPTS=${SHUTDOWN_ATTEMPTS:-3}
397         export OSD_TRACK_DECLARES_LBUG=${OSD_TRACK_DECLARES_LBUG:-"yes"}
398
399         # command line
400
401         while getopts "rvwf:" opt $*; do
402                 case $opt in
403                         f) CONFIG=$OPTARG;;
404                         r) REFORMAT=yes;;
405                         v) VERBOSE=true;;
406                         w) WRITECONF=writeconf;;
407                         \?) usage;;
408                 esac
409         done
410
411         shift $((OPTIND - 1))
412         ONLY=${ONLY:-$*}
413
414         # print the durations of each test if "true"
415         DDETAILS=${DDETAILS:-false}
416         [ "$TESTSUITELOG" ] && rm -f $TESTSUITELOG || true
417         if ! $RPC_MODE; then
418                 rm -f $TMP/*active
419         fi
420
421         export TF_FAIL=${TF_FAIL:-$TMP/tf.fail}
422
423         # Constants used in more than one test script
424         export LOV_MAX_STRIPE_COUNT=2000
425
426         export MACHINEFILE=${MACHINEFILE:-$TMP/$(basename $0 .sh).machines}
427         . ${CONFIG:=$LUSTRE/tests/cfg/$NAME.sh}
428         get_lustre_env
429
430 }
431
432 check_cpt_number() {
433         local facet=$1
434         local ncpts
435
436         ncpts=$(do_facet $facet "lctl get_param -n " \
437                 "cpu_partition_table 2>/dev/null| wc -l" || echo 1)
438
439         if [ $ncpts -eq 0 ]; then
440                 echo "1"
441         else
442                 echo $ncpts
443         fi
444 }
445
446 # Return a numeric version code based on a version string.  The version
447 # code is useful for comparison two version strings to see which is newer.
448 version_code() {
449         # split arguments like "1.8.6-wc3" into "1", "8", "6", "wc3"
450         eval set -- $(tr "[:punct:]" " " <<< $*)
451
452         echo -n "$((($1 << 16) | ($2 << 8) | $3))"
453 }
454
455 export LINUX_VERSION=$(uname -r | sed -e "s/\([0-9]*\.[0-9]*\.[0-9]*\).*/\1/")
456 export LINUX_VERSION_CODE=$(version_code ${LINUX_VERSION//\./ })
457
458 # Report the Lustre build version string (e.g. 1.8.7.3 or 2.4.1).
459 #
460 # usage: lustre_build_version
461 #
462 # All Lustre versions support "lctl get_param" to report the version of the
463 # code running in the kernel (what our tests are interested in), but it
464 # doesn't work without modules loaded.  After 2.9.53 and in upstream kernels
465 # the "version" parameter doesn't include "lustre: " at the beginning.
466 # If that fails, call "lctl lustre_build_version" which prints either (or both)
467 # the userspace and kernel build versions, but until 2.8.55 required root
468 # access to get the Lustre kernel version.  If that also fails, fall back to
469 # using "lctl --version", which is easy to parse and works without the kernel
470 # modules, but was only added in 2.6.50 and only prints the lctl tool version,
471 # not the module version, though they are usually the same.
472 #
473 # Various commands and their output format for different Lustre versions:
474 # lctl get_param version:       2.9.55
475 # lctl get_param version:       lustre: 2.8.53
476 # lctl get_param version:       lustre: 2.6.52
477 #                               kernel: patchless_client
478 #                               build: v2_6_92_0-2.6.32-431.el6_lustre.x86_64
479 # lctl lustre_build_version:    Lustre version: 2.8.53_27_gae67fc01
480 # lctl lustre_build_version:    error: lustre_build_version: Permission denied
481 #       (as non-root user)      lctl   version: v2_6_92_0-2.6.32-431.el6.x86_64
482 # lctl lustre_build_version:    Lustre version: 2.5.3-2.6.32.26-175.fc12.x86_64
483 #                               lctl   version: 2.5.3-2.6.32..26-175fc12.x86_64
484 # lctl --version:               lctl 2.6.50
485 #
486 # output: prints version string to stdout in (up to 4) dotted-decimal values
487 lustre_build_version() {
488         local facet=${1:-client}
489         local ver=$(do_facet $facet "$LCTL get_param -n version 2>/dev/null ||
490                                 $LCTL lustre_build_version 2>/dev/null ||
491                                 $LCTL --version 2>/dev/null | cut -d' ' -f2")
492         local lver=$(egrep -i "lustre: |version: " <<<"$ver" | head -n 1)
493         [ -n "$lver" ] && ver="$lver"
494
495         sed -e 's/[^:]*: //' -e 's/^v//' -e 's/[ -].*//' -e 's/_/./g' <<<$ver |
496                 cut -d. -f1-4
497 }
498
499 # Report the Lustre numeric build version code for the supplied facet.
500 lustre_version_code() {
501         version_code $(lustre_build_version $1)
502 }
503
504 module_loaded () {
505         /sbin/lsmod | grep -q "^\<$1\>"
506 }
507
508 PRLFS=false
509 lustre_insmod() {
510         local module=$1
511         shift
512         local args="$@"
513         local msg
514         local rc=0
515
516         if ! $PRLFS; then
517                 msg="$(insmod $module $args 2>&1)" && return 0 || rc=$?
518         fi
519
520         # parallels can't load modules directly from prlfs, use /tmp instead
521         if $PRLFS || [[ "$(stat -f -c%t $module)" == "7c7c6673" ]]; then
522                 local target="$(mktemp)"
523
524                 cp "$module" "$target"
525                 insmod $target $args
526                 rc=$?
527                 [[ $rc == 0 ]] && PRLFS=true
528                 rm -f $target
529         else
530                 echo "$msg"
531         fi
532         return $rc
533 }
534
535 # Load a module on the system where this is running.
536 #
537 # usage: load_module module_name [module arguments for insmod/modprobe]
538 #
539 # If module arguments are not given but MODOPTS_<MODULE> is set, then its value
540 # will be used as the arguments.  Otherwise arguments will be obtained from
541 # /etc/modprobe.conf, from /etc/modprobe.d/Lustre, or else none will be used.
542 #
543 load_module() {
544         local module=$1 # '../libcfs/libcfs/libcfs', 'obdclass/obdclass', ...
545         shift
546         local ext=".ko"
547         local base=$(basename $module $ext)
548         local path
549         local -A module_is_loaded_aa
550         local optvar
551         local mod
552
553         for mod in $(lsmod | awk '{ print $1; }'); do
554                 module_is_loaded_aa[${mod//-/_}]=true
555         done
556
557         module_is_loaded() {
558                 ${module_is_loaded_aa[${1//-/_}]:-false}
559         }
560
561         if module_is_loaded $base; then
562                 return
563         fi
564
565         if [[ -f $LUSTRE/$module$ext ]]; then
566                 path=$LUSTRE/$module$ext
567         elif [[ "$base" == lnet_selftest ]] &&
568              [[ -f $LUSTRE/../lnet/selftest/$base$ext ]]; then
569                 path=$LUSTRE/../lnet/selftest/$base$ext
570         else
571                 path=''
572         fi
573
574         if [[ -n "$path" ]]; then
575                 # Try to load any non-Lustre modules that $module depends on.
576                 for mod in $(modinfo --field=depends $path | tr ',' ' '); do
577                         if ! module_is_loaded $mod; then
578                                 modprobe $mod
579                         fi
580                 done
581         fi
582
583         # If no module arguments were passed then get them from
584         # $MODOPTS_<MODULE>, otherwise from modprobe.conf.
585         if [ $# -eq 0 ]; then
586                 # $MODOPTS_<MODULE>; we could use associative arrays, but that's
587                 # not in Bash until 4.x, so we resort to eval.
588                 optvar="MODOPTS_$(basename $module | tr a-z A-Z)"
589                 eval set -- \$$optvar
590                 if [ $# -eq 0 -a -n "$MODPROBECONF" ]; then
591                         # Nothing in $MODOPTS_<MODULE>; try modprobe.conf
592                         local opt
593                         opt=$(awk -v var="^options $base" '$0 ~ var \
594                               {gsub("'"options $base"'",""); print}' \
595                                 $MODPROBECONF)
596                         set -- $(echo -n $opt)
597
598                         # Ensure we have accept=all for lnet
599                         if [[ "$base" == lnet ]]; then
600                                 # OK, this is a bit wordy...
601                                 local arg accept_all_present=false
602
603                                 for arg in "$@"; do
604                                         [[ "$arg" == accept=all ]] &&
605                                                 accept_all_present=true
606                                 done
607
608                                 $accept_all_present || set -- "$@" accept=all
609                         fi
610
611                         export $optvar="$*"
612                 fi
613         fi
614
615         [ $# -gt 0 ] && echo "${module} options: '$*'"
616
617         # Note that insmod will ignore anything in modprobe.conf, which is why
618         # we're passing options on the command-line. If $path does not exist
619         # then we must be testing a "make install" or"rpm" installation. Also
620         # note that failing to load ptlrpc_gss is not considered fatal.
621         if [[ -n "$path" ]]; then
622                 lustre_insmod $path "$@"
623         elif [[ "$base" == ptlrpc_gss ]]; then
624                 if ! modprobe $base "$@" 2>/dev/null; then
625                         echo "gss/krb5 is not supported"
626                 fi
627         else
628                 modprobe $base "$@"
629         fi
630 }
631
632 load_modules_local() {
633         if [ -n "$MODPROBE" ]; then
634                 # use modprobe
635                 echo "Using modprobe to load modules"
636                 return 0
637         fi
638
639         # Create special udev test rules on every node
640         if [ -f $LUSTRE/lustre/conf/99-lustre.rules ]; then {
641                 sed -e 's|/usr/sbin/lctl|$LCTL|g' $LUSTRE/lustre/conf/99-lustre.rules > /etc/udev/rules.d/99-lustre-test.rules
642         } else {
643                 echo "SUBSYSTEM==\"lustre\", ACTION==\"change\", ENV{PARAM}==\"?*\", RUN+=\"$LCTL set_param '\$env{PARAM}=\$env{SETTING}'\"" > /etc/udev/rules.d/99-lustre-test.rules
644         } fi
645         udevadm control --reload-rules
646         udevadm trigger
647
648         # For kmemleak-enabled kernels we need clear all past state
649         # that obviously has nothing to do with this Lustre run
650         # Disable automatic memory scanning to avoid perf hit.
651         if [ -f /sys/kernel/debug/kmemleak ] ; then
652                 echo scan=off > /sys/kernel/debug/kmemleak
653                 echo scan > /sys/kernel/debug/kmemleak
654                 echo clear > /sys/kernel/debug/kmemleak
655         fi
656
657         echo Loading modules from $LUSTRE
658
659         local ncpus
660
661         if [ -f /sys/devices/system/cpu/online ]; then
662                 ncpus=$(($(cut -d "-" -f 2 /sys/devices/system/cpu/online) + 1))
663                 echo "detected $ncpus online CPUs by sysfs"
664         else
665                 ncpus=$(getconf _NPROCESSORS_CONF 2>/dev/null)
666                 local rc=$?
667                 if [ $rc -eq 0 ]; then
668                         echo "detected $ncpus online CPUs by getconf"
669                 else
670                         echo "Can't detect number of CPUs"
671                         ncpus=1
672                 fi
673         fi
674
675         # if there is only one CPU core, libcfs can only create one partition
676         # if there is more than 4 CPU cores, libcfs should create multiple CPU
677         # partitions. So we just force libcfs to create 2 partitions for
678         # system with 2 or 4 cores
679         if [ $ncpus -le 4 ] && [ $ncpus -gt 1 ]; then
680                 # force to enable multiple CPU partitions
681                 echo "Force libcfs to create 2 CPU partitions"
682                 MODOPTS_LIBCFS="cpu_npartitions=2 $MODOPTS_LIBCFS"
683         else
684                 echo "libcfs will create CPU partition based on online CPUs"
685         fi
686
687         load_module ../libcfs/libcfs/libcfs
688         # Prevent local MODOPTS_LIBCFS being passed as part of environment
689         # variable to remote nodes
690         unset MODOPTS_LIBCFS
691
692         set_default_debug
693         load_module ../lnet/lnet/lnet
694
695         LNDPATH=${LNDPATH:-"../lnet/klnds"}
696         if [ -z "$LNETLND" ]; then
697                 case $NETTYPE in
698                 o2ib*)  LNETLND="o2iblnd/ko2iblnd" ;;
699                 tcp*)   LNETLND="socklnd/ksocklnd" ;;
700                 *)      local lnd="${NETTYPE%%[0-9]}lnd"
701                         [ -f "$LNDPATH/$lnd/k$lnd.ko" ] &&
702                                 LNETLND="$lnd/k$lnd" ||
703                                 LNETLND="socklnd/ksocklnd"
704                 esac
705         fi
706         load_module ../lnet/klnds/$LNETLND
707         load_module obdclass/obdclass
708         load_module ptlrpc/ptlrpc
709         load_module ptlrpc/gss/ptlrpc_gss
710         load_module fld/fld
711         load_module fid/fid
712         load_module lmv/lmv
713         load_module osc/osc
714         load_module mdc/mdc
715         load_module lov/lov
716         load_module mgc/mgc
717         load_module obdecho/obdecho
718         if ! client_only; then
719                 load_module lfsck/lfsck
720                 [ "$LQUOTA" != "no" ] &&
721                         load_module quota/lquota $LQUOTAOPTS
722                 if [[ $(node_fstypes $HOSTNAME) == *zfs* ]]; then
723                         load_module osd-zfs/osd_zfs
724                 elif [[ $(node_fstypes $HOSTNAME) == *ldiskfs* ]]; then
725                         load_module ../ldiskfs/ldiskfs
726                         load_module osd-ldiskfs/osd_ldiskfs
727                 fi
728                 load_module mgs/mgs
729                 load_module mdd/mdd
730                 load_module mdt/mdt
731                 load_module ost/ost
732                 load_module lod/lod
733                 load_module osp/osp
734                 load_module ofd/ofd
735                 load_module osp/osp
736         fi
737
738         load_module llite/lustre
739         [ -d /r ] && OGDB=${OGDB:-"/r/tmp"}
740         OGDB=${OGDB:-$TMP}
741         rm -f $OGDB/ogdb-$HOSTNAME
742         $LCTL modules > $OGDB/ogdb-$HOSTNAME
743
744         # 'mount' doesn't look in $PATH, just sbin
745         local mount_lustre=$LUSTRE/utils/mount.lustre
746         if [ -f $mount_lustre ]; then
747                 local sbin_mount=$(readlink -f /sbin)/mount.lustre
748                 if grep -qw "$sbin_mount" /proc/mounts; then
749                         cmp -s $mount_lustre $sbin_mount || umount $sbin_mount
750                 fi
751                 if ! grep -qw "$sbin_mount" /proc/mounts; then
752                         [ ! -f "$sbin_mount" ] && touch "$sbin_mount"
753                         if [ ! -s "$sbin_mount" -a -w "$sbin_mount" ]; then
754                                 cat <<- EOF > "$sbin_mount"
755                                 #!/bin/sh
756                                 #STUB MARK
757                                 echo "This $sbin_mount just a mountpoint." 1>&2
758                                 echo "It is never supposed to be run." 1>&2
759                                 logger -p emerg -- "using stub $sbin_mount $@"
760                                 exit 1
761                                 EOF
762                                 chmod a+x $sbin_mount
763                         fi
764                         mount --bind $mount_lustre $sbin_mount ||
765                                 error "can't bind $mount_lustre to $sbin_mount"
766                 fi
767         fi
768 }
769
770 load_modules () {
771         load_modules_local
772         # bug 19124
773         # load modules on remote nodes optionally
774         # lustre-tests have to be installed on these nodes
775         if $LOAD_MODULES_REMOTE; then
776                 local list=$(comma_list $(remote_nodes_list))
777                 if [ -n "$list" ]; then
778                         echo "loading modules on: '$list'"
779                         do_rpc_nodes "$list" load_modules_local
780                 fi
781         fi
782 }
783
784 check_mem_leak () {
785     LEAK_LUSTRE=$(dmesg | tail -n 30 | grep "obd_memory.*leaked" || true)
786     LEAK_PORTALS=$(dmesg | tail -n 20 | grep "Portals memory leaked" || true)
787     if [ "$LEAK_LUSTRE" -o "$LEAK_PORTALS" ]; then
788         echo "$LEAK_LUSTRE" 1>&2
789         echo "$LEAK_PORTALS" 1>&2
790         mv $TMP/debug $TMP/debug-leak.`date +%s` || true
791         echo "Memory leaks detected"
792         [ -n "$IGNORE_LEAK" ] && { echo "ignoring leaks" && return 0; } || true
793         return 1
794     fi
795 }
796
797 unload_modules() {
798         wait_exit_ST client # bug 12845
799
800         $LUSTRE_RMMOD ldiskfs || return 2
801
802         [ -f /etc/udev/rules.d/99-lustre-test.rules ] &&
803                 rm /etc/udev/rules.d/99-lustre-test.rules
804         udevadm control --reload-rules
805         udevadm trigger
806
807         if $LOAD_MODULES_REMOTE; then
808                 local list=$(comma_list $(remote_nodes_list))
809                 if [ -n "$list" ]; then
810                         echo "unloading modules on: '$list'"
811                         do_rpc_nodes "$list" $LUSTRE_RMMOD ldiskfs
812                         do_rpc_nodes "$list" check_mem_leak
813                         do_rpc_nodes "$list" "rm -f /etc/udev/rules.d/99-lustre-test.rules"
814                         do_rpc_nodes "$list" "udevadm control --reload-rules"
815                         do_rpc_nodes "$list" "udevadm trigger"
816                 fi
817         fi
818
819         local sbin_mount=$(readlink -f /sbin)/mount.lustre
820         if grep -qe "$sbin_mount " /proc/mounts; then
821                 umount $sbin_mount || true
822                 [ -s $sbin_mount ] && ! grep -q "STUB MARK" $sbin_mount ||
823                         rm -f $sbin_mount
824         fi
825
826         check_mem_leak || return 254
827
828         echo "modules unloaded."
829         return 0
830 }
831
832 fs_log_size() {
833         local facet=${1:-$SINGLEMDS}
834         local size=0
835
836         case $(facet_fstype $facet) in
837                 ldiskfs) size=50;; # largest seen is 44, leave some headroom
838                 # grant_block_size is in bytes, allow at least 2x max blocksize
839                 zfs)     size=$(lctl get_param osc.$FSNAME*.import |
840                                 awk '/grant_block_size:/ {print $2/512; exit;}')
841                           ;;
842         esac
843
844         echo -n $((size * MDSCOUNT))
845 }
846
847 fs_inode_ksize() {
848         local facet=${1:-$SINGLEMDS}
849         local fstype=$(facet_fstype $facet)
850         local size=0
851         case $fstype in
852                 ldiskfs) size=4;;  # ~4KB per inode
853                 zfs)     size=11;; # 10 to 11KB per inode
854         esac
855
856         echo -n $size
857 }
858
859 check_gss_daemon_nodes() {
860     local list=$1
861     dname=$2
862
863     do_nodesv $list "num=\\\$(ps -o cmd -C $dname | grep $dname | wc -l);
864 if [ \\\"\\\$num\\\" -ne 1 ]; then
865     echo \\\$num instance of $dname;
866     exit 1;
867 fi; "
868 }
869
870 check_gss_daemon_facet() {
871     facet=$1
872     dname=$2
873
874     num=`do_facet $facet ps -o cmd -C $dname | grep $dname | wc -l`
875     if [ $num -ne 1 ]; then
876         echo "$num instance of $dname on $facet"
877         return 1
878     fi
879     return 0
880 }
881
882 send_sigint() {
883     local list=$1
884     shift
885     echo Stopping $@ on $list
886     do_nodes $list "killall -2 $@ 2>/dev/null || true"
887 }
888
889 # start gss daemons on all nodes, or "daemon" on "nodes" if set
890 start_gss_daemons() {
891         local nodes=$1
892         local daemon=$2
893
894         if [ "$nodes" ] && [ "$daemon" ] ; then
895                 echo "Starting gss daemon on nodes: $nodes"
896                 do_nodes $nodes "$daemon" || return 8
897                 return 0
898         fi
899
900         nodes=$(comma_list $(mdts_nodes))
901         echo "Starting gss daemon on mds: $nodes"
902         if $GSS_SK; then
903                 # Start all versions, in case of switching
904                 do_nodes $nodes "$LSVCGSSD -vvv -s -m -o -z" || return 1
905         else
906                 do_nodes $nodes "$LSVCGSSD -v" || return 1
907         fi
908         if $GSS_PIPEFS; then
909                 do_nodes $nodes "$LGSSD -v" || return 2
910         fi
911
912         nodes=$(comma_list $(osts_nodes))
913         echo "Starting gss daemon on ost: $nodes"
914         if $GSS_SK; then
915                 # Start all versions, in case of switching
916                 do_nodes $nodes "$LSVCGSSD -vvv -s -m -o -z" || return 3
917         else
918                 do_nodes $nodes "$LSVCGSSD -v" || return 3
919         fi
920         # starting on clients
921
922         local clients=${CLIENTS:-$HOSTNAME}
923         if $GSS_PIPEFS; then
924                 echo "Starting $LGSSD on clients $clients "
925                 do_nodes $clients  "$LGSSD -v" || return 4
926         fi
927
928         # wait daemons entering "stable" status
929         sleep 5
930
931         #
932         # check daemons are running
933         #
934         nodes=$(comma_list $(mdts_nodes) $(osts_nodes))
935         check_gss_daemon_nodes $nodes lsvcgssd || return 5
936         if $GSS_PIPEFS; then
937                 nodes=$(comma_list $(mdts_nodes))
938                 check_gss_daemon_nodes $nodes lgssd || return 6
939         fi
940         if $GSS_PIPEFS; then
941                 check_gss_daemon_nodes $clients lgssd || return 7
942         fi
943 }
944
945 stop_gss_daemons() {
946         local nodes=$(comma_list $(mdts_nodes))
947
948         send_sigint $nodes lsvcgssd lgssd
949
950         nodes=$(comma_list $(osts_nodes))
951         send_sigint $nodes lsvcgssd
952
953         nodes=${CLIENTS:-$HOSTNAME}
954         send_sigint $nodes lgssd
955 }
956
957 add_sk_mntflag() {
958         # Add mount flags for shared key
959         local mt_opts=$@
960         if grep -q skpath <<< "$mt_opts" ; then
961                 mt_opts=$(echo $mt_opts |
962                         sed -e "s#skpath=[^ ,]*#skpath=$SK_PATH#")
963         else
964                 if [ -z "$mt_opts" ]; then
965                         mt_opts="-o skpath=$SK_PATH"
966                 else
967                         mt_opts="$mt_opts,skpath=$SK_PATH"
968                 fi
969         fi
970         echo -n $mt_opts
971 }
972
973 init_gss() {
974         if $SHARED_KEY; then
975                 GSS=true
976                 GSS_SK=true
977         fi
978
979         if ! $GSS; then
980                 return
981         fi
982
983         case $LUSTRE in
984         /usr/lib/lustre/* | /usr/lib64/lustre/* | /usr/lib/lustre | \
985         /usr/lib64/lustre )
986                 from_build_tree=false
987                 ;;
988         *)
989                 from_build_tree=true
990                 ;;
991         esac
992
993         if ! module_loaded ptlrpc_gss; then
994                 load_module ptlrpc/gss/ptlrpc_gss
995                 module_loaded ptlrpc_gss ||
996                         error_exit "init_gss: GSS=$GSS, but gss/krb5 missing"
997         fi
998
999         if $GSS_KRB5 || $GSS_SK; then
1000                 start_gss_daemons || error_exit "start gss daemon failed! rc=$?"
1001         fi
1002
1003         if $GSS_SK && $SK_NO_KEY; then
1004                 local numclients=${1:-$CLIENTCOUNT}
1005                 local clients=${CLIENTS:-$HOSTNAME}
1006
1007                 # security ctx config for keyring
1008                 SK_NO_KEY=false
1009                 local lgssc_conf_file="/etc/request-key.d/lgssc.conf"
1010
1011                 if $from_build_tree; then
1012                         mkdir -p $SK_OM_PATH
1013                         if grep -q request-key /proc/mounts > /dev/null; then
1014                                 echo "SSK: Request key already mounted."
1015                         else
1016                                 mount -o bind $SK_OM_PATH /etc/request-key.d/
1017                         fi
1018                         local lgssc_conf_line='create lgssc * * '
1019                         lgssc_conf_line+=$(which lgss_keyring)
1020                         lgssc_conf_line+=' %o %k %t %d %c %u %g %T %P %S'
1021                         echo "$lgssc_conf_line" > $lgssc_conf_file
1022                 fi
1023
1024                 [ -e $lgssc_conf_file ] ||
1025                         error_exit "Could not find key options in $lgssc_conf_file"
1026                 echo "$lgssc_conf_file content is:"
1027                 cat $lgssc_conf_file
1028
1029                 if ! local_mode; then
1030                         if $from_build_tree; then
1031                                 do_nodes $(comma_list $(all_nodes)) "mkdir -p \
1032                                         $SK_OM_PATH"
1033                                 do_nodes $(comma_list $(all_nodes)) "mount \
1034                                         -o bind $SK_OM_PATH \
1035                                         /etc/request-key.d/"
1036                                 do_nodes $(comma_list $(all_nodes)) "rsync \
1037                                         -aqv $HOSTNAME:$lgssc_conf_file \
1038                                         $lgssc_conf_file >/dev/null 2>&1"
1039                         else
1040                                 do_nodes $(comma_list $(all_nodes)) \
1041                                         "echo $lgssc_conf_file: ; \
1042                                         cat $lgssc_conf_file"
1043                         fi
1044                 fi
1045
1046                 # create shared key on all nodes
1047                 mkdir -p $SK_PATH/nodemap
1048                 rm -f $SK_PATH/$FSNAME.key $SK_PATH/nodemap/c*.key \
1049                         $SK_PATH/$FSNAME-*.key
1050                 # for nodemap testing each client may need own key,
1051                 # and S2S now requires keys as well, both for "client"
1052                 # and for "server"
1053                 if $SK_S2S; then
1054                         lgss_sk -t server -f$FSNAME -n $SK_S2SNMCLI \
1055                                 -w $SK_PATH/$FSNAME-nmclient.key \
1056                                 -d /dev/urandom >/dev/null 2>&1
1057                         lgss_sk -t mgs,server -f$FSNAME -n $SK_S2SNM \
1058                                 -w $SK_PATH/$FSNAME-s2s-server.key \
1059                                 -d /dev/urandom >/dev/null 2>&1
1060                 fi
1061                 # basic key create
1062                 lgss_sk -t server -f$FSNAME -w $SK_PATH/$FSNAME.key \
1063                         -d /dev/urandom >/dev/null 2>&1
1064                 # per-nodemap keys
1065                 for i in $(seq 0 $((numclients - 1))); do
1066                         lgss_sk -t server -f$FSNAME -n c$i \
1067                                 -w $SK_PATH/nodemap/c$i.key -d /dev/urandom \
1068                                 >/dev/null 2>&1
1069                 done
1070                 # Distribute keys
1071                 if ! local_mode; then
1072                         for lnode in $(all_nodes); do
1073                                 scp -r $SK_PATH ${lnode}:$(dirname $SK_PATH)/
1074                         done
1075                 fi
1076                 # Set client keys to client type to generate prime P
1077                 if local_mode; then
1078                         do_nodes $(all_nodes) "lgss_sk -t client,server -m \
1079                                 $SK_PATH/$FSNAME.key >/dev/null 2>&1"
1080                 else
1081                         do_nodes $clients "lgss_sk -t client -m \
1082                                 $SK_PATH/$FSNAME.key >/dev/null 2>&1"
1083                         do_nodes $clients "find $SK_PATH/nodemap -name \*.key | \
1084                                 xargs -IX lgss_sk -t client -m X >/dev/null 2>&1"
1085                 fi
1086                 # This is required for servers as well, if S2S in use
1087                 if $SK_S2S; then
1088                         do_nodes $(comma_list $(mdts_nodes)) \
1089                                 "cp $SK_PATH/$FSNAME-s2s-server.key \
1090                                 $SK_PATH/$FSNAME-s2s-client.key; lgss_sk \
1091                                 -t client -m $SK_PATH/$FSNAME-s2s-client.key \
1092                                 >/dev/null 2>&1"
1093                         do_nodes $(comma_list $(osts_nodes)) \
1094                                 "cp $SK_PATH/$FSNAME-s2s-server.key \
1095                                 $SK_PATH/$FSNAME-s2s-client.key; lgss_sk \
1096                                 -t client -m $SK_PATH/$FSNAME-s2s-client.key \
1097                                 >/dev/null 2>&1"
1098                         do_nodes $clients "lgss_sk -t client \
1099                                 -m $SK_PATH/$FSNAME-nmclient.key \
1100                                  >/dev/null 2>&1"
1101                 fi
1102         fi
1103         if $GSS_SK; then
1104                 # mount options for servers and clients
1105                 MGS_MOUNT_OPTS=$(add_sk_mntflag $MGS_MOUNT_OPTS)
1106                 MDS_MOUNT_OPTS=$(add_sk_mntflag $MDS_MOUNT_OPTS)
1107                 OST_MOUNT_OPTS=$(add_sk_mntflag $OST_MOUNT_OPTS)
1108                 MOUNT_OPTS=$(add_sk_mntflag $MOUNT_OPTS)
1109                 SEC=$SK_FLAVOR
1110         fi
1111
1112         if [ -n "$LGSS_KEYRING_DEBUG" ]; then
1113                 lctl set_param -n \
1114                         sptlrpc.gss.lgss_keyring.debug_level=$LGSS_KEYRING_DEBUG
1115         fi
1116 }
1117
1118 cleanup_gss() {
1119         if $GSS; then
1120                 stop_gss_daemons
1121                 # maybe cleanup credential cache?
1122         fi
1123 }
1124
1125 cleanup_sk() {
1126         if $GSS_SK; then
1127                 case $LUSTRE in
1128                 /usr/lib/lustre/* | /usr/lib64/lustre/* | /usr/lib/lustre | \
1129                 /usr/lib64/lustre )
1130                         from_build_tree=false
1131                         ;;
1132                 *)
1133                         from_build_tree=true
1134                         ;;
1135                 esac
1136
1137                 if $SK_S2S; then
1138                         do_node $(mgs_node) "$LCTL nodemap_del $SK_S2SNM"
1139                         do_node $(mgs_node) "$LCTL nodemap_del $SK_S2SNMCLI"
1140                         $RPC_MODE || echo "Sleeping for 10 sec for Nodemap.."
1141                         sleep 10
1142                 fi
1143                 stop_gss_daemons
1144                 $RPC_MODE || echo "Cleaning up Shared Key.."
1145                 do_nodes $(comma_list $(all_nodes)) "rm -f \
1146                         $SK_PATH/$FSNAME*.key $SK_PATH/nodemap/$FSNAME*.key"
1147                 do_nodes $(comma_list $(all_nodes)) "keyctl show | \
1148                   awk '/lustre/ { print \\\$1 }' | xargs -IX keyctl unlink X"
1149                 if $from_build_tree; then
1150                         # Remove the mount and clean up the files we added to
1151                         # SK_PATH
1152                         do_nodes $(comma_list $(all_nodes)) "while grep -q \
1153                                 request-key.d /proc/mounts; do umount \
1154                                 /etc/request-key.d/; done"
1155                         do_nodes $(comma_list $(all_nodes)) "rm -f \
1156                                 $SK_OM_PATH/lgssc.conf"
1157                         do_nodes $(comma_list $(all_nodes)) "rmdir $SK_OM_PATH"
1158                 fi
1159                 SK_NO_KEY=true
1160         fi
1161 }
1162
1163 facet_svc() {
1164         local facet=$1
1165         local var=${facet}_svc
1166
1167         echo -n ${!var}
1168 }
1169
1170 facet_type() {
1171         local facet=$1
1172
1173         echo -n $facet | sed -e 's/^fs[0-9]\+//' -e 's/[0-9_]\+//' |
1174                 tr '[:lower:]' '[:upper:]'
1175 }
1176
1177 facet_number() {
1178         local facet=$1
1179
1180         if [ $facet == mgs ] || [ $facet == client ]; then
1181                 return 1
1182         fi
1183
1184         echo -n $facet | sed -e 's/^fs[0-9]\+//' | sed -e 's/^[a-z]\+//'
1185 }
1186
1187 facet_fstype() {
1188         local facet=$1
1189         local var
1190
1191         var=${facet}_FSTYPE
1192         if [ -n "${!var}" ]; then
1193                 echo -n ${!var}
1194                 return
1195         fi
1196
1197         var=$(facet_type $facet)FSTYPE
1198         if [ -n "${!var}" ]; then
1199                 echo -n ${!var}
1200                 return
1201         fi
1202
1203         if [ -n "$FSTYPE" ]; then
1204                 echo -n $FSTYPE
1205                 return
1206         fi
1207
1208         if [[ $facet == mgs ]] && combined_mgs_mds; then
1209                 facet_fstype mds1
1210                 return
1211         fi
1212
1213         return 1
1214 }
1215
1216 node_fstypes() {
1217         local node=$1
1218         local fstypes
1219         local fstype
1220         local facets=$(get_facets)
1221         local facet
1222
1223         for facet in ${facets//,/ }; do
1224                 if [ $node == $(facet_host $facet) ] ||
1225                    [ $node == "$(facet_failover_host $facet)" ]; then
1226                         fstype=$(facet_fstype $facet)
1227                         if [[ $fstypes != *$fstype* ]]; then
1228                                 fstypes+="${fstypes:+,}$fstype"
1229                         fi
1230                 fi
1231         done
1232         echo -n $fstypes
1233 }
1234
1235 facet_index() {
1236         local facet=$1
1237         local num=$(facet_number $facet)
1238         local index
1239
1240         if [[ $(facet_type $facet) = OST ]]; then
1241                 index=OSTINDEX${num}
1242                 if [[ -n "${!index}" ]]; then
1243                         echo -n ${!index}
1244                         return
1245                 fi
1246
1247                 index=${OST_INDICES[num - 1]}
1248         fi
1249
1250         [[ -n "$index" ]] || index=$((num - 1))
1251         echo -n $index
1252 }
1253
1254 devicelabel() {
1255         local facet=$1
1256         local dev=$2
1257         local label
1258         local fstype=$(facet_fstype $facet)
1259
1260         case $fstype in
1261         ldiskfs)
1262                 label=$(do_facet ${facet} "$E2LABEL ${dev} 2>/dev/null");;
1263         zfs)
1264                 label=$(do_facet ${facet} "$ZFS get -H -o value lustre:svname \
1265                                            ${dev} 2>/dev/null");;
1266         *)
1267                 error "unknown fstype!";;
1268         esac
1269
1270         echo -n $label
1271 }
1272
1273 mdsdevlabel() {
1274         local num=$1
1275         local device=$(mdsdevname $num)
1276         local label=$(devicelabel mds$num ${device} | grep -v "CMD: ")
1277         echo -n $label
1278 }
1279
1280 ostdevlabel() {
1281         local num=$1
1282         local device=$(ostdevname $num)
1283         local label=$(devicelabel ost$num ${device} | grep -v "CMD: ")
1284         echo -n $label
1285 }
1286
1287 #
1288 # Get the device of a facet.
1289 #
1290 facet_device() {
1291         local facet=$1
1292         local device
1293
1294         case $facet in
1295                 mgs) device=$(mgsdevname) ;;
1296                 mds*) device=$(mdsdevname $(facet_number $facet)) ;;
1297                 ost*) device=$(ostdevname $(facet_number $facet)) ;;
1298                 fs2mds) device=$(mdsdevname 1_2) ;;
1299                 fs2ost) device=$(ostdevname 1_2) ;;
1300                 fs3ost) device=$(ostdevname 2_2) ;;
1301                 *) ;;
1302         esac
1303
1304         echo -n $device
1305 }
1306
1307 #
1308 # Get the virtual device of a facet.
1309 #
1310 facet_vdevice() {
1311         local facet=$1
1312         local device
1313
1314         case $facet in
1315                 mgs) device=$(mgsvdevname) ;;
1316                 mds*) device=$(mdsvdevname $(facet_number $facet)) ;;
1317                 ost*) device=$(ostvdevname $(facet_number $facet)) ;;
1318                 fs2mds) device=$(mdsvdevname 1_2) ;;
1319                 fs2ost) device=$(ostvdevname 1_2) ;;
1320                 fs3ost) device=$(ostvdevname 2_2) ;;
1321                 *) ;;
1322         esac
1323
1324         echo -n $device
1325 }
1326
1327 running_in_vm() {
1328         local virt=$(virt-what 2> /dev/null)
1329
1330         [ $? -eq 0 ] && [ -n "$virt" ] && { echo $virt; return; }
1331
1332         virt=$(dmidecode -s system-product-name | awk '{print $1}')
1333
1334         case $virt in
1335                 VMware|KVM|VirtualBox|Parallels|Bochs)
1336                         echo $virt | tr '[A-Z]' '[a-z]' ;;
1337                 *) ;;
1338         esac
1339 }
1340
1341 #
1342 # Re-read the partition table on failover partner host.
1343 # After a ZFS storage pool is created on a shared device, the partition table
1344 # on the device may change. However, the operating system on the failover
1345 # host may not notice the change automatically. Without the up-to-date partition
1346 # block devices, 'zpool import ..' cannot find the labels, whose positions are
1347 # relative to partition rather than disk beginnings.
1348 #
1349 # This function performs partprobe on the failover host to make it re-read the
1350 # partition table.
1351 #
1352 refresh_partition_table() {
1353         local facet=$1
1354         local device=$2
1355         local host
1356
1357         host=$(facet_passive_host $facet)
1358         if [[ -n "$host" ]]; then
1359                 do_node $host "$PARTPROBE $device"
1360         fi
1361 }
1362
1363 #
1364 # Get ZFS storage pool name.
1365 #
1366 zpool_name() {
1367         local facet=$1
1368         local device
1369         local poolname
1370
1371         device=$(facet_device $facet)
1372         # poolname is string before "/"
1373         poolname="${device%%/*}"
1374
1375         echo -n $poolname
1376 }
1377
1378 #
1379 #
1380 # Get ZFS local fsname.
1381 #
1382 zfs_local_fsname() {
1383         local facet=$1
1384         local lfsname=$(basename $(facet_device $facet))
1385
1386         echo -n $lfsname
1387 }
1388
1389 #
1390 # Create ZFS storage pool.
1391 #
1392 create_zpool() {
1393         local facet=$1
1394         local poolname=$2
1395         local vdev=$3
1396         shift 3
1397         local opts=${@:-"-o cachefile=none"}
1398
1399         do_facet $facet "lsmod | grep zfs >&/dev/null || modprobe zfs;
1400                 $ZPOOL list -H $poolname >/dev/null 2>&1 ||
1401                 $ZPOOL create -f $opts $poolname $vdev"
1402 }
1403
1404 #
1405 # Create ZFS file system.
1406 #
1407 create_zfs() {
1408         local facet=$1
1409         local dataset=$2
1410         shift 2
1411         local opts=${@:-"-o mountpoint=legacy"}
1412
1413         do_facet $facet "$ZFS list -H $dataset >/dev/null 2>&1 ||
1414                 $ZFS create $opts $dataset"
1415 }
1416
1417 #
1418 # Export ZFS storage pool.
1419 # Before exporting the pool, all datasets within the pool should be unmounted.
1420 #
1421 export_zpool() {
1422         local facet=$1
1423         shift
1424         local opts="$@"
1425         local poolname
1426
1427         poolname=$(zpool_name $facet)
1428
1429         if [[ -n "$poolname" ]]; then
1430                 do_facet $facet "! $ZPOOL list -H $poolname >/dev/null 2>&1 ||
1431                         grep -q ^$poolname/ /proc/mounts ||
1432                         $ZPOOL export $opts $poolname"
1433         fi
1434 }
1435
1436 #
1437 # Destroy ZFS storage pool.
1438 # Destroy the given pool and free up any devices for other use. This command
1439 # tries to unmount any active datasets before destroying the pool.
1440 # -f    Force any active datasets contained within the pool to be unmounted.
1441 #
1442 destroy_zpool() {
1443         local facet=$1
1444         local poolname=${2:-$(zpool_name $facet)}
1445
1446         if [[ -n "$poolname" ]]; then
1447                 do_facet $facet "! $ZPOOL list -H $poolname >/dev/null 2>&1 ||
1448                         $ZPOOL destroy -f $poolname"
1449         fi
1450 }
1451
1452 #
1453 # Import ZFS storage pool.
1454 # Force importing, even if the pool appears to be potentially active.
1455 #
1456 import_zpool() {
1457         local facet=$1
1458         shift
1459         local opts=${@:-"-o cachefile=none -o failmode=panic"}
1460         local poolname
1461
1462         poolname=$(zpool_name $facet)
1463
1464         if [[ -n "$poolname" ]]; then
1465                 opts+=" -d $(dirname $(facet_vdevice $facet))"
1466                 do_facet $facet "lsmod | grep zfs >&/dev/null || modprobe zfs;
1467                         $ZPOOL list -H $poolname >/dev/null 2>&1 ||
1468                         $ZPOOL import -f $opts $poolname"
1469         fi
1470 }
1471
1472 #
1473 # Reimport ZFS storage pool with new name
1474 #
1475 reimport_zpool() {
1476         local facet=$1
1477         local newpool=$2
1478         local opts="-o cachefile=none"
1479         local poolname=$(zpool_name $facet)
1480
1481         opts+=" -d $(dirname $(facet_vdevice $facet))"
1482         do_facet $facet "$ZPOOL export $poolname;
1483                          $ZPOOL import $opts $poolname $newpool"
1484 }
1485
1486 #
1487 # Set the "cachefile=none" property on ZFS storage pool so that the pool
1488 # is not automatically imported on system startup.
1489 #
1490 # In a failover environment, this will provide resource level fencing which
1491 # will ensure that the same ZFS storage pool will not be imported concurrently
1492 # on different nodes.
1493 #
1494 disable_zpool_cache() {
1495         local facet=$1
1496         local poolname
1497
1498         poolname=$(zpool_name $facet)
1499
1500         if [[ -n "$poolname" ]]; then
1501                 do_facet $facet "$ZPOOL set cachefile=none $poolname"
1502         fi
1503 }
1504
1505 #
1506 # This and set_osd_param() shall be used to access OSD parameters
1507 # once existed under "obdfilter":
1508 #
1509 #   mntdev
1510 #   stats
1511 #   read_cache_enable
1512 #   writethrough_cache_enable
1513 #
1514 get_osd_param() {
1515         local nodes=$1
1516         local device=${2:-$FSNAME-OST*}
1517         local name=$3
1518
1519         do_nodes $nodes "$LCTL get_param -n obdfilter.$device.$name \
1520                 osd-*.$device.$name 2>&1" | grep -v 'error:'
1521 }
1522
1523 set_osd_param() {
1524         local nodes=$1
1525         local device=${2:-$FSNAME-OST*}
1526         local name=$3
1527         local value=$4
1528
1529         do_nodes $nodes "$LCTL set_param -n obdfilter.$device.$name=$value \
1530                 osd-*.$device.$name=$value 2>&1" | grep -v 'error:'
1531 }
1532
1533 set_debug_size () {
1534     local dz=${1:-$DEBUG_SIZE}
1535
1536     if [ -f /sys/devices/system/cpu/possible ]; then
1537         local cpus=$(($(cut -d "-" -f 2 /sys/devices/system/cpu/possible)+1))
1538     else
1539         local cpus=$(getconf _NPROCESSORS_CONF 2>/dev/null)
1540     fi
1541
1542     # bug 19944, adjust size to be -gt num_possible_cpus()
1543     # promise 2MB for every cpu at least
1544     if [ -n "$cpus" ] && [ $((cpus * 2)) -gt $dz ]; then
1545         dz=$((cpus * 2))
1546     fi
1547     lctl set_param debug_mb=$dz
1548 }
1549
1550 set_default_debug () {
1551     local debug=${1:-"$PTLDEBUG"}
1552     local subsys=${2:-"$SUBSYSTEM"}
1553     local debug_size=${3:-$DEBUG_SIZE}
1554
1555     [ -n "$debug" ] && lctl set_param debug="$debug" >/dev/null
1556     [ -n "$subsys" ] && lctl set_param subsystem_debug="${subsys# }" >/dev/null
1557
1558     [ -n "$debug_size" ] && set_debug_size $debug_size > /dev/null
1559 }
1560
1561 set_default_debug_nodes () {
1562         local nodes="$1"
1563
1564         if [[ ,$nodes, = *,$HOSTNAME,* ]]; then
1565                 nodes=$(exclude_items_from_list "$nodes" "$HOSTNAME")
1566                 set_default_debug
1567         fi
1568
1569         do_rpc_nodes "$nodes" set_default_debug \
1570                 \\\"$PTLDEBUG\\\" \\\"$SUBSYSTEM\\\" $DEBUG_SIZE || true
1571 }
1572
1573 set_default_debug_facet () {
1574     local facet=$1
1575     local node=$(facet_active_host $facet)
1576     [ -z "$node" ] && echo "No host defined for facet $facet" && exit 1
1577
1578     set_default_debug_nodes $node
1579 }
1580
1581 set_hostid () {
1582     local hostid=${1:-$(hostid)}
1583
1584     if [ ! -s /etc/hostid ]; then
1585         printf $(echo -n $hostid |
1586             sed 's/\(..\)\(..\)\(..\)\(..\)/\\x\4\\x\3\\x\2\\x\1/') >/etc/hostid
1587     fi
1588 }
1589
1590 # Facet functions
1591 mount_facets () {
1592         local facets=${1:-$(get_facets)}
1593         local facet
1594
1595         for facet in ${facets//,/ }; do
1596                 mount_facet $facet
1597                 local RC=$?
1598                 [ $RC -eq 0 ] && continue
1599
1600                 if [ "$TESTSUITE.$TESTNAME" = "replay-dual.test_0a" ]; then
1601                         skip_noexit "Restart of $facet failed!." &&
1602                                 touch $LU482_FAILED
1603                 else
1604                         error "Restart of $facet failed!"
1605                 fi
1606                 return $RC
1607         done
1608 }
1609
1610 #
1611 # Add argument "arg" (e.g., "loop") to the comma-separated list
1612 # of arguments for option "opt" (e.g., "-o") on command
1613 # line "opts" (e.g., "-o flock").
1614 #
1615 csa_add() {
1616         local opts=$1
1617         local opt=$2
1618         local arg=$3
1619         local opt_pattern="\([[:space:]]\+\|^\)$opt"
1620
1621         if echo "$opts" | grep -q $opt_pattern; then
1622                 opts=$(echo "$opts" | sed -e \
1623                         "s/$opt_pattern[[:space:]]*[^[:space:]]\+/&,$arg/")
1624         else
1625                 opts+="${opts:+ }$opt $arg"
1626         fi
1627         echo -n "$opts"
1628 }
1629
1630 #
1631 # Associate loop device with a given regular file.
1632 # Return the loop device.
1633 #
1634 setup_loop_device() {
1635         local facet=$1
1636         local file=$2
1637
1638         do_facet $facet "loop_dev=\\\$($LOSETUP -j $file | cut -d : -f 1);
1639                          if [[ -z \\\$loop_dev ]]; then
1640                                 loop_dev=\\\$($LOSETUP -f);
1641                                 $LOSETUP \\\$loop_dev $file || loop_dev=;
1642                          fi;
1643                          echo -n \\\$loop_dev"
1644 }
1645
1646 #
1647 # Detach a loop device.
1648 #
1649 cleanup_loop_device() {
1650         local facet=$1
1651         local loop_dev=$2
1652
1653         do_facet $facet "! $LOSETUP $loop_dev >/dev/null 2>&1 ||
1654                          $LOSETUP -d $loop_dev"
1655 }
1656
1657 #
1658 # Check if a given device is a block device.
1659 #
1660 is_blkdev() {
1661         local facet=$1
1662         local dev=$2
1663         local size=${3:-""}
1664
1665         [[ -n "$dev" ]] || return 1
1666         do_facet $facet "test -b $dev" || return 1
1667         if [[ -n "$size" ]]; then
1668                 local in=$(do_facet $facet "dd if=$dev of=/dev/null bs=1k \
1669                                             count=1 skip=$size 2>&1" |
1670                                             awk '($3 == "in") { print $1 }')
1671                 [[ "$in" = "1+0" ]] || return 1
1672         fi
1673 }
1674
1675 #
1676 # Check if a given device is a device-mapper device.
1677 #
1678 is_dm_dev() {
1679         local facet=$1
1680         local dev=$2
1681
1682         [[ -n "$dev" ]] || return 1
1683         do_facet $facet "$DMSETUP status $dev >/dev/null 2>&1"
1684 }
1685
1686 #
1687 # Check if a given device is a device-mapper flakey device.
1688 #
1689 is_dm_flakey_dev() {
1690         local facet=$1
1691         local dev=$2
1692         local type
1693
1694         [[ -n "$dev" ]] || return 1
1695
1696         type=$(do_facet $facet "$DMSETUP status $dev 2>&1" |
1697                awk '{print $3}')
1698         [[ $type = flakey ]] && return 0 || return 1
1699 }
1700
1701 #
1702 # Check if device-mapper flakey device is supported by the kernel
1703 # of $facet node or not.
1704 #
1705 dm_flakey_supported() {
1706         local facet=$1
1707
1708         $FLAKEY || return 1
1709         do_facet $facet "modprobe dm-flakey;
1710                          $DMSETUP targets | grep -q flakey" &> /dev/null
1711 }
1712
1713 #
1714 # Get the device-mapper flakey device name of a given facet.
1715 #
1716 dm_facet_devname() {
1717         local facet=$1
1718         [[ $facet = mgs ]] && combined_mgs_mds && facet=mds1
1719
1720         echo -n ${facet}_flakey
1721 }
1722
1723 #
1724 # Get the device-mapper flakey device of a given facet.
1725 # A device created by dmsetup will appear as /dev/mapper/<device-name>.
1726 #
1727 dm_facet_devpath() {
1728         local facet=$1
1729
1730         echo -n $DM_DEV_PATH/$(dm_facet_devname $facet)
1731 }
1732
1733 #
1734 # Set a device-mapper device with a new table.
1735 #
1736 # The table has the following format:
1737 # <logical_start_sector> <num_sectors> <target_type> <target_args>
1738 #
1739 # flakey <target_args> includes:
1740 # <destination_device> <offset> <up_interval> <down_interval> \
1741 # [<num_features> [<feature_arguments>]]
1742 #
1743 # linear <target_args> includes:
1744 # <destination_device> <start_sector>
1745 #
1746 dm_set_dev_table() {
1747         local facet=$1
1748         local dm_dev=$2
1749         local target_type=$3
1750         local num_sectors
1751         local real_dev
1752         local tmp
1753         local table
1754
1755         read tmp num_sectors tmp real_dev tmp \
1756                 <<< $(do_facet $facet "$DMSETUP table $dm_dev")
1757
1758         case $target_type in
1759         flakey)
1760                 table="0 $num_sectors flakey $real_dev 0 0 1800 1 drop_writes"
1761                 ;;
1762         linear)
1763                 table="0 $num_sectors linear $real_dev 0"
1764                 ;;
1765         *) error "invalid target type $target_type" ;;
1766         esac
1767
1768         do_facet $facet "$DMSETUP suspend --nolockfs --noflush $dm_dev" ||
1769                 error "failed to suspend $dm_dev"
1770         do_facet $facet "$DMSETUP load $dm_dev --table \\\"$table\\\"" ||
1771                 error "failed to load $target_type table into $dm_dev"
1772         do_facet $facet "$DMSETUP resume $dm_dev" ||
1773                 error "failed to resume $dm_dev"
1774 }
1775
1776 #
1777 # Set a device-mapper flakey device as "read-only" by using the "drop_writes"
1778 # feature parameter.
1779 #
1780 # drop_writes:
1781 #       All write I/O is silently ignored.
1782 #       Read I/O is handled correctly.
1783 #
1784 dm_set_dev_readonly() {
1785         local facet=$1
1786         local dm_dev=${2:-$(dm_facet_devpath $facet)}
1787
1788         dm_set_dev_table $facet $dm_dev flakey
1789 }
1790
1791 #
1792 # Set a device-mapper device to traditional linear mapping mode.
1793 #
1794 dm_clear_dev_readonly() {
1795         local facet=$1
1796         local dm_dev=${2:-$(dm_facet_devpath $facet)}
1797
1798         dm_set_dev_table $facet $dm_dev linear
1799 }
1800
1801 #
1802 # Set the device of a given facet as "read-only".
1803 #
1804 set_dev_readonly() {
1805         local facet=$1
1806         local svc=${facet}_svc
1807
1808         if [[ $(facet_fstype $facet) = zfs ]] ||
1809            ! dm_flakey_supported $facet; then
1810                 do_facet $facet $LCTL --device ${!svc} readonly
1811         else
1812                 dm_set_dev_readonly $facet
1813         fi
1814 }
1815
1816 #
1817 # Get size in 512-byte sectors (BLKGETSIZE64 / 512) of a given device.
1818 #
1819 get_num_sectors() {
1820         local facet=$1
1821         local dev=$2
1822         local num_sectors
1823
1824         num_sectors=$(do_facet $facet "blockdev --getsz $dev 2>/dev/null")
1825         [[ ${PIPESTATUS[0]} = 0 && -n "$num_sectors" ]] || num_sectors=0
1826         echo -n $num_sectors
1827 }
1828
1829 #
1830 # Create a device-mapper device with a given block device or regular file (will
1831 # be associated with loop device).
1832 # Return the full path of the device-mapper device.
1833 #
1834 dm_create_dev() {
1835         local facet=$1
1836         local real_dev=$2                                  # destination device
1837         local dm_dev_name=${3:-$(dm_facet_devname $facet)} # device name
1838         local dm_dev=$DM_DEV_PATH/$dm_dev_name            # device-mapper device
1839
1840         # check if the device-mapper device to be created already exists
1841         if is_dm_dev $facet $dm_dev; then
1842                 # if the existing device was set to "read-only", then clear it
1843                 ! is_dm_flakey_dev $facet $dm_dev ||
1844                         dm_clear_dev_readonly $facet $dm_dev
1845
1846                 echo -n $dm_dev
1847                 return 0
1848         fi
1849
1850         # check if the destination device is a block device, and if not,
1851         # associate it with a loop device
1852         is_blkdev $facet $real_dev ||
1853                 real_dev=$(setup_loop_device $facet $real_dev)
1854         [[ -n "$real_dev" ]] || { echo -n $real_dev; return 2; }
1855
1856         # now create the device-mapper device
1857         local num_sectors=$(get_num_sectors $facet $real_dev)
1858         local table="0 $num_sectors linear $real_dev 0"
1859         local rc=0
1860
1861         do_facet $facet "$DMSETUP create $dm_dev_name --table \\\"$table\\\"" ||
1862                 { rc=${PIPESTATUS[0]}; dm_dev=; }
1863         do_facet $facet "$DMSETUP mknodes >/dev/null 2>&1"
1864
1865         echo -n $dm_dev
1866         return $rc
1867 }
1868
1869 #
1870 # Map the facet name to its device variable name.
1871 #
1872 facet_device_alias() {
1873         local facet=$1
1874         local dev_alias=$facet
1875
1876         case $facet in
1877                 fs2mds) dev_alias=mds1_2 ;;
1878                 fs2ost) dev_alias=ost1_2 ;;
1879                 fs3ost) dev_alias=ost2_2 ;;
1880                 *) ;;
1881         esac
1882
1883         echo -n $dev_alias
1884 }
1885
1886 #
1887 # Save the original value of the facet device and export the new value.
1888 #
1889 export_dm_dev() {
1890         local facet=$1
1891         local dm_dev=$2
1892
1893         local active_facet=$(facet_active $facet)
1894         local dev_alias=$(facet_device_alias $active_facet)
1895         local dev_name=${dev_alias}_dev
1896         local dev=${!dev_name}
1897
1898         if [[ $active_facet = $facet ]]; then
1899                 local failover_dev=${dev_alias}failover_dev
1900                 if [[ ${!failover_dev} = $dev ]]; then
1901                         eval export ${failover_dev}_saved=$dev
1902                         eval export ${failover_dev}=$dm_dev
1903                 fi
1904         else
1905                 dev_alias=$(facet_device_alias $facet)
1906                 local facet_dev=${dev_alias}_dev
1907                 if [[ ${!facet_dev} = $dev ]]; then
1908                         eval export ${facet_dev}_saved=$dev
1909                         eval export ${facet_dev}=$dm_dev
1910                 fi
1911         fi
1912
1913         eval export ${dev_name}_saved=$dev
1914         eval export ${dev_name}=$dm_dev
1915 }
1916
1917 #
1918 # Restore the saved value of the facet device.
1919 #
1920 unexport_dm_dev() {
1921         local facet=$1
1922
1923         [[ $facet = mgs ]] && combined_mgs_mds && facet=mds1
1924         local dev_alias=$(facet_device_alias $facet)
1925
1926         local saved_dev=${dev_alias}_dev_saved
1927         [[ -z ${!saved_dev} ]] ||
1928                 eval export ${dev_alias}_dev=${!saved_dev}
1929
1930         saved_dev=${dev_alias}failover_dev_saved
1931         [[ -z ${!saved_dev} ]] ||
1932                 eval export ${dev_alias}failover_dev=${!saved_dev}
1933 }
1934
1935 #
1936 # Remove a device-mapper device.
1937 # If the destination device is a loop device, then also detach it.
1938 #
1939 dm_cleanup_dev() {
1940         local facet=$1
1941         local dm_dev=${2:-$(dm_facet_devpath $facet)}
1942         local major
1943         local minor
1944
1945         is_dm_dev $facet $dm_dev || return 0
1946
1947         read major minor <<< $(do_facet $facet "$DMSETUP table $dm_dev" |
1948                 awk '{ print $4 }' | awk -F: '{ print $1" "$2 }')
1949
1950         do_facet $facet "$DMSETUP remove $dm_dev"
1951         do_facet $facet "$DMSETUP mknodes >/dev/null 2>&1"
1952
1953         unexport_dm_dev $facet
1954
1955         # detach a loop device
1956         [[ $major -ne 7 ]] || cleanup_loop_device $facet /dev/loop$minor
1957
1958         # unload dm-flakey module
1959         do_facet $facet "modprobe -r dm-flakey" || true
1960 }
1961
1962 mount_facet() {
1963         local facet=$1
1964         shift
1965         local active_facet=$(facet_active $facet)
1966         local dev_alias=$(facet_device_alias $active_facet)
1967         local dev=${dev_alias}_dev
1968         local opt=${facet}_opt
1969         local mntpt=$(facet_mntpt $facet)
1970         local opts="${!opt} $@"
1971         local fstype=$(facet_fstype $facet)
1972         local devicelabel
1973         local dm_dev=${!dev}
1974
1975         module_loaded lustre || load_modules
1976
1977         case $fstype in
1978         ldiskfs)
1979                 if dm_flakey_supported $facet; then
1980                         dm_dev=$(dm_create_dev $facet ${!dev})
1981                         [[ -n "$dm_dev" ]] || dm_dev=${!dev}
1982                 fi
1983
1984                 is_blkdev $facet $dm_dev || opts=$(csa_add "$opts" -o loop)
1985
1986                 devicelabel=$(do_facet ${facet} "$E2LABEL $dm_dev");;
1987         zfs)
1988                 # import ZFS storage pool
1989                 import_zpool $facet || return ${PIPESTATUS[0]}
1990
1991                 devicelabel=$(do_facet ${facet} "$ZFS get -H -o value \
1992                                                 lustre:svname $dm_dev");;
1993         *)
1994                 error "unknown fstype!";;
1995         esac
1996
1997         echo "Starting ${facet}: $opts $dm_dev $mntpt"
1998         # for testing LU-482 error handling in mount_facets() and test_0a()
1999         if [ -f $TMP/test-lu482-trigger ]; then
2000                 RC=2
2001         else
2002                 do_facet ${facet} \
2003                         "mkdir -p $mntpt; $MOUNT_CMD $opts $dm_dev $mntpt"
2004                 RC=${PIPESTATUS[0]}
2005         fi
2006
2007         if [ $RC -ne 0 ]; then
2008                 echo "Start of $dm_dev on ${facet} failed ${RC}"
2009                 return $RC
2010         fi
2011
2012         health=$(do_facet ${facet} "$LCTL get_param -n health_check")
2013         if [[ "$health" != "healthy" ]]; then
2014                 error "$facet is in a unhealthy state"
2015         fi
2016
2017         set_default_debug_facet $facet
2018
2019         if [[ $opts =~ .*nosvc.* ]]; then
2020                 echo "Start $dm_dev without service"
2021         else
2022
2023                 case $fstype in
2024                 ldiskfs)
2025                         wait_update_facet ${facet} "$E2LABEL $dm_dev \
2026                                 2>/dev/null | grep -E ':[a-zA-Z]{3}[0-9]{4}'" \
2027                                 "" || error "$dm_dev failed to initialize!";;
2028                 zfs)
2029                         wait_update_facet ${facet} "$ZFS get -H -o value \
2030                                 lustre:svname $dm_dev 2>/dev/null | \
2031                                 grep -E ':[a-zA-Z]{3}[0-9]{4}'" "" ||
2032                                 error "$dm_dev failed to initialize!";;
2033
2034                 *)
2035                         error "unknown fstype!";;
2036                 esac
2037         fi
2038
2039         # commit the device label change to disk
2040         if [[ $devicelabel =~ (:[a-zA-Z]{3}[0-9]{4}) ]]; then
2041                 echo "Commit the device label on ${!dev}"
2042                 do_facet $facet "sync; sleep 1; sync"
2043         fi
2044
2045
2046         label=$(devicelabel ${facet} $dm_dev)
2047         [ -z "$label" ] && echo no label for $dm_dev && exit 1
2048         eval export ${facet}_svc=${label}
2049         echo Started ${label}
2050
2051         export_dm_dev $facet $dm_dev
2052
2053         return $RC
2054 }
2055
2056 # start facet device options
2057 start() {
2058         local facet=$1
2059         shift
2060         local device=$1
2061         shift
2062         local dev_alias=$(facet_device_alias $facet)
2063
2064         eval export ${dev_alias}_dev=${device}
2065         eval export ${facet}_opt=\"$@\"
2066
2067         local varname=${dev_alias}failover_dev
2068         if [ -n "${!varname}" ] ; then
2069                 eval export ${dev_alias}failover_dev=${!varname}
2070         else
2071                 eval export ${dev_alias}failover_dev=$device
2072         fi
2073
2074         local mntpt=$(facet_mntpt $facet)
2075         do_facet ${facet} mkdir -p $mntpt
2076         eval export ${facet}_MOUNT=$mntpt
2077         mount_facet ${facet}
2078         RC=$?
2079
2080         return $RC
2081 }
2082
2083 stop() {
2084         local running
2085         local facet=$1
2086         shift
2087         local HOST=$(facet_active_host $facet)
2088         [[ -z $HOST ]] && echo stop: no host for $facet && return 0
2089
2090         local mntpt=$(facet_mntpt $facet)
2091         running=$(do_facet ${facet} "grep -c $mntpt' ' /proc/mounts || true")
2092         if [ ${running} -ne 0 ]; then
2093                 echo "Stopping $mntpt (opts:$@) on $HOST"
2094                 do_facet ${facet} $UMOUNT $@ $mntpt
2095         fi
2096
2097         # umount should block, but we should wait for unrelated obd's
2098         # like the MGS or MGC to also stop.
2099         wait_exit_ST ${facet} || return ${PIPESTATUS[0]}
2100
2101         if [[ $(facet_fstype $facet) == zfs ]]; then
2102                 # export ZFS storage pool
2103                 [ "$KEEP_ZPOOL" = "true" ] || export_zpool $facet
2104         elif dm_flakey_supported $facet; then
2105                 local host=${facet}_HOST
2106                 local failover_host=${facet}failover_HOST
2107                 if [[ -n ${!failover_host} && ${!failover_host} != ${!host} ]]||
2108                         $CLEANUP_DM_DEV || [[ $facet = fs* ]]; then
2109                         dm_cleanup_dev $facet
2110                 fi
2111         fi
2112 }
2113
2114 # get mdt quota type
2115 mdt_quota_type() {
2116         local varsvc=${SINGLEMDS}_svc
2117         do_facet $SINGLEMDS $LCTL get_param -n \
2118                 osd-$(facet_fstype $SINGLEMDS).${!varsvc}.quota_slave.enabled
2119 }
2120
2121 # get ost quota type
2122 ost_quota_type() {
2123         # All OSTs should have same quota type
2124         local varsvc=ost1_svc
2125         do_facet ost1 $LCTL get_param -n \
2126                 osd-$(facet_fstype ost1).${!varsvc}.quota_slave.enabled
2127 }
2128
2129 # restore old quota type settings
2130 restore_quota() {
2131         if [ "$old_MDT_QUOTA_TYPE" ]; then
2132                 if [[ $PERM_CMD == *"set_param -P"* ]]; then
2133                         do_facet mgs $PERM_CMD \
2134                                 osd-*.$FSNAME-MDT*.quota_slave.enable = \
2135                                 $old_MDT_QUOTA_TYPE
2136                 else
2137                         do_facet mgs $PERM_CMD \
2138                                 $FSNAME.quota.mdt=$old_MDT_QUOTA_TYPE
2139                 fi
2140         fi
2141         if [ "$old_OST_QUOTA_TYPE" ]; then
2142                 if [[ $PERM_CMD == *"set_param -P"* ]]; then
2143                         do_facet mgs $PERM_CMD \
2144                                 osd-*.$FSNAME-OST*.quota_slave.enable = \
2145                                 $old_OST_QUOTA_TYPE
2146                 else
2147                         do_facet mgs $LCTL conf_param \
2148                                 $FSNAME.quota.ost=$old_OST_QUOTA_TYPE
2149                 fi
2150         fi
2151 }
2152
2153 # Handle the case when there is a space in the lfs df
2154 # "filesystem summary" line the same as when there is no space.
2155 # This will allow fixing the "lfs df" summary line in the future.
2156 lfs_df() {
2157         $LFS df $* | sed -e 's/filesystem /filesystem_/'
2158 }
2159
2160 # Get free inodes on the MDT specified by mdt index, free indoes on
2161 # the whole filesystem will be returned when index == -1.
2162 mdt_free_inodes() {
2163         local index=$1
2164         local free_inodes
2165         local mdt_uuid
2166
2167         if [ $index -eq -1 ]; then
2168                 mdt_uuid="summary"
2169         else
2170                 mdt_uuid=$(mdtuuid_from_index $index)
2171         fi
2172
2173         free_inodes=$(lfs_df -i $MOUNT | grep $mdt_uuid | awk '{print $4}')
2174         echo $free_inodes
2175 }
2176
2177 #
2178 # Get the OST device status from 'lfs df' with a given OST index.
2179 #
2180 ost_dev_status() {
2181         local ost_idx=$1
2182         local mnt_pnt=${2:-$MOUNT}
2183         local ost_uuid
2184
2185         ost_uuid=$(ostuuid_from_index $ost_idx $mnt_pnt)
2186         lfs_df $mnt_pnt | awk '/'$ost_uuid'/ { print $7 }'
2187 }
2188
2189 setup_quota(){
2190         local mntpt=$1
2191
2192         # save old quota type & set new quota type
2193         local mdt_qtype=$(mdt_quota_type)
2194         local ost_qtype=$(ost_quota_type)
2195
2196         echo "[HOST:$HOSTNAME] [old_mdt_qtype:$mdt_qtype]" \
2197                 "[old_ost_qtype:$ost_qtype] [new_qtype:$QUOTA_TYPE]"
2198
2199         export old_MDT_QUOTA_TYPE=$mdt_qtype
2200         export old_OST_QUOTA_TYPE=$ost_qtype
2201
2202         if [[ $PERM_CMD == *"set_param -P"* ]]; then
2203                 do_facet mgs $PERM_CMD \
2204                         osd-*.$FSNAME-MDT*.quota_slave.enable=$QUOTA_TYPE
2205                 do_facet mgs $PERM_CMD \
2206                         osd-*.$FSNAME-OST*.quota_slave.enable=$QUOTA_TYPE
2207         else
2208                 do_facet mgs $PERM_CMD $FSNAME.quota.mdt=$QUOTA_TYPE ||
2209                         error "set mdt quota type failed"
2210                 do_facet mgs $PERM_CMD $FSNAME.quota.ost=$QUOTA_TYPE ||
2211                         error "set ost quota type failed"
2212         fi
2213
2214         local quota_usrs=$QUOTA_USERS
2215
2216         # get_filesystem_size
2217         local disksz=$(lfs_df $mntpt | grep "summary" | awk '{print $2}')
2218         local blk_soft=$((disksz + 1024))
2219         local blk_hard=$((blk_soft + blk_soft / 20)) # Go 5% over
2220
2221         local inodes=$(lfs_df -i $mntpt | grep "summary" | awk '{print $2}')
2222         local i_soft=$inodes
2223         local i_hard=$((i_soft + i_soft / 20))
2224
2225         echo "Total disk size: $disksz  block-softlimit: $blk_soft" \
2226                 "block-hardlimit: $blk_hard inode-softlimit: $i_soft" \
2227                 "inode-hardlimit: $i_hard"
2228
2229         local cmd
2230         for usr in $quota_usrs; do
2231                 echo "Setting up quota on $HOSTNAME:$mntpt for $usr..."
2232                 for type in u g; do
2233                         cmd="$LFS setquota -$type $usr -b $blk_soft"
2234                         cmd="$cmd -B $blk_hard -i $i_soft -I $i_hard $mntpt"
2235                         echo "+ $cmd"
2236                         eval $cmd || error "$cmd FAILED!"
2237                 done
2238                 # display the quota status
2239                 echo "Quota settings for $usr : "
2240                 $LFS quota -v -u $usr $mntpt || true
2241         done
2242 }
2243
2244 zconf_mount() {
2245         local client=$1
2246         local mnt=$2
2247         local opts=${3:-$MOUNT_OPTS}
2248         opts=${opts:+-o $opts}
2249         local flags=${4:-$MOUNT_FLAGS}
2250
2251         local device=$MGSNID:/$FSNAME$FILESET
2252         if [ -z "$mnt" -o -z "$FSNAME" ]; then
2253                 echo "Bad mount command: opt=$flags $opts dev=$device " \
2254                      "mnt=$mnt"
2255                 exit 1
2256         fi
2257
2258         echo "Starting client: $client: $flags $opts $device $mnt"
2259         do_node $client mkdir -p $mnt
2260         if [ -n "$FILESET" -a -z "$SKIP_FILESET" ];then
2261                 do_node $client $MOUNT_CMD $flags $opts $MGSNID:/$FSNAME \
2262                         $mnt || return 1
2263                 #disable FILESET if not supported
2264                 do_nodes $client lctl get_param -n \
2265                         mdc.$FSNAME-MDT0000*.import | grep -q subtree ||
2266                                 device=$MGSNID:/$FSNAME
2267                 do_node $client mkdir -p $mnt/$FILESET
2268                 do_node $client "! grep -q $mnt' ' /proc/mounts ||
2269                         umount $mnt"
2270         fi
2271         if $GSS_SK && ($SK_UNIQUE_NM || $SK_S2S); then
2272                 # Mount using nodemap key
2273                 local mountkey=$SK_PATH/$FSNAME-nmclient.key
2274                 if $SK_UNIQUE_NM; then
2275                         mountkey=$SK_PATH/nodemap/c0.key
2276                 fi
2277                 local prunedopts=$(echo $opts |
2278                                 sed -e "s#skpath=[^,^ ]*#skpath=$mountkey#g")
2279                 do_node $client $MOUNT_CMD $flags $prunedopts $device $mnt ||
2280                                 return 1
2281         else
2282                 do_node $client $MOUNT_CMD $flags $opts $device $mnt ||
2283                                 return 1
2284         fi
2285
2286         set_default_debug_nodes $client
2287
2288         return 0
2289 }
2290
2291 zconf_umount() {
2292         local client=$1
2293         local mnt=$2
2294         local force
2295         local busy
2296         local need_kill
2297         local running=$(do_node $client "grep -c $mnt' ' /proc/mounts") || true
2298
2299         [ "$3" ] && force=-f
2300         [ $running -eq 0 ] && return 0
2301
2302         echo "Stopping client $client $mnt (opts:$force)"
2303         do_node $client lsof -t $mnt || need_kill=no
2304         if [ "x$force" != "x" ] && [ "x$need_kill" != "xno" ]; then
2305                 pids=$(do_node $client lsof -t $mnt | sort -u);
2306                 if [ -n "$pids" ]; then
2307                         do_node $client kill -9 $pids || true
2308                 fi
2309         fi
2310
2311         busy=$(do_node $client "umount $force $mnt 2>&1" | grep -c "busy") ||
2312                 true
2313         if [ $busy -ne 0 ] ; then
2314                 echo "$mnt is still busy, wait one second" && sleep 1
2315                 do_node $client umount $force $mnt
2316         fi
2317 }
2318
2319 # Mount the file system on the MGS
2320 mount_mgs_client() {
2321         do_facet mgs "mkdir -p $MOUNT"
2322         zconf_mount $mgs_HOST $MOUNT $MOUNT_OPTS ||
2323                 error "unable to mount $MOUNT on MGS"
2324 }
2325
2326 # Unmount the file system on the MGS
2327 umount_mgs_client() {
2328         zconf_umount $mgs_HOST $MOUNT
2329         do_facet mgs "rm -rf $MOUNT"
2330 }
2331
2332 # nodes is comma list
2333 sanity_mount_check_nodes () {
2334     local nodes=$1
2335     shift
2336     local mnts="$@"
2337     local mnt
2338
2339     # FIXME: assume that all cluster nodes run the same os
2340     [ "$(uname)" = Linux ] || return 0
2341
2342     local rc=0
2343     for mnt in $mnts ; do
2344         do_nodes $nodes "running=\\\$(grep -c $mnt' ' /proc/mounts);
2345 mpts=\\\$(mount | grep -c $mnt' ');
2346 if [ \\\$running -ne \\\$mpts ]; then
2347     echo \\\$(hostname) env are INSANE!;
2348     exit 1;
2349 fi"
2350     [ $? -eq 0 ] || rc=1
2351     done
2352     return $rc
2353 }
2354
2355 sanity_mount_check_servers () {
2356     [ -n "$CLIENTONLY" ] &&
2357         { echo "CLIENTONLY mode, skip mount_check_servers"; return 0; } || true
2358     echo Checking servers environments
2359
2360     # FIXME: modify get_facets to display all facets wo params
2361     local facets="$(get_facets OST),$(get_facets MDS),mgs"
2362     local node
2363     local mntpt
2364     local facet
2365     for facet in ${facets//,/ }; do
2366         node=$(facet_host ${facet})
2367         mntpt=$(facet_mntpt $facet)
2368         sanity_mount_check_nodes $node $mntpt ||
2369             { error "server $node environments are insane!"; return 1; }
2370     done
2371 }
2372
2373 sanity_mount_check_clients () {
2374     local clients=${1:-$CLIENTS}
2375     local mntpt=${2:-$MOUNT}
2376     local mntpt2=${3:-$MOUNT2}
2377
2378     [ -z $clients ] && clients=$(hostname)
2379     echo Checking clients $clients environments
2380
2381     sanity_mount_check_nodes $clients $mntpt $mntpt2 ||
2382        error "clients environments are insane!"
2383 }
2384
2385 sanity_mount_check () {
2386     sanity_mount_check_servers || return 1
2387     sanity_mount_check_clients || return 2
2388 }
2389
2390 # mount clients if not mouted
2391 zconf_mount_clients() {
2392         local clients=$1
2393         local mnt=$2
2394         local opts=${3:-$MOUNT_OPTS}
2395         opts=${opts:+-o $opts}
2396         local flags=${4:-$MOUNT_FLAGS}
2397         local device=$MGSNID:/$FSNAME$FILESET
2398         if [ -z "$mnt" -o -z "$FSNAME" ]; then
2399                 echo "Bad conf mount command: opt=$flags $opts dev=$device " \
2400                      "mnt=$mnt"
2401                 exit 1
2402         fi
2403
2404         echo "Starting client $clients: $flags $opts $device $mnt"
2405         do_nodes $clients mkdir -p $mnt
2406         if [ -n "$FILESET" -a -z "$SKIP_FILESET" ]; then
2407                 if $GSS_SK && ($SK_UNIQUE_NM || $SK_S2S); then
2408                         # Mount with own nodemap key
2409                         local i=0
2410                         # Mount all server nodes first with per-NM keys
2411                         for nmclient in ${clients//,/ }; do
2412 #                               do_nodes $(comma_list $(all_server_nodes)) "lgss_sk -t server -l $SK_PATH/nodemap/c$i.key -n c$i"
2413                                 do_nodes $(comma_list $(all_server_nodes)) "lgss_sk -t server -l $SK_PATH/nodemap/c$i.key"
2414                                 i=$((i + 1))
2415                         done
2416                         # set perms for per-nodemap keys else permission denied
2417                         do_nodes $(comma_list $(all_nodes)) \
2418                                 "keyctl show | grep lustre | cut -c1-11 |
2419                                 sed -e 's/ //g;' |
2420                                 xargs -IX keyctl setperm X 0x3f3f3f3f"
2421                         local mountkey=$SK_PATH/$FSNAME-nmclient.key
2422                         i=0
2423                         for nmclient in ${clients//,/ }; do
2424                                 if $SK_UNIQUE_NM; then
2425                                         mountkey=$SK_PATH/nodemap/c$i.key
2426                                 fi
2427                                 do_node $nmclient "! grep -q $mnt' ' \
2428                                         /proc/mounts || umount $mnt"
2429                                 local prunedopts=$(add_sk_mntflag $prunedopts);
2430                                 prunedopts=$(echo $prunedopts | sed -e \
2431                                         "s#skpath=[^ ^,]*#skpath=$mountkey#g")
2432                                 set -x
2433                                 do_nodes $(comma_list $(all_server_nodes)) \
2434                                         "keyctl show"
2435                                 set +x
2436                                 do_node $nmclient $MOUNT_CMD $flags \
2437                                         $prunedopts $MGSNID:/$FSNAME $mnt ||
2438                                         return 1
2439                                 i=$((i + 1))
2440                         done
2441                 else
2442                         do_nodes $clients "! grep -q $mnt' ' /proc/mounts ||
2443                                         umount $mnt"
2444                         do_nodes $clients $MOUNT_CMD $flags $opts \
2445                                         $MGSNID:/$FSNAME $mnt || return 1
2446                 fi
2447                 #disable FILESET if not supported
2448                 do_nodes $clients lctl get_param -n \
2449                         mdc.$FSNAME-MDT0000*.import | grep -q subtree ||
2450                                 device=$MGSNID:/$FSNAME
2451                 do_nodes $clients mkdir -p $mnt/$FILESET
2452                 do_nodes $clients "! grep -q $mnt' ' /proc/mounts ||
2453                         umount $mnt"
2454         fi
2455
2456         if $GSS_SK && ($SK_UNIQUE_NM || $SK_S2S); then
2457                 # Mount with nodemap key
2458                 local i=0
2459                 local mountkey=$SK_PATH/$FSNAME-nmclient.key
2460                 for nmclient in ${clients//,/ }; do
2461                         if $SK_UNIQUE_NM; then
2462                                 mountkey=$SK_PATH/nodemap/c$i.key
2463                         fi
2464                         local prunedopts=$(echo $opts | sed -e \
2465                                 "s#skpath=[^ ^,]*#skpath=$mountkey#g");
2466                         do_node $nmclient "! grep -q $mnt' ' /proc/mounts ||
2467                                 umount $mnt"
2468                         do_node $nmclient "
2469                 running=\\\$(mount | grep -c $mnt' ');
2470                 rc=0;
2471                 if [ \\\$running -eq 0 ] ; then
2472                         mkdir -p $mnt;
2473                         $MOUNT_CMD $flags $prunedopts $device $mnt;
2474                         rc=\\\$?;
2475                 else
2476                         lustre_mnt_count=\\\$(mount | grep $mnt' ' | \
2477                                 grep 'type lustre' | wc -l);
2478                         if [ \\\$running -ne \\\$lustre_mnt_count ] ; then
2479                                 echo zconf_mount_clients FAILED: \
2480                                         mount count \\\$running, not matching \
2481                                         with mount count of 'type lustre' \
2482                                         \\\$lustre_mnt_count;
2483                                 rc=1;
2484                         fi;
2485                 fi;
2486         exit \\\$rc" || return ${PIPESTATUS[0]}
2487
2488                         i=$((i + 1))
2489                 done
2490         else
2491
2492                 local tmpopts=$opts
2493                 if $SHARED_KEY; then
2494                         tmpopts=$(add_sk_mntflag $opts)
2495                 fi
2496                 do_nodes $clients "
2497 running=\\\$(mount | grep -c $mnt' ');
2498 rc=0;
2499 if [ \\\$running -eq 0 ] ; then
2500         mkdir -p $mnt;
2501         $MOUNT_CMD $flags $tmpopts $device $mnt;
2502         rc=\\\$?;
2503 fi;
2504 exit \\\$rc" || return ${PIPESTATUS[0]}
2505         fi
2506
2507         echo "Started clients $clients: "
2508         do_nodes $clients "mount | grep $mnt' '"
2509
2510         set_default_debug_nodes $clients
2511
2512         return 0
2513 }
2514
2515 zconf_umount_clients() {
2516     local clients=$1
2517     local mnt=$2
2518     local force
2519
2520     [ "$3" ] && force=-f
2521
2522     echo "Stopping clients: $clients $mnt (opts:$force)"
2523     do_nodes $clients "running=\\\$(grep -c $mnt' ' /proc/mounts);
2524 if [ \\\$running -ne 0 ] ; then
2525 echo Stopping client \\\$(hostname) $mnt opts:$force;
2526 lsof $mnt || need_kill=no;
2527 if [ "x$force" != "x" -a "x\\\$need_kill" != "xno" ]; then
2528     pids=\\\$(lsof -t $mnt | sort -u);
2529     if [ -n \\\"\\\$pids\\\" ]; then
2530              kill -9 \\\$pids;
2531     fi
2532 fi;
2533 while umount $force $mnt 2>&1 | grep -q "busy"; do
2534     echo "$mnt is still busy, wait one second" && sleep 1;
2535 done;
2536 fi"
2537 }
2538
2539 shutdown_node () {
2540     local node=$1
2541     echo + $POWER_DOWN $node
2542     $POWER_DOWN $node
2543 }
2544
2545 shutdown_node_hard () {
2546     local host=$1
2547     local attempts=$SHUTDOWN_ATTEMPTS
2548
2549     for i in $(seq $attempts) ; do
2550         shutdown_node $host
2551         sleep 1
2552         wait_for_function --quiet "! ping -w 3 -c 1 $host" 5 1 && return 0
2553         echo "waiting for $host to fail attempts=$attempts"
2554         [ $i -lt $attempts ] || \
2555             { echo "$host still pingable after power down! attempts=$attempts" && return 1; }
2556     done
2557 }
2558
2559 shutdown_client() {
2560     local client=$1
2561     local mnt=${2:-$MOUNT}
2562     local attempts=3
2563
2564     if [ "$FAILURE_MODE" = HARD ]; then
2565         shutdown_node_hard $client
2566     else
2567        zconf_umount_clients $client $mnt -f
2568     fi
2569 }
2570
2571 facets_on_host () {
2572     local host=$1
2573     local facets="$(get_facets OST),$(get_facets MDS)"
2574     local affected
2575
2576     combined_mgs_mds || facets="$facets,mgs"
2577
2578     for facet in ${facets//,/ }; do
2579         if [ $(facet_active_host $facet) == $host ]; then
2580            affected="$affected $facet"
2581         fi
2582     done
2583
2584     echo $(comma_list $affected)
2585 }
2586
2587 facet_up() {
2588         local facet=$1
2589         local host=${2:-$(facet_host $facet)}
2590
2591         local label=$(convert_facet2label $facet)
2592         do_node $host $LCTL dl | awk '{ print $4 }' | grep -q "^$label\$"
2593 }
2594
2595 facets_up_on_host () {
2596     local host=$1
2597     local facets=$(facets_on_host $host)
2598     local affected_up
2599
2600     for facet in ${facets//,/ }; do
2601         if $(facet_up $facet $host); then
2602             affected_up="$affected_up $facet"
2603         fi
2604     done
2605
2606     echo $(comma_list $affected_up)
2607 }
2608
2609 shutdown_facet() {
2610         local facet=$1
2611         local affected_facet
2612         local affected_facets
2613
2614         if [[ "$FAILURE_MODE" = HARD ]]; then
2615                 if [[ $(facet_fstype $facet) = ldiskfs ]] &&
2616                         dm_flakey_supported $facet; then
2617                         affected_facets=$(affected_facets $facet)
2618                         for affected_facet in ${affected_facets//,/ }; do
2619                                 unexport_dm_dev $affected_facet
2620                         done
2621                 fi
2622
2623                 shutdown_node_hard $(facet_active_host $facet)
2624         else
2625                 stop $facet
2626         fi
2627 }
2628
2629 reboot_node() {
2630     local node=$1
2631     echo + $POWER_UP $node
2632     $POWER_UP $node
2633 }
2634
2635 remount_facet() {
2636     local facet=$1
2637
2638     stop $facet
2639     mount_facet $facet
2640 }
2641
2642 reboot_facet() {
2643         local facet=$1
2644         if [ "$FAILURE_MODE" = HARD ]; then
2645                 reboot_node $(facet_active_host $facet)
2646         else
2647                 sleep 10
2648         fi
2649 }
2650
2651 boot_node() {
2652     local node=$1
2653     if [ "$FAILURE_MODE" = HARD ]; then
2654        reboot_node $node
2655        wait_for_host $node
2656     fi
2657 }
2658
2659 facets_hosts () {
2660     local facets=$1
2661     local hosts
2662
2663     for facet in ${facets//,/ }; do
2664         hosts=$(expand_list $hosts $(facet_host $facet) )
2665     done
2666
2667     echo $hosts
2668 }
2669
2670 _check_progs_installed () {
2671     local progs=$@
2672     local rc=0
2673
2674     for prog in $progs; do
2675         if ! [ "$(which $prog)"  -o  "${!prog}" ]; then
2676            echo $prog missing on $(hostname)
2677            rc=1
2678         fi
2679     done
2680     return $rc
2681 }
2682
2683 check_progs_installed () {
2684         local nodes=$1
2685         shift
2686
2687         do_rpc_nodes "$nodes" _check_progs_installed $@
2688 }
2689
2690 # recovery-scale functions
2691 node_var_name() {
2692     echo __$(echo $1 | tr '-' '_' | tr '.' '_')
2693 }
2694
2695 start_client_load() {
2696         local client=$1
2697         local load=$2
2698         local var=$(node_var_name $client)_load
2699         eval export ${var}=$load
2700
2701         do_node $client "PATH=$PATH MOUNT=$MOUNT ERRORS_OK=$ERRORS_OK \
2702                         BREAK_ON_ERROR=$BREAK_ON_ERROR \
2703                         END_RUN_FILE=$END_RUN_FILE \
2704                         LOAD_PID_FILE=$LOAD_PID_FILE \
2705                         TESTLOG_PREFIX=$TESTLOG_PREFIX \
2706                         TESTNAME=$TESTNAME \
2707                         DBENCH_LIB=$DBENCH_LIB \
2708                         DBENCH_SRC=$DBENCH_SRC \
2709                         CLIENT_COUNT=$((CLIENTCOUNT - 1)) \
2710                         LFS=$LFS \
2711                         LCTL=$LCTL \
2712                         FSNAME=$FSNAME \
2713                         MPIRUN=$MPIRUN \
2714                         MPIRUN_OPTIONS=\\\"$MPIRUN_OPTIONS\\\" \
2715                         MACHINEFILE_OPTION=\\\"$MACHINEFILE_OPTION\\\" \
2716                         num_clients=$(get_node_count ${CLIENTS//,/ }) \
2717                         ior_THREADS=$ior_THREADS ior_iteration=$ior_iteration \
2718                         ior_blockSize=$ior_blockSize \
2719                         ior_blockUnit=$ior_blockUnit \
2720                         ior_xferSize=$ior_xferSize ior_type=$ior_type \
2721                         ior_DURATION=$ior_DURATION \
2722                         ior_stripe_params=\\\"$ior_stripe_params\\\" \
2723                         ior_custom_params=\\\"$ior_custom_param\\\" \
2724                         mpi_ior_custom_threads=$mpi_ior_custom_threads \
2725                         run_${load}.sh" &
2726         local ppid=$!
2727         log "Started client load: ${load} on $client"
2728
2729         # get the children process IDs
2730         local pids=$(ps --ppid $ppid -o pid= | xargs)
2731         CLIENT_LOAD_PIDS="$CLIENT_LOAD_PIDS $ppid $pids"
2732         return 0
2733 }
2734
2735 start_client_loads () {
2736     local -a clients=(${1//,/ })
2737     local numloads=${#CLIENT_LOADS[@]}
2738     local testnum
2739
2740     for ((nodenum=0; nodenum < ${#clients[@]}; nodenum++ )); do
2741         testnum=$((nodenum % numloads))
2742         start_client_load ${clients[nodenum]} ${CLIENT_LOADS[testnum]}
2743     done
2744     # bug 22169: wait the background threads to start
2745     sleep 2
2746 }
2747
2748 # only for remote client
2749 check_client_load () {
2750         local client=$1
2751         local var=$(node_var_name $client)_load
2752         local testload=run_${!var}.sh
2753
2754         ps auxww | grep -v grep | grep $client | grep -q $testload || return 1
2755
2756         # bug 18914: try to connect several times not only when
2757         # check ps, but  while check_node_health also
2758
2759         local tries=3
2760         local RC=254
2761         while [ $RC = 254 -a $tries -gt 0 ]; do
2762                 let tries=$tries-1
2763                 # assume success
2764                 RC=0
2765                 if ! check_node_health $client; then
2766                         RC=${PIPESTATUS[0]}
2767                         if [ $RC -eq 254 ]; then
2768                                 # FIXME: not sure how long we shuold sleep here
2769                                 sleep 10
2770                                 continue
2771                         fi
2772                         echo "check node health failed: RC=$RC "
2773                         return $RC
2774                 fi
2775         done
2776         # We can continue try to connect if RC=254
2777         # Just print the warning about this
2778         if [ $RC = 254 ]; then
2779                 echo "got a return status of $RC from do_node while checking " \
2780                 "node health on $client"
2781         fi
2782
2783         # see if the load is still on the client
2784         tries=3
2785         RC=254
2786         while [ $RC = 254 -a $tries -gt 0 ]; do
2787                 let tries=$tries-1
2788                 # assume success
2789                 RC=0
2790                 if ! do_node $client \
2791                         "ps auxwww | grep -v grep | grep -q $testload"; then
2792                         RC=${PIPESTATUS[0]}
2793                         sleep 30
2794                 fi
2795         done
2796         if [ $RC = 254 ]; then
2797                 echo "got a return status of $RC from do_node while checking " \
2798                 "(node health and 'ps') the client load on $client"
2799                 # see if we can diagnose a bit why this is
2800         fi
2801
2802         return $RC
2803 }
2804 check_client_loads () {
2805    local clients=${1//,/ }
2806    local client=
2807    local rc=0
2808
2809    for client in $clients; do
2810       check_client_load $client
2811       rc=${PIPESTATUS[0]}
2812       if [ "$rc" != 0 ]; then
2813         log "Client load failed on node $client, rc=$rc"
2814         return $rc
2815       fi
2816    done
2817 }
2818
2819 restart_client_loads () {
2820     local clients=${1//,/ }
2821     local expectedfail=${2:-""}
2822     local client=
2823     local rc=0
2824
2825     for client in $clients; do
2826         check_client_load $client
2827         rc=${PIPESTATUS[0]}
2828         if [ "$rc" != 0 -a "$expectedfail" ]; then
2829             local var=$(node_var_name $client)_load
2830             start_client_load $client ${!var}
2831             echo "Restarted client load ${!var}: on $client. Checking ..."
2832             check_client_load $client
2833             rc=${PIPESTATUS[0]}
2834             if [ "$rc" != 0 ]; then
2835                 log "Client load failed to restart on node $client, rc=$rc"
2836                 # failure one client load means test fail
2837                 # we do not need to check other
2838                 return $rc
2839             fi
2840         else
2841             return $rc
2842         fi
2843     done
2844 }
2845
2846 # Start vmstat and save its process ID in a file.
2847 start_vmstat() {
2848     local nodes=$1
2849     local pid_file=$2
2850
2851     [ -z "$nodes" -o -z "$pid_file" ] && return 0
2852
2853     do_nodes $nodes \
2854         "vmstat 1 > $TESTLOG_PREFIX.$TESTNAME.vmstat.\\\$(hostname -s).log \
2855         2>/dev/null </dev/null & echo \\\$! > $pid_file"
2856 }
2857
2858 # Display the nodes on which client loads failed.
2859 print_end_run_file() {
2860     local file=$1
2861     local node
2862
2863     [ -s $file ] || return 0
2864
2865     echo "Found the END_RUN_FILE file: $file"
2866     cat $file
2867
2868     # A client load will stop if it finds the END_RUN_FILE file.
2869     # That does not mean the client load actually failed though.
2870     # The first node in END_RUN_FILE is the one we are interested in.
2871     read node < $file
2872
2873     if [ -n "$node" ]; then
2874         local var=$(node_var_name $node)_load
2875
2876         local prefix=$TESTLOG_PREFIX
2877         [ -n "$TESTNAME" ] && prefix=$prefix.$TESTNAME
2878         local stdout_log=$prefix.run_${!var}_stdout.$node.log
2879         local debug_log=$(echo $stdout_log | sed 's/\(.*\)stdout/\1debug/')
2880
2881         echo "Client load ${!var} failed on node $node:"
2882         echo "$stdout_log"
2883         echo "$debug_log"
2884     fi
2885 }
2886
2887 # Stop the process which had its PID saved in a file.
2888 stop_process() {
2889     local nodes=$1
2890     local pid_file=$2
2891
2892     [ -z "$nodes" -o -z "$pid_file" ] && return 0
2893
2894     do_nodes $nodes "test -f $pid_file &&
2895         { kill -s TERM \\\$(cat $pid_file); rm -f $pid_file; }" || true
2896 }
2897
2898 # Stop all client loads.
2899 stop_client_loads() {
2900     local nodes=${1:-$CLIENTS}
2901     local pid_file=$2
2902
2903     # stop the client loads
2904     stop_process $nodes $pid_file
2905
2906     # clean up the processes that started them
2907     [ -n "$CLIENT_LOAD_PIDS" ] && kill -9 $CLIENT_LOAD_PIDS 2>/dev/null || true
2908 }
2909 # End recovery-scale functions
2910
2911 # verify that lustre actually cleaned up properly
2912 cleanup_check() {
2913         VAR=$(lctl get_param -n catastrophe 2>&1)
2914         if [ $? = 0 ] ; then
2915                 if [ $VAR != 0 ]; then
2916                         error "LBUG/LASSERT detected"
2917                 fi
2918         fi
2919         BUSY=$(dmesg | grep -i destruct || true)
2920         if [ -n "$BUSY" ]; then
2921                 echo "$BUSY" 1>&2
2922                 [ -e $TMP/debug ] && mv $TMP/debug $TMP/debug-busy.$(date +%s)
2923                 exit 205
2924         fi
2925
2926         check_mem_leak || exit 204
2927
2928         [[ $($LCTL dl 2>/dev/null | wc -l) -gt 0 ]] && $LCTL dl &&
2929                 echo "$TESTSUITE: lustre didn't clean up..." 1>&2 &&
2930                 return 202 || true
2931
2932         if module_loaded lnet || module_loaded libcfs; then
2933                 echo "$TESTSUITE: modules still loaded..." 1>&2
2934                 /sbin/lsmod 1>&2
2935                 return 203
2936         fi
2937         return 0
2938 }
2939
2940 wait_update () {
2941         local verbose=false
2942         if [[ "$1" == "--verbose" ]]; then
2943                 shift
2944                 verbose=true
2945         fi
2946
2947         local node=$1
2948         local TEST=$2
2949         local FINAL=$3
2950         local MAX=${4:-90}
2951         local RESULT
2952         local PREV_RESULT
2953         local WAIT=0
2954         local sleep=1
2955         local print=10
2956
2957         PREV_RESULT=$(do_node $node "$TEST")
2958         while [ true ]; do
2959                 RESULT=$(do_node $node "$TEST")
2960                 if [[ "$RESULT" == "$FINAL" ]]; then
2961                         [[ -z "$RESULT" || $WAIT -le $sleep ]] ||
2962                                 echo "Updated after ${WAIT}s: wanted '$FINAL'"\
2963                                      "got '$RESULT'"
2964                         return 0
2965                 fi
2966                 if [[ $verbose && "$RESULT" != "$PREV_RESULT" ]]; then
2967                         echo "Changed after ${WAIT}s: from '$PREV_RESULT'"\
2968                              "to '$RESULT'"
2969                         PREV_RESULT=$RESULT
2970                 fi
2971                 [[ $WAIT -ge $MAX ]] && break
2972                 [[ $((WAIT % print)) -eq 0 ]] &&
2973                         echo "Waiting $((MAX - WAIT)) secs for update"
2974                 WAIT=$((WAIT + sleep))
2975                 sleep $sleep
2976         done
2977         echo "Update not seen after ${MAX}s: wanted '$FINAL' got '$RESULT'"
2978         return 3
2979 }
2980
2981 wait_update_facet() {
2982         local verbose=
2983         [ "$1" = "--verbose" ] && verbose="$1" && shift
2984
2985         local facet=$1
2986         shift
2987         wait_update $verbose $(facet_active_host $facet) "$@"
2988 }
2989
2990 sync_all_data() {
2991         do_nodes $(comma_list $(mdts_nodes)) \
2992             "lctl set_param -n os[cd]*.*MDT*.force_sync=1"
2993         do_nodes $(comma_list $(osts_nodes)) \
2994             "lctl set_param -n osd*.*OS*.force_sync=1" 2>&1 |
2995                 grep -v 'Found no match'
2996 }
2997
2998 wait_zfs_commit() {
2999         local zfs_wait=${2:-5}
3000
3001         # the occupied disk space will be released
3002         # only after TXGs are committed
3003         if [[ $(facet_fstype $1) == zfs ]]; then
3004                 echo "sleep $zfs_wait for ZFS $(facet_fstype $1)"
3005                 sleep $zfs_wait
3006         fi
3007 }
3008
3009 fill_ost() {
3010         local filename=$1
3011         local ost_idx=$2
3012         local lwm=$3  #low watermark
3013         local size_mb #how many MB should we write to pass watermark
3014         local ost_name=$(ostname_from_index $ost_idx)
3015
3016         free_kb=$($LFS df $MOUNT | awk "/$ost_name/ { print \$4 }")
3017         size_mb=0
3018         if (( $free_kb / 1024 > lwm )); then
3019                 size_mb=$((free_kb / 1024 - lwm))
3020         fi
3021         #If 10% of free space cross low watermark use it
3022         if (( $free_kb / 10240 > size_mb )); then
3023                 size_mb=$((free_kb / 10240))
3024         else
3025                 #At least we need to store 1.1 of difference between
3026                 #free space and low watermark
3027                 size_mb=$((size_mb + size_mb / 10))
3028         fi
3029         if (( lwm <= $free_kb / 1024 )) ||
3030            [ ! -f $DIR/${filename}.fill_ost$ost_idx ]; then
3031                 $LFS setstripe -i $ost_idx -c1 $DIR/${filename}.fill_ost$ost_idx
3032                 dd if=/dev/zero of=$DIR/${filename}.fill_ost$ost_idx bs=1M \
3033                         count=$size_mb oflag=append conv=notrunc
3034         fi
3035
3036         sleep_maxage
3037
3038         free_kb=$($LFS df $MOUNT | awk "/$ost_name/ { print \$4 }")
3039         echo "OST still has $((free_kb / 1024)) MB free"
3040 }
3041
3042 # This checks only the primary MDS
3043 ost_watermarks_get() {
3044         local ost_idx=$1
3045         local ost_name=$(ostname_from_index $ost_idx)
3046         local mdtosc_proc=$(get_mdtosc_proc_path $SINGLEMDS $ost_name)
3047
3048         local hwm=$(do_facet $SINGLEMDS $LCTL get_param -n \
3049                         osp.$mdtosc_proc.reserved_mb_high)
3050         local lwm=$(do_facet $SINGLEMDS $LCTL get_param -n \
3051                         osp.$mdtosc_proc.reserved_mb_low)
3052
3053         echo "$lwm $hwm"
3054 }
3055
3056 # Note that we set watermarks on all MDSes (necessary for striped dirs)
3057 ost_watermarks_set() {
3058         local ost_idx=$1
3059         local lwm=$2
3060         local hwm=$3
3061         local ost_name=$(ostname_from_index $ost_idx)
3062         local facets=$(get_facets MDS)
3063
3064         do_nodes $(comma_list $(mdts_nodes)) $LCTL set_param -n \
3065                 osp.*$ost_name*.reserved_mb_low=$lwm \
3066                 osp.*$ost_name*.reserved_mb_high=$hwm > /dev/null
3067
3068         # sleep to ensure we see the change
3069         sleep_maxage
3070 }
3071
3072 ost_watermarks_set_low_space() {
3073         local ost_idx=$1
3074         local wms=$(ost_watermarks_get $ost_idx)
3075         local ost_name=$(ostname_from_index $ost_idx)
3076
3077         local old_lwm=$(echo $wms | awk '{ print $1 }')
3078         local old_hwm=$(echo $wms | awk '{ print $2 }')
3079
3080         local blocks=$($LFS df $MOUNT | awk "/$ost_name/ { print \$4 }")
3081         # minimal extension size is 64M
3082         local new_lwm=50
3083         if (( $blocks / 1024 > 50 )); then
3084                 new_lwm=$((blocks / 1024 - 50))
3085         fi
3086         local new_hwm=$((new_lwm + 5))
3087
3088         ost_watermarks_set $ost_idx $new_lwm $new_hwm
3089         echo "watermarks: $old_lwm $old_hwm $new_lwm $new_hwm"
3090 }
3091
3092 # Set watermarks to ~current available space & then write data to fill it
3093 # Note OST is not *actually* full after this, it just reports ENOSPC in the
3094 # internal statfs used by the stripe allocator
3095 #
3096 # first parameter is the filename-prefix, which must get under t-f cleanup
3097 # requirements (rm -rf $DIR/[Rdfs][0-9]*), i.e. $tfile work fine
3098 ost_watermarks_set_enospc() {
3099         local filename=$1
3100         local ost_idx=$2
3101         # on the mdt's osc
3102         local ost_name=$(ostname_from_index $ost_idx)
3103         local facets=$(get_facets MDS)
3104         local wms
3105         local MDS
3106
3107         for MDS in ${facets//,/ }; do
3108                 local mdtosc_proc=$(get_mdtosc_proc_path $MDS $ost_name)
3109
3110                 do_facet $MDS $LCTL get_param -n \
3111                         osp.$mdtosc_proc.reserved_mb_high ||
3112                         skip  "remote MDS does not support reserved_mb_high"
3113         done
3114
3115         wms=$(ost_watermarks_set_low_space $ost_idx)
3116         local new_lwm=$(echo $wms | awk '{ print $4 }')
3117         fill_ost $filename $ost_idx $new_lwm
3118         #First enospc could execute orphan deletion so repeat
3119         fill_ost $filename $ost_idx $new_lwm
3120         echo $wms
3121 }
3122
3123 ost_watermarks_enospc_delete_files() {
3124         local filename=$1
3125         local ost_idx=$2
3126
3127         rm -f $DIR/${filename}.fill_ost$ost_idx
3128
3129         wait_delete_completed
3130         wait_mds_ost_sync
3131 }
3132
3133 # clean up from "ost_watermarks_set_enospc"
3134 ost_watermarks_clear_enospc() {
3135         local filename=$1
3136         local ost_idx=$2
3137         local old_lwm=$4
3138         local old_hwm=$5
3139
3140         ost_watermarks_enospc_delete_files $filename $ost_idx
3141         ost_watermarks_set $ost_idx $old_lwm $old_hwm
3142         echo "set OST$ost_idx lwm back to $old_lwm, hwm back to $old_hwm"
3143 }
3144
3145 wait_delete_completed_mds() {
3146         local max_wait=${1:-20}
3147         local mds2sync=""
3148         local stime=$(date +%s)
3149         local etime
3150         local node
3151         local changes
3152
3153         # find MDS with pending deletions
3154         for node in $(mdts_nodes); do
3155                 changes=$(do_node $node "$LCTL get_param -n osc.*MDT*.sync_*" \
3156                         2>/dev/null | calc_sum)
3157                 if [[ $changes -eq 0 ]]; then
3158                         continue
3159                 fi
3160                 mds2sync="$mds2sync $node"
3161         done
3162         if [ -z "$mds2sync" ]; then
3163                 wait_zfs_commit $SINGLEMDS
3164                 return 0
3165         fi
3166         mds2sync=$(comma_list $mds2sync)
3167
3168         # sync MDS transactions
3169         do_nodes $mds2sync "$LCTL set_param -n os[cd]*.*MD*.force_sync 1"
3170
3171         # wait till all changes are sent and commmitted by OSTs
3172         # for ldiskfs space is released upon execution, but DMU
3173         # do this upon commit
3174
3175         local WAIT=0
3176         while [[ $WAIT -ne $max_wait ]]; do
3177                 changes=$(do_nodes $mds2sync \
3178                         "$LCTL get_param -n osc.*MDT*.sync_*" | calc_sum)
3179                 #echo "$node: $changes changes on all"
3180                 if [[ $changes -eq 0 ]]; then
3181                         wait_zfs_commit $SINGLEMDS
3182
3183                         # the occupied disk space will be released
3184                         # only after TXGs are committed
3185                         wait_zfs_commit ost1
3186                         return 0
3187                 fi
3188                 sleep 1
3189                 WAIT=$((WAIT + 1))
3190         done
3191
3192         etime=$(date +%s)
3193         echo "Delete is not completed in $((etime - stime)) seconds"
3194         do_nodes $mds2sync "$LCTL get_param osc.*MDT*.sync_*"
3195         return 1
3196 }
3197
3198 wait_for_host() {
3199     local hostlist=$1
3200
3201     # we can use "for" here because we are waiting the slowest
3202     for host in ${hostlist//,/ }; do
3203         check_network "$host" 900
3204     done
3205     while ! do_nodes $hostlist hostname  > /dev/null; do sleep 5; done
3206 }
3207
3208 wait_for_facet() {
3209     local facetlist=$1
3210     local hostlist
3211
3212     for facet in ${facetlist//,/ }; do
3213         hostlist=$(expand_list $hostlist $(facet_active_host $facet))
3214     done
3215     wait_for_host $hostlist
3216 }
3217
3218 _wait_recovery_complete () {
3219     local param=$1
3220
3221     # Use default policy if $2 is not passed by caller.
3222     local MAX=${2:-$(max_recovery_time)}
3223
3224     local WAIT=0
3225     local STATUS=
3226
3227     while [ $WAIT -lt $MAX ]; do
3228         STATUS=$(lctl get_param -n $param | grep status)
3229         echo $param $STATUS
3230         [[ $STATUS = "status: COMPLETE" || $STATUS = "status: INACTIVE" ]] && return 0
3231         sleep 5
3232         WAIT=$((WAIT + 5))
3233         echo "Waiting $((MAX - WAIT)) secs for $param recovery done. $STATUS"
3234     done
3235     echo "$param recovery not done in $MAX sec. $STATUS"
3236     return 1
3237 }
3238
3239 wait_recovery_complete () {
3240     local facet=$1
3241
3242     # with an assumption that at_max is the same on all nodes
3243     local MAX=${2:-$(max_recovery_time)}
3244
3245     local facets=$facet
3246     if [ "$FAILURE_MODE" = HARD ]; then
3247         facets=$(facets_on_host $(facet_active_host $facet))
3248     fi
3249     echo affected facets: $facets
3250
3251         # we can use "for" here because we are waiting the slowest
3252         for facet in ${facets//,/ }; do
3253                 local var_svc=${facet}_svc
3254                 local param="*.${!var_svc}.recovery_status"
3255
3256                 local host=$(facet_active_host $facet)
3257                 do_rpc_nodes "$host" _wait_recovery_complete $param $MAX
3258         done
3259 }
3260
3261 wait_mds_ost_sync () {
3262         # just because recovery is done doesn't mean we've finished
3263         # orphan cleanup. Wait for llogs to get synchronized.
3264         echo "Waiting for orphan cleanup..."
3265         # MAX value includes time needed for MDS-OST reconnection
3266         local MAX=$(( TIMEOUT * 2 ))
3267         local WAIT_TIMEOUT=${1:-$MAX}
3268         local WAIT=0
3269         local new_wait=true
3270         local list=$(comma_list $(mdts_nodes))
3271         local cmd="$LCTL get_param -n osp.*osc*.old_sync_processed"
3272         if ! do_facet $SINGLEMDS \
3273                 "$LCTL list_param osp.*osc*.old_sync_processed 2> /dev/null"
3274         then
3275                 # old way, use mds_sync
3276                 new_wait=false
3277                 list=$(comma_list $(osts_nodes))
3278                 cmd="$LCTL get_param -n obdfilter.*.mds_sync"
3279         fi
3280
3281         echo "wait $WAIT_TIMEOUT secs maximumly for $list mds-ost sync done."
3282         while [ $WAIT -lt $WAIT_TIMEOUT ]; do
3283                 local -a sync=($(do_nodes $list "$cmd"))
3284                 local con=1
3285                 local i
3286                 for ((i=0; i<${#sync[@]}; i++)); do
3287                         if $new_wait; then
3288                                 [ ${sync[$i]} -eq 1 ] && continue
3289                         else
3290                                 [ ${sync[$i]} -eq 0 ] && continue
3291                         fi
3292                         # there is a not finished MDS-OST synchronization
3293                         con=0
3294                         break;
3295                 done
3296                 sleep 2 # increase waiting time and cover statfs cache
3297                 [ ${con} -eq 1 ] && return 0
3298                 echo "Waiting $WAIT secs for $list $i mds-ost sync done."
3299                 WAIT=$((WAIT + 2))
3300         done
3301
3302         # show which nodes are not finished.
3303         cmd=$(echo $cmd | sed 's/-n//')
3304         do_nodes $list "$cmd"
3305         echo "$facet recovery node $i not done in $WAIT_TIMEOUT sec. $STATUS"
3306         return 1
3307 }
3308
3309 # Wait OSTs to be active on both client and MDT side.
3310 wait_osts_up() {
3311         local cmd="$LCTL get_param -n lov.$FSNAME-clilov-*.target_obd |
3312                 awk 'BEGIN {c = 0} /ACTIVE/{c += 1} END {printf \\\"%d\\\", c}'"
3313         wait_update $HOSTNAME "eval $cmd" $OSTCOUNT ||
3314                 error "wait_update OSTs up on client failed"
3315
3316         cmd="$LCTL get_param osp.$FSNAME-OST*-MDT0000.prealloc_last_id |
3317              awk '/=[1-9][0-9]/ { c += 1 } END { printf \\\"%d\\\", c }'"
3318         wait_update_facet $SINGLEMDS "eval $cmd" $OSTCOUNT ||
3319                 error "wait_update OSTs up on MDT0000 failed"
3320 }
3321
3322 wait_destroy_complete () {
3323         echo "Waiting for local destroys to complete"
3324         # MAX value shouldn't be big as this mean server responsiveness
3325         # never increase this just to make test pass but investigate
3326         # why it takes so long time
3327         local MAX=5
3328         local WAIT=0
3329         while [ $WAIT -lt $MAX ]; do
3330                 local -a RPCs=($($LCTL get_param -n osc.*.destroys_in_flight))
3331                 local con=1
3332                 local i
3333
3334                 for ((i=0; i<${#RPCs[@]}; i++)); do
3335                         [ ${RPCs[$i]} -eq 0 ] && continue
3336                         # there are still some destroy RPCs in flight
3337                         con=0
3338                         break;
3339                 done
3340                 sleep 1
3341                 [ ${con} -eq 1 ] && return 0 # done waiting
3342                 echo "Waiting ${WAIT}s for local destroys to complete"
3343                 WAIT=$((WAIT + 1))
3344         done
3345         echo "Local destroys weren't done in $MAX sec."
3346         return 1
3347 }
3348
3349 wait_delete_completed() {
3350         wait_delete_completed_mds $1 || return $?
3351         wait_destroy_complete || return $?
3352 }
3353
3354 wait_exit_ST () {
3355     local facet=$1
3356
3357     local WAIT=0
3358     local INTERVAL=1
3359     local running
3360     # conf-sanity 31 takes a long time cleanup
3361     while [ $WAIT -lt 300 ]; do
3362         running=$(do_facet ${facet} "lsmod | grep lnet > /dev/null &&
3363 lctl dl | grep ' ST ' || true")
3364         [ -z "${running}" ] && return 0
3365         echo "waited $WAIT for${running}"
3366         [ $INTERVAL -lt 64 ] && INTERVAL=$((INTERVAL + INTERVAL))
3367         sleep $INTERVAL
3368         WAIT=$((WAIT + INTERVAL))
3369     done
3370     echo "service didn't stop after $WAIT seconds.  Still running:"
3371     echo ${running}
3372     return 1
3373 }
3374
3375 wait_remote_prog () {
3376    local prog=$1
3377    local WAIT=0
3378    local INTERVAL=5
3379    local rc=0
3380
3381    [ "$PDSH" = "no_dsh" ] && return 0
3382
3383    while [ $WAIT -lt $2 ]; do
3384         running=$(ps uax | grep "$PDSH.*$prog.*$MOUNT" | grep -v grep) || true
3385         [ -z "${running}" ] && return 0 || true
3386         echo "waited $WAIT for: "
3387         echo "$running"
3388         [ $INTERVAL -lt 60 ] && INTERVAL=$((INTERVAL + INTERVAL))
3389         sleep $INTERVAL
3390         WAIT=$((WAIT + INTERVAL))
3391     done
3392     local pids=$(ps  uax | grep "$PDSH.*$prog.*$MOUNT" | grep -v grep | awk '{print $2}')
3393     [ -z "$pids" ] && return 0
3394     echo "$PDSH processes still exists after $WAIT seconds.  Still running: $pids"
3395     # FIXME: not portable
3396     for pid in $pids; do
3397         cat /proc/${pid}/status || true
3398         cat /proc/${pid}/wchan || true
3399         echo "Killing $pid"
3400         kill -9 $pid || true
3401         sleep 1
3402         ps -P $pid && rc=1
3403     done
3404
3405     return $rc
3406 }
3407
3408 lfs_df_check() {
3409         local clients=${1:-$CLIENTS}
3410
3411         if [ -z "$clients" ]; then
3412                 $LFS df $MOUNT
3413         else
3414                 $PDSH $clients "$LFS df $MOUNT" > /dev/null
3415         fi
3416 }
3417
3418 clients_up() {
3419         # not every config has many clients
3420         sleep 1
3421         lfs_df_check
3422 }
3423
3424 client_up() {
3425         # usually checked on particular client or locally
3426         sleep 1
3427         lfs_df_check $1
3428 }
3429
3430 client_evicted() {
3431     ! client_up $1
3432 }
3433
3434 client_reconnect_try() {
3435         local f=$MOUNT/recon
3436
3437         uname -n >> $f
3438         if [ -z "$CLIENTS" ]; then
3439                 $LFS df $MOUNT; uname -n >> $f
3440         else
3441                 do_nodes $CLIENTS "$LFS df $MOUNT; uname -n >> $f" > /dev/null
3442         fi
3443         echo "Connected clients: $(cat $f)"
3444         ls -l $f > /dev/null
3445         rm $f
3446 }
3447
3448 client_reconnect() {
3449         # one client_reconnect_try call does not always do the job...
3450         while true ; do
3451                 client_reconnect_try && break
3452                 sleep 1
3453         done
3454 }
3455
3456 affected_facets () {
3457     local facet=$1
3458
3459     local host=$(facet_active_host $facet)
3460     local affected=$facet
3461
3462     if [ "$FAILURE_MODE" = HARD ]; then
3463         affected=$(facets_up_on_host $host)
3464     fi
3465     echo $affected
3466 }
3467
3468 facet_failover() {
3469         local E2FSCK_ON_MDT0=false
3470         if [ "$1" == "--fsck" ]; then
3471                 shift
3472                 [ $(facet_fstype $SINGLEMDS) == ldiskfs ] &&
3473                         E2FSCK_ON_MDT0=true
3474         fi
3475
3476         local facets=$1
3477         local sleep_time=$2
3478         local -a affecteds
3479         local facet
3480         local total=0
3481         local index=0
3482         local skip
3483
3484         #Because it will only get up facets, we need get affected
3485         #facets before shutdown
3486         #For HARD Failure mode, it needs make sure facets on the same
3487         #HOST will only be shutdown and reboot once
3488         for facet in ${facets//,/ }; do
3489                 local affected_facet
3490                 skip=0
3491                 #check whether facet has been included in other affected facets
3492                 for ((index=0; index<$total; index++)); do
3493                         [[ *,$facet,* == ,${affecteds[index]}, ]] && skip=1
3494                 done
3495
3496                 if [ $skip -eq 0 ]; then
3497                         affecteds[$total]=$(affected_facets $facet)
3498                         total=$((total+1))
3499                 fi
3500         done
3501
3502         for ((index=0; index<$total; index++)); do
3503                 facet=$(echo ${affecteds[index]} | tr -s " " | cut -d"," -f 1)
3504                 local host=$(facet_active_host $facet)
3505                 echo "Failing ${affecteds[index]} on $host"
3506                 shutdown_facet $facet
3507         done
3508
3509         $E2FSCK_ON_MDT0 && (run_e2fsck $(facet_active_host $SINGLEMDS) \
3510                 $(mdsdevname 1) "-n" || error "Running e2fsck")
3511
3512         for ((index=0; index<$total; index++)); do
3513                 facet=$(echo ${affecteds[index]} | tr -s " " | cut -d"," -f 1)
3514                 echo reboot facets: ${affecteds[index]}
3515
3516                 reboot_facet $facet
3517
3518                 change_active ${affecteds[index]}
3519
3520                 wait_for_facet ${affecteds[index]}
3521                 if $GSS_SK; then
3522                         init_gss
3523                         init_facets_vars_simple
3524                 fi
3525                 # start mgs first if it is affected
3526                 if ! combined_mgs_mds &&
3527                         list_member ${affecteds[index]} mgs; then
3528                         mount_facet mgs || error "Restart of mgs failed"
3529                 fi
3530                 # FIXME; has to be changed to mount all facets concurrently
3531                 affected=$(exclude_items_from_list ${affecteds[index]} mgs)
3532                 echo mount facets: ${affecteds[index]}
3533                 mount_facets ${affecteds[index]}
3534                 if $GSS_SK; then
3535                         do_nodes $(comma_list $(all_nodes)) \
3536                                 "keyctl show | grep lustre | cut -c1-11 |
3537                                 sed -e 's/ //g;' |
3538                                 xargs -IX keyctl setperm X 0x3f3f3f3f"
3539                 fi
3540         done
3541 }
3542
3543 obd_name() {
3544     local facet=$1
3545 }
3546
3547 replay_barrier() {
3548         local facet=$1
3549         do_facet $facet "sync; sync; sync"
3550         $LFS df $MOUNT
3551
3552         # make sure there will be no seq change
3553         local clients=${CLIENTS:-$HOSTNAME}
3554         local f=fsa-\\\$\(hostname\)
3555         do_nodes $clients "mcreate $MOUNT/$f; rm $MOUNT/$f"
3556         do_nodes $clients "if [ -d $MOUNT2 ]; then mcreate $MOUNT2/$f; rm $MOUNT2/$f; fi"
3557
3558         local svc=${facet}_svc
3559         do_facet $facet $LCTL --device ${!svc} notransno
3560         #
3561         # If a ZFS OSD is made read-only here, its pool is "freezed". This
3562         # in-memory state has to be cleared by either rebooting the host or
3563         # exporting and reimporting the pool.
3564         #
3565         # Although the uberblocks are not updated when a pool is freezed,
3566         # transactions are still written to the disks. Modified blocks may be
3567         # cached in memory when tests try reading them back. The
3568         # export-and-reimport process also evicts any cached pool data from
3569         # memory to provide the correct "data loss" semantics.
3570         #
3571         # In the test framework, the exporting and importing operations are
3572         # handled by stop() and mount_facet() separately, which are used
3573         # inside fail() and fail_abort().
3574         #
3575         set_dev_readonly $facet
3576         do_facet $facet $LCTL mark "$facet REPLAY BARRIER on ${!svc}"
3577         $LCTL mark "local REPLAY BARRIER on ${!svc}"
3578 }
3579
3580 replay_barrier_nodf() {
3581         local facet=$1    echo running=${running}
3582         do_facet $facet "sync; sync; sync"
3583         local svc=${facet}_svc
3584         echo Replay barrier on ${!svc}
3585         do_facet $facet $LCTL --device ${!svc} notransno
3586         set_dev_readonly $facet
3587         do_facet $facet $LCTL mark "$facet REPLAY BARRIER on ${!svc}"
3588         $LCTL mark "local REPLAY BARRIER on ${!svc}"
3589 }
3590
3591 replay_barrier_nosync() {
3592         local facet=$1    echo running=${running}
3593         local svc=${facet}_svc
3594         echo Replay barrier on ${!svc}
3595         do_facet $facet $LCTL --device ${!svc} notransno
3596         set_dev_readonly $facet
3597         do_facet $facet $LCTL mark "$facet REPLAY BARRIER on ${!svc}"
3598         $LCTL mark "local REPLAY BARRIER on ${!svc}"
3599 }
3600
3601 #
3602 # Get Lustre client uuid for a given Lustre mount point.
3603 #
3604 get_client_uuid() {
3605         local mntpnt=${1:-$MOUNT}
3606
3607         local name=$($LFS getname $mntpnt | cut -d' ' -f1)
3608         local uuid=$($LCTL get_param -n llite.$name.uuid)
3609
3610         echo -n $uuid
3611 }
3612
3613 mds_evict_client() {
3614         local mntpnt=${1:-$MOUNT}
3615         local uuid=$(get_client_uuid $mntpnt)
3616
3617         do_facet $SINGLEMDS \
3618                 "$LCTL set_param -n mdt.${mds1_svc}.evict_client $uuid"
3619 }
3620
3621 ost_evict_client() {
3622         local mntpnt=${1:-$MOUNT}
3623         local uuid=$(get_client_uuid $mntpnt)
3624
3625         do_facet ost1 \
3626                 "$LCTL set_param -n obdfilter.${ost1_svc}.evict_client $uuid"
3627 }
3628
3629 fail() {
3630         local facets=$1
3631         local clients=${CLIENTS:-$HOSTNAME}
3632
3633         SK_NO_KEY_save=$SK_NO_KEY
3634         if $GSS_SK; then
3635                 export SK_NO_KEY=false
3636         fi
3637         facet_failover $* || error "failover: $?"
3638         export SK_NO_KEY=$SK_NO_KEY_save
3639         # to initiate all OSC idling connections
3640         clients_up
3641         wait_clients_import_state "$clients" "$facets" "\(FULL\|IDLE\)"
3642         clients_up || error "post-failover stat: $?"
3643 }
3644
3645 fail_nodf() {
3646         local facet=$1
3647         facet_failover $facet
3648 }
3649
3650 fail_abort() {
3651         local facet=$1
3652         stop $facet
3653         change_active $facet
3654         wait_for_facet $facet
3655         mount_facet $facet -o abort_recovery
3656         clients_up || echo "first stat failed: $?"
3657         clients_up || error "post-failover stat: $?"
3658 }
3659
3660 host_nids_address() {
3661         local nodes=$1
3662         local net=${2:-"."}
3663
3664         do_nodes $nodes "$LCTL list_nids | grep $net | cut -f 1 -d @"
3665 }
3666
3667 h2name_or_ip() {
3668         if [ "$1" = "'*'" ]; then echo \'*\'; else
3669                 echo $1"@$2"
3670         fi
3671 }
3672
3673 h2nettype() {
3674         if [[ -n "$NETTYPE" ]]; then
3675                 h2name_or_ip "$1" "$NETTYPE"
3676         else
3677                 h2name_or_ip "$1" "$2"
3678         fi
3679 }
3680 declare -fx h2nettype
3681
3682 # Wrapper function to print the deprecation warning
3683 h2tcp() {
3684         echo "h2tcp: deprecated, use h2nettype instead" 1>&2
3685         if [[ -n "$NETTYPE" ]]; then
3686                 h2nettype "$@"
3687         else
3688                 h2nettype "$1" "tcp"
3689         fi
3690 }
3691
3692 # Wrapper function to print the deprecation warning
3693 h2o2ib() {
3694         echo "h2o2ib: deprecated, use h2nettype instead" 1>&2
3695         if [[ -n "$NETTYPE" ]]; then
3696                 h2nettype "$@"
3697         else
3698                 h2nettype "$1" "o2ib"
3699         fi
3700 }
3701
3702 # This enables variables in cfg/"setup".sh files to support the pdsh HOSTLIST
3703 # expressions format. As a bonus we can then just pass in those variables
3704 # to pdsh. What this function does is take a HOSTLIST type string and
3705 # expand it into a space deliminated list for us.
3706 hostlist_expand() {
3707     local hostlist=$1
3708     local offset=$2
3709     local myList
3710     local item
3711     local list
3712
3713     [ -z "$hostlist" ] && return
3714
3715     # Translate the case of [..],..,[..] to [..] .. [..]
3716     list="${hostlist/],/] }"
3717     front=${list%%[*}
3718     [[ "$front" == *,* ]] && {
3719         new="${list%,*} "
3720         old="${list%,*},"
3721         list=${list/${old}/${new}}
3722     }
3723
3724     for item in $list; do
3725         # Test if we have any []'s at all
3726         if [ "$item" != "${item/\[/}" ]; then {
3727             # Expand the [*] into list
3728             name=${item%%[*}
3729             back=${item#*]}
3730
3731             if [ "$name" != "$item" ]; then
3732                 group=${item#$name[*}
3733                 group=${group%%]*}
3734
3735                 for range in ${group//,/ }; do
3736                     local order
3737
3738                     begin=${range%-*}
3739                     end=${range#*-}
3740
3741                     # Number of leading zeros
3742                     padlen=${#begin}
3743                     padlen2=${#end}
3744                     end=$(echo $end | sed 's/0*//')
3745                     [[ -z "$end" ]] && end=0
3746                     [[ $padlen2 -gt $padlen ]] && {
3747                         [[ $padlen2 -eq ${#end} ]] && padlen2=0
3748                         padlen=$padlen2
3749                     }
3750                     begin=$(echo $begin | sed 's/0*//')
3751                     [ -z $begin ] && begin=0
3752
3753                     if [ ! -z "${begin##[!0-9]*}" ]; then
3754                         order=$(seq -f "%0${padlen}g" $begin $end)
3755                     else
3756                         order=$(eval echo {$begin..$end});
3757                     fi
3758
3759                     for num in $order; do
3760                         value="${name#*,}${num}${back}"
3761                         [ "$value" != "${value/\[/}" ] && {
3762                             value=$(hostlist_expand "$value")
3763                         }
3764                         myList="$myList $value"
3765                     done
3766                 done
3767             fi
3768         } else {
3769             myList="$myList $item"
3770         } fi
3771     done
3772     myList=${myList//,/ }
3773     myList=${myList:1} # Remove first character which is a space
3774
3775     # Filter any duplicates without sorting
3776     list="$myList "
3777     myList="${list%% *}"
3778
3779     while [[ "$list" != ${myList##* } ]]; do
3780         local tlist=" $list"
3781         list=${tlist// ${list%% *} / }
3782         list=${list:1}
3783         myList="$myList ${list%% *}"
3784     done
3785     myList="${myList%* }";
3786
3787     # We can select an object at an offset in the list
3788     [ $# -eq 2 ] && {
3789         cnt=0
3790         for item in $myList; do
3791             let cnt=cnt+1
3792             [ $cnt -eq $offset ] && {
3793                 myList=$item
3794             }
3795         done
3796         [ $(get_node_count $myList) -ne 1 ] && myList=""
3797     }
3798     echo $myList
3799 }
3800
3801 facet_host() {
3802         local facet=$1
3803         local varname
3804
3805         [ "$facet" == client ] && echo -n $HOSTNAME && return
3806         varname=${facet}_HOST
3807         if [ -z "${!varname}" ]; then
3808                 if [ "${facet:0:3}" == "ost" ]; then
3809                         local fh=${facet%failover}_HOST
3810                         eval export ${facet}_HOST=${!fh}
3811                         if [ -z "${!varname}" ]; then
3812                                 eval export ${facet}_HOST=${ost_HOST}
3813                         fi
3814                 elif [ "${facet:0:3}" == "mdt" -o \
3815                         "${facet:0:3}" == "mds" -o \
3816                         "${facet:0:3}" == "mgs" ]; then
3817                         eval export ${facet}_HOST=${mds_HOST}
3818                 fi
3819         fi
3820         echo -n ${!varname}
3821 }
3822
3823 facet_failover_host() {
3824         local facet=$1
3825         local varname
3826
3827         var=${facet}failover_HOST
3828         if [ -n "${!var}" ]; then
3829                 echo ${!var}
3830                 return
3831         fi
3832
3833         if [ "${facet:0:3}" == "mdt" -o "${facet:0:3}" == "mds" -o \
3834              "${facet:0:3}" == "mgs" ]; then
3835
3836                 eval export ${facet}failover_host=${mds_HOST}
3837                 echo ${mds_HOST}
3838                 return
3839         fi
3840
3841         if [[ $facet == ost* ]]; then
3842                 eval export ${facet}failover_host=${ost_HOST}
3843                 echo ${ost_HOST}
3844                 return
3845         fi
3846 }
3847
3848 facet_active() {
3849     local facet=$1
3850     local activevar=${facet}active
3851
3852     if [ -f $TMP/${facet}active ] ; then
3853         source $TMP/${facet}active
3854     fi
3855
3856     active=${!activevar}
3857     if [ -z "$active" ] ; then
3858         echo -n ${facet}
3859     else
3860         echo -n ${active}
3861     fi
3862 }
3863
3864 facet_active_host() {
3865         facet_host $(facet_active $1)
3866 }
3867
3868 # Get the passive failover partner host of facet.
3869 facet_passive_host() {
3870         local facet=$1
3871         [[ $facet = client ]] && return
3872
3873         local host=${facet}_HOST
3874         local failover_host=${facet}failover_HOST
3875         local active_host=$(facet_active_host $facet)
3876
3877         [[ -z ${!failover_host} || ${!failover_host} = ${!host} ]] && return
3878
3879         if [[ $active_host = ${!host} ]]; then
3880                 echo -n ${!failover_host}
3881         else
3882                 echo -n ${!host}
3883         fi
3884 }
3885
3886 change_active() {
3887     local facetlist=$1
3888     local facet
3889
3890     facetlist=$(exclude_items_from_list $facetlist mgs)
3891
3892     for facet in ${facetlist//,/ }; do
3893     local failover=${facet}failover
3894     local host=`facet_host $failover`
3895     [ -z "$host" ] && return
3896
3897     local curactive=`facet_active $facet`
3898     if [ -z "${curactive}" -o "$curactive" == "$failover" ] ; then
3899         eval export ${facet}active=$facet
3900     else
3901         eval export ${facet}active=$failover
3902     fi
3903     # save the active host for this facet
3904     local activevar=${facet}active
3905     echo "$activevar=${!activevar}" > $TMP/$activevar
3906     [[ $facet = mds1 ]] && combined_mgs_mds && \
3907         echo "mgsactive=${!activevar}" > $TMP/mgsactive
3908     local TO=`facet_active_host $facet`
3909     echo "Failover $facet to $TO"
3910     done
3911 }
3912
3913 do_node() {
3914     local verbose=false
3915     # do not stripe off hostname if verbose, bug 19215
3916     if [ x$1 = x--verbose ]; then
3917         shift
3918         verbose=true
3919     fi
3920
3921     local HOST=$1
3922     shift
3923     local myPDSH=$PDSH
3924     if [ "$HOST" = "$HOSTNAME" ]; then
3925         myPDSH="no_dsh"
3926     elif [ -z "$myPDSH" -o "$myPDSH" = "no_dsh" ]; then
3927         echo "cannot run remote command on $HOST with $myPDSH"
3928         return 128
3929     fi
3930     if $VERBOSE; then
3931         echo "CMD: $HOST $@" >&2
3932         $myPDSH $HOST "$LCTL mark \"$@\"" > /dev/null 2>&1 || :
3933     fi
3934
3935         if [[ "$myPDSH" == "rsh" ]] ||
3936            [[ "$myPDSH" == *pdsh* && "$myPDSH" != *-S* ]]; then
3937                 # we need this because rsh and pdsh do not return
3938                 # exit code of an executed command
3939                 local command_status="$TMP/cs"
3940                 eval $myPDSH $HOST ":> $command_status"
3941                 eval $myPDSH $HOST "(PATH=\$PATH:$RLUSTRE/utils:$RLUSTRE/tests;
3942                                      PATH=\$PATH:/sbin:/usr/sbin;
3943                                      cd $RPWD;
3944                                      LUSTRE=\"$RLUSTRE\" sh -c \"$@\") ||
3945                                      echo command failed >$command_status"
3946                 [[ -n "$($myPDSH $HOST cat $command_status)" ]] && return 1 ||
3947                         return 0
3948         fi
3949
3950     if $verbose ; then
3951         # print HOSTNAME for myPDSH="no_dsh"
3952         if [[ $myPDSH = no_dsh ]]; then
3953             $myPDSH $HOST "(PATH=\$PATH:$RLUSTRE/utils:$RLUSTRE/tests:/sbin:/usr/sbin; cd $RPWD; LUSTRE=\"$RLUSTRE\" sh -c \"$@\")" | sed -e "s/^/${HOSTNAME}: /"
3954         else
3955             $myPDSH $HOST "(PATH=\$PATH:$RLUSTRE/utils:$RLUSTRE/tests:/sbin:/usr/sbin; cd $RPWD; LUSTRE=\"$RLUSTRE\" sh -c \"$@\")"
3956         fi
3957     else
3958         $myPDSH $HOST "(PATH=\$PATH:$RLUSTRE/utils:$RLUSTRE/tests:/sbin:/usr/sbin; cd $RPWD; LUSTRE=\"$RLUSTRE\" sh -c \"$@\")" | sed "s/^${HOST}: //"
3959     fi
3960     return ${PIPESTATUS[0]}
3961 }
3962
3963 do_nodev() {
3964     do_node --verbose "$@"
3965 }
3966
3967 single_local_node () {
3968    [ "$1" = "$HOSTNAME" ]
3969 }
3970
3971 # Outputs environment variable assignments that should be passed to remote nodes
3972 get_env_vars() {
3973         local var
3974         local value
3975         local facets=$(get_facets)
3976         local facet
3977
3978         for var in ${!MODOPTS_*}; do
3979                 value=${!var//\"/\\\"}
3980                 echo -n " ${var}=\"$value\""
3981         done
3982
3983         for facet in ${facets//,/ }; do
3984                 var=${facet}_FSTYPE
3985                 if [ -n "${!var}" ]; then
3986                         echo -n " $var=${!var}"
3987                 fi
3988         done
3989
3990         for var in MGSFSTYPE MDSFSTYPE OSTFSTYPE; do
3991                 if [ -n "${!var}" ]; then
3992                         echo -n " $var=${!var}"
3993                 fi
3994         done
3995
3996         for var in VERBOSE; do
3997                 if [ -n "${!var}" ]; then
3998                         echo -n " $var=${!var}"
3999                 fi
4000         done
4001
4002         if [ -n "$FSTYPE" ]; then
4003                 echo -n " FSTYPE=$FSTYPE"
4004         fi
4005
4006         for var in LNETLND NETTYPE; do
4007                 if [ -n "${!var}" ]; then
4008                         echo -n " $var=${!var}"
4009                 fi
4010         done
4011 }
4012
4013 do_nodes() {
4014     local verbose=false
4015     # do not stripe off hostname if verbose, bug 19215
4016     if [ x$1 = x--verbose ]; then
4017         shift
4018         verbose=true
4019     fi
4020
4021     local rnodes=$1
4022     shift
4023
4024     if single_local_node $rnodes; then
4025         if $verbose; then
4026            do_nodev $rnodes "$@"
4027         else
4028            do_node $rnodes "$@"
4029         fi
4030         return $?
4031     fi
4032
4033     # This is part from do_node
4034     local myPDSH=$PDSH
4035
4036     [ -z "$myPDSH" -o "$myPDSH" = "no_dsh" -o "$myPDSH" = "rsh" ] && \
4037         echo "cannot run remote command on $rnodes with $myPDSH" && return 128
4038
4039     export FANOUT=$(get_node_count "${rnodes//,/ }")
4040     if $VERBOSE; then
4041         echo "CMD: $rnodes $@" >&2
4042         $myPDSH $rnodes "$LCTL mark \"$@\"" > /dev/null 2>&1 || :
4043     fi
4044
4045     # do not replace anything from pdsh output if -N is used
4046     # -N     Disable hostname: prefix on lines of output.
4047     if $verbose || [[ $myPDSH = *-N* ]]; then
4048         $myPDSH $rnodes "(PATH=\$PATH:$RLUSTRE/utils:$RLUSTRE/tests:/sbin:/usr/sbin; cd $RPWD; LUSTRE=\"$RLUSTRE\" $(get_env_vars) sh -c \"$@\")"
4049     else
4050         $myPDSH $rnodes "(PATH=\$PATH:$RLUSTRE/utils:$RLUSTRE/tests:/sbin:/usr/sbin; cd $RPWD; LUSTRE=\"$RLUSTRE\" $(get_env_vars) sh -c \"$@\")" | sed -re "s/^[^:]*: //g"
4051     fi
4052     return ${PIPESTATUS[0]}
4053 }
4054
4055 ##
4056 # Execute commands on a single service's host
4057 #
4058 # The \a facet (service) may be on a local or remote node, which is
4059 # determined at the time the command is run.
4060 #
4061 # usage: do_facet $facet command [arg ...]
4062 do_facet() {
4063         local facet=$1
4064         shift
4065         local HOST=$(facet_active_host $facet)
4066         [ -z $HOST ] && echo "No host defined for facet ${facet}" && exit 1
4067         do_node $HOST "$@"
4068 }
4069
4070 # Function: do_facet_random_file $FACET $FILE $SIZE
4071 # Creates FILE with random content on the given FACET of given SIZE
4072
4073 do_facet_random_file() {
4074         local facet="$1"
4075         local fpath="$2"
4076         local fsize="$3"
4077         local cmd="dd if=/dev/urandom of='$fpath' bs=$fsize count=1"
4078         do_facet $facet "$cmd 2>/dev/null"
4079 }
4080
4081 do_facet_create_file() {
4082         local facet="$1"
4083         local fpath="$2"
4084         local fsize="$3"
4085         local cmd="dd if=/dev/zero of='$fpath' bs=$fsize count=1"
4086         do_facet $facet "$cmd 2>/dev/null"
4087 }
4088
4089 do_nodesv() {
4090     do_nodes --verbose "$@"
4091 }
4092
4093 add() {
4094         local facet=$1
4095         shift
4096         # make sure its not already running
4097         stop ${facet} -f
4098         rm -f $TMP/${facet}active
4099         [[ $facet = mds1 ]] && combined_mgs_mds && rm -f $TMP/mgsactive
4100         do_facet ${facet} $MKFS $* || return ${PIPESTATUS[0]}
4101
4102         if [[ $(facet_fstype $facet) == zfs ]]; then
4103                 #
4104                 # After formatting a ZFS target, "cachefile=none" property will
4105                 # be set on the ZFS storage pool so that the pool is not
4106                 # automatically imported on system startup. And then the pool
4107                 # will be exported so as to leave the importing and exporting
4108                 # operations handled by mount_facet() and stop() separately.
4109                 #
4110                 refresh_partition_table $facet $(facet_vdevice $facet)
4111                 disable_zpool_cache $facet
4112                 export_zpool $facet
4113         fi
4114 }
4115
4116 # Device formatted as ost
4117 ostdevname() {
4118         local num=$1
4119         local DEVNAME=OSTDEV$num
4120
4121         local fstype=$(facet_fstype ost$num)
4122
4123         case $fstype in
4124                 ldiskfs )
4125                         local dev=ost${num}_dev
4126                         [[ -n ${!dev} ]] && eval DEVPTR=${!dev} ||
4127                         #if $OSTDEVn isn't defined, default is $OSTDEVBASE + num
4128                         eval DEVPTR=${!DEVNAME:=${OSTDEVBASE}${num}};;
4129                 zfs )
4130                         #try $OSTZFSDEVn - independent of vdev
4131                         DEVNAME=OSTZFSDEV$num
4132                         eval DEVPTR=${!DEVNAME:=${FSNAME}-ost${num}/ost${num}};;
4133                 * )
4134                         error "unknown fstype!";;
4135         esac
4136
4137     echo -n $DEVPTR
4138 }
4139
4140 # Physical device location of data
4141 ostvdevname() {
4142         local num=$1
4143         local DEVNAME
4144         local VDEVPTR
4145
4146         local fstype=$(facet_fstype ost$num)
4147
4148         case $fstype in
4149                 ldiskfs )
4150                         # vdevs are not supported by ldiskfs
4151                         eval VDEVPTR="";;
4152                 zfs )
4153                         #if $OSTDEVn isn't defined, default is $OSTDEVBASE{n}
4154                         # Device formatted by zfs
4155                         DEVNAME=OSTDEV$num
4156                         eval VDEVPTR=${!DEVNAME:=${OSTDEVBASE}${num}};;
4157                 * )
4158                         error "unknown fstype!";;
4159         esac
4160
4161         echo -n $VDEVPTR
4162 }
4163
4164 # Logical device formatted for lustre
4165 mdsdevname() {
4166         local num=$1
4167         local DEVNAME=MDSDEV$num
4168
4169         local fstype=$(facet_fstype mds$num)
4170
4171         case $fstype in
4172                 ldiskfs )
4173                         local dev=mds${num}_dev
4174                         [[ -n ${!dev} ]] && eval DEVPTR=${!dev} ||
4175                         #if $MDSDEVn isn't defined, default is $MDSDEVBASE{n}
4176                         eval DEVPTR=${!DEVNAME:=${MDSDEVBASE}${num}};;
4177                 zfs )
4178                         # try $MDSZFSDEVn - independent of vdev
4179                         DEVNAME=MDSZFSDEV$num
4180                         eval DEVPTR=${!DEVNAME:=${FSNAME}-mdt${num}/mdt${num}};;
4181                 * )
4182                         error "unknown fstype!";;
4183         esac
4184
4185         echo -n $DEVPTR
4186 }
4187
4188 # Physical location of data
4189 mdsvdevname() {
4190         local VDEVPTR=""
4191         local num=$1
4192         local fstype=$(facet_fstype mds$num)
4193
4194         case $fstype in
4195                 ldiskfs )
4196                         # vdevs are not supported by ldiskfs
4197                         eval VDEVPTR="";;
4198                 zfs )
4199                         # if $MDSDEVn isn't defined, default is $MDSDEVBASE{n}
4200                         # Device formatted by ZFS
4201                         local DEVNAME=MDSDEV$num
4202                         eval VDEVPTR=${!DEVNAME:=${MDSDEVBASE}${num}};;
4203                 * )
4204                         error "unknown fstype!";;
4205         esac
4206
4207         echo -n $VDEVPTR
4208 }
4209
4210 mgsdevname() {
4211         local DEVPTR
4212         local fstype=$(facet_fstype mgs)
4213
4214         case $fstype in
4215         ldiskfs )
4216                 if [ $(facet_host mgs) = $(facet_host mds1) ] &&
4217                    ( [ -z "$MGSDEV" ] || [ $MGSDEV = $MDSDEV1 ] ); then
4218                         DEVPTR=$(mdsdevname 1)
4219                 else
4220                         [[ -n $mgs_dev ]] && DEVPTR=$mgs_dev ||
4221                         DEVPTR=$MGSDEV
4222                 fi;;
4223         zfs )
4224                 if [ $(facet_host mgs) = $(facet_host mds1) ] &&
4225                     ( [ -z "$MGSZFSDEV" ] &&
4226                         [ -z "$MGSDEV" -o "$MGSDEV" = $(mdsvdevname 1) ] ); then
4227                         DEVPTR=$(mdsdevname 1)
4228                 else
4229                         DEVPTR=${MGSZFSDEV:-${FSNAME}-mgs/mgs}
4230                 fi;;
4231         * )
4232                 error "unknown fstype!";;
4233         esac
4234
4235         echo -n $DEVPTR
4236 }
4237
4238 mgsvdevname() {
4239         local VDEVPTR=""
4240
4241         local fstype=$(facet_fstype mgs)
4242
4243         case $fstype in
4244         ldiskfs )
4245                 # vdevs are not supported by ldiskfs
4246                 ;;
4247         zfs )
4248                 if [ $(facet_host mgs) = $(facet_host mds1) ] &&
4249                    ( [ -z "$MGSDEV" ] &&
4250                        [ -z "$MGSZFSDEV" -o "$MGSZFSDEV" = $(mdsdevname 1) ]); then
4251                         VDEVPTR=$(mdsvdevname 1)
4252                 elif [ -n "$MGSDEV" ]; then
4253                         VDEVPTR=$MGSDEV
4254                 fi;;
4255         * )
4256                 error "unknown fstype!";;
4257         esac
4258
4259         echo -n $VDEVPTR
4260 }
4261
4262 facet_mntpt () {
4263     local facet=$1
4264     [[ $facet = mgs ]] && combined_mgs_mds && facet="mds1"
4265
4266     local var=${facet}_MOUNT
4267     eval mntpt=${!var:-${MOUNT}-$facet}
4268
4269     echo -n $mntpt
4270 }
4271
4272 mount_ldiskfs() {
4273         local facet=$1
4274         local dev=$(facet_device $facet)
4275         local mnt=${2:-$(facet_mntpt $facet)}
4276         local opts
4277         local dm_dev=$dev
4278
4279         if dm_flakey_supported $facet; then
4280                 dm_dev=$(dm_create_dev $facet $dev)
4281                 [[ -n "$dm_dev" ]] || dm_dev=$dev
4282         fi
4283         is_blkdev $facet $dm_dev || opts=$(csa_add "$opts" -o loop)
4284         export_dm_dev $facet $dm_dev
4285
4286         do_facet $facet mount -t ldiskfs $opts $dm_dev $mnt
4287 }
4288
4289 unmount_ldiskfs() {
4290         local facet=$1
4291         local dev=$(facet_device $facet)
4292         local mnt=${2:-$(facet_mntpt $facet)}
4293
4294         do_facet $facet $UMOUNT $mnt
4295 }
4296
4297 var_name() {
4298         echo -n "$1" | tr -c '[:alnum:]\n' '_'
4299 }
4300
4301 mount_zfs() {
4302         local facet=$1
4303         local ds=$(facet_device $facet)
4304         local mnt=${2:-$(facet_mntpt $facet)}
4305         local canmnt
4306         local mntpt
4307
4308         import_zpool $facet
4309         canmnt=$(do_facet $facet $ZFS get -H -o value canmount $ds)
4310         mntpt=$(do_facet $facet $ZFS get -H -o value mountpoint $ds)
4311         do_facet $facet $ZFS set canmount=noauto $ds
4312         #
4313         # The "legacy" mount method is used here because "zfs unmount $mnt"
4314         # calls stat(2) on $mnt/../*, which may include $MOUNT.  If certain
4315         # targets are not available at the time, the stat(2) on $MOUNT will
4316         # hang.
4317         #
4318         do_facet $facet $ZFS set mountpoint=legacy $ds
4319         do_facet $facet mount -t zfs $ds $mnt
4320         eval export mz_$(var_name ${facet}_$ds)_canmount=$canmnt
4321         eval export mz_$(var_name ${facet}_$ds)_mountpoint=$mntpt
4322 }
4323
4324 unmount_zfs() {
4325         local facet=$1
4326         local ds=$(facet_device $facet)
4327         local mnt=${2:-$(facet_mntpt $facet)}
4328         local var_mntpt=mz_$(var_name ${facet}_$ds)_mountpoint
4329         local var_canmnt=mz_$(var_name ${facet}_$ds)_canmount
4330         local mntpt=${!var_mntpt}
4331         local canmnt=${!var_canmnt}
4332
4333         unset $var_mntpt
4334         unset $var_canmnt
4335         do_facet $facet umount $mnt
4336         do_facet $facet $ZFS set mountpoint=$mntpt $ds
4337         do_facet $facet $ZFS set canmount=$canmnt $ds
4338         export_zpool $facet
4339 }
4340
4341 mount_fstype() {
4342         local facet=$1
4343         local mnt=$2
4344         local fstype=$(facet_fstype $facet)
4345
4346         mount_$fstype $facet $mnt
4347 }
4348
4349 unmount_fstype() {
4350         local facet=$1
4351         local mnt=$2
4352         local fstype=$(facet_fstype $facet)
4353
4354         unmount_$fstype $facet $mnt
4355 }
4356
4357 ########
4358 ## MountConf setup
4359
4360 stopall() {
4361         # make sure we are using the primary server, so test-framework will
4362         # be able to clean up properly.
4363         activemds=`facet_active mds1`
4364         if [ $activemds != "mds1" ]; then
4365                 fail mds1
4366         fi
4367
4368         local clients=$CLIENTS
4369         [ -z $clients ] && clients=$(hostname)
4370
4371         zconf_umount_clients $clients $MOUNT "$*" || true
4372         [ -n "$MOUNT2" ] && zconf_umount_clients $clients $MOUNT2 "$*" || true
4373
4374         [ -n "$CLIENTONLY" ] && return
4375
4376         # The add fn does rm ${facet}active file, this would be enough
4377         # if we use do_facet <facet> only after the facet added, but
4378         # currently we use do_facet mds in local.sh
4379         for num in `seq $MDSCOUNT`; do
4380                 stop mds$num -f
4381                 rm -f ${TMP}/mds${num}active
4382         done
4383         combined_mgs_mds && rm -f $TMP/mgsactive
4384
4385         for num in `seq $OSTCOUNT`; do
4386                 stop ost$num -f
4387                 rm -f $TMP/ost${num}active
4388         done
4389
4390         if ! combined_mgs_mds ; then
4391                 stop mgs
4392         fi
4393
4394         if $SHARED_KEY; then
4395                 export SK_MOUNTED=false
4396         fi
4397
4398         return 0
4399 }
4400
4401 cleanup_echo_devs () {
4402         trap 0
4403         local dev
4404         local devs=$($LCTL dl | grep echo | awk '{print $4}')
4405
4406         for dev in $devs; do
4407                 $LCTL --device $dev cleanup
4408                 $LCTL --device $dev detach
4409         done
4410 }
4411
4412 cleanupall() {
4413         nfs_client_mode && return
4414         cifs_client_mode && return
4415
4416         cleanup_echo_devs
4417         CLEANUP_DM_DEV=true stopall $*
4418
4419         unload_modules
4420         cleanup_sk
4421         cleanup_gss
4422 }
4423
4424 combined_mgs_mds () {
4425         [[ "$(mdsdevname 1)" = "$(mgsdevname)" ]] &&
4426                 [[ "$(facet_host mds1)" = "$(facet_host mgs)" ]]
4427 }
4428
4429 lower() {
4430         echo -n "$1" | tr '[:upper:]' '[:lower:]'
4431 }
4432
4433 upper() {
4434         echo -n "$1" | tr '[:lower:]' '[:upper:]'
4435 }
4436
4437 squash_opt() {
4438         local var="$*"
4439         local other=""
4440         local opt_o=""
4441         local opt_e=""
4442         local first_e=0
4443         local first_o=0
4444         local take=""
4445
4446         var=$(echo "$var" | sed -e 's/,\( \)*/,/g')
4447         for i in $(echo "$var"); do
4448                 if [ "$i" == "-O" ]; then
4449                         take="o";
4450                         first_o=$(($first_o + 1))
4451                         continue;
4452                 fi
4453                 if [ "$i" == "-E" ]; then
4454                         take="e";
4455                         first_e=$(($first_e + 1 ))
4456                         continue;
4457                 fi
4458                 case $take in
4459                         "o")
4460                                 [ $first_o -gt 1 ] && opt_o+=",";
4461                                 opt_o+="$i";
4462                                 ;;
4463                         "e")
4464                                 [ $first_e -gt 1 ] && opt_e+=",";
4465                                 opt_e+="$i";
4466                                 ;;
4467                         *)
4468                                 other+=" $i";
4469                                 ;;
4470                 esac
4471                 take=""
4472         done
4473
4474         echo -n "$other"
4475         [ -n "$opt_o" ] && echo " -O $opt_o"
4476         [ -n "$opt_e" ] && echo " -E $opt_e"
4477 }
4478
4479 mkfs_opts() {
4480         local facet=$1
4481         local dev=$2
4482         local fsname=${3:-"$FSNAME"}
4483         local type=$(facet_type $facet)
4484         local index=$(facet_index $facet)
4485         local fstype=$(facet_fstype $facet)
4486         local host=$(facet_host $facet)
4487         local opts
4488         local fs_mkfs_opts
4489         local var
4490
4491         if [ $type == MGS ] || ( [ $type == MDS ] &&
4492                                  [ "$dev" == $(mgsdevname) ] &&
4493                                  [ "$host" == "$(facet_host mgs)" ] ); then
4494                 opts="--mgs"
4495         else
4496                 opts="--mgsnode=$MGSNID"
4497         fi
4498
4499         if [ $type != MGS ]; then
4500                 opts+=" --fsname=$fsname --$(lower ${type/MDS/MDT}) \
4501                         --index=$index"
4502         fi
4503
4504         var=${facet}failover_HOST
4505         if [ -n "${!var}" ] && [ ${!var} != $(facet_host $facet) ]; then
4506                 opts+=" --failnode=$(h2nettype ${!var})"
4507         fi
4508
4509         opts+=${TIMEOUT:+" --param=sys.timeout=$TIMEOUT"}
4510         opts+=${LDLM_TIMEOUT:+" --param=sys.ldlm_timeout=$LDLM_TIMEOUT"}
4511
4512         if [ $type == MDS ]; then
4513                 opts+=${MDSCAPA:+" --param-mdt.capa=$MDSCAPA"}
4514                 opts+=${DEF_STRIPE_SIZE:+" --param=lov.stripesize=$DEF_STRIPE_SIZE"}
4515                 opts+=${DEF_STRIPE_COUNT:+" --param=lov.stripecount=$DEF_STRIPE_COUNT"}
4516                 opts+=${L_GETIDENTITY:+" --param=mdt.identity_upcall=$L_GETIDENTITY"}
4517
4518                 if [ $fstype == ldiskfs ]; then
4519                         fs_mkfs_opts+="-O ea_inode"
4520
4521                         var=${facet}_JRN
4522                         if [ -n "${!var}" ]; then
4523                                 fs_mkfs_opts+=" -J device=${!var}"
4524                         else
4525                                 fs_mkfs_opts+=${MDSJOURNALSIZE:+" -J size=$MDSJOURNALSIZE"}
4526                         fi
4527                         fs_mkfs_opts+=${MDSISIZE:+" -i $MDSISIZE"}
4528                 fi
4529         fi
4530
4531         if [ $type == OST ]; then
4532                 opts+=${OSSCAPA:+" --param=ost.capa=$OSSCAPA"}
4533
4534                 if [ $fstype == ldiskfs ]; then
4535                         var=${facet}_JRN
4536                         if [ -n "${!var}" ]; then
4537                                 fs_mkfs_opts+=" -J device=${!var}"
4538                         else
4539                                 fs_mkfs_opts+=${OSTJOURNALSIZE:+" -J size=$OSTJOURNALSIZE"}
4540                         fi
4541                 fi
4542         fi
4543
4544         opts+=" --backfstype=$fstype"
4545
4546         var=${type}SIZE
4547         if [ -n "${!var}" ]; then
4548                 opts+=" --device-size=${!var}"
4549         fi
4550
4551         var=$(upper $fstype)_MKFS_OPTS
4552         fs_mkfs_opts+=${!var:+" ${!var}"}
4553
4554         var=${type}_FS_MKFS_OPTS
4555         fs_mkfs_opts+=${!var:+" ${!var}"}
4556
4557         [ $fstype == ldiskfs ] && fs_mkfs_opts=$(squash_opt $fs_mkfs_opts)
4558
4559         if [ -n "${fs_mkfs_opts## }" ]; then
4560                 opts+=" --mkfsoptions=\\\"${fs_mkfs_opts## }\\\""
4561         fi
4562
4563         var=${type}OPT
4564         opts+=${!var:+" ${!var}"}
4565
4566         echo -n "$opts"
4567 }
4568
4569 mountfs_opts() {
4570         local facet=$1
4571         local type=$(facet_type $facet)
4572         local var=${type}_MOUNT_FS_OPTS
4573         local opts=""
4574         if [ -n "${!var}" ]; then
4575                 opts+=" --mountfsoptions=${!var}"
4576         fi
4577         echo -n "$opts"
4578 }
4579
4580 check_ost_indices() {
4581         local index_count=${#OST_INDICES[@]}
4582         [[ $index_count -eq 0 || $OSTCOUNT -le $index_count ]] && return 0
4583
4584         # OST count is greater than the index count in $OST_INDEX_LIST.
4585         # We need check whether there are duplicate indices.
4586         local i
4587         local j
4588         local index
4589         for i in $(seq $((index_count + 1)) $OSTCOUNT); do
4590                 index=$(facet_index ost$i)
4591                 for j in $(seq 0 $((index_count - 1))); do
4592                         [[ $index -ne ${OST_INDICES[j]} ]] ||
4593                         error "ost$i has the same index $index as ost$((j+1))"
4594                 done
4595         done
4596 }
4597
4598 __touch_device()
4599 {
4600         local facet_type=$1 # mgs || mds || ost
4601         local facet_num=$2
4602         local facet=${1}${2}
4603         local device
4604
4605         case "$(facet_fstype $facet)" in
4606         ldiskfs)
4607                 device=$(${facet_type}devname $facet_num)
4608                 ;;
4609         zfs)
4610                 device=$(${facet_type}vdevname $facet_num)
4611                 ;;
4612         *)
4613                 error "Unhandled filesystem type"
4614                 ;;
4615         esac
4616
4617         do_facet $facet "[ -e \"$device\" ]" && return
4618
4619         # Note: the following check only works with absolute paths
4620         [[ ! "$device" =~ ^/dev/ ]] || [[ "$device" =~ ^/dev/shm/ ]] ||
4621                 error "$facet: device '$device' does not exist"
4622
4623         # zpool create doesn't like empty files
4624         [[ $(facet_fstype $facet) == zfs ]] && return 0
4625
4626         do_facet $facet "touch \"${device}\""
4627 }
4628
4629 format_mgs() {
4630         local quiet
4631
4632         if ! $VERBOSE; then
4633                 quiet=yes
4634         fi
4635         echo "Format mgs: $(mgsdevname)"
4636         reformat_external_journal mgs
4637
4638         # touch "device" in case it is a loopback file for testing and needs to
4639         # be created. mkfs.lustre doesn't do this to avoid accidentally writing
4640         # to non-existent files in /dev if the admin made a typo during setup
4641         __touch_device mgs
4642
4643         add mgs $(mkfs_opts mgs $(mgsdevname)) $(mountfs_opts mgs) --reformat \
4644                 $(mgsdevname) $(mgsvdevname) ${quiet:+>/dev/null} || exit 10
4645 }
4646
4647 format_mdt() {
4648         local num=$1
4649         local quiet
4650
4651         if ! $VERBOSE; then
4652                 quiet=yes
4653         fi
4654         echo "Format mds$num: $(mdsdevname $num)"
4655         reformat_external_journal mds$num
4656
4657         __touch_device mds $num
4658
4659         add mds$num $(mkfs_opts mds$num $(mdsdevname ${num})) \
4660                 $(mountfs_opts mds$num) --reformat $(mdsdevname $num) \
4661                 $(mdsvdevname $num) ${quiet:+>/dev/null} || exit 10
4662 }
4663
4664 format_ost() {
4665         local num=$1
4666
4667         if ! $VERBOSE; then
4668                 quiet=yes
4669         fi
4670         echo "Format ost$num: $(ostdevname $num)"
4671         reformat_external_journal ost$num
4672
4673         __touch_device ost $num
4674
4675         add ost$num $(mkfs_opts ost$num $(ostdevname ${num})) \
4676                 $(mountfs_opts ost$num) --reformat $(ostdevname $num) \
4677                 $(ostvdevname ${num}) ${quiet:+>/dev/null} || exit 10
4678 }
4679
4680 formatall() {
4681         stopall -f
4682         # Set hostid for ZFS/SPL zpool import protection
4683         # (Assumes MDS version is also OSS version)
4684         if [ $(lustre_version_code $SINGLEMDS) -ge $(version_code 2.8.54) ];
4685         then
4686                 do_rpc_nodes "$(comma_list $(all_server_nodes))" set_hostid
4687         fi
4688
4689         # We need ldiskfs here, may as well load them all
4690         load_modules
4691         [ -n "$CLIENTONLY" ] && return
4692         echo Formatting mgs, mds, osts
4693         if ! combined_mgs_mds ; then
4694                 format_mgs
4695         fi
4696
4697         for num in $(seq $MDSCOUNT); do
4698                 format_mdt $num
4699         done
4700
4701         export OST_INDICES=($(hostlist_expand "$OST_INDEX_LIST"))
4702         check_ost_indices
4703         for num in $(seq $OSTCOUNT); do
4704                 format_ost $num
4705         done
4706 }
4707
4708 mount_client() {
4709         grep " $1 " /proc/mounts || zconf_mount $HOSTNAME $*
4710 }
4711
4712 umount_client() {
4713         grep " $1 " /proc/mounts && zconf_umount $HOSTNAME $*
4714 }
4715
4716 # return value:
4717 # 0: success, the old identity set already.
4718 # 1: success, the old identity does not set.
4719 # 2: fail.
4720 switch_identity() {
4721     local num=$1
4722     local switch=$2
4723     local j=`expr $num - 1`
4724     local MDT="`(do_facet mds$num lctl get_param -N mdt.*MDT*$j 2>/dev/null | cut -d"." -f2 2>/dev/null) || true`"
4725
4726     if [ -z "$MDT" ]; then
4727         return 2
4728     fi
4729
4730     local old="`do_facet mds$num "lctl get_param -n mdt.$MDT.identity_upcall"`"
4731
4732     if $switch; then
4733         do_facet mds$num "lctl set_param -n mdt.$MDT.identity_upcall \"$L_GETIDENTITY\""
4734     else
4735         do_facet mds$num "lctl set_param -n mdt.$MDT.identity_upcall \"NONE\""
4736     fi
4737
4738     do_facet mds$num "lctl set_param -n mdt/$MDT/identity_flush=-1"
4739
4740     if [ $old = "NONE" ]; then
4741         return 1
4742     else
4743         return 0
4744     fi
4745 }
4746
4747 remount_client()
4748 {
4749         zconf_umount $HOSTNAME $1 || error "umount failed"
4750         zconf_mount $HOSTNAME $1 || error "mount failed"
4751 }
4752
4753 writeconf_facet() {
4754         local facet=$1
4755         local dev=$2
4756
4757         stop ${facet} -f
4758         rm -f $TMP/${facet}active
4759         do_facet ${facet} "$TUNEFS --quiet --writeconf $dev" || return 1
4760         return 0
4761 }
4762
4763 writeconf_all () {
4764         local mdt_count=${1:-$MDSCOUNT}
4765         local ost_count=${2:-$OSTCOUNT}
4766         local rc=0
4767
4768         for num in $(seq $mdt_count); do
4769                 DEVNAME=$(mdsdevname $num)
4770                 writeconf_facet mds$num $DEVNAME || rc=$?
4771         done
4772
4773         for num in $(seq $ost_count); do
4774                 DEVNAME=$(ostdevname $num)
4775                 writeconf_facet ost$num $DEVNAME || rc=$?
4776         done
4777         return $rc
4778 }
4779
4780 mountmgs() {
4781         if ! combined_mgs_mds ; then
4782                 start mgs $(mgsdevname) $MGS_MOUNT_OPTS
4783         fi
4784 }
4785
4786 mountmds() {
4787         local num
4788         local devname
4789         local host
4790         local varname
4791         for num in $(seq $MDSCOUNT); do
4792                 devname=$(mdsdevname $num)
4793                 start mds$num $devname $MDS_MOUNT_OPTS
4794
4795                 # We started mds$num, now we should set mds${num}_HOST
4796                 # and mds${num}failover_HOST variables properly if they
4797                 # are not set.
4798                 host=$(facet_host mds$num)
4799                 for varname in mds${num}_HOST mds${num}failover_HOST; do
4800                         if [[ -z "${!varname}" ]]; then
4801                                 eval $varname=$host
4802                         fi
4803                 done
4804                 if [ $IDENTITY_UPCALL != "default" ]; then
4805                         switch_identity $num $IDENTITY_UPCALL
4806                 fi
4807         done
4808 }
4809
4810 mountoss() {
4811         local num
4812         local devname
4813         local host
4814         local varname
4815         for num in $(seq $OSTCOUNT); do
4816                 devname=$(ostdevname $num)
4817                 start ost$num $devname $OST_MOUNT_OPTS
4818
4819                 # We started ost$num, now we should set ost${num}_HOST
4820                 # and ost${num}failover_HOST variables properly if they
4821                 # are not set.
4822                 host=$(facet_host ost$num)
4823                 for varname in ost${num}_HOST ost${num}failover_HOST; do
4824                         if [[ -z "${!varname}" ]]; then
4825                                 eval $varname=$host
4826                         fi
4827                 done
4828         done
4829 }
4830
4831 mountcli() {
4832         [ "$DAEMONFILE" ] && $LCTL debug_daemon start $DAEMONFILE $DAEMONSIZE
4833         if [ ! -z $arg1 ]; then
4834                 [ "$arg1" = "server_only" ] && return
4835         fi
4836         mount_client $MOUNT
4837         if [ -n "$CLIENTS" ]; then
4838                 zconf_mount_clients $CLIENTS $MOUNT
4839         fi
4840         clients_up
4841
4842         if [ "$MOUNT_2" ]; then
4843                 mount_client $MOUNT2
4844                 if [ -n "$CLIENTS" ]; then
4845                         zconf_mount_clients $CLIENTS $MOUNT2
4846                 fi
4847         fi
4848 }
4849
4850 sk_nodemap_setup() {
4851         local sk_map_name=${1:-$SK_S2SNM}
4852         local sk_map_nodes=${2:-$HOSTNAME}
4853         do_node $(mgs_node) "$LCTL nodemap_add $sk_map_name"
4854         for servernode in $sk_map_nodes; do
4855                 local nids=$(do_nodes $servernode "$LCTL list_nids")
4856                 for nid in $nids; do
4857                         do_node $(mgs_node) "$LCTL nodemap_add_range --name \
4858                                 $sk_map_name --range $nid"
4859                 done
4860         done
4861 }
4862
4863 setupall() {
4864         local arg1=$1
4865
4866         nfs_client_mode && return
4867         cifs_client_mode && return
4868
4869         sanity_mount_check || error "environments are insane!"
4870
4871         load_modules
4872
4873         init_gss
4874
4875         if [ -z "$CLIENTONLY" ]; then
4876                 echo Setup mgs, mdt, osts
4877                 echo $WRITECONF | grep -q "writeconf" && writeconf_all
4878
4879                 if $SK_MOUNTED; then
4880                         echo "Shared Key file system already mounted"
4881                 else
4882                         mountmgs
4883                         mountmds
4884                         mountoss
4885                         if $SHARED_KEY; then
4886                                 export SK_MOUNTED=true
4887                         fi
4888                 fi
4889                 if $GSS_SK; then
4890                         echo "GSS_SK: setting kernel keyring perms"
4891                         do_nodes $(comma_list $(all_nodes)) \
4892                                 "keyctl show | grep lustre | cut -c1-11 |
4893                                 sed -e 's/ //g;' |
4894                                 xargs -IX keyctl setperm X 0x3f3f3f3f"
4895
4896                         if $SK_S2S; then
4897                                 # Need to start one nodemap for servers,
4898                                 # and one for clients.
4899                                 sk_nodemap_setup $SK_S2SNM \
4900                                         $(comma_list $(all_server_nodes))
4901                                 mountcli
4902                                 sk_nodemap_setup $SK_S2SNMCLI \
4903                                         ${CLIENTS:-$HOSTNAME}
4904                                 echo "Nodemap set up for SK S2S, remounting."
4905                                 stopall
4906                                 mountmgs
4907                                 mountmds
4908                                 mountoss
4909                         fi
4910                 fi
4911         fi
4912
4913         # wait a while to allow sptlrpc configuration be propogated to targets,
4914         # only needed when mounting new target devices.
4915         if $GSS; then
4916                 sleep 10
4917         fi
4918
4919         mountcli
4920         init_param_vars
4921
4922         # by remounting mdt before ost, initial connect from mdt to ost might
4923         # timeout because ost is not ready yet. wait some time to its fully
4924         # recovery. initial obd_connect timeout is 5s; in GSS case it's
4925         # preceeded by a context negotiation rpc with $TIMEOUT.
4926         # FIXME better by monitoring import status.
4927         if $GSS; then
4928                 if $GSS_SK; then
4929                         set_rule $FSNAME any cli2mdt $SK_FLAVOR
4930                         set_rule $FSNAME any cli2ost $SK_FLAVOR
4931                         if $SK_SKIPFIRST; then
4932                                 export SK_SKIPFIRST=false
4933
4934                                 sleep 30
4935                                 do_nodes $CLIENTS \
4936                                          "lctl set_param osc.*.idle_connect=1"
4937                                 return
4938                         else
4939                                 wait_flavor cli2mdt $SK_FLAVOR
4940                                 wait_flavor cli2ost $SK_FLAVOR
4941                         fi
4942                 else
4943                         set_flavor_all $SEC
4944                 fi
4945                 sleep $((TIMEOUT + 5))
4946         else
4947                 sleep 5
4948         fi
4949 }
4950
4951 mounted_lustre_filesystems() {
4952         awk '($3 ~ "lustre" && $1 ~ ":") { print $2 }' /proc/mounts
4953 }
4954
4955 init_facet_vars () {
4956         [ -n "$CLIENTONLY" ] && return 0
4957         local facet=$1
4958         shift
4959         local device=$1
4960
4961         shift
4962
4963         eval export ${facet}_dev=${device}
4964         eval export ${facet}_opt=\"$@\"
4965
4966         local dev=${facet}_dev
4967
4968         # We need to loop for the label
4969         # in case its not initialized yet.
4970         for wait_time in {0,1,3,5,10}; do
4971
4972                 if [ $wait_time -gt 0 ]; then
4973                         echo "${!dev} not yet initialized,"\
4974                                 "waiting ${wait_time} seconds."
4975                         sleep $wait_time
4976                 fi
4977
4978                 local label=$(devicelabel ${facet} ${!dev})
4979
4980                 # Check to make sure the label does
4981                 # not include ffff at the end of the label.
4982                 # This indicates it has not been initialized yet.
4983
4984                 if [[ $label =~ [f|F]{4}$ ]]; then
4985                         # label is not initialized, unset the result
4986                         # and either try again or fail
4987                         unset label
4988                 else
4989                         break
4990                 fi
4991         done
4992
4993         [ -z "$label" ] && echo no label for ${!dev} && exit 1
4994
4995         eval export ${facet}_svc=${label}
4996
4997         local varname=${facet}failover_HOST
4998         if [ -z "${!varname}" ]; then
4999                 eval export $varname=$(facet_host $facet)
5000         fi
5001
5002         varname=${facet}_HOST
5003         if [ -z "${!varname}" ]; then
5004                 eval export $varname=$(facet_host $facet)
5005         fi
5006
5007         # ${facet}failover_dev is set in cfg file
5008         varname=${facet}failover_dev
5009         if [ -n "${!varname}" ] ; then
5010                 eval export ${facet}failover_dev=${!varname}
5011         else
5012                 eval export ${facet}failover_dev=$device
5013         fi
5014
5015         # get mount point of already mounted device
5016         # is facet_dev is already mounted then use the real
5017         #  mount point of this facet; otherwise use $(facet_mntpt $facet)
5018         # i.e. ${facet}_MOUNT if specified by user or default
5019         local mntpt=$(do_facet ${facet} cat /proc/mounts | \
5020                         awk '"'${!dev}'" == $1 && $3 == "lustre" { print $2 }')
5021         if [ -z $mntpt ]; then
5022                 mntpt=$(facet_mntpt $facet)
5023         fi
5024         eval export ${facet}_MOUNT=$mntpt
5025 }
5026
5027 init_facets_vars () {
5028         local DEVNAME
5029
5030         if ! remote_mds_nodsh; then
5031                 for num in $(seq $MDSCOUNT); do
5032                         DEVNAME=`mdsdevname $num`
5033                         init_facet_vars mds$num $DEVNAME $MDS_MOUNT_OPTS
5034                 done
5035         fi
5036
5037         combined_mgs_mds || init_facet_vars mgs $(mgsdevname) $MGS_MOUNT_OPTS
5038
5039         if ! remote_ost_nodsh; then
5040                 for num in $(seq $OSTCOUNT); do
5041                         DEVNAME=$(ostdevname $num)
5042                         init_facet_vars ost$num $DEVNAME $OST_MOUNT_OPTS
5043                 done
5044         fi
5045 }
5046
5047 init_facets_vars_simple () {
5048         local devname
5049
5050         if ! remote_mds_nodsh; then
5051                 for num in $(seq $MDSCOUNT); do
5052                         devname=$(mdsdevname $num)
5053                         eval export mds${num}_dev=${devname}
5054                         eval export mds${num}_opt=\"${MDS_MOUNT_OPTS}\"
5055                 done
5056         fi
5057
5058         if ! combined_mgs_mds ; then
5059                 eval export mgs_dev=$(mgsdevname)
5060                 eval export mgs_opt=\"${MGS_MOUNT_OPTS}\"
5061         fi
5062
5063         if ! remote_ost_nodsh; then
5064                 for num in $(seq $OSTCOUNT); do
5065                         devname=$(ostdevname $num)
5066                         eval export ost${num}_dev=${devname}
5067                         eval export ost${num}_opt=\"${OST_MOUNT_OPTS}\"
5068                 done
5069         fi
5070 }
5071
5072 osc_ensure_active () {
5073     local facet=$1
5074     local timeout=$2
5075     local period=0
5076
5077     while [ $period -lt $timeout ]; do
5078         count=$(do_facet $facet "lctl dl | grep ' IN osc ' 2>/dev/null | wc -l")
5079         if [ $count -eq 0 ]; then
5080             break
5081         fi
5082
5083         echo "There are $count OST are inactive, wait $period seconds, and try again"
5084         sleep 3
5085         period=$((period+3))
5086     done
5087
5088     [ $period -lt $timeout ] || log "$count OST are inactive after $timeout seconds, give up"
5089 }
5090
5091 set_conf_param_and_check() {
5092         local myfacet=$1
5093         local TEST=$2
5094         local PARAM=$3
5095         local ORIG=$(do_facet $myfacet "$TEST")
5096         if [ $# -gt 3 ]; then
5097                 local FINAL=$4
5098         else
5099                 local -i FINAL
5100                 FINAL=$((ORIG + 5))
5101         fi
5102         echo "Setting $PARAM from $ORIG to $FINAL"
5103         do_facet mgs "$LCTL conf_param $PARAM='$FINAL'" ||
5104                 error "conf_param $PARAM failed"
5105
5106         wait_update_facet $myfacet "$TEST" "$FINAL" ||
5107                 error "check $PARAM failed!"
5108 }
5109
5110 set_persistent_param() {
5111         local myfacet=$1
5112         local test_param=$2
5113         local param=$3
5114         local orig=$(do_facet $myfacet "$LCTL get_param -n $test_param")
5115
5116         if [ $# -gt 3 ]; then
5117                 local final=$4
5118         else
5119                 local -i final
5120                 final=$((orig + 5))
5121         fi
5122
5123         if [[ $PERM_CMD == *"set_param -P"* ]]; then
5124                 echo "Setting $test_param from $orig to $final"
5125                 do_facet mgs "$PERM_CMD $test_param='$final'" ||
5126                         error "$PERM_CMD $test_param failed"
5127         else
5128                 echo "Setting $param from $orig to $final"
5129                 do_facet mgs "$PERM_CMD $param='$final'" ||
5130                         error "$PERM_CMD $param failed"
5131         fi
5132 }
5133
5134 set_persistent_param_and_check() {
5135         local myfacet=$1
5136         local test_param=$2
5137         local param=$3
5138         local orig=$(do_facet $myfacet "$LCTL get_param -n $test_param")
5139
5140         if [ $# -gt 3 ]; then
5141                 local final=$4
5142         else
5143                 local -i final
5144                 final=$((orig + 5))
5145         fi
5146
5147         set_persistent_param $myfacet $test_param $param "$final"
5148
5149         wait_update_facet $myfacet "$LCTL get_param -n $test_param" "$final" ||
5150                 error "check $param failed!"
5151 }
5152
5153 init_param_vars () {
5154         TIMEOUT=$(lctl get_param -n timeout)
5155         TIMEOUT=${TIMEOUT:-20}
5156
5157         if [ -n "$arg1" ]; then
5158                 [ "$arg1" = "server_only" ] && return
5159         fi
5160
5161         remote_mds_nodsh && log "Using TIMEOUT=$TIMEOUT" && return 0
5162
5163         TIMEOUT=$(do_facet $SINGLEMDS "lctl get_param -n timeout")
5164         log "Using TIMEOUT=$TIMEOUT"
5165
5166         osc_ensure_active $SINGLEMDS $TIMEOUT
5167         osc_ensure_active client $TIMEOUT
5168         $LCTL set_param osc.*.idle_timeout=debug
5169
5170         if [ -n "$(lctl get_param -n mdc.*.connect_flags|grep jobstats)" ]; then
5171                 local current_jobid_var=$($LCTL get_param -n jobid_var)
5172
5173                 if [ $JOBID_VAR = "existing" ]; then
5174                         echo "keeping jobstats as $current_jobid_var"
5175                 elif [ $current_jobid_var != $JOBID_VAR ]; then
5176                         echo "setting jobstats to $JOBID_VAR"
5177
5178                         set_persistent_param_and_check client \
5179                                 "jobid_var" "$FSNAME.sys.jobid_var" $JOBID_VAR
5180                 fi
5181         else
5182                 echo "jobstats not supported by server"
5183         fi
5184
5185         if [ $QUOTA_AUTO -ne 0 ]; then
5186                 if [ "$ENABLE_QUOTA" ]; then
5187                         echo "enable quota as required"
5188                         setup_quota $MOUNT || return 2
5189                 else
5190                         echo "disable quota as required"
5191                         # $LFS quotaoff -ug $MOUNT > /dev/null 2>&1
5192                 fi
5193         fi
5194         return 0
5195 }
5196
5197 nfs_client_mode () {
5198     if [ "$NFSCLIENT" ]; then
5199         echo "NFSCLIENT mode: setup, cleanup, check config skipped"
5200         local clients=$CLIENTS
5201         [ -z $clients ] && clients=$(hostname)
5202
5203         # FIXME: remove hostname when 19215 fixed
5204         do_nodes $clients "echo \\\$(hostname); grep ' '$MOUNT' ' /proc/mounts"
5205         declare -a nfsexport=(`grep ' '$MOUNT' ' /proc/mounts | awk '{print $1}' | awk -F: '{print $1 " "  $2}'`)
5206         if [[ ${#nfsexport[@]} -eq 0 ]]; then
5207                 error_exit NFSCLIENT=$NFSCLIENT mode, but no NFS export found!
5208         fi
5209         do_nodes ${nfsexport[0]} "echo \\\$(hostname); df -T  ${nfsexport[1]}"
5210         return
5211     fi
5212     return 1
5213 }
5214
5215 cifs_client_mode () {
5216         [ x$CIFSCLIENT = xyes ] &&
5217                 echo "CIFSCLIENT=$CIFSCLIENT mode: setup, cleanup, check config skipped"
5218 }
5219
5220 check_config_client () {
5221     local mntpt=$1
5222
5223     local mounted=$(mount | grep " $mntpt ")
5224     if [ -n "$CLIENTONLY" ]; then
5225         # bug 18021
5226         # CLIENTONLY should not depend on *_HOST settings
5227         local mgc=$($LCTL device_list | awk '/MGC/ {print $4}')
5228         # in theory someone could create a new,
5229         # client-only config file that assumed lustre was already
5230         # configured and didn't set the MGSNID. If MGSNID is not set,
5231         # then we should use the mgs nid currently being used
5232         # as the default value. bug 18021
5233         [[ x$MGSNID = x ]] &&
5234             MGSNID=${mgc//MGC/}
5235
5236         if [[ x$mgc != xMGC$MGSNID ]]; then
5237             if [ "$mgs_HOST" ]; then
5238                 local mgc_ip=$(ping -q -c1 -w1 $mgs_HOST | grep PING | awk '{print $3}' | sed -e "s/(//g" -e "s/)//g")
5239 #                [[ x$mgc = xMGC$mgc_ip@$NETTYPE ]] ||
5240 #                    error_exit "MGSNID=$MGSNID, mounted: $mounted, MGC : $mgc"
5241             fi
5242         fi
5243         return 0
5244     fi
5245
5246     echo Checking config lustre mounted on $mntpt
5247     local mgshost=$(mount | grep " $mntpt " | awk -F@ '{print $1}')
5248     mgshost=$(echo $mgshost | awk -F: '{print $1}')
5249
5250 }
5251
5252 check_config_clients () {
5253         local clients=${CLIENTS:-$HOSTNAME}
5254         local mntpt=$1
5255
5256         nfs_client_mode && return
5257         cifs_client_mode && return
5258
5259         do_rpc_nodes "$clients" check_config_client $mntpt
5260
5261         sanity_mount_check || error "environments are insane!"
5262 }
5263
5264 check_timeout () {
5265     local mdstimeout=$(do_facet $SINGLEMDS "lctl get_param -n timeout")
5266     local cltimeout=$(lctl get_param -n timeout)
5267     if [ $mdstimeout -ne $TIMEOUT ] || [ $mdstimeout -ne $cltimeout ]; then
5268         error "timeouts are wrong! mds: $mdstimeout, client: $cltimeout, TIMEOUT=$TIMEOUT"
5269         return 1
5270     fi
5271 }
5272
5273 is_mounted () {
5274     local mntpt=$1
5275     [ -z $mntpt ] && return 1
5276     local mounted=$(mounted_lustre_filesystems)
5277
5278     echo $mounted' ' | grep -w -q $mntpt' '
5279 }
5280
5281 is_empty_dir() {
5282         [ $(find $1 -maxdepth 1 -print | wc -l) = 1 ] && return 0
5283         return 1
5284 }
5285
5286 # empty lustre filesystem may have empty directories lost+found and .lustre
5287 is_empty_fs() {
5288         # exclude .lustre & lost+found
5289         [ $(find $1 -maxdepth 1 -name lost+found -o -name .lustre -prune -o \
5290                 -print | wc -l) = 1 ] || return 1
5291         [ ! -d $1/lost+found ] || is_empty_dir $1/lost+found || return 1
5292         if [ $(lustre_version_code $SINGLEMDS) -gt $(version_code 2.4.0) ]; then
5293                 # exclude .lustre/fid (LU-2780)
5294                 [ $(find $1/.lustre -maxdepth 1 -name fid -prune -o \
5295                         -print | wc -l) = 1 ] || return 1
5296         else
5297                 [ ! -d $1/.lustre ] || is_empty_dir $1/.lustre || return 1
5298         fi
5299         return 0
5300 }
5301
5302 check_and_setup_lustre() {
5303         sanitize_parameters
5304         nfs_client_mode && return
5305         cifs_client_mode && return
5306
5307         local MOUNTED=$(mounted_lustre_filesystems)
5308
5309         local do_check=true
5310         # 1.
5311         # both MOUNT and MOUNT2 are not mounted
5312         if ! is_mounted $MOUNT && ! is_mounted $MOUNT2; then
5313                 [ "$REFORMAT" = "yes" ] && CLEANUP_DM_DEV=true formatall
5314                 # setupall mounts both MOUNT and MOUNT2 (if MOUNT_2 is set)
5315                 setupall
5316                 is_mounted $MOUNT || error "NAME=$NAME not mounted"
5317                 export I_MOUNTED=yes
5318                 do_check=false
5319     # 2.
5320     # MOUNT2 is mounted
5321     elif is_mounted $MOUNT2; then
5322             # 3.
5323             # MOUNT2 is mounted, while MOUNT_2 is not set
5324             if ! [ "$MOUNT_2" ]; then
5325                 cleanup_mount $MOUNT2
5326                 export I_UMOUNTED2=yes
5327
5328             # 4.
5329             # MOUNT2 is mounted, MOUNT_2 is set
5330             else
5331                 # FIXME: what to do if check_config failed?
5332                 # i.e. if:
5333                 # 1) remote client has mounted other Lustre fs ?
5334                 # 2) it has insane env ?
5335                 # let's try umount MOUNT2 on all clients and mount it again:
5336                 if ! check_config_clients $MOUNT2; then
5337                     cleanup_mount $MOUNT2
5338                     restore_mount $MOUNT2
5339                     export I_MOUNTED2=yes
5340                 fi
5341             fi
5342
5343     # 5.
5344     # MOUNT is mounted MOUNT2 is not mounted
5345     elif [ "$MOUNT_2" ]; then
5346         restore_mount $MOUNT2
5347         export I_MOUNTED2=yes
5348     fi
5349
5350     if $do_check; then
5351         # FIXME: what to do if check_config failed?
5352         # i.e. if:
5353         # 1) remote client has mounted other Lustre fs?
5354         # 2) lustre is mounted on remote_clients atall ?
5355         check_config_clients $MOUNT
5356         init_facets_vars
5357         init_param_vars
5358
5359         set_default_debug_nodes $(comma_list $(nodes_list))
5360     fi
5361
5362         if [ -z "$CLIENTONLY" -a $(lower $OSD_TRACK_DECLARES_LBUG) == 'yes' ]; then
5363                 local facets=""
5364                 [ "$(facet_fstype ost1)" = "ldiskfs" ] &&
5365                         facets="$(get_facets OST)"
5366                 [ "$(facet_fstype mds1)" = "ldiskfs" ] &&
5367                         facets="$facets,$(get_facets MDS)"
5368                 [ "$(facet_fstype mgs)" = "ldiskfs" ] &&
5369                         facets="$facets,mgs"
5370                 local nodes="$(facets_hosts ${facets})"
5371                 if [ -n "$nodes" ] ; then
5372                         do_nodes $nodes "$LCTL set_param \
5373                                  osd-ldiskfs.track_declares_assert=1 || true"
5374                 fi
5375         fi
5376
5377         if $GSS_SK; then
5378                 set_flavor_all null
5379         elif $GSS; then
5380                 set_flavor_all $SEC
5381         fi
5382
5383         if [ "$ONLY" == "setup" ]; then
5384                 exit 0
5385         fi
5386 }
5387
5388 restore_mount () {
5389    local clients=${CLIENTS:-$HOSTNAME}
5390    local mntpt=$1
5391
5392    zconf_mount_clients $clients $mntpt
5393 }
5394
5395 cleanup_mount () {
5396         local clients=${CLIENTS:-$HOSTNAME}
5397         local mntpt=$1
5398
5399         zconf_umount_clients $clients $mntpt
5400 }
5401
5402 cleanup_and_setup_lustre() {
5403     if [ "$ONLY" == "cleanup" -o "`mount | grep $MOUNT`" ]; then
5404         lctl set_param debug=0 || true
5405         cleanupall
5406         if [ "$ONLY" == "cleanup" ]; then
5407             exit 0
5408         fi
5409     fi
5410     check_and_setup_lustre
5411 }
5412
5413 # Get all of the server target devices from a given server node and type.
5414 get_mnt_devs() {
5415         local node=$1
5416         local type=$2
5417         local devs
5418         local dev
5419
5420         if [ "$type" == ost ]; then
5421                 devs=$(get_osd_param $node "" mntdev)
5422         else
5423                 devs=$(do_node $node $LCTL get_param -n osd-*.$FSNAME-M*.mntdev)
5424         fi
5425         for dev in $devs; do
5426                 case $dev in
5427                 *loop*) do_node $node "losetup $dev" | \
5428                                 sed -e "s/.*(//" -e "s/).*//" ;;
5429                 *) echo $dev ;;
5430                 esac
5431         done
5432 }
5433
5434 # Get all of the server target devices.
5435 get_svr_devs() {
5436         local node
5437         local i
5438
5439         # Master MDS parameters used by lfsck
5440         MDTNODE=$(facet_active_host $SINGLEMDS)
5441         MDTDEV=$(echo $(get_mnt_devs $MDTNODE mdt) | awk '{print $1}')
5442
5443         # MDT devices
5444         i=0
5445         for node in $(mdts_nodes); do
5446                 MDTDEVS[i]=$(get_mnt_devs $node mdt)
5447                 i=$((i + 1))
5448         done
5449
5450         # OST devices
5451         i=0
5452         for node in $(osts_nodes); do
5453                 OSTDEVS[i]=$(get_mnt_devs $node ost)
5454                 i=$((i + 1))
5455         done
5456 }
5457
5458 # Run e2fsck on MDT or OST device.
5459 run_e2fsck() {
5460         local node=$1
5461         local target_dev=$2
5462         local extra_opts=$3
5463         local cmd="$E2FSCK -d -v -t -t -f $extra_opts $target_dev"
5464         local log=$TMP/e2fsck.log
5465         local rc=0
5466
5467         echo $cmd
5468         do_node $node $cmd 2>&1 | tee $log
5469         rc=${PIPESTATUS[0]}
5470         if [ -n "$(grep "DNE mode isn't supported" $log)" ]; then
5471                 rm -f $log
5472                 if [ $MDSCOUNT -gt 1 ]; then
5473                         skip_noexit "DNE mode isn't supported!"
5474                         cleanupall
5475                         exit_status
5476                 else
5477                         error "It's not DNE mode."
5478                 fi
5479         fi
5480         rm -f $log
5481
5482         [ $rc -le $FSCK_MAX_ERR ] ||
5483                 error "$cmd returned $rc, should be <= $FSCK_MAX_ERR"
5484
5485         return 0
5486 }
5487
5488 #
5489 # Run resize2fs on MDT or OST device.
5490 #
5491 run_resize2fs() {
5492         local facet=$1
5493         local device=$2
5494         local size=$3
5495         shift 3
5496         local opts="$@"
5497
5498         do_facet $facet "$RESIZE2FS $opts $device $size"
5499 }
5500
5501 # verify a directory is shared among nodes.
5502 check_shared_dir() {
5503         local dir=$1
5504         local list=${2:-$(comma_list $(nodes_list))}
5505
5506         [ -z "$dir" ] && return 1
5507         do_rpc_nodes "$list" check_logdir $dir
5508         check_write_access $dir "$list" || return 1
5509         return 0
5510 }
5511
5512 run_lfsck() {
5513         do_nodes $(comma_list $(mdts_nodes) $(osts_nodes)) \
5514                 $LCTL set_param printk=+lfsck
5515         do_facet $SINGLEMDS "$LCTL lfsck_start -M $FSNAME-MDT0000 -r -A -t all"
5516
5517         for k in $(seq $MDSCOUNT); do
5518                 # wait up to 10+1 minutes for LFSCK to complete
5519                 wait_update_facet --verbose mds${k} "$LCTL get_param -n \
5520                         mdd.$(facet_svc mds${k}).lfsck_layout |
5521                         awk '/^status/ { print \\\$2 }'" "completed" 600 ||
5522                         error "MDS${k} layout isn't the expected 'completed'"
5523                 wait_update_facet --verbose mds${k} "$LCTL get_param -n \
5524                         mdd.$(facet_svc mds${k}).lfsck_namespace |
5525                         awk '/^status/ { print \\\$2 }'" "completed" 60 ||
5526                         error "MDS${k} namespace isn't the expected 'completed'"
5527         done
5528         local rep_mdt=$(do_nodes $(comma_list $(mdts_nodes)) \
5529                         $LCTL get_param -n mdd.$FSNAME-*.lfsck_* |
5530                         awk '/repaired/ { print $2 }' | calc_sum)
5531         local rep_ost=$(do_nodes $(comma_list $(osts_nodes)) \
5532                         $LCTL get_param -n obdfilter.$FSNAME-*.lfsck_* |
5533                         awk '/repaired/ { print $2 }' | calc_sum)
5534         local repaired=$((rep_mdt + rep_ost))
5535         [ $repaired -eq 0 ] ||
5536                 error "lfsck repaired $rep_mdt MDT and $rep_ost OST errors"
5537 }
5538
5539 dump_file_contents() {
5540         local nodes=$1
5541         local dir=$2
5542         local logname=$3
5543         local node
5544
5545         if [ -z "$nodes" -o -z "$dir" -o -z "$logname" ]; then
5546                 error_noexit false \
5547                         "Invalid parameters for dump_file_contents()"
5548                 return 1
5549         fi
5550         for node in ${nodes}; do
5551                 do_node $node "for i in \\\$(find $dir -type f); do
5552                                 echo ====\\\${i}=======================;
5553                                 cat \\\${i};
5554                                 done" >> ${logname}.${node}.log
5555         done
5556 }
5557
5558 dump_command_output() {
5559         local nodes=$1
5560         local cmd=$2
5561         local logname=$3
5562         local node
5563
5564         if [ -z "$nodes" -o -z "$cmd" -o -z "$logname" ]; then
5565                 error_noexit false \
5566                         "Invalid parameters for dump_command_output()"
5567                 return 1
5568         fi
5569
5570         for node in ${nodes}; do
5571                 do_node $node "echo ====${cmd}=======================;
5572                                 $cmd" >> ${logname}.${node}.log
5573         done
5574 }
5575
5576 log_zfs_info() {
5577         local logname=$1
5578
5579         # dump file contents from /proc/spl in case of zfs test
5580         if [ "$(facet_fstype ost1)" = "zfs" ]; then
5581                 dump_file_contents "$(osts_nodes)" "/proc/spl" "${logname}"
5582                 dump_command_output \
5583                         "$(osts_nodes)" "zpool events -v" "${logname}"
5584         fi
5585
5586         if [ "$(facet_fstype $SINGLEMDS)" = "zfs" ]; then
5587                 dump_file_contents "$(mdts_nodes)" "/proc/spl" "${logname}"
5588                 dump_command_output \
5589                         "$(mdts_nodes)" "zpool events -v" "${logname}"
5590         fi
5591 }
5592
5593 check_and_cleanup_lustre() {
5594         if [ "$LFSCK_ALWAYS" = "yes" -a "$TESTSUITE" != "sanity-lfsck" -a \
5595              "$TESTSUITE" != "sanity-scrub" ]; then
5596                 run_lfsck
5597         fi
5598
5599         if is_mounted $MOUNT; then
5600                 if $DO_CLEANUP; then
5601                         [ -n "$DIR" ] && rm -rf $DIR/[Rdfs][0-9]* ||
5602                                 error "remove sub-test dirs failed"
5603                 else
5604                         echo "skip cleanup"
5605                 fi
5606                 [ "$ENABLE_QUOTA" ] && restore_quota || true
5607         fi
5608
5609         if [ "$I_UMOUNTED2" = "yes" ]; then
5610                 restore_mount $MOUNT2 || error "restore $MOUNT2 failed"
5611         fi
5612
5613         if [ "$I_MOUNTED2" = "yes" ]; then
5614                 cleanup_mount $MOUNT2
5615         fi
5616
5617         if [[ "$I_MOUNTED" = "yes" ]] && ! $AUSTER_CLEANUP; then
5618                 cleanupall -f || error "cleanup failed"
5619                 unset I_MOUNTED
5620         fi
5621 }
5622
5623 #######
5624 # General functions
5625
5626 wait_for_function () {
5627     local quiet=""
5628
5629     # suppress fn both stderr and stdout
5630     if [ "$1" = "--quiet" ]; then
5631         shift
5632         quiet=" > /dev/null 2>&1"
5633
5634     fi
5635
5636     local fn=$1
5637     local max=${2:-900}
5638     local sleep=${3:-5}
5639
5640     local wait=0
5641
5642     while true; do
5643
5644         eval $fn $quiet && return 0
5645
5646         wait=$((wait + sleep))
5647         [ $wait -lt $max ] || return 1
5648         echo waiting $fn, $((max - wait)) secs left ...
5649         sleep $sleep
5650     done
5651 }
5652
5653 check_network() {
5654         local host=$1
5655         local max=$2
5656         local sleep=${3:-5}
5657
5658         [ "$host" = "$HOSTNAME" ] && return 0
5659
5660         echo "$(date +'%H:%M:%S (%s)') waiting for $host network $max secs ..."
5661         if ! wait_for_function --quiet "ping -c 1 -w 3 $host" $max $sleep ; then
5662                 echo "Network not available!"
5663                 exit 1
5664         fi
5665
5666         echo "$(date +'%H:%M:%S (%s)') network interface is UP"
5667 }
5668
5669 no_dsh() {
5670     shift
5671     eval $@
5672 }
5673
5674 # Convert a space-delimited list to a comma-delimited list.  If the input is
5675 # only whitespace, ensure the output is empty (i.e. "") so [ -n $list ] works
5676 comma_list() {
5677         # echo is used to convert newlines to spaces, since it doesn't
5678         # introduce a trailing space as using "tr '\n' ' '" does
5679         echo $(tr -s " " "\n" <<< $* | sort -b -u) | tr ' ' ','
5680 }
5681
5682 list_member () {
5683     local list=$1
5684     local item=$2
5685     echo $list | grep -qw $item
5686 }
5687
5688 # list, excluded are the comma separated lists
5689 exclude_items_from_list () {
5690     local list=$1
5691     local excluded=$2
5692     local item
5693
5694     list=${list//,/ }
5695     for item in ${excluded//,/ }; do
5696         list=$(echo " $list " | sed -re "s/\s+$item\s+/ /g")
5697     done
5698     echo $(comma_list $list)
5699 }
5700
5701 # list, expand  are the comma separated lists
5702 expand_list () {
5703     local list=${1//,/ }
5704     local expand=${2//,/ }
5705     local expanded=
5706
5707     expanded=$(for i in $list $expand; do echo $i; done | sort -u)
5708     echo $(comma_list $expanded)
5709 }
5710
5711 testslist_filter () {
5712     local script=$LUSTRE/tests/${TESTSUITE}.sh
5713
5714     [ -f $script ] || return 0
5715
5716     local start_at=$START_AT
5717     local stop_at=$STOP_AT
5718
5719     local var=${TESTSUITE//-/_}_START_AT
5720     [ x"${!var}" != x ] && start_at=${!var}
5721     var=${TESTSUITE//-/_}_STOP_AT
5722     [ x"${!var}" != x ] && stop_at=${!var}
5723
5724     sed -n 's/^test_\([^ (]*\).*/\1/p' $script | \
5725         awk ' BEGIN { if ("'${start_at:-0}'" != 0) flag = 1 }
5726             /^'${start_at}'$/ {flag = 0}
5727             {if (flag == 1) print $0}
5728             /^'${stop_at}'$/ { flag = 1 }'
5729 }
5730
5731 absolute_path() {
5732     (cd `dirname $1`; echo $PWD/`basename $1`)
5733 }
5734
5735 get_facets () {
5736     local types=${1:-"OST MDS MGS"}
5737
5738     local list=""
5739
5740     for entry in $types; do
5741         local name=$(echo $entry | tr "[:upper:]" "[:lower:]")
5742         local type=$(echo $entry | tr "[:lower:]" "[:upper:]")
5743
5744         case $type in
5745                 MGS ) list="$list $name";;
5746             MDS|OST|AGT ) local count=${type}COUNT
5747                        for ((i=1; i<=${!count}; i++)) do
5748                           list="$list ${name}$i"
5749                       done;;
5750                   * ) error "Invalid facet type"
5751                  exit 1;;
5752         esac
5753     done
5754     echo $(comma_list $list)
5755 }
5756
5757 ##################################
5758 # Adaptive Timeouts funcs
5759
5760 at_is_enabled() {
5761     # only check mds, we assume at_max is the same on all nodes
5762     local at_max=$(do_facet $SINGLEMDS "lctl get_param -n at_max")
5763     if [ $at_max -eq 0 ]; then
5764         return 1
5765     else
5766         return 0
5767     fi
5768 }
5769
5770 at_get() {
5771     local facet=$1
5772     local at=$2
5773
5774     # suppose that all ost-s have the same $at value set
5775     [ $facet != "ost" ] || facet=ost1
5776
5777     do_facet $facet "lctl get_param -n $at"
5778 }
5779
5780 at_max_get() {
5781     at_get $1 at_max
5782 }
5783
5784 at_min_get() {
5785         at_get $1 at_min
5786 }
5787
5788 at_max_set() {
5789     local at_max=$1
5790     shift
5791
5792     local facet
5793     local hosts
5794     for facet in $@; do
5795         if [ $facet == "ost" ]; then
5796             facet=$(get_facets OST)
5797         elif [ $facet == "mds" ]; then
5798             facet=$(get_facets MDS)
5799         fi
5800         hosts=$(expand_list $hosts $(facets_hosts $facet))
5801     done
5802
5803     do_nodes $hosts lctl set_param at_max=$at_max
5804 }
5805
5806 ##################################
5807 # OBD_FAIL funcs
5808
5809 drop_request() {
5810 # OBD_FAIL_MDS_ALL_REQUEST_NET
5811     RC=0
5812     do_facet $SINGLEMDS lctl set_param fail_val=0 fail_loc=0x123
5813     do_facet client "$1" || RC=$?
5814     do_facet $SINGLEMDS lctl set_param fail_loc=0
5815     return $RC
5816 }
5817
5818 drop_reply() {
5819 # OBD_FAIL_MDS_ALL_REPLY_NET
5820         RC=0
5821         do_facet $SINGLEMDS $LCTL set_param fail_loc=0x122
5822         eval "$@" || RC=$?
5823         do_facet $SINGLEMDS $LCTL set_param fail_loc=0
5824         return $RC
5825 }
5826
5827 drop_reint_reply() {
5828 # OBD_FAIL_MDS_REINT_NET_REP
5829         RC=0
5830         do_facet $SINGLEMDS $LCTL set_param fail_loc=0x119
5831         eval "$@" || RC=$?
5832         do_facet $SINGLEMDS $LCTL set_param fail_loc=0
5833         return $RC
5834 }
5835
5836 drop_update_reply() {
5837 # OBD_FAIL_OUT_UPDATE_NET_REP
5838         local index=$1
5839         shift 1
5840         RC=0
5841         do_facet mds${index} lctl set_param fail_loc=0x1701
5842         do_facet client "$@" || RC=$?
5843         do_facet mds${index} lctl set_param fail_loc=0
5844         return $RC
5845 }
5846
5847 pause_bulk() {
5848 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
5849         RC=0
5850
5851         local timeout=${2:-0}
5852         # default is (obd_timeout / 4) if unspecified
5853         echo "timeout is $timeout/$2"
5854         do_facet ost1 lctl set_param fail_val=$timeout fail_loc=0x80000214
5855         do_facet client "$1" || RC=$?
5856         do_facet client "sync"
5857         do_facet ost1 lctl set_param fail_loc=0
5858         return $RC
5859 }
5860
5861 drop_ldlm_cancel() {
5862 #define OBD_FAIL_LDLM_CANCEL_NET                        0x304
5863         local RC=0
5864         local list=$(comma_list $(mdts_nodes) $(osts_nodes))
5865         do_nodes $list lctl set_param fail_loc=0x304
5866
5867         do_facet client "$@" || RC=$?
5868
5869         do_nodes $list lctl set_param fail_loc=0
5870         return $RC
5871 }
5872
5873 drop_bl_callback_once() {
5874         local rc=0
5875         do_facet client lctl set_param ldlm.namespaces.*.early_lock_cancel=0
5876 #define OBD_FAIL_LDLM_BL_CALLBACK_NET                   0x305
5877         do_facet client lctl set_param fail_loc=0x80000305
5878         do_facet client "$@" || rc=$?
5879         do_facet client lctl set_param fail_loc=0
5880         do_facet client lctl set_param fail_val=0
5881         do_facet client lctl set_param ldlm.namespaces.*.early_lock_cancel=1
5882         return $rc
5883 }
5884
5885 drop_bl_callback() {
5886         rc=0
5887         do_facet client lctl set_param ldlm.namespaces.*.early_lock_cancel=0
5888 #define OBD_FAIL_LDLM_BL_CALLBACK_NET                   0x305
5889         do_facet client lctl set_param fail_loc=0x305
5890         do_facet client "$@" || rc=$?
5891         do_facet client lctl set_param fail_loc=0
5892         do_facet client lctl set_param fail_val=0
5893         do_facet client lctl set_param ldlm.namespaces.*.early_lock_cancel=1
5894         return $rc
5895 }
5896
5897 drop_mdt_ldlm_reply() {
5898 #define OBD_FAIL_MDS_LDLM_REPLY_NET     0x157
5899     RC=0
5900     local list=$(comma_list $(mdts_nodes))
5901     do_nodes $list lctl set_param fail_loc=0x157
5902
5903     do_facet client "$@" || RC=$?
5904
5905     do_nodes $list lctl set_param fail_loc=0
5906     return $RC
5907 }
5908
5909 drop_mdt_ldlm_reply_once() {
5910 #define OBD_FAIL_MDS_LDLM_REPLY_NET     0x157
5911     RC=0
5912     local list=$(comma_list $(mdts_nodes))
5913     do_nodes $list lctl set_param fail_loc=0x80000157
5914
5915     do_facet client "$@" || RC=$?
5916
5917     do_nodes $list lctl set_param fail_loc=0
5918     return $RC
5919 }
5920
5921 clear_failloc() {
5922     facet=$1
5923     pause=$2
5924     sleep $pause
5925     echo "clearing fail_loc on $facet"
5926     do_facet $facet "lctl set_param fail_loc=0 2>/dev/null || true"
5927 }
5928
5929 set_nodes_failloc () {
5930         local fv=${3:-0}
5931         do_nodes $(comma_list $1)  lctl set_param fail_val=$fv fail_loc=$2
5932 }
5933
5934 cancel_lru_locks() {
5935         #$LCTL mark "cancel_lru_locks $1 start"
5936         $LCTL set_param -n ldlm.namespaces.*$1*.lru_size=clear
5937         $LCTL get_param ldlm.namespaces.*$1*.lock_unused_count | grep -v '=0'
5938         #$LCTL mark "cancel_lru_locks $1 stop"
5939 }
5940
5941 default_lru_size()
5942 {
5943         NR_CPU=$(grep -c "processor" /proc/cpuinfo)
5944         DEFAULT_LRU_SIZE=$((100 * NR_CPU))
5945         echo "$DEFAULT_LRU_SIZE"
5946 }
5947
5948 lru_resize_enable()
5949 {
5950     lctl set_param ldlm.namespaces.*$1*.lru_size=0
5951 }
5952
5953 lru_resize_disable()
5954 {
5955     lctl set_param ldlm.namespaces.*$1*.lru_size $(default_lru_size)
5956 }
5957
5958 flock_is_enabled()
5959 {
5960         local RC=0
5961         [ -z "$(mount | grep "$MOUNT.*flock" | grep -v noflock)" ] && RC=1
5962         return $RC
5963 }
5964
5965 pgcache_empty() {
5966     local FILE
5967     for FILE in `lctl get_param -N "llite.*.dump_page_cache"`; do
5968         if [ `lctl get_param -n $FILE | wc -l` -gt 1 ]; then
5969             echo there is still data in page cache $FILE ?
5970             lctl get_param -n $FILE
5971             return 1
5972         fi
5973     done
5974     return 0
5975 }
5976
5977 debugsave() {
5978         DEBUGSAVE="$(lctl get_param -n debug)"
5979         DEBUGSAVE_SERVER=$(do_facet $SINGLEMDS "$LCTL get_param -n debug")
5980 }
5981
5982 debugrestore() {
5983         [ -n "$DEBUGSAVE" ] &&
5984                 do_nodes $CLIENTS "$LCTL set_param debug=\\\"${DEBUGSAVE}\\\""||
5985                 true
5986         DEBUGSAVE=""
5987
5988         [ -n "$DEBUGSAVE_SERVER" ] &&
5989                 do_nodes $(comma_list $(all_server_nodes)) \
5990                          "$LCTL set_param debug=\\\"${DEBUGSAVE_SERVER}\\\"" ||
5991                          true
5992         DEBUGSAVE_SERVER=""
5993 }
5994
5995 debug_size_save() {
5996     DEBUG_SIZE_SAVED="$(lctl get_param -n debug_mb)"
5997 }
5998
5999 debug_size_restore() {
6000     [ -n "$DEBUG_SIZE_SAVED" ] && \
6001         do_nodes $(comma_list $(nodes_list)) "$LCTL set_param debug_mb=$DEBUG_SIZE_SAVED"
6002     DEBUG_SIZE_SAVED=""
6003 }
6004
6005 start_full_debug_logging() {
6006     debugsave
6007     debug_size_save
6008
6009     local FULLDEBUG=-1
6010     local DEBUG_SIZE=150
6011
6012     do_nodes $(comma_list $(nodes_list)) "$LCTL set_param debug_mb=$DEBUG_SIZE"
6013     do_nodes $(comma_list $(nodes_list)) "$LCTL set_param debug=$FULLDEBUG;"
6014 }
6015
6016 stop_full_debug_logging() {
6017     debug_size_restore
6018     debugrestore
6019 }
6020
6021 # prints bash call stack
6022 print_stack_trace() {
6023         local skip=${1:-1}
6024         echo "  Trace dump:"
6025         for (( i=$skip; i < ${#BASH_LINENO[*]} ; i++ )) ; do
6026                 local src=${BASH_SOURCE[$i]}
6027                 local lineno=${BASH_LINENO[$i-1]}
6028                 local funcname=${FUNCNAME[$i]}
6029                 echo "  = $src:$lineno:$funcname()"
6030         done
6031 }
6032
6033 report_error() {
6034         local TYPE=${TYPE:-"FAIL"}
6035
6036         local dump=true
6037         # do not dump logs if $1=false
6038         if [ "x$1" = "xfalse" ]; then
6039                 shift
6040                 dump=false
6041         fi
6042
6043         log " ${TESTSUITE} ${TESTNAME}: @@@@@@ ${TYPE}: $@ "
6044         (print_stack_trace 2) >&2
6045         mkdir -p $LOGDIR
6046         # We need to dump the logs on all nodes
6047         if $dump; then
6048                 gather_logs $(comma_list $(nodes_list))
6049         fi
6050
6051         debugrestore
6052         [ "$TESTSUITELOG" ] &&
6053                 echo "$TESTSUITE: $TYPE: $TESTNAME $@" >> $TESTSUITELOG
6054         if [ -z "$*" ]; then
6055                 echo "error() without useful message, please fix" > $LOGDIR/err
6056         else
6057                 if [[ `echo $TYPE | grep ^IGNORE` ]]; then
6058                         echo "$@" > $LOGDIR/ignore
6059                 else
6060                         echo "$@" > $LOGDIR/err
6061                 fi
6062         fi
6063
6064         # cleanup the env for failed tests
6065         reset_fail_loc
6066 }
6067
6068 ##################################
6069 # Test interface
6070 ##################################
6071
6072 # usage: stack_trap arg sigspec
6073 #
6074 # stack_trap() behaves like bash's built-in trap, except that it "stacks" the
6075 # command ``arg`` on top of previously defined commands for ``sigspec`` instead
6076 # of overwriting them.
6077 # stacked traps are executed in reverse order of their registration
6078 #
6079 # arg and sigspec have the same meaning as in man (1) trap
6080 stack_trap()
6081 {
6082         local arg="$1"
6083         local sigspec="$2"
6084
6085         # Use "trap -p" to get the quoting right
6086         local old_trap="$(trap -p "$sigspec")"
6087         # Append ";" and remove the leading "trap -- '" added by "trap -p"
6088         old_trap="${old_trap:+"; ${old_trap#trap -- \'}"}"
6089
6090         # Once again, use "trap -p" to get the quoting right
6091         local new_trap="$(trap -- "$arg" "$sigspec"
6092                           trap -p "$sigspec"
6093                           trap -- '' "$sigspec")"
6094
6095         # Remove the trailing "' $sigspec" part added by "trap -p" and merge
6096         #
6097         # The resulting string should be safe to "eval" as it is (supposedly
6098         # correctly) quoted by "trap -p"
6099         eval "${new_trap%\' $sigspec}${old_trap:-"' $sigspec"}"
6100 }
6101
6102 error_noexit() {
6103         report_error "$@"
6104 }
6105
6106 exit_status () {
6107         local status=0
6108         local log=$TESTSUITELOG
6109
6110         [ -f "$log" ] && grep -qw FAIL $log && status=1
6111         exit $status
6112 }
6113
6114 error() {
6115         report_error "$@"
6116         exit 1
6117 }
6118
6119 error_exit() {
6120         report_error "$@"
6121         exit 1
6122 }
6123
6124 # use only if we are ignoring failures for this test, bugno required.
6125 # (like ALWAYS_EXCEPT, but run the test and ignore the results.)
6126 # e.g. error_ignore bz5494 "your message" or
6127 # error_ignore LU-5494 "your message"
6128 error_ignore() {
6129         local TYPE="IGNORE ($1)"
6130         shift
6131         report_error "$@"
6132 }
6133
6134 error_and_remount() {
6135         report_error "$@"
6136         remount_client $MOUNT
6137         exit 1
6138 }
6139
6140 # Throw an error if it's not running in vm - usually for performance
6141 # verification
6142 error_not_in_vm() {
6143         local virt=$(running_in_vm)
6144         if [[ -n "$virt" ]]; then
6145                 echo "running in VM '$virt', ignore error"
6146                 error_ignore env=$virt "$@"
6147         else
6148                 error "$@"
6149         fi
6150 }
6151
6152 #
6153 # Function: skip_env()
6154 # Purpose:  to skip a test during developer testing because some tool
6155 #           is missing, but fail the test in release testing because the test
6156 #           environment is not configured properly".
6157 #
6158 skip_env () {
6159         $FAIL_ON_SKIP_ENV && error false $@ || skip $@
6160 }
6161
6162 skip_noexit() {
6163         echo
6164         log " SKIP: $TESTSUITE $TESTNAME $@"
6165
6166         if [[ -n "$ALWAYS_SKIPPED" ]]; then
6167                 skip_logged $TESTNAME "$@"
6168         else
6169                 mkdir -p $LOGDIR
6170                 echo "$@" > $LOGDIR/skip
6171         fi
6172
6173         [[ -n "$TESTSUITELOG" ]] &&
6174                 echo "$TESTSUITE: SKIP: $TESTNAME $@" >> $TESTSUITELOG || true
6175 }
6176
6177 skip() {
6178         skip_noexit $@
6179         exit 0
6180 }
6181
6182 build_test_filter() {
6183         EXCEPT="$EXCEPT $(testslist_filter)"
6184
6185         for O in $ONLY; do
6186                 if [[ $O = [0-9]*-[0-9]* ]]; then
6187                         for num in $(seq $(echo $O | tr '-' ' ')); do
6188                                 eval ONLY_$num=true
6189                         done
6190                 else
6191                         eval ONLY_${O}=true
6192                 fi
6193         done
6194
6195     [ "$EXCEPT$ALWAYS_EXCEPT" ] && \
6196         log "excepting tests: `echo $EXCEPT $ALWAYS_EXCEPT`"
6197     [ "$EXCEPT_SLOW" ] && \
6198         log "skipping tests SLOW=no: `echo $EXCEPT_SLOW`"
6199     for E in $EXCEPT; do
6200         eval EXCEPT_${E}=true
6201     done
6202     for E in $ALWAYS_EXCEPT; do
6203         eval EXCEPT_ALWAYS_${E}=true
6204     done
6205     for E in $EXCEPT_SLOW; do
6206         eval EXCEPT_SLOW_${E}=true
6207     done
6208     for G in $GRANT_CHECK_LIST; do
6209         eval GCHECK_ONLY_${G}=true
6210         done
6211 }
6212
6213 basetest() {
6214     if [[ $1 = [a-z]* ]]; then
6215         echo $1
6216     else
6217         echo ${1%%[a-z]*}
6218     fi
6219 }
6220
6221 # print a newline if the last test was skipped
6222 export LAST_SKIPPED=
6223 export ALWAYS_SKIPPED=
6224 #
6225 # Main entry into test-framework. This is called with the name and
6226 # description of a test. The name is used to find the function to run
6227 # the test using "test_$name".
6228 #
6229 # This supports a variety of methods of specifying specific test to
6230 # run or not run.  These need to be documented...
6231 #
6232 run_test() {
6233         assert_DIR
6234         export base=$(basetest $1)
6235         TESTNAME=test_$1
6236         LAST_SKIPPED=
6237         ALWAYS_SKIPPED=
6238
6239         # Check the EXCEPT, ALWAYS_EXCEPT and SLOW lists to see if we
6240         # need to skip the current test. If so, set the ALWAYS_SKIPPED flag.
6241         local testname=EXCEPT_$1
6242         local testname_base=EXCEPT_$base
6243         if [ ${!testname}x != x ]; then
6244                 ALWAYS_SKIPPED="y"
6245                 skip_message="skipping excluded test $1"
6246         elif [ ${!testname_base}x != x ]; then
6247                 ALWAYS_SKIPPED="y"
6248                 skip_message="skipping excluded test $1 (base $base)"
6249         fi
6250
6251         testname=EXCEPT_ALWAYS_$1
6252         testname_base=EXCEPT_ALWAYS_$base
6253         if [ ${!testname}x != x ]; then
6254                 ALWAYS_SKIPPED="y"
6255                 skip_message="skipping ALWAYS excluded test $1"
6256         elif [ ${!testname_base}x != x ]; then
6257                 ALWAYS_SKIPPED="y"
6258                 skip_message="skipping ALWAYS excluded test $1 (base $base)"
6259         fi
6260
6261         testname=EXCEPT_SLOW_$1
6262         testname_base=EXCEPT_SLOW_$base
6263         if [ ${!testname}x != x ]; then
6264                 ALWAYS_SKIPPED="y"
6265                 skip_message="skipping SLOW test $1"
6266         elif [ ${!testname_base}x != x ]; then
6267                 ALWAYS_SKIPPED="y"
6268                 skip_message="skipping SLOW test $1 (base $base)"
6269         fi
6270
6271         # If there are tests on the ONLY list, check if the current test
6272         # is on that list and, if so, check if the test is to be skipped
6273         # and if we are supposed to honor the skip lists.
6274         if [ -n "$ONLY" ]; then
6275                 testname=ONLY_$1
6276                 testname_base=ONLY_$base
6277                 if [[ ${!testname}x != x || ${!testname_base}x != x ]]; then
6278
6279                         if [[ -n "$ALWAYS_SKIPPED" && -n "$HONOR_EXCEPT" ]]; then
6280                                 LAST_SKIPPED="y"
6281                                 skip_noexit "$skip_message"
6282                                 return 0
6283                         else
6284                                 [ -n "$LAST_SKIPPED" ] &&
6285                                         echo "" && LAST_SKIPPED=
6286                                 ALWAYS_SKIPPED=
6287                                 run_one_logged $1 "$2"
6288                                 return $?
6289                         fi
6290
6291                 else
6292                         LAST_SKIPPED="y"
6293                         return 0
6294                 fi
6295         fi
6296
6297         if [ -n "$ALWAYS_SKIPPED" ]; then
6298                 LAST_SKIPPED="y"
6299                 skip_noexit "$skip_message"
6300                 return 0
6301         else
6302                 run_one_logged $1 "$2"
6303                 return $?
6304         fi
6305
6306 }
6307
6308 log() {
6309         echo "$*" >&2
6310         load_module ../libcfs/libcfs/libcfs
6311
6312     local MSG="$*"
6313     # Get rid of '
6314     MSG=${MSG//\'/\\\'}
6315     MSG=${MSG//\(/\\\(}
6316     MSG=${MSG//\)/\\\)}
6317     MSG=${MSG//\;/\\\;}
6318     MSG=${MSG//\|/\\\|}
6319     MSG=${MSG//\>/\\\>}
6320     MSG=${MSG//\</\\\<}
6321     MSG=${MSG//\//\\\/}
6322     do_nodes $(comma_list $(nodes_list)) $LCTL mark "$MSG" 2> /dev/null || true
6323 }
6324
6325 trace() {
6326         log "STARTING: $*"
6327         strace -o $TMP/$1.strace -ttt $*
6328         RC=$?
6329         log "FINISHED: $*: rc $RC"
6330         return 1
6331 }
6332
6333 complete () {
6334     local duration=$1
6335
6336     banner test complete, duration $duration sec
6337     [ -f "$TESTSUITELOG" ] && egrep .FAIL $TESTSUITELOG || true
6338     echo duration $duration >>$TESTSUITELOG
6339 }
6340
6341 pass() {
6342         # Set TEST_STATUS here. It will be used for logging the result.
6343         TEST_STATUS="PASS"
6344
6345         if [[ -f $LOGDIR/err ]]; then
6346                 TEST_STATUS="FAIL"
6347         elif [[ -f $LOGDIR/skip ]]; then
6348                 TEST_STATUS="SKIP"
6349         fi
6350         echo "$TEST_STATUS $@" 2>&1 | tee -a $TESTSUITELOG
6351 }
6352
6353 check_mds() {
6354     local FFREE=$(do_node $SINGLEMDS \
6355         lctl get_param -n osd*.*MDT*.filesfree | calc_sum)
6356     local FTOTAL=$(do_node $SINGLEMDS \
6357         lctl get_param -n osd*.*MDT*.filestotal | calc_sum)
6358
6359     [ $FFREE -ge $FTOTAL ] && error "files free $FFREE > total $FTOTAL" || true
6360 }
6361
6362 reset_fail_loc () {
6363         echo -n "Resetting fail_loc on all nodes..."
6364         do_nodes $(comma_list $(nodes_list)) "lctl set_param -n fail_loc=0 \
6365             fail_val=0 2>/dev/null" || true
6366         echo done.
6367 }
6368
6369
6370 #
6371 # Log a message (on all nodes) padded with "=" before and after.
6372 # Also appends a timestamp and prepends the testsuite name.
6373 #
6374
6375 EQUALS="===================================================================================================="
6376 banner() {
6377     msg="== ${TESTSUITE} $*"
6378     last=${msg: -1:1}
6379     [[ $last != "=" && $last != " " ]] && msg="$msg "
6380     msg=$(printf '%s%.*s'  "$msg"  $((${#EQUALS} - ${#msg})) $EQUALS )
6381     # always include at least == after the message
6382     log "$msg== $(date +"%H:%M:%S (%s)")"
6383 }
6384
6385 check_dmesg_for_errors() {
6386         local res
6387         local errors="VFS: Busy inodes after unmount of\|\
6388 ldiskfs_check_descriptors: Checksum for group 0 failed\|\
6389 group descriptors corrupted"
6390
6391         res=$(do_nodes $(comma_list $(nodes_list)) "dmesg" | grep "$errors")
6392         [ -z "$res" ] && return 0
6393         echo "Kernel error detected: $res"
6394         return 1
6395 }
6396
6397 #
6398 # Run a single test function and cleanup after it.
6399 #
6400 # This function should be run in a subshell so the test func can
6401 # exit() without stopping the whole script.
6402 #
6403 run_one() {
6404         local testnum=$1
6405         local message=$2
6406         export tfile=f${testnum}.${TESTSUITE}
6407         export tdir=d${testnum}.${TESTSUITE}
6408         export TESTNAME=test_$testnum
6409         local SAVE_UMASK=`umask`
6410         umask 0022
6411
6412         if ! grep -q $DIR /proc/mounts; then
6413                 $SETUP
6414         fi
6415
6416         banner "test $testnum: $message"
6417         test_${testnum} || error "test_$testnum failed with $?"
6418         cd $SAVE_PWD
6419         reset_fail_loc
6420         check_grant ${testnum} || error "check_grant $testnum failed with $?"
6421         check_node_health
6422         check_dmesg_for_errors || error "Error in dmesg detected"
6423         if [ "$PARALLEL" != "yes" ]; then
6424                 ps auxww | grep -v grep | grep -q multiop &&
6425                                         error "multiop still running"
6426         fi
6427         unset TESTNAME
6428         unset tdir
6429         unset tfile
6430         umask $SAVE_UMASK
6431         $CLEANUP
6432         return 0
6433 }
6434
6435 #
6436 # Wrapper around run_one to ensure:
6437 #  - test runs in subshell
6438 #  - output of test is saved to separate log file for error reporting
6439 #  - test result is saved to data file
6440 #
6441 run_one_logged() {
6442         local BEFORE=$(date +%s)
6443         local TEST_ERROR
6444         local name=${TESTSUITE}.test_${1}.test_log.$(hostname -s).log
6445         local test_log=$LOGDIR/$name
6446         local zfs_log_name=${TESTSUITE}.test_${1}.zfs_log
6447         local zfs_debug_log=$LOGDIR/$zfs_log_name
6448         rm -rf $LOGDIR/err
6449         rm -rf $LOGDIR/ignore
6450         rm -rf $LOGDIR/skip
6451         local SAVE_UMASK=$(umask)
6452         umask 0022
6453
6454         echo
6455         log_sub_test_begin test_${1}
6456         (run_one $1 "$2") 2>&1 | tee -i $test_log
6457         local RC=${PIPESTATUS[0]}
6458
6459         [ $RC -ne 0 ] && [ ! -f $LOGDIR/err ] &&
6460                 echo "test_$1 returned $RC" | tee $LOGDIR/err
6461
6462         duration=$(($(date +%s) - $BEFORE))
6463         pass "$1" "(${duration}s)"
6464
6465         if [[ -f $LOGDIR/err ]]; then
6466                 TEST_ERROR=$(cat $LOGDIR/err)
6467         elif [[ -f $LOGDIR/ignore ]]; then
6468                 TEST_ERROR=$(cat $LOGDIR/ignore)
6469         elif [[ -f $LOGDIR/skip ]]; then
6470                 TEST_ERROR=$(cat $LOGDIR/skip)
6471         fi
6472         log_sub_test_end $TEST_STATUS $duration "$RC" "$TEST_ERROR"
6473
6474         if [[ "$TEST_STATUS" != "SKIP" ]] && [[ -f $TF_SKIP ]]; then
6475                 rm -f $TF_SKIP
6476         fi
6477
6478         if [ -f $LOGDIR/err ]; then
6479                 log_zfs_info "$zfs_debug_log"
6480                 $FAIL_ON_ERROR && exit $RC
6481         fi
6482
6483         umask $SAVE_UMASK
6484
6485         return 0
6486 }
6487
6488 #
6489 # Print information of skipped tests to result.yml
6490 #
6491 skip_logged(){
6492         log_sub_test_begin $1
6493         shift
6494         log_sub_test_end "SKIP" "0" "0" "$@"
6495 }
6496
6497 canonical_path() {
6498         (cd $(dirname $1); echo $PWD/$(basename $1))
6499 }
6500
6501
6502 check_grant() {
6503         export base=$(basetest $1)
6504         [ "$CHECK_GRANT" == "no" ] && return 0
6505
6506         testnamebase=GCHECK_ONLY_${base}
6507         testname=GCHECK_ONLY_$1
6508         [ ${!testnamebase}x == x -a ${!testname}x == x ] && return 0
6509
6510         echo -n "checking grant......"
6511
6512         local clients=$CLIENTS
6513         [ -z "$clients" ] && clients=$(hostname)
6514
6515         # sync all the data and make sure no pending data on server
6516         do_nodes $clients sync
6517         clients_up # initiate all idling connections
6518
6519         # get client grant
6520         client_grant=$(do_nodes $clients \
6521                 "$LCTL get_param -n osc.${FSNAME}-*.cur_*grant_bytes" |
6522                 awk '{ total += $1 } END { printf("%0.0f", total) }')
6523
6524         # get server grant
6525         # which is tot_granted less grant_precreate
6526         server_grant=$(do_nodes $(comma_list $(osts_nodes)) \
6527                 "$LCTL get_param "\
6528                 "obdfilter.${FSNAME}-OST*.{tot_granted,tot_pending,grant_precreate}" |
6529                 sed 's/=/ /'| awk '/tot_granted/{ total += $2 };
6530                                 /tot_pending/{ total -= $2 };
6531                                 /grant_precreate/{ total -= $2 };
6532                                 END { printf("%0.0f", total) }')
6533
6534         # check whether client grant == server grant
6535         if [[ $client_grant -ne $server_grant ]]; then
6536                 do_nodes $(comma_list $(osts_nodes)) \
6537                         "$LCTL get_param obdfilter.${FSNAME}-OST*.tot*" \
6538                         "obdfilter.${FSNAME}-OST*.grant_*"
6539                 do_nodes $clients "$LCTL get_param osc.${FSNAME}-*.cur_*_bytes"
6540                 error "failed: client:${client_grant} server: ${server_grant}."
6541         else
6542                 echo "pass: client:${client_grant} server: ${server_grant}"
6543         fi
6544 }
6545
6546 ########################
6547 # helper functions
6548
6549 osc_to_ost()
6550 {
6551     osc=$1
6552     ost=`echo $1 | awk -F_ '{print $3}'`
6553     if [ -z $ost ]; then
6554         ost=`echo $1 | sed 's/-osc.*//'`
6555     fi
6556     echo $ost
6557 }
6558
6559 ostuuid_from_index()
6560 {
6561     $LFS osts $2 | sed -ne "/^$1: /s/.* \(.*\) .*$/\1/p"
6562 }
6563
6564 ostname_from_index() {
6565     local uuid=$(ostuuid_from_index $1)
6566     echo ${uuid/_UUID/}
6567 }
6568
6569 index_from_ostuuid()
6570 {
6571     $LFS osts $2 | sed -ne "/${1}/s/\(.*\): .* .*$/\1/p"
6572 }
6573
6574 mdtuuid_from_index()
6575 {
6576     $LFS mdts $2 | sed -ne "/^$1: /s/.* \(.*\) .*$/\1/p"
6577 }
6578
6579 # Description:
6580 #   Return unique identifier for given hostname
6581 host_id() {
6582         local host_name=$1
6583         echo $host_name | md5sum | cut -d' ' -f1
6584 }
6585
6586 # Description:
6587 #   Returns list of ip addresses for each interface
6588 local_addr_list() {
6589         ip addr | awk '/inet\ / {print $2}' | awk -F\/ '{print $1}'
6590 }
6591
6592 is_local_addr() {
6593         local addr=$1
6594         # Cache address list to avoid mutiple execution of local_addr_list
6595         LOCAL_ADDR_LIST=${LOCAL_ADDR_LIST:-$(local_addr_list)}
6596         local i
6597         for i in $LOCAL_ADDR_LIST ; do
6598                 [[ "$i" == "$addr" ]] && return 0
6599         done
6600         return 1
6601 }
6602
6603 local_node() {
6604         local host_name=$1
6605         local is_local="IS_LOCAL_$(host_id $host_name)"
6606         if [ -z "${!is_local-}" ] ; then
6607                 eval $is_local=0
6608                 local host_ip=$($LUSTRE/tests/resolveip $host_name)
6609                 is_local_addr "$host_ip" && eval $is_local=1
6610         fi
6611         [[ "${!is_local}" == "1" ]]
6612 }
6613
6614 remote_node () {
6615         local node=$1
6616         local_node $node && return 1
6617         return 0
6618 }
6619
6620 remote_mds ()
6621 {
6622     local node
6623     for node in $(mdts_nodes); do
6624         remote_node $node && return 0
6625     done
6626     return 1
6627 }
6628
6629 remote_mds_nodsh()
6630 {
6631         [ -n "$CLIENTONLY" ] && return 0 || true
6632         remote_mds && [ "$PDSH" = "no_dsh" -o -z "$PDSH" -o -z "$mds_HOST" ]
6633 }
6634
6635 require_dsh_mds()
6636 {
6637         remote_mds_nodsh && echo "SKIP: $TESTSUITE: remote MDS with nodsh" &&
6638                 MSKIPPED=1 && return 1
6639         return 0
6640 }
6641
6642 remote_ost ()
6643 {
6644     local node
6645     for node in $(osts_nodes) ; do
6646         remote_node $node && return 0
6647     done
6648     return 1
6649 }
6650
6651 remote_ost_nodsh()
6652 {
6653         [ -n "$CLIENTONLY" ] && return 0 || true
6654         remote_ost && [ "$PDSH" = "no_dsh" -o -z "$PDSH" -o -z "$ost_HOST" ]
6655 }
6656
6657 require_dsh_ost()
6658 {
6659         remote_ost_nodsh && echo "SKIP: $TESTSUITE: remote OST with nodsh" && \
6660             OSKIPPED=1 && return 1
6661         return 0
6662 }
6663
6664 remote_mgs_nodsh()
6665 {
6666         [ -n "$CLIENTONLY" ] && return 0 || true
6667         local MGS
6668         MGS=$(facet_host mgs)
6669         remote_node $MGS && [ "$PDSH" = "no_dsh" -o -z "$PDSH" -o -z "$ost_HOST" ]
6670 }
6671
6672 local_mode ()
6673 {
6674     remote_mds_nodsh || remote_ost_nodsh || \
6675         $(single_local_node $(comma_list $(nodes_list)))
6676 }
6677
6678 remote_servers () {
6679     remote_ost && remote_mds
6680 }
6681
6682 # Get the active nodes for facets.
6683 facets_nodes () {
6684         local facets=$1
6685         local facet
6686         local nodes
6687         local nodes_sort
6688         local i
6689
6690         for facet in ${facets//,/ }; do
6691                 nodes="$nodes $(facet_active_host $facet)"
6692         done
6693
6694         nodes_sort=$(for i in $nodes; do echo $i; done | sort -u)
6695         echo -n $nodes_sort
6696 }
6697
6698 # Get name of the active MGS node.
6699 mgs_node () {
6700         echo -n $(facets_nodes $(get_facets MGS))
6701 }
6702
6703 # Get all of the active MDS nodes.
6704 mdts_nodes () {
6705         echo -n $(facets_nodes $(get_facets MDS))
6706 }
6707
6708 # Get all of the active OSS nodes.
6709 osts_nodes () {
6710         echo -n $(facets_nodes $(get_facets OST))
6711 }
6712
6713 # Get all of the active AGT (HSM agent) nodes.
6714 agts_nodes () {
6715         echo -n $(facets_nodes $(get_facets AGT))
6716 }
6717
6718 # Get all of the client nodes and active server nodes.
6719 nodes_list () {
6720         local nodes=$HOSTNAME
6721         local nodes_sort
6722         local i
6723
6724         # CLIENTS (if specified) contains the local client
6725         [ -n "$CLIENTS" ] && nodes=${CLIENTS//,/ }
6726
6727         if [ "$PDSH" -a "$PDSH" != "no_dsh" ]; then
6728                 nodes="$nodes $(facets_nodes $(get_facets))"
6729         fi
6730
6731         nodes_sort=$(for i in $nodes; do echo $i; done | sort -u)
6732         echo -n $nodes_sort
6733 }
6734
6735 # Get all of the remote client nodes and remote active server nodes.
6736 remote_nodes_list () {
6737         echo -n $(nodes_list) | sed -re "s/\<$HOSTNAME\>//g"
6738 }
6739
6740 # Get all of the MDS nodes, including active and passive nodes.
6741 all_mdts_nodes () {
6742         local host
6743         local failover_host
6744         local nodes
6745         local nodes_sort
6746         local i
6747
6748         for i in $(seq $MDSCOUNT); do
6749                 host=mds${i}_HOST
6750                 failover_host=mds${i}failover_HOST
6751                 nodes="$nodes ${!host} ${!failover_host}"
6752         done
6753
6754         [ -n "$nodes" ] || nodes="${mds_HOST} ${mdsfailover_HOST}"
6755         nodes_sort=$(for i in $nodes; do echo $i; done | sort -u)
6756         echo -n $nodes_sort
6757 }
6758
6759 # Get all of the OSS nodes, including active and passive nodes.
6760 all_osts_nodes () {
6761         local host
6762         local failover_host
6763         local nodes=
6764         local nodes_sort
6765         local i
6766
6767         for i in $(seq $OSTCOUNT); do
6768                 host=ost${i}_HOST
6769                 failover_host=ost${i}failover_HOST
6770                 nodes="$nodes ${!host} ${!failover_host}"
6771         done
6772
6773         [ -n "$nodes" ] || nodes="${ost_HOST} ${ostfailover_HOST}"
6774         nodes_sort=$(for i in $nodes; do echo $i; done | sort -u)
6775         echo -n $nodes_sort
6776 }
6777
6778 # Get all of the server nodes, including active and passive nodes.
6779 all_server_nodes () {
6780         local nodes
6781         local nodes_sort
6782         local i
6783
6784         nodes="$mgs_HOST $mgsfailover_HOST $(all_mdts_nodes) $(all_osts_nodes)"
6785
6786         nodes_sort=$(for i in $nodes; do echo $i; done | sort -u)
6787         echo -n $nodes_sort
6788 }
6789
6790 # Get all of the client and server nodes, including active and passive nodes.
6791 all_nodes () {
6792         local nodes=$HOSTNAME
6793         local nodes_sort
6794         local i
6795
6796         # CLIENTS (if specified) contains the local client
6797         [ -n "$CLIENTS" ] && nodes=${CLIENTS//,/ }
6798
6799         if [ "$PDSH" -a "$PDSH" != "no_dsh" ]; then
6800                 nodes="$nodes $(all_server_nodes)"
6801         fi
6802
6803         nodes_sort=$(for i in $nodes; do echo $i; done | sort -u)
6804         echo -n $nodes_sort
6805 }
6806
6807 init_clients_lists () {
6808     # Sanity check: exclude the local client from RCLIENTS
6809     local clients=$(hostlist_expand "$RCLIENTS")
6810     local rclients=$(exclude_items_from_list "$clients" $HOSTNAME)
6811
6812     # Sanity check: exclude the dup entries
6813     RCLIENTS=$(for i in ${rclients//,/ }; do echo $i; done | sort -u)
6814
6815     clients="$SINGLECLIENT $HOSTNAME $RCLIENTS"
6816
6817     # Sanity check: exclude the dup entries from CLIENTS
6818     # for those configs which has SINGLCLIENT set to local client
6819     clients=$(for i in $clients; do echo $i; done | sort -u)
6820
6821     CLIENTS=$(comma_list $clients)
6822     local -a remoteclients=($RCLIENTS)
6823     for ((i=0; $i<${#remoteclients[@]}; i++)); do
6824             varname=CLIENT$((i + 2))
6825             eval $varname=${remoteclients[i]}
6826     done
6827
6828     CLIENTCOUNT=$((${#remoteclients[@]} + 1))
6829 }
6830
6831 get_random_entry () {
6832     local rnodes=$1
6833
6834     rnodes=${rnodes//,/ }
6835
6836     local -a nodes=($rnodes)
6837     local num=${#nodes[@]}
6838     local i=$((RANDOM * num * 2 / 65536))
6839
6840     echo ${nodes[i]}
6841 }
6842
6843 client_only () {
6844         [ -n "$CLIENTONLY" ] || [ "x$CLIENTMODSONLY" = "xyes" ]
6845 }
6846
6847 check_versions () {
6848     [ "$(lustre_version_code client)" = "$(lustre_version_code $SINGLEMDS)" -a \
6849       "$(lustre_version_code client)" = "$(lustre_version_code ost1)" ]
6850 }
6851
6852 get_node_count() {
6853     local nodes="$@"
6854     echo $nodes | wc -w || true
6855 }
6856
6857 mixed_ost_devs () {
6858     local nodes=$(osts_nodes)
6859     local osscount=$(get_node_count "$nodes")
6860     [ ! "$OSTCOUNT" = "$osscount" ]
6861 }
6862
6863 mixed_mdt_devs () {
6864     local nodes=$(mdts_nodes)
6865     local mdtcount=$(get_node_count "$nodes")
6866     [ ! "$MDSCOUNT" = "$mdtcount" ]
6867 }
6868
6869 generate_machine_file() {
6870     local nodes=${1//,/ }
6871     local machinefile=$2
6872     rm -f $machinefile
6873     for node in $nodes; do
6874         echo $node >>$machinefile || \
6875             { echo "can not generate machinefile $machinefile" && return 1; }
6876     done
6877 }
6878
6879 get_stripe () {
6880         local file=$1/stripe
6881
6882         touch $file
6883         $LFS getstripe -v $file || error "getstripe $file failed"
6884         rm -f $file
6885 }
6886
6887 setstripe_nfsserver () {
6888         local dir=$1
6889         local nfsexportdir=$2
6890         shift
6891         shift
6892
6893         local -a nfsexport=($(awk '"'$dir'" ~ $2 && $3 ~ "nfs" && $2 != "/" \
6894                 { print $1 }' /proc/mounts | cut -f 1 -d :))
6895
6896         # check that only one nfs mounted
6897         [[ -z $nfsexport ]] && echo "$dir is not nfs mounted" && return 1
6898         (( ${#nfsexport[@]} == 1 )) ||
6899                 error "several nfs mounts found for $dir: ${nfsexport[@]} !"
6900
6901         do_nodev ${nfsexport[0]} lfs setstripe $nfsexportdir "$@"
6902 }
6903
6904 # Check and add a test group.
6905 add_group() {
6906         local group_id=$1
6907         local group_name=$2
6908         local rc=0
6909
6910         local gid=$(getent group $group_name | cut -d: -f3)
6911         if [[ -n "$gid" ]]; then
6912                 [[ "$gid" -eq "$group_id" ]] || {
6913                         error_noexit "inconsistent group ID:" \
6914                                      "new: $group_id, old: $gid"
6915                         rc=1
6916                 }
6917         else
6918                 groupadd -g $group_id $group_name
6919                 rc=${PIPESTATUS[0]}
6920         fi
6921
6922         return $rc
6923 }
6924
6925 # Check and add a test user.
6926 add_user() {
6927         local user_id=$1
6928         shift
6929         local user_name=$1
6930         shift
6931         local group_name=$1
6932         shift
6933         local home=$1
6934         shift
6935         local opts="$@"
6936         local rc=0
6937
6938         local uid=$(getent passwd $user_name | cut -d: -f3)
6939         if [[ -n "$uid" ]]; then
6940                 if [[ "$uid" -eq "$user_id" ]]; then
6941                         local dir=$(getent passwd $user_name | cut -d: -f6)
6942                         if [[ "$dir" != "$home" ]]; then
6943                                 mkdir -p $home
6944                                 usermod -d $home $user_name
6945                                 rc=${PIPESTATUS[0]}
6946                         fi
6947                 else
6948                         error_noexit "inconsistent user ID:" \
6949                                      "new: $user_id, old: $uid"
6950                         rc=1
6951                 fi
6952         else
6953                 mkdir -p $home
6954                 useradd -M -u $user_id -d $home -g $group_name $opts $user_name
6955                 rc=${PIPESTATUS[0]}
6956         fi
6957
6958         return $rc
6959 }
6960
6961 check_runas_id_ret() {
6962     local myRC=0
6963     local myRUNAS_UID=$1
6964     local myRUNAS_GID=$2
6965     shift 2
6966     local myRUNAS=$@
6967     if [ -z "$myRUNAS" ]; then
6968         error_exit "myRUNAS command must be specified for check_runas_id"
6969     fi
6970     if $GSS_KRB5; then
6971         $myRUNAS krb5_login.sh || \
6972             error "Failed to refresh Kerberos V5 TGT for UID $myRUNAS_ID."
6973     fi
6974     mkdir $DIR/d0_runas_test
6975     chmod 0755 $DIR
6976     chown $myRUNAS_UID:$myRUNAS_GID $DIR/d0_runas_test
6977     $myRUNAS touch $DIR/d0_runas_test/f$$ || myRC=$?
6978     rm -rf $DIR/d0_runas_test
6979     return $myRC
6980 }
6981
6982 check_runas_id() {
6983     local myRUNAS_UID=$1
6984     local myRUNAS_GID=$2
6985     shift 2
6986     local myRUNAS=$@
6987     check_runas_id_ret $myRUNAS_UID $myRUNAS_GID $myRUNAS || \
6988         error "unable to write to $DIR/d0_runas_test as UID $myRUNAS_UID.
6989         Please set RUNAS_ID to some UID which exists on MDS and client or
6990         add user $myRUNAS_UID:$myRUNAS_GID on these nodes."
6991 }
6992
6993 # obtain the UID/GID for MPI_USER
6994 get_mpiuser_id() {
6995     local mpi_user=$1
6996
6997     MPI_USER_UID=$(do_facet client "getent passwd $mpi_user | cut -d: -f3;
6998 exit \\\${PIPESTATUS[0]}") || error_exit "failed to get the UID for $mpi_user"
6999
7000     MPI_USER_GID=$(do_facet client "getent passwd $mpi_user | cut -d: -f4;
7001 exit \\\${PIPESTATUS[0]}") || error_exit "failed to get the GID for $mpi_user"
7002 }
7003
7004 # obtain and cache Kerberos ticket-granting ticket
7005 refresh_krb5_tgt() {
7006     local myRUNAS_UID=$1
7007     local myRUNAS_GID=$2
7008     shift 2
7009     local myRUNAS=$@
7010     if [ -z "$myRUNAS" ]; then
7011         error_exit "myRUNAS command must be specified for refresh_krb5_tgt"
7012     fi
7013
7014     CLIENTS=${CLIENTS:-$HOSTNAME}
7015     do_nodes $CLIENTS "set -x
7016 if ! $myRUNAS krb5_login.sh; then
7017     echo "Failed to refresh Krb5 TGT for UID/GID $myRUNAS_UID/$myRUNAS_GID."
7018     exit 1
7019 fi"
7020 }
7021
7022 # Run multiop in the background, but wait for it to print
7023 # "PAUSING" to its stdout before returning from this function.
7024 multiop_bg_pause() {
7025     MULTIOP_PROG=${MULTIOP_PROG:-$MULTIOP}
7026     FILE=$1
7027     ARGS=$2
7028
7029     TMPPIPE=/tmp/multiop_open_wait_pipe.$$
7030     mkfifo $TMPPIPE
7031
7032     echo "$MULTIOP_PROG $FILE v$ARGS"
7033     $MULTIOP_PROG $FILE v$ARGS > $TMPPIPE &
7034
7035     echo "TMPPIPE=${TMPPIPE}"
7036     read -t 60 multiop_output < $TMPPIPE
7037     if [ $? -ne 0 ]; then
7038         rm -f $TMPPIPE
7039         return 1
7040     fi
7041     rm -f $TMPPIPE
7042     if [ "$multiop_output" != "PAUSING" ]; then
7043         echo "Incorrect multiop output: $multiop_output"
7044         kill -9 $PID
7045         return 1
7046     fi
7047
7048     return 0
7049 }
7050
7051 do_and_time () {
7052     local cmd=$1
7053     local rc
7054
7055     SECONDS=0
7056     eval '$cmd'
7057
7058     [ ${PIPESTATUS[0]} -eq 0 ] || rc=1
7059
7060     echo $SECONDS
7061     return $rc
7062 }
7063
7064 inodes_available () {
7065         local IFree=$($LFS df -i $MOUNT | grep ^$FSNAME | awk '{ print $4 }' |
7066                 sort -un | head -n1) || return 1
7067         echo $((IFree))
7068 }
7069
7070 mdsrate_inodes_available () {
7071         local min_inodes=$(inodes_available)
7072         echo $((min_inodes * 99 / 100))
7073 }
7074
7075 # reset stat counters
7076 clear_stats() {
7077         local paramfile="$1"
7078         lctl set_param -n $paramfile=0
7079 }
7080
7081 # sum stat items
7082 calc_stats() {
7083         local paramfile="$1"
7084         local stat="$2"
7085         lctl get_param -n $paramfile |
7086                 awk '/^'$stat'/ { sum += $2 } END { printf("%0.0f", sum) }'
7087 }
7088
7089 calc_sum () {
7090         awk '{sum += $1} END { printf("%0.0f", sum) }'
7091 }
7092
7093 calc_osc_kbytes () {
7094         $LFS df $MOUNT > /dev/null
7095         $LCTL get_param -n osc.*[oO][sS][cC][-_][0-9a-f]*.$1 | calc_sum
7096 }
7097
7098 # save_lustre_params(comma separated facet list, parameter_mask)
7099 # generate a stream of formatted strings (<facet> <param name>=<param value>)
7100 save_lustre_params() {
7101         local facets=$1
7102         local facet
7103         local facet_svc
7104
7105         for facet in ${facets//,/ }; do
7106                 facet_svc=$(facet_svc $facet)
7107                 do_facet $facet \
7108                         "params=\\\$($LCTL get_param $2);
7109                          [[ -z \\\"$facet_svc\\\" ]] && param= ||
7110                          param=\\\$(grep $facet_svc <<< \\\"\\\$params\\\");
7111                          [[ -z \\\$param ]] && param=\\\"\\\$params\\\";
7112                          while read s; do echo $facet \\\$s;
7113                          done <<< \\\"\\\$param\\\""
7114         done
7115 }
7116
7117 # restore lustre parameters from input stream, produces by save_lustre_params
7118 restore_lustre_params() {
7119         local facet
7120         local name
7121         local val
7122
7123         while IFS=" =" read facet name val; do
7124                 do_facet $facet "$LCTL set_param -n $name=$val"
7125         done
7126 }
7127
7128 check_node_health() {
7129         local nodes=${1:-$(comma_list $(nodes_list))}
7130
7131         for node in ${nodes//,/ }; do
7132                 check_network "$node" 5
7133                 if [ $? -eq 0 ]; then
7134                         do_node $node "rc=0;
7135                         val=\\\$($LCTL get_param -n catastrophe 2>&1);
7136                         if [[ \\\$? -eq 0 && \\\$val -ne 0 ]]; then
7137                                 echo \\\$(hostname -s): \\\$val;
7138                                 rc=\\\$val;
7139                         fi;
7140                         exit \\\$rc" || error "$node:LBUG/LASSERT detected"
7141                 fi
7142         done
7143 }
7144
7145 mdsrate_cleanup () {
7146         if [ -d $4 ]; then
7147                 mpi_run ${MACHINEFILE_OPTION} $2 -np $1 ${MDSRATE} --unlink \
7148                         --nfiles $3 --dir $4 --filefmt $5 $6
7149                 rmdir $4
7150         fi
7151 }
7152
7153 delayed_recovery_enabled () {
7154     local var=${SINGLEMDS}_svc
7155     do_facet $SINGLEMDS lctl get_param -n mdd.${!var}.stale_export_age > /dev/null 2>&1
7156 }
7157
7158 ########################
7159
7160 convert_facet2label() {
7161         local facet=$1
7162
7163         if [ x$facet = xost ]; then
7164                 facet=ost1
7165         elif [ x$facet = xmgs ] && combined_mgs_mds ; then
7166                 facet=mds1
7167         fi
7168
7169         local varsvc=${facet}_svc
7170
7171         if [ -n ${!varsvc} ]; then
7172                 echo ${!varsvc}
7173         else
7174                 error "No label for $facet!"
7175         fi
7176 }
7177
7178 get_clientosc_proc_path() {
7179         echo "${1}-osc-[-0-9a-f]*"
7180 }
7181
7182 # If the 2.0 MDS was mounted on 1.8 device, then the OSC and LOV names
7183 # used by MDT would not be changed.
7184 # mdt lov: fsname-mdtlov
7185 # mdt osc: fsname-OSTXXXX-osc
7186 mds_on_old_device() {
7187     local mds=${1:-"$SINGLEMDS"}
7188
7189     if [ $(lustre_version_code $mds) -gt $(version_code 1.9.0) ]; then
7190         do_facet $mds "lctl list_param osc.$FSNAME-OST*-osc \
7191             > /dev/null 2>&1" && return 0
7192     fi
7193     return 1
7194 }
7195
7196 get_mdtosc_proc_path() {
7197         local mds_facet=$1
7198         local ost_label=${2:-"*OST*"}
7199
7200         [ "$mds_facet" = "mds" ] && mds_facet=$SINGLEMDS
7201         local mdt_label=$(convert_facet2label $mds_facet)
7202         local mdt_index=$(echo $mdt_label | sed -e 's/^.*-//')
7203
7204         if [[ $ost_label = *OST* ]]; then
7205                 echo "${ost_label}-osc-${mdt_index}"
7206         else
7207                 echo "${ost_label}-osp-${mdt_index}"
7208         fi
7209 }
7210
7211 get_osc_import_name() {
7212     local facet=$1
7213     local ost=$2
7214     local label=$(convert_facet2label $ost)
7215
7216     if [ "${facet:0:3}" = "mds" ]; then
7217         get_mdtosc_proc_path $facet $label
7218         return 0
7219     fi
7220
7221     get_clientosc_proc_path $label
7222     return 0
7223 }
7224
7225 _wait_import_state () {
7226     local expected=$1
7227     local CONN_PROC=$2
7228     local maxtime=${3:-$(max_recovery_time)}
7229     local error_on_failure=${4:-1}
7230     local CONN_STATE
7231     local i=0
7232
7233         CONN_STATE=$($LCTL get_param -n $CONN_PROC 2>/dev/null | cut -f2 | uniq)
7234     while ! echo "${CONN_STATE}" | egrep -q "^${expected}\$" ; do
7235         if [ "${expected}" == "DISCONN" ]; then
7236             # for disconn we can check after proc entry is removed
7237             [ "x${CONN_STATE}" == "x" ] && return 0
7238             #  with AT enabled, we can have connect request timeout near of
7239             # reconnect timeout and test can't see real disconnect
7240             [ "${CONN_STATE}" == "CONNECTING" ] && return 0
7241         fi
7242         if [ $i -ge $maxtime ]; then
7243             [ $error_on_failure -ne 0 ] && \
7244                 error "can't put import for $CONN_PROC into ${expected}" \
7245                       "state after $i sec, have ${CONN_STATE}"
7246             return 1
7247         fi
7248         sleep 1
7249         # Add uniq for multi-mount case
7250         CONN_STATE=$($LCTL get_param -n $CONN_PROC 2>/dev/null | cut -f2 | uniq)
7251         i=$(($i + 1))
7252     done
7253
7254     log "$CONN_PROC in ${CONN_STATE} state after $i sec"
7255     return 0
7256 }
7257
7258 wait_import_state() {
7259     local state=$1
7260     local params=$2
7261     local maxtime=${3:-$(max_recovery_time)}
7262     local error_on_failure=${4:-1}
7263     local param
7264
7265     for param in ${params//,/ }; do
7266         _wait_import_state $state $param $maxtime $error_on_failure || return
7267     done
7268 }
7269
7270 wait_import_state_mount() {
7271         if ! is_mounted $MOUNT && ! is_mounted $MOUNT2; then
7272                 return 0
7273         fi
7274
7275         wait_import_state $*
7276 }
7277
7278 # One client request could be timed out because server was not ready
7279 # when request was sent by client.
7280 # The request timeout calculation details :
7281 # ptl_send_rpc ()
7282 #      /* We give the server rq_timeout secs to process the req, and
7283 #      add the network latency for our local timeout. */
7284 #      request->rq_deadline = request->rq_sent + request->rq_timeout +
7285 #           ptlrpc_at_get_net_latency(request) ;
7286 #
7287 # ptlrpc_connect_import ()
7288 #      request->rq_timeout = INITIAL_CONNECT_TIMEOUT
7289 #
7290 # init_imp_at () ->
7291 #   -> at_init(&at->iat_net_latency, 0, 0) -> iat_net_latency=0
7292 # ptlrpc_at_get_net_latency(request) ->
7293 #       at_get (max (iat_net_latency=0, at_min)) = at_min
7294 #
7295 # i.e.:
7296 # request->rq_timeout + ptlrpc_at_get_net_latency(request) =
7297 # INITIAL_CONNECT_TIMEOUT + at_min
7298 #
7299 # We will use obd_timeout instead of INITIAL_CONNECT_TIMEOUT
7300 # because we can not get this value in runtime,
7301 # the value depends on configure options, and it is not stored in /proc.
7302 # obd_support.h:
7303 # #define CONNECTION_SWITCH_MIN 5U
7304 # #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/20)
7305
7306 request_timeout () {
7307     local facet=$1
7308
7309     # request->rq_timeout = INITIAL_CONNECT_TIMEOUT
7310     local init_connect_timeout=$TIMEOUT
7311     [[ $init_connect_timeout -ge 5 ]] || init_connect_timeout=5
7312
7313     local at_min=$(at_get $facet at_min)
7314
7315     echo $(( init_connect_timeout + at_min ))
7316 }
7317
7318 _wait_osc_import_state() {
7319         local facet=$1
7320         local ost_facet=$2
7321         local expected=$3
7322         local target=$(get_osc_import_name $facet $ost_facet)
7323         local param="os[cp].${target}.ost_server_uuid"
7324         local params=$param
7325         local i=0
7326
7327         # 1. wait the deadline of client 1st request (it could be skipped)
7328         # 2. wait the deadline of client 2nd request
7329         local maxtime=$(( 2 * $(request_timeout $facet)))
7330
7331         if [[ $facet == client* ]]; then
7332                 # During setup time, the osc might not be setup, it need wait
7333                 # until list_param can return valid value.
7334                 params=$($LCTL list_param $param 2>/dev/null || true)
7335                 while [ -z "$params" ]; do
7336                         if [ $i -ge $maxtime ]; then
7337                                 echo "can't get $param in $maxtime secs"
7338                                 return 1
7339                         fi
7340                         sleep 1
7341                         i=$((i + 1))
7342                         params=$($LCTL list_param $param 2>/dev/null || true)
7343                 done
7344         fi
7345
7346         if [[ $ost_facet = mds* ]]; then
7347                 # no OSP connection to itself
7348                 if [[ $facet = $ost_facet ]]; then
7349                         return 0
7350                 fi
7351                 param="osp.${target}.mdt_server_uuid"
7352                 params=$param
7353         fi
7354
7355         if ! do_rpc_nodes "$(facet_active_host $facet)" \
7356                         wait_import_state $expected "$params" $maxtime; then
7357                 error "$facet: import is not in $expected state after $maxtime"
7358                 return 1
7359         fi
7360
7361         return 0
7362 }
7363
7364 wait_osc_import_state() {
7365         local facet=$1
7366         local ost_facet=$2
7367         local expected=$3
7368         local num
7369
7370         if [[ $facet = mds ]]; then
7371                 for num in $(seq $MDSCOUNT); do
7372                         _wait_osc_import_state mds$num "$ost_facet" "$expected"
7373                 done
7374         else
7375                 _wait_osc_import_state "$facet" "$ost_facet" "$expected"
7376         fi
7377 }
7378
7379 wait_osc_import_ready() {
7380         wait_osc_import_state $1 $2 "\(FULL\|IDLE\)"
7381 }
7382
7383 _wait_mgc_import_state() {
7384         local facet=$1
7385         local expected=$2
7386         local error_on_failure=${3:-1}
7387         local param="mgc.*.mgs_server_uuid"
7388         local params=$param
7389         local i=0
7390
7391         # 1. wait the deadline of client 1st request (it could be skipped)
7392         # 2. wait the deadline of client 2nd request
7393         local maxtime=$(( 2 * $(request_timeout $facet)))
7394
7395         if [[ $facet == client* ]]; then
7396                 # During setup time, the osc might not be setup, it need wait
7397                 # until list_param can return valid value. And also if there
7398                 # are mulitple osc entries we should list all of them before
7399                 # go to wait.
7400                 params=$($LCTL list_param $param 2>/dev/null || true)
7401                 while [ -z "$params" ]; do
7402                         if [ $i -ge $maxtime ]; then
7403                                 echo "can't get $param in $maxtime secs"
7404                                 return 1
7405                         fi
7406                         sleep 1
7407                         i=$((i + 1))
7408                         params=$($LCTL list_param $param 2>/dev/null || true)
7409                 done
7410         fi
7411         if ! do_rpc_nodes "$(facet_active_host $facet)" \
7412                         wait_import_state $expected "$params" $maxtime \
7413                                           $error_on_failure; then
7414                 if [ $error_on_failure -ne 0 ]; then
7415                     error "import is not in ${expected} state"
7416                 fi
7417                 return 1
7418         fi
7419
7420         return 0
7421 }
7422
7423 wait_mgc_import_state() {
7424         local facet=$1
7425         local expected=$2
7426         local error_on_failure=${3:-1}
7427         local num
7428
7429         if [[ $facet = mds ]]; then
7430                 for num in $(seq $MDSCOUNT); do
7431                         _wait_mgc_import_state mds$num "$expected" \
7432                                                $error_on_failure || return
7433                 done
7434         else
7435                 _wait_mgc_import_state "$facet" "$expected"
7436                                        $error_on_failure || return
7437         fi
7438 }
7439
7440 wait_dne_interconnect() {
7441         local num
7442
7443         if [ $MDSCOUNT -gt 1 ]; then
7444                 for num in $(seq $MDSCOUNT); do
7445                         wait_osc_import_ready mds mds$num
7446                 done
7447         fi
7448 }
7449
7450 get_clientmdc_proc_path() {
7451     echo "${1}-mdc-*"
7452 }
7453
7454 get_clientmgc_proc_path() {
7455     echo "*"
7456 }
7457
7458 do_rpc_nodes () {
7459         local list=$1
7460         shift
7461
7462         [ -z "$list" ] && return 0
7463
7464         # Add paths to lustre tests for 32 and 64 bit systems.
7465         local LIBPATH="/usr/lib/lustre/tests:/usr/lib64/lustre/tests:"
7466         local TESTPATH="$RLUSTRE/tests:"
7467         local RPATH="PATH=${TESTPATH}${LIBPATH}${PATH}:/sbin:/bin:/usr/sbin:"
7468         do_nodesv $list "${RPATH} NAME=${NAME} bash rpc.sh $@ "
7469 }
7470
7471 wait_clients_import_state () {
7472         local list=$1
7473         local facet=$2
7474         local expected=$3
7475
7476         local facets=$facet
7477
7478         if [ "$FAILURE_MODE" = HARD ]; then
7479                 facets=$(facets_on_host $(facet_active_host $facet))
7480         fi
7481
7482         for facet in ${facets//,/ }; do
7483                 local label=$(convert_facet2label $facet)
7484                 local proc_path
7485                 case $facet in
7486                 ost* ) proc_path="osc.$(get_clientosc_proc_path \
7487                                   $label).ost_server_uuid" ;;
7488                 mds* ) proc_path="mdc.$(get_clientmdc_proc_path \
7489                                   $label).mds_server_uuid" ;;
7490                 mgs* ) proc_path="mgc.$(get_clientmgc_proc_path \
7491                                   $label).mgs_server_uuid" ;;
7492                 *) error "unknown facet!" ;;
7493                 esac
7494
7495                 local params=$(expand_list $params $proc_path)
7496         done
7497
7498         if ! do_rpc_nodes "$list" wait_import_state_mount "$expected" $params;
7499         then
7500                 error "import is not in ${expected} state"
7501                 return 1
7502         fi
7503 }
7504
7505 wait_osp_active() {
7506         local facet=$1
7507         local tgt_name=$2
7508         local tgt_idx=$3
7509         local expected=$4
7510         local num
7511
7512         # wait until all MDTs are in the expected state
7513         for ((num = 1; num <= $MDSCOUNT; num++)); do
7514                 local mdtosp=$(get_mdtosc_proc_path mds${num} ${tgt_name})
7515                 local wait=0
7516                 local mproc
7517
7518                 if [ $facet = "mds" ]; then
7519                         mproc="osp.$mdtosp.active"
7520                         [ $num -eq $((tgt_idx + 1)) ] && continue
7521                 else
7522                         mproc="osc.$mdtosp.active"
7523                 fi
7524
7525                 echo "check $mproc"
7526                 while [ 1 ]; do
7527                         sleep 5
7528                         local result=$(do_facet mds${num} "$LCTL get_param -n $mproc")
7529                         local max=30
7530
7531                         [ ${PIPESTATUS[0]} = 0 ] || error "Can't read $mproc"
7532                         if [ $result -eq $expected ]; then
7533                                 echo -n "target updated after "
7534                                 echo "$wait sec (got $result)"
7535                                 break
7536                         fi
7537                         wait=$((wait + 5))
7538                         if [ $wait -eq $max ]; then
7539                                 error "$tgt_name: wanted $expected got $result"
7540                         fi
7541                         echo "Waiting $((max - wait)) secs for $tgt_name"
7542                 done
7543         done
7544 }
7545
7546 oos_full() {
7547         local -a AVAILA
7548         local -a GRANTA
7549         local -a TOTALA
7550         local OSCFULL=1
7551         AVAILA=($(do_nodes $(comma_list $(osts_nodes)) \
7552                   $LCTL get_param obdfilter.*.kbytesavail))
7553         GRANTA=($(do_nodes $(comma_list $(osts_nodes)) \
7554                   $LCTL get_param -n obdfilter.*.tot_granted))
7555         TOTALA=($(do_nodes $(comma_list $(osts_nodes)) \
7556                   $LCTL get_param -n obdfilter.*.kbytestotal))
7557         for ((i=0; i<${#AVAILA[@]}; i++)); do
7558                 local -a AVAIL1=(${AVAILA[$i]//=/ })
7559                 local -a TOTAL=(${TOTALA[$i]//=/ })
7560                 GRANT=$((${GRANTA[$i]}/1024))
7561                 # allow 1% of total space in bavail because of delayed
7562                 # allocation with ZFS which might release some free space after
7563                 # txg commit.  For small devices, we set a mininum of 8MB
7564                 local LIMIT=$((${TOTAL} / 100 + 8000))
7565                 echo -n $(echo ${AVAIL1[0]} | cut -d"." -f2) avl=${AVAIL1[1]} \
7566                         grnt=$GRANT diff=$((AVAIL1[1] - GRANT)) limit=${LIMIT}
7567                 [ $((AVAIL1[1] - GRANT)) -lt $LIMIT ] && OSCFULL=0 && \
7568                         echo " FULL" || echo
7569         done
7570         return $OSCFULL
7571 }
7572
7573 list_pool() {
7574         echo -e "$(do_facet $SINGLEMDS $LCTL pool_list $1 | sed '1d')"
7575 }
7576
7577 check_pool_not_exist() {
7578         local fsname=${1%%.*}
7579         local poolname=${1##$fsname.}
7580         [[ $# -ne 1 ]] && return 0
7581         [[ x$poolname = x ]] &&  return 0
7582         list_pool $fsname | grep -w $1 && return 1
7583         return 0
7584 }
7585
7586 create_pool() {
7587         local fsname=${1%%.*}
7588         local poolname=${1##$fsname.}
7589
7590         stack_trap "destroy_test_pools $fsname" EXIT
7591         do_facet mgs lctl pool_new $1
7592         local RC=$?
7593         # get param should return err unless pool is created
7594         [[ $RC -ne 0 ]] && return $RC
7595
7596         for mds_id in $(seq $MDSCOUNT); do
7597                 local mdt_id=$((mds_id-1))
7598                 local lodname=$fsname-MDT$(printf "%04x" $mdt_id)-mdtlov
7599                 wait_update_facet mds$mds_id \
7600                         "lctl get_param -n lod.$lodname.pools.$poolname \
7601                                 2>/dev/null || echo foo" "" ||
7602                         error "mds$mds_id: pool_new failed $1"
7603         done
7604         wait_update $HOSTNAME "lctl get_param -n lov.$fsname-*.pools.$poolname \
7605                 2>/dev/null || echo foo" "" || error "pool_new failed $1"
7606
7607         add_pool_to_list $1
7608         return $RC
7609 }
7610
7611 add_pool_to_list () {
7612         local fsname=${1%%.*}
7613         local poolname=${1##$fsname.}
7614
7615         local listvar=${fsname}_CREATED_POOLS
7616         local temp=${listvar}=$(expand_list ${!listvar} $poolname)
7617         eval export $temp
7618 }
7619
7620 remove_pool_from_list () {
7621         local fsname=${1%%.*}
7622         local poolname=${1##$fsname.}
7623
7624         local listvar=${fsname}_CREATED_POOLS
7625         local temp=${listvar}=$(exclude_items_from_list ${!listvar} $poolname)
7626         eval export $temp
7627 }
7628
7629 destroy_pool_int() {
7630         local ost
7631         local OSTS=$(list_pool $1)
7632         for ost in $OSTS; do
7633                 do_facet mgs lctl pool_remove $1 $ost
7634         done
7635         wait_update_facet $SINGLEMDS "lctl pool_list $1 | wc -l" "1" ||
7636                 error "MDS: pool_list $1 failed"
7637         do_facet mgs lctl pool_destroy $1
7638 }
7639
7640 # <fsname>.<poolname> or <poolname>
7641 destroy_pool() {
7642         local fsname=${1%%.*}
7643         local poolname=${1##$fsname.}
7644
7645         [[ x$fsname = x$poolname ]] && fsname=$FSNAME
7646
7647         local RC
7648
7649         check_pool_not_exist $fsname.$poolname
7650         [[ $? -eq 0 ]] && return 0
7651
7652         destroy_pool_int $fsname.$poolname
7653         RC=$?
7654         [[ $RC -ne 0 ]] && return $RC
7655         for mds_id in $(seq $MDSCOUNT); do
7656                 local mdt_id=$((mds_id-1))
7657                 local lodname=$fsname-MDT$(printf "%04x" $mdt_id)-mdtlov
7658                 wait_update_facet mds$mds_id \
7659                         "lctl get_param -n lod.$lodname.pools.$poolname \
7660                                 2>/dev/null || echo foo" "foo" ||
7661                         error "mds$mds_id: destroy pool failed $1"
7662         done
7663         wait_update $HOSTNAME "lctl get_param -n lov.$fsname-*.pools.$poolname \
7664                 2>/dev/null || echo foo" "foo" || error "destroy pool failed $1"
7665
7666         remove_pool_from_list $fsname.$poolname
7667
7668         return $RC
7669 }
7670
7671 destroy_pools () {
7672         local fsname=${1:-$FSNAME}
7673         local poolname
7674         local listvar=${fsname}_CREATED_POOLS
7675
7676         [ x${!listvar} = x ] && return 0
7677
7678         echo "Destroy the created pools: ${!listvar}"
7679         for poolname in ${!listvar//,/ }; do
7680                 destroy_pool $fsname.$poolname
7681         done
7682 }
7683
7684 destroy_test_pools () {
7685         trap 0
7686         local fsname=${1:-$FSNAME}
7687         destroy_pools $fsname || true
7688 }
7689
7690 gather_logs () {
7691     local list=$1
7692
7693     local ts=$(date +%s)
7694     local docp=true
7695
7696     if [[ ! -f "$YAML_LOG" ]]; then
7697         # init_logging is not performed before gather_logs,
7698         # so the $LOGDIR needs to be checked here
7699         check_shared_dir $LOGDIR && touch $LOGDIR/shared
7700     fi
7701
7702     [ -f $LOGDIR/shared ] && docp=false
7703
7704     # dump lustre logs, dmesg
7705
7706     prefix="$TESTLOG_PREFIX.$TESTNAME"
7707     suffix="$ts.log"
7708     echo "Dumping lctl log to ${prefix}.*.${suffix}"
7709
7710     if [ -n "$CLIENTONLY" -o "$PDSH" == "no_dsh" ]; then
7711         echo "Dumping logs only on local client."
7712         $LCTL dk > ${prefix}.debug_log.$(hostname -s).${suffix}
7713         dmesg > ${prefix}.dmesg.$(hostname -s).${suffix}
7714         return
7715     fi
7716
7717     do_nodesv $list \
7718         "$LCTL dk > ${prefix}.debug_log.\\\$(hostname -s).${suffix};
7719          dmesg > ${prefix}.dmesg.\\\$(hostname -s).${suffix}"
7720
7721     if [ ! -f $LOGDIR/shared ]; then
7722         do_nodes $list rsync -az "${prefix}.*.${suffix}" $HOSTNAME:$LOGDIR
7723     fi
7724 }
7725
7726 do_ls () {
7727     local mntpt_root=$1
7728     local num_mntpts=$2
7729     local dir=$3
7730     local i
7731     local cmd
7732     local pids
7733     local rc=0
7734
7735     for i in $(seq 0 $num_mntpts); do
7736         cmd="ls -laf ${mntpt_root}$i/$dir"
7737         echo + $cmd;
7738         $cmd > /dev/null &
7739         pids="$pids $!"
7740     done
7741     echo pids=$pids
7742     for pid in $pids; do
7743         wait $pid || rc=$?
7744     done
7745
7746     return $rc
7747 }
7748
7749 # check_and_start_recovery_timer()
7750 #       service_time = at_est2timeout(service_time);
7751 #       service_time += 2 * INITIAL_CONNECT_TIMEOUT;
7752 #       service_time += 2 * (CONNECTION_SWITCH_MAX + CONNECTION_SWITCH_INC);
7753
7754 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN, obd_timeout/20)
7755 #define CONNECTION_SWITCH_MAX min(50, max(CONNECTION_SWITCH_MIN, obd_timeout))
7756 #define CONNECTION_SWITCH_MIN 5
7757 #define CONNECTION_SWITCH_INC 5
7758 max_recovery_time() {
7759         local init_connect_timeout=$((TIMEOUT / 20))
7760         ((init_connect_timeout >= 5)) || init_connect_timeout=5
7761
7762         local service_time=$(($(at_max_get client) * 9 / 4 + 5))
7763         service_time=$((service_time + 2 * (init_connect_timeout + 50 + 5)))
7764
7765         echo -n $service_time
7766 }
7767
7768 recovery_time_min() {
7769         local connection_switch_min=5
7770         local connection_switch_inc=5
7771         local connection_switch_max
7772         local reconnect_delay_max
7773         local initial_connect_timeout
7774         local max
7775         local timout_20
7776
7777         #connection_switch_max=min(50, max($connection_switch_min,$TIMEOUT)
7778         (($connection_switch_min > $TIMEOUT)) &&
7779                 max=$connection_switch_min || max=$TIMEOUT
7780         (($max < 50)) && connection_switch_max=$max || connection_switch_max=50
7781
7782         #initial_connect_timeout = max(connection_switch_min, obd_timeout/20)
7783         timeout_20=$((TIMEOUT/20))
7784         (($connection_switch_min > $timeout_20)) &&
7785                 initial_connect_timeout=$connection_switch_min ||
7786                 initial_connect_timeout=$timeout_20
7787
7788         reconnect_delay_max=$((connection_switch_max + connection_switch_inc + \
7789                                initial_connect_timeout))
7790         echo $((2 * reconnect_delay_max))
7791 }
7792
7793 get_clients_mount_count () {
7794         local clients=${CLIENTS:-$HOSTNAME}
7795
7796         # we need to take into account the clients mounts and
7797         # exclude mds/ost mounts if any;
7798         do_nodes $clients cat /proc/mounts | grep lustre |
7799                 grep -w $MOUNT | wc -l
7800 }
7801
7802 # gss functions
7803 PROC_CLI="srpc_info"
7804 PROC_CON="srpc_contexts"
7805
7806 combination()
7807 {
7808     local M=$1
7809     local N=$2
7810     local R=1
7811
7812     if [ $M -lt $N ]; then
7813         R=0
7814     else
7815         N=$((N + 1))
7816         while [ $N -lt $M ]; do
7817             R=$((R * N))
7818             N=$((N + 1))
7819         done
7820     fi
7821
7822     echo $R
7823     return 0
7824 }
7825
7826 calc_connection_cnt() {
7827         local dir=$1
7828
7829         # MDT->MDT = 2 * C(M, 2)
7830         # MDT->OST = M * O
7831         # CLI->OST = C * O
7832         # CLI->MDT = C * M
7833         comb_m2=$(combination $MDSCOUNT 2)
7834
7835         local num_clients=$(get_clients_mount_count)
7836
7837         local cnt_mdt2mdt=$((comb_m2 * 2))
7838         local cnt_mdt2ost=$((MDSCOUNT * OSTCOUNT))
7839         local cnt_cli2ost=$((num_clients * OSTCOUNT))
7840         local cnt_cli2mdt=$((num_clients * MDSCOUNT))
7841         if is_mounted $MOUNT2; then
7842                 cnt_cli2mdt=$((cnt_cli2mdt * 2))
7843                 cnt_cli2ost=$((cnt_cli2ost * 2))
7844         fi
7845         if local_mode; then
7846                 cnt_mdt2mdt=0
7847                 cnt_mdt2ost=0
7848                 cnt_cli2ost=2
7849                 cnt_cli2mdt=1
7850         fi
7851         local cnt_all2ost=$((cnt_mdt2ost + cnt_cli2ost))
7852         local cnt_all2mdt=$((cnt_mdt2mdt + cnt_cli2mdt))
7853         local cnt_all2all=$((cnt_mdt2ost + cnt_mdt2mdt \
7854                 + cnt_cli2ost + cnt_cli2mdt))
7855
7856         local var=cnt_$dir
7857         local res=${!var}
7858
7859         echo $res
7860 }
7861
7862 set_rule()
7863 {
7864     local tgt=$1
7865     local net=$2
7866     local dir=$3
7867     local flavor=$4
7868     local cmd="$tgt.srpc.flavor"
7869
7870     if [ $net == "any" ]; then
7871         net="default"
7872     fi
7873     cmd="$cmd.$net"
7874
7875     if [ $dir != "any" ]; then
7876         cmd="$cmd.$dir"
7877     fi
7878
7879     cmd="$cmd=$flavor"
7880     log "Setting sptlrpc rule: $cmd"
7881     do_facet mgs "$LCTL conf_param $cmd"
7882 }
7883
7884 count_contexts()
7885 {
7886         local output=$1
7887         local total_ctx=$(echo "$output" | grep -c "expire.*key.*hdl")
7888         echo $total_ctx
7889 }
7890
7891 count_flvr()
7892 {
7893     local output=$1
7894     local flavor=$2
7895     local count=0
7896
7897     rpc_flvr=`echo $flavor | awk -F - '{ print $1 }'`
7898     bulkspec=`echo $flavor | awk -F - '{ print $2 }'`
7899
7900     count=`echo "$output" | grep "rpc flavor" | grep $rpc_flvr | wc -l`
7901
7902     if [ "x$bulkspec" != "x" ]; then
7903         algs=`echo $bulkspec | awk -F : '{ print $2 }'`
7904
7905         if [ "x$algs" != "x" ]; then
7906             bulk_count=`echo "$output" | grep "bulk flavor" | grep $algs | wc -l`
7907         else
7908             bulk=`echo $bulkspec | awk -F : '{ print $1 }'`
7909             if [ $bulk == "bulkn" ]; then
7910                 bulk_count=`echo "$output" | grep "bulk flavor" \
7911                             | grep "null/null" | wc -l`
7912             elif [ $bulk == "bulki" ]; then
7913                 bulk_count=`echo "$output" | grep "bulk flavor" \
7914                             | grep "/null" | grep -v "null/" | wc -l`
7915             else
7916                 bulk_count=`echo "$output" | grep "bulk flavor" \
7917                             | grep -v "/null" | grep -v "null/" | wc -l`
7918             fi
7919         fi
7920
7921         [ $bulk_count -lt $count ] && count=$bulk_count
7922     fi
7923
7924     echo $count
7925 }
7926
7927 flvr_cnt_cli2mdt()
7928 {
7929     local flavor=$1
7930     local cnt
7931
7932     local clients=${CLIENTS:-$HOSTNAME}
7933
7934     for c in ${clients//,/ }; do
7935         local output=$(do_node $c lctl get_param -n \
7936                  mdc.*-*-mdc-*.$PROC_CLI 2>/dev/null)
7937         local tmpcnt=$(count_flvr "$output" $flavor)
7938         if $GSS_SK && [ $flavor != "null" ]; then
7939                 # tmpcnt=min(contexts,flavors) to ensure SK context is on
7940                 output=$(do_node $c lctl get_param -n \
7941                          mdc.*-MDT*-mdc-*.$PROC_CON 2>/dev/null)
7942                 local outcon=$(count_contexts "$output")
7943                 if [ "$outcon" -lt "$tmpcnt" ]; then
7944                         tmpcnt=$outcon
7945                 fi
7946         fi
7947         cnt=$((cnt + tmpcnt))
7948     done
7949     echo $cnt
7950 }
7951
7952 flvr_cnt_cli2ost()
7953 {
7954     local flavor=$1
7955     local cnt
7956
7957     local clients=${CLIENTS:-$HOSTNAME}
7958
7959     for c in ${clients//,/ }; do
7960         # reconnect if idle
7961         do_node $c lctl set_param osc.*.idle_connect=1 >/dev/null 2>&1
7962         local output=$(do_node $c lctl get_param -n \
7963                  osc.*OST*-osc-[^M][^D][^T]*.$PROC_CLI 2>/dev/null)
7964         local tmpcnt=$(count_flvr "$output" $flavor)
7965         if $GSS_SK && [ $flavor != "null" ]; then
7966                 # tmpcnt=min(contexts,flavors) to ensure SK context is on
7967                 output=$(do_node $c lctl get_param -n \
7968                          osc.*OST*-osc-[^M][^D][^T]*.$PROC_CON 2>/dev/null)
7969                 local outcon=$(count_contexts "$output")
7970                 if [ "$outcon" -lt "$tmpcnt" ]; then
7971                         tmpcnt=$outcon
7972                 fi
7973         fi
7974         cnt=$((cnt + tmpcnt))
7975     done
7976     echo $cnt
7977 }
7978
7979 flvr_cnt_mdt2mdt()
7980 {
7981     local flavor=$1
7982     local cnt=0
7983
7984     if [ $MDSCOUNT -le 1 ]; then
7985         echo 0
7986         return
7987     fi
7988
7989     for num in `seq $MDSCOUNT`; do
7990         local output=$(do_facet mds$num lctl get_param -n \
7991                 osp.*-MDT*osp-MDT*.$PROC_CLI 2>/dev/null)
7992         local tmpcnt=$(count_flvr "$output" $flavor)
7993         if $GSS_SK && [ $flavor != "null" ]; then
7994                 # tmpcnt=min(contexts,flavors) to ensure SK context is on
7995                 output=$(do_facet mds$num lctl get_param -n \
7996                         osp.*-MDT*osp-MDT*.$PROC_CON 2>/dev/null)
7997                 local outcon=$(count_contexts "$output")
7998                 if [ "$outcon" -lt "$tmpcnt" ]; then
7999                         tmpcnt=$outcon
8000                 fi
8001         fi
8002         cnt=$((cnt + tmpcnt))
8003     done
8004     echo $cnt;
8005 }
8006
8007 flvr_cnt_mdt2ost()
8008 {
8009     local flavor=$1
8010     local cnt=0
8011     local mdtosc
8012
8013     for num in `seq $MDSCOUNT`; do
8014         mdtosc=$(get_mdtosc_proc_path mds$num)
8015         mdtosc=${mdtosc/-MDT*/-MDT\*}
8016         local output=$(do_facet mds$num lctl get_param -n \
8017                        os[cp].$mdtosc.$PROC_CLI 2>/dev/null)
8018         local tmpcnt=$(count_flvr "$output" $flavor)
8019         if $GSS_SK && [ $flavor != "null" ]; then
8020                 # tmpcnt=min(contexts,flavors) to ensure SK context is on
8021                 output=$(do_facet mds$num lctl get_param -n \
8022                          os[cp].$mdtosc.$PROC_CON 2>/dev/null)
8023                 local outcon=$(count_contexts "$output")
8024                 if [ "$outcon" -lt "$tmpcnt" ]; then
8025                         tmpcnt=$outcon
8026                 fi
8027         fi
8028         cnt=$((cnt + tmpcnt))
8029     done
8030     echo $cnt;
8031 }
8032
8033 flvr_cnt_mgc2mgs()
8034 {
8035     local flavor=$1
8036
8037     local output=$(do_facet client lctl get_param -n mgc.*.$PROC_CLI \
8038                         2>/dev/null)
8039     count_flvr "$output" $flavor
8040 }
8041
8042 do_check_flavor()
8043 {
8044     local dir=$1        # from to
8045     local flavor=$2     # flavor expected
8046     local res=0
8047
8048     if [ $dir == "cli2mdt" ]; then
8049         res=`flvr_cnt_cli2mdt $flavor`
8050     elif [ $dir == "cli2ost" ]; then
8051         res=`flvr_cnt_cli2ost $flavor`
8052     elif [ $dir == "mdt2mdt" ]; then
8053         res=`flvr_cnt_mdt2mdt $flavor`
8054     elif [ $dir == "mdt2ost" ]; then
8055         res=`flvr_cnt_mdt2ost $flavor`
8056     elif [ $dir == "all2ost" ]; then
8057         res1=`flvr_cnt_mdt2ost $flavor`
8058         res2=`flvr_cnt_cli2ost $flavor`
8059         res=$((res1 + res2))
8060     elif [ $dir == "all2mdt" ]; then
8061         res1=`flvr_cnt_mdt2mdt $flavor`
8062         res2=`flvr_cnt_cli2mdt $flavor`
8063         res=$((res1 + res2))
8064     elif [ $dir == "all2all" ]; then
8065         res1=`flvr_cnt_mdt2ost $flavor`
8066         res2=`flvr_cnt_cli2ost $flavor`
8067         res3=`flvr_cnt_mdt2mdt $flavor`
8068         res4=`flvr_cnt_cli2mdt $flavor`
8069         res=$((res1 + res2 + res3 + res4))
8070     fi
8071
8072     echo $res
8073 }
8074
8075 wait_flavor()
8076 {
8077         local dir=$1        # from to
8078         local flavor=$2     # flavor expected
8079         local expect=${3:-$(calc_connection_cnt $dir)} # number expected
8080         local WAITFLAVOR_MAX=20 # how many retries before abort?
8081
8082         local res=0
8083         for ((i = 0; i < $WAITFLAVOR_MAX; i++)); do
8084                 echo -n "checking $dir..."
8085                 res=$(do_check_flavor $dir $flavor)
8086                 echo "found $res/$expect $flavor connections"
8087                 [ $res -ge $expect ] && return 0
8088                 sleep 4
8089         done
8090
8091         echo "Error checking $flavor of $dir: expect $expect, actual $res"
8092 #       echo "Dumping additional logs for SK debug.."
8093         do_nodes $(comma_list $(all_server_nodes)) "keyctl show"
8094         if $dump; then
8095                 gather_logs $(comma_list $(nodes_list))
8096         fi
8097         return 1
8098 }
8099
8100 restore_to_default_flavor()
8101 {
8102         local proc="mgs.MGS.live.$FSNAME"
8103
8104         echo "restoring to default flavor..."
8105
8106         local nrule=$(do_facet mgs lctl get_param -n $proc 2>/dev/null |
8107                 grep ".srpc.flavor" | wc -l)
8108
8109         # remove all existing rules if any
8110         if [ $nrule -ne 0 ]; then
8111                 echo "$nrule existing rules"
8112                 for rule in $(do_facet mgs lctl get_param -n $proc 2>/dev/null |
8113                     grep ".srpc.flavor."); do
8114                         echo "remove rule: $rule"
8115                         spec=`echo $rule | awk -F = '{print $1}'`
8116                         do_facet mgs "$LCTL conf_param -d $spec"
8117                 done
8118         fi
8119
8120         # verify no rules left
8121         nrule=$(do_facet mgs lctl get_param -n $proc 2>/dev/null |
8122                 grep ".srpc.flavor." | wc -l)
8123         [ $nrule -ne 0 ] && error "still $nrule rules left"
8124
8125         # wait for default flavor to be applied
8126         if $GSS_SK; then
8127                 if $SK_S2S; then
8128                         set_rule $FSNAME any any $SK_FLAVOR
8129                         wait_flavor all2all $SK_FLAVOR
8130                 else
8131                         set_rule $FSNAME any cli2mdt $SK_FLAVOR
8132                         set_rule $FSNAME any cli2ost $SK_FLAVOR
8133                         wait_flavor cli2mdt $SK_FLAVOR
8134                         wait_flavor cli2ost $SK_FLAVOR
8135                 fi
8136                 echo "GSS_SK now at default flavor: $SK_FLAVOR"
8137         else
8138                 wait_flavor all2all null
8139         fi
8140 }
8141
8142 set_flavor_all()
8143 {
8144         local flavor=${1:-null}
8145
8146         echo "setting all flavor to $flavor"
8147
8148         # FIXME need parameter to this fn
8149         # and remove global vars
8150         local cnt_all2all=$(calc_connection_cnt all2all)
8151
8152         local res=$(do_check_flavor all2all $flavor)
8153         if [ $res -eq $cnt_all2all ]; then
8154                 echo "already have total $res $flavor connections"
8155                 return
8156         fi
8157
8158         echo "found $res $flavor out of total $cnt_all2all connections"
8159         restore_to_default_flavor
8160
8161         [[ $flavor = null ]] && return 0
8162
8163         if $GSS_SK && [ $flavor != "null" ]; then
8164                 if $SK_S2S; then
8165                         set_rule $FSNAME any any $flavor
8166                         wait_flavor all2all $flavor
8167                 else
8168                         set_rule $FSNAME any cli2mdt $flavor
8169                         set_rule $FSNAME any cli2ost $flavor
8170                         set_rule $FSNAME any mdt2ost null
8171                         set_rule $FSNAME any mdt2mdt null
8172                         wait_flavor cli2mdt $flavor
8173                         wait_flavor cli2ost $flavor
8174                 fi
8175                 echo "GSS_SK now at flavor: $flavor"
8176         else
8177                 set_rule $FSNAME any any $flavor
8178                 wait_flavor all2all $flavor
8179         fi
8180 }
8181
8182
8183 check_logdir() {
8184     local dir=$1
8185     # Checking for shared logdir
8186     if [ ! -d $dir ]; then
8187         # Not found. Create local logdir
8188         mkdir -p $dir
8189     else
8190         touch $dir/check_file.$(hostname -s)
8191     fi
8192     return 0
8193 }
8194
8195 check_write_access() {
8196         local dir=$1
8197         local list=${2:-$(comma_list $(nodes_list))}
8198         local node
8199         local file
8200
8201         for node in ${list//,/ }; do
8202                 file=$dir/check_file.$(short_nodename $node)
8203                 if [[ ! -f "$file" ]]; then
8204                         # Logdir not accessible/writable from this node.
8205                         return 1
8206                 fi
8207                 rm -f $file || return 1
8208         done
8209         return 0
8210 }
8211
8212 init_logging() {
8213         [[ -n $YAML_LOG ]] && return
8214         local save_umask=$(umask)
8215         umask 0000
8216
8217         export YAML_LOG=${LOGDIR}/results.yml
8218         mkdir -p $LOGDIR
8219         init_clients_lists
8220
8221         # If the yaml log already exists then we will just append to it
8222         if [ ! -f $YAML_LOG ]; then
8223                 if check_shared_dir $LOGDIR; then
8224                         touch $LOGDIR/shared
8225                         echo "Logging to shared log directory: $LOGDIR"
8226                 else
8227                         echo "Logging to local directory: $LOGDIR"
8228                 fi
8229
8230                 yml_nodes_file $LOGDIR >> $YAML_LOG
8231                 yml_results_file >> $YAML_LOG
8232         fi
8233
8234         umask $save_umask
8235
8236         # If modules are not yet loaded then older "lctl lustre_build_version"
8237         # will fail.  Use lctl build version instead.
8238         log "Client: $($LCTL lustre_build_version)"
8239         log "MDS: $(do_facet $SINGLEMDS $LCTL lustre_build_version 2>/dev/null||
8240                     do_facet $SINGLEMDS $LCTL --version)"
8241         log "OSS: $(do_facet ost1 $LCTL lustre_build_version 2> /dev/null ||
8242                     do_facet ost1 $LCTL --version)"
8243 }
8244
8245 log_test() {
8246     yml_log_test $1 >> $YAML_LOG
8247 }
8248
8249 log_test_status() {
8250      yml_log_test_status $@ >> $YAML_LOG
8251 }
8252
8253 log_sub_test_begin() {
8254     yml_log_sub_test_begin "$@" >> $YAML_LOG
8255 }
8256
8257 log_sub_test_end() {
8258     yml_log_sub_test_end "$@" >> $YAML_LOG
8259 }
8260
8261 run_llverdev()
8262 {
8263         local dev=$1
8264         local llverdev_opts=$2
8265         local devname=$(basename $1)
8266         local size=$(grep "$devname"$ /proc/partitions | awk '{print $3}')
8267         # loop devices aren't in /proc/partitions
8268         [ "x$size" == "x" ] && local size=$(ls -l $dev | awk '{print $5}')
8269
8270         size=$(($size / 1024 / 1024)) # Gb
8271
8272         local partial_arg=""
8273         # Run in partial (fast) mode if the size
8274         # of a partition > 1 GB
8275         [ $size -gt 1 ] && partial_arg="-p"
8276
8277         llverdev --force $partial_arg $llverdev_opts $dev
8278 }
8279
8280 run_llverfs()
8281 {
8282         local dir=$1
8283         local llverfs_opts=$2
8284         local use_partial_arg=$3
8285         local partial_arg=""
8286         local size=$(df -B G $dir |tail -n 1 |awk '{print $2}' |sed 's/G//') #GB
8287
8288         # Run in partial (fast) mode if the size
8289         # of a partition > 1 GB
8290         [ "x$use_partial_arg" != "xno" ] && [ $size -gt 1 ] && partial_arg="-p"
8291
8292         llverfs $partial_arg $llverfs_opts $dir
8293 }
8294
8295 #Remove objects from OST
8296 remove_ost_objects() {
8297         local facet=$1
8298         local ostdev=$2
8299         local group=$3
8300         shift 3
8301         local objids="$@"
8302         local mntpt=$(facet_mntpt $facet)
8303         local opts=$OST_MOUNT_OPTS
8304         local i
8305         local rc
8306
8307         echo "removing objects from $ostdev on $facet: $objids"
8308         if ! test -b $ostdev; then
8309                 opts=$(csa_add "$opts" -o loop)
8310         fi
8311         mount -t $(facet_fstype $facet) $opts $ostdev $mntpt ||
8312                 return $?
8313         rc=0
8314         for i in $objids; do
8315                 rm $mntpt/O/$group/d$((i % 32))/$i || { rc=$?; break; }
8316         done
8317         umount -f $mntpt || return $?
8318         return $rc
8319 }
8320
8321 #Remove files from MDT
8322 remove_mdt_files() {
8323         local facet=$1
8324         local mdtdev=$2
8325         shift 2
8326         local files="$@"
8327         local mntpt=$(facet_mntpt $facet)
8328         local opts=$MDS_MOUNT_OPTS
8329
8330         echo "removing files from $mdtdev on $facet: $files"
8331         if [ $(facet_fstype $facet) == ldiskfs ] &&
8332            ! do_facet $facet test -b $mdtdev; then
8333                 opts=$(csa_add "$opts" -o loop)
8334         fi
8335         mount -t $(facet_fstype $facet) $opts $mdtdev $mntpt ||
8336                 return $?
8337         rc=0
8338         for f in $files; do
8339                 rm $mntpt/ROOT/$f || { rc=$?; break; }
8340         done
8341         umount -f $mntpt || return $?
8342         return $rc
8343 }
8344
8345 duplicate_mdt_files() {
8346         local facet=$1
8347         local mdtdev=$2
8348         shift 2
8349         local files="$@"
8350         local mntpt=$(facet_mntpt $facet)
8351         local opts=$MDS_MOUNT_OPTS
8352
8353         echo "duplicating files on $mdtdev on $facet: $files"
8354         mkdir -p $mntpt || return $?
8355         if [ $(facet_fstype $facet) == ldiskfs ] &&
8356            ! do_facet $facet test -b $mdtdev; then
8357                 opts=$(csa_add "$opts" -o loop)
8358         fi
8359         mount -t $(facet_fstype $facet) $opts $mdtdev $mntpt ||
8360                 return $?
8361
8362     do_umount() {
8363         trap 0
8364         popd > /dev/null
8365         rm $tmp
8366         umount -f $mntpt
8367     }
8368     trap do_umount EXIT
8369
8370     tmp=$(mktemp $TMP/setfattr.XXXXXXXXXX)
8371     pushd $mntpt/ROOT > /dev/null || return $?
8372     rc=0
8373     for f in $files; do
8374         touch $f.bad || return $?
8375         getfattr -n trusted.lov $f | sed "s#$f#&.bad#" > $tmp
8376         rc=${PIPESTATUS[0]}
8377         [ $rc -eq 0 ] || return $rc
8378         setfattr --restore $tmp || return $?
8379     done
8380     do_umount
8381 }
8382
8383 run_sgpdd () {
8384     local devs=${1//,/ }
8385     shift
8386     local params=$@
8387     local rslt=$TMP/sgpdd_survey
8388
8389     # sgpdd-survey cleanups ${rslt}.* files
8390
8391     local cmd="rslt=$rslt $params scsidevs=\"$devs\" $SGPDDSURVEY"
8392     echo + $cmd
8393     eval $cmd
8394     cat ${rslt}.detail
8395 }
8396
8397 # returns the canonical name for an ldiskfs device
8398 ldiskfs_canon() {
8399         local dev="$1"
8400         local facet="$2"
8401
8402         do_facet $facet "dv=\\\$($LCTL get_param -n $dev);
8403                          if foo=\\\$(lvdisplay -c \\\$dv 2>/dev/null); then
8404                                 echo dm-\\\${foo##*:};
8405                          else
8406                                 name=\\\$(basename \\\$dv);
8407                                 if [[ \\\$name = *flakey* ]]; then
8408                                         name=\\\$(lsblk -o NAME,KNAME |
8409                                                 awk /\\\$name/'{print \\\$NF}');
8410                                 fi;
8411                                 echo \\\$name;
8412                          fi;"
8413 }
8414
8415 is_sanity_benchmark() {
8416     local benchmarks="dbench bonnie iozone fsx"
8417     local suite=$1
8418     for b in $benchmarks; do
8419         if [ "$b" == "$suite" ]; then
8420             return 0
8421         fi
8422     done
8423     return 1
8424 }
8425
8426 min_ost_size () {
8427         $LFS df | grep OST | awk '{print $4}' | sort -un | head -1
8428 }
8429
8430 #
8431 # Get the available size (KB) of a given obd target.
8432 #
8433 get_obd_size() {
8434         local facet=$1
8435         local obd=$2
8436         local size
8437
8438         [[ $facet != client ]] || return 0
8439
8440         size=$(do_facet $facet $LCTL get_param -n *.$obd.kbytesavail | head -n1)
8441         echo -n $size
8442 }
8443
8444 #
8445 # Get the page size (bytes) on a given facet node.
8446 # The local client page_size is directly available in PAGE_SIZE.
8447 #
8448 get_page_size() {
8449         local facet=$1
8450         local page_size=$(getconf PAGE_SIZE 2>/dev/null)
8451
8452         [ -z "$CLIENTONLY" -a "$facet" != "client" ] &&
8453                 page_size=$(do_facet $facet getconf PAGE_SIZE)
8454         echo -n ${page_size:-4096}
8455 }
8456
8457 #
8458 # Get the block count of the filesystem.
8459 #
8460 get_block_count() {
8461         local facet=$1
8462         local device=$2
8463         local count
8464
8465         [ -z "$CLIENTONLY" ] && count=$(do_facet $facet "$DUMPE2FS -h $device 2>&1" |
8466                 awk '/^Block count:/ {print $3}')
8467         echo -n ${count:-0}
8468 }
8469
8470 # Get the block size of the filesystem.
8471 get_block_size() {
8472         local facet=$1
8473         local device=$2
8474         local size
8475
8476         [ -z "$CLIENTONLY" ] && size=$(do_facet $facet "$DUMPE2FS -h $device 2>&1" |
8477                 awk '/^Block size:/ {print $3}')
8478         echo -n ${size:-0}
8479 }
8480
8481 # Check whether the "ea_inode" feature is enabled or not, to allow
8482 # ldiskfs xattrs over one block in size.  Allow both the historical
8483 # Lustre feature name (large_xattr) and the upstream name (ea_inode).
8484 large_xattr_enabled() {
8485         [[ $(facet_fstype $SINGLEMDS) == zfs ]] && return 0
8486
8487         local mds_dev=$(mdsdevname ${SINGLEMDS//mds/})
8488
8489         do_facet $SINGLEMDS "$DUMPE2FS -h $mds_dev 2>&1 |
8490                 grep -E -q '(ea_inode|large_xattr)'"
8491         return ${PIPESTATUS[0]}
8492 }
8493
8494 # Get the maximum xattr size supported by the filesystem.
8495 max_xattr_size() {
8496     local size
8497
8498     if large_xattr_enabled; then
8499         size=$($LCTL get_param -n llite.*.max_easize)
8500     else
8501         local mds_dev=$(mdsdevname ${SINGLEMDS//mds/})
8502         local block_size=$(get_block_size $SINGLEMDS $mds_dev)
8503
8504         # maximum xattr size = size of block - size of header -
8505         #                      size of 1 entry - 4 null bytes
8506         size=$((block_size - 32 - 32 - 4))
8507     fi
8508
8509     echo $size
8510 }
8511
8512 # Dump the value of the named xattr from a file.
8513 get_xattr_value() {
8514     local xattr_name=$1
8515     local file=$2
8516
8517     echo "$(getfattr -n $xattr_name --absolute-names --only-values $file)"
8518 }
8519
8520 # Generate a string with size of $size bytes.
8521 generate_string() {
8522     local size=${1:-1024} # in bytes
8523
8524     echo "$(head -c $size < /dev/zero | tr '\0' y)"
8525 }
8526
8527 reformat_external_journal() {
8528         local facet=$1
8529         local var
8530
8531         var=${facet}_JRN
8532         if [ -n "${!var}" ]; then
8533                 local rcmd="do_facet $facet"
8534
8535                 echo "reformat external journal on $facet:${!var}"
8536                 ${rcmd} mke2fs -O journal_dev ${!var} || return 1
8537         fi
8538 }
8539
8540 # MDT file-level backup/restore
8541 mds_backup_restore() {
8542         local facet=$1
8543         local igif=$2
8544         local devname=$(mdsdevname $(facet_number $facet))
8545         local mntpt=$(facet_mntpt brpt)
8546         local rcmd="do_facet $facet"
8547         local metaea=${TMP}/backup_restore.ea
8548         local metadata=${TMP}/backup_restore.tgz
8549         local opts=${MDS_MOUNT_OPTS}
8550         local svc=${facet}_svc
8551
8552         if ! ${rcmd} test -b ${devname}; then
8553                 opts=$(csa_add "$opts" -o loop)
8554         fi
8555
8556         echo "file-level backup/restore on $facet:${devname}"
8557
8558         # step 1: build mount point
8559         ${rcmd} mkdir -p $mntpt
8560         # step 2: cleanup old backup
8561         ${rcmd} rm -f $metaea $metadata
8562         # step 3: mount dev
8563         ${rcmd} mount -t ldiskfs $opts $devname $mntpt || return 1
8564         if [ ! -z $igif ]; then
8565                 # step 3.5: rm .lustre
8566                 ${rcmd} rm -rf $mntpt/ROOT/.lustre || return 1
8567         fi
8568         # step 4: backup metaea
8569         echo "backup EA"
8570         ${rcmd} "cd $mntpt && getfattr -R -d -m '.*' -P . > $metaea && cd -" ||
8571                 return 2
8572         # step 5: backup metadata
8573         echo "backup data"
8574         ${rcmd} tar zcf $metadata -C $mntpt/ . > /dev/null 2>&1 || return 3
8575         # step 6: umount
8576         ${rcmd} $UMOUNT $mntpt || return 4
8577         # step 8: reformat dev
8578         echo "reformat new device"
8579         format_mdt $(facet_number $facet)
8580         # step 9: mount dev
8581         ${rcmd} mount -t ldiskfs $opts $devname $mntpt || return 7
8582         # step 10: restore metadata
8583         echo "restore data"
8584         ${rcmd} tar zxfp $metadata -C $mntpt > /dev/null 2>&1 || return 8
8585         # step 11: restore metaea
8586         echo "restore EA"
8587         ${rcmd} "cd $mntpt && setfattr --restore=$metaea && cd - " || return 9
8588         # step 12: remove recovery logs
8589         echo "remove recovery logs"
8590         ${rcmd} rm -fv $mntpt/OBJECTS/* $mntpt/CATALOGS
8591         # step 13: umount dev
8592         ${rcmd} $UMOUNT $mntpt || return 10
8593         # step 14: cleanup tmp backup
8594         ${rcmd} rm -f $metaea $metadata
8595         # step 15: reset device label - it's not virgin on
8596         ${rcmd} e2label $devname ${!svc}
8597 }
8598
8599 # remove OI files
8600 mds_remove_ois() {
8601         local facet=$1
8602         local idx=$2
8603         local devname=$(mdsdevname $(facet_number $facet))
8604         local mntpt=$(facet_mntpt brpt)
8605         local rcmd="do_facet $facet"
8606         local opts=${MDS_MOUNT_OPTS}
8607
8608         if ! ${rcmd} test -b ${devname}; then
8609                 opts=$(csa_add "$opts" -o loop)
8610         fi
8611
8612         echo "removing OI files on $facet: idx=${idx}"
8613
8614         # step 1: build mount point
8615         ${rcmd} mkdir -p $mntpt
8616         # step 2: mount dev
8617         ${rcmd} mount -t ldiskfs $opts $devname $mntpt || return 1
8618         if [ -z $idx ]; then
8619                 # step 3: remove all OI files
8620                 ${rcmd} rm -fv $mntpt/oi.16*
8621         elif [ $idx -lt 2 ]; then
8622                 ${rcmd} rm -fv $mntpt/oi.16.${idx}
8623         else
8624                 local i
8625
8626                 # others, rm oi.16.[idx, idx * idx, idx ** ...]
8627                 for ((i=${idx}; i<64; i=$((i * idx)))); do
8628                         ${rcmd} rm -fv $mntpt/oi.16.${i}
8629                 done
8630         fi
8631         # step 4: umount
8632         ${rcmd} $UMOUNT $mntpt || return 2
8633         # OI files will be recreated when mounted as lustre next time.
8634 }
8635
8636 # generate maloo upload-able log file name
8637 # \param logname specify unique part of file name
8638 generate_logname() {
8639         local logname=${1:-"default_logname"}
8640
8641         echo "$TESTLOG_PREFIX.$TESTNAME.$logname.$(hostname -s).log"
8642 }
8643
8644 # make directory on different MDTs
8645 test_mkdir() {
8646         local path
8647         local p_option
8648         local dirstripe_count=${DIRSTRIPE_COUNT:-"2"}
8649         local dirstripe_index=${DIRSTRIPE_INDEX:-$((base % $MDSCOUNT))}
8650         local OPTIND=1
8651
8652         while getopts "c:i:p" opt; do
8653                 case $opt in
8654                         c) dirstripe_count=$OPTARG;;
8655                         i) dirstripe_index=$OPTARG;;
8656                         p) p_option="-p";;
8657                         \?) error "only support -i -c -p";;
8658                 esac
8659         done
8660
8661         shift $((OPTIND - 1))
8662         [ $# -eq 1 ] || error "Only creating single directory is supported"
8663         path="$*"
8664
8665         if [ "$p_option" == "-p" ]; then
8666                 local parent=$(dirname $path)
8667
8668                 [ -d $path ] && return 0
8669                 if [ ! -d ${parent} ]; then
8670                         mkdir -p ${parent} ||
8671                                 error "mkdir parent '$parent' failed"
8672                 fi
8673         fi
8674
8675         if [ $MDSCOUNT -le 1 ]; then
8676                 mkdir $path || error "mkdir '$path' failed"
8677         else
8678                 local mdt_index
8679
8680                 if [ $dirstripe_index -eq -1 ]; then
8681                         mdt_index=$((base % MDSCOUNT))
8682                 else
8683                         mdt_index=$dirstripe_index
8684                 fi
8685
8686                 if (($MDS1_VERSION >= $(version_code 2.8.0))); then
8687                         if [ $dirstripe_count -eq -1 ]; then
8688                                 dirstripe_count=$((RANDOM % MDSCOUNT + 1))
8689                         fi
8690                 else
8691                         dirstripe_count=1
8692                 fi
8693
8694                 echo "striped dir -i$mdt_index -c$dirstripe_count $path"
8695                 $LFS mkdir -i$mdt_index -c$dirstripe_count $path ||
8696                         error "mkdir -i $mdt_index -c$dirstripe_count $path failed"
8697         fi
8698 }
8699
8700 # free_fd: find the smallest and not in use file descriptor [above @last_fd]
8701 #
8702 # If called many times, passing @last_fd will avoid repeated searching
8703 # already-open FDs repeatedly if we know they are still in use.
8704 #
8705 # usage: free_fd [last_fd]
8706 free_fd()
8707 {
8708         local max_fd=$(ulimit -n)
8709         local fd=$((${1:-2} + 1))
8710
8711         while [[ $fd -le $max_fd && -e /proc/self/fd/$fd ]]; do
8712                 ((++fd))
8713         done
8714         [ $fd -lt $max_fd ] || error "finding free file descriptor failed"
8715         echo $fd
8716 }
8717
8718 check_mount_and_prep()
8719 {
8720         is_mounted $MOUNT || setupall
8721
8722         rm -rf $DIR/[df][0-9]* || error "Fail to cleanup the env!"
8723         mkdir $DIR/$tdir || error "Fail to mkdir $DIR/$tdir."
8724         for idx in $(seq $MDSCOUNT); do
8725                 local name="MDT$(printf '%04x' $((idx - 1)))"
8726                 rm -rf $MOUNT/.lustre/lost+found/$name/*
8727         done
8728 }
8729
8730 # calcule how many ost-objects to be created.
8731 precreated_ost_obj_count()
8732 {
8733         local mdt_idx=$1
8734         local ost_idx=$2
8735         local mdt_name="MDT$(printf '%04x' $mdt_idx)"
8736         local ost_name="OST$(printf '%04x' $ost_idx)"
8737         local proc_path="${FSNAME}-${ost_name}-osc-${mdt_name}"
8738         local last_id=$(do_facet mds$((mdt_idx + 1)) lctl get_param -n \
8739                         osp.$proc_path.prealloc_last_id)
8740         local next_id=$(do_facet mds$((mdt_idx + 1)) lctl get_param -n \
8741                         osp.$proc_path.prealloc_next_id)
8742         echo $((last_id - next_id + 1))
8743 }
8744
8745 check_file_in_pool()
8746 {
8747         local file=$1
8748         local pool=$2
8749         local tlist="$3"
8750         local res=$($GETSTRIPE $file | grep 0x | cut -f2)
8751         for i in $res
8752         do
8753                 for t in $tlist ; do
8754                         [ "$i" -eq "$t" ] && continue 2
8755                 done
8756
8757                 echo "pool list: $tlist"
8758                 echo "striping: $res"
8759                 error_noexit "$file not allocated in $pool"
8760                 return 1
8761         done
8762         return 0
8763 }
8764
8765 pool_add() {
8766         echo "Creating new pool"
8767         local pool=$1
8768
8769         create_pool $FSNAME.$pool ||
8770                 { error_noexit "No pool created, result code $?"; return 1; }
8771         [ $($LFS pool_list $FSNAME | grep -c "$FSNAME.${pool}\$") -eq 1 ] ||
8772                 { error_noexit "$pool not in lfs pool_list"; return 2; }
8773 }
8774
8775 pool_add_targets() {
8776         echo "Adding targets to pool"
8777         local pool=$1
8778         local first=$2
8779         local last=$3
8780         local step=${4:-1}
8781
8782         if [ -z $last ]; then
8783                 local list=$first
8784         else
8785                 local list=$(seq $first $step $last)
8786         fi
8787
8788         local t=$(for i in $list; do printf "$FSNAME-OST%04x_UUID " $i; done)
8789         do_facet mgs $LCTL pool_add \
8790                         $FSNAME.$pool $FSNAME-OST[$first-$last/$step]
8791
8792         # wait for OSTs to be added to the pool
8793         for mds_id in $(seq $MDSCOUNT); do
8794                 local mdt_id=$((mds_id-1))
8795                 local lodname=$FSNAME-MDT$(printf "%04x" $mdt_id)-mdtlov
8796                 wait_update_facet mds$mds_id \
8797                         "lctl get_param -n lod.$lodname.pools.$pool |
8798                                 sort -u | tr '\n' ' ' " "$t" || {
8799                         error_noexit "mds$mds_id: Add to pool failed"
8800                         return 3
8801                 }
8802         done
8803         wait_update $HOSTNAME "lctl get_param -n lov.$FSNAME-*.pools.$pool \
8804                         | sort -u | tr '\n' ' ' " "$t" || {
8805                 error_noexit "Add to pool failed"
8806                 return 1
8807         }
8808         local lfscount=$($LFS pool_list $FSNAME.$pool | grep -c "\-OST")
8809         local addcount=$(((last - first) / step + 1))
8810         [ $lfscount -eq $addcount ] || {
8811                 error_noexit "lfs pool_list bad ost count" \
8812                                                 "$lfscount != $addcount"
8813                 return 2
8814         }
8815 }
8816
8817 pool_set_dir() {
8818         local pool=$1
8819         local tdir=$2
8820         echo "Setting pool on directory $tdir"
8821
8822         $SETSTRIPE -c 2 -p $pool $tdir && return 0
8823
8824         error_noexit "Cannot set pool $pool to $tdir"
8825         return 1
8826 }
8827
8828 pool_check_dir() {
8829         local pool=$1
8830         local tdir=$2
8831         echo "Checking pool on directory $tdir"
8832
8833         local res=$($GETSTRIPE --pool $tdir | sed "s/\s*$//")
8834         [ "$res" = "$pool" ] && return 0
8835
8836         error_noexit "Pool on '$tdir' is '$res', not '$pool'"
8837         return 1
8838 }
8839
8840 pool_dir_rel_path() {
8841         echo "Testing relative path works well"
8842         local pool=$1
8843         local tdir=$2
8844         local root=$3
8845
8846         mkdir -p $root/$tdir/$tdir
8847         cd $root/$tdir
8848         pool_set_dir $pool $tdir          || return 1
8849         pool_set_dir $pool ./$tdir        || return 2
8850         pool_set_dir $pool ../$tdir       || return 3
8851         pool_set_dir $pool ../$tdir/$tdir || return 4
8852         rm -rf $tdir; cd - > /dev/null
8853 }
8854
8855 pool_alloc_files() {
8856         echo "Checking files allocation from directory pool"
8857         local pool=$1
8858         local tdir=$2
8859         local count=$3
8860         local tlist="$4"
8861
8862         local failed=0
8863         for i in $(seq -w 1 $count)
8864         do
8865                 local file=$tdir/file-$i
8866                 touch $file
8867                 check_file_in_pool $file $pool "$tlist" || \
8868                         failed=$((failed + 1))
8869         done
8870         [ "$failed" = 0 ] && return 0
8871
8872         error_noexit "$failed files not allocated in $pool"
8873         return 1
8874 }
8875
8876 pool_create_files() {
8877         echo "Creating files in pool"
8878         local pool=$1
8879         local tdir=$2
8880         local count=$3
8881         local tlist="$4"
8882
8883         mkdir -p $tdir
8884         local failed=0
8885         for i in $(seq -w 1 $count)
8886         do
8887                 local file=$tdir/spoo-$i
8888                 $SETSTRIPE -p $pool $file
8889                 check_file_in_pool $file $pool "$tlist" || \
8890                         failed=$((failed + 1))
8891         done
8892         [ "$failed" = 0 ] && return 0
8893
8894         error_noexit "$failed files not allocated in $pool"
8895         return 1
8896 }
8897
8898 pool_lfs_df() {
8899         echo "Checking 'lfs df' output"
8900         local pool=$1
8901
8902         local t=$($LCTL get_param -n lov.$FSNAME-clilov-*.pools.$pool |
8903                         tr '\n' ' ')
8904         local res=$($LFS df --pool $FSNAME.$pool |
8905                         awk '{print $1}' |
8906                         grep "$FSNAME-OST" |
8907                         tr '\n' ' ')
8908         [ "$res" = "$t" ] && return 0
8909
8910         error_noexit "Pools OSTs '$t' is not '$res' that lfs df reports"
8911         return 1
8912 }
8913
8914 pool_file_rel_path() {
8915         echo "Creating files in a pool with relative pathname"
8916         local pool=$1
8917         local tdir=$2
8918
8919         mkdir -p $tdir ||
8920                 { error_noexit "unable to create $tdir"; return 1 ; }
8921         local file="/..$tdir/$tfile-1"
8922         $SETSTRIPE -p $pool $file ||
8923                 { error_noexit "unable to create $file" ; return 2 ; }
8924
8925         cd $tdir
8926         $SETSTRIPE -p $pool $tfile-2 || {
8927                 error_noexit "unable to create $tfile-2 in $tdir"
8928                 return 3
8929         }
8930 }
8931
8932 pool_remove_first_target() {
8933         echo "Removing first target from a pool"
8934         local pool=$1
8935
8936         local pname="lov.$FSNAME-*.pools.$pool"
8937         local t=$($LCTL get_param -n $pname | head -1)
8938         do_facet mgs $LCTL pool_remove $FSNAME.$pool $t
8939         for mds_id in $(seq $MDSCOUNT); do
8940                 local mdt_id=$((mds_id-1))
8941                 local lodname=$FSNAME-MDT$(printf "%04x" $mdt_id)-mdtlov
8942                 wait_update_facet mds$mds_id \
8943                         "lctl get_param -n lod.$lodname.pools.$pool |
8944                                 grep $t" "" || {
8945                         error_noexit "mds$mds_id: $t not removed from" \
8946                         "$FSNAME.$pool"
8947                         return 2
8948                 }
8949         done
8950         wait_update $HOSTNAME "lctl get_param -n $pname | grep $t" "" || {
8951                 error_noexit "$t not removed from $FSNAME.$pool"
8952                 return 1
8953         }
8954 }
8955
8956 pool_remove_all_targets() {
8957         echo "Removing all targets from pool"
8958         local pool=$1
8959         local file=$2
8960         local pname="lov.$FSNAME-*.pools.$pool"
8961         for t in $($LCTL get_param -n $pname | sort -u)
8962         do
8963                 do_facet mgs $LCTL pool_remove $FSNAME.$pool $t
8964         done
8965         for mds_id in $(seq $MDSCOUNT); do
8966                 local mdt_id=$((mds_id-1))
8967                 local lodname=$FSNAME-MDT$(printf "%04x" $mdt_id)-mdtlov
8968                 wait_update_facet mds$mds_id "lctl get_param -n \
8969                         lod.$lodname.pools.$pool" "" || {
8970                         error_noexit "mds$mds_id: Pool $pool not drained"
8971                         return 4
8972                 }
8973         done
8974         wait_update $HOSTNAME "lctl get_param -n $pname" "" || {
8975                 error_noexit "Pool $FSNAME.$pool cannot be drained"
8976                 return 1
8977         }
8978         # striping on an empty/nonexistant pool should fall back
8979         # to "pool of everything"
8980         touch $file || {
8981                 error_noexit "failed to use fallback striping for empty pool"
8982                 return 2
8983         }
8984         # setstripe on an empty pool should fail
8985         $SETSTRIPE -p $pool $file 2>/dev/null && {
8986                 error_noexit "expected failure when creating file" \
8987                                                         "with empty pool"
8988                 return 3
8989         }
8990         return 0
8991 }
8992
8993 pool_remove() {
8994         echo "Destroying pool"
8995         local pool=$1
8996         local file=$2
8997
8998         do_facet mgs $LCTL pool_destroy $FSNAME.$pool
8999
9000         sleep 2
9001         # striping on an empty/nonexistant pool should fall back
9002         # to "pool of everything"
9003         touch $file || {
9004                 error_noexit "failed to use fallback striping for missing pool"
9005                 return 1
9006         }
9007         # setstripe on an empty pool should fail
9008         $SETSTRIPE -p $pool $file 2>/dev/null && {
9009                 error_noexit "expected failure when creating file" \
9010                                                         "with missing pool"
9011                 return 2
9012         }
9013
9014         # get param should return err once pool is gone
9015         if wait_update $HOSTNAME "lctl get_param -n \
9016                 lov.$FSNAME-*.pools.$pool 2>/dev/null || echo foo" "foo"
9017         then
9018                 remove_pool_from_list $FSNAME.$pool
9019                 return 0
9020         fi
9021         error_noexit "Pool $FSNAME.$pool is not destroyed"
9022         return 3
9023 }
9024
9025 # Get and check the actual stripe count of one file.
9026 # Usage: check_stripe_count <file> <expected_stripe_count>
9027 check_stripe_count() {
9028         local file=$1
9029         local expected=$2
9030         local actual
9031
9032         [[ -z "$file" || -z "$expected" ]] &&
9033                 error "check_stripe_count: invalid argument"
9034
9035         local cmd="$LFS getstripe -c $file"
9036         actual=$($cmd) || error "$cmd failed"
9037         actual=${actual%% *}
9038
9039         if [[ $actual -ne $expected ]]; then
9040                 [[ $expected -eq -1 ]] || { $LFS getstripe $file;
9041                         error "$cmd not expected ($expected): found $actual"; }
9042                 [[ $actual -eq $OSTCOUNT ]] || { $LFS getstripe $file;
9043                         error "$cmd not OST count ($OSTCOUNT): found $actual"; }
9044         fi
9045 }
9046
9047 # Get and check the actual list of OST indices on one file.
9048 # Usage: check_obdidx <file> <expected_comma_separated_list_of_ost_indices>
9049 check_obdidx() {
9050         local file=$1
9051         local expected=$2
9052         local obdidx
9053
9054         [[ -z "$file" || -z "$expected" ]] &&
9055                 error "check_obdidx: invalid argument!"
9056
9057         obdidx=$(comma_list $($GETSTRIPE $file | grep -A $OSTCOUNT obdidx |
9058                               grep -v obdidx | awk '{print $1}' | xargs))
9059
9060         [[ $obdidx = $expected ]] ||
9061                 error "list of OST indices on $file is $obdidx," \
9062                       "should be $expected"
9063 }
9064
9065 # Get and check the actual OST index of the first stripe on one file.
9066 # Usage: check_start_ost_idx <file> <expected_start_ost_idx>
9067 check_start_ost_idx() {
9068         local file=$1
9069         local expected=$2
9070         local start_ost_idx
9071
9072         [[ -z "$file" || -z "$expected" ]] &&
9073                 error "check_start_ost_idx: invalid argument!"
9074
9075         start_ost_idx=$($GETSTRIPE $file | grep -A 1 obdidx | grep -v obdidx |
9076                         awk '{print $1}')
9077
9078         [[ $start_ost_idx = $expected ]] ||
9079                 error "OST index of the first stripe on $file is" \
9080                       "$start_ost_idx, should be $expected"
9081 }
9082
9083 killall_process () {
9084         local clients=${1:-$(hostname)}
9085         local name=$2
9086         local signal=$3
9087         local rc=0
9088
9089         do_nodes $clients "killall $signal $name"
9090 }
9091
9092 lsnapshot_create()
9093 {
9094         do_facet mgs "$LCTL snapshot_create -F $FSNAME $*"
9095 }
9096
9097 lsnapshot_destroy()
9098 {
9099         do_facet mgs "$LCTL snapshot_destroy -F $FSNAME $*"
9100 }
9101
9102 lsnapshot_modify()
9103 {
9104         do_facet mgs "$LCTL snapshot_modify -F $FSNAME $*"
9105 }
9106
9107 lsnapshot_list()
9108 {
9109         do_facet mgs "$LCTL snapshot_list -F $FSNAME $*"
9110 }
9111
9112 lsnapshot_mount()
9113 {
9114         do_facet mgs "$LCTL snapshot_mount -F $FSNAME $*"
9115 }
9116
9117 lsnapshot_umount()
9118 {
9119         do_facet mgs "$LCTL snapshot_umount -F $FSNAME $*"
9120 }
9121
9122 lss_err()
9123 {
9124         local msg=$1
9125
9126         do_facet mgs "cat $LSNAPSHOT_LOG"
9127         error $msg
9128 }
9129
9130 lss_cleanup()
9131 {
9132         echo "Cleaning test environment ..."
9133
9134         # Every lsnapshot command takes exclusive lock with others,
9135         # so can NOT destroy the snapshot during list with 'xargs'.
9136         while true; do
9137                 local ssname=$(lsnapshot_list | grep snapshot_name |
9138                         grep lss_ | awk '{ print $2 }' | head -n 1)
9139                 [ -z "$ssname" ] && break
9140
9141                 lsnapshot_destroy -n $ssname -f ||
9142                         lss_err "Fail to destroy $ssname by force"
9143         done
9144 }
9145
9146 lss_gen_conf_one()
9147 {
9148         local facet=$1
9149         local role=$2
9150         local idx=$3
9151
9152         local host=$(facet_active_host $facet)
9153         local dir=$(dirname $(facet_vdevice $facet))
9154         local pool=$(zpool_name $facet)
9155         local lfsname=$(zfs_local_fsname $facet)
9156         local label=${FSNAME}-${role}$(printf '%04x' $idx)
9157
9158         do_facet mgs \
9159                 "echo '$host - $label zfs:${dir}/${pool}/${lfsname} - -' >> \
9160                 $LSNAPSHOT_CONF"
9161 }
9162
9163 lss_gen_conf()
9164 {
9165         do_facet mgs "rm -f $LSNAPSHOT_CONF"
9166         echo "Generating $LSNAPSHOT_CONF on MGS ..."
9167
9168         if ! combined_mgs_mds ; then
9169                 [ $(facet_fstype mgs) != zfs ] &&
9170                         skip "Lustre snapshot 1 only works for ZFS backend"
9171
9172                 local host=$(facet_active_host mgs)
9173                 local dir=$(dirname $(facet_vdevice mgs))
9174                 local pool=$(zpool_name mgs)
9175                 local lfsname=$(zfs_local_fsname mgs)
9176
9177                 do_facet mgs \
9178                         "echo '$host - MGS zfs:${dir}/${pool}/${lfsname} - -' \
9179                         >> $LSNAPSHOT_CONF" || lss_err "generate lss conf (mgs)"
9180         fi
9181
9182         for num in `seq $MDSCOUNT`; do
9183                 [ $(facet_fstype mds$num) != zfs ] &&
9184                         skip "Lustre snapshot 1 only works for ZFS backend"
9185
9186                 lss_gen_conf_one mds$num MDT $((num - 1)) ||
9187                         lss_err "generate lss conf (mds$num)"
9188         done
9189
9190         for num in `seq $OSTCOUNT`; do
9191                 [ $(facet_fstype ost$num) != zfs ] &&
9192                         skip "Lustre snapshot 1 only works for ZFS backend"
9193
9194                 lss_gen_conf_one ost$num OST $((num - 1)) ||
9195                         lss_err "generate lss conf (ost$num)"
9196         done
9197
9198         do_facet mgs "cat $LSNAPSHOT_CONF"
9199 }
9200
9201 # Parse 'lfs getstripe -d <path_with_dir_name>' for non-composite dir
9202 parse_plain_dir_param()
9203 {
9204         local invalues=($1)
9205         local param=""
9206
9207         if [[ ${invalues[0]} =~ "stripe_count:" ]]; then
9208                 param="-c ${invalues[1]}"
9209         fi
9210         if [[ ${invalues[2]} =~ "stripe_size:" ]]; then
9211                 param="$param -S ${invalues[3]}"
9212         fi
9213         if [[ ${invalues[4]} =~ "pattern:" ]]; then
9214                 if [[ ${invalues[5]} =~ "stripe_offset:" ]]; then
9215                         param="$param -i ${invalues[6]}"
9216                 else
9217                         param="$param -L ${invalues[5]} -i ${invalues[7]}"
9218                 fi
9219         elif [[ ${invalues[4]} =~ "stripe_offset:" ]]; then
9220                 param="$param -i ${invalues[5]}"
9221         fi
9222         echo "$param"
9223 }
9224
9225 parse_plain_param()
9226 {
9227         local line=$1
9228         local val=$(awk '{print $2}' <<< $line)
9229
9230         if [[ $line =~ ^"lmm_stripe_count:" ]]; then
9231                 echo "-c $val"
9232         elif [[ $line =~ ^"lmm_stripe_size:" ]]; then
9233                 echo "-S $val"
9234         elif [[ $line =~ ^"lmm_stripe_offset:" ]]; then
9235                 echo "-i $val"
9236         elif [[ $line =~ ^"lmm_pattern:" ]]; then
9237                 echo "-L $val"
9238         fi
9239 }
9240
9241 parse_layout_param()
9242 {
9243         local mode=""
9244         local val=""
9245         local param=""
9246
9247         while read line; do
9248                 if [[ ! -z $line ]]; then
9249                         if [[ -z $mode ]]; then
9250                                 if [[ $line =~ ^"stripe_count:" ]]; then
9251                                         mode="plain_dir"
9252                                 elif [[ $line =~ ^"lmm_stripe_count:" ]]; then
9253                                         mode="plain_file"
9254                                 elif [[ $line =~ ^"lcm_layout_gen:" ]]; then
9255                                         mode="pfl"
9256                                 fi
9257                         fi
9258
9259                         if [[ $mode = "plain_dir" ]]; then
9260                                 param=$(parse_plain_dir_param "$line")
9261                         elif [[ $mode = "plain_file" ]]; then
9262                                 val=$(parse_plain_param "$line")
9263                                 [[ ! -z $val ]] && param="$param $val"
9264                         elif [[ $mode = "pfl" ]]; then
9265                                 val=$(echo $line | awk '{print $2}')
9266                                 if [[ $line =~ ^"lcme_extent.e_end:" ]]; then
9267                                         if [[ $val = "EOF" ]]; then
9268                                                 param="$param -E -1"
9269                                         else
9270                                                 param="$param -E $val"
9271                                         fi
9272                                 elif [[ $line =~ ^"stripe_count:" ]]; then
9273                                         # pfl dir
9274                                         val=$(parse_plain_dir_param "$line")
9275                                         param="$param $val"
9276                                 else
9277                                         #pfl file
9278                                         val=$(parse_plain_param "$line")
9279                                         [[ ! -z $val ]] && param="$param $val"
9280                                 fi
9281                         fi
9282                 fi
9283         done
9284         echo "$param"
9285 }
9286
9287 get_layout_param()
9288 {
9289         local param=$($LFS getstripe -d $1 | parse_layout_param)
9290         echo "$param"
9291 }
9292
9293 lfsck_verify_pfid()
9294 {
9295         local f
9296         local rc=0
9297
9298         # Cancel locks before setting lfsck_verify_pfid so that errors are more
9299         # controllable
9300         cancel_lru_locks mdc
9301         cancel_lru_locks osc
9302
9303         # make sure PFID is set correctly for files
9304         do_nodes $(comma_list $(osts_nodes)) \
9305                "$LCTL set_param -n obdfilter.${FSNAME}-OST*.lfsck_verify_pfid=1"
9306
9307         for f in "$@"; do
9308                 cat $f &> /dev/nullA ||
9309                         { rc=$?; echo "verify $f failed"; break; }
9310         done
9311
9312         do_nodes $(comma_list $(osts_nodes)) \
9313                "$LCTL set_param -n obdfilter.${FSNAME}-OST*.lfsck_verify_pfid=0"
9314         return $rc
9315 }
9316
9317 # check that clients "oscs" was evicted after "before"
9318 check_clients_evicted() {
9319         local before=$1
9320         shift
9321         local oscs=${@}
9322         local osc
9323         local rc=0
9324
9325         for osc in $oscs; do
9326                 ((rc++))
9327                 echo "Check state for $osc"
9328                 local evicted=$(do_facet client $LCTL get_param osc.$osc.state |
9329                         tail -n 3 | awk -F"[ [,]" \
9330                         '/EVICTED ]$/ { if (mx<$5) {mx=$5;} } END { print mx }')
9331                 if (($? == 0)) && (($evicted > $before)); then
9332                         echo "$osc is evicted at $evicted"
9333                         ((rc--))
9334                 fi
9335         done
9336
9337         [ $rc -eq 0 ] || error "client not evicted from OST"
9338 }
9339
9340 # check that clients OSCS current_state is FULL
9341 check_clients_full() {
9342         local timeout=$1
9343         shift
9344         local oscs=${@}
9345
9346         for osc in $oscs; do
9347                 wait_update_facet client \
9348                         "lctl get_param -n osc.$osc.state |
9349                         grep 'current_state: FULL'" \
9350                         "current_state: FULL" $timeout
9351                 [ $? -eq 0 ] || error "$osc state is not FULL"
9352         done
9353 }
9354
9355 #Changelogs
9356 __changelog_deregister() {
9357         local facet=$1
9358         local mdt="$(facet_svc $facet)"
9359         local cl_user=$2
9360         local rc=0
9361
9362         # skip cleanup if no user registered for this MDT
9363         [ -z "$cl_user" ] && echo "$mdt: no changelog user" && return 0
9364         # user is no longer registered, skip cleanup
9365         changelog_users "$facet" | grep -q "$cl_user" ||
9366                 { echo "$mdt: changelog user '$cl_user' not found"; return 0; }
9367
9368         # From this point, if any operation fails, it is an error
9369         __changelog_clear $facet $cl_user 0 ||
9370                 error_noexit "$mdt: changelog_clear $cl_user 0 fail: $rc"
9371         do_facet $facet $LCTL --device $mdt changelog_deregister $cl_user ||
9372                 error_noexit "$mdt: changelog_deregister '$cl_user' fail: $rc"
9373 }
9374
9375 declare -Ax CL_USERS
9376 changelog_register() {
9377         for M in $(seq $MDSCOUNT); do
9378                 local facet=mds$M
9379                 local mdt="$(facet_svc $facet)"
9380                 local cl_mask
9381
9382                 cl_mask=$(do_facet $facet $LCTL get_param \
9383                              mdd.${mdt}.changelog_mask -n)
9384                 stack_trap "do_facet $facet $LCTL \
9385                         set_param mdd.$mdt.changelog_mask=\'$cl_mask\' -n" EXIT
9386                 do_facet $facet $LCTL set_param mdd.$mdt.changelog_mask=+hsm ||
9387                         error "$mdt: changelog_mask=+hsm failed: $?"
9388
9389                 local cl_user
9390                 cl_user=$(do_facet $facet \
9391                                   $LCTL --device $mdt changelog_register -n) ||
9392                         error "$mdt: register changelog user failed: $?"
9393                 stack_trap "__changelog_deregister $facet $cl_user" EXIT
9394
9395                 stack_trap "CL_USERS[$facet]='${CL_USERS[$facet]}'" EXIT
9396                 # Bash does not support nested arrays, but the format of a
9397                 # cl_user is constrained enough to use whitespaces as separators
9398                 CL_USERS[$facet]+="$cl_user "
9399         done
9400         echo "Registered $MDSCOUNT changelog users: '${CL_USERS[@]% }'"
9401 }
9402
9403 changelog_deregister() {
9404         local cl_user
9405         # bash assoc arrays do not guarantee to list keys in created order
9406         # so reorder to get same order than in changelog_register()
9407         local cl_facets=$(echo "${!CL_USERS[@]}" | tr " " "\n" | sort |
9408                           tr "\n" " ")
9409
9410         for facet in $cl_facets; do
9411                 for cl_user in ${CL_USERS[$facet]}; do
9412                         __changelog_deregister $facet $cl_user || return $?
9413                 done
9414                 unset CL_USERS[$facet]
9415         done
9416 }
9417
9418 changelog_users() {
9419         local facet=$1
9420         local service=$(facet_svc $facet)
9421
9422         do_facet $facet $LCTL get_param -n mdd.$service.changelog_users
9423 }
9424
9425 changelog_user_rec() {
9426         local facet=$1
9427         local cl_user=$2
9428         local service=$(facet_svc $facet)
9429
9430         changelog_users $facet | awk '$1 == "'$cl_user'" { print $2 }'
9431 }
9432
9433 changelog_chmask() {
9434         local mask=$1
9435
9436         do_nodes $(comma_list $(mdts_nodes)) \
9437                 $LCTL set_param mdd.*.changelog_mask="$mask"
9438 }
9439
9440 # usage: __changelog_clear FACET CL_USER [+]INDEX
9441 __changelog_clear()
9442 {
9443         local facet=$1
9444         local mdt="$(facet_svc $facet)"
9445         local cl_user=$2
9446         local -i rec
9447
9448         case "$3" in
9449         +*)
9450                 # Remove the leading '+'
9451                 rec=${3:1}
9452                 rec+=$(changelog_user_rec $facet $cl_user)
9453                 ;;
9454         *)
9455                 rec=$3
9456                 ;;
9457         esac
9458
9459         if [ $rec -eq 0 ]; then
9460                 echo "$mdt: clear the changelog for $cl_user of all records"
9461         else
9462                 echo "$mdt: clear the changelog for $cl_user to record #$rec"
9463         fi
9464         $LFS changelog_clear $mdt $cl_user $rec
9465 }
9466
9467 # usage: changelog_clear [+]INDEX
9468 #
9469 # If INDEX is prefixed with '+', increment every changelog user's record index
9470 # by INDEX. Otherwise, clear the changelog up to INDEX for every changelog
9471 # users.
9472 changelog_clear() {
9473         local rc
9474         # bash assoc arrays do not guarantee to list keys in created order
9475         # so reorder to get same order than in changelog_register()
9476         local cl_facets=$(echo "${!CL_USERS[@]}" | tr " " "\n" | sort |
9477                           tr "\n" " ")
9478
9479         for facet in $cl_facets; do
9480                 for cl_user in ${CL_USERS[$facet]}; do
9481                         __changelog_clear $facet $cl_user $1 || rc=${rc:-$?}
9482                 done
9483         done
9484
9485         return ${rc:-0}
9486 }
9487
9488 changelog_dump() {
9489         for M in $(seq $MDSCOUNT); do
9490                 local facet=mds$M
9491                 local mdt="$(facet_svc $facet)"
9492
9493                 $LFS changelog $mdt | sed -e 's/^/'$mdt'./'
9494         done
9495 }
9496
9497 changelog_extract_field() {
9498         local cltype=$1
9499         local file=$2
9500         local identifier=$3
9501
9502         changelog_dump | gawk "/$cltype.*$file$/ {
9503                 print gensub(/^.* "$identifier'(\[[^\]]*\]).*$/,"\\1",1)}' |
9504                 tail -1
9505 }
9506
9507 # Prints a changelog record produced by "lfs changelog" as an associative array
9508 #
9509 # Example:
9510 # $> changelog2array 16 01CREAT 10:28:46.968438800 2018.03.09 0x0 \
9511 #                    t=[0x200000401:0x10:0x0] j=touch.501 ef=0xf u=501:501 \
9512 #                    nid=0@lo p=[0x200000007:0x1:0x0] blob
9513 # ([index]='16' [type]='CREAT' [time]='10:28:46.968438800'
9514 #  [date]='2018.03.09' [flags]=0x0 ['target-fid']='[0x200000401:0x10:0x0]'
9515 #  ['jobid']='touch.501' ['extra-flags']='0x0f' [uid]='0' ['gid']='0'
9516 #  ['nid']='0@lo' ['parent-fid']='[0x200000007:0x1:0x0]')
9517 #
9518 # Note that the changelog record is not quoted
9519 # Also note that the line breaks in the output were only added for readability
9520 #
9521 # Typically, you want to eval the output of the command to fill an actual
9522 # associative array, like this:
9523 # $> eval declare -A changelog=$(changelog2array $entry)
9524 #
9525 # It can then be accessed like any bash associative array:
9526 # $> echo "${changelog[index]}" "${changelog[type]}" "${changelog[flags]}"
9527 # 16 CREAT 0x0
9528 # $> echo "${changelog[uid]}":"${changelog[gid]}"
9529 # 501:501
9530 #
9531 changelog2array()
9532 {
9533         # Start the array
9534         printf '('
9535
9536         # A changelog, as printed by "lfs changelog" typically looks like this:
9537         # <index> <type> <time> <date> <flags> <key1=value1> <key2=value2> ...
9538
9539         # Parse the positional part of the changelog
9540
9541         # changelog_dump() prefixes records with their mdt's name
9542         local index="${1##*.}"
9543
9544         printf "[index]='%s' [type]='%s' [time]='%s' [date]='%s' [flags]='%s'" \
9545                "$index" "${2:2}" "$3" "$4" "$5"
9546
9547         # Parse the key/value part of the changelog
9548         for arg in "${@:5}"; do
9549                 # Check it matches a key=value syntax
9550                 [[ "$arg" =~ ^[[:alpha:]]+= ]] || continue
9551
9552                 local key="${arg%%=*}"
9553                 local value="${arg#*=}"
9554
9555                 case "$key" in
9556                 u)
9557                         # u is actually for uid AND gid: u=UID:GID
9558                         printf " [uid]='%s'" "${value%:*}"
9559                         key=gid
9560                         value="${value#*:}"
9561                         ;;
9562                 t)
9563                         key=target-fid
9564                         value="${value#[}"
9565                         value="${value%]}"
9566                         ;;
9567                 j)
9568                         key=jobid
9569                         ;;
9570                 p)
9571                         key=parent-fid
9572                         value="${value#[}"
9573                         value="${value%]}"
9574                         ;;
9575                 ef)
9576                         key=extra-flags
9577                         ;;
9578                 m)
9579                         key=mode
9580                         ;;
9581                 x)
9582                         key=xattr
9583                         ;;
9584                 *)
9585                         ;;
9586                 esac
9587
9588                 printf " ['%s']='%s'" "$key" "$value"
9589         done
9590
9591         # end the array
9592         printf ')'
9593 }
9594
9595 # Format and print a changelog record
9596 #
9597 # Interpreted sequences are:
9598 #       %%      a single %
9599 #       %f      the "flags" attribute of a changelog record
9600 __changelog_printf()
9601 {
9602         local format="$1"
9603
9604         local -i i
9605         for ((i = 0; i < ${#format}; i++)); do
9606                 local char="${format:$i:1}"
9607                 if [ "$char" != % ]; then
9608                         printf '%c' "$char"
9609                         continue
9610                 fi
9611
9612                 i+=1
9613                 char="${format:$i:1}"
9614                 case "$char" in
9615                 f)
9616                         printf '%s' "${changelog[flags]}"
9617                         ;;
9618                 %)
9619                         printf '%'
9620                         ;;
9621                 esac
9622         done
9623         printf '\n'
9624 }
9625
9626 # Filter changelog records
9627 changelog_find()
9628 {
9629         local -A filter
9630         local action='print'
9631         local format
9632
9633         while [ $# -gt 0 ]; do
9634                 case "$1" in
9635                 -print)
9636                         action='print'
9637                         ;;
9638                 -printf)
9639                         action='printf'
9640                         format="$2"
9641                         shift
9642                         ;;
9643                 -*)
9644                         filter[${1#-}]="$2"
9645                         shift
9646                         ;;
9647                 esac
9648                 shift
9649         done
9650
9651         local found=false
9652         local record
9653         changelog_dump | { while read -r record; do
9654                 eval local -A changelog=$(changelog2array $record)
9655                 for key in "${!filter[@]}"; do
9656                         case "$key" in
9657                         *)
9658                                 [ "${changelog[$key]}" == "${filter[$key]}" ]
9659                                 ;;
9660                         esac || continue 2
9661                 done
9662
9663                 found=true
9664
9665                 case "${action:-print}" in
9666                 print)
9667                         printf '%s\n' "$record"
9668                         ;;
9669                 printf)
9670                         __changelog_printf "$format"
9671                         ;;
9672                 esac
9673         done; $found; }
9674 }
9675
9676 restore_layout() {
9677         local dir=$1
9678         local layout=$2
9679
9680         [ ! -d "$dir" ] && return
9681
9682         [ -z "$layout" ] && {
9683                 $LFS setstripe -d $dir || error "error deleting stripe '$dir'"
9684                 return
9685         }
9686
9687         setfattr -n trusted.lov -v $layout $dir ||
9688                 error "error restoring layout '$layout' to '$dir'"
9689 }
9690
9691 # save the layout of a directory, the returned string will be used by
9692 # restore_layout() to restore the layout
9693 save_layout() {
9694         local dir=$1
9695         local str=$(getfattr -n trusted.lov --absolute-names -e hex $dir \
9696                     2> /dev/null | awk -F'=' '/trusted.lov/{ print $2 }')
9697         echo "$str"
9698 }
9699
9700 # save layout of a directory and restore it at exit
9701 save_layout_restore_at_exit() {
9702         local dir=$1
9703         local layout=$(save_layout $dir)
9704
9705         stack_trap "restore_layout $dir $layout" EXIT
9706 }
9707
9708 verify_yaml_layout() {
9709         local src=$1
9710         local dst=$2
9711         local temp=$3
9712         local msg_prefix=$4
9713
9714         echo "getstripe --yaml $src"
9715         $LFS getstripe --yaml $src > $temp || error "getstripe $src failed"
9716         echo "setstripe --yaml=$temp $dst"
9717         $LFS setstripe --yaml=$temp $dst|| error "setstripe $dst failed"
9718
9719         echo "compare"
9720         local layout1=$(get_layout_param $src)
9721         local layout2=$(get_layout_param $dst)
9722         # compare their layout info
9723         [ "$layout1" == "$layout2" ] ||
9724                 error "$msg_prefix $src/$dst layouts are not equal"
9725 }
9726
9727 is_project_quota_supported() {
9728         $ENABLE_PROJECT_QUOTAS || return 1
9729         [ "$(facet_fstype $SINGLEMDS)" == "ldiskfs" ] &&
9730                 [ $(lustre_version_code $SINGLEMDS) -gt \
9731                 $(version_code 2.9.55) ] &&
9732                 lfs --help | grep project >&/dev/null &&
9733                 egrep -q "7." /etc/redhat-release && return 0
9734
9735         if [ "$(facet_fstype $SINGLEMDS)" == "zfs" ]; then
9736                 [ $(lustre_version_code $SINGLEMDS) -le \
9737                         $(version_code 2.10.53) ] && return 1
9738
9739                 do_facet mds1 $ZPOOL upgrade -v |
9740                         grep project_quota && return 0
9741         fi
9742
9743         return 1
9744 }
9745
9746 enable_project_quota() {
9747         is_project_quota_supported || return 0
9748         [ "$(facet_fstype $SINGLEMDS)" != "ldiskfs" ] && return 0
9749         stopall || error "failed to stopall (1)"
9750
9751         for num in $(seq $MDSCOUNT); do
9752                 do_facet mds$num $TUNE2FS -O project $(mdsdevname $num) ||
9753                         error "tune2fs $(mdsdevname $num) failed"
9754         done
9755
9756         for num in $(seq $OSTCOUNT); do
9757                 do_facet ost$num $TUNE2FS -O project $(ostdevname $num) ||
9758                         error "tune2fs $(ostdevname $num) failed"
9759         done
9760
9761         mount
9762         setupall
9763 }
9764
9765 disable_project_quota() {
9766         is_project_quota_supported || return 0
9767         [ "$(facet_fstype $SINGLEMDS)" != "ldiskfs" ] && return 0
9768         stopall || error "failed to stopall (1)"
9769
9770         for num in $(seq $MDSCOUNT); do
9771                 do_facet mds$num $TUNE2FS -Q ^prj $(mdsdevname $num) ||
9772                         error "tune2fs $(mdsdevname $num) failed"
9773         done
9774
9775         for num in $(seq $OSTCOUNT); do
9776                 do_facet ost$num $TUNE2FS -Q ^prj $(ostdevname $num) ||
9777                         error "tune2fs $(ostdevname $num) failed"
9778         done
9779
9780         mount
9781         setupall
9782 }
9783
9784 #
9785 # In order to test multiple remote HSM agents, a new facet type named "AGT" and
9786 # the following associated variables are added:
9787 #
9788 # AGTCOUNT: number of agents
9789 # AGTDEV{N}: target HSM mount point (root path of the backend)
9790 # agt{N}_HOST: hostname of the agent agt{N}
9791 # SINGLEAGT: facet of the single agent
9792 #
9793 # The number of agents is initialized as the number of remote client nodes.
9794 # By default, only single copytool is started on a remote client/agent. If there
9795 # was no remote client, then the copytool will be started on the local client.
9796 #
9797 init_agt_vars() {
9798         local n
9799         local agent
9800
9801         export AGTCOUNT=${AGTCOUNT:-$((CLIENTCOUNT - 1))}
9802         [[ $AGTCOUNT -gt 0 ]] || AGTCOUNT=1
9803
9804         export SHARED_DIRECTORY=${SHARED_DIRECTORY:-$TMP}
9805         if [[ $CLIENTCOUNT -gt 1 ]] &&
9806                 ! check_shared_dir $SHARED_DIRECTORY $CLIENTS; then
9807                 skip_env "SHARED_DIRECTORY should be accessible"\
9808                          "on all client nodes"
9809                 exit 0
9810         fi
9811
9812         # We used to put the HSM archive in $SHARED_DIRECTORY but that
9813         # meant NFS issues could hose sanity-hsm sessions. So now we
9814         # use $TMP instead.
9815         for n in $(seq $AGTCOUNT); do
9816                 eval export AGTDEV$n=\$\{AGTDEV$n:-"$TMP/arc$n"\}
9817                 agent=CLIENT$((n + 1))
9818                 if [[ -z "${!agent}" ]]; then
9819                         [[ $CLIENTCOUNT -eq 1 ]] && agent=CLIENT1 ||
9820                                 agent=CLIENT2
9821                 fi
9822                 eval export agt${n}_HOST=\$\{agt${n}_HOST:-${!agent}\}
9823                 local var=agt${n}_HOST
9824                 [[ ! -z "${!var}" ]] || error "agt${n}_HOST is empty!"
9825         done
9826
9827         export SINGLEAGT=${SINGLEAGT:-agt1}
9828
9829         export HSMTOOL=${HSMTOOL:-"lhsmtool_posix"}
9830         export HSMTOOL_VERBOSE=${HSMTOOL_VERBOSE:-""}
9831         export HSMTOOL_UPDATE_INTERVAL=${HSMTOOL_UPDATE_INTERVAL:=""}
9832         export HSMTOOL_EVENT_FIFO=${HSMTOOL_EVENT_FIFO:=""}
9833         export HSMTOOL_TESTDIR
9834         export HSMTOOL_BASE=$(basename "$HSMTOOL" | cut -f1 -d" ")
9835
9836         HSM_ARCHIVE_NUMBER=2
9837
9838         # The test only support up to 10 MDTs
9839         MDT_PREFIX="mdt.$FSNAME-MDT000"
9840         HSM_PARAM="${MDT_PREFIX}0.hsm"
9841
9842         # archive is purged at copytool setup
9843         HSM_ARCHIVE_PURGE=true
9844
9845         # Don't allow copytool error upon start/setup
9846         HSMTOOL_NOERROR=false
9847 }
9848
9849 # Get the backend root path for the given agent facet.
9850 copytool_device() {
9851         local facet=$1
9852         local dev=AGTDEV$(facet_number $facet)
9853
9854         echo -n ${!dev}
9855 }
9856
9857 get_mdt_devices() {
9858         local mdtno
9859         # get MDT device for each mdc
9860         for mdtno in $(seq 1 $MDSCOUNT); do
9861                 local idx=$(($mdtno - 1))
9862                 MDT[$idx]=$($LCTL get_param -n \
9863                         mdc.$FSNAME-MDT000${idx}-mdc-*.mds_server_uuid |
9864                         awk '{gsub(/_UUID/,""); print $1}' | head -n1)
9865         done
9866 }
9867
9868 search_copytools() {
9869         local hosts=${1:-$(facet_active_host $SINGLEAGT)}
9870         do_nodesv $hosts "pgrep -x $HSMTOOL_BASE"
9871 }
9872
9873 kill_copytools() {
9874         local hosts=${1:-$(facet_active_host $SINGLEAGT)}
9875
9876         echo "Killing existing copytools on $hosts"
9877         do_nodesv $hosts "killall -q $HSMTOOL_BASE" || true
9878 }
9879
9880 wait_copytools() {
9881         local hosts=${1:-$(facet_active_host $SINGLEAGT)}
9882         local wait_timeout=200
9883         local wait_start=$SECONDS
9884         local wait_end=$((wait_start + wait_timeout))
9885         local sleep_time=100000 # 0.1 second
9886
9887         while ((SECONDS < wait_end)); do
9888                 if ! search_copytools $hosts; then
9889                         echo "copytools stopped in $((SECONDS - wait_start))s"
9890                         return 0
9891                 fi
9892
9893                 echo "copytools still running on $hosts"
9894                 usleep $sleep_time
9895                 [ $sleep_time -lt 32000000 ] && # 3.2 seconds
9896                         sleep_time=$(bc <<< "$sleep_time * 2")
9897         done
9898
9899         # try to dump Copytool's stack
9900         do_nodesv $hosts "echo 1 >/proc/sys/kernel/sysrq ; " \
9901                          "echo t >/proc/sysrq-trigger"
9902
9903         echo "copytools failed to stop in ${wait_timeout}s"
9904
9905         return 1
9906 }
9907
9908 copytool_monitor_cleanup() {
9909         local facet=${1:-$SINGLEAGT}
9910         local agent=$(facet_active_host $facet)
9911
9912         if [ -n "$HSMTOOL_MONITOR_DIR" ]; then
9913                 # Should die when the copytool dies, but just in case.
9914                 local cmd="kill \\\$(cat $HSMTOOL_MONITOR_DIR/monitor_pid)"
9915                 cmd+=" 2>/dev/null || true"
9916                 do_node $agent "$cmd"
9917                 do_node $agent "rm -fr $HSMTOOL_MONITOR_DIR"
9918                 export HSMTOOL_MONITOR_DIR=
9919         fi
9920
9921         # The pdsh should die on its own when the monitor dies. Just
9922         # in case, though, try to clean up to avoid any cruft.
9923         if [ -n "$HSMTOOL_MONITOR_PDSH" ]; then
9924                 kill $HSMTOOL_MONITOR_PDSH 2>/dev/null || true
9925                 export HSMTOOL_MONITOR_PDSH=
9926         fi
9927 }
9928
9929 copytool_logfile()
9930 {
9931         local host="$(facet_host "$1")"
9932         local prefix=$TESTLOG_PREFIX
9933         [ -n "$TESTNAME" ] && prefix+=.$TESTNAME
9934
9935         printf "${prefix}.copytool${archive_id}_log.${host}.log"
9936 }
9937
9938 __lhsmtool_rebind()
9939 {
9940         do_facet $facet $HSMTOOL -p "$hsm_root" --rebind "$@" "$mountpoint"
9941 }
9942
9943 __lhsmtool_import()
9944 {
9945         mkdir -p "$(dirname "$2")" ||
9946                 error "cannot create directory '$(dirname "$2")'"
9947         do_facet $facet $HSMTOOL -p "$hsm_root" --import "$@" "$mountpoint"
9948 }
9949
9950 __lhsmtool_setup()
9951 {
9952         local cmd="$HSMTOOL $HSMTOOL_VERBOSE --daemon --hsm-root \"$hsm_root\""
9953         [ -n "$bandwidth" ] && cmd+=" --bandwidth $bandwidth"
9954         [ -n "$archive_id" ] && cmd+=" --archive $archive_id"
9955         [ ${#misc_options[@]} -gt 0 ] &&
9956                 cmd+=" $(IFS=" " echo "$@")"
9957         cmd+=" \"$mountpoint\""
9958
9959         echo "Starting copytool $facet on $(facet_host $facet)"
9960         stack_trap "do_facet $facet libtool execute pkill -x '$HSMTOOL' || true" EXIT
9961         do_facet $facet "$cmd < /dev/null > \"$(copytool_logfile $facet)\" 2>&1"
9962 }
9963
9964 hsm_root() {
9965         local facet="${1:-$SINGLEAGT}"
9966
9967         printf "$(copytool_device "$facet")/${TESTSUITE}.${TESTNAME}/"
9968 }
9969
9970 # Main entry point to perform copytool related operations
9971 #
9972 # Sub-commands:
9973 #
9974 #       setup   setup a copytool to run in the background, that copytool will be
9975 #               killed on EXIT
9976 #       import  import a file from an HSM backend
9977 #       rebind  rebind an archived file to a new fid
9978 #
9979 # Although the semantics might suggest otherwise, one does not need to 'setup'
9980 # a copytool before a call to 'copytool import' or 'copytool rebind'.
9981 #
9982 copytool()
9983 {
9984         local action=$1
9985         shift
9986
9987         # Parse arguments
9988         local fail_on_error=true
9989         local -a misc_options
9990         while [ $# -gt 0 ]; do
9991                 case "$1" in
9992                 -f|--facet)
9993                         shift
9994                         local facet="$1"
9995                         ;;
9996                 -m|--mountpoint)
9997                         shift
9998                         local mountpoint="$1"
9999                         ;;
10000                 -a|--archive-id)
10001                         shift
10002                         local archive_id="$1"
10003                         ;;
10004                 -h|--hsm-root)
10005                         shift
10006                         local hsm_root="$1"
10007                         ;;
10008                 -b|--bwlimit)
10009                         shift
10010                         local bandwidth="$1" # in MB/s
10011                         ;;
10012                 -n|--no-fail)
10013                         local fail_on_error=false
10014                         ;;
10015                 *)
10016                         # Uncommon(/copytool dependent) option
10017                         misc_options+=("$1")
10018                         ;;
10019                 esac
10020                 shift
10021         done
10022
10023         # Use default values if needed
10024         local facet=${facet:-$SINGLEAGT}
10025         local mountpoint="${mountpoint:-${MOUNT2:-$MOUNT}}"
10026         local hsm_root="${hsm_root:-$(hsm_root "$facet")}"
10027
10028         stack_trap "do_facet $facet rm -rf '$hsm_root'" EXIT
10029         do_facet $facet mkdir -p "$hsm_root" ||
10030                 error "mkdir '$hsm_root' failed"
10031
10032         case "$HSMTOOL" in
10033         lhsmtool_posix)
10034                 local copytool=lhsmtool
10035                 ;;
10036         esac
10037
10038         __${copytool}_${action} "${misc_options[@]}"
10039         if [ $? -ne 0 ]; then
10040                 local error_msg
10041
10042                 case $action in
10043                 setup)
10044                         local host="$(facet_host $facet)"
10045                         error_msg="Failed to start copytool $facet on '$host'"
10046                         ;;
10047                 import)
10048                         local src="${misc_options[0]}"
10049                         local dest="${misc_options[1]}"
10050                         error_msg="Failed to import '$src' to '$dest'"
10051                         ;;
10052                 rebind)
10053                         error_msg="could not rebind file"
10054                         ;;
10055                 esac
10056
10057                 $fail_on_error && error "$error_msg" || echo "$error_msg"
10058         fi
10059 }
10060
10061 needclients() {
10062         local client_count=$1
10063         if [[ $CLIENTCOUNT -lt $client_count ]]; then
10064                 skip "Need $client_count or more clients, have $CLIENTCOUNT"
10065                 return 1
10066         fi
10067         return 0
10068 }
10069
10070 path2fid() {
10071         $LFS path2fid $1 | tr -d '[]'
10072         return ${PIPESTATUS[0]}
10073 }
10074
10075 get_hsm_flags() {
10076         local f=$1
10077         local u=$2
10078         local st
10079
10080         if [[ $u == "user" ]]; then
10081                 st=$($RUNAS $LFS hsm_state $f)
10082         else
10083                 u=root
10084                 st=$($LFS hsm_state $f)
10085         fi
10086
10087         [[ $? == 0 ]] || error "$LFS hsm_state $f failed (run as $u)"
10088
10089         st=$(echo $st | cut -f 2 -d" " | tr -d "()," )
10090         echo $st
10091 }
10092
10093 check_hsm_flags() {
10094         local f=$1
10095         local fl=$2
10096
10097         local st=$(get_hsm_flags $f)
10098         [[ $st == $fl ]] || error "hsm flags on $f are $st != $fl"
10099 }
10100
10101 mdts_set_param() {
10102         local arg=$1
10103         local key=$2
10104         local value=$3
10105         local mdtno
10106         local rc=0
10107         if [[ "$value" != "" ]]; then
10108                 value="=$value"
10109         fi
10110         for mdtno in $(seq 1 $MDSCOUNT); do
10111                 local idx=$(($mdtno - 1))
10112                 local facet=mds${mdtno}
10113                 # if $arg include -P option, run 1 set_param per MDT on the MGS
10114                 # else, run set_param on each MDT
10115                 [[ $arg = *"-P"* ]] && facet=mgs
10116                 do_facet $facet $LCTL set_param $arg mdt.${MDT[$idx]}.$key$value
10117                 [[ $? != 0 ]] && rc=1
10118         done
10119         return $rc
10120 }
10121
10122 wait_result() {
10123         local facet=$1
10124         shift
10125         wait_update --verbose $(facet_active_host $facet) "$@"
10126 }
10127
10128 mdts_check_param() {
10129         local key="$1"
10130         local target="$2"
10131         local timeout="$3"
10132         local mdtno
10133         for mdtno in $(seq 1 $MDSCOUNT); do
10134                 local idx=$(($mdtno - 1))
10135                 wait_result mds${mdtno} \
10136                         "$LCTL get_param -n $MDT_PREFIX${idx}.$key" "$target" \
10137                         $timeout ||
10138                         error "$key state is not '$target' on mds${mdtno}"
10139         done
10140 }
10141
10142 cdt_set_mount_state() {
10143         mdts_set_param "-P" hsm_control "$1"
10144         # set_param -P is asynchronous operation and could race with set_param.
10145         # In such case configs could be retrieved and applied at mgc after
10146         # set_param -P completion. Sleep here to avoid race with set_param.
10147         # We need at least 20 seconds. 10 for mgc_requeue_thread to wake up
10148         # MGC_TIMEOUT_MIN_SECONDS + MGC_TIMEOUT_RAND_CENTISEC(5 + 5)
10149         # and 10 seconds to retrieve config from server.
10150         sleep 20
10151 }
10152
10153 cdt_check_state() {
10154         mdts_check_param hsm_control "$1" 20
10155 }
10156
10157 cdt_set_sanity_policy() {
10158         if [[ "$CDT_POLICY_HAD_CHANGED" ]]
10159         then
10160                 # clear all
10161                 mdts_set_param "" hsm.policy "+NRA"
10162                 mdts_set_param "" hsm.policy "-NBR"
10163                 CDT_POLICY_HAD_CHANGED=
10164         fi
10165 }
10166
10167 set_hsm_param() {
10168         local param=$1
10169         local value=$2
10170         local opt=$3
10171         mdts_set_param "$opt -n" "hsm.$param" "$value"
10172         return $?
10173 }
10174
10175 wait_request_state() {
10176         local fid=$1
10177         local request=$2
10178         local state=$3
10179         # 4th arg (mdt index) is optional
10180         local mdtidx=${4:-0}
10181         local mds=mds$(($mdtidx + 1))
10182
10183         local cmd="$LCTL get_param -n ${MDT_PREFIX}${mdtidx}.hsm.actions"
10184         cmd+=" | awk '/'$fid'.*action='$request'/ {print \\\$13}' | cut -f2 -d="
10185
10186         wait_result $mds "$cmd" "$state" 200 ||
10187                 error "request on $fid is not $state on $mds"
10188 }
10189
10190
10191 rmultiop_start() {
10192         local client=$1
10193         local file=$2
10194         local cmds=$3
10195         local WAIT_MAX=${4:-60}
10196         local wait_time=0
10197
10198         # We need to run do_node in bg, because pdsh does not exit
10199         # if child process of run script exists.
10200         # I.e. pdsh does not exit when runmultiop_bg_pause exited,
10201         # because of multiop_bg_pause -> $MULTIOP_PROG &
10202         # By the same reason we need sleep a bit after do_nodes starts
10203         # to let runmultiop_bg_pause start muliop and
10204         # update /tmp/multiop_bg.pid ;
10205         # The rm /tmp/multiop_bg.pid guarantees here that
10206         # we have the updated by runmultiop_bg_pause
10207         # /tmp/multiop_bg.pid file
10208
10209         local pid_file=$TMP/multiop_bg.pid.$$
10210
10211         do_node $client "MULTIOP_PID_FILE=$pid_file LUSTRE= \
10212                         runmultiop_bg_pause $file $cmds" &
10213         local pid=$!
10214         local multiop_pid
10215
10216         while [[ $wait_time -lt $WAIT_MAX ]]; do
10217                 sleep 3
10218                 wait_time=$((wait_time + 3))
10219                 multiop_pid=$(do_node $client cat $pid_file)
10220                 if [ -n "$multiop_pid" ]; then
10221                         break
10222                 fi
10223         done
10224
10225         [ -n "$multiop_pid" ] ||
10226                 error "$client : Can not get multiop_pid from $pid_file "
10227
10228         eval export $(node_var_name $client)_multiop_pid=$multiop_pid
10229         eval export $(node_var_name $client)_do_node_pid=$pid
10230         local var=$(node_var_name $client)_multiop_pid
10231         echo client $client multiop_bg started multiop_pid=${!var}
10232         return $?
10233 }
10234
10235 rmultiop_stop() {
10236         local client=$1
10237         local multiop_pid=$(node_var_name $client)_multiop_pid
10238         local do_node_pid=$(node_var_name $client)_do_node_pid
10239
10240         echo "Stopping multiop_pid=${!multiop_pid} (kill ${!multiop_pid} on $client)"
10241         do_node $client kill -USR1 ${!multiop_pid}
10242
10243         wait ${!do_node_pid}
10244 }
10245
10246 sleep_maxage() {
10247         local delay=$(do_facet $SINGLEMDS lctl get_param -n lo[vd].*.qos_maxage |
10248                       awk '{ print $1 * 2; exit; }')
10249         sleep $delay
10250 }
10251
10252 check_component_count() {
10253         local comp_cnt=$($LFS getstripe --component-count $1)
10254         [ $comp_cnt -eq $2 ] || error "$1, component count $comp_cnt != $2"
10255 }
10256
10257 # Verify there are no init components with "extension" flag
10258 verify_no_init_extension() {
10259         local flg_opts="--component-flags init,extension"
10260         local found=$($LFS find $flg_opts $1 | wc -l)
10261         [ $found -eq 0 ] || error "$1 has component with initialized extension"
10262 }
10263
10264 # Verify there is at least one component starting at 0
10265 verify_comp_at_zero() {
10266         flg_opts="--component-flags init"
10267         found=$($LFS find --component-start 0M $flg_opts $1 | wc -l)
10268         [ $found -eq 1 ] ||
10269                 error "No component starting at zero(!)"
10270 }
10271
10272 #TODO: This version is a placeholder, to be replaced before final commit
10273 SEL_VER="2.12.52"
10274
10275 sel_layout_sanity() {
10276         local file=$1
10277         local comp_cnt=$2
10278
10279         verify_no_init_extension $file
10280         verify_comp_at_zero $file
10281         check_component_count $file $comp_cnt
10282 }
10283