xfstests: introduce a common directory
[xfstests-dev.git] / common / config
1 ##/bin/bash
2 #
3 # Copyright (c) 2000-2003,2006 Silicon Graphics, Inc.  All Rights Reserved.
4 #
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License as
7 # published by the Free Software Foundation.
8 #
9 # This program is distributed in the hope that it would be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write the Free Software Foundation,
16 # Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17 #
18 #
19 # setup and check for config parameters, and in particular
20 #
21 # EMAIL -           email of the script runner.
22 # TEST_DIR -        scratch test directory that is in an already
23 #                   mounted XFS file system, needs to be be world
24 #                   writeable
25 # TEST_DEV -        device for file system containing TEST_DIR
26 #
27 # and optionally:
28 # SCRATCH_DEV -     device you can make a scratch file system on
29 # SCRATCH_MNT -     mount point for scratch file system
30 # SCRATCH_LOGDEV -  scratch log device for external log testing
31 # SCRATCH_RTDEV -   scratch rt dev
32 # TEST_LOGDEV -     test log device for external log testing
33 # TEST_RTDEV -      test rt dev
34 # TAPE_DEV -        the tape device for the xfsdump tests
35 # RMT_TAPE_DEV -    the remote tape device for the xfsdump tests
36 # RMT_IRIXTAPE_DEV- the IRIX remote tape device for the xfsdump tests
37 # RMT_TAPE_USER -   remote user for tape device
38 #
39 # - These can be added to $HOST_CONFIG_DIR (witch default to ./config)
40 #   below or a separate local configuration file can be used (using
41 #   the HOST_OPTIONS variable).
42 # - This script is shared by the stress test system and the auto-qa
43 #   system
44 # - TEST_DEV & TEST_DIR must be assigned.
45 # - this script shouldn't make any assertions about filesystem
46 #   validity or mountedness.
47 #
48
49 # all tests should use a common language setting to prevent golden
50 # output mismatches.
51 export LANG=C
52
53 # Warning: don't put freeware before /usr/bsd on IRIX coz you'll
54 #  get the wrong hostname and set your system name to -s  :)
55 [ -d /usr/bsd ] && PATH=$PATH:/usr/bsd
56 [ -d /usr/freeware/bin ] && PATH=$PATH:/usr/freeware/bin
57 PATH=".:$PATH"
58
59 HOST=`hostname -s`
60 HOSTOS=`uname -s`
61 [ "$HOSTOS" = "IRIX64" ] && HOSTOS="IRIX"
62
63 MODULAR=0               # using XFS as a module or not
64 BOOT="/boot"            # install target for kernels
65 export EXTRA=${EXTRA:=xfs-qa}
66
67 # general parameters (mainly for auto-qa)
68 SOAK_PROC=3             # -p option to fsstress
69 SOAK_STRESS=10000       # -n option to fsstress
70 SOAK_PASSES=-1          # count of repetitions of fsstress (while soaking)
71 EMAIL=root@localhost    # where auto-qa will send its status messages
72 export HOST_OPTIONS=${HOST_OPTIONS:=local.config}
73 export CHECK_OPTIONS=${CHECK_OPTIONS:="-g auto"}
74 export BENCH_PASSES=${BENCH_PASSES:=5}
75 export XFS_MKFS_OPTIONS=${XFS_MKFS_OPTIONS:=-bsize=4096}
76 export TIME_FACTOR=${TIME_FACTOR:=1}
77 export LOAD_FACTOR=${LOAD_FACTOR:=1}
78 export DEBUGFS_MNT=${DEBUGFS_MNT:="/sys/kernel/debug"}
79
80 export PWD=`pwd`
81 #export DEBUG=${DEBUG:=...} # arbitrary CFLAGS really.
82 export MALLOCLIB=${MALLOCLIB:=/usr/lib/libefence.a}
83 export LOCAL_CONFIGURE_OPTIONS=${LOCAL_CONFIGURE_OPTIONS:=--enable-readline=yes}
84
85 # $1 = prog to look for, $2* = default pathnames if not found in $PATH
86 set_prog_path()
87 {
88     p=`which $1 2> /dev/null`
89     if [ -n "$p" -a -x "$p" ]; then
90         echo $p
91         return 0
92     fi
93     p=$1
94
95     shift
96     for f; do
97         if [ -x $f ]; then
98             echo $f
99             return 0
100         fi
101     done
102
103     echo ""
104     return 1
105 }
106
107 # Handle mkfs.btrfs which does (or does not) require -f to overwrite
108 set_btrfs_mkfs_prog_path_with_opts()
109 {
110         p=`set_prog_path mkfs.btrfs`
111         if [ "$p" != "" ] && grep -q 'force overwrite' $p; then
112                 echo "$p -f"
113         else
114                 echo $p
115         fi
116 }
117
118 _fatal()
119 {
120     echo "$*"
121     status=1
122     exit 1
123 }
124
125 export MKFS_PROG="`set_prog_path mkfs`"
126 [ "$MKFS_PROG" = "" ] && _fatal "mkfs not found"
127
128 export MOUNT_PROG="`set_prog_path mount`"
129 [ "$MOUNT_PROG" = "" ] && _fatal "mount not found"
130
131 export UMOUNT_PROG="`set_prog_path umount`"
132 [ "$UMOUNT_PROG" = "" ] && _fatal "umount not found"
133
134 export FSSTRESS_PROG="`set_prog_path fsstress $PWD/ltp/fsstress`"
135 [ "$FSSTRESS_PROG" = "" ] && _fatal "fsstress not found"
136
137 export PERL_PROG="`set_prog_path perl`"
138 [ "$PERL_PROG" = "" ] && _fatal "perl not found"
139
140 export AWK_PROG="`set_prog_path awk`"
141 [ "$AWK_PROG" = "" ] && _fatal "awk not found"
142
143 export SED_PROG="`set_prog_path sed`"
144 [ "$SED_PROG" = "" ] && _fatal "sed not found"
145
146 export BC_PROG="`set_prog_path bc`"
147 [ "$BC_PROG" = "" ] && _fatal "bc not found"
148
149 export PS_ALL_FLAGS="-ef"
150
151 export DF_PROG="`set_prog_path df`"
152 [ "$DF_PROG" = "" ] && _fatal "df not found"
153 [ "$HOSTOS" = "Linux" ] && export DF_PROG="$DF_PROG -T"
154
155 export XFS_LOGPRINT_PROG="`set_prog_path xfs_logprint`"
156 export XFS_REPAIR_PROG="`set_prog_path xfs_repair`"
157 export XFS_CHECK_PROG="`set_prog_path xfs_check`"
158 export XFS_DB_PROG="`set_prog_path xfs_db`"
159 export XFS_GROWFS_PROG=`set_prog_path xfs_growfs`
160 export XFS_IO_PROG="`set_prog_path xfs_io`"
161 export XFS_PARALLEL_REPAIR_PROG="`set_prog_path xfs_prepair`"
162 export XFS_PARALLEL_REPAIR64_PROG="`set_prog_path xfs_prepair64`"
163 export __XFSDUMP_PROG="`set_prog_path xfsdump`"
164 export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
165 export XFSRESTORE_PROG="`set_prog_path xfsrestore`"
166 export XFSINVUTIL_PROG="`set_prog_path xfsinvutil`"
167 export GETFATTR_PROG="`set_prog_path getfattr`"
168 export SETFATTR_PROG="`set_prog_path setfattr`"
169 export ATTR_PROG="`set_prog_path attr`"
170 export QUOTA_PROG="`set_prog_path quota`"
171 export XFS_QUOTA_PROG="`set_prog_path xfs_quota`"
172 export KILLALL_PROG="`set_prog_path killall`"
173 export INDENT_PROG="`set_prog_path indent`"
174 export XFS_COPY_PROG="`set_prog_path xfs_copy`"
175 export FSTRIM_PROG="`set_prog_path fstrim`"
176 export DUMPE2FS_PROG="`set_prog_path dumpe2fs`"
177 export FIO_PROG="`set_prog_path fio`"
178 export FILEFRAG_PROG="`set_prog_path filefrag`"
179 export E4DEFRAG_PROG="`set_prog_path e4defrag`"
180 export LOGGER_PROG="`set_prog_path logger`"
181
182 # Generate a comparable xfsprogs version number in the form of
183 # major * 10000 + minor * 100 + release
184 #
185 # $ xfs_db -V
186 # xfs_db version 2.9.7
187 #
188 # so, 2.9.7 = 20907
189 _version=`$XFS_DB_PROG -V | $AWK_PROG '
190         /version/ {
191                 if (split($3,ver,".") == 3)
192                         print (ver[1] * 10000) + (ver[2] * 100) + ver[3];
193         }'`
194 [ -z "$_version" ] && _fatal "xfsprogs version cannot be found"
195 export XFSPROGS_VERSION="$_version"
196
197 case "$HOSTOS" in
198     IRIX*)
199         export MKFS_XFS_PROG="`set_prog_path mkfs_xfs`"
200         export MKFS_UDF_PROG="`set_prog_path mkfs_udf`"
201         export XFS_FSR_PROG="`set_prog_path /usr/etc/fsr_xfs`"
202         export MKFS_NFS_PROG="false"
203         ;;
204     Linux)
205         export MKFS_XFS_PROG="`set_prog_path mkfs.xfs`"
206         export MKFS_UDF_PROG="`set_prog_path mkudffs`"
207         export MKFS_BTRFS_PROG="`set_btrfs_mkfs_prog_path_with_opts`"
208         export BTRFS_UTIL_PROG="`set_prog_path btrfs`"
209         export XFS_FSR_PROG="`set_prog_path xfs_fsr`"
210         export MKFS_NFS_PROG="false"
211         ;;
212 esac
213
214 known_hosts()
215 {
216   [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
217
218   [ -f /etc/xfsqa.config ]             && . /etc/xfsqa.config
219   [ -f $HOST_CONFIG_DIR/$HOST ]        && . $HOST_CONFIG_DIR/$HOST
220   [ -f $HOST_CONFIG_DIR/$HOST.config ] && . $HOST_CONFIG_DIR/$HOST.config
221
222   #  Mandatory Config values.
223   MC=""
224   [ -z "$EMAIL" ]          && MC="$MC EMAIL"
225   [ -z "$TEST_DIR" ]       && MC="$MC TEST_DIR"
226   [ -z "$TEST_DEV" ]       && MC="$MC TEST_DEV"
227
228   if [ -n "$MC" ]; then
229     echo "Warning: need to define parameters for host $HOST"
230     echo "       or set variables:"
231     echo "       $MC"
232     exit 1
233   fi
234 }
235
236 if [ -f "$HOST_OPTIONS" ]; then
237     . "$HOST_OPTIONS"
238 else
239     known_hosts
240 fi
241
242 echo $TEST_DEV | grep -q ":" > /dev/null 2>&1
243 if [ ! -b "$TEST_DEV" -a "$?" != "0" ]; then
244     echo "common.config: Error: \$TEST_DEV ($TEST_DEV) is not a block device or a NFS filesystem"
245     exit 1
246 fi
247
248 if [ ! -d "$TEST_DIR" ]; then
249     echo "common.config: Error: \$TEST_DIR ($TEST_DIR) is not a directory"
250     exit 1
251 fi
252
253 # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
254 # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
255 if [ ! -z "$SCRATCH_DEV_POOL" ]; then
256     if [ ! -z "$SCRATCH_DEV" ]; then
257         echo "common.config: Error: \$SCRATCH_DEV should be unset when \$SCRATCH_DEV_POOL is set"
258         exit 1
259     fi
260     SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
261     SCRATCH_DEV_POOL=`echo $SCRATCH_DEV_POOL | awk '{ ORS=" "; for (i = 2; i <= NF; i++) print $i}'`
262 fi
263
264 echo $SCRATCH_DEV | grep -q ":" > /dev/null 2>&1
265 if [ ! -z "$SCRATCH_DEV" -a ! -b "$SCRATCH_DEV" -a "$?" != "0" ]; then
266     echo "common.config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) is not a block device or a NFS filesystem"
267     exit 1
268 fi
269
270 if [ ! -z "$SCRATCH_MNT" -a ! -d "$SCRATCH_MNT" ]; then
271     echo "common.config: Error: \$SCRATCH_MNT ($SCRATCH_MNT) is not a directory"
272     exit 1
273 fi
274
275 # make sure this script returns success
276 /bin/true