tools/srcdiff

   1 #!/usr/bin/perl -w
   2 use strict;
   3 #
   4 # srcdiff is used to compare current user level code with the current
   5 # kernel code and advise of any differences between files which are
   6 # sharing some or all of their content.
   7 #
   8 # There are two classes of sharing which we will check - header files
   9 # in the include directory, which must be exactly the same (use diff)
  10 # and source files which contain routines which must be exactly the
  11 # same (but the userland file is always a subset of the kernel file,
  12 # and hence a more flexible mechanism to "diff" is required).
  13 #
  14 # NB: to cross check that srcdiff is finding all the functions in the
  15 #     user source file, providing you have "mkproto" installed, you
  16 #     can "cd cmd/xfsprogs/libxfs" and cut&paste this in a bourne shell:
  17 #     $ for file in xfs_*.c; do
  18 #     > mkproto -nps < $file | perl -ne '
  19 #     > END { print "    $count\t- " }
  20 #     > s/^.* (xfs\w+|\*xfs\w+|xlog\w+|\*xlog\w+) \(.*/\1/ && { $count++ }'
  21 #     > echo $file
  22 #     > done
  23 # (compare this to "srcdiff | fgrep Total:") ... repeat for logprint.
  24 #
  25
  26 die "WORKAREA not set" unless defined $ENV{'WORKAREA'};
  27 chdir $ENV{'WORKAREA'};
  28 my $xdiff = $ENV{'XDIFF'};
  29 my $quiet=0;
  30 my $usage=0;
  31
  32 foreach (@ARGV) {
  33     if (/^-q$/) {
  34         $quiet++;
  35     } else {
  36         print STDERR "Illegal option $_\n";
  37         $usage++;
  38     }
  39 }
  40
  41 if ($usage) {
  42     print STDERR "Usage: $0 [-q]\n";
  43     exit 1;
  44 }
  45
  46 my @difflist = qw(
  47         xfs_ag.h  xfs_alloc.h  xfs_alloc_btree.h xfs_arch.h
  48         xfs_attr_leaf.h  xfs_attr_sf.h  xfs_bit.h  xfs_bmap.h
  49         xfs_bmap_btree.h  xfs_btree.h  xfs_buf_item.h
  50         xfs_da_btree.h  xfs_dfrag.h  xfs_dinode.h  xfs_dir.h
  51         xfs_dir2.h  xfs_dir2_block.h  xfs_dir2_data.h
  52         xfs_dir2_leaf.h  xfs_dir2_node.h  xfs_dir2_sf.h
  53         xfs_dir_leaf.h  xfs_dir_sf.h  xfs_dqblk.h  xfs_dquot_item.h
  54         xfs_extfree_item.h  xfs_ialloc.h  xfs_imap.h
  55         xfs_ialloc_btree.h  xfs_inode.h  xfs_inode_item.h
  56         xfs_inum.h  xfs_log.h  xfs_log_priv.h  xfs_log_recover.h
  57         xfs_mount.h  xfs_quota.h  xfs_rtalloc.h
  58         xfs_sb.h  xfs_trans.h  xfs_trans_space.h  xfs_types.h
  59 );
  60
  61 sub straightdiff {
  62         my ( $file, $prefix1, $prefix2 ) = @_;
  63
  64         `diff $prefix1/$file $prefix2/$file >/dev/null 2>&1`;
  65         if (!$quiet) {
  66             print sprintf("\t%-35s ... ", $file);
  67             if ($? != 0)        { print "FAILED\n"; }
  68             else                { print "ok\n"; }
  69         } elsif ($? != 0) {
  70                 printf("\t%-35s ... ", $file);
  71                 print "FAILED\n";
  72         }
  73 }
  74
  75 print "\n=== Checking headers ===\n";
  76 foreach (@difflist) {
  77         straightdiff $_, 'cmd/xfsprogs/include', 'linux/fs/xfs';
  78 }
  79 straightdiff 'xfs_cred.h', 'cmd/xfsprogs/include', 'linux/fs/xfs/linux';
  80 straightdiff 'xfs_fs.h', 'cmd/xfsprogs/include', 'linux/include/linux';
  81 straightdiff 'attributes.h', 'cmd/attr/include', 'linux/include/linux';
  82 straightdiff 'dmapi_kern.h', 'cmd/dmapi/include', 'linux/include/linux';
  83 straightdiff 'dmapi.h', 'cmd/dmapi/include', 'linux/include/linux';
  84 straightdiff 'acl.h', 'cmd/acl/include', 'linux/include/linux';
  85 straightdiff 'arch.h', 'cmd/xfsprogs/include', 'linux/fs/xfs/support';
  86 straightdiff 'xqm.h', 'cmd/xfsprogs/include', 'linux/include/linux';
  87
  88 #
  89 # setstate
  90 # Implements a tri-state FSA, see comments for state transitions
  91 #  (knows about the way the XFS kernel code is written, & makes
  92 #   some assumptions so as to not need to parse generic C code).
  93 # Accepts one line at a time from a source file, picking out the
  94 #   function bodies so they can be subsequently compared.
  95 #
  96
  97 my $line;       # line number in current source file
  98 my $state;      # current FSA state
  99 my $funcbody;   # current function body (contents)
 100
 101 sub setstate {
 102         my ( $newline ) = @_;
 103         $line++;
 104
 105         # - state 0:
 106         #       if line looks like start of a function, transition to 1
 107         #               & squirrel line away as line 1 of current function
 108         if ($state == 0) {
 109                 if ($newline =~ m/^[xfs|xlog]/) {
 110                         $state = 1;
 111                         $funcbody = $newline;
 112                 }
 113         }
 114
 115         # - state 1:
 116         #       if line looks like start of a function, stay here
 117         #               & squirrel line away as line 1 of current function
 118         #       otherwise if line isn't start of function body,
 119         #               squirrel line away as next line of current function
 120         #               (args/..., but not sure this is a real function yet)
 121         #       otherwise (start of function)
 122         #               squirrel line away as next line of current function
 123         #               transition to state 2
 124         elsif ($state == 1) {
 125                 if ($newline =~ m/^[xfs|xlog]/) {
 126                         $funcbody = $newline;
 127                 }
 128                 elsif ($newline =~ m/^\{/) {
 129                         $state = 2;
 130                         $funcbody .= $newline;
 131                 }
 132         }
 133
 134         # - state 2:
 135         #       if line looks like end of function body,
 136         #               squirrel line away as last line of current function
 137         #               tell someone we have a complete function ready
 138         #               transition to state 0
 139         #       otherwise
 140         #               squirrel line away as next line of current function
 141         elsif ($state == 2) {
 142                 $funcbody .= $newline;
 143                 if ($newline =~ m/^\}/) {
 144                         $state = 0;
 145                         return $funcbody;
 146                 }
 147         }
 148
 149         else {
 150                 die "unknown state transition";
 151         }
 152         return undef;   # i.e. not at end of a function
 153 }
 154
 155 sub listfuncs {
 156         my ( $file ) = @_;
 157         my @funcs;
 158
 159         $funcbody = '';
 160         $state = $line = 0;
 161
 162         open(USER, "$file") || die "cannot open $file";
 163         while (<USER>) {
 164                 my $func = setstate($_);
 165                 push @funcs, $func if (defined($func)); # store function away
 166         }
 167         close USER;
 168         return @funcs;
 169 }
 170
 171 sub hashfuncs {
 172         my ( $file ) = @_;
 173         my %funcs;
 174
 175         $funcbody = '';
 176         $state = $line = 0;
 177
 178         open(KERN, "$file") || die "cannot open $file";
 179         while (<KERN>) {
 180                 my $func = setstate($_);
 181                 if (defined($func)) {
 182                         $func =~ m/^([xfs|xlog]\w+)\s*\(/;
 183                         next unless defined($1);
 184                         my $name = $1;
 185                         if (defined($func)) {
 186                                 $funcs{$name} = $func;  # store function away
 187                         }
 188                 }
 189         }
 190         close KERN;
 191         return %funcs;
 192 }
 193
 194 sub diffme {
 195         my ( $sa, $sb ) = @_;
 196
 197         return unless defined($xdiff);
 198
 199         open(FILEA, "> /tmp/diff.user.$$") || die "cannot write to /tmp/diff.user.$$";
 200         open(FILEB, "> /tmp/diff.kern.$$") || die "cannot write to /tmp/diff.kern.$$";
 201         print FILEA $sa;
 202         print FILEB $sb;
 203         close FILEA;
 204         close FILEB;
 205         `$xdiff /tmp/diff.user.$$ /tmp/diff.kern.$$`;
 206         unlink ("/tmp/diff.user.$$","/tmp/diff.kern.$$");
 207 }
 208
 209 sub functiondiff {
 210         my ( $file, $prefix1, $prefix2 ) = @_;
 211         my $plural = '';
 212         my $count = 0;
 213         my $name;
 214         my $found = 0;
 215
 216         print "\n=== Checking $file routines ===\n" unless ($quiet);
 217
 218         # iterate over user funcs, match up to kernel funcs
 219         #
 220         my @user = listfuncs "$prefix1/$file";
 221         my %kern = hashfuncs "$prefix2/$file";
 222
 223         foreach my $userfunc (@user) {
 224
 225                 $userfunc =~ m/^([xfs|xlog]\w+)\s*\(/;
 226                 next unless (defined($1));
 227                 $name = $1;
 228                 $count++;
 229
 230                 if (exists($kern{$name})) {
 231                         if ($userfunc ne $kern{$name}) {
 232                                 print "\n=== $file routines ===\n"
 233                                     if (!$found++ && $quiet);
 234
 235                                 printf("\t%-35s ... ", $name);
 236                                 print "FAILED\n";
 237                                 diffme $userfunc, $kern{$name};
 238                         }
 239                         elsif (!$quiet) {
 240                                 printf("\t%-35s ... ", $name);
 241                                 print "ok\n";
 242                         }
 243                 }
 244                 else {
 245                         print "Cannot find kernel function $userfunc";
 246                         print " in file $prefix2/$file\n";
 247                 }
 248         }
 249         ($count != 1) && ( $plural = 's' );
 250         print "( Total: $count routine$plural checked in $file )\n" unless ($quiet);
 251 }
 252
 253 # cmd/xfsprogs/{libxfs,logprint}/* fs/xfs/*
 254 my @funclist = qw(
 255         xfs_alloc.c  xfs_alloc_btree.c  xfs_attr_leaf.c  xfs_bit.c
 256         xfs_bmap.c  xfs_bmap_btree.c  xfs_btree.c  xfs_da_btree.c
 257         xfs_dir.c  xfs_dir2.c  xfs_dir2_block.c  xfs_dir2_data.c
 258         xfs_dir2_leaf.c  xfs_dir2_node.c  xfs_dir2_sf.c
 259         xfs_dir_leaf.c  xfs_ialloc.c  xfs_ialloc_btree.c
 260         xfs_inode.c  xfs_rtalloc.c  xfs_rtbit.c xfs_mount.c
 261         xfs_trans.c
 262 );
 263
 264 print "\n=== Checking libxfs code ===\n";
 265 foreach (@funclist) {
 266         functiondiff $_, 'cmd/xfsprogs/libxfs', 'linux/fs/xfs';
 267 }
 268 print "\n=== Checking logprint code ===\n";
 269 functiondiff 'xfs_log_recover.c', 'cmd/xfsprogs/logprint', 'linux/fs/xfs';