common/fuzzy: if the fuzz verb is random, keep fuzzing until we get a new value
[xfstests-dev.git] / common / quota
1 ##/bin/bash
2 #
3 # Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
4 # All Rights Reserved.
5 #
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation.
9 #
10 # This program is distributed in the hope that it would be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write the Free Software Foundation,
17 # Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18 #
19 #
20 # Functions useful for quota tests
21 #
22
23 #
24 # checks that the generic quota support in the kernel is enabled
25 # and that we have valid quota user tools installed.
26 #
27 _require_quota()
28 {
29     [ -n "$QUOTA_PROG" ] || _notrun "Quota user tools not installed"
30
31     case $FSTYP in
32     ext2|ext3|ext4|ext4dev|reiserfs)
33         if [ ! -d /proc/sys/fs/quota ]; then
34             _notrun "Installed kernel does not support quotas"
35         fi
36         ;;
37     gfs2|ocfs2)
38         ;;
39     xfs)
40         if [ ! -f /proc/fs/xfs/xqmstat ]; then
41             _notrun "Installed kernel does not support XFS quotas"
42         fi
43         if [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ]; then
44             _notrun "Quotas not supported on realtime test device"
45         fi
46         if [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ]; then
47             _notrun "Quotas not supported on realtime scratch device"
48         fi
49         ;;
50     *)
51         _notrun "disk quotas not supported by this filesystem type: $FSTYP"
52         ;;
53     esac
54 }
55
56 #
57 # checks that the XFS quota support in the kernel is enabled
58 # and that we have valid quota user tools installed.
59 #
60 _require_xfs_quota()
61 {
62     src/feature -q $TEST_DEV
63     [ $? -ne 0 ] && _notrun "Installed kernel does not support XFS quota"
64     if [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ]; then
65         _notrun "Quotas not supported on realtime test device"
66     fi
67     if [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ]; then
68         _notrun "Quotas not supported on realtime scratch device"
69     fi
70     [ -n "$XFS_QUOTA_PROG" ] || _notrun "XFS quota user tools not installed"
71 }
72
73 #
74 # checks that xfs_quota can operate on foreign (non-xfs) filesystems
75 # Skips check on xfs filesystems, old xfs_quota is fine there.
76 # Appends "-f" to enable foreign behavior on non-xfs filesystems if available.
77 #
78 _require_xfs_quota_foreign()
79 {
80         if [ "$FSTYP" != "xfs" ]; then
81                 $XFS_QUOTA_PROG -f -V &>/dev/null || \
82                  _notrun "xfs_quota binary does not support foreign filesystems"
83                 XFS_QUOTA_PROG="$XFS_QUOTA_PROG -f"
84         fi
85 }
86
87 #
88 # checks that the project quota support in the kernel is enabled.
89 #
90 _require_prjquota()
91 {
92     [ -n "$1" ] && _dev="$1" || _dev="$TEST_DEV"
93     if [ "$FSTYP" == "ext4" ]; then
94         dumpe2fs -h $_dev 2>&1 | grep -qw project || \
95                 _notrun "Project quota not available on this ext4"
96     fi
97     src/feature -P $_dev
98     [ $? -ne 0 ] && _notrun "Installed kernel does not support project quotas"
99     if [ "$USE_EXTERNAL" = yes -a ! -z "$_dev" ]; then
100         _notrun "Project quotas not supported on realtime filesystem"
101     fi
102 }
103
104 #
105 # Do we have GETNEXTQUOTA?  Querying ID 0 should work.
106 #
107 _require_getnextquota()
108 {
109         _require_test_program "test-nextquota"
110         $here/src/test-nextquota -i 0 -u -d $SCRATCH_DEV &> $seqres.full || \
111                 _notrun "No GETNEXTQUOTA support"
112 }
113
114 #
115 # ext4 (for now) is unique in that we must enable the project quota feature
116 # prior to mount.  This is a relatively new feature ...
117 _scratch_enable_pquota()
118 {
119         [ "$FSTYP" != "ext4" ] && return
120
121         tune2fs -O quota,project $SCRATCH_DEV >>$seqres.full 2>&1
122         _scratch_mount >/dev/null 2>&1 \
123                 || _notrun "kernel doesn't support project feature on $FSTYP"
124         _scratch_unmount
125 }
126
127 #
128 # checks for user nobody in /etc/passwd and /etc/group.
129 #
130 _require_nobody()
131 {
132     _cat_passwd | grep -q '^nobody'
133     [ $? -ne 0 ] && _notrun "password file does not contain user nobody."
134
135     _cat_group | egrep -q '^no(body|group)'
136     [ $? -ne 0 ] && _notrun "group file does not contain nobody/nogroup."
137 }
138
139 # create a file as a specific user (uid)
140 # takes filename, id, type (u/g/p), blocksize, blockcount
141 #
142 _file_as_id()
143 {
144     [ $# != 5 ] && _fail "broken call to _file_as_id in test $seq"
145
146     parent=`dirname $1`
147     if [ $3 = p ]; then
148         echo PARENT: $XFS_IO_PROG -r -c "chproj $2" -c "chattr +P" $parent >>$seqres.full
149         $XFS_IO_PROG -r -c "chproj $2" -c "chattr +P" $parent >>$seqres.full 2>&1
150         magik='$>'      # (irrelevent, above set projid-inherit-on-parent)
151     elif [ $3 = u ]; then
152         magik='$>'      # perlspeak for effective uid
153     elif [ $3 = g ]; then
154         magik='$)'      # perlspeak for effective gid
155     else
156         _notrun "broken type in call to _file_as_id in test $seq"
157     fi
158
159     perl <<EOF >>$seqres.full 2>&1
160         \$| = 1;
161         $magik = $2;
162         if ($5 == 0) {
163             print "touch $1";
164             exec "touch $1";
165         } else {
166             print "dd if=/dev/zero of=$1 bs=$4 count=$5";
167             exec "dd if=/dev/zero of=$1 bs=$4 count=$5";
168         }
169 EOF
170 # for debugging the above euid change, try... [need write in cwd]
171 #       exec "dd if=/dev/zero of=$1 bs=$4 count=$5 >>$seqres.full 2>&1";
172
173     if [ $3 = p ]; then
174         echo PARENT: $XFS_IO_PROG -r -c "chproj 0" -c "chattr -P" $parent >>$seqres.full
175         $XFS_IO_PROG -r -c "chproj 0" -c "chattr -P" $parent >>$seqres.full 2>&1
176     fi
177 }
178
179 _choose_uid()
180 {
181     _cat_passwd | grep '^nobody' | perl -ne '@a = split(/:/); END { printf "id=%d name=%s\n", $a[2],$a[0] }'
182 }
183
184 _choose_gid()
185 {
186     _cat_group | egrep '^no(body|group)' | perl -ne '@a = split(/:/); END { printf "id=%d name=%s\n", $a[2],$a[0] }'
187 }
188
189 _choose_prid()
190 {
191     if [ "X$projid_file" == "X" ]; then
192         projid_file=/etc/projid
193     fi
194     if [ ! -f $projid_file ]; then
195         echo 0
196         return
197     fi
198     perl -ne '@a = split(/:/); END { printf "id=%d name=%s\n", $a[1],$a[0] }' \
199         $projid_file
200 }
201
202 _qmount()
203 {
204     _scratch_unmount >/dev/null 2>&1
205     _scratch_mount || _fail "qmount failed"
206     # xfs doesn't need these setups and quotacheck even fails on xfs
207     # redirect the output to $seqres.full for debug purpose and ignore results
208     if [ "$FSTYP" != "xfs" ]; then
209         quotacheck -ug $SCRATCH_MNT >>$seqres.full 2>&1
210         quotaon -ug $SCRATCH_MNT >>$seqres.full 2>&1
211     fi
212     chmod ugo+rwx $SCRATCH_MNT
213 }
214
215 #
216 # Ensures only the given quota mount option is used
217 #
218 _qmount_option()
219 {
220         OPTS=$1
221
222         # Replace any user defined quota options
223         # with the quota option that we want.
224         # Simplest to do this rather than delete existing ones first because
225         # of the variety of commas and spaces and multiple -o's
226         # that we'd have to cater for. Doesn't matter if we have duplicates.
227         # Use "QUOTA" string so that we don't have any substring confusion
228         # thanks to "quota" which will match with "uquota" and "gquota" etc.
229         export MOUNT_OPTIONS=`echo $MOUNT_OPTIONS \
230         | sed   -e 's/uquota/QUOTA/g'      \
231                 -e 's/usrquota/QUOTA/g'    \
232                 -e 's/gquota/QUOTA/g'      \
233                 -e 's/grpquota/QUOTA/g'    \
234                 -e 's/\bpquota/QUOTA/g'    \
235                 -e 's/prjquota/QUOTA/g'    \
236                 -e 's/quota/QUOTA/g'       \
237                 -e 's/uqnoenforce/QUOTA/g' \
238                 -e 's/gqnoenforce/QUOTA/g' \
239                 -e 's/pqnoenforce/QUOTA/g' \
240                 -e 's/qnoenforce/QUOTA/g'  \
241                 -e "s/QUOTA/$OPTS/g"`
242
243         # ext4 doesn't _do_ "-o pquota/prjquota" because reasons
244         # Switch it to "quota" to enable mkfs-time pquota
245         if [ "$FSTYP" == "ext4" ]; then
246                 OPTS=`echo $OPTS \
247                 | sed   -e 's/\bpquota/quota/g' \
248                         -e 's/prjquota/quota/g'`
249         fi
250         # Ensure we have the given quota option - duplicates are fine
251         export MOUNT_OPTIONS="$MOUNT_OPTIONS -o $OPTS"
252         echo "MOUNT_OPTIONS = $MOUNT_OPTIONS" >>$seqres.full
253 }
254
255 _check_quota_usage()
256 {
257         # Sync to get delalloc to disk
258         sync
259
260         # kill caches to guarantee removal speculative delalloc
261         # XXX: really need an ioctl instead of this big hammer
262         echo 3 > /proc/sys/vm/drop_caches
263
264         VFS_QUOTA=0
265         case $FSTYP in
266         ext2|ext3|ext4|ext4dev|reiserfs|gfs2)
267                 VFS_QUOTA=1
268                 quotaon -f -u -g $SCRATCH_MNT 2>/dev/null
269                 ;;
270         xfs)
271                 # Clear out speculative preallocations to eliminate them
272                 # as a source of intermittent orig/checked differences.
273                 test -x "$XFS_SPACEMAN_PROG" && \
274                         "$XFS_SPACEMAN_PROG" -c 'prealloc -s' $SCRATCH_MNT
275                 ;;
276         *)
277                 ;;
278         esac
279         repquota -u -n $SCRATCH_MNT  | grep -v "^#0" | _filter_scratch |
280                 sort >$tmp.user.orig
281         repquota -g -n $SCRATCH_MNT  | grep -v "^#0" | _filter_scratch |
282                 sort >$tmp.group.orig
283         if [ $VFS_QUOTA -eq 1 ]; then
284                 quotacheck -u -g $SCRATCH_MNT 2>/dev/null
285         else
286                 # use XFS method to force quotacheck
287                 xfs_quota -x -c "off -ug" $SCRATCH_MNT
288                 _scratch_unmount
289                 _scratch_mount "-o usrquota,grpquota"
290         fi
291         repquota -u -n $SCRATCH_MNT  | grep -v "^#0" | _filter_scratch |
292                 sort >$tmp.user.checked
293         repquota -g -n $SCRATCH_MNT  | grep -v "^#0" | _filter_scratch |
294                 sort >$tmp.group.checked
295         if [ $VFS_QUOTA -eq 1 ]; then
296                 quotaon -u -g $SCRATCH_MNT 2>/dev/null
297         fi
298         {
299                 echo "Comparing user usage"
300                 diff $tmp.user.orig $tmp.user.checked
301         } && {
302                 echo "Comparing group usage"
303                 diff $tmp.group.orig $tmp.group.checked
304         }
305 }
306
307 # Report the block usage of root, $qa_user, and nobody
308 _report_quota_blocks() {
309         repquota $1 | egrep "^($qa_user|root|nobody)" | awk '{print $1, $3, $4, $5}'
310 }
311
312 # Report the inode usage of root, $qa_user, and nobody
313 _report_quota_inodes() {
314         repquota $1 | egrep "^($qa_user|root|nobody)" | awk '{print $1, $6, $7, $8}'
315 }
316
317 # make sure this script returns success
318 /bin/true