common/quota

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