4 # Test xfs_db metadump functionality.
6 # This test was created to verify fixes for problems where metadump
7 # would never complete due to an inability to find a suitable
8 # obfuscated name to use. It also verifies a few other things,
9 # including ensuring the "lost+found" directory and orphaned files
10 # in it do not get obfuscated.
12 # This test also creates a number of files that are effectively
13 # duplicates of existing files; this can happen in certain rare
14 # instances where the obfuscation process has produced a filename
15 # that is already in use (and no other name is available to use).
17 #-----------------------------------------------------------------------
18 # Copyright (c) 2011 SGI. All Rights Reserved.
20 # This program is free software; you can redistribute it and/or
21 # modify it under the terms of the GNU General Public License as
22 # published by the Free Software Foundation.
24 # This program is distributed in the hope that it would be useful,
25 # but WITHOUT ANY WARRANTY; without even the implied warranty of
26 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 # GNU General Public License for more details.
29 # You should have received a copy of the GNU General Public License
30 # along with this program; if not, write the Free Software Foundation,
31 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
32 #-----------------------------------------------------------------------
38 echo "QA output created by $seq"
42 status=1 # failure is the default!
43 trap "_cleanup; exit \$status" 0 1 2 3 15
49 rm -rf "${OUTPUT_DIR}"
50 rm -f "${METADUMP_FILE}"
53 # get standard environment, filters and checks
59 # real QA test starts here
61 OUTPUT_DIR="${SCRATCH_MNT}/test_${seq}"
62 METADUMP_FILE="${TEST_DIR}/${seq}_metadump"
63 ORPHANAGE="lost+found"
68 function create_file() {
69 [ $# -eq 1 ] || return 1
73 echo "Disciplyne of silence is goed."
75 _scratch_mkfs >/dev/null 2>&1
78 # Initialize and mount the scratch filesystem, then create a bunch
79 # of files that exercise the original problem.
81 # The problem arose when a file name produced a hash that contained
82 # either 0x00 (string terminator) or 0x27 ('/' character) in a
83 # spot used to determine a character in an obfuscated name. This
84 # occurred in one of 5 spots at the end of the name, at position
85 # (last-4), (last-3), (last-2), (last-1), or (last).
87 rm -f "${METADUMP_FILE}"
89 mkdir -p "${OUTPUT_DIR}"
92 # Start out with some basic test files
93 create_file 'abcde' # hash 0x1c58f263 ("normal" name)
95 create_file 'f' # hash 0x00000066 (1-byte name)
96 create_file 'gh' # hash 0x000033e8 (2-byte name)
97 create_file 'ijk' # hash 0x001a756b (3-byte name)
98 create_file 'lmno' # hash 0x0d9b776f (4-byte name)
99 create_file 'pqrstu' # hash 0x1e5cf9f2 (6-byte name)
100 create_file 'abcdefghijklmnopqrstuvwxyz' # a most remarkable word (0x55004ae3)
102 # Create a short directory name; it won't be obfuscated. Populate
103 # it with some longer named-files. The first part of the obfuscated
104 # filenames should use printable characters.
106 create_file 'foo/longer_file_name_1' # hash 0xe83634ec
107 create_file 'foo/longer_file_name_2' # hash 0xe83634ef
108 create_file 'foo/longer_file_name_3' # hash 0xe83634ee
110 # Now create a longer directory name
111 mkdir longer_directory_name
112 create_file 'longer_directory_name/f1' # directory hash 0x9c7accdd
113 create_file 'longer_directory_name/f2' # filenames are short, no hash
114 create_file 'longer_directory_name/f3'
116 # The problematic name originally reported by Arkadiusz MiĆkiewicz
118 create_file 'R\323\257NE' # hash 0x3a4be740, forces (last-3) = 0x2f
120 # Other names that force a 0x00 byte
121 create_file 'Pbcde' # hash 0x0c58f260, forces (last-4) = 0x00
122 create_file 'a\001\203de' # hash 0x1000f263, forces (last-3) = 0x00
123 create_file 'ab\001\344e' # hash 0x1c403263, forces (last-2) = 0x00
124 create_file 'abc\200e' # hash 0x1c588063, forces (last-1) = 0x00
125 create_file 'abcd\006' # hash 0x1c58f200, forces (last) = 0x00
127 # Names that force a 0x2f byte; note no name will ever force (last-4) = 0x2f
128 create_file 'a.\343de' # hash 0x15f8f263 forces (last-3) = 0x00
129 create_file 'ac\257de' # hash 0x1c4bf263, forces (last-2) = 0x2f
130 create_file 'abe\257e' # hash 0x1c5917e3, forces (last-1) = 0x2f
131 create_file 'abcd)' # hash 0x1c58f22f, forces (last) = 0x2f
133 # The following names are possible results of obfuscating the name
134 # "abcde". Previously, xfs_metadump could get hung up trying to
135 # obfuscate names when too many of the same length had the same hash
137 create_file '!bcda' # essentially a dup of 'abcde'
138 create_file 'Abcdg' # essentially a dup of 'abcde'
139 create_file 'qbcdd' # essentially a dup of 'abcde'
140 create_file '1bcd`' # essentially a dup of 'abcde'
141 create_file 'Qbcdf' # essentially a dup of 'abcde'
142 create_file '\001bcdc' # essentially a dup of 'abcde'
143 create_file 'Qbce\346' # essentially a dup of 'abcde'
144 create_file 'abb\344e' # essentially a dup of 'abcde'
146 # The orphanage directory (lost+found) should not be obfuscated.
147 # Files thereunder can be, but not if their name is the same as
148 # their inode number. Test this.
151 mkdir -p "${ORPHANAGE}"
153 TEMP_ORPHAN="${ORPHANAGE}/__orphan__"
154 NON_ORPHAN="${ORPHANAGE}/__should_be_obfuscated__"
156 # Create an orphan, whose name is the same as its inode number
157 touch "${TEMP_ORPHAN}"
158 INUM=$(ls -i "${TEMP_ORPHAN}" | awk '{ print $1; }')
159 ORPHAN="${SCRATCH_MNT}/lost+found/${INUM}"
160 mv "${TEMP_ORPHAN}" "${ORPHAN}"
162 # Create non-orphan, which *should* be obfuscated
163 touch "${NON_ORPHAN}"
165 # Get a listing of all the files before obfuscation
166 ls -R >> "${seq}.full"
167 ls -R | od -c >> "${seq}.full"
169 # Now unmount the filesystem and create a metadump file
170 cd /; sync; sync # Old school
174 xfs_metadump -f "${SCRATCH_DEV}" "${METADUMP_FILE}"
176 # Now restore the obfuscated one back and take a look around
177 xfs_mdrestore "${METADUMP_FILE}" "${SCRATCH_DEV}"
181 # Get a listing of all the files after obfuscation
183 ls -R >> "${seq}.full"
184 ls -R | od -c >> "${seq}.full"
186 # Finally, re-make the filesystem since to ensure we don't
187 # leave a directory with duplicate entries lying around.
190 _scratch_mkfs >/dev/null 2>&1