tools/mkdep.pl

   1 #!/usr/bin/perl
   2 ## --------------------------------------------------------------------------
   3 ##
   4 ##   Copyright 1996-2017 The NASM Authors - All Rights Reserved
   5 ##   See the file AUTHORS included with the NASM distribution for
   6 ##   the specific copyright holders.
   7 ##
   8 ##   Redistribution and use in source and binary forms, with or without
   9 ##   modification, are permitted provided that the following
  10 ##   conditions are met:
  11 ##
  12 ##   * Redistributions of source code must retain the above copyright
  13 ##     notice, this list of conditions and the following disclaimer.
  14 ##   * Redistributions in binary form must reproduce the above
  15 ##     copyright notice, this list of conditions and the following
  16 ##     disclaimer in the documentation and/or other materials provided
  17 ##     with the distribution.
  18 ##
  19 ##     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  20 ##     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  21 ##     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  22 ##     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23 ##     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24 ##     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 ##     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26 ##     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 ##     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 ##     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29 ##     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  30 ##     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  31 ##     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 ##
  33 ## --------------------------------------------------------------------------
  34
  35 #
  36 # Script to create Makefile-style dependencies.
  37 #
  38 # Usage:
  39 #   perl mkdep.pl [-s path-separator][-o obj-ext] dir... > deps
  40 #   perl mkdep.pl [-i][-e][-m makefile]...[-M makefile... --] dir...
  41 #
  42
  43 use File::Spec;
  44 use File::Basename;
  45 use File::Copy;
  46 use File::Temp;
  47 use Fcntl;
  48
  49 $barrier = "#-- Everything below is generated by mkdep.pl - do not edit --#\n";
  50
  51 # This converts from filenames to full pathnames for our dependencies
  52 %dep_path = {};
  53
  54 # List of files that cannot be found; these *must* be excluded
  55 @must_exclude = ();
  56
  57 #
  58 # Scan files for dependencies
  59 #
  60 sub scandeps($) {
  61     my($file) = @_;
  62     my $line;
  63     my %xdeps;
  64     my %mdeps;
  65
  66     open(my $fh, '<', $file)
  67         or return;              # If not openable, assume generated
  68
  69     while ( defined($line = <$fh>) ) {
  70         chomp $line;
  71         $line =~ s:/\*.*\*/::g;
  72         $line =~ s://.*$::;
  73         if ( $line =~ /^\s*\#\s*include\s+\"(.*)\"\s*$/ ) {
  74             my $nf = $1;
  75             if (!defined($dep_path{$nf})) {
  76                 push(@must_exclude, $nf);
  77                 next;
  78             }
  79             $nf = $dep_path{$nf};
  80             $mdeps{$nf}++;
  81             $xdeps{$nf}++ unless ( defined($deps{$nf}) );
  82         }
  83     }
  84     close($fh);
  85     $deps{$file} = [keys(%mdeps)];
  86
  87     foreach my $xf ( keys(%xdeps) ) {
  88         scandeps($xf);
  89     }
  90 }
  91
  92 # %deps contains direct dependencies.  This subroutine resolves
  93 # indirect dependencies that result.
  94 sub alldeps($$) {
  95     my($file, $level) = @_;
  96     my %adeps;
  97
  98     foreach my $dep ( @{$deps{$file}} ) {
  99         $adeps{$dep} = 1;
 100         foreach my $idep ( alldeps($dep, $level+1) ) {
 101             $adeps{$idep} = 1;
 102         }
 103     }
 104     return sort(keys(%adeps));
 105 }
 106
 107 # This converts a filename from host syntax to target syntax
 108 # This almost certainly works only on relative filenames...
 109 sub convert_file($$) {
 110     my($file,$sep) = @_;
 111
 112     my @fspec = (basename($file));
 113     while ( ($file = dirname($file)) ne File::Spec->curdir() &&
 114             $file ne File::Spec->rootdir() ) {
 115         unshift(@fspec, basename($file));
 116     }
 117
 118     if ( $sep eq '' ) {
 119         # This means kill path completely.  Used with Makes who do
 120         # path searches, but doesn't handle output files in subdirectories,
 121         # like OpenWatcom WMAKE.
 122         return $fspec[scalar(@fspec)-1];
 123     } else {
 124         return join($sep, @fspec);
 125     }
 126 }
 127
 128 #
 129 # Insert dependencies into a Makefile
 130 #
 131 sub _insert_deps($$) {
 132     my($file, $out) = @_;
 133
 134     open(my $in, '<', $file)
 135         or die "$0: Cannot open input: $file\n";
 136
 137     my $line, $parm, $val;
 138     my $obj = '.o';             # Defaults
 139     my $sep = '/';
 140     my $cont = "\\";
 141     my $include_command = undef;
 142     my $selfrule = 0;
 143     my $do_external = 0;
 144     my $maxline = 78;           # Seems like a reasonable default
 145     my %exclude = ();           # Don't exclude anything
 146     my @genhdrs = ();
 147     my $external = undef;
 148     my $raw_output = 0;
 149     my @outfile = ();
 150     my $done = 0;
 151
 152     while ( defined($line = <$in>) && !$done ) {
 153         if ( $line =~ /^([^\s\#\$\:]+\.h):/ ) {
 154             # Note: we trust the first Makefile given best
 155             my $fpath = $1;
 156             my $fbase = basename($fpath);
 157             if (!defined($dep_path{$fbase})) {
 158                 $dep_path{$fbase} = $fpath;
 159                 print STDERR "Makefile: $fbase -> $fpath\n";
 160             }
 161         } elsif ( $line =~ /^\s*\#\s*@([a-z0-9-]+):\s*\"([^\"]*)\"/ ) {
 162             $parm = $1;  $val = $2;
 163             if ( $parm eq 'object-ending' ) {
 164                 $obj = $val;
 165             } elsif ( $parm eq 'path-separator' ) {
 166                 $sep = $val;
 167             } elsif ( $parm eq 'line-width' ) {
 168                 $maxline = $val+0;
 169             } elsif ( $parm eq 'continuation' ) {
 170                 $cont = $val;
 171             } elsif ( $parm eq 'exclude' ) {
 172                 $excludes{$val}++;
 173             } elsif ( $parm eq 'include-command' ) {
 174                 $include_command = $val;
 175             } elsif ( $parm eq 'external' ) {
 176                 # Keep dependencies in an external file
 177                 $external = $val;
 178             } elsif ( $parm eq 'selfrule' ) {
 179                 $selfrule = !!$val;
 180             }
 181         } elsif ( $line =~ /^(\s*\#?\s*EXTERNAL_DEPENDENCIES\s*=\s*)([01])\s*$/ ) {
 182             $is_external = $externalize ? 1 : $force_inline ? 0 : $2+0;
 183             $line = $1.$is_external."\n";
 184         } elsif ( $line eq $barrier ) {
 185             $done = 1;          # Stop reading input at barrier line
 186         }
 187
 188         push @outfile, $line;
 189     }
 190     close($in);
 191
 192     $is_external = $is_external && defined($external);
 193
 194     if ( !$is_external || $externalize ) {
 195         print $out @outfile;
 196     } else {
 197         print $out $barrier;    # Start generated file with barrier
 198     }
 199
 200     if ( $externalize ) {
 201         if ( $is_external && defined($include_command) ) {
 202             print $out "$include_command $external\n";
 203         }
 204         return undef;
 205     }
 206
 207     my $e;
 208
 209     foreach my $dfile ($external, sort(keys(%deps)) ) {
 210         my $ofile;
 211         my @deps;
 212
 213         if ( $selfrule && $dfile eq $external ) {
 214             $ofile = convert_file($dfile, $sep).':';
 215             @deps = sort(keys(%deps));
 216         } elsif ( $dfile =~ /^(.*)\.[Cc]$/ ) {
 217             $ofile = convert_file($1, $sep).$obj.':';
 218             @deps = ($dfile,alldeps($dfile,1));
 219         }
 220
 221         if (defined($ofile)) {
 222             my $len = length($ofile);
 223             print $out $ofile;
 224             foreach my $dep (@deps) {
 225                 unless ($excludes{$dep}) {
 226                     my $str = convert_file($dep, $sep);
 227                     my $sl = length($str)+1;
 228                     if ( $len+$sl > $maxline-2 ) {
 229                         print $out ' ', $cont, "\n ", $str;
 230                         $len = $sl;
 231                     } else {
 232                         print $out ' ', $str;
 233                         $len += $sl;
 234                     }
 235                 }
 236             }
 237             print $out "\n";
 238         }
 239     }
 240
 241     return $external;
 242 }
 243
 244 sub insert_deps($)
 245 {
 246     my($mkfile) = @_;
 247     my $tmp = File::Temp->new(DIR => dirname($mkfile));
 248     my $tmpname = $tmp->filename;
 249
 250     my $newname = _insert_deps($mkfile, $tmp);
 251     close($tmp);
 252
 253     $newname = $mkfile unless(defined($newname));
 254
 255     move($tmpname, $newname);
 256 }
 257
 258 #
 259 # Main program
 260 #
 261
 262 my %deps = ();
 263 my @files = ();
 264 my @mkfiles = ();
 265 my $mkmode = 0;
 266 $force_inline = 0;
 267 $externalize = 0;
 268 $debug = 0;
 269
 270 while ( defined(my $arg = shift(@ARGV)) ) {
 271     if ( $arg eq '-m' ) {
 272         $arg = shift(@ARGV);
 273         push(@mkfiles, $arg);
 274     } elsif ( $arg eq '-i' ) {
 275         $force_inline = 1;
 276     } elsif ( $arg eq '-e' ) {
 277         $externalize = 1;
 278     } elsif ( $arg eq '-d' ) {
 279         $debug++;
 280     } elsif ( $arg eq '-M' ) {
 281         $mkmode = 1;            # Futher filenames are output Makefile names
 282     } elsif ( $arg eq '--' && $mkmode ) {
 283         $mkmode = 0;
 284     } elsif ( $arg =~ /^-/ ) {
 285         die "Unknown option: $arg\n";
 286     } else {
 287         if ( $mkmode ) {
 288             push(@mkfiles, $arg);
 289         } else {
 290             push(@files, $arg);
 291         }
 292     }
 293 }
 294
 295 my @cfiles = ();
 296
 297 foreach my $dir ( @files ) {
 298     opendir(DIR, $dir) or die "$0: Cannot open directory: $dir";
 299
 300     while ( my $file = readdir(DIR) ) {
 301         $path = ($dir eq File::Spec->curdir())
 302             ? $file : File::Spec->catfile($dir,$file);
 303         if ( $file =~ /\.[Cc]$/ ) {
 304             push(@cfiles, $path);
 305         } elsif ( $file =~ /\.[Hh]$/ ) {
 306             print STDERR "Filesystem: $file -> $path\n" if ( $debug );
 307             $dep_path{$file} = $path; # Allow the blank filename
 308             $dep_path{$path} = $path; # Also allow the full pathname
 309         }
 310     }
 311     closedir(DIR);
 312 }
 313
 314 foreach my $cfile ( @cfiles ) {
 315     scandeps($cfile);
 316 }
 317
 318 foreach my $mkfile ( @mkfiles ) {
 319     insert_deps($mkfile);
 320 }