#!/usr/bin/perl -w
#
# headers_check.pl execute a number of trivial consistency checks
#
# Usage: headers_check.pl dir arch [files...]
# dir:   dir to look for included files
# arch:  architecture
# files: list of files to check
#
# The script reads the supplied files line by line and:
#
# 1) for each include statement it checks if the
#    included file actually exists.
#    Only include files located in asm* and linux* are checked.
#    The rest are assumed to be system include files.
#
# 2) It is checked that prototypes does not use "extern"
#
# 3) Check for leaked CONFIG_ symbols

use strict;
use File::Basename;

my ($dir, $arch, @files) = @ARGV;

my $ret = 0;
my $line;
my $lineno = 0;
my $filename;

foreach my $file (@files) {
	$filename = $file;

	open(my $fh, '<', $filename)
		or die "$filename: $!\n";
	$lineno = 0;
	while ($line = <$fh>) {
		$lineno++;
		&check_include();
		&check_asm_types();
		&check_sizetypes();
		&check_declarations();
		# Dropped for now. Too much noise &check_config();
	}
	close $fh;
}
exit $ret;

sub check_include
{
	if ($line =~ m/^\s*#\s*include\s+<((asm|linux).*)>/) {
		my $inc = $1;
		my $found;
		$found = stat($dir . "/" . $inc);
		if (!$found) {
			$inc =~ s#asm/#asm-$arch/#;
			$found = stat($dir . "/" . $inc);
		}
		if (!$found) {
			printf STDERR "$filename:$lineno: included file '$inc' is not exported\n";
			$ret = 1;
		}
	}
}

sub check_declarations
{
	# soundcard.h is what it is
	if ($line =~ m/^void seqbuf_dump\(void\);/) {
		return;
	}
	# drm headers are being C++ friendly
	if ($line =~ m/^extern "C"/) {
		return;
	}
	if ($line =~ m/^(\s*extern|unsigned|char|short|int|long|void)\b/) {
		printf STDERR "$filename:$lineno: " .
			      "userspace cannot reference function or " .
			      "variable defined in the kernel\n";
	}
}

sub check_config
{
	if ($line =~ m/[^a-zA-Z0-9_]+CONFIG_([a-zA-Z0-9_]+)[^a-zA-Z0-9_]/) {
		printf STDERR "$filename:$lineno: leaks CONFIG_$1 to userspace where it is not valid\n";
	}
}

my $linux_asm_types;
sub check_asm_types
{
	if ($filename =~ /types.h|int-l64.h|int-ll64.h/o) {
		return;
	}
	if ($lineno == 1) {
		$linux_asm_types = 0;
	} elsif ($linux_asm_types >= 1) {
		return;
	}
	if ($line =~ m/^\s*#\s*include\s+<asm\/types.h>/) {
		$linux_asm_types = 1;
		printf STDERR "$filename:$lineno: " .
		"include of <linux/types.h> is preferred over <asm/types.h>\n"
		# Warn until headers are all fixed
		#$ret = 1;
	}
}

my $linux_types;
my %import_stack = ();
sub check_include_typesh
{
	my $path = $_[0];
	my $import_path;

	my $fh;
	my @file_paths = ($path, $dir . "/" .  $path, dirname($filename) . "/" . $path);
	for my $possible ( @file_paths ) {
	    if (not $import_stack{$possible} and open($fh, '<', $possible)) {
		$import_path = $possible;
		$import_stack{$import_path} = 1;
		last;
	    }
	}
	if (eof $fh) {
	    return;
	}

	my $line;
	while ($line = <$fh>) {
		if ($line =~ m/^\s*#\s*include\s+<linux\/types.h>/) {
			$linux_types = 1;
			last;
		}
		if (my $included = ($line =~ /^\s*#\s*include\s+[<"](\S+)[>"]/)[0]) {
			check_include_typesh($included);
		}
	}
	close $fh;
	delete $import_stack{$import_path};
}

sub check_sizetypes
{
	if ($filename =~ /types.h|int-l64.h|int-ll64.h/o) {
		return;
	}
	if ($lineno == 1) {
		$linux_types = 0;
	} elsif ($linux_types >= 1) {
		return;
	}
	if ($line =~ m/^\s*#\s*include\s+<linux\/types.h>/) {
		$linux_types = 1;
		return;
	}
	if (my $included = ($line =~ /^\s*#\s*include\s+[<"](\S+)[>"]/)[0]) {
		check_include_typesh($included);
	}
	if ($line =~ m/__[us](8|16|32|64)\b/) {
		printf STDERR "$filename:$lineno: " .
		              "found __[us]{8,16,32,64} type " .
		              "without #include <linux/types.h>\n";
		$linux_types = 2;
		# Warn until headers are all fixed
		#$ret = 1;
	}
}
/span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=2bd137de531367fb573d90150d1872cb2a2095f7'>lwtunnel: valid encap attr check should return 0 when lwtunnel is disabled</a></td><td>David Ahern</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2017-02-07 12:10:57 -0800'>2017-02-07</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=926af6273fc683cd98cd0ce7bf0d04a02eed6742'>Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net</a></td><td>Linus Torvalds</td><td>3</td><td><span class='deletions'>-7</span>/<span class='insertions'>+10</span></td></tr>
<tr><td><span title='2017-02-07 11:19:00 -0500'>2017-02-07</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=69629464e0b587f3711739b3aa2bcdaf2e075276'>udp: properly cope with csum errors</a></td><td>Eric Dumazet</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+3</span></td></tr>
<tr><td><span title='2017-02-04 19:44:22 -0500'>2017-02-04</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=d71b7896886345c53ef1d84bda2bc758554f5d61'>netlabel: out of bound access in cipso_v4_validate()</a></td><td>Eric Dumazet</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2017-02-04 12:18:01 -0800'>2017-02-04</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=a572a1b999489efb591287632279c6c9eca3e4ed'>Merge branch 'irq-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/ker...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+17</span></td></tr>
<tr><td><span title='2017-02-04 10:44:15 -0800'>2017-02-04</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=412e6d3fec247b2bc83106514b0fb3b17e2eb7fe'>Merge tag 'char-misc-4.10-rc7' of git://git.kernel.org/pub/scm/linux/kernel/g...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+30</span></td></tr>
<tr><td><span title='2017-02-03 14:13:19 -0800'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=a96dfddbcc04336bbed50dc2b24823e45e09e80c'>base/memory, hotplug: fix a kernel oops in show_valid_zones()</a></td><td>Toshi Kani</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2017-02-03 11:32:25 -0800'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=79c9089f97d37ffac88c3ddb6d359b2cf75058b7'>Merge tag 'drm-fixes-for-v4.10-rc7' of git://people.freedesktop.org/~airlied/...</a></td><td>Linus Torvalds</td><td>2</td><td><span class='deletions'>-1</span>/<span class='insertions'>+16</span></td></tr>
<tr><td><span title='2017-02-03 10:30:27 -0800'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=2cb54ce9ee92ae627bc1cef8bea236905910a86d'>Merge branch 'modversions' (modversions fixes for powerpc from Ard)</a></td><td>Linus Torvalds</td><td>3</td><td><span class='deletions'>-17</span>/<span class='insertions'>+25</span></td></tr>
<tr><td><span title='2017-02-03 09:56:43 -0800'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=29905b52fad0854351f57bab867647e4982285bf'>log2: make order_base_2() behave correctly on const input value zero</a></td><td>Ard Biesheuvel</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+12</span></td></tr>
<tr><td><span title='2017-02-03 08:28:25 -0800'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=4b9eee96fcb361a5e16a8d2619825e8a048f81f7'>module: unify absolute krctab definitions for 32-bit and 64-bit</a></td><td>Ard Biesheuvel</td><td>1</td><td><span class='deletions'>-7</span>/<span class='insertions'>+0</span></td></tr>
<tr><td><span title='2017-02-03 08:28:25 -0800'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=71810db27c1c853b335675bee335d893bc3d324b'>modversions: treat symbol CRCs as 32 bit quantities</a></td><td>Ard Biesheuvel</td><td>3</td><td><span class='deletions'>-12</span>/<span class='insertions'>+27</span></td></tr>
<tr><td><span title='2017-02-03 11:05:23 -0500'>2017-02-03</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=013e8167899d389075160412a8c0c5e0581e1f13'>ipv6: sr: remove cleanup flag and fix HMAC computation</a></td><td>David Lebrun</td><td>1</td><td><span class='deletions'>-6</span>/<span class='insertions'>+3</span></td></tr>
<tr><td><span title='2017-02-02 13:30:19 -0800'>2017-02-02</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=891aa1e0f13c3aaa756c69b343d6ab6f3357009b'>Merge branch 'perf-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/ke...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+0</span></td></tr>
<tr><td><span title='2017-02-01 11:52:27 -0800'>2017-02-01</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=6d04dfc8966019b8b0977b2cb942351f13d2b178'>Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net</a></td><td>Linus Torvalds</td><td>4</td><td><span class='deletions'>-19</span>/<span class='insertions'>+26</span></td></tr>
<tr><td><span title='2017-02-01 10:30:56 -0800'>2017-02-01</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=2883aaea363f7a897ff06d2e6c73ae7aae285bcb'>Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/vir...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2017-02-01 12:10:56 -0500'>2017-02-01</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=1a2a14444d32b89b28116daea86f63ced1716668'>net: fix ndo_features_check/ndo_fix_features comment ordering</a></td><td>Dimitris Michailidis</td><td>1</td><td><span class='deletions'>-14</span>/<span class='insertions'>+15</span></td></tr>
<tr><td><span title='2017-02-01 08:37:27 +0100'>2017-02-01</span></td><td><a href='/cgit.cgi/linux/net-next.git/commit/include?h=nds-private-remove&amp;id=fff4b87e594ad3d2e4f51e8d3d86a6f9d3d8b654'>perf/x86/intel/uncore: Make package handling more robust</a></td><td>Thomas Gleixner</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+0</span></td></tr>