Modify dassi QA scratch device
[xfstests-dev.git] / common.log
1 ##/bin/sh
2 #
3 # Copyright (c) 2000-2002 Silicon Graphics, Inc.  All Rights Reserved.
4 #
5 # common routines for log testing
6 # Created by dxm@sgi.com & tes@sgi.com
7 #
8
9 fulldir=$seq.fulldir
10 rm -rf $fulldir
11
12 _cleanup_logfiles()
13 {
14     if [ $status -eq 0 ]; then
15         # don't keep these files around unless something went wrong
16         rm -rf $fulldir
17     fi
18 }
19
20 _full()
21 {
22     echo ""            >>$seq.full      
23     echo "*** $* ***"  >>$seq.full
24     echo ""            >>$seq.full
25 }
26
27 _echofull()
28 {
29     echo ""            | tee -a $seq.full      
30     echo "*** $* ***"  | tee -a $seq.full
31     echo ""            | tee -a $seq.full
32 }
33
34 # Handle the operations which get split over Log Record
35 # boundaries.
36 # Oper (379)..... flags: CONTINUE
37 # ...
38 # Oper (0)....... flags: WAS_CONT END
39 #
40 # or
41 #
42 # Oper (379)..... flags: none 
43 # ...
44 # Oper (0)....... flags: none 
45 #
46 _filter_opnum()
47 {
48     $AWK_PROG '
49 BEGIN { 
50         debug = 0 
51         }
52 /^Oper/ && debug {
53             printf "line = %s\n", $0
54         }
55 /^Oper/ {
56             was_cont = 0
57         }
58 /^Oper/ && /flags: CONTINUE/ { 
59             # this will be the first op of split region
60             $9 = "none" # overwrite CONTINUE flags
61             print
62             print "Not printing rest"
63             was_cont = 1
64             next        
65         }
66 /^Oper/ && /flags: WAS_CONT END/ {
67             # this will be the last op of split region
68             # skip over was-continued op
69             # we assume there can be only 1
70             was_cont = 1
71             next        
72         }
73 (was_cont == 1) { 
74             # skip over any continued op stuff
75             next
76         }
77         {print}
78     '
79 }
80
81 #
82 # Filter out things that can change
83 # We have complexities which change when log is sync'ed at different
84 # times.
85 # Example1: DATA FORK EXTENTS
86 # These will not show up if inode is sync'ed sooner
87 #       /DATA FORK EXTENTS/d;
88 #       /INODE:/s/flags:0x5/flags:0x1/g;
89 # define XFS_ILOG_CORE   0x001   /* log standard inode fields */
90 # define XFS_ILOG_DEXT   0x004   /* log i_df.if_extents */
91 #
92 #
93
94 _filter_logprint()
95 {
96     _fix_malloc |\
97     sed '
98         s/data device: 0x[0-9a-f][0-9a-f]*/data device: <DEVICE>/;
99         s/log device: 0x[0-9a-f][0-9a-f]*/log device: <DEVICE>/;
100         s/log file: \".*\"/log device: <DEVICE>/;
101         s/daddr: [0-9][0-9]*/daddr: <DADDR>/;
102         s/length: [0-9][0-9]*/length: <LENGTH>/;
103         s/length: [0-9][0-9]*/length: <LENGTH>/;
104         s/^cycle num overwrites: .*$/cycle num overwrites: <TIDS>/;
105         s/tid: [0-9a-f][0-9a-f]*/tid: <TID>/;
106         s/tid:0x[0-9a-f][0-9a-f]*/tid:<TID>/;
107         s/q:0x[0-9a-f][0-9a-f]*/q:<Q>/;
108         s/a:0x[0-9a-f][0-9a-f]*/a:<A>/g;
109         s/blkno:0x[0-9a-f][0-9a-f]*/blkno:<BLKNO>/g;
110         s/blkno: *[0-9][0-9]* (0x[0-9a-f]*)/blkno: <BLKNO> (<BLKNO>)/g;
111         s/blkno: *[0-9][0-9]*/blkno: <BLKNO>/g;
112         s/boff: [0-9][0-9]*/boff: <BOFF>/g;
113         s/len: *[0-9][0-9]*/len:<LEN>/g;
114         /BUF:/s/[       ]*flags:.*$//;
115         /zeroed blocks/s/[0-9][0-9]*/<COUNT>/g;
116         /cleared blocks/d;
117         /log tail/s/[0-9][0-9]*/<COUNT>/g;
118         s/atime:[0-9a-fx]*  *mtime:[0-9a-fx]*  *ctime:[0-9a-fx]*/atime:<TIME>  mtime:<TIME>  ctime:<TIME>/;
119         s/atime 0x[0-9a-f]* mtime 0x[0-9a-f]* ctime 0x[0-9a-f]*/atime <TIME>  mtime <TIME>  ctime <TIME>/;
120         s/block [0-9][0-9]*/block <BLOCK>/;
121         s/icount: *[0-9][0-9]*  *ifree: *[0-9][0-9]*  *fdblks: *[0-9][0-9]*  *frext: *[0-9][0-9]*/icount:<COUNT> ifree:<FREE> fdblks:<BLOCKS> frext:<COUNT>/;
122         s/sunit: *[0-9][0-9]*  *swidth: *[0-9][0-9]*/sunit:<SUNIT> swidth:<SWIDTH>/;
123         s/1st: *[0-9][0-9]*  *last: *[0-9][0-9]*  *cnt: *[0-9][0-9]*  *freeblks: *[0-9][0-9]*  *longest: *[0-9][0-9]*/1st:<NUM> last:<NUM> cnt:<COUNT> freeblks:<COUNT> longest:<NUM>/;
124         s/^uuid: *[0-9a-f-][0-9a-f-]* *format: *.*$/uuid: <UUID> format: <FORMAT>/;
125         /flushiter:/d;
126         /version:/,/h_size:/d;
127         /override tail/s/[0-9][0-9]*/<TAIL_BLK>/;
128         /^---*/d;
129         /^===*/d;
130         /^~~~*/d;
131         /extended-header/d;
132         /LOG REC AT LSN/d;
133         /DATA FORK EXTENTS/d;
134         s/BUF: cnt:[1-9][0-9]* total:[1-9][0-9]*.*/BUF: cnt:C total:T/;
135         s/INO: cnt:[1-9][0-9]* total:[1-9][0-9]*.*/INO: cnt:C total:T/;
136         s/#regs: *[1-9][0-9]*/#regs:R/;
137         /INODE:/s/flags:0x5/flags:0x1/g;
138         s/Oper ([0-9][0-9]*)/Oper (OPNUM)/;
139         /^[     ]*$/d;
140         s/  */ /g;
141         s/ $//;
142         s/newino: 0x[0-9a-f]*$/newino: <INO>/g
143         s/newino:0x[0-9a-f]*$/newino:<INO>/g
144         s/ino: 0x[0-9a-f]* flags:/ino: <INO> flags:/g
145         s/ino:0x[0-9a-f]* flags:/ino:<INO> flags:/g
146     '|\
147     awk '
148         # collapse BUF DATA group into 1 line
149         # for Oper data this can be over separate operations...ughh
150         /BUF DATA/ { 
151                 if (!buf_data) { # 1st one
152                     if (oper) { 
153                         print oper
154                         oper = 0
155                     }           
156                     print
157                 }
158                 buf_data = 1
159                 oper = 0 # wont need it now
160                 next
161         }
162         /^Oper/ { 
163                 # store it as we dont know if 2nd BUF DATA is to follow
164                 if (oper) {
165                     print oper
166                 }
167                 oper = $0
168                 next
169         }
170         /^TRANS/ && dummy_rec == 1 {
171                 # start printing again - dummy transaction over
172                 dummy_rec = 0
173         }
174         /DUMMY1/ {
175                 # filter out dummy transactions
176                 dummy_rec = 1
177                 next
178         }
179         {
180                 if (dummy_rec) {
181                     next
182                 }
183                 buf_data = 0
184                 if (oper) { # now we can print out oper
185                     print oper
186                     oper = 0    
187                 }
188                 print
189         }
190     '
191 }
192
193 _check_log()
194 {
195     _full "clean_log : xfs_logprint"
196     _scratch_xfs_logprint -t | tee -a $seq.full \
197         | head | grep -q "<CLEAN>" || _fail "DIRTY LOG"
198 }
199
200 _print_logstate()
201 {
202     _scratch_xfs_logprint -t | tee -a $seq.full >$tmp.logprint
203     if grep -q "<DIRTY>" $tmp.logprint; then
204         echo "dirty log"
205     fi
206     if grep -q "<CLEAN>" $tmp.logprint; then
207         echo "clean log"
208     fi
209 }
210
211 _print_operation()
212 {
213     mkdir $fulldir >/dev/null 2>&1
214     mntopt=`echo $MOUNT_OPTIONS | sed 's/ //g'`
215     mkfsopt=`echo $MKFS_OPTIONS | sed 's/ //g'`
216     raw=$fulldir/op.mnt$mntopt.mkfs$mkfsopt$sync_suffix.raw
217     filtered=$fulldir/op.mnt$mntopt.mkfs$mkfsopt$sync_suffix.filtered
218
219     echo "### xfs_logprint output ###" | tee $raw >$filtered
220     _scratch_xfs_logprint -c  2>&1 \
221     | tee -a $raw      \
222     | _filter_logprint \
223     | _filter_opnum    \
224     >>$filtered
225 }
226
227 # start at rec#2 "-s 2" so we skip over UMOUNT record which will always
228 # be a 512b single header at mkfs time
229 # and may not match with the FS mounted at a different LR size 
230 # => xlog_do_recovery_pass() can not handle the different hdr sizes
231 #    it assumes them all to be the same between the start..finish
232 # NB: On IRIX there is no UMOUNT record and so we could start from -s 0.
233
234 _print_transaction_inode()
235 {
236     _start=$1
237     mkdir $fulldir >/dev/null 2>&1
238     mntopt=`echo $MOUNT_OPTIONS | sed 's/ //g'`
239     mkfsopt=`echo $MKFS_OPTIONS | sed 's/ //g'`
240     raw=$fulldir/trans_inode.mnt$mntopt.mkfs$mkfsopt$sync_suffix.raw
241     filtered=$fulldir/trans_inode.mnt$mntopt.mkfs$mkfsopt$sync_suffix.filtered
242
243     echo "### xfs_logprint -t -i -s START output ###" | tee $raw >$filtered
244     _scratch_xfs_logprint -t -i -s $_start 2>&1 \
245     | tee -a $raw      \
246     | _filter_logprint \
247     >>$filtered
248 }
249
250 _print_transaction_buf()
251 {
252     _start=$1
253     mkdir $fulldir >/dev/null 2>&1
254     mntopt=`echo $MOUNT_OPTIONS | sed 's/ //g'`
255     mkfsopt=`echo $MKFS_OPTIONS | sed 's/ //g'`
256     raw=$fulldir/trans_buf.mnt$mntopt.mkfs$mkfsopt$sync_suffix.raw
257     filtered=$fulldir/trans_buf.mnt$mntopt.mkfs$mkfsopt$sync_suffix.filtered
258
259     echo "### xfs_logprint -t -b -s START output ###" | tee $raw >$filtered
260     _scratch_xfs_logprint -t -b -s $_start 2>&1 \
261     | tee -a $raw      \
262     | _filter_logprint \
263     >>$filtered
264 }
265
266 _mkfs_log()
267 {
268     # create the FS
269     # mkfs options to append to log size otion can be specified ($*)
270     export MKFS_OPTIONS="-l size=2000b $*"
271     _full "mkfs"
272     _scratch_mkfs_xfs >>$seq.full 2>&1
273     if [ $? -ne 0 ] ; then 
274         _echofull "Cannot mkfs for this test using option specified: $MKFS_OPTIONS"
275         return 1
276     fi  
277
278     return 0
279 }
280
281
282 #
283 # mount fs and create some log traffic
284 #
285 _create_log()
286 {
287     # mount the FS
288     _full "mount"
289     _scratch_mount >>$seq.full 2>&1
290     if [ $? -ne 0 ] ; then 
291         _echofull "mount failed: $MOUNT_OPTIONS"
292         return 1
293     fi
294
295     # generate some log traffic - but not too much - life gets a little
296     # more complicated if the log wraps around. This traffic is
297     # pretty much arbitary, but could probably be made better than this.
298     touch $SCRATCH_MNT/{0,1,2,3,4,5,6,7,8,9}{0,1,2,3,4,5,6,7,8,9}
299         
300     # unmount the FS
301     _full "umount"
302     umount $SCRATCH_DEV >>$seq.full 2>&1
303     if [ $? -ne 0 ] ; then 
304         _echofull "umount failed"
305         return 1
306     fi
307
308     return 0
309 }
310
311 #
312 # mount fs and create some log traffic with sync'ing
313 #
314 _create_log_sync()
315 {
316     # mount the FS
317     _full " mount"
318     _scratch_mount >>$seq.full 2>&1
319     if [ $? -ne 0 ] ; then 
320         _echofull "mount failed: $MOUNT_OPTIONS"
321         return 1
322     fi
323
324     # generate some log traffic - but not too much
325     # add some syncs to get the log flushed to disk 
326     for file in $SCRATCH_MNT/{0,1,2,3,4,5,6,7,8,9}{0,1,2,3,4,5,6,7,8,9}; do
327         touch $file
328         sync
329     done
330
331     # unmount the FS
332     _full "umount"
333     umount $SCRATCH_DEV >>$seq.full 2>&1
334     if [ $? -ne 0 ] ; then 
335         _echofull "umount failed"
336         return 1
337     fi
338 }
339
340 _cmp_output()
341 {
342     echo "*** compare logprint: $1 with $2"
343     if ! diff $1 $2 >/dev/null; then
344         _fail "logprint output $1 differs to $2"
345     fi
346 }
347
348 #
349 # Op data of different Log Record sizes will mean that data is
350 # split at different points and in op printing it will not
351 # try and decode the data which has been split up.
352 # So we do a special diff processing to complain of differences
353 # if no split is involved.
354 #
355 # Example diff with forms of:
356 # "Left over region from split log item"
357 # "Not printing rest of data"
358 #
359 #   2149c2149
360 #   < Left over region from split log item
361 #   ---
362 #   > BUF DATA
363 #   2888c2888,2889
364 #   < INODE: #regs: 3 Not printing rest of data
365 #   ---
366 #   > INODE: #regs: 3 ino: 0x80 flags: 0x5 dsize: 16
367 #   >  blkno: <BLKNO> len:<LEN> boff: <BOFF>
368 #
369 _process_op_diff()
370 {
371     $AWK_PROG <$1 '
372         BEGIN { num_splits = 1; max_splits = 50 }
373         /^[0-9]/ {
374
375                 # ensure a split happened in previous difference
376                 if (num_splits < 1 || num_splits > max_splits) {
377                         print num_splits, " split(s) found prior to diff cmd: ", $0
378                         num_splits = 1 # shut-up end condition
379                         exit 1
380                 }
381                 num_splits = 0
382
383                 next
384         }
385         /Left over region/ || /Not printing rest/ { 
386                 num_splits++
387                 next
388         }
389         { next }
390         END { 
391                 if (num_splits < 1 || num_splits > max_splits) {
392                         print num_splits, " split(s) found prior to diff end"
393                         exit 1
394                 }
395         }
396     '
397     return $?
398 }
399
400 _cmp_op_output()
401 {
402     echo "*** compare logprint: $1 with $2"
403
404     diff $1 $2 >$filtered.diff
405     if ! _process_op_diff $filtered.diff
406     then
407         _fail "logprint output $1 differs to $2 considering splits"
408     fi
409 }
410
411 # return xfs log version of device
412 # e.g.
413 #   _log_version /dev/dsk/dks0d1s4
414 #
415 _log_version()
416 {
417     _dev=$1 
418     vers=`xfs_db -c 'sb 0' -c 'p versionnum' -r $_dev | $AWK_PROG '{print $3}'`
419     logver=`echo $vers | sed -e 's/0x[0-9a-f]\([0-9a-f]\)[0-9a-f][0-9a-f]/\1/'` 
420     if [ $logver = 4 -o $logver = 5 -o $logver = 6 -o $logver = 7 -o \
421          $logver = c -o $logver = d -o $logver = e -o $logver = f ]; then
422         echo 2
423     else
424         echo 1
425     fi
426 }
427
428 _require_v2log()
429 {
430     # test out mkfs to see if it supports "-l version=2"
431     export MKFS_OPTIONS="-l version=2"
432     if ! _scratch_mkfs_xfs >>$seq.full 2>&1; then
433         _notrun "mkfs does not support v2 logs"
434     fi
435
436     # test out mount to see if it mounts a v2 log fs
437     export MOUNT_OPTIONS="-o logbsize=32k"
438     if ! _scratch_mount >>$seq.full 2>&1; then
439         _notrun "mount/kernel does not support v2 logs"
440     fi
441
442     # check after unmount to see if it is clean
443     # i.e. it is not a 6.5.25 buggy version checking kernel
444     touch $SCRATCH_MNT/file
445     umount $SCRATCH_DEV >>$seq.full 2>&1
446     if _scratch_xfs_logprint -t | tee -a $seq.full \
447         | head | grep -q "<DIRTY>"; then
448         _notrun "kernel does not support v2 logs"
449     fi
450  
451     # otherwise presume it does support v2 logs...:)
452 }
453
454
455 # make sure this script returns success
456 /bin/true