2 # Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
4 # Licensed under the Apache License 2.0 (the "License"). You may not use
5 # this file except in compliance with the License. You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
15 use File::Spec::Functions qw(:DEFAULT rel2abs);
16 use File::Compare qw(compare_text);
19 # When using stat() on Windows, we can get it to perform better by avoid some
20 # data. This doesn't affect the mtime field, so we're not losing anything...
21 ${^WIN32_SLOPPY_STAT} = 1;
23 my $debug = $ENV{ADD_DEPENDS_DEBUG};
24 my $buildfile = $config{build_file};
25 my $build_mtime = (stat($buildfile))[9];
27 my $depext = $target{dep_extension} || ".d";
31 # This grep has side effects. Not only does if check the existence
32 # of the dependency file given in $_, but it also checks if it's
33 # newer than the build file, and if it is, sets $rebuild.
35 $rebuild = 1 if @st && $st[9] > $build_mtime;
36 scalar @st > 0; # Determines the grep result
38 map { (my $x = $_) =~ s|\.o$|$depext|; $x; }
39 ( ( grep { $unified_info{sources}->{$_}->[0] =~ /\.cc?$/ }
40 keys %{$unified_info{sources}} ),
41 ( grep { $unified_info{shared_sources}->{$_}->[0] =~ /\.cc?$/ }
42 keys %{$unified_info{shared_sources}} ) );
44 exit 0 unless $rebuild;
46 # Ok, primary checks are done, time to do some real work
48 my $producer = shift @ARGV;
49 die "Producer not given\n" unless $producer;
51 my $srcdir = $config{sourcedir};
52 my $blddir = $config{builddir};
53 my $abs_srcdir = rel2abs($srcdir);
54 my $abs_blddir = rel2abs($blddir);
56 # Convenient cache of absolute to relative map. We start with filling it
57 # with mappings for the known generated header files. They are relative to
58 # the current working directory, so that's an easy task.
59 # NOTE: there's more than C header files that are generated. They will also
60 # generate entries in this map. We could of course deal with C header files
61 # only, but in case we decide to handle more than just C files in the future,
62 # we already have the mechanism in place here.
63 # NOTE2: we lower case the index to make it searchable without regard for
64 # character case. That could seem dangerous, but as long as we don't have
65 # files we depend on in the same directory that only differ by character case,
68 map { catfile($abs_blddir, $_) => $_ }
69 keys %{$unified_info{generate}};
72 'gcc' => undef, # gcc style dependency files needs no mods
75 # makedepend, in its infinite wisdom, wants to have the object file
76 # in the same directory as the source file. This doesn't work too
77 # well with out-of-source-tree builds, so we must resort to tricks
78 # to get things right. Fortunately, the .d files are always placed
79 # parallel with the object files, so all we need to do is construct
80 # the object file name from the dep file name.
81 (my $objfile = shift) =~ s|\.d$|.o|i;
85 return undef if $line =~ /^(#.*|\s*)$/;
87 # Remove the original object file
88 $line =~ s|^.*\.o: | |;
89 # Also, remove any dependency that starts with a /, because those
90 # are typically system headers
91 $line =~ s/\s+\/(\\.|\S)*//g;
92 # Finally, discard all empty lines
93 return undef if $line =~ /^\s*$/;
95 # All we got now is a dependency, just shave off surrounding spaces
98 return ($objfile, $line);
102 state $abs_srcdir_shaved = undef;
103 state $srcdir_shaved = undef;
105 unless (defined $abs_srcdir_shaved) {
106 ($abs_srcdir_shaved = $abs_srcdir) =~ s|[>\]]$||;
107 ($srcdir_shaved = $srcdir) =~ s|[>\]]$||;
110 # current versions of DEC / Compaq / HP / VSI C strips away all
111 # directory information from the object file, so we must insert it
112 # back. To make life simpler, we simply replace it with the
113 # corresponding .D file that's had its extension changed. Since
114 # .D files are always written parallel to the object files, we
115 # thereby get the directory information for free.
116 (my $objfile = shift) =~ s|\.D$|.OBJ|i;
119 # Shave off the target.
121 # The pattern for target and dependencies will always take this
124 # target SPACE : SPACE deps
126 # This is so a volume delimiter (a : without any spaces around it)
127 # won't get mixed up with the target / deps delimiter. We use this
128 # to easily identify what needs to be removed.
129 m|\s:\s|; $line = $';
131 # We know that VMS has system header files in text libraries,
132 # extension .TLB. We also know that our header files aren't stored
133 # in text libraries. Finally, we know that VMS C produces exactly
134 # one dependency per line, so we simply discard any line ending with
136 return undef if /\.TLB\s*$/;
138 # All we got now is a dependency, just shave off surrounding spaces
142 # VMS C gives us absolute paths, always. Let's see if we can
143 # make them relative instead.
144 $line = canonpath($line);
146 unless (defined $depconv_cache{$line}) {
148 # Since we have already pre-populated the cache with
149 # mappings for generated headers, we only need to deal
150 # with the source tree.
151 if ($dep =~ s|^\Q$abs_srcdir_shaved\E([\.>\]])?|$srcdir_shaved$1|i) {
152 $depconv_cache{$line} = $dep;
155 return ($objfile, $depconv_cache{$line})
156 if defined $depconv_cache{$line};
157 print STDERR "DEBUG[VMS C]: ignoring $objfile <- $line\n"
164 # On Windows, with Microsoft Visual C the flags /Zs /showIncludes
165 # give us the necessary output to be able to create dependencies
166 # that nmake (or any 'make' implementation) should be able to read,
167 # with a bit of help. The output we're interested in looks like
168 # this (it always starts the same)
170 # Note: including file: {whatever header file}
172 # With Embarcadero C++Builder's preprocessor (cpp32.exe) the -Hp
173 # flag gives us the preprocessed output annotated with the following
174 # note whenever a #include file is read:
176 # Including ->->{whatever header file}
178 # where each "->" indicates the nesting level of the #include. The
179 # logic here is otherwise the same as the 'VC' case.
181 # Since there's no object file name at all in that information,
182 # we must construct it ourselves.
184 (my $objfile = shift) =~ s|\.d$|.obj|i;
187 # There are also other lines mixed in, for example compiler
188 # warnings, so we simply discard anything that doesn't start with
191 if (/^Note: including file: */ or /^Including (->)*/) {
192 (my $tail = $') =~ s/\s*\R$//;
194 # VC gives us absolute paths for all include files, so to
195 # remove system header dependencies, we need to check that
196 # they don't match $abs_srcdir or $abs_blddir. C++Builder gives
197 # us relative paths when possible, so convert to absolute paths.
198 $tail = rel2abs($tail);
200 unless (defined $depconv_cache{$tail}) {
202 # Since we have already pre-populated the cache with
203 # mappings for generated headers, we only need to deal
204 # with the source tree.
205 if ($dep =~ s|^\Q$abs_srcdir\E\\|\$(SRCDIR)\\|i) {
206 $depconv_cache{$tail} = $dep;
209 return ($objfile, '"'.$depconv_cache{$tail}.'"')
210 if defined $depconv_cache{$tail};
211 print STDERR "DEBUG[VC]: ignoring $objfile <- $tail\n"
218 my %continuations = (
220 'makedepend' => "\\",
225 die "Producer unrecognised: $producer\n"
226 unless exists $procedures{$producer} && exists $continuations{$producer};
228 my $procedure = $procedures{$producer};
229 my $continuation = $continuations{$producer};
231 my $buildfile_new = "$buildfile-$$";
234 if (defined $procedure) {
235 foreach my $depfile (@depfiles) {
236 open IDEP,$depfile or die "Trying to read $depfile: $!\n";
238 s|\R$||; # The better chomp
239 my ($target, $deps) = $procedure->($depfile, $_);
240 $collect{$target}->{$deps} = 1 if defined $target;
246 open IBF, $buildfile or die "Trying to read $buildfile: $!\n";
247 open OBF, '>', $buildfile_new or die "Trying to write $buildfile_new: $!\n";
249 last if /^# DO NOT DELETE THIS LINE/;
250 print OBF or die "$!\n";
254 print OBF "# DO NOT DELETE THIS LINE -- make depend depends on it.\n";
256 if (defined $procedure) {
257 foreach my $target (sort keys %collect) {
258 my $prefix = $target . ' :';
259 my @deps = sort keys %{$collect{$target}};
265 while (@deps && ($buf eq ''
266 || length($buf) + length($deps[0]) <= 77)) {
267 $buf .= ' ' . shift @deps;
269 $buf .= ' '.$continuation if @deps;
271 print OBF $buf,"\n" or die "Trying to print: $!\n"
275 foreach my $depfile (@depfiles) {
276 open IDEP,$depfile or die "Trying to read $depfile: $!\n";
278 print OBF or die "Trying to print: $!\n";
286 if (compare_text($buildfile_new, $buildfile) != 0) {
287 rename $buildfile_new, $buildfile
288 or die "Trying to rename $buildfile_new -> $buildfile: $!\n";
292 # On VMS, we want to remove all generations of this file, in case there
293 # are more than one, so we loop.
294 if (defined $buildfile_new) {
295 while (unlink $buildfile_new) {}