generic: Make some shared tests generic
[xfstests-dev.git] / tests / shared / 243
1 #! /bin/bash
2 # FS QA Test No. 243
3 #
4 # Test to ensure that the EOFBLOCK_FL gets set/unset correctly.
5 #
6 # As found by Theodore Ts'o:
7 # If a 128K file is falloc'ed using the KEEP_SIZE flag, and then
8 # write exactly 128K, the EOFBLOCK_FL doesn't get cleared correctly.
9 # This is bad since it forces e2fsck to complain about that inode.
10 # If you have a large number of inodes that are written with fallocate
11 # using KEEP_SIZE, and then fill them up to their expected size,
12 # e2fsck will potentially complain about a _huge_ number of inodes.
13 # This would also cause a huge increase in the time taken by e2fsck
14 # to complete its check.
15 #
16 # Test scenarios covered:
17 # 1. Fallocating X bytes and writing Y (Y<X) (buffered and direct io)
18 # 2. Fallocating X bytes and writing Y (Y=X) (buffered and direct io)
19 # 3. Fallocating X bytes and writing Y (Y>X) (buffered and direct io)
20 #
21 # These test cases exercise the normal and edge case conditions using
22 # falloc (and KEEP_SIZE).
23 #
24 # Ref: http://thread.gmane.org/gmane.comp.file-systems.ext4/20682
25 #
26 #-----------------------------------------------------------------------
27 # Copyright (c) 2010 Google, Inc.  All Rights Reserved.
28 #
29 # This program is free software; you can redistribute it and/or
30 # modify it under the terms of the GNU General Public License as
31 # published by the Free Software Foundation.
32 #
33 # This program is distributed in the hope that it would be useful,
34 # but WITHOUT ANY WARRANTY; without even the implied warranty of
35 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36 # GNU General Public License for more details.
37 #
38 # You should have received a copy of the GNU General Public License
39 # along with this program; if not, write the Free Software Foundation,
40 # Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
41 #-----------------------------------------------------------------------
42 #
43
44 seq=`basename $0`
45 seqres=$RESULT_DIR/$seq
46 echo "QA output created by $seq"
47
48 here=`pwd`
49 tmp=/tmp/$$
50 status=1        # failure is the default!
51 trap "_cleanup; exit \$status" 0 1 2 3 15
52
53 # Test specific macros.
54 BIT_NOT_SET=0   # inode flag - 0x400000 bit is not set.
55 BIT_SET=1       # inode flag - 0x400000 bit is set.
56
57 # Generic test cleanup function.
58 _cleanup()
59 {
60   cd /
61   rm -f $tmp.*
62 }
63
64 # Ext4 uses the EOFBLOCKS_FL bit when fallocating blocks with KEEP_SIZE
65 # enabled. The only time this bit should be set is when extending the allocated
66 # blocks further than what the i_size represents. In the situations wherein the
67 # i_size covers all allocated blocks, this bit should be cleared.
68
69 # Checks the state of the sample file in the filesystem and returns whether
70 # the inode flag 0x400000 is set or not.
71 _check_ext4_eof_flag()
72 {
73   # Check whether EOFBLOCK_FL is set.
74   # For ext4 filesystems: use debugfs to check if EOFBLOCKS_FL is set.
75   # Other filesystems: do nothing. The default fsck at the end of the test
76   # should catch any potential errors.
77   if [ "${FSTYP}" == "ext4" ]; then
78     bit_set=1
79
80     # Unmount the ${TEST_DEV}
81     umount ${TEST_DEV}
82
83     # Run debugfs to gather file_parameters - specifically iflags.
84     file_params=`debugfs ${TEST_DEV} -R "stat ${1}" 2>&1 | grep -e Flags:`
85     iflags=${file_params#*Flags: }
86
87     # Ensure that the iflags value was parsed correctly.
88     if [ -z ${iflags} ]; then
89       echo "iFlags value was not parsed successfully." >> $seqres.full
90       status=1
91       exit ${status}
92     fi
93
94     # Check if EOFBLOCKS_FL is set.
95     if ((${iflags} & 0x400000)); then
96       echo "EOFBLOCK_FL bit is set." >> $seqres.full
97       bit_set=1
98     else
99       echo "EOFBLOCK_FL bit is not set." >> $seqres.full
100       bit_set=0
101     fi
102
103     # Check current bit state to expected value.
104     if [ ${bit_set} -ne ${2} ]; then
105       echo "Error: Current bit state incorrect." >> $seqres.full
106       status=1
107       exit ${status}
108     fi
109
110     # Mount the ${TEST_DEV}
111     mount ${TEST_DEV} -t ${FSTYP} ${TEST_DIR}
112   fi
113 }
114
115 # Get standard environment, filters and checks.
116 . ./common/rc
117 . ./common/filter
118
119 # Prerequisites for the test run.
120 _supported_fs ext4 xfs btrfs gfs2
121 _supported_os Linux
122 _require_xfs_io_falloc
123
124 # Real QA test starts here.
125 rm -f $seqres.full
126
127 # Remove any leftover files from last run.
128 rm -f ${TEST_DIR}/test_?
129
130 # Begin test cases.
131 echo "Test 1: Fallocate 40960 bytes and write 4096 bytes (buffered io)." \
132     >> $seqres.full
133 ${XFS_IO_PROG} -f                       \
134     -c 'falloc -k 0 40960'              \
135     -c 'pwrite 0 4096'                  \
136     ${TEST_DIR}/test_1 | _filter_xfs_io_unique
137 _check_ext4_eof_flag test_1 ${BIT_SET}
138
139 echo "Test 2: Fallocate 40960 bytes and write 4096 bytes (direct io)." \
140     >> $seqres.full
141 ${XFS_IO_PROG} -f -d                    \
142     -c 'falloc -k 0 40960'              \
143     -c 'pwrite 0 4096'                  \
144     ${TEST_DIR}/test_2 | _filter_xfs_io_unique
145 _check_ext4_eof_flag test_2 ${BIT_SET}
146
147 echo "Test 3: Fallocate 40960 bytes and write 40960 bytes (buffered io)." \
148     >> $seqres.full
149 ${XFS_IO_PROG} -f                       \
150     -c 'falloc -k 0 40960'              \
151     -c 'pwrite 0 40960'                 \
152     ${TEST_DIR}/test_3 | _filter_xfs_io_unique
153 _check_ext4_eof_flag test_3 ${BIT_NOT_SET}
154
155 echo "Test 4: Fallocate 40960 bytes and write 40960 bytes (direct io)." \
156     >> $seqres.full
157 ${XFS_IO_PROG} -f -d                    \
158     -c 'falloc -k 0 40960'              \
159     -c 'pwrite 0 40960'                 \
160     ${TEST_DIR}/test_4 | _filter_xfs_io_unique
161 _check_ext4_eof_flag test_4 ${BIT_NOT_SET}
162
163 echo "Test 5: Fallocate 128k, seek 256k and write 4k block (buffered io)." \
164     >> $seqres.full
165 ${XFS_IO_PROG} -f                       \
166     -c 'falloc -k 0 128k'               \
167     -c 'pwrite 256k 4k'                 \
168     ${TEST_DIR}/test_5 | _filter_xfs_io_unique
169 _check_ext4_eof_flag test_5 ${BIT_NOT_SET}
170
171 echo "Test 6: Fallocate 128k, seek to 256k and write a 4k block (direct io)." \
172     >> $seqres.full
173 ${XFS_IO_PROG} -f -d                    \
174     -c 'falloc -k 0 128k'               \
175     -c 'pwrite 256k 4k'                 \
176     ${TEST_DIR}/test_6 | _filter_xfs_io_unique
177 _check_ext4_eof_flag test_6 ${BIT_NOT_SET}
178
179 status=0
180 exit ${status}