10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 20a920b5bSAndy Whitcroft# (c) 2001, Dave Jones. <[email protected]> (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 40a920b5bSAndy Whitcroft# (c) 2007, Andy Whitcroft <[email protected]> (new conditions, test suite, etc) 50a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 60a920b5bSAndy Whitcroft 70a920b5bSAndy Whitcroftuse strict; 80a920b5bSAndy Whitcroft 90a920b5bSAndy Whitcroftmy $P = $0; 1000df344fSAndy Whitcroft$P =~ s@.*/@@g; 110a920b5bSAndy Whitcroft 126cbb2e71SAndy Whitcroftmy $V = '0.20'; 130a920b5bSAndy Whitcroft 140a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 150a920b5bSAndy Whitcroft 160a920b5bSAndy Whitcroftmy $quiet = 0; 170a920b5bSAndy Whitcroftmy $tree = 1; 180a920b5bSAndy Whitcroftmy $chk_signoff = 1; 190a920b5bSAndy Whitcroftmy $chk_patch = 1; 20653d4876SAndy Whitcroftmy $tst_type = 0; 21773647a0SAndy Whitcroftmy $tst_only; 226c72ffaaSAndy Whitcroftmy $emacs = 0; 238905a67cSAndy Whitcroftmy $terse = 0; 246c72ffaaSAndy Whitcroftmy $file = 0; 256c72ffaaSAndy Whitcroftmy $check = 0; 268905a67cSAndy Whitcroftmy $summary = 1; 278905a67cSAndy Whitcroftmy $mailback = 0; 2813214adfSAndy Whitcroftmy $summary_file = 0; 296c72ffaaSAndy Whitcroftmy $root; 30c2fdda0dSAndy Whitcroftmy %debug; 310a920b5bSAndy WhitcroftGetOptions( 326c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 330a920b5bSAndy Whitcroft 'tree!' => \$tree, 340a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 350a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 366c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 378905a67cSAndy Whitcroft 'terse!' => \$terse, 386c72ffaaSAndy Whitcroft 'file!' => \$file, 396c72ffaaSAndy Whitcroft 'subjective!' => \$check, 406c72ffaaSAndy Whitcroft 'strict!' => \$check, 416c72ffaaSAndy Whitcroft 'root=s' => \$root, 428905a67cSAndy Whitcroft 'summary!' => \$summary, 438905a67cSAndy Whitcroft 'mailback!' => \$mailback, 4413214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 4513214adfSAndy Whitcroft 46c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 4713214adfSAndy Whitcroft 'test-type!' => \$tst_type, 48773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 490a920b5bSAndy Whitcroft) or exit; 500a920b5bSAndy Whitcroft 510a920b5bSAndy Whitcroftmy $exit = 0; 520a920b5bSAndy Whitcroft 530a920b5bSAndy Whitcroftif ($#ARGV < 0) { 5400df344fSAndy Whitcroft print "usage: $P [options] patchfile\n"; 550a920b5bSAndy Whitcroft print "version: $V\n"; 560a920b5bSAndy Whitcroft print "options: -q => quiet\n"; 570a920b5bSAndy Whitcroft print " --no-tree => run without a kernel tree\n"; 588905a67cSAndy Whitcroft print " --terse => one line per report\n"; 596c72ffaaSAndy Whitcroft print " --emacs => emacs compile window format\n"; 606c72ffaaSAndy Whitcroft print " --file => check a source file\n"; 616c72ffaaSAndy Whitcroft print " --strict => enable more subjective tests\n"; 626c72ffaaSAndy Whitcroft print " --root => path to the kernel tree root\n"; 6313214adfSAndy Whitcroft print " --no-summary => suppress the per-file summary\n"; 6413214adfSAndy Whitcroft print " --summary-file => include the filename in summary\n"; 650a920b5bSAndy Whitcroft exit(1); 660a920b5bSAndy Whitcroft} 670a920b5bSAndy Whitcroft 68c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 69c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 70c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 71c2fdda0dSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';" 72c2fdda0dSAndy Whitcroft} 73c2fdda0dSAndy Whitcroft 748905a67cSAndy Whitcroftif ($terse) { 758905a67cSAndy Whitcroft $emacs = 1; 768905a67cSAndy Whitcroft $quiet++; 778905a67cSAndy Whitcroft} 788905a67cSAndy Whitcroft 796c72ffaaSAndy Whitcroftif ($tree) { 806c72ffaaSAndy Whitcroft if (defined $root) { 816c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 826c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 836c72ffaaSAndy Whitcroft } 846c72ffaaSAndy Whitcroft } else { 856c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 866c72ffaaSAndy Whitcroft $root = '.'; 876c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 886c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 896c72ffaaSAndy Whitcroft $root = $1; 906c72ffaaSAndy Whitcroft } 916c72ffaaSAndy Whitcroft } 926c72ffaaSAndy Whitcroft 936c72ffaaSAndy Whitcroft if (!defined $root) { 940a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 950a920b5bSAndy Whitcroft exit(2); 960a920b5bSAndy Whitcroft } 976c72ffaaSAndy Whitcroft} 986c72ffaaSAndy Whitcroft 996c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1006c72ffaaSAndy Whitcroft 1016c72ffaaSAndy Whitcroftour $Ident = qr{[A-Za-z_][A-Za-z\d_]*}; 1026c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1036c72ffaaSAndy Whitcroftour $Sparse = qr{ 1046c72ffaaSAndy Whitcroft __user| 1056c72ffaaSAndy Whitcroft __kernel| 1066c72ffaaSAndy Whitcroft __force| 1076c72ffaaSAndy Whitcroft __iomem| 1086c72ffaaSAndy Whitcroft __must_check| 1096c72ffaaSAndy Whitcroft __init_refok| 110cf655043SAndy Whitcroft __kprobes 1116c72ffaaSAndy Whitcroft }x; 1126c72ffaaSAndy Whitcroftour $Attribute = qr{ 1136c72ffaaSAndy Whitcroft const| 1146c72ffaaSAndy Whitcroft __read_mostly| 1156c72ffaaSAndy Whitcroft __kprobes| 1166c72ffaaSAndy Whitcroft __(?:mem|cpu|dev|)(?:initdata|init) 1176c72ffaaSAndy Whitcroft }x; 118c45dcabdSAndy Whitcroftour $Modifier; 1196c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 1206c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 1216c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 1226c72ffaaSAndy Whitcroft 1236c72ffaaSAndy Whitcroftour $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 1246c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 1256c72ffaaSAndy Whitcroftour $Operators = qr{ 1266c72ffaaSAndy Whitcroft <=|>=|==|!=| 1276c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 128c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 1296c72ffaaSAndy Whitcroft }x; 1306c72ffaaSAndy Whitcroft 1318905a67cSAndy Whitcroftour $NonptrType; 1328905a67cSAndy Whitcroftour $Type; 1338905a67cSAndy Whitcroftour $Declare; 1348905a67cSAndy Whitcroft 135171ae1a4SAndy Whitcroftour $UTF8 = qr { 136171ae1a4SAndy Whitcroft [\x09\x0A\x0D\x20-\x7E] # ASCII 137171ae1a4SAndy Whitcroft | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 138171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 139171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 140171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 141171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 142171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 143171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 144171ae1a4SAndy Whitcroft}x; 145171ae1a4SAndy Whitcroft 1468905a67cSAndy Whitcroftour @typeList = ( 1478905a67cSAndy Whitcroft qr{void}, 148c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 149c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 150c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 151c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 152c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 153c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 154c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 1558905a67cSAndy Whitcroft qr{unsigned}, 1568905a67cSAndy Whitcroft qr{float}, 1578905a67cSAndy Whitcroft qr{double}, 1588905a67cSAndy Whitcroft qr{bool}, 1598905a67cSAndy Whitcroft qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)}, 1608905a67cSAndy Whitcroft qr{struct\s+$Ident}, 1618905a67cSAndy Whitcroft qr{union\s+$Ident}, 1628905a67cSAndy Whitcroft qr{enum\s+$Ident}, 1638905a67cSAndy Whitcroft qr{${Ident}_t}, 1648905a67cSAndy Whitcroft qr{${Ident}_handler}, 1658905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 1668905a67cSAndy Whitcroft); 167c45dcabdSAndy Whitcroftour @modifierList = ( 168c45dcabdSAndy Whitcroft qr{fastcall}, 169c45dcabdSAndy Whitcroft); 1708905a67cSAndy Whitcroft 1718905a67cSAndy Whitcroftsub build_types { 172c45dcabdSAndy Whitcroft my $mods = "(?: \n" . join("|\n ", @modifierList) . "\n)"; 1738905a67cSAndy Whitcroft my $all = "(?: \n" . join("|\n ", @typeList) . "\n)"; 174*c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1758905a67cSAndy Whitcroft $NonptrType = qr{ 1768905a67cSAndy Whitcroft (?:const\s+)? 177c45dcabdSAndy Whitcroft (?:$mods\s+)? 178cf655043SAndy Whitcroft (?: 179c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 180c45dcabdSAndy Whitcroft (?:${all}\b) 181cf655043SAndy Whitcroft ) 182*c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 1838905a67cSAndy Whitcroft }x; 1848905a67cSAndy Whitcroft $Type = qr{ 185c45dcabdSAndy Whitcroft $NonptrType 1868905a67cSAndy Whitcroft (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)? 187*c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 1888905a67cSAndy Whitcroft }x; 1898905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 1908905a67cSAndy Whitcroft} 1918905a67cSAndy Whitcroftbuild_types(); 1926c72ffaaSAndy Whitcroft 1936c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 1940a920b5bSAndy Whitcroft 1954a0df2efSAndy Whitcroftmy @dep_includes = (); 1964a0df2efSAndy Whitcroftmy @dep_functions = (); 1976c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 1986c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 1996c72ffaaSAndy Whitcroft open(REMOVE, "<$root/$removal") || 2006c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 2010a920b5bSAndy Whitcroft while (<REMOVE>) { 202f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 203f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 204f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 2054a0df2efSAndy Whitcroft push(@dep_includes, $1); 2064a0df2efSAndy Whitcroft 207f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 208f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 209f0a594c1SAndy Whitcroft } 2104a0df2efSAndy Whitcroft } 2110a920b5bSAndy Whitcroft } 2120a920b5bSAndy Whitcroft } 2130a920b5bSAndy Whitcroft} 2140a920b5bSAndy Whitcroft 21500df344fSAndy Whitcroftmy @rawlines = (); 216c2fdda0dSAndy Whitcroftmy @lines = (); 217c2fdda0dSAndy Whitcroftmy $vname; 2186c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 2196c72ffaaSAndy Whitcroft if ($file) { 2206c72ffaaSAndy Whitcroft open(FILE, "diff -u /dev/null $filename|") || 2216c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 2226c72ffaaSAndy Whitcroft } else { 2236c72ffaaSAndy Whitcroft open(FILE, "<$filename") || 2246c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 2256c72ffaaSAndy Whitcroft } 226c2fdda0dSAndy Whitcroft if ($filename eq '-') { 227c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 228c2fdda0dSAndy Whitcroft } else { 229c2fdda0dSAndy Whitcroft $vname = $filename; 230c2fdda0dSAndy Whitcroft } 2316c72ffaaSAndy Whitcroft while (<FILE>) { 2320a920b5bSAndy Whitcroft chomp; 23300df344fSAndy Whitcroft push(@rawlines, $_); 2346c72ffaaSAndy Whitcroft } 2356c72ffaaSAndy Whitcroft close(FILE); 236c2fdda0dSAndy Whitcroft if (!process($filename)) { 2370a920b5bSAndy Whitcroft $exit = 1; 2380a920b5bSAndy Whitcroft } 23900df344fSAndy Whitcroft @rawlines = (); 24013214adfSAndy Whitcroft @lines = (); 2410a920b5bSAndy Whitcroft} 2420a920b5bSAndy Whitcroft 2430a920b5bSAndy Whitcroftexit($exit); 2440a920b5bSAndy Whitcroft 2450a920b5bSAndy Whitcroftsub top_of_kernel_tree { 2466c72ffaaSAndy Whitcroft my ($root) = @_; 2476c72ffaaSAndy Whitcroft 2486c72ffaaSAndy Whitcroft my @tree_check = ( 2496c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 2506c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 2516c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 2526c72ffaaSAndy Whitcroft ); 2536c72ffaaSAndy Whitcroft 2546c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 2556c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 2560a920b5bSAndy Whitcroft return 0; 2570a920b5bSAndy Whitcroft } 2586c72ffaaSAndy Whitcroft } 2596c72ffaaSAndy Whitcroft return 1; 2606c72ffaaSAndy Whitcroft} 2610a920b5bSAndy Whitcroft 2620a920b5bSAndy Whitcroftsub expand_tabs { 2630a920b5bSAndy Whitcroft my ($str) = @_; 2640a920b5bSAndy Whitcroft 2650a920b5bSAndy Whitcroft my $res = ''; 2660a920b5bSAndy Whitcroft my $n = 0; 2670a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 2680a920b5bSAndy Whitcroft if ($c eq "\t") { 2690a920b5bSAndy Whitcroft $res .= ' '; 2700a920b5bSAndy Whitcroft $n++; 2710a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 2720a920b5bSAndy Whitcroft $res .= ' '; 2730a920b5bSAndy Whitcroft } 2740a920b5bSAndy Whitcroft next; 2750a920b5bSAndy Whitcroft } 2760a920b5bSAndy Whitcroft $res .= $c; 2770a920b5bSAndy Whitcroft $n++; 2780a920b5bSAndy Whitcroft } 2790a920b5bSAndy Whitcroft 2800a920b5bSAndy Whitcroft return $res; 2810a920b5bSAndy Whitcroft} 2826c72ffaaSAndy Whitcroftsub copy_spacing { 283773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 2846c72ffaaSAndy Whitcroft return $res; 2856c72ffaaSAndy Whitcroft} 2860a920b5bSAndy Whitcroft 2874a0df2efSAndy Whitcroftsub line_stats { 2884a0df2efSAndy Whitcroft my ($line) = @_; 2894a0df2efSAndy Whitcroft 2904a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 2914a0df2efSAndy Whitcroft $line =~ s/^.//; 2924a0df2efSAndy Whitcroft $line = expand_tabs($line); 2934a0df2efSAndy Whitcroft 2944a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 2954a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 2964a0df2efSAndy Whitcroft 2974a0df2efSAndy Whitcroft return (length($line), length($white)); 2984a0df2efSAndy Whitcroft} 2994a0df2efSAndy Whitcroft 300773647a0SAndy Whitcroftmy $sanitise_quote = ''; 301773647a0SAndy Whitcroft 302773647a0SAndy Whitcroftsub sanitise_line_reset { 303773647a0SAndy Whitcroft my ($in_comment) = @_; 304773647a0SAndy Whitcroft 305773647a0SAndy Whitcroft if ($in_comment) { 306773647a0SAndy Whitcroft $sanitise_quote = '*/'; 307773647a0SAndy Whitcroft } else { 308773647a0SAndy Whitcroft $sanitise_quote = ''; 309773647a0SAndy Whitcroft } 310773647a0SAndy Whitcroft} 31100df344fSAndy Whitcroftsub sanitise_line { 31200df344fSAndy Whitcroft my ($line) = @_; 31300df344fSAndy Whitcroft 31400df344fSAndy Whitcroft my $res = ''; 31500df344fSAndy Whitcroft my $l = ''; 31600df344fSAndy Whitcroft 317c2fdda0dSAndy Whitcroft my $qlen = 0; 318773647a0SAndy Whitcroft my $off = 0; 319773647a0SAndy Whitcroft my $c; 32000df344fSAndy Whitcroft 321773647a0SAndy Whitcroft # Always copy over the diff marker. 322773647a0SAndy Whitcroft $res = substr($line, 0, 1); 323773647a0SAndy Whitcroft 324773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 325773647a0SAndy Whitcroft $c = substr($line, $off, 1); 326773647a0SAndy Whitcroft 327773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 328773647a0SAndy Whitcroft # and end, all to $;. 329773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 330773647a0SAndy Whitcroft $sanitise_quote = '*/'; 331773647a0SAndy Whitcroft 332773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 333773647a0SAndy Whitcroft $off++; 33400df344fSAndy Whitcroft next; 335773647a0SAndy Whitcroft } 336c45dcabdSAndy Whitcroft if (substr($line, $off, 2) eq '*/') { 337773647a0SAndy Whitcroft $sanitise_quote = ''; 338773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 339773647a0SAndy Whitcroft $off++; 340773647a0SAndy Whitcroft next; 341773647a0SAndy Whitcroft } 342773647a0SAndy Whitcroft 343773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 344773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 345773647a0SAndy Whitcroft $c eq "\\") { 346773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 347773647a0SAndy Whitcroft $off++; 348773647a0SAndy Whitcroft next; 349773647a0SAndy Whitcroft } 350773647a0SAndy Whitcroft # Regular quotes. 351773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 352773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 353773647a0SAndy Whitcroft $sanitise_quote = $c; 354773647a0SAndy Whitcroft 355773647a0SAndy Whitcroft substr($res, $off, 1, $c); 356773647a0SAndy Whitcroft next; 357773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 358773647a0SAndy Whitcroft $sanitise_quote = ''; 35900df344fSAndy Whitcroft } 36000df344fSAndy Whitcroft } 361773647a0SAndy Whitcroft 362773647a0SAndy Whitcroft #print "SQ:$sanitise_quote\n"; 363773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 364773647a0SAndy Whitcroft substr($res, $off, 1, $;); 365773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 366773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 36700df344fSAndy Whitcroft } else { 368773647a0SAndy Whitcroft substr($res, $off, 1, $c); 36900df344fSAndy Whitcroft } 370c2fdda0dSAndy Whitcroft } 371c2fdda0dSAndy Whitcroft 372c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 373c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 374c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 375c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 376c2fdda0dSAndy Whitcroft 377c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 378c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 379c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 380c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 381c2fdda0dSAndy Whitcroft } 382c2fdda0dSAndy Whitcroft 38300df344fSAndy Whitcroft return $res; 38400df344fSAndy Whitcroft} 38500df344fSAndy Whitcroft 3868905a67cSAndy Whitcroftsub ctx_statement_block { 3878905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 3888905a67cSAndy Whitcroft my $line = $linenr - 1; 3898905a67cSAndy Whitcroft my $blk = ''; 3908905a67cSAndy Whitcroft my $soff = $off; 3918905a67cSAndy Whitcroft my $coff = $off - 1; 392773647a0SAndy Whitcroft my $coff_set = 0; 3938905a67cSAndy Whitcroft 39413214adfSAndy Whitcroft my $loff = 0; 39513214adfSAndy Whitcroft 3968905a67cSAndy Whitcroft my $type = ''; 3978905a67cSAndy Whitcroft my $level = 0; 398cf655043SAndy Whitcroft my $p; 3998905a67cSAndy Whitcroft my $c; 4008905a67cSAndy Whitcroft my $len = 0; 40113214adfSAndy Whitcroft 40213214adfSAndy Whitcroft my $remainder; 4038905a67cSAndy Whitcroft while (1) { 404773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 4058905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 4068905a67cSAndy Whitcroft # context. 4078905a67cSAndy Whitcroft if ($off >= $len) { 4088905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 409c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 4108905a67cSAndy Whitcroft $remain--; 41113214adfSAndy Whitcroft $loff = $len; 412c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 4138905a67cSAndy Whitcroft $len = length($blk); 4148905a67cSAndy Whitcroft $line++; 4158905a67cSAndy Whitcroft last; 4168905a67cSAndy Whitcroft } 4178905a67cSAndy Whitcroft # Bail if there is no further context. 4188905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 41913214adfSAndy Whitcroft if ($off >= $len) { 4208905a67cSAndy Whitcroft last; 4218905a67cSAndy Whitcroft } 4228905a67cSAndy Whitcroft } 423cf655043SAndy Whitcroft $p = $c; 4248905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 42513214adfSAndy Whitcroft $remainder = substr($blk, $off); 4268905a67cSAndy Whitcroft 427773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 4288905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 4298905a67cSAndy Whitcroft # outermost level. 4308905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 4318905a67cSAndy Whitcroft last; 4328905a67cSAndy Whitcroft } 4338905a67cSAndy Whitcroft 43413214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 435773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 436773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 437773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 438773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 439773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 440773647a0SAndy Whitcroft $coff_set = 1; 441773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 442773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 44313214adfSAndy Whitcroft } 44413214adfSAndy Whitcroft 4458905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 4468905a67cSAndy Whitcroft $level++; 4478905a67cSAndy Whitcroft $type = '('; 4488905a67cSAndy Whitcroft } 4498905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 4508905a67cSAndy Whitcroft $level--; 4518905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 4528905a67cSAndy Whitcroft 4538905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 4548905a67cSAndy Whitcroft $coff = $off; 455773647a0SAndy Whitcroft $coff_set = 1; 456773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 4578905a67cSAndy Whitcroft } 4588905a67cSAndy Whitcroft } 4598905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 4608905a67cSAndy Whitcroft $level++; 4618905a67cSAndy Whitcroft $type = '{'; 4628905a67cSAndy Whitcroft } 4638905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 4648905a67cSAndy Whitcroft $level--; 4658905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 4668905a67cSAndy Whitcroft 4678905a67cSAndy Whitcroft if ($level == 0) { 4688905a67cSAndy Whitcroft last; 4698905a67cSAndy Whitcroft } 4708905a67cSAndy Whitcroft } 4718905a67cSAndy Whitcroft $off++; 4728905a67cSAndy Whitcroft } 47313214adfSAndy Whitcroft if ($off == $len) { 47413214adfSAndy Whitcroft $line++; 47513214adfSAndy Whitcroft $remain--; 47613214adfSAndy Whitcroft } 4778905a67cSAndy Whitcroft 4788905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 4798905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 4808905a67cSAndy Whitcroft 4818905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 4828905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 4838905a67cSAndy Whitcroft 484773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 48513214adfSAndy Whitcroft 48613214adfSAndy Whitcroft return ($statement, $condition, 48713214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 48813214adfSAndy Whitcroft} 48913214adfSAndy Whitcroft 490cf655043SAndy Whitcroftsub statement_lines { 491cf655043SAndy Whitcroft my ($stmt) = @_; 492cf655043SAndy Whitcroft 493cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 494cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 495cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 496cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 497cf655043SAndy Whitcroft 498cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 499cf655043SAndy Whitcroft 500cf655043SAndy Whitcroft return $#stmt_lines + 2; 501cf655043SAndy Whitcroft} 502cf655043SAndy Whitcroft 503cf655043SAndy Whitcroftsub statement_rawlines { 504cf655043SAndy Whitcroft my ($stmt) = @_; 505cf655043SAndy Whitcroft 506cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 507cf655043SAndy Whitcroft 508cf655043SAndy Whitcroft return $#stmt_lines + 2; 509cf655043SAndy Whitcroft} 510cf655043SAndy Whitcroft 511cf655043SAndy Whitcroftsub statement_block_size { 512cf655043SAndy Whitcroft my ($stmt) = @_; 513cf655043SAndy Whitcroft 514cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 515cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 516cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 517cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 518cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 519cf655043SAndy Whitcroft 520cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 521cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 522cf655043SAndy Whitcroft 523cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 524cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 525cf655043SAndy Whitcroft 526cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 527cf655043SAndy Whitcroft return $stmt_lines; 528cf655043SAndy Whitcroft } else { 529cf655043SAndy Whitcroft return $stmt_statements; 530cf655043SAndy Whitcroft } 531cf655043SAndy Whitcroft} 532cf655043SAndy Whitcroft 53313214adfSAndy Whitcroftsub ctx_statement_full { 53413214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 53513214adfSAndy Whitcroft my ($statement, $condition, $level); 53613214adfSAndy Whitcroft 53713214adfSAndy Whitcroft my (@chunks); 53813214adfSAndy Whitcroft 539cf655043SAndy Whitcroft # Grab the first conditional/block pair. 54013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 54113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 542773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 54313214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 544cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 545cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 546cf655043SAndy Whitcroft } 547cf655043SAndy Whitcroft 548cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 549cf655043SAndy Whitcroft # could continue the statement. 550cf655043SAndy Whitcroft for (;;) { 55113214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 55213214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 553cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 554773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 555cf655043SAndy Whitcroft #print "C: push\n"; 556cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 55713214adfSAndy Whitcroft } 55813214adfSAndy Whitcroft 55913214adfSAndy Whitcroft return ($level, $linenr, @chunks); 5608905a67cSAndy Whitcroft} 5618905a67cSAndy Whitcroft 5624a0df2efSAndy Whitcroftsub ctx_block_get { 563f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 5644a0df2efSAndy Whitcroft my $line; 5654a0df2efSAndy Whitcroft my $start = $linenr - 1; 5664a0df2efSAndy Whitcroft my $blk = ''; 5674a0df2efSAndy Whitcroft my @o; 5684a0df2efSAndy Whitcroft my @c; 5694a0df2efSAndy Whitcroft my @res = (); 5704a0df2efSAndy Whitcroft 571f0a594c1SAndy Whitcroft my $level = 0; 57200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 57300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 57400df344fSAndy Whitcroft $remain--; 57500df344fSAndy Whitcroft 57600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 577f0a594c1SAndy Whitcroft foreach my $c (split(//, $rawlines[$line])) { 578f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 579f0a594c1SAndy Whitcroft if ($off > 0) { 580f0a594c1SAndy Whitcroft $off--; 581f0a594c1SAndy Whitcroft next; 582f0a594c1SAndy Whitcroft } 5834a0df2efSAndy Whitcroft 584f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 585f0a594c1SAndy Whitcroft $level--; 586f0a594c1SAndy Whitcroft last if ($level == 0); 587f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 588f0a594c1SAndy Whitcroft $level++; 589f0a594c1SAndy Whitcroft } 590f0a594c1SAndy Whitcroft } 5914a0df2efSAndy Whitcroft 592f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 59300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 5944a0df2efSAndy Whitcroft } 5954a0df2efSAndy Whitcroft 596f0a594c1SAndy Whitcroft last if ($level == 0); 5974a0df2efSAndy Whitcroft } 5984a0df2efSAndy Whitcroft 599f0a594c1SAndy Whitcroft return ($level, @res); 6004a0df2efSAndy Whitcroft} 6014a0df2efSAndy Whitcroftsub ctx_block_outer { 6024a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6034a0df2efSAndy Whitcroft 604f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 605f0a594c1SAndy Whitcroft return @r; 6064a0df2efSAndy Whitcroft} 6074a0df2efSAndy Whitcroftsub ctx_block { 6084a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6094a0df2efSAndy Whitcroft 610f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 611f0a594c1SAndy Whitcroft return @r; 612653d4876SAndy Whitcroft} 613653d4876SAndy Whitcroftsub ctx_statement { 614f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 615f0a594c1SAndy Whitcroft 616f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 617f0a594c1SAndy Whitcroft return @r; 618f0a594c1SAndy Whitcroft} 619f0a594c1SAndy Whitcroftsub ctx_block_level { 620653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 621653d4876SAndy Whitcroft 622f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 6234a0df2efSAndy Whitcroft} 6249c0ca6f9SAndy Whitcroftsub ctx_statement_level { 6259c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 6269c0ca6f9SAndy Whitcroft 6279c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 6289c0ca6f9SAndy Whitcroft} 6294a0df2efSAndy Whitcroft 6304a0df2efSAndy Whitcroftsub ctx_locate_comment { 6314a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6324a0df2efSAndy Whitcroft 6334a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 63400df344fSAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*$@); 6354a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 6364a0df2efSAndy Whitcroft 6374a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 6384a0df2efSAndy Whitcroft # comment. 6394a0df2efSAndy Whitcroft my $in_comment = 0; 6404a0df2efSAndy Whitcroft $current_comment = ''; 6414a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 64200df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 64300df344fSAndy Whitcroft #warn " $line\n"; 6444a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 6454a0df2efSAndy Whitcroft $in_comment = 1; 6464a0df2efSAndy Whitcroft } 6474a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 6484a0df2efSAndy Whitcroft $in_comment = 1; 6494a0df2efSAndy Whitcroft } 6504a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 6514a0df2efSAndy Whitcroft $current_comment = ''; 6524a0df2efSAndy Whitcroft } 6534a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 6544a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 6554a0df2efSAndy Whitcroft $in_comment = 0; 6564a0df2efSAndy Whitcroft } 6574a0df2efSAndy Whitcroft } 6584a0df2efSAndy Whitcroft 6594a0df2efSAndy Whitcroft chomp($current_comment); 6604a0df2efSAndy Whitcroft return($current_comment); 6614a0df2efSAndy Whitcroft} 6624a0df2efSAndy Whitcroftsub ctx_has_comment { 6634a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6644a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 6654a0df2efSAndy Whitcroft 66600df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 6674a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 6684a0df2efSAndy Whitcroft 6694a0df2efSAndy Whitcroft return ($cmt ne ''); 6704a0df2efSAndy Whitcroft} 6714a0df2efSAndy Whitcroft 6720a920b5bSAndy Whitcroftsub cat_vet { 6730a920b5bSAndy Whitcroft my ($vet) = @_; 6749c0ca6f9SAndy Whitcroft my ($res, $coded); 6750a920b5bSAndy Whitcroft 6769c0ca6f9SAndy Whitcroft $res = ''; 6776c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 6786c72ffaaSAndy Whitcroft $res .= $1; 6796c72ffaaSAndy Whitcroft if ($2 ne '') { 6809c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 6816c72ffaaSAndy Whitcroft $res .= $coded; 6826c72ffaaSAndy Whitcroft } 6839c0ca6f9SAndy Whitcroft } 6849c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 6850a920b5bSAndy Whitcroft 6869c0ca6f9SAndy Whitcroft return $res; 6870a920b5bSAndy Whitcroft} 6880a920b5bSAndy Whitcroft 689c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 690cf655043SAndy Whitcroftmy $av_pending; 691c2fdda0dSAndy Whitcroftmy @av_paren_type; 692c2fdda0dSAndy Whitcroft 693c2fdda0dSAndy Whitcroftsub annotate_reset { 694c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 695cf655043SAndy Whitcroft $av_pending = '_'; 696cf655043SAndy Whitcroft @av_paren_type = ('E'); 697c2fdda0dSAndy Whitcroft} 698c2fdda0dSAndy Whitcroft 6996c72ffaaSAndy Whitcroftsub annotate_values { 7006c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 7016c72ffaaSAndy Whitcroft 7026c72ffaaSAndy Whitcroft my $res; 7036c72ffaaSAndy Whitcroft my $cur = $stream; 7046c72ffaaSAndy Whitcroft 705c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 7066c72ffaaSAndy Whitcroft 7076c72ffaaSAndy Whitcroft while (length($cur)) { 708773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 709cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 710171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 7116c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 712c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 713c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 714cf655043SAndy Whitcroft $type = pop(@av_paren_type); 715c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 7166c72ffaaSAndy Whitcroft } 7176c72ffaaSAndy Whitcroft 718*c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\))/) { 719c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 7206c72ffaaSAndy Whitcroft $type = 'T'; 7216c72ffaaSAndy Whitcroft 722c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 723171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 724c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 725171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 726171ae1a4SAndy Whitcroft if ($2 ne '') { 727cf655043SAndy Whitcroft $av_pending = 'N'; 728171ae1a4SAndy Whitcroft } 729171ae1a4SAndy Whitcroft $type = 'E'; 730171ae1a4SAndy Whitcroft 731c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 732171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 733171ae1a4SAndy Whitcroft $av_preprocessor = 1; 734171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 7356c72ffaaSAndy Whitcroft 736c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 737cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 738c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 739cf655043SAndy Whitcroft 740cf655043SAndy Whitcroft push(@av_paren_type, $type); 741cf655043SAndy Whitcroft push(@av_paren_type, $type); 742171ae1a4SAndy Whitcroft $type = 'E'; 743cf655043SAndy Whitcroft 744c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 745cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 746cf655043SAndy Whitcroft $av_preprocessor = 1; 747cf655043SAndy Whitcroft 748cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 749cf655043SAndy Whitcroft 750171ae1a4SAndy Whitcroft $type = 'E'; 751cf655043SAndy Whitcroft 752c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 753cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 754cf655043SAndy Whitcroft 755cf655043SAndy Whitcroft $av_preprocessor = 1; 756cf655043SAndy Whitcroft 757cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 758cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 759cf655043SAndy Whitcroft pop(@av_paren_type); 760cf655043SAndy Whitcroft push(@av_paren_type, $type); 761171ae1a4SAndy Whitcroft $type = 'E'; 7626c72ffaaSAndy Whitcroft 7636c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 764c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 7656c72ffaaSAndy Whitcroft 766171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 767171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 768171ae1a4SAndy Whitcroft $av_pending = $type; 769171ae1a4SAndy Whitcroft $type = 'N'; 770171ae1a4SAndy Whitcroft 7716c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 772c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 7736c72ffaaSAndy Whitcroft if (defined $2) { 774cf655043SAndy Whitcroft $av_pending = 'V'; 7756c72ffaaSAndy Whitcroft } 7766c72ffaaSAndy Whitcroft $type = 'N'; 7776c72ffaaSAndy Whitcroft 77813214adfSAndy Whitcroft } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) { 779c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 780cf655043SAndy Whitcroft $av_pending = 'N'; 7816c72ffaaSAndy Whitcroft $type = 'N'; 7826c72ffaaSAndy Whitcroft 7836c72ffaaSAndy Whitcroft } elsif ($cur =~/^(return|case|else)/o) { 784c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 7856c72ffaaSAndy Whitcroft $type = 'N'; 7866c72ffaaSAndy Whitcroft 7876c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 788c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 789cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 790cf655043SAndy Whitcroft $av_pending = '_'; 7916c72ffaaSAndy Whitcroft $type = 'N'; 7926c72ffaaSAndy Whitcroft 7936c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 794cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 795cf655043SAndy Whitcroft if ($new_type ne '_') { 796cf655043SAndy Whitcroft $type = $new_type; 797c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 798c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 7996c72ffaaSAndy Whitcroft } else { 800c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 8016c72ffaaSAndy Whitcroft } 8026c72ffaaSAndy Whitcroft 803*c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 804c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 805*c8cb2ca3SAndy Whitcroft $type = 'V'; 806cf655043SAndy Whitcroft $av_pending = 'V'; 8076c72ffaaSAndy Whitcroft 8086c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 809c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 8106c72ffaaSAndy Whitcroft $type = 'V'; 8116c72ffaaSAndy Whitcroft 8126c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 813c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 8146c72ffaaSAndy Whitcroft $type = 'N'; 8156c72ffaaSAndy Whitcroft 816cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 817c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 81813214adfSAndy Whitcroft $type = 'E'; 81913214adfSAndy Whitcroft 820cf655043SAndy Whitcroft } elsif ($cur =~ /^(;|\?|:|\[)/o) { 82113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 8226c72ffaaSAndy Whitcroft $type = 'N'; 8236c72ffaaSAndy Whitcroft 8246c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 825c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 8266c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 8276c72ffaaSAndy Whitcroft $type = 'N'; 8286c72ffaaSAndy Whitcroft } 8296c72ffaaSAndy Whitcroft 8306c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 831c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 8326c72ffaaSAndy Whitcroft } 8336c72ffaaSAndy Whitcroft if (defined $1) { 8346c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 8356c72ffaaSAndy Whitcroft $res .= $type x length($1); 8366c72ffaaSAndy Whitcroft } 8376c72ffaaSAndy Whitcroft } 8386c72ffaaSAndy Whitcroft 8396c72ffaaSAndy Whitcroft return $res; 8406c72ffaaSAndy Whitcroft} 8416c72ffaaSAndy Whitcroft 8428905a67cSAndy Whitcroftsub possible { 84313214adfSAndy Whitcroft my ($possible, $line) = @_; 8448905a67cSAndy Whitcroft 845c45dcabdSAndy Whitcroft print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1); 8468905a67cSAndy Whitcroft if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ && 8478905a67cSAndy Whitcroft $possible ne 'goto' && $possible ne 'return' && 8488905a67cSAndy Whitcroft $possible ne 'case' && $possible ne 'else' && 849c45dcabdSAndy Whitcroft $possible ne 'asm' && 850c45dcabdSAndy Whitcroft $possible !~ /^(typedef|struct|enum)\b/) { 851c45dcabdSAndy Whitcroft # Check for modifiers. 852c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 853c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 854c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 855c45dcabdSAndy Whitcroft 856c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 857c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 858c45dcabdSAndy Whitcroft warn "MODIFIER: $possible ($line)\n" if ($dbg_possible); 859c45dcabdSAndy Whitcroft push(@modifierList, $possible); 860c45dcabdSAndy Whitcroft 861c45dcabdSAndy Whitcroft } else { 86213214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 8638905a67cSAndy Whitcroft push(@typeList, $possible); 864c45dcabdSAndy Whitcroft } 8658905a67cSAndy Whitcroft build_types(); 8668905a67cSAndy Whitcroft } 8678905a67cSAndy Whitcroft} 8688905a67cSAndy Whitcroft 8696c72ffaaSAndy Whitcroftmy $prefix = ''; 8706c72ffaaSAndy Whitcroft 871f0a594c1SAndy Whitcroftsub report { 872773647a0SAndy Whitcroft if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) { 873773647a0SAndy Whitcroft return 0; 874773647a0SAndy Whitcroft } 8758905a67cSAndy Whitcroft my $line = $prefix . $_[0]; 8768905a67cSAndy Whitcroft 8778905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 8788905a67cSAndy Whitcroft 87913214adfSAndy Whitcroft push(our @report, $line); 880773647a0SAndy Whitcroft 881773647a0SAndy Whitcroft return 1; 882f0a594c1SAndy Whitcroft} 883f0a594c1SAndy Whitcroftsub report_dump { 88413214adfSAndy Whitcroft our @report; 885f0a594c1SAndy Whitcroft} 886de7d4f0eSAndy Whitcroftsub ERROR { 887773647a0SAndy Whitcroft if (report("ERROR: $_[0]\n")) { 888de7d4f0eSAndy Whitcroft our $clean = 0; 8896c72ffaaSAndy Whitcroft our $cnt_error++; 890de7d4f0eSAndy Whitcroft } 891773647a0SAndy Whitcroft} 892de7d4f0eSAndy Whitcroftsub WARN { 893773647a0SAndy Whitcroft if (report("WARNING: $_[0]\n")) { 894de7d4f0eSAndy Whitcroft our $clean = 0; 8956c72ffaaSAndy Whitcroft our $cnt_warn++; 896de7d4f0eSAndy Whitcroft } 897773647a0SAndy Whitcroft} 898de7d4f0eSAndy Whitcroftsub CHK { 899773647a0SAndy Whitcroft if ($check && report("CHECK: $_[0]\n")) { 900de7d4f0eSAndy Whitcroft our $clean = 0; 9016c72ffaaSAndy Whitcroft our $cnt_chk++; 9026c72ffaaSAndy Whitcroft } 903de7d4f0eSAndy Whitcroft} 904de7d4f0eSAndy Whitcroft 9050a920b5bSAndy Whitcroftsub process { 9060a920b5bSAndy Whitcroft my $filename = shift; 9070a920b5bSAndy Whitcroft 9080a920b5bSAndy Whitcroft my $linenr=0; 9090a920b5bSAndy Whitcroft my $prevline=""; 910c2fdda0dSAndy Whitcroft my $prevrawline=""; 9110a920b5bSAndy Whitcroft my $stashline=""; 912c2fdda0dSAndy Whitcroft my $stashrawline=""; 9130a920b5bSAndy Whitcroft 9144a0df2efSAndy Whitcroft my $length; 9150a920b5bSAndy Whitcroft my $indent; 9160a920b5bSAndy Whitcroft my $previndent=0; 9170a920b5bSAndy Whitcroft my $stashindent=0; 9180a920b5bSAndy Whitcroft 919de7d4f0eSAndy Whitcroft our $clean = 1; 9200a920b5bSAndy Whitcroft my $signoff = 0; 9210a920b5bSAndy Whitcroft my $is_patch = 0; 9220a920b5bSAndy Whitcroft 92313214adfSAndy Whitcroft our @report = (); 9246c72ffaaSAndy Whitcroft our $cnt_lines = 0; 9256c72ffaaSAndy Whitcroft our $cnt_error = 0; 9266c72ffaaSAndy Whitcroft our $cnt_warn = 0; 9276c72ffaaSAndy Whitcroft our $cnt_chk = 0; 9286c72ffaaSAndy Whitcroft 9290a920b5bSAndy Whitcroft # Trace the real file/line as we go. 9300a920b5bSAndy Whitcroft my $realfile = ''; 9310a920b5bSAndy Whitcroft my $realline = 0; 9320a920b5bSAndy Whitcroft my $realcnt = 0; 9330a920b5bSAndy Whitcroft my $here = ''; 9340a920b5bSAndy Whitcroft my $in_comment = 0; 935c2fdda0dSAndy Whitcroft my $comment_edge = 0; 9360a920b5bSAndy Whitcroft my $first_line = 0; 9370a920b5bSAndy Whitcroft 93813214adfSAndy Whitcroft my $prev_values = 'E'; 93913214adfSAndy Whitcroft 94013214adfSAndy Whitcroft # suppression flags 941773647a0SAndy Whitcroft my %suppress_ifbraces; 942653d4876SAndy Whitcroft 943c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 944de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 945c2fdda0dSAndy Whitcroft # 946de7d4f0eSAndy Whitcroft my @setup_docs = (); 947de7d4f0eSAndy Whitcroft my $setup_docs = 0; 948773647a0SAndy Whitcroft 949773647a0SAndy Whitcroft sanitise_line_reset(); 950c2fdda0dSAndy Whitcroft my $line; 951c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 952773647a0SAndy Whitcroft $linenr++; 953773647a0SAndy Whitcroft $line = $rawline; 954c2fdda0dSAndy Whitcroft 955773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 956de7d4f0eSAndy Whitcroft $setup_docs = 0; 957de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 958de7d4f0eSAndy Whitcroft $setup_docs = 1; 959de7d4f0eSAndy Whitcroft } 960773647a0SAndy Whitcroft #next; 961de7d4f0eSAndy Whitcroft } 962773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 963773647a0SAndy Whitcroft $realline=$1-1; 964773647a0SAndy Whitcroft if (defined $2) { 965773647a0SAndy Whitcroft $realcnt=$3+1; 966773647a0SAndy Whitcroft } else { 967773647a0SAndy Whitcroft $realcnt=1+1; 968773647a0SAndy Whitcroft } 969c45dcabdSAndy Whitcroft $in_comment = 0; 970773647a0SAndy Whitcroft 971773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 972773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 973773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 974773647a0SAndy Whitcroft # at context start. 975773647a0SAndy Whitcroft my $edge; 976171ae1a4SAndy Whitcroft for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) { 977773647a0SAndy Whitcroft next if ($line =~ /^-/); 978773647a0SAndy Whitcroft ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@); 979773647a0SAndy Whitcroft last if (defined $edge); 980773647a0SAndy Whitcroft } 981773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 982773647a0SAndy Whitcroft $in_comment = 1; 983773647a0SAndy Whitcroft } 984773647a0SAndy Whitcroft 985773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 986773647a0SAndy Whitcroft # is the start of a diff block and this line starts 987773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 988773647a0SAndy Whitcroft if (!defined $edge && 989773647a0SAndy Whitcroft $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@) 990773647a0SAndy Whitcroft { 991773647a0SAndy Whitcroft $in_comment = 1; 992773647a0SAndy Whitcroft } 993773647a0SAndy Whitcroft 994773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 995773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 996773647a0SAndy Whitcroft 997171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 998773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 999171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1000773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1001773647a0SAndy Whitcroft } 1002773647a0SAndy Whitcroft push(@lines, $line); 1003773647a0SAndy Whitcroft 1004773647a0SAndy Whitcroft if ($realcnt > 1) { 1005773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1006773647a0SAndy Whitcroft } else { 1007773647a0SAndy Whitcroft $realcnt = 0; 1008773647a0SAndy Whitcroft } 1009773647a0SAndy Whitcroft 1010773647a0SAndy Whitcroft #print "==>$rawline\n"; 1011773647a0SAndy Whitcroft #print "-->$line\n"; 1012de7d4f0eSAndy Whitcroft 1013de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1014de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1015de7d4f0eSAndy Whitcroft } 1016de7d4f0eSAndy Whitcroft } 1017de7d4f0eSAndy Whitcroft 10186c72ffaaSAndy Whitcroft $prefix = ''; 10196c72ffaaSAndy Whitcroft 1020773647a0SAndy Whitcroft $realcnt = 0; 1021773647a0SAndy Whitcroft $linenr = 0; 10220a920b5bSAndy Whitcroft foreach my $line (@lines) { 10230a920b5bSAndy Whitcroft $linenr++; 10240a920b5bSAndy Whitcroft 1025c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 10266c72ffaaSAndy Whitcroft 10270a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 10286c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 10290a920b5bSAndy Whitcroft $is_patch = 1; 10304a0df2efSAndy Whitcroft $first_line = $linenr + 1; 10310a920b5bSAndy Whitcroft $realline=$1-1; 10320a920b5bSAndy Whitcroft if (defined $2) { 10330a920b5bSAndy Whitcroft $realcnt=$3+1; 10340a920b5bSAndy Whitcroft } else { 10350a920b5bSAndy Whitcroft $realcnt=1+1; 10360a920b5bSAndy Whitcroft } 1037c2fdda0dSAndy Whitcroft annotate_reset(); 103813214adfSAndy Whitcroft $prev_values = 'E'; 103913214adfSAndy Whitcroft 1040773647a0SAndy Whitcroft %suppress_ifbraces = (); 10410a920b5bSAndy Whitcroft next; 10420a920b5bSAndy Whitcroft 10434a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 10444a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 10454a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1046773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 10470a920b5bSAndy Whitcroft $realline++; 1048d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 10490a920b5bSAndy Whitcroft 10504a0df2efSAndy Whitcroft # Measure the line length and indent. 1051c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 10520a920b5bSAndy Whitcroft 10530a920b5bSAndy Whitcroft # Track the previous line. 10540a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 10550a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1056c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1057c2fdda0dSAndy Whitcroft 1058773647a0SAndy Whitcroft #warn "line<$line>\n"; 10596c72ffaaSAndy Whitcroft 1060d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1061d8aaf121SAndy Whitcroft $realcnt--; 10620a920b5bSAndy Whitcroft } 10630a920b5bSAndy Whitcroft 10640a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1065773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1066773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1067773647a0SAndy Whitcroft 10686c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 10696c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1070773647a0SAndy Whitcroft 1071773647a0SAndy Whitcroft # extract the filename as it passes 1072773647a0SAndy Whitcroft if ($line=~/^\+\+\+\s+(\S+)/) { 1073773647a0SAndy Whitcroft $realfile = $1; 1074773647a0SAndy Whitcroft $realfile =~ s@^[^/]*/@@; 1075773647a0SAndy Whitcroft 1076773647a0SAndy Whitcroft if ($realfile =~ m@include/asm/@) { 1077773647a0SAndy Whitcroft ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1078773647a0SAndy Whitcroft } 1079773647a0SAndy Whitcroft next; 1080773647a0SAndy Whitcroft } 1081773647a0SAndy Whitcroft 1082389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 10830a920b5bSAndy Whitcroft 1084c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1085c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1086c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 10870a920b5bSAndy Whitcroft 10886c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 10896c72ffaaSAndy Whitcroft 10900a920b5bSAndy Whitcroft#check the patch for a signoff: 1091d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 10924a0df2efSAndy Whitcroft # This is a signoff, if ugly, so do not double report. 10934a0df2efSAndy Whitcroft $signoff++; 10940a920b5bSAndy Whitcroft if (!($line =~ /^\s*Signed-off-by:/)) { 1095de7d4f0eSAndy Whitcroft WARN("Signed-off-by: is the preferred form\n" . 1096de7d4f0eSAndy Whitcroft $herecurr); 10970a920b5bSAndy Whitcroft } 10980a920b5bSAndy Whitcroft if ($line =~ /^\s*signed-off-by:\S/i) { 1099773647a0SAndy Whitcroft WARN("space required after Signed-off-by:\n" . 1100de7d4f0eSAndy Whitcroft $herecurr); 11010a920b5bSAndy Whitcroft } 11020a920b5bSAndy Whitcroft } 11030a920b5bSAndy Whitcroft 110400df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 11058905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1106de7d4f0eSAndy Whitcroft ERROR("patch seems to be corrupt (line wrapped?)\n" . 11076c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1108de7d4f0eSAndy Whitcroft } 1109de7d4f0eSAndy Whitcroft 1110de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1111de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1112171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1113171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1114171ae1a4SAndy Whitcroft 1115171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1116171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1117171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1118171ae1a4SAndy Whitcroft 1119171ae1a4SAndy Whitcroft ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 112000df344fSAndy Whitcroft } 11210a920b5bSAndy Whitcroft 112200df344fSAndy Whitcroft#ignore lines being removed 112300df344fSAndy Whitcroft if ($line=~/^-/) {next;} 112400df344fSAndy Whitcroft 112500df344fSAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 112600df344fSAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 11270a920b5bSAndy Whitcroft 11280a920b5bSAndy Whitcroft#trailing whitespace 11299c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1130c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 11319c0ca6f9SAndy Whitcroft ERROR("DOS line endings\n" . $herevet); 11329c0ca6f9SAndy Whitcroft 1133c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1134c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1135de7d4f0eSAndy Whitcroft ERROR("trailing whitespace\n" . $herevet); 11360a920b5bSAndy Whitcroft } 11370a920b5bSAndy Whitcroft#80 column limit 1138c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1139c45dcabdSAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && $length > 80) 1140c45dcabdSAndy Whitcroft { 1141de7d4f0eSAndy Whitcroft WARN("line over 80 characters\n" . $herecurr); 11420a920b5bSAndy Whitcroft } 11430a920b5bSAndy Whitcroft 11448905a67cSAndy Whitcroft# check for adding lines without a newline. 11458905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 11468905a67cSAndy Whitcroft WARN("adding a line without newline at end of file\n" . $herecurr); 11478905a67cSAndy Whitcroft } 11488905a67cSAndy Whitcroft 11490a920b5bSAndy Whitcroft# check we are in a valid source file *.[hc] if not then ignore this hunk 11500a920b5bSAndy Whitcroft next if ($realfile !~ /\.[hc]$/); 11510a920b5bSAndy Whitcroft 11520a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 11530a920b5bSAndy Whitcroft# more than 8 must use tabs. 1154c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1155c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1156c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1157171ae1a4SAndy Whitcroft ERROR("code indent should use tabs where possible\n" . $herevet); 11580a920b5bSAndy Whitcroft } 11590a920b5bSAndy Whitcroft 1160c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1161cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1162c2fdda0dSAndy Whitcroft WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1163c2fdda0dSAndy Whitcroft } 116422f2a2efSAndy Whitcroft 11659c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 1166171ae1a4SAndy Whitcroft my ($stat, $cond); 11679c9ba34eSAndy Whitcroft if ($realcnt && $line =~ /.\s*\S/) { 1168171ae1a4SAndy Whitcroft ($stat, $cond) = ctx_statement_block($linenr, 1169171ae1a4SAndy Whitcroft $realcnt, 0); 1170171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1171171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1172171ae1a4SAndy Whitcroft 1173171ae1a4SAndy Whitcroft my $s = $stat; 1174171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1175cf655043SAndy Whitcroft 1176c2fdda0dSAndy Whitcroft # Ignore goto labels. 1177171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1178c2fdda0dSAndy Whitcroft 1179c2fdda0dSAndy Whitcroft # Ignore functions being called 1180171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1181c2fdda0dSAndy Whitcroft 1182c45dcabdSAndy Whitcroft # declarations always start with types 1183c45dcabdSAndy Whitcroft } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) { 1184c45dcabdSAndy Whitcroft my $type = $1; 1185c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1186c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1187c45dcabdSAndy Whitcroft 11886c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1189171ae1a4SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) { 1190c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1191c2fdda0dSAndy Whitcroft } 11928905a67cSAndy Whitcroft 11936c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 1194171ae1a4SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) { 1195c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 11969c0ca6f9SAndy Whitcroft } 11978905a67cSAndy Whitcroft 11988905a67cSAndy Whitcroft # Check for any sort of function declaration. 11998905a67cSAndy Whitcroft # int foo(something bar, other baz); 12008905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1201171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 12028905a67cSAndy Whitcroft my ($name_len) = length($1); 12038905a67cSAndy Whitcroft 1204cf655043SAndy Whitcroft my $ctx = $s; 1205773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 12068905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1207cf655043SAndy Whitcroft 12088905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1209c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 12108905a67cSAndy Whitcroft 1211c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 12128905a67cSAndy Whitcroft } 12138905a67cSAndy Whitcroft } 12148905a67cSAndy Whitcroft } 12158905a67cSAndy Whitcroft 12169c0ca6f9SAndy Whitcroft } 12179c0ca6f9SAndy Whitcroft 121800df344fSAndy Whitcroft# 121900df344fSAndy Whitcroft# Checks which may be anchored in the context. 122000df344fSAndy Whitcroft# 122100df344fSAndy Whitcroft 122200df344fSAndy Whitcroft# Check for switch () and associated case and default 122300df344fSAndy Whitcroft# statements should be at the same indent. 122400df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 122500df344fSAndy Whitcroft my $err = ''; 122600df344fSAndy Whitcroft my $sep = ''; 122700df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 122800df344fSAndy Whitcroft shift(@ctx); 122900df344fSAndy Whitcroft for my $ctx (@ctx) { 123000df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 123100df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 123200df344fSAndy Whitcroft $indent != $cindent) { 123300df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 123400df344fSAndy Whitcroft $sep = ''; 123500df344fSAndy Whitcroft } else { 123600df344fSAndy Whitcroft $sep = "[...]\n"; 123700df344fSAndy Whitcroft } 123800df344fSAndy Whitcroft } 123900df344fSAndy Whitcroft if ($err ne '') { 12409c0ca6f9SAndy Whitcroft ERROR("switch and case should be at the same indent\n$hereline$err"); 1241de7d4f0eSAndy Whitcroft } 1242de7d4f0eSAndy Whitcroft } 1243de7d4f0eSAndy Whitcroft 1244de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1245de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1246c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1247773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1248773647a0SAndy Whitcroft 12499c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1250de7d4f0eSAndy Whitcroft my $ctx_ln = $linenr + $#ctx + 1; 1251de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1252de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1253de7d4f0eSAndy Whitcroft 1254773647a0SAndy Whitcroft ##warn "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 1255de7d4f0eSAndy Whitcroft 1256773647a0SAndy Whitcroft # Skip over any removed lines in the context following statement. 1257773647a0SAndy Whitcroft while (defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^-/) { 1258773647a0SAndy Whitcroft $ctx_ln++; 1259773647a0SAndy Whitcroft } 1260773647a0SAndy Whitcroft ##warn "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1261773647a0SAndy Whitcroft 1262773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1263773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . 1264c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 126500df344fSAndy Whitcroft } 1266773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1267773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1268773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1269773647a0SAndy Whitcroft { 12709c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 12719c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1272773647a0SAndy Whitcroft WARN("trailing semicolon indicates no statements, indent implies otherwise\n" . 1273c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 12749c0ca6f9SAndy Whitcroft } 12759c0ca6f9SAndy Whitcroft } 127600df344fSAndy Whitcroft } 127700df344fSAndy Whitcroft 12786c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 12796c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 12806c72ffaaSAndy Whitcroft my $curr_values = annotate_values($opline . "\n", $prev_values); 12816c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 1282c2fdda0dSAndy Whitcroft if ($dbg_values) { 1283c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 1284cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 1285cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 1286c2fdda0dSAndy Whitcroft } 12876c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 12886c72ffaaSAndy Whitcroft 128900df344fSAndy Whitcroft#ignore lines not being added 129000df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 129100df344fSAndy Whitcroft 1292653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 1293653d4876SAndy Whitcroft if ($tst_type && $line =~ /^.$Declare$/) { 1294de7d4f0eSAndy Whitcroft ERROR("TEST: is type $Declare\n" . $herecurr); 1295653d4876SAndy Whitcroft next; 1296653d4876SAndy Whitcroft } 1297653d4876SAndy Whitcroft 1298f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 1299f0a594c1SAndy Whitcroft if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ && 1300f0a594c1SAndy Whitcroft $line =~ /^.\s*{/) { 1301773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . $hereprev); 1302f0a594c1SAndy Whitcroft } 1303f0a594c1SAndy Whitcroft 130400df344fSAndy Whitcroft# 130500df344fSAndy Whitcroft# Checks which are anchored on the added line. 130600df344fSAndy Whitcroft# 130700df344fSAndy Whitcroft 1308653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 1309c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 1310653d4876SAndy Whitcroft my $path = $1; 1311653d4876SAndy Whitcroft if ($path =~ m{//}) { 1312de7d4f0eSAndy Whitcroft ERROR("malformed #include filename\n" . 1313de7d4f0eSAndy Whitcroft $herecurr); 1314653d4876SAndy Whitcroft } 1315653d4876SAndy Whitcroft } 1316653d4876SAndy Whitcroft 131700df344fSAndy Whitcroft# no C99 // comments 131800df344fSAndy Whitcroft if ($line =~ m{//}) { 1319de7d4f0eSAndy Whitcroft ERROR("do not use C99 // comments\n" . $herecurr); 132000df344fSAndy Whitcroft } 132100df344fSAndy Whitcroft # Remove C99 comments. 13220a920b5bSAndy Whitcroft $line =~ s@//.*@@; 13236c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 13240a920b5bSAndy Whitcroft 13250a920b5bSAndy Whitcroft#EXPORT_SYMBOL should immediately follow its function closing }. 1326653d4876SAndy Whitcroft if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) || 1327653d4876SAndy Whitcroft ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 1328653d4876SAndy Whitcroft my $name = $1; 13290a920b5bSAndy Whitcroft if (($prevline !~ /^}/) && 13300a920b5bSAndy Whitcroft ($prevline !~ /^\+}/) && 1331653d4876SAndy Whitcroft ($prevline !~ /^ }/) && 1332cf655043SAndy Whitcroft ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) && 1333cf655043SAndy Whitcroft ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) && 1334171ae1a4SAndy Whitcroft ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) && 1335cf655043SAndy Whitcroft ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) { 1336de7d4f0eSAndy Whitcroft WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 13370a920b5bSAndy Whitcroft } 13380a920b5bSAndy Whitcroft } 13390a920b5bSAndy Whitcroft 1340f0a594c1SAndy Whitcroft# check for external initialisers. 1341c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 1342f0a594c1SAndy Whitcroft ERROR("do not initialise externals to 0 or NULL\n" . 1343f0a594c1SAndy Whitcroft $herecurr); 1344f0a594c1SAndy Whitcroft } 13450a920b5bSAndy Whitcroft# check for static initialisers. 13469c9ba34eSAndy Whitcroft if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) { 1347de7d4f0eSAndy Whitcroft ERROR("do not initialise statics to 0 or NULL\n" . 1348de7d4f0eSAndy Whitcroft $herecurr); 13490a920b5bSAndy Whitcroft } 13500a920b5bSAndy Whitcroft 1351653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 1352653d4876SAndy Whitcroft# make sense. 1353653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 13549c0ca6f9SAndy Whitcroft $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ && 1355c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 1356653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 1357de7d4f0eSAndy Whitcroft WARN("do not add new typedefs\n" . $herecurr); 13580a920b5bSAndy Whitcroft } 13590a920b5bSAndy Whitcroft 13600a920b5bSAndy Whitcroft# * goes on variable not on type 1361d8aaf121SAndy Whitcroft if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) { 1362de7d4f0eSAndy Whitcroft ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" . 1363de7d4f0eSAndy Whitcroft $herecurr); 1364d8aaf121SAndy Whitcroft 1365d8aaf121SAndy Whitcroft } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) { 1366de7d4f0eSAndy Whitcroft ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" . 1367de7d4f0eSAndy Whitcroft $herecurr); 1368d8aaf121SAndy Whitcroft 13699c0ca6f9SAndy Whitcroft } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) { 1370de7d4f0eSAndy Whitcroft ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" . 1371de7d4f0eSAndy Whitcroft $herecurr); 1372d8aaf121SAndy Whitcroft 13739c0ca6f9SAndy Whitcroft } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) { 1374de7d4f0eSAndy Whitcroft ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" . 1375de7d4f0eSAndy Whitcroft $herecurr); 13760a920b5bSAndy Whitcroft } 13770a920b5bSAndy Whitcroft 13780a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 13790a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 13800a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 13810a920b5bSAndy Whitcroft# print "$herecurr"; 13820a920b5bSAndy Whitcroft# $clean = 0; 13830a920b5bSAndy Whitcroft# } 13840a920b5bSAndy Whitcroft 13858905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 1386c2fdda0dSAndy Whitcroft WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 13878905a67cSAndy Whitcroft } 13888905a67cSAndy Whitcroft 138900df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 139000df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 139100df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 139200df344fSAndy Whitcroft# printk includes all preceeding printk's which have no newline on the end. 139300df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 1394f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 139500df344fSAndy Whitcroft my $ok = 0; 139600df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 139700df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 139800df344fSAndy Whitcroft # we have a preceeding printk if it ends 139900df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 140000df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 140100df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 140200df344fSAndy Whitcroft $ok = 1; 140300df344fSAndy Whitcroft } 140400df344fSAndy Whitcroft last; 140500df344fSAndy Whitcroft } 140600df344fSAndy Whitcroft } 140700df344fSAndy Whitcroft if ($ok == 0) { 1408de7d4f0eSAndy Whitcroft WARN("printk() should include KERN_ facility level\n" . $herecurr); 14090a920b5bSAndy Whitcroft } 141000df344fSAndy Whitcroft } 14110a920b5bSAndy Whitcroft 1412653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 1413653d4876SAndy Whitcroft# or if closed on same line 1414c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 1415c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 1416de7d4f0eSAndy Whitcroft ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 14170a920b5bSAndy Whitcroft } 1418653d4876SAndy Whitcroft 14198905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 14208905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 14218905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 14228905a67cSAndy Whitcroft ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 14238905a67cSAndy Whitcroft } 14248905a67cSAndy Whitcroft 1425f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 14266c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 1427c2fdda0dSAndy Whitcroft my $name = $1; 1428773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 1429773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 1430c2fdda0dSAndy Whitcroft 1431c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 1432773647a0SAndy Whitcroft if ($name =~ /^(?: 1433773647a0SAndy Whitcroft if|for|while|switch|return|case| 1434773647a0SAndy Whitcroft volatile|__volatile__| 1435773647a0SAndy Whitcroft __attribute__|format|__extension__| 1436773647a0SAndy Whitcroft asm|__asm__)$/x) 1437773647a0SAndy Whitcroft { 1438c2fdda0dSAndy Whitcroft 1439c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 1440c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 1441c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 1442c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 1443773647a0SAndy Whitcroft 1444773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 1445c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 1446c2fdda0dSAndy Whitcroft 1447c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 1448c2fdda0dSAndy Whitcroft # likely a typedef for a function. 1449773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 1450c2fdda0dSAndy Whitcroft 1451c2fdda0dSAndy Whitcroft } else { 1452773647a0SAndy Whitcroft WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr); 1453f0a594c1SAndy Whitcroft } 14546c72ffaaSAndy Whitcroft } 1455653d4876SAndy Whitcroft# Check operator spacing. 14560a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 14579c0ca6f9SAndy Whitcroft my $ops = qr{ 14589c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 14599c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 14609c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 1461c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 14629c0ca6f9SAndy Whitcroft }x; 1463cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 146400df344fSAndy Whitcroft my $off = 0; 14656c72ffaaSAndy Whitcroft 14666c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 14676c72ffaaSAndy Whitcroft 14680a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 14694a0df2efSAndy Whitcroft $off += length($elements[$n]); 14704a0df2efSAndy Whitcroft 1471773647a0SAndy Whitcroft # Pick up the preceeding and succeeding characters. 1472773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 1473773647a0SAndy Whitcroft my $cc = ''; 1474773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 1475773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 1476773647a0SAndy Whitcroft } 1477773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 1478773647a0SAndy Whitcroft 14794a0df2efSAndy Whitcroft my $a = ''; 14804a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 14814a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 1482cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 14834a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 14844a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 1485773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 14864a0df2efSAndy Whitcroft 14870a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 14884a0df2efSAndy Whitcroft 14894a0df2efSAndy Whitcroft my $c = ''; 14900a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 14914a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 14924a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 1493cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 14944a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 14954a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 149622f2a2efSAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/); 14974a0df2efSAndy Whitcroft } else { 14984a0df2efSAndy Whitcroft $c = 'E'; 14990a920b5bSAndy Whitcroft } 15000a920b5bSAndy Whitcroft 15014a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 15024a0df2efSAndy Whitcroft 15034a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 15044a0df2efSAndy Whitcroft 15056c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 1506de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 15070a920b5bSAndy Whitcroft 15089c0ca6f9SAndy Whitcroft # Classify operators into binary, unary, or 15099c0ca6f9SAndy Whitcroft # definitions (* only) where they have more 15109c0ca6f9SAndy Whitcroft # than one mode. 15116c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 15126c72ffaaSAndy Whitcroft my $op_left = substr($curr_values, $off, 1); 15136c72ffaaSAndy Whitcroft my $is_unary; 15146c72ffaaSAndy Whitcroft if ($op_type eq 'T') { 15159c0ca6f9SAndy Whitcroft $is_unary = 2; 15166c72ffaaSAndy Whitcroft } elsif ($op_left eq 'V') { 15176c72ffaaSAndy Whitcroft $is_unary = 0; 15186c72ffaaSAndy Whitcroft } else { 15196c72ffaaSAndy Whitcroft $is_unary = 1; 15209c0ca6f9SAndy Whitcroft } 15219c0ca6f9SAndy Whitcroft #if ($op eq '-' || $op eq '&' || $op eq '*') { 15226c72ffaaSAndy Whitcroft # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n"; 15239c0ca6f9SAndy Whitcroft #} 15240a920b5bSAndy Whitcroft 152513214adfSAndy Whitcroft # Ignore operators passed as parameters. 152613214adfSAndy Whitcroft if ($op_type ne 'V' && 152713214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 152813214adfSAndy Whitcroft 1529cf655043SAndy Whitcroft# # Ignore comments 1530cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 153113214adfSAndy Whitcroft 1532d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 153313214adfSAndy Whitcroft } elsif ($op eq ';') { 1534cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 1535cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 1536773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 1537d8aaf121SAndy Whitcroft } 1538d8aaf121SAndy Whitcroft 1539d8aaf121SAndy Whitcroft # // is a comment 1540d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 15410a920b5bSAndy Whitcroft 15420a920b5bSAndy Whitcroft # -> should have no spaces 15430a920b5bSAndy Whitcroft } elsif ($op eq '->') { 15444a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 1545773647a0SAndy Whitcroft ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 15460a920b5bSAndy Whitcroft } 15470a920b5bSAndy Whitcroft 15480a920b5bSAndy Whitcroft # , must have a space on the right. 15490a920b5bSAndy Whitcroft } elsif ($op eq ',') { 1550cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 1551773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 15520a920b5bSAndy Whitcroft } 15530a920b5bSAndy Whitcroft 15549c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 15559c0ca6f9SAndy Whitcroft } elsif ($op eq '*' && $is_unary == 2) { 15569c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 15579c0ca6f9SAndy Whitcroft 15589c0ca6f9SAndy Whitcroft # unary operators should have a space before and 15599c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 15609c0ca6f9SAndy Whitcroft # unary operator, or a cast 15619c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 15629c0ca6f9SAndy Whitcroft ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) { 1563cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 1564773647a0SAndy Whitcroft ERROR("space required before that '$op' $at\n" . $hereptr); 15650a920b5bSAndy Whitcroft } 1566171ae1a4SAndy Whitcroft if ($op eq '*' && $cc =~/\s*const\b/) { 1567171ae1a4SAndy Whitcroft # A unary '*' may be const 1568171ae1a4SAndy Whitcroft 1569171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 1570773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 15710a920b5bSAndy Whitcroft } 15720a920b5bSAndy Whitcroft 15730a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 15740a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 1575773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 1576773647a0SAndy Whitcroft ERROR("space required one side of that '$op' $at\n" . $hereptr); 15770a920b5bSAndy Whitcroft } 1578773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 1579773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 1580773647a0SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 1581653d4876SAndy Whitcroft } 1582773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 1583773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 1584773647a0SAndy Whitcroft } 1585773647a0SAndy Whitcroft 15860a920b5bSAndy Whitcroft 15870a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 15889c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 15899c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 15909c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 1591c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 1592c2fdda0dSAndy Whitcroft $op eq '%') 15930a920b5bSAndy Whitcroft { 1594773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 1595de7d4f0eSAndy Whitcroft ERROR("need consistent spacing around '$op' $at\n" . 1596de7d4f0eSAndy Whitcroft $hereptr); 15970a920b5bSAndy Whitcroft } 15980a920b5bSAndy Whitcroft 15990a920b5bSAndy Whitcroft # All the others need spaces both sides. 1600cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 160122f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 160222f2a2efSAndy Whitcroft if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) && 160322f2a2efSAndy Whitcroft !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) { 1604773647a0SAndy Whitcroft ERROR("spaces required around that '$op' $at\n" . $hereptr); 16050a920b5bSAndy Whitcroft } 160622f2a2efSAndy Whitcroft } 16074a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 16080a920b5bSAndy Whitcroft } 16090a920b5bSAndy Whitcroft } 16100a920b5bSAndy Whitcroft 1611f0a594c1SAndy Whitcroft# check for multiple assignments 1612f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 16136c72ffaaSAndy Whitcroft CHK("multiple assignments should be avoided\n" . $herecurr); 1614f0a594c1SAndy Whitcroft } 1615f0a594c1SAndy Whitcroft 161622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 161722f2a2efSAndy Whitcroft## # continuation. 161822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 161922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 162022f2a2efSAndy Whitcroft## 162122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 162222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 162322f2a2efSAndy Whitcroft## my $ln = $line; 162422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 162522f2a2efSAndy Whitcroft## } 162622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 162722f2a2efSAndy Whitcroft## WARN("declaring multiple variables together should be avoided\n" . $herecurr); 162822f2a2efSAndy Whitcroft## } 162922f2a2efSAndy Whitcroft## } 1630f0a594c1SAndy Whitcroft 16310a920b5bSAndy Whitcroft#need space before brace following if, while, etc 163222f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 163322f2a2efSAndy Whitcroft $line =~ /do{/) { 1634773647a0SAndy Whitcroft ERROR("space required before the open brace '{'\n" . $herecurr); 1635de7d4f0eSAndy Whitcroft } 1636de7d4f0eSAndy Whitcroft 1637de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 1638de7d4f0eSAndy Whitcroft# on the line 1639de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 1640773647a0SAndy Whitcroft ERROR("space required after that close brace '}'\n" . $herecurr); 16410a920b5bSAndy Whitcroft } 16420a920b5bSAndy Whitcroft 164322f2a2efSAndy Whitcroft# check spacing on square brackets 164422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 1645773647a0SAndy Whitcroft ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 164622f2a2efSAndy Whitcroft } 164722f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 1648773647a0SAndy Whitcroft ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 164922f2a2efSAndy Whitcroft } 165022f2a2efSAndy Whitcroft 1651c45dcabdSAndy Whitcroft# check spacing on parentheses 16529c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 16539c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 1654773647a0SAndy Whitcroft ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 165522f2a2efSAndy Whitcroft } 165613214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 1657c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 1658c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 1659773647a0SAndy Whitcroft ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 166022f2a2efSAndy Whitcroft } 166122f2a2efSAndy Whitcroft 16620a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 16634a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 16640a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 1665de7d4f0eSAndy Whitcroft WARN("labels should not be indented\n" . $herecurr); 16660a920b5bSAndy Whitcroft } 16670a920b5bSAndy Whitcroft 1668c45dcabdSAndy Whitcroft# Return is not a function. 1669c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 1670c45dcabdSAndy Whitcroft my $spacing = $1; 1671c45dcabdSAndy Whitcroft my $value = $2; 1672c45dcabdSAndy Whitcroft 1673c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 1674fee61c47SAndy Whitcroft $value =~ s/\)\(/\) \(/g; 1675c45dcabdSAndy Whitcroft while ($value =~ s/\([^\(\)]*\)/1/) { 1676c45dcabdSAndy Whitcroft } 1677c45dcabdSAndy Whitcroft 1678c45dcabdSAndy Whitcroft if ($value =~ /^(?:$Ident|-?$Constant)$/) { 1679c45dcabdSAndy Whitcroft ERROR("return is not a function, parentheses are not required\n" . $herecurr); 1680c45dcabdSAndy Whitcroft 1681c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 1682c45dcabdSAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 1683c45dcabdSAndy Whitcroft } 1684c45dcabdSAndy Whitcroft } 1685c45dcabdSAndy Whitcroft 16860a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 16874a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 1688773647a0SAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 16890a920b5bSAndy Whitcroft } 16900a920b5bSAndy Whitcroft 16910a920b5bSAndy Whitcroft# Check for illegal assignment in if conditional. 16928905a67cSAndy Whitcroft if ($line =~ /\bif\s*\(/) { 1693171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 16948905a67cSAndy Whitcroft 16958905a67cSAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) { 1696c2fdda0dSAndy Whitcroft ERROR("do not use assignment in if condition\n" . $herecurr); 16978905a67cSAndy Whitcroft } 16988905a67cSAndy Whitcroft 16998905a67cSAndy Whitcroft # Find out what is on the end of the line after the 17008905a67cSAndy Whitcroft # conditional. 1701773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 17028905a67cSAndy Whitcroft $s =~ s/\n.*//g; 170313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 1704773647a0SAndy Whitcroft if (length($c) && $s !~ /^\s*({|;|)\s*\\*\s*$/ && 1705c45dcabdSAndy Whitcroft $c !~ /^.\s*\#\s*if/) 1706773647a0SAndy Whitcroft { 17078905a67cSAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 17088905a67cSAndy Whitcroft } 17098905a67cSAndy Whitcroft } 17108905a67cSAndy Whitcroft 171113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 171213214adfSAndy Whitcroft if ($line =~ / 171313214adfSAndy Whitcroft (?: 171413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 171513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 171613214adfSAndy Whitcroft (?:\&\&|\|\|) 171713214adfSAndy Whitcroft | 171813214adfSAndy Whitcroft (?:\&\&|\|\|) 171913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 172013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 172113214adfSAndy Whitcroft )/x) 172213214adfSAndy Whitcroft { 172313214adfSAndy Whitcroft WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 172413214adfSAndy Whitcroft } 172513214adfSAndy Whitcroft 17268905a67cSAndy Whitcroft# if and else should not have general statements after it 172713214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 172813214adfSAndy Whitcroft my $s = $1; 172913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 173013214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 17318905a67cSAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 17320a920b5bSAndy Whitcroft } 173313214adfSAndy Whitcroft } 17340a920b5bSAndy Whitcroft 17350a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 17360a920b5bSAndy Whitcroft # indent level to be relevant to each other. 17370a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 17380a920b5bSAndy Whitcroft $previndent == $indent) { 1739de7d4f0eSAndy Whitcroft ERROR("else should follow close brace '}'\n" . $hereprev); 17400a920b5bSAndy Whitcroft } 17410a920b5bSAndy Whitcroft 1742c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 1743c2fdda0dSAndy Whitcroft $previndent == $indent) { 1744c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 1745c2fdda0dSAndy Whitcroft 1746c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 1747c2fdda0dSAndy Whitcroft # conditional. 1748773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 1749c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 1750c2fdda0dSAndy Whitcroft 1751c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 1752c2fdda0dSAndy Whitcroft ERROR("while should follow close brace '}'\n" . $hereprev); 1753c2fdda0dSAndy Whitcroft } 1754c2fdda0dSAndy Whitcroft } 1755c2fdda0dSAndy Whitcroft 17560a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 17570a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 17580a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 17590a920b5bSAndy Whitcroft# print "$herecurr"; 17600a920b5bSAndy Whitcroft# $clean = 0; 17610a920b5bSAndy Whitcroft# } 17620a920b5bSAndy Whitcroft 17630a920b5bSAndy Whitcroft#no spaces allowed after \ in define 1764c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 1765de7d4f0eSAndy Whitcroft WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr); 17660a920b5bSAndy Whitcroft } 17670a920b5bSAndy Whitcroft 1768653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 1769c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 1770c45dcabdSAndy Whitcroft my $checkfile = "include/linux/$1.h"; 1771c45dcabdSAndy Whitcroft if (-f "$root/$checkfile" && $realfile ne $checkfile && 1772c45dcabdSAndy Whitcroft $1 ne 'irq') 1773c45dcabdSAndy Whitcroft { 1774773647a0SAndy Whitcroft WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" . 1775de7d4f0eSAndy Whitcroft $herecurr); 17760a920b5bSAndy Whitcroft } 17770a920b5bSAndy Whitcroft } 17780a920b5bSAndy Whitcroft 1779653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 1780653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 1781cf655043SAndy Whitcroft# in a known good container 1782c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 1783d8aaf121SAndy Whitcroft my $ln = $linenr; 1784d8aaf121SAndy Whitcroft my $cnt = $realcnt; 1785c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 1786c45dcabdSAndy Whitcroft my $ctx = ''; 1787653d4876SAndy Whitcroft 1788c45dcabdSAndy Whitcroft my $args = defined($1); 1789de7d4f0eSAndy Whitcroft 1790c45dcabdSAndy Whitcroft # Find the end of the macro and limit our statement 1791c45dcabdSAndy Whitcroft # search to that. 1792c45dcabdSAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1] && 1793c45dcabdSAndy Whitcroft $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 1794c45dcabdSAndy Whitcroft { 1795c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1] . "\n"; 1796c45dcabdSAndy Whitcroft $ln++; 1797c45dcabdSAndy Whitcroft $cnt--; 1798de7d4f0eSAndy Whitcroft } 1799c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1]; 1800d8aaf121SAndy Whitcroft 1801c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 1802c45dcabdSAndy Whitcroft ctx_statement_block($linenr, $ln - $linenr + 1, 0); 1803c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 1804c45dcabdSAndy Whitcroft #print "LINE<$lines[$ln]> len<" . length($lines[$ln]) . "\n"; 1805c45dcabdSAndy Whitcroft 1806c45dcabdSAndy Whitcroft # Extract the remainder of the define (if any) and 1807c45dcabdSAndy Whitcroft # rip off surrounding spaces, and trailing \'s. 1808c45dcabdSAndy Whitcroft $rest = ''; 1809c45dcabdSAndy Whitcroft if (defined $lines[$ln - 1] && 1810c45dcabdSAndy Whitcroft $off > length($lines[$ln - 1])) 1811c45dcabdSAndy Whitcroft { 1812c45dcabdSAndy Whitcroft $ln++; 1813c45dcabdSAndy Whitcroft $cnt--; 1814c45dcabdSAndy Whitcroft $off = 0; 1815c45dcabdSAndy Whitcroft } 1816c45dcabdSAndy Whitcroft while ($cnt > 0) { 1817c45dcabdSAndy Whitcroft $rest .= substr($lines[$ln - 1], $off) . "\n"; 1818c45dcabdSAndy Whitcroft $ln++; 1819c45dcabdSAndy Whitcroft $cnt--; 1820c45dcabdSAndy Whitcroft $off = 0; 1821c45dcabdSAndy Whitcroft } 1822c45dcabdSAndy Whitcroft $rest =~ s/\\\n.//g; 1823c45dcabdSAndy Whitcroft $rest =~ s/^\s*//s; 1824c45dcabdSAndy Whitcroft $rest =~ s/\s*$//s; 1825c45dcabdSAndy Whitcroft 1826c45dcabdSAndy Whitcroft # Clean up the original statement. 1827c45dcabdSAndy Whitcroft if ($args) { 1828c45dcabdSAndy Whitcroft substr($dstat, 0, length($dcond), ''); 1829d8aaf121SAndy Whitcroft } else { 1830c45dcabdSAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 1831c45dcabdSAndy Whitcroft } 1832c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 1833c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 1834c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 1835c45dcabdSAndy Whitcroft 1836c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 1837c45dcabdSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/) { 1838c45dcabdSAndy Whitcroft } 1839c45dcabdSAndy Whitcroft while ($dstat =~ s/\{[^\{\}]*\}/1/) { 1840c45dcabdSAndy Whitcroft } 1841c45dcabdSAndy Whitcroft 1842c45dcabdSAndy Whitcroft my $exceptions = qr{ 1843c45dcabdSAndy Whitcroft $Declare| 1844c45dcabdSAndy Whitcroft module_param_named| 1845c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 1846c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 1847c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 1848c45dcabdSAndy Whitcroft __typeof__\( 1849c45dcabdSAndy Whitcroft }x; 1850c45dcabdSAndy Whitcroft if ($rest ne '') { 1851c45dcabdSAndy Whitcroft if ($rest !~ /while\s*\(/ && 1852c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/) 1853c45dcabdSAndy Whitcroft { 1854c45dcabdSAndy Whitcroft ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 1855c45dcabdSAndy Whitcroft } 1856c45dcabdSAndy Whitcroft 1857c45dcabdSAndy Whitcroft } elsif ($ctx !~ /;/) { 1858c45dcabdSAndy Whitcroft if ($dstat ne '' && 1859c45dcabdSAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && 1860c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/ && 1861c45dcabdSAndy Whitcroft $dstat =~ /$Operators/) 1862c45dcabdSAndy Whitcroft { 1863de7d4f0eSAndy Whitcroft ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 1864d8aaf121SAndy Whitcroft } 18650a920b5bSAndy Whitcroft } 1866653d4876SAndy Whitcroft } 18670a920b5bSAndy Whitcroft 1868f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 186913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 187013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 1871cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 187213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 1873cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 1874cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 187513214adfSAndy Whitcroft my $allowed = 0; 187613214adfSAndy Whitcroft my $seen = 0; 1877773647a0SAndy Whitcroft my $herectx = $here . "\n"; 1878cf655043SAndy Whitcroft my $ln = $linenr - 1; 187913214adfSAndy Whitcroft for my $chunk (@chunks) { 188013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 188113214adfSAndy Whitcroft 1882773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 1883773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 1884773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 1885773647a0SAndy Whitcroft 1886773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 1887773647a0SAndy Whitcroft 1888773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 1889773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 1890773647a0SAndy Whitcroft 1891773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 1892cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 1893cf655043SAndy Whitcroft 1894773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 189513214adfSAndy Whitcroft 189613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 189713214adfSAndy Whitcroft 1898cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 1899cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 1900cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 190113214adfSAndy Whitcroft $allowed = 1; 190213214adfSAndy Whitcroft } 190313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 1904cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 190513214adfSAndy Whitcroft $allowed = 1; 190613214adfSAndy Whitcroft } 1907cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 1908cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 190913214adfSAndy Whitcroft $allowed = 1; 191013214adfSAndy Whitcroft } 191113214adfSAndy Whitcroft } 191213214adfSAndy Whitcroft if ($seen && !$allowed) { 1913cf655043SAndy Whitcroft WARN("braces {} are not necessary for any arm of this statement\n" . $herectx); 191413214adfSAndy Whitcroft } 191513214adfSAndy Whitcroft } 191613214adfSAndy Whitcroft } 1917773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 191813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 1919cf655043SAndy Whitcroft my $allowed = 0; 1920f0a594c1SAndy Whitcroft 1921cf655043SAndy Whitcroft # Check the pre-context. 1922cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 1923cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 1924cf655043SAndy Whitcroft $allowed = 1; 1925f0a594c1SAndy Whitcroft } 1926773647a0SAndy Whitcroft 1927773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 1928773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 1929773647a0SAndy Whitcroft 1930cf655043SAndy Whitcroft # Check the condition. 1931cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 1932773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 1933cf655043SAndy Whitcroft if (defined $cond) { 1934773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 1935cf655043SAndy Whitcroft } 1936cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 1937cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 1938cf655043SAndy Whitcroft $allowed = 1; 1939cf655043SAndy Whitcroft } 1940cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 1941cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 1942cf655043SAndy Whitcroft $allowed = 1; 1943cf655043SAndy Whitcroft } 1944cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 1945cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 1946cf655043SAndy Whitcroft $allowed = 1; 1947cf655043SAndy Whitcroft } 1948cf655043SAndy Whitcroft # Check the post-context. 1949cf655043SAndy Whitcroft if (defined $chunks[1]) { 1950cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 1951cf655043SAndy Whitcroft if (defined $cond) { 1952773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 1953cf655043SAndy Whitcroft } 1954cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 1955cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 1956cf655043SAndy Whitcroft $allowed = 1; 1957cf655043SAndy Whitcroft } 1958cf655043SAndy Whitcroft } 1959cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 1960cf655043SAndy Whitcroft my $herectx = $here . "\n";; 1961cf655043SAndy Whitcroft my $end = $linenr + statement_rawlines($block) - 1; 1962cf655043SAndy Whitcroft 1963cf655043SAndy Whitcroft for (my $ln = $linenr - 1; $ln < $end; $ln++) { 1964cf655043SAndy Whitcroft $herectx .= $rawlines[$ln] . "\n";; 1965cf655043SAndy Whitcroft } 1966cf655043SAndy Whitcroft 1967cf655043SAndy Whitcroft WARN("braces {} are not necessary for single statement blocks\n" . $herectx); 1968f0a594c1SAndy Whitcroft } 1969f0a594c1SAndy Whitcroft } 1970f0a594c1SAndy Whitcroft 1971653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 19724a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 1973c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 1974de7d4f0eSAndy Whitcroft ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 19750a920b5bSAndy Whitcroft } 19760a920b5bSAndy Whitcroft } 19770a920b5bSAndy Whitcroft 19784a0df2efSAndy Whitcroft# don't use deprecated functions 19794a0df2efSAndy Whitcroft for my $func (@dep_functions) { 198000df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 1981de7d4f0eSAndy Whitcroft ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 19824a0df2efSAndy Whitcroft } 19834a0df2efSAndy Whitcroft } 19844a0df2efSAndy Whitcroft 19854a0df2efSAndy Whitcroft# no volatiles please 19866c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 19876c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 1988de7d4f0eSAndy Whitcroft WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 19894a0df2efSAndy Whitcroft } 19904a0df2efSAndy Whitcroft 19919c0ca6f9SAndy Whitcroft# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated 19929c0ca6f9SAndy Whitcroft if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { 19939c0ca6f9SAndy Whitcroft ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr); 19949c0ca6f9SAndy Whitcroft } 19959c0ca6f9SAndy Whitcroft 199600df344fSAndy Whitcroft# warn about #if 0 1997c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 1998de7d4f0eSAndy Whitcroft CHK("if this code is redundant consider removing it\n" . 1999de7d4f0eSAndy Whitcroft $herecurr); 20004a0df2efSAndy Whitcroft } 20014a0df2efSAndy Whitcroft 2002f0a594c1SAndy Whitcroft# check for needless kfree() checks 2003f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 2004f0a594c1SAndy Whitcroft my $expr = $1; 2005f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 2006f0a594c1SAndy Whitcroft WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev); 2007f0a594c1SAndy Whitcroft } 2008f0a594c1SAndy Whitcroft } 2009f0a594c1SAndy Whitcroft 201000df344fSAndy Whitcroft# warn about #ifdefs in C files 2011c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 201200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 201300df344fSAndy Whitcroft# print "$herecurr"; 201400df344fSAndy Whitcroft# $clean = 0; 201500df344fSAndy Whitcroft# } 201600df344fSAndy Whitcroft 201722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 2018c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 201922f2a2efSAndy Whitcroft ERROR("exactly one space required after that #$1\n" . $herecurr); 202022f2a2efSAndy Whitcroft } 202122f2a2efSAndy Whitcroft 20224a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 2023171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 2024171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 20254a0df2efSAndy Whitcroft my $which = $1; 20264a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2027de7d4f0eSAndy Whitcroft CHK("$1 definition without comment\n" . $herecurr); 20284a0df2efSAndy Whitcroft } 20294a0df2efSAndy Whitcroft } 20304a0df2efSAndy Whitcroft# check for memory barriers without a comment. 20314a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 20324a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2033de7d4f0eSAndy Whitcroft CHK("memory barrier without comment\n" . $herecurr); 20344a0df2efSAndy Whitcroft } 20354a0df2efSAndy Whitcroft } 20364a0df2efSAndy Whitcroft# check of hardware specific defines 2037c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 2038de7d4f0eSAndy Whitcroft CHK("architecture specific defines should be avoided\n" . $herecurr); 20390a920b5bSAndy Whitcroft } 2040653d4876SAndy Whitcroft 2041de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 2042de7d4f0eSAndy Whitcroft# storage class and type. 20439c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 20449c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 2045de7d4f0eSAndy Whitcroft ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 2046de7d4f0eSAndy Whitcroft } 2047de7d4f0eSAndy Whitcroft 20488905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 20498905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 20508905a67cSAndy Whitcroft WARN("plain inline is preferred over $1\n" . $herecurr); 20518905a67cSAndy Whitcroft } 20528905a67cSAndy Whitcroft 2053de7d4f0eSAndy Whitcroft# check for new externs in .c files. 2054171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 2055c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 2056171ae1a4SAndy Whitcroft { 2057c45dcabdSAndy Whitcroft my $function_name = $1; 2058c45dcabdSAndy Whitcroft my $paren_space = $2; 2059171ae1a4SAndy Whitcroft 2060171ae1a4SAndy Whitcroft my $s = $stat; 2061171ae1a4SAndy Whitcroft if (defined $cond) { 2062171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 2063171ae1a4SAndy Whitcroft } 2064c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 2065c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 2066c45dcabdSAndy Whitcroft { 2067de7d4f0eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2068de7d4f0eSAndy Whitcroft } 2069de7d4f0eSAndy Whitcroft 2070171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 2071171ae1a4SAndy Whitcroft WARN("arguments for function declarations should follow identifier\n" . $herecurr); 2072171ae1a4SAndy Whitcroft } 20739c9ba34eSAndy Whitcroft 20749c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 20759c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 20769c9ba34eSAndy Whitcroft { 20779c9ba34eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2078171ae1a4SAndy Whitcroft } 2079171ae1a4SAndy Whitcroft 2080de7d4f0eSAndy Whitcroft# checks for new __setup's 2081de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 2082de7d4f0eSAndy Whitcroft my $name = $1; 2083de7d4f0eSAndy Whitcroft 2084de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 2085de7d4f0eSAndy Whitcroft CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 2086de7d4f0eSAndy Whitcroft } 2087653d4876SAndy Whitcroft } 20889c0ca6f9SAndy Whitcroft 20899c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 20909c0ca6f9SAndy Whitcroft if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { 20919c0ca6f9SAndy Whitcroft WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 20929c0ca6f9SAndy Whitcroft } 209313214adfSAndy Whitcroft 209413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 209513214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 209613214adfSAndy Whitcroft WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 209713214adfSAndy Whitcroft } 2098773647a0SAndy Whitcroft 2099773647a0SAndy Whitcroft# check for semaphores used as mutexes 2100171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) { 2101773647a0SAndy Whitcroft WARN("mutexes are preferred for single holder semaphores\n" . $herecurr); 2102773647a0SAndy Whitcroft } 2103773647a0SAndy Whitcroft# check for semaphores used as mutexes 2104171ae1a4SAndy Whitcroft if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) { 2105773647a0SAndy Whitcroft WARN("consider using a completion\n" . $herecurr); 2106773647a0SAndy Whitcroft } 2107773647a0SAndy Whitcroft# recommend strict_strto* over simple_strto* 2108773647a0SAndy Whitcroft if ($line =~ /\bsimple_(strto.*?)\s*\(/) { 2109773647a0SAndy Whitcroft WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr); 2110773647a0SAndy Whitcroft } 2111773647a0SAndy Whitcroft 2112773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 2113773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 2114773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 2115c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 2116c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 2117171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 2118171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 2119171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 2120773647a0SAndy Whitcroft { 2121773647a0SAndy Whitcroft WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 2122773647a0SAndy Whitcroft } 21239c9ba34eSAndy Whitcroft 21249c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 21259c9ba34eSAndy Whitcroft my $string; 21269c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 21279c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 21289c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 21299c9ba34eSAndy Whitcroft WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 21309c9ba34eSAndy Whitcroft last; 21319c9ba34eSAndy Whitcroft } 21329c9ba34eSAndy Whitcroft } 213313214adfSAndy Whitcroft } 213413214adfSAndy Whitcroft 213513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 213613214adfSAndy Whitcroft # so just keep quiet. 213713214adfSAndy Whitcroft if ($#rawlines == -1) { 213813214adfSAndy Whitcroft exit(0); 21390a920b5bSAndy Whitcroft } 21400a920b5bSAndy Whitcroft 21418905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 21428905a67cSAndy Whitcroft # things that appear to be patches. 21438905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 21448905a67cSAndy Whitcroft exit(0); 21458905a67cSAndy Whitcroft } 21468905a67cSAndy Whitcroft 21478905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 21488905a67cSAndy Whitcroft # just keep quiet. 21498905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 21508905a67cSAndy Whitcroft exit(0); 21518905a67cSAndy Whitcroft } 21528905a67cSAndy Whitcroft 21538905a67cSAndy Whitcroft if (!$is_patch) { 2154de7d4f0eSAndy Whitcroft ERROR("Does not appear to be a unified-diff format patch\n"); 21550a920b5bSAndy Whitcroft } 21560a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 2157de7d4f0eSAndy Whitcroft ERROR("Missing Signed-off-by: line(s)\n"); 21580a920b5bSAndy Whitcroft } 21590a920b5bSAndy Whitcroft 2160f0a594c1SAndy Whitcroft print report_dump(); 216113214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 216213214adfSAndy Whitcroft print "$filename " if ($summary_file); 21636c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 21646c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 21656c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 21668905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 21676c72ffaaSAndy Whitcroft } 21688905a67cSAndy Whitcroft 21690a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 2170c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 21710a920b5bSAndy Whitcroft } 21720a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 2173c2fdda0dSAndy Whitcroft print "$vname has style problems, please review. If any of these errors\n"; 21740a920b5bSAndy Whitcroft print "are false positives report them to the maintainer, see\n"; 21750a920b5bSAndy Whitcroft print "CHECKPATCH in MAINTAINERS.\n"; 21760a920b5bSAndy Whitcroft } 217713214adfSAndy Whitcroft 21780a920b5bSAndy Whitcroft return $clean; 21790a920b5bSAndy Whitcroft} 2180