debian/scripts/abi-check

   1 #!/usr/bin/perl -w
   2
   3 my $abinew = shift;
   4 my $abiold = shift;
   5 my $skipabi = shift;
   6
   7 # to catch multiple abi-prev-* files being passed in
   8 die "invalid value for skipabi parameter\n"
   9         if (defined($skipabi) && $skipabi !~ /^[01]$/);
  10
  11 $abinew =~ /abi-(.*)/;
  12 my $abistr = $1;
  13 $abiold =~ /abi-prev-(.*)/;
  14 my $prev_abistr = $1;
  15
  16 my $fail_exit = 1;
  17 my $EE = "EE:";
  18 my $errors = 0;
  19 my $abiskip = 0;
  20
  21 my $count;
  22
  23 print "II: Checking ABI...\n";
  24
  25 if ($skipabi) {
  26         print "WW: Explicitly asked to ignore ABI, running in no-fail mode\n";
  27         $fail_exit = 0;
  28         $abiskip = 1;
  29         $EE = "WW:";
  30 }
  31
  32 if ($prev_abistr ne $abistr) {
  33         print "II: Different ABI's, running in no-fail mode\n";
  34         $fail_exit = 0;
  35         $EE = "WW:";
  36 }
  37
  38 if (not -f "$abinew" or not -f "$abiold") {
  39         print "EE: Previous or current ABI file missing!\n";
  40         print "    $abinew\n" if not -f "$abinew";
  41         print "    $abiold\n" if not -f "$abiold";
  42
  43         # Exit if the ABI files are missing, but return status based on whether
  44         # skip ABI was indicated.
  45         if ("$abiskip" eq "1") {
  46                 exit(0);
  47         } else {
  48                 exit(1);
  49         }
  50 }
  51
  52 my %symbols;
  53 my %symbols_ignore;
  54 my %modules_ignore;
  55 my %module_syms;
  56
  57 # See if we have any ignores
  58 my $ignore = 0;
  59 print "    Reading symbols/modules to ignore...";
  60
  61 for $file ("abi-blacklist") {
  62         if (-f $file) {
  63                 open(IGNORE, "< $file") or
  64                         die "Could not open $file";
  65                 while (<IGNORE>) {
  66                         chomp;
  67                         if ($_ =~ m/M: (.*)/) {
  68                                 $modules_ignore{$1} = 1;
  69                         } else {
  70                                 $symbols_ignore{$_} = 1;
  71                         }
  72                         $ignore++;
  73                 }
  74                 close(IGNORE);
  75         }
  76 }
  77 print "read $ignore symbols/modules.\n";
  78
  79 sub is_ignored($$) {
  80         my ($mod, $sym) = @_;
  81
  82         die "Missing module name in is_ignored()" if not defined($mod);
  83         die "Missing symbol name in is_ignored()" if not defined($sym);
  84
  85         if (defined($symbols_ignore{$sym}) or defined($modules_ignore{$mod})) {
  86                 return 1;
  87         }
  88         return 0;
  89 }
  90
  91 # Read new syms first
  92 print "    Reading new symbols ($abistr)...";
  93 $count = 0;
  94 open(NEW, "< $abinew") or
  95         die "Could not open $abinew";
  96 while (<NEW>) {
  97         chomp;
  98         m/^(\S+)\s(.+)\s(0x[0-9a-f]+)\s(.+)$/;
  99         $symbols{$4}{'type'} = $1;
 100         $symbols{$4}{'loc'} = $2;
 101         $symbols{$4}{'hash'} = $3;
 102         $module_syms{$2} = 0;
 103         $count++;
 104 }
 105 close(NEW);
 106 print "read $count symbols.\n";
 107
 108 # Now the old symbols, checking for missing ones
 109 print "    Reading old symbols...";
 110 $count = 0;
 111 open(OLD, "< $abiold") or
 112         die "Could not open $abiold";
 113 while (<OLD>) {
 114         chomp;
 115         m/^(\S+)\s(.+)\s(0x[0-9a-f]+)\s(.+)$/;
 116         $symbols{$4}{'old_type'} = $1;
 117         $symbols{$4}{'old_loc'} = $2;
 118         $symbols{$4}{'old_hash'} = $3;
 119         $count++;
 120 }
 121 close(OLD);
 122
 123 print "read $count symbols.\n";
 124
 125 print "II: Checking for missing symbols in new ABI...";
 126 $count = 0;
 127 foreach $sym (keys(%symbols)) {
 128         if (!defined($symbols{$sym}{'type'})) {
 129                 print "\n" if not $count;
 130                 printf("    MISS : %s%s\n", $sym,
 131                         is_ignored($symbols{$sym}{'old_loc'}, $sym) ? " (ignored)" : "");
 132                 $count++ if !is_ignored($symbols{$sym}{'old_loc'}, $sym);
 133         }
 134 }
 135 print "    " if $count;
 136 print "found $count missing symbols\n";
 137 if ($count) {
 138         print "$EE Symbols gone missing (what did you do!?!)\n";
 139         $errors++;
 140 }
 141
 142
 143 print "II: Checking for new symbols in new ABI...";
 144 $count = 0;
 145 foreach $sym (keys(%symbols)) {
 146         if (!defined($symbols{$sym}{'old_type'})) {
 147                 print "\n" if not $count;
 148                 print "    NEW : $sym\n";
 149                 $count++;
 150         }
 151 }
 152 print "    " if $count;
 153 print "found $count new symbols\n";
 154 if ($count) {
 155         print "WW: Found new symbols. Not recommended unless ABI was bumped\n";
 156 }
 157
 158 print "II: Checking for changes to ABI...\n";
 159 $count = 0;
 160 my $moved = 0;
 161 my $changed_type = 0;
 162 my $changed_hash = 0;
 163 foreach $sym (keys(%symbols)) {
 164         if (!defined($symbols{$sym}{'old_type'}) or
 165             !defined($symbols{$sym}{'type'})) {
 166                 next;
 167         }
 168
 169         # Changes in location don't hurt us, but log it anyway
 170         if ($symbols{$sym}{'loc'} ne $symbols{$sym}{'old_loc'}) {
 171                 printf("    MOVE : %-40s : %s => %s\n", $sym, $symbols{$sym}{'old_loc'},
 172                         $symbols{$sym}{'loc'});
 173                 $moved++;
 174         }
 175
 176         # Changes to export type are only bad if new type isn't
 177         # EXPORT_SYMBOL. Changing things to GPL are bad.
 178         if ($symbols{$sym}{'type'} ne $symbols{$sym}{'old_type'}) {
 179                 printf("    TYPE : %-40s : %s => %s%s\n", $sym, $symbols{$sym}{'old_type'}.
 180                         $symbols{$sym}{'type'}, is_ignored($symbols{$sym}{'loc'}, $sym)
 181                         ? " (ignored)" : "");
 182                 $changed_type++ if $symbols{$sym}{'type'} ne "EXPORT_SYMBOL"
 183                         and !is_ignored($symbols{$sym}{'loc'}, $sym);
 184         }
 185
 186         # Changes to the hash are always bad
 187         if ($symbols{$sym}{'hash'} ne $symbols{$sym}{'old_hash'}) {
 188                 printf("    HASH : %-40s : %s => %s%s\n", $sym, $symbols{$sym}{'old_hash'},
 189                         $symbols{$sym}{'hash'}, is_ignored($symbols{$sym}{'loc'}, $sym)
 190                         ? " (ignored)" : "");
 191                 $changed_hash++ if !is_ignored($symbols{$sym}{'loc'}, $sym);
 192                 $module_syms{$symbols{$sym}{'loc'}}++;
 193         }
 194 }
 195
 196 print "WW: $moved symbols changed location\n" if $moved;
 197 print "$EE $changed_type symbols changed export type and weren't ignored\n" if $changed_type;
 198 print "$EE $changed_hash symbols changed hash and weren't ignored\n" if $changed_hash;
 199
 200 $errors++ if $changed_hash or $changed_type;
 201 if ($changed_hash) {
 202         print "II: Module hash change summary...\n";
 203         foreach $mod (sort { $module_syms{$b} <=> $module_syms{$a} } keys %module_syms) {
 204                 next if ! $module_syms{$mod};
 205                 printf("    %-40s: %d\n", $mod, $module_syms{$mod});
 206         }
 207 }
 208
 209 print "II: Done\n";
 210
 211 if ($errors) {
 212         exit($fail_exit);
 213 } else {
 214         exit(0);
 215 }