xfstests updates - rework build to be like other xfs packages, revive some old fs...
[xfstests-dev.git] / common.dump
1 #/bin/sh
2
3 #
4 # Functions useful for xfsdump/xfsrestore tests
5 #
6 # Copyright (c) 2000-2002 Silicon Graphics, Inc.  All Rights Reserved.
7
8 # This program is free software; you can redistribute it and/or modify it
9 # under the terms of version 2 of the GNU General Public License as
10 # published by the Free Software Foundation.
11
12 # This program is distributed in the hope that it would be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15
16 # Further, this software is distributed without any warranty that it is
17 # free of the rightful claim of any third person regarding infringement
18 # or the like.  Any license provided herein, whether implied or
19 # otherwise, applies only to this software file.  Patent licenses, if
20 # any, provided herein do not apply to combinations of this program with
21 # other software, or any other product whatsoever.
22
23 # You should have received a copy of the GNU General Public License along
24 # with this program; if not, write the Free Software Foundation, Inc., 59
25 # Temple Place - Suite 330, Boston MA 02111-1307, USA.
26
27 # Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
28 # Mountain View, CA  94043, or:
29
30 # http://www.sgi.com 
31
32 # For further information regarding this notice, see: 
33
34 # http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
35 #
36
37 # --- initializations ---
38 rm -f $here/$seq.full
39
40 if [ -n "$DEBUGDUMP" ]; then
41   _dump_debug=-v5
42   _restore_debug=-v5
43   _invutil_debug=-d
44 fi
45  
46 # Use dump/restore in qa directory for debugging
47 PATH="$here:$PATH"
48 export PATH
49 #which xfsdump
50 #which xfsrestore
51 #which xfsinvutil
52
53 # status returned for not run tests
54 NOTRUNSTS=2
55
56 # name those directories
57 dump_file=$tmp.dumpfile
58 # dump_file=$here/dumpfile #TEMP OVERRIDE DUMP FILE
59 dump_sdir=dumpdir
60 dump_dir=$SCRATCH_MNT/$dump_sdir
61 restore_sdir=restoredir
62 restore_dir=$SCRATCH_MNT/$restore_sdir
63 multi=3
64 dumptape=$TAPE_DEV
65 media_label="stress_tape_media"
66 session_label="stress_$seq"
67
68 nobody=4 # define this uid/gid as a number
69 do_quota_check=true # do quota check if quotas enabled
70
71 _need_to_be_root
72
73 # install our cleaner
74 trap "_cleanup; exit \$status" 0 1 2 3 15
75
76 # start inventory from a known base - move it aside for test
77 for dir in /var/xfsdump/inventory /var/lib/xfsdump/inventory; do
78     if [ -d $dir ]; then
79         [ -d $dir.$seq ] && rm -rf $dir.$seq
80         mv $dir $dir.$seq
81     fi
82 done
83
84 have_mtvariable=false
85 [ `uname` = "Linux" ] && have_mtvariable=true
86
87 #
88 # do a remote/local mt
89 #
90 _mt()
91 {
92     op=$1
93     if _isrmt; then  
94         # REMOTE
95         _rmtdev=`echo $dumptape | $AWK_PROG -F: '{print $2}'`
96
97         if echo $dumptape | grep '@' >/dev/null; then
98             _spec=`echo $dumptape | $AWK_PROG -F: '{print $1}'`
99             _rmtuser=`echo $_spec | $AWK_PROG -F@ '{print $1}'`
100             _rmthost=`echo $_spec | $AWK_PROG -F@ '{print $2}'`
101             rsh -n -l $_rmtuser $_rmthost "mt -t $_rmtdev $op"
102         else
103             _rmthost=`echo $dumptape | $AWK_PROG -F: '{print $1}'`
104             rsh -n $_rmthost "mt -t $_rmtdev $op"
105         fi
106     else
107         #LOCAL
108         mt -t $dumptape $op
109     fi
110 }
111
112 _check_onl()
113 {
114     _limit=10
115     i=0
116     while [ $i -lt $_limit ]; do  
117         echo "Checking online..." >>$here/$seq.full
118         if _mt status >$tmp.status 2>&1; then
119             break; 
120         else
121             sleep 2 
122         fi
123         i=`expr $i + 1`
124     done
125
126
127     if [ $i -eq $_limit ]; then
128         echo "ERROR: mt -f $dumptape failed"
129         cat $tmp.status
130
131         echo "mt -f $dumptape failed" >$seq.notrun 
132         status=$NOTRUNSTS
133         exit
134     fi 
135
136
137     if egrep -i 'onl|ready' $tmp.status | grep -iv 'not ready' >/dev/null; then
138         :
139     else
140         echo "ERROR: $dumptape is not online"
141         cat $tmp.status
142
143         echo "dumptape, $dumptape, is not online" >$seq.notrun 
144         status=$NOTRUNSTS
145         exit
146     fi
147 }
148
149 _wait_tape()
150 {
151     echo "Wait for tape, $dumptape, ..." >>$here/$seq.full
152
153     i=0
154     while [ $i -lt 20 ]; do  
155         echo "Checking status..." >>$here/$seq.full
156         if _mt status 2>&1 | tee -a $here/$seq.full | egrep -i "onl|ready" >/dev/null; then
157             break; 
158         else
159             sleep 2 
160         fi
161         i=`expr $i + 1`
162     done
163 }
164
165 #
166 # Keep trying so we know we really have rewound
167 #
168 _rewind()
169 {
170     echo "Initiate rewind..." >>$here/$seq.full
171     _wait_tape
172     _mt rewind >/dev/null
173     _wait_tape
174 }
175
176 #
177 # Do a custom erase because: 
178 # (i) some machines don't support it
179 # (ii) some machines take forever to do it
180 #
181 _erase_soft()
182 {
183     echo "Erasing tape" | tee -a $here/$seq.full
184     _rewind
185     _mt weof 3
186     _rewind
187 }
188
189 _erase_hard()
190 {
191     echo "Erasing tape" | tee -a $here/$seq.full
192     _mt erase
193 }
194
195 _isrmt()
196 {
197     echo $dumptape | grep ':' >/dev/null
198 }
199
200 #
201 # Get tape ready
202 #
203 _set_variable()
204 {
205     $have_mtvariable || return
206
207     if _isrmt; then
208         :
209     else
210         # LOCAL
211         echo "Put scsi tape driver into variable block size mode"
212         mt -f $dumptape setblk 0
213     fi  
214 }
215
216 _require_tape()
217 {
218     dumptape=$1
219
220     if [ -z "$dumptape" ]; then
221         echo "This test requires a dump tape - none was specified"
222         echo "No dump tape specified" >$seq.notrun 
223         status=$NOTRUNSTS
224         exit
225     fi
226
227     _check_onl
228     _set_variable
229 }
230
231 _wipe_fs()
232 {
233     _require_scratch
234
235     _scratch_mkfs_xfs >>$here/$seq.full || _fail "mkfs failed"
236     _scratch_mount >>$here/$seq.full || _fail "mount failed"
237 }
238
239
240 # Cleanup created dirs and files
241 # Called by trap
242 #
243 _cleanup()
244 {
245     cd $here
246     rm -f $tmp.*
247
248     if [ -n "$DEBUGDUMP" ]; then
249         # save it for inspection
250         for dir in /var/xfsdump/inventory /var/lib/xfsdump/inventory; do
251             [ -d $dir ] || continue
252             tar -cvf $seq.inventory.tar $dir
253             ls -lR $dir >$seq.inventory.ls
254         done
255     fi
256
257     # put inventory dir back
258     for dir in /var/xfsdump/inventory /var/lib/xfsdump/inventory; do
259         [ -d $dir.$seq ] || continue
260         rm -rf $dir             # get rid of new one
261         mv $dir.$seq $dir
262     done
263
264     if [ $status -ne $NOTRUNSTS ]; then
265         # Sleep added to stop _check_scratch_fs from complaining that the
266         # scratch_dev is still busy
267         sleep 10
268
269         _check_scratch_fs
270     fi
271 }
272
273 #
274 # ensure that bulkstat data will
275 # match with incore data
276 # by forcing disk data to be written out
277 #
278 _stable_fs()
279 {
280     _saveddir=`pwd`; cd /
281     umount $SCRATCH_MNT >>$here/$seq.full || _fail "unmount failed"
282     _scratch_mount >>$here/$seq.full || _fail "mount failed"
283     cd $_saveddir
284 }
285
286 #
287 # Run fsstress to create a mixture of 
288 # files,dirs,links,symlinks
289 #
290 # Pinched from test 013.
291 #
292 _create_dumpdir_stress()
293 {
294     echo "Creating directory system to dump using fsstress."
295
296     _wipe_fs
297
298     _param="-f link=10 -f creat=10 -f mkdir=10 -f truncate=5 -f symlink=10"
299     _count=200
300     rm -rf $dump_dir
301     if ! mkdir $dump_dir; then
302         echo "    failed to mkdir $dump_dir"
303         status=1
304         exit
305     fi
306     echo ""
307     echo "-----------------------------------------------"
308     echo "fsstress : $_param"
309     echo "-----------------------------------------------"
310     if ! $here/ltp/fsstress $_param -s 1 $FSSTRESS_AVOID -n $_count -d $dump_dir >$tmp.out 2>&1
311     then
312         echo "    fsstress (count=$_count) returned $? - see $here/$seq.full"
313         
314         echo "--------------------------------------"       >>$here/$here/$seq.full
315         echo "output from fsstress:"                        >>$here/$here/$seq.full
316         echo "--------------------------------------"       >>$here/$here/$seq.full
317         cat $tmp.out                                        >>$here/$here/$seq.full
318         status=1
319     fi
320
321     _stable_fs
322 }
323
324 _mk_fillconfig1()
325 {
326     cat <<End-of-File >$tmp.config
327 # pathname      size in bytes   owner   group
328 #
329 small           10      $nobody $nobody
330 big             102400  daemon  sys
331 sub/small       10      bin     bin
332 sub/big         102400  $nobody sys
333 #
334 sub/a           1       $nobody $nobody
335 sub/b           2       $nobody $nobody
336 sub/c           4       $nobody $nobody
337 sub/d           8       $nobody $nobody
338 sub/e           16      $nobody $nobody
339 sub/f           32      $nobody $nobody
340 sub/g           64      $nobody $nobody
341 sub/h           128     $nobody $nobody
342 sub/i           256     $nobody $nobody
343 sub/j           512     $nobody $nobody
344 sub/k           1024    $nobody $nobody
345 sub/l           2048    $nobody $nobody
346 sub/m           4096    $nobody $nobody
347 sub/n           8192    $nobody $nobody
348 #
349 sub/a00         100     $nobody $nobody
350 sub/b00         200     $nobody $nobody
351 sub/c00         400     $nobody $nobody
352 sub/d00         800     $nobody $nobody
353 sub/e00         1600    $nobody $nobody
354 sub/f00         3200    $nobody $nobody
355 sub/g00         6400    $nobody $nobody
356 sub/h00         12800   $nobody $nobody
357 sub/i00         25600   $nobody $nobody
358 sub/j00         51200   $nobody $nobody
359 sub/k00         102400  $nobody $nobody
360 sub/l00         204800  $nobody $nobody
361 sub/m00         409600  $nobody $nobody
362 sub/n00         819200  $nobody $nobody
363 #
364 sub/a000        1000    $nobody $nobody
365 sub/e000        16000   $nobody $nobody
366 sub/h000        128000  $nobody $nobody
367 sub/k000        1024000 $nobody $nobody
368 End-of-File
369 }
370
371 _mk_fillconfig2()
372 {
373     cat <<End-of-File >$tmp.config
374 # pathname      size in bytes
375 #
376 smalll          10      $nobody $nobody
377 biggg           102400  $nobody $nobody
378 sub/smalll      10      $nobody $nobody
379 sub/biggg       102400  $nobody $nobody
380 End-of-File
381 }
382
383 _mk_fillconfig_perm()
384 {
385     # dir_guid: ugo=rwx,g+s on dir is for IRIX chmod(1)
386
387     cat <<End-of-File >$tmp.config
388 # pathname      size/dir  user group mode
389 #
390 file_suid       10      $nobody $nobody 04777
391 file_guid       10      $nobody $nobody 02777
392 file_sticky     10      $nobody $nobody 01777
393 file_mix1       10      $nobody $nobody 761
394 file_mix2       10      $nobody $nobody 642
395 dir_suid        d       $nobody $nobody 04777
396 dir_guid        d       $nobody $nobody ugo=rwx,g+s
397 dir_sticky      d       $nobody $nobody 01777
398 dir_mix1        d       $nobody $nobody 761
399 dir_mix2        d       $nobody $nobody 642
400 End-of-File
401 }
402
403 _mk_fillconfig_ea()
404 {
405     cat <<End-of-File >$tmp.config
406 # pathname      size    user    group    perm   name value namespace
407 #
408 smalll          10      $nobody $nobody  777    attr1 some_text   user 
409 biggg           102400  $nobody $nobody  777    attr2 some_text2  root
410 sub/smalll      10      $nobody $nobody  777    attr3 some_text3  user
411 sub/biggg       102400  $nobody $nobody  777    attr4 some_text4  root
412 dir             d       $nobody $nobody  777    attr5 dir_text    user
413 #
414 # Add more files so that there are more than the number
415 # of streams.
416 # There are bugs in dump/restore for # non-dir files < # streams
417 # It can be tested in another configuration.
418 # It is a pathalogical case.
419 #
420 sub/a           1       $nobody $nobody
421 sub/b           2       $nobody $nobody
422 sub/c           4       $nobody $nobody
423 sub/d           8       $nobody $nobody
424 sub/e           16      $nobody $nobody
425 sub/f           32      $nobody $nobody
426 sub/g           64      $nobody $nobody
427 sub/h           128     $nobody $nobody
428 sub/i           256     $nobody $nobody
429 sub/j           512     $nobody $nobody
430 sub/k           1024    $nobody $nobody
431 sub/l           2048    $nobody $nobody
432 sub/m           4096    $nobody $nobody
433 sub/n           8192    $nobody $nobody
434 End-of-File
435 }
436
437 #
438 # Create a bunch of directories/files of different sizes
439 # filled with data.
440 #
441 # Pinched from test 001.
442 #
443 _do_create_dumpdir_fill()
444 {
445     echo "Creating directory system to dump using src/fill."
446
447     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
448     cd $dump_dir
449
450     $verbose && echo -n "Setup "
451     sed -e '/^#/d' $tmp.config \
452     | while read file nbytes owner group perms ea_name ea_value namespace
453     do
454         if [ $nbytes = "d" ]; then
455             # create a directory
456             dir=$file   
457             if [ ! -d $dir ]
458             then
459                 if mkdir $dir
460                 then
461                     :
462                 else
463                     $verbose && echo
464                     echo "Error: cannot mkdir \"$dir\""
465                     exit 1
466                 fi
467             fi
468         else
469             # create a directory/file
470             dir=`dirname $file`
471             if [ "$dir" != "." ]
472             then
473                 if [ ! -d $dir ]
474                 then
475                     if mkdir $dir
476                     then
477                         :
478                     else
479                         $verbose && echo
480                         echo "Error: cannot mkdir \"$dir\""
481                         exit 1
482                     fi
483                 fi
484             fi
485             rm -f $file
486             if $here/src/fill $file $file $nbytes
487             then
488                 :
489             else
490                 $verbose && echo
491                 echo "Error: cannot create \"$file\""
492                 exit 1
493             fi
494         fi
495         if [ -n "$owner" -a -n "$group" ]; then
496             chown $owner.$group $file
497         fi
498         if [ -n "$perms" ]; then
499             chmod $perms $file
500         fi
501         if [ -n "$ea_name" -a -n "$ea_value" ]; then
502             if [ "X$namespace" = "Xroot" ]; then
503                 attr -R -s $ea_name -V $ea_value $file
504             else
505                 attr -s $ea_name -V $ea_value $file
506             fi
507         fi
508         $verbose && echo -n "."
509     done
510     $verbose && echo
511
512     cd $here
513 }
514
515 _create_dumpdir_largefile()
516 {
517     _wipe_fs
518     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
519     _largesize=4294967297
520     _largefile=$dump_dir/largefile
521     echo "dd a largefile at offset $_largesize"
522     POSIXLY_CORRECT=yes \
523     dd if=/dev/zero of=$_largefile bs=1 seek=$_largesize count=10 2>&1
524     _stable_fs
525 }       
526
527 _create_dumpdir_fill()
528 {
529     _wipe_fs
530     _mk_fillconfig1
531     _do_create_dumpdir_fill
532     _stable_fs
533 }       
534
535 _create_dumpdir_fill2()
536 {
537     _wipe_fs
538     _mk_fillconfig2
539     _do_create_dumpdir_fill
540     _stable_fs
541 }       
542
543 _create_dumpdir_fill_perm()
544 {
545     _wipe_fs
546     _mk_fillconfig_perm
547     _do_create_dumpdir_fill
548     _stable_fs
549 }       
550
551 _create_dumpdir_fill_ea()
552 {
553     _wipe_fs
554     _mk_fillconfig_ea
555     _do_create_dumpdir_fill
556     _stable_fs
557 }       
558
559
560 #
561 # Append a subset of the fill'ed files
562 # So we can see if just these get dumped on an incremental
563 #
564 _append_dumpdir_fill()
565 {
566     cd $dump_dir
567     cat <<End-of-File >$tmp.config
568 # pathname
569 #
570 small   
571 sub/big 
572 #
573 sub/a
574 sub/c
575 sub/e
576 End-of-File
577     sed -e '/^#/d' $tmp.config \
578     | while read file
579     do
580         echo 'Extra text' >>$file
581     done
582
583     cd $here
584     _stable_fs
585 }
586
587 _do_create_dump_symlinks()
588 {
589     echo "Creating directory system of symlinks to dump."
590
591     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
592     cd $dump_dir
593
594     $verbose && echo -n "Setup "
595     sed -e '/^#/d' $tmp.config \
596     | while read file nbytes owner group owner2 group2 perms perms2
597     do
598         dir=`dirname $file`
599         if [ "$dir" != "." ]
600         then
601             if [ ! -d $dir ]
602             then
603                 if mkdir $dir
604                 then
605                     :
606                 else
607                     $verbose && echo
608                     echo "Error: cannot mkdir \"$dir\""
609                     exit 1
610                 fi
611             fi
612         fi
613         rm -f $file
614         touch $file
615
616         # Do chmod on symlink using umask.
617         # This won't do the right thing as it subtracts permissions.
618         # However, I don't care, as long as I get some different perms
619         # for testing.
620         if [ -n "$perms2" ]; then
621             omask=`umask`
622             umask $perms2
623         fi
624         ln -s $file $file-link
625         if [ -n "$perms2" ]; then
626             umask $omask        
627         fi
628
629         if [ -n "$owner" -a -n "$group" ]; then
630             chown $owner.$group $file
631         fi
632         if [ -n "$owner" -a -n "$group" ]; then
633             chown -h $owner.$group $file-link
634         fi
635         if [ -n "$perms" ]; then
636             chmod $perms $file
637         fi
638         $verbose && echo -n "."
639     done
640     $verbose && echo
641
642     cd $here
643 }
644
645 _mk_symlink_config()
646 {
647     cat <<End-of-File >$tmp.config
648 # path  size    owner1  group1  owner2  group2  perm1   perm2 
649 #
650 a       0       $nobody $nobody daemon  sys     124     421
651 b       0       daemon  sys     bin     bin     347     743
652 sub/a   0       bin     bin     $nobody sys     777     777
653 sub/b   0       $nobody sys     $nobody $nobody 367     763
654 End-of-File
655 }
656
657 _create_dumpdir_symlinks()
658 {
659     _wipe_fs
660     _mk_symlink_config
661     _do_create_dump_symlinks
662     _stable_fs
663 }       
664
665 #
666 # create hardlinks of form $_fname, $_fname_h1 $_fname_h2 ...
667 #
668 _create_hardlinks()
669 {
670     _fname=$1   
671     _numlinks=$2
672
673     touch $_fname
674     _j=1
675     while [ $_j -le $_numlinks ]; do
676         _suffix=_h$_j
677         _hardlink=$_fname$_suffix
678         echo "creating hardlink $_hardlink to $_fname"
679         ln $_fname $_hardlink
680         _j=`expr $_j + 1`
681     done
682 }
683
684 #
685 # create a set of hardlinks
686 # create hardlinks of form file1, file1_h1 file1_h2 ...
687 # create hardlinks of form file2, file2_h1 file2_h2 ...
688 # create hardlinks of form file3, file3_h1 file3_h2 ...
689 #
690 _create_hardset()
691 {
692     _numsets=$1
693     _i=1
694     while [ $_i -le $_numsets ]; do
695         _create_hardlinks file$_i 5
696         _i=`expr $_i + 1`
697     done
698 }
699
700
701 _modify_level()
702 {
703     _level=$1
704     echo "mod level $_level" >$dump_dir/file$_level
705 }
706
707 _create_dumpdir_hardlinks()
708 {
709     _numsets=$1
710     _wipe_fs
711     echo "Creating directory system of hardlinks to incrementally dump."
712
713     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
714     cd $dump_dir
715
716     _create_hardset $_numsets
717
718     cd $here
719     _stable_fs
720 }
721
722 #
723 # Filter for ls
724 # Filter out dates on symlinks and char devices
725 #
726 _ls_filter()
727 {
728   $AWK_PROG '
729         /^l/ { date = $8; sub(date,"DATE"); print}
730         /^c/ { date = $9; sub(date,"DATE"); print}
731         {print}' \
732   | sed -e 's/total [0-9][0-9]*/total TOTAL/'
733 }
734
735
736
737 # Filter out the non-deterministic dump msgs from
738 # xfsdump and xfsrestore
739 #
740 _dump_filter_main()
741 {
742   sed \
743       -e "s/`hostname`/HOSTNAME/"   \
744       -e "s#$SCRATCH_DEV#SCRATCH_DEV#"    \
745       -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
746       -e "s#$dumptape#TAPE_DEV#"    \
747       -e "s#$SCRATCH_MNT#SCRATCH_MNT#"    \
748       -e "s#$dump_file#DUMP_FILE#"  \
749       -e 's#/var/lib/xfsdump#/var/xfsdump#' \
750       -e 's/id:[        ]*[0-9a-f-]*/id: ID/'  \
751       -e 's/time:[      ].*/time: TIME/'       \
752       -e 's/date:[      ].*/date: DATE/'       \
753       -e 's/dump begun .*/dump begun DATE/'    \
754       -e 's/[0-9][0-9]* seconds/SECS seconds/' \
755       -e 's/restore.[0-9][0-9]*/restore.PID/' \
756       -e 's/ino [0-9][0-9]*/ino INO/' \
757       -e '/: dump size/s/[0-9][0-9]*/NUM/'     \
758       -e '/dump size:/s/[0-9][0-9]*/NUM/'      \
759       -e '/dump size per stream:/s/[0-9][0-9]*/NUM/' \
760       -e 's/\(media file size[   ]*\)[0-9][0-9]*/\1NUM/' \
761       -e 's/\(mfile size:[       ]*\)[0-9][0-9]*/\1NUM/' \
762       -e '/drive[        ]*[0-9][0-9]*:/d' \
763       -e '/\/dev\/tty/d' \
764       -e '/inventory session uuid/d' \
765       -e '/ - Running single-threaded/d' \
766       -e '/^.*I\/O metrics: .*$/d' \
767       -e 's/1048576/BLOCKSZ/' \
768       -e 's/2097152/BLOCKSZ/' \
769       -e 's/(pid[        ]*[1-9][0-9]*)/\(pid PID\)/' \
770   | perl -ne '
771       if ($_ =~ /(?:Dump|Restore) Summary/) {
772         $skip = 1;
773       } elsif ($_ =~ /(?:Dump|Restore) Status/) {
774         $skip = 0;
775       }
776       print if (! $skip);'
777 }
778
779 _dump_filter()
780 {
781    if $do_quota_check
782    then
783        _dump_filter_main | _check_quota_dumprestore | _check_quota_entries
784    else
785        _dump_filter_main
786    fi
787 }
788
789 _invutil_filter()
790 {
791   _dump_filter_main \
792   | sed \
793         -e 's/UUID[     ]*:[    ][0-9a-f-]*/UUID                :       ID/' \
794         -e 's/TIME OF DUMP[     ]*:.*/TIME OF DUMP      :       TIME/' \
795         -e 's/HOSTNAME:SCRATCH_MNT.*/HOSTNAME:SCRATCH_MNT/' \
796         -e 's#inventory/[0-9a-f-]*#inventory/UUID#' \
797
798 }
799
800
801 _dir_filter()
802 {
803   sed \
804     -e "s#$dump_file#DUMP_FILE#"      \
805     -e "s#$SCRATCH_DEV#SCRATCH_DEV#"        \
806     -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
807     -e "s#$dumptape#TAPE_DEV#"         \
808     -e "s#$dump_dir#DUMP_DIR#g"       \
809     -e "s#$restore_dir#RESTORE_DIR#g" \
810     -e "s#$SCRATCH_MNT#SCRATCH_MNT#g"       \
811     -e "s#$dump_sdir#DUMP_SUBDIR#g"   \
812     -e "s#$restore_sdir#RESTORE_SUBDIR#g" \
813     -e "s#$$#PID#g" \
814
815 }
816
817 #
818 # Note: requires a space between option letter and argument 
819 #
820 _parse_args()
821 {
822     OPTIND=0
823     dump_args=""
824     while [ $# -gt 0 ]
825     do
826         case $1
827         in
828         -f)
829             [ -z "$2" ] && _fail "missing argument for -f"
830             dumptape=$2 
831             shift
832             ;;
833         -L)
834             [ -z "$2" ] && _fail "missing argument for -L"
835             session_label=$2
836             shift
837             ;;
838         -o)
839             dump_args="$dump_args -o"
840             ;;
841         -F)
842             dump_args="$dump_args -F"
843             ;;
844         --multi)
845             multi=$2
846             shift
847             ;;
848         -q)
849             do_quota_check=true
850             ;;
851         -Q)
852             do_quota_check=false
853             ;;
854         -l)
855             [ -z "$2" ] && _fail "missing argument for -l"
856             dump_args="$dump_args -l$2"
857             shift
858             ;;
859         *)
860             _fail "invalid argument to common.dump function: $1"
861             ;;
862         esac
863         shift
864     done
865 }
866
867
868 #
869 # Dump a subdir
870 #
871 _do_dump_sub()
872 {
873     _parse_args $*
874
875     echo "Dumping to tape..."
876     opts="$_dump_debug$dump_args -s $dump_sdir -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
877     echo "xfsdump $opts" | _dir_filter  
878     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
879 }
880
881 #
882 # Do dump to tape
883 #
884 _do_dump()
885 {
886     _parse_args $*
887
888     echo "Dumping to tape..."
889     opts="$_dump_debug$dump_args -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
890     echo "xfsdump $opts" | _dir_filter  
891     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
892 }
893
894
895 #
896 # Do full dump with -m
897 #
898 _do_dump_min()
899 {
900     _parse_args $*
901
902     echo "Dumping to tape..."
903     onemeg=1048576
904     opts="$_dump_debug$dump_args -m -b $onemeg -l0 -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
905     echo "xfsdump $opts" | _dir_filter  
906     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
907 }
908
909
910 #
911 # Do full dump to file
912 #
913 _do_dump_file()
914 {
915     _parse_args $*
916
917     echo "Dumping to file..."
918     opts="$_dump_debug$dump_args -f $dump_file -M $media_label -L $session_label $SCRATCH_MNT"
919     echo "xfsdump $opts" | _dir_filter  
920     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
921 }
922
923 #
924 # Do full dump to multiple files
925 #
926 _do_dump_multi_file()
927 {
928     _parse_args "$@"
929
930     multi_args=""
931
932     i=0
933     while [ $i -lt $multi ]
934     do
935         multi_args="$multi_args -f $dump_file.$i -M $media_label.$i"
936         i=`expr $i + 1`
937     done
938
939     echo "Dumping to files..."
940     opts="$_dump_debug$dump_args $multi_args -L $session_label $SCRATCH_MNT"
941     echo "xfsdump $opts" | _dir_filter  
942     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
943 }
944
945
946 _prepare_restore_dir()
947 {
948     rm -rf $restore_dir
949     mkdir $restore_dir || _fail "failed to mkdir $restore_dir"
950 }
951
952
953 #
954 # Get tape ready and restore dir
955 #
956 _prepare_restore()
957 {
958     _prepare_restore_dir
959
960     echo "Rewinding tape"
961     _rewind
962 }
963
964 #
965 # Restore the tape into $restore_dir
966 #
967 _do_restore()
968 {
969     _parse_args $*
970     _prepare_restore
971
972
973     echo "Restoring from tape..."
974     opts="$_restore_debug -f $dumptape  -L $session_label $restore_dir"
975     echo "xfsrestore $opts" | _dir_filter  
976     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
977 }
978
979 #
980 # Restore the tape into $restore_dir using -m
981 #
982 _do_restore_min()
983 {
984     _parse_args $*
985     _prepare_restore
986
987     echo "Restoring from tape..."
988     onemeg=1048576
989     opts="$_restore_debug -m -b $onemeg -f $dumptape  -L $session_label $restore_dir"
990     echo "xfsrestore $opts" | _dir_filter  
991     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
992 }
993
994 #
995 # Restore the tape from a dump file
996 #
997 _do_restore_file()
998 {
999     _parse_args $*
1000     _prepare_restore_dir
1001
1002     echo "Restoring from file..."
1003     opts="$_restore_debug -f $dump_file  -L $session_label $restore_dir"
1004     echo "xfsrestore $opts" | _dir_filter  
1005     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1006 }
1007
1008 #
1009 # Cumulative restore from a file
1010 # Need to specify the dump level e.g. "-l 0"
1011 #
1012 _do_restore_file_cum()
1013 {
1014     _parse_args $*
1015     if echo $dump_args | grep '\-l0' >/dev/null; then
1016         _prepare_restore_dir
1017     fi
1018
1019     echo "Restoring cumumlative from file..."
1020     opts="$_restore_debug -f $dump_file -r $restore_dir"
1021     echo "xfsrestore $opts" | _dir_filter  
1022     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1023 }
1024
1025 _do_restore_toc()
1026 {
1027     echo "Contents of dump ..."
1028     opts="$_restore_debug -f $dump_file -t"
1029     echo "xfsrestore $opts" | _dir_filter
1030     cd $SCRATCH_MNT # for IRIX which needs xfs cwd
1031     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter_main |\
1032     _check_quota_file |\
1033     _check_quota_entries |\
1034     $AWK_PROG 'NF != 1 { print; next }
1035                {files = sprintf("%s\n%s", files, $1)}
1036                 END { print files | "sort" } '
1037     # the above awk code is to alpha sort only the output
1038     # of files (and not the verbose restore msgs)
1039     cd $here # put back
1040 }
1041
1042 #
1043 # Restore the tape from multiple dump files
1044 #
1045 _do_restore_multi_file()
1046 {
1047     _parse_args "$@"
1048     _prepare_restore_dir
1049
1050     multi_args=""
1051
1052     i=0
1053     while [ $i -lt $multi ]
1054     do
1055         multi_args="$multi_args -f $dump_file.$i"
1056         i=`expr $i + 1`
1057     done
1058
1059     echo "Restoring from file..."
1060     opts="$_restore_debug $multi_args -L $session_label $restore_dir"
1061     echo "xfsrestore $opts" | _dir_filter  
1062     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1063 }
1064
1065 #
1066 # Do xfsdump piped into xfsrestore - xfsdump | xfsrestore
1067 #
1068 # Use -s as we want to dump and restore to the same xfs partition
1069 #
1070 _do_dump_restore()
1071 {
1072     _parse_args $*
1073     _prepare_restore_dir
1074     echo "xfsdump|xfsrestore ..."
1075     restore_opts="$_restore_debug - $restore_dir"
1076     dump_opts="$_dump_debug$dump_args -s $dump_sdir - $SCRATCH_MNT"
1077     echo "xfsdump $dump_opts | xfsrestore $restore_opts" | _dir_filter  
1078     xfsdump $dump_opts 2>$tmp.dump.mlog | xfsrestore $restore_opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1079     _dump_filter <$tmp.dump.mlog
1080 }
1081
1082 #
1083 # Compare dumped subdirectory with restored dir
1084 # using ls -lR.
1085 # Thus no contents are compared but permissions, sizes,
1086 # owners, etc... are.
1087 #
1088 _ls_compare_sub()
1089 {
1090     #
1091     # verify we got back what we dumped
1092     #
1093     echo "Comparing listing of dump directory with restore directory"
1094     ls -lR $dump_dir | tee -a $here/$seq.full | _ls_filter >$tmp.dump_dir
1095     ls -lR $restore_dir/$dump_sdir | tee -a $here/$seq.full | _ls_filter \
1096     | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1097
1098     diff -cs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1099 }
1100
1101 #
1102 # filter out the date fields
1103 #
1104 _ls_nodate_filter()
1105 {
1106     $AWK_PROG 'NF == 9 { print $1, $2, $3, $4, $9 }'
1107 }
1108
1109 #
1110 # _ls_compare_sub but don't compare dates
1111 _ls_nodate_compare_sub()
1112 {
1113     #
1114     # verify we got back what we dumped
1115     #
1116     echo "Comparing listing of dump directory with restore directory"
1117     ls -lR $dump_dir | tee -a $here/$seq.full | _ls_filter | _ls_nodate_filter >$tmp.dump_dir
1118     ls -lR $restore_dir/$dump_sdir | tee -a $here/$seq.full | _ls_filter \
1119     | _ls_nodate_filter | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1120
1121     diff -cs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1122 }
1123
1124 #
1125 # Compare using recursive diff the files of the dumped
1126 # subdirectory.
1127 # This one will compare the contents.
1128 #
1129 _diff_compare_sub()
1130 {
1131     echo "Comparing dump directory with restore directory"
1132     diff -rs $dump_dir $restore_dir/$dump_sdir | _dir_filter
1133 }
1134
1135 _get_eas_on_path()
1136 {
1137     _path=$1
1138
1139 # Tim - this is the IRIX way...
1140     # find $_path -exec attr -l {} \; |\
1141     # awk '{print $9, $2}' |\
1142     # sed 's/["]//g' |\
1143     # sort |\
1144 # and this is now the Linux way...
1145     echo "User names"
1146     getfattr --absolute-names -Rh $_path |\
1147     perl -wn -e '
1148         if (m/^# file: (\S+)/) { $file = $1 }
1149         elsif (m/^user\.(\w+)/) { print $file, " ",$1,"\n" }' |\
1150     sort |\
1151     while read file ea_name; do
1152         attr -g $ea_name $file
1153     done
1154
1155     echo "Root names"
1156     getfattr --absolute-names -Rh -m trusted $_path |\
1157     perl -wn -e '
1158         if (m/^# file: (\S+)/) { $file = $1 }
1159         elsif (m/^trusted\.(\w+)/) { print $file, " ",$1,"\n" }' |\
1160     sort |\
1161     while read file ea_name; do
1162         attr -R -g $ea_name $file
1163     done
1164 }
1165
1166 #
1167 # Compare the extended attributes of the files/dirs
1168 # b/w the dumped and restore dirs.
1169 #
1170 #
1171 # Attribute "attr5" had a 8 byte value for /spare1/dump.5460/dir:
1172 # Attribute "attr5" had a 8 byte value for /spare1/restore.5460/dump.5460/dir:
1173 #
1174 _diff_compare_eas()
1175 {
1176     echo "Comparing dump directory with restore directory"
1177     echo "Looking at the extended attributes (EAs)"
1178     echo "EAs on dump"
1179     _get_eas_on_path $dump_dir | tee $seq.ea1 | _dir_filter
1180     echo "EAs on restore"
1181     _get_eas_on_path $restore_dir/$dump_sdir \
1182     | sed -e "s#$restore_sdir\/##" \
1183     | tee $seq.ea2 \
1184     | _dir_filter
1185     diff -s $seq.ea1 $seq.ea2
1186 }
1187
1188
1189 #
1190 # Compare using recursive diff the files of the dumped
1191 # filesystem
1192 #
1193 _diff_compare()
1194 {
1195     echo "Comparing dump directory with restore directory"
1196     diff -rs $SCRATCH_MNT $restore_dir | _dir_filter | _check_quota_diff
1197 }
1198
1199 #
1200 # Check out the dump inventory
1201 #
1202 _dump_inventory()
1203 {
1204     xfsdump $_dump_debug -I | tee -a $here/$seq.full | _dump_filter_main
1205 }
1206
1207 #
1208 # Do the xfsinvutil cmd with debug and filters
1209 # Need to set variable: "$middate" to the invutil date 
1210 #
1211 _do_invutil()
1212 {
1213     host=`hostname`
1214     echo "xfsinvutil $_invutil_debug -M $host:$SCRATCH_MNT \"$middate\" $*" >$here/$seq.full
1215     xfsinvutil $_invutil_debug $* -M $host:$SCRATCH_MNT "$middate" \
1216     | tee -a $here/$seq.full | _invutil_filter
1217 }
1218
1219 #
1220 # ensure we can find the user quota msg if user quotas are on
1221 # ensure we can find the group quota msg if group quotas are on
1222 #
1223 _check_quota()
1224 {
1225     usermsg=$1 
1226     groupmsg=$2 
1227     uquota=0
1228     gquota=0 
1229     $here/src/feature -U $SCRATCH_DEV && uquota=1
1230     $here/src/feature -G $SCRATCH_DEV && gquota=1
1231
1232     $AWK_PROG -v uquota=$uquota -v gquota=$gquota -v full=$here/$seq.full \
1233               -v usermsg="$usermsg" -v groupmsg="$groupmsg" '
1234         $0 ~ groupmsg {
1235                         print "Found group quota:", $0 >>full
1236                         found_gquota = 1
1237                         if (!gquota) {
1238                             print "Found extra:", $0
1239                         }
1240                         next
1241         }
1242         $0 ~ usermsg {
1243                         print "Found user quota:", $0 >>full
1244                         found_uquota = 1
1245                         if (!uquota) {
1246                             print "Found extra:", $0
1247                         }
1248                         next
1249         }
1250                         { print }
1251         END {
1252                 if (uquota && !found_uquota) {
1253                     print "Missing: ", usermsg
1254                 }
1255                 if (gquota && !found_gquota) {
1256                     print "Missing: ", groupmsg
1257                 }
1258         }
1259     '
1260 }
1261
1262 #
1263 # xfsrestore: 3 directories and 40 entries processed 
1264 #   $5 = 40 
1265 #   num entries needs to be reduced by num quota file(s) 
1266 #
1267 _check_quota_entries()
1268 {
1269     uquota=0
1270     gquota=0 
1271     $here/src/feature -U $SCRATCH_DEV && uquota=1
1272     $here/src/feature -G $SCRATCH_DEV && gquota=1
1273     $AWK_PROG -v uquota=$uquota -v gquota=$gquota '
1274         /entries processed/ { 
1275                 if (uquota) $5--
1276                 if (gquota) $5--
1277         }
1278         {print}'
1279 }
1280
1281 #
1282 # Look for:
1283 # xfsdump: saving user quota information for: SCRATCH_MNT
1284 # xfsdump: saving group quota information for: SCRATCH_MNT
1285 # xfsrestore: user quota information written to ...'
1286 # xfsrestore: group quota information written to ...'
1287 #
1288 _check_quota_dumprestore()
1289 {
1290    _check_quota 'user quota information' \
1291                 'group quota information'
1292 }
1293
1294 #
1295 # Look for:
1296 # Only in RESTORE_DIR: xfsdump_quotas
1297 # Only in RESTORE_DIR: xfsdump_quotas_group
1298 #
1299 _check_quota_diff()
1300 {
1301    _check_quota 'Only in RESTORE_DIR: xfsdump_quotas' \
1302        'Only in RESTORE_DIR: xfsdump_quotas_group' 
1303 }
1304
1305 #
1306 # Look for the quota file in the output
1307 # Ensure that it is there if it should be
1308 # Filter it out so that the output is always the same
1309 # even with no quotas
1310 #
1311 _check_quota_file()
1312 {
1313    _check_quota 'xfsdump_quotas' 'xfsdump_quotas_group'
1314 }
1315
1316 # make sure this script returns success
1317 /bin/true