use strict;

use vars qw($debug $isc_includes $dns_includes $lwres_includes

$omapi_includes);

$isc_includes = "-Ilib/isc/include -Ilib/isc/unix/include " .

"-Ilib/isc/pthreads/include";

$dns_includes = "-Ilib/dns/include -Ilib/dns/sec/dst/include";

$lwres_includes = "-Ilib/lwres/include";

$omapi_includes = "-Ilib/omapi/include";

$0 =~ s%.*/%%;

die "Usage: $0 [-debug] headerfile ...\n" unless @ARGV > 0;

unless (-f 'configure.in') {

die "$0: run from top of bind9 source tree\n";

}

undef $/;

my @files = @ARGV;

for (<>) {

my ($file, $tmpfile, $objfile);

$file = shift @files;

unless ($file =~ /\.h$/) {

print "$0: skipping non-header file $file\n";

next;

}

die "$0: $file: no such file\n" unless -f $file;

# header file fragments; ignore

# XXX rdatastruct itself is moderately tricky.

next if $file =~ m%/rdatastruct(pre|suf)\.h$%;

# From external sources; ignore.

next if $file =~ m%lib/dns/sec/(dnssafe|openssl)%m;

# Totally wrong platform; ignore.

next if $file =~ m%lib/isc/win32%;

($tmpfile = $file) =~ s%(.*/)?%/tmp/%;

$tmpfile =~ s/\.h$/.c/;

($objfile = $tmpfile) =~ s/\.c$/\.o/;;

$file =~ m%(.*/)?(.*)/(.*)\.h%;

my $symbol = uc "\Q$2_$3_H\E";

$symbol =~ s/\\-/_/g;

if (! m%^\#ifndef\ $symbol\n

\#define\ $symbol\ 1\n

(.*\n)+

\#endif\ /\*\ $symbol\ \*/\n

\n*\Z%mx) {

print "$file has non-conforming wrapper for symbol $symbol\n"

unless $file =~ m%confparser_p\.h%;

}

my $nocomment = '^(?!\s+/?\*)';

my $lib = $file =~ /lwres/ ? "lwres" : "isc";

# check use of macros without having included proper header for them.

if (/^(\U$lib\E_LANG_(BEGIN|END)DECLS)$/m &&

! m%^#include <$lib/lang\.h>$%m) {

print "$file has $1 without <$lib/lang.h>\n";

}

if (/$nocomment.*ISC_EVENTCLASS_/m && ! m%^#include <isc/eventclass\.h>%m) {

print "$file has ISC_EVENTCLASS_ without <isc/eventclass.h>\n"

unless $file =~ m%isc/eventclass.h%;

}

if (/$nocomment.*ISC_RESULTCLASS_/m &&

! m%^#include <isc/resultclass\.h>%m) {

print "$file has ISC_RESULTCLASS_ without <isc/resultclass.h>\n"

unless $file =~ m%isc/resultclass.h%;

}

if (/$nocomment.*ISC_(TRUE|FALSE|TF)\W/m &&

! m%^#include <isc/(types|boolean).h>%m) {

print "$file has ISC_TRUE/FALSE/TF without <isc/(boolean|types).h>\n"

unless $file =~ m%isc/boolean.h%;

}

if (/$nocomment.*ISC_PLATFORM_/m &&

! m%^#include <isc/platform.h>%m) {

print "$file has ISC_PLATFORM_ without <isc/platform.h>\n"

unless $file =~ m%isc/platform.h%;

}

if ($file !~ m%isc/magic\.h$% && $lib ne "lwres") {

print "$file has ISC_MAGIC_VALID without <isc/magic.h>\n"

if /$nocomment.*ISC_MAGIC_VALID/m && ! m%^#include <isc/magic.h>%m;

print "$file could use ISC_MAGIC_VALID\n" if /^$nocomment.*->magic ==/m;

}

if (/$nocomment.*(ISC|DNS|DST)_R_/m &&

! m%^#include <\L$1\E/result.h>%m) {

print "$file has $1_R_ without <\L$1\E/result.h>\n"

unless $file =~ m%\L$1\E/result.h%m;

}

if (/^$nocomment(?!#define)[a-z].*([a-zA-Z0-9]\([^;]*\);)/m &&

! m%^#include <$lib/lang.h>%m) {

print "$file has declarations without <$lib/lang.h>\n";

}

#

# First see whether it can be compiled without any additional includes.

# Only bother doing this for files that will be installed as public

# headers (thus weeding out, for example, all of the dns/rdata/*/*.h)

#

if ($file =~ m%/include/% && system("cp $file $tmpfile") == 0) {

if (compile($file, $tmpfile, $objfile) != 0) {

print "$file does not compile stand-alone\n";

}

}

my $prefix = '';

my ($elided, $comment, $prefix_extend, $body);

while (1) {

eval {

# 1 23 4 5 6 78

if (m%(\A\Q$prefix\E((.*\n)*?))(\#include .*(<.*?>)(.*)\n)((.*\n)*)%) {

$elided = $5;

$prefix_extend = $2 . $4;

$comment = $6;

$body = $1 . $7;

} else {

$elided = ""; # stop processing this file.

}

};

if ($@ ne "") {

print "$file processing failed: $@\n";

last;

}

last if $elided eq "";

print STDERR "$file checking $elided\n" if $debug;

# Can mark in the header file when a #include should stay even

# though it might not appear that way otherwise.

next if $comment =~ /require|provide|extend|define|contract|ensure/i;

#

# Special exceptions.

# XXXDCL some of these should be perhaps generalized (ie, look for

# ISC_(LINK|LIST)_ when using <isc/list.h>.

#

if (($file =~ m%isc/log\.h$% && $elided eq "<syslog.h>") ||

($file =~ m%isc/print\.h$% && $elided =~ /^<std(arg|def)\.h>$/) ||

($file =~ m%isc/string\.h$% && $elided eq "<string.h>") ||

($file =~ m%isc/types\.h$% &&

$elided =~ m%^<isc/(boolean|int|offset)\.h>$%) ||

($file =~ m%isc/netdb\.h$% &&

$elided =~ m%^<(netdb|isc/net)\.h>$%)) {

next;

}

if ($elided =~ m%^<(isc|dns|dst)/result.h>$%) {

my $dir = $1;

if (! /$nocomment.*\U$dir\E_R_/m) {

unless ($dir eq "isc" && /$nocomment.*isc_result_t/m) {

# No {foo}_R_, but it is acceptable to include isc/result.h for

# isc_result_t ... but not both isc/result.h and isc/types.h.

# The later check will determine isc/result.h to be redundant,

# so only the ISC_R_ aspect has to be pointed out.

print "$file has <$dir/result.h> without \U$dir\E_R_\n";

next;

}

} else {

# There is an {foo}_R_; this is a necessary include.

next;

}

}

if ($elided eq "<$lib/lang.h>") {

if (! /^\U$lib\E_LANG_BEGINDECLS$/m) {

print "$file includes <$lib/lang.h> but " .

"has no \U$lib\E_LANG_BEGINDECLS\n";

} elsif (! /^\U$lib\E_LANG_ENDDECLS$/m) {

print "$file has \U$lib\E_LANG_BEGINDECLS but " .

"has no \U$lib\E_LANG_ENDDECLS\n";

} elsif (! /^$nocomment(?!#define)[a-z].*([a-zA-Z0-9]\()/m) {

print "$file has <$lib/lang.h> apparently not function declarations\n";

}

next;

}

if ($elided eq "<isc/eventclass.h>") {

if (! /$nocomment.*ISC_EVENTCLASS_/m) {

print "$file has <isc/eventclass.h> without ISC_EVENTCLASS_\n";

}

next;

}

if ($elided eq "<isc/resultclass.h>") {

if (! /$nocomment.*ISC_RESULTCLASS_/m) {

print "$file has <isc/resultclass.h> without ISC_RESULTCLASS_\n";

}

next;

}

if ($elided =~ "<(isc|dns)/types.h>") {

my $dir = $1;

if (! /^$nocomment.*$dir\_\S+\_t\s/m) {

print "$file has <$dir/types.h> but apparently no $dir\_*_t uses\n";

} elsif ($dir ne "isc" && m%^#include <isc/types.h>%m) {

print "$file has <$dir/types.h> and redundant <isc/types.h>\n";

}

# ... otherwise the types.h file is needed for the relevant _t types

# it defines, even if this header file accidentally picks it up by

# including another header that itself included types.h.

# So skip the elision test in any event.

# XXX would be good to test for files that need types.h but don't

# include it.

next;

}

if ($elided eq "<isc/boolean.h>") {

next if /^$nocomment.*ISC_(TRUE|FALSE|TF)\W/m;

}

if ($elided eq "<isc/platform.h>") {

if (! /^$nocomment.*ISC_PLATFORM_/m) {

print "$file has <isc/platform.h> but no ISC_PLATFORM_\n";

}

next;

}

if ($elided eq "<isc/magic.h>") {

if (! /^$nocomment.*ISC_MAGIC_VALID/m) {

print "$file has <isc/magic.h> but no ISC_MAGIC_VALID\n";

}

next;

}

open(TMP, "> $tmpfile");

print TMP "$body";

close(TMP);

print "$file elided $elided, compiling\n" if $debug;

if (compile($file, $tmpfile, $objfile) == 0) {

print "$file does not need $elided\n";

}

} continue {

$prefix .= $prefix_extend;

}

}

compile() {

my ($original, $source, $objfile) = @_;

my $includes;

my $stderr = $debug ? "" : "2>/dev/null";

if ($original =~ m%lib/(isc|tests)/%) {

$includes = $isc_includes;

} elsif ($original =~ m%lib/dns/%) {

$includes = "$isc_includes $dns_includes";

} elsif ($original =~ m%lib/lwres/%) {

$includes = $lwres_includes;

} elsif ($original =~ m%lib/omapi/%) {

$includes = "$isc_includes $dns_includes $omapi_includes";

} else {

$includes = "";

}

system("cc $includes -c $source -o $objfile $stderr");

unlink($source, $objfile);

return ($?);

}