cmd/xfs/stress/001 1.6 Renamed to cmd/xfstests/001
[xfstests-dev.git] / src / fill2fs
1 #!/usr/bin/perl -w
2 #
3
4 #
5 #  Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
6 #  
7 #  This program is free software; you can redistribute it and/or modify it
8 #  under the terms of version 2 of the GNU General Public License as
9 #  published by the Free Software Foundation.
10 #  
11 #  This program is distributed in the hope that it would be useful, but
12 #  WITHOUT ANY WARRANTY; without even the implied warranty of
13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 #  
15 #  Further, this software is distributed without any warranty that it is
16 #  free of the rightful claim of any third person regarding infringement
17 #  or the like.  Any license provided herein, whether implied or
18 #  otherwise, applies only to this software file.  Patent licenses, if
19 #  any, provided herein do not apply to combinations of this program with
20 #  other software, or any other product whatsoever.
21 #  
22 #  You should have received a copy of the GNU General Public License along
23 #  with this program; if not, write the Free Software Foundation, Inc., 59
24 #  Temple Place - Suite 330, Boston MA 02111-1307, USA.
25 #  
26 #  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27 #  Mountain View, CA  94043, or:
28 #  
29 #  http://www.sgi.com 
30 #  
31 #  For further information regarding this notice, see: 
32 #  
33 #  http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
34 #
35 #
36  
37 #
38 # fill2fs:
39 #   Fill a filesystem, or write a specified number of bits.
40 #   Script runs deterministically given a seed for the random number
41 #   generator. Will generate the same set of directories and files,
42 #   with the only source of variation the precise point at which the
43 #   filesystem fills up. When used with XFS filesystems, and when 
44 #   the filesize is small, XFS pre-allocation may cause the filesystem
45 #   to "fill up" before the actual disk space is gone. Using this
46 #   script repeatedly, with a delay between invocations, to account
47 #   for extent flushing, will allow more of the filesystem to be filled.
48 #
49 #   All generated files are checksummed and this sum is stored in the
50 #   filename (files are named: <sequence number>.<checksum>.data.
51 #   Normally script is invoked using the --list option, which causes all
52 #   data files to be written to standard output (--list=-) or a file
53 #   (--list=filename). This list can be fed into fill2fs_check, which
54 #   recomputes the checksums and flags any errors.
55 #
56 #   The --stddev=0 forces all files to be precisely --filesize bytes in
57 #   length, some other value (--stddev=val) produces filesizes with a 
58 #   normal distribution with standard deviation val. If not specified
59 #   most file sizes are set to lie within 30% of the requested file size.
60 #
61 #   fill2fs is not guaranteed to write the requested number of bytes, or
62 #   fill the filesystem completely. However, it and fill2 are both very
63 #   careful about establishing when write operations fail. When the 
64 #   --verbose option is used the number of bytes "actually written"
65 #   is guaranteed to be the number of bytes on disk.
66 #
67 #   $Id$
68 #
69
70 use Getopt::Long;
71 use File::Basename;
72
73 chomp($os = `uname`);
74
75 #
76 # fsinfo: get filesystem info put it into the global namespace, assigns:
77 #       $dev, $type, $blocks, $used, $avail, $cap, $mnt, $mnt_options
78 #       $fsblocks, $fsblocksize, $agblocks, $agcount, $imax_pct, $logblocks
79 #       $logstart, $internal
80 #
81 # if $verbose is set then output fs info to STDERR
82 #
83
84 sub fsinfo {
85   my($file) = $_[0];
86
87   # filesystem space and mount point
88   
89   $cmd = "df" if ($os =~ /IRIX/);
90   $cmd = "df -P -T --block-size=512" if ($os =~ /Linux/);
91   chomp($_ = `$cmd $file | tail -1`);
92   $n = ($dev, $type, $blocks, $used, $avail, $cap, $mnt) = split(/ +/);
93   die("df failed") if ($n != 7);
94
95   if ($fscheck && $type ne "xfs") {
96     die("Error: $progname: filesystem is not xfs")
97   }
98
99   # how was this filesystem mounted
100   $_ = `grep $dev /etc/mtab`;
101   @mtab = split(/ +/);
102   $mnt_options = $mtab[3];
103
104   # xfs_db: read only, use the default superblock, print everything
105   die("Error: $progname: can't read device: \"$dev\"\n") if (! -r $dev);
106   $_=`xfs_db -r -c sb -c p $dev`;
107   # multiline matching ^$ refers to individual lines...
108   /^dblocks = (\d+)$/m;         $fsblocks=$1;
109   /^blocksize = (\d+)$/m;       $fsblocksize=$1;
110   /^agblocks = (\d+)$/m;        $agblocks=$1;
111   /^agcount = (\d+)$/m;         $agcount=$1;
112   /^imax_pct = (\d+)$/m;        $imax_pct=$1;
113   /^logblocks = (\d+)$/m;       $logblocks=$1;
114   /^logstart = (\d+)$/m;        $logstart=$1;
115   $internal = $logstart > 0 ? " (internal)" : "";
116
117   $verbose && print STDERR <<"EOF"
118 Filesystem information:
119   type=$type; device=$dev
120   mount point=$mnt; mount options=$mnt_options
121   percent full=$cap; size (512 byte blocks)=$blocks; used=$used; avail=$avail
122   total filesystem size (fs blocks)=$fsblocks; fs block size=$fsblocksize; imax_pct=$imax_pct
123   agcount=$agcount; agblocks=$agblocks; logblocks=$logblocks; logstart=$logstart$internal
124 EOF
125 }
126
127
128 # returns numbers with a normal distribution
129 sub normal {
130   my($mean) = $_[0];
131   my($stddev) = $_[1];
132
133   $x = -6.0;
134   for ($i = 0; $i < 12; $i++) {
135     $x += rand;
136   }
137
138   $x = $mean + $stddev * $x;
139   return $x;
140 }
141
142 #
143 # determine script location and find fill2
144 #
145
146 chomp($cwd = `pwd`);
147 chomp($_ = `which fill2 2>&1 | head -1`);
148 if (-x $_) {
149   # look in the path
150   $fill2 = fill2;
151 }
152 else {
153   # in the same directory - get absolute path
154   chomp($dirname = dirname $0);
155   if ($dirname =~ m!^/.*!) {
156     $fill2 = $dirname . "/fill2";
157   }
158   else {
159     # relative
160     $fill2 = $cwd . "/" . $dirname . "/fill2";
161   }    
162   if (! -x $fill2) {
163     die("Error: $progname: can't find fill2, tried \"$fill2\"\n");
164   }
165 }
166
167 #
168 # process/check args
169 #
170
171 $progname=$0;
172 GetOptions("bytes=f" => \$bytes,
173            "dir=s" => \$root,
174            "filesize=i" => \$filesize,
175            "force!" => \$force,
176            "help!" => \$help,
177            "list=s" => \$list,
178            "fscheck!" => \$fscheck,
179            "percent=f" => \$percentage,
180            "seed=i" => \$seed,
181            "stddev=i" => \$stddev,
182            "verbose!" => \$verbose);
183
184
185 # check/remove output directory, get filesystem info
186 if (defined $help
187     || (! defined $root && @ARGV != 1)
188     || (defined $root && @ARGV == 1))
189 {
190   # newline at end of die message suppresses line number
191   print STDERR <<"EOF";
192 Usage: $progname [options] root_dir
193 Options:
194   --bytes=num       total number of bytes to write
195   --dir=name        where to write files
196   --filesize=num    set all files to num bytes in size
197   --force           overwrite any existing files
198   --help            print this help message
199   --list=filename   store created files to filename (- for stdout)
200   --percent=num     percentage of filesystem to fill
201   --seed=num        seed for random number generator
202   --stddev          set file size standard deviation
203   --verbose         verbose output
204 EOF
205   exit(1) unless defined $help;
206   # otherwise...
207   exit(0);
208     
209 }
210
211
212 #
213 # lots of boring argument checking
214 #
215
216 # root directory and filesystem info
217 $root = $ARGV[0] if (@ARGV == 1);
218 if (-e $root) {
219   if (! $force) {
220     die("Error: $progname: \"$root\" already exists\n");
221   }
222   else {
223     $verbose && print STDERR "Removing \"$root\"... ";
224     system("rm -rf $root");
225     $verbose && print STDERR "done\n";
226   }
227 }
228 chomp($root_dir = dirname $root);
229 fsinfo $root_dir;
230
231 # $list can be "-" for stdout, perl open ">-" opens stdout
232 open LIST, ">$list" if (defined $list);
233
234 # how many bytes should we write
235 if (defined $bytes && defined $percentage) {
236   die("Error: $progname: can't specify --bytes and --percent\n");
237 }
238 # check percentage
239 if (defined $percentage && ($percentage < 0 || $percentage > 100)) {
240   die("Error: $progname: invalid percentage\n");
241 }
242 if (! defined $bytes && ! defined $percentage) {
243   $bytes = $avail * 512;
244   $verbose && print STDERR <<"EOF";
245 Neither --bytes nor --percent specified: filling filesystem ($bytes bytes)
246 EOF
247 }
248 elsif (! defined $bytes) {
249   $bytes = int($blocks * 512 * $percentage / 100.0);
250 }
251 if (($bytes > $blocks * 512) || (! $force && $bytes > $avail * 512))
252 {
253   die("Error: $progname: not enough free disk space, disk is $cap full\n");
254 }
255
256
257
258 #
259 # To get fix sized files set stddev to 0. The default is to make most files
260 # within 30% of the requested filesize (or 4k if filesize is not specified).
261 # Set the standard deviation to be half of the required percentage: ~95% of
262 # samples lie within 2 standard deviations of the mean.
263 #
264
265 $filesize = 4096 if (! defined $filesize);
266 die("Error: $progname: --filesize must be >= 1 byte") if ($filesize < 1);
267 $stddev = 0.5 * 0.3 * $filesize if (! defined $stddev);
268 $seed = time ^ $$ if (! defined $seed);
269 srand $seed;
270 umask 0000;
271 mkdir $root, 0777;
272 chdir $root;
273 $total = 0;
274 $files = 0;
275 $dirs = 0;
276 $d = 0;
277
278 #
279 # fill filesystem
280 #
281
282 $verbose && print STDERR "Writing $bytes bytes (seed is $seed)... ";
283 while ($total < $bytes) {
284   $r = rand(3.0);
285
286   if (($d == 0 && $r < 0.5) || ($d > 0 && $r >= 0.0 && $r < 2.4)) {
287     # create a new data file
288     $n = sprintf("%04d", $names[$d]++);
289     if ($stddev == 0) {
290       $size = $filesize;
291     }
292     else {
293       $size = int(normal($filesize, $stddev));
294     }
295     $left = $bytes - $total;
296     $size = 0 if ($size < 0);
297     $size = $left if ($size > $left);
298
299     # fill2 will fail if the filesystem is full - not an error!
300     $cmd = "$fill2 -d nbytes=$size,linelength=72,seed=$n -b 4k $n";
301     $cmd .= " > /dev/null 2>&1" if (! $verbose);
302     if (system($cmd) != 0) {
303       if ($verbose) {
304         warn("can't create a file - assuming filesystem is full\n");
305       }
306       if (-e $n && unlink($n) != 1) {
307         warn("couldn't delete \"$n\"");
308       }
309       last;
310     }
311     $_ = `sum $n`;
312     ($sum) = split(/ +/);
313     $name = "$n.$sum.data";
314     $cmd = "mv $n $name";       # perl rename failed earlier than using mv
315     $cmd .= " > /dev/null 2>&1" if (! $verbose);
316     if (system($cmd) != 0) {
317       if ($verbose) {
318         warn("can't rename a file - assuming filesystem is full\n");
319       }
320       if (-e $name && unlink($name) != 1) {
321         warn("couldn't delete \"$name\"");
322       }
323       last;
324     }
325     if (defined $list) {
326       chomp($_ = `pwd`);
327       printf LIST ("%s/%s\n", $_, $name);
328     }
329     $total += $size;
330     $files++;
331   }
332   # note that if d==0 create directories more frequently than files
333   elsif (($d == 0 && $r >= 0.5) || ($d > 0 && $r >= 2.4 && $r < 2.7)) {
334     # create a new directory and descend
335     $name = sprintf("%04d.d", $names[$d]++);
336     if (! mkdir($name, 0777)) {
337       warn("can't make a directory - assuming filesystem is full\n");
338       last;
339     }
340     chdir($name) or die();
341     $d++;
342     $dirs++;
343   }
344   elsif ($r >= 2.7 && $r < 3.0) {
345     # pop up to the parent directory same probability as descend
346     die("Error: $progname: panic: shouldn't be here!") if ($d == 0);
347     chdir("..") or die();
348     $d--;
349   }
350 }
351 # make sure we return to the original working directory
352 chdir($cwd) or die();
353 $verbose && print STDERR "done\n";
354 $verbose && print STDERR "$total bytes (in $files files and $dirs directories) were actually written\n";
355 close LIST;
356 exit(0) if ($total = $bytes);
357 exit(1) if ($total == 0);
358 exit(2) if ($total > 0 && $total < $bytes);
359
360 # - to sum all generated data:
361 #   find /home/fill/ -name \*data | xargs ls -al | awk '{total = total + $5; } END { printf("total = %d bytes\n", total); }'
362 # - to find any files not of the required size
363 #   find . -name \*data -a \! -size 4096c
364 # - count new files
365 #   find ./fill -name \*.data | wc
366 # - count new directories
367 #   find ./fill -name \*.d | wc