10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2f4432c5cSDave Jones# (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 12*50a7dcfbSAndy Whitcroftmy $V = '0.25'; 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; 20773647a0SAndy Whitcroftmy $tst_only; 216c72ffaaSAndy Whitcroftmy $emacs = 0; 228905a67cSAndy Whitcroftmy $terse = 0; 236c72ffaaSAndy Whitcroftmy $file = 0; 246c72ffaaSAndy Whitcroftmy $check = 0; 258905a67cSAndy Whitcroftmy $summary = 1; 268905a67cSAndy Whitcroftmy $mailback = 0; 2713214adfSAndy Whitcroftmy $summary_file = 0; 286c72ffaaSAndy Whitcroftmy $root; 29c2fdda0dSAndy Whitcroftmy %debug; 300a920b5bSAndy WhitcroftGetOptions( 316c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 320a920b5bSAndy Whitcroft 'tree!' => \$tree, 330a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 340a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 356c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 368905a67cSAndy Whitcroft 'terse!' => \$terse, 376c72ffaaSAndy Whitcroft 'file!' => \$file, 386c72ffaaSAndy Whitcroft 'subjective!' => \$check, 396c72ffaaSAndy Whitcroft 'strict!' => \$check, 406c72ffaaSAndy Whitcroft 'root=s' => \$root, 418905a67cSAndy Whitcroft 'summary!' => \$summary, 428905a67cSAndy Whitcroft 'mailback!' => \$mailback, 4313214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 4413214adfSAndy Whitcroft 45c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 46773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 470a920b5bSAndy Whitcroft) or exit; 480a920b5bSAndy Whitcroft 490a920b5bSAndy Whitcroftmy $exit = 0; 500a920b5bSAndy Whitcroft 510a920b5bSAndy Whitcroftif ($#ARGV < 0) { 5200df344fSAndy Whitcroft print "usage: $P [options] patchfile\n"; 530a920b5bSAndy Whitcroft print "version: $V\n"; 540a920b5bSAndy Whitcroft print "options: -q => quiet\n"; 550a920b5bSAndy Whitcroft print " --no-tree => run without a kernel tree\n"; 568905a67cSAndy Whitcroft print " --terse => one line per report\n"; 576c72ffaaSAndy Whitcroft print " --emacs => emacs compile window format\n"; 586c72ffaaSAndy Whitcroft print " --file => check a source file\n"; 596c72ffaaSAndy Whitcroft print " --strict => enable more subjective tests\n"; 606c72ffaaSAndy Whitcroft print " --root => path to the kernel tree root\n"; 6113214adfSAndy Whitcroft print " --no-summary => suppress the per-file summary\n"; 6213214adfSAndy Whitcroft print " --summary-file => include the filename in summary\n"; 630a920b5bSAndy Whitcroft exit(1); 640a920b5bSAndy Whitcroft} 650a920b5bSAndy Whitcroft 66c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 67c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 687429c690SAndy Whitcroftmy $dbg_type = 0; 69a1ef277eSAndy Whitcroftmy $dbg_attr = 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| 11624e1d81aSAndy Whitcroft __(?:mem|cpu|dev|)(?:initdata|init)| 11724e1d81aSAndy Whitcroft ____cacheline_aligned| 11824e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 1195fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 1205fe3af11SAndy Whitcroft __weak 1216c72ffaaSAndy Whitcroft }x; 122c45dcabdSAndy Whitcroftour $Modifier; 1236c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 1246c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 1256c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 1266c72ffaaSAndy Whitcroft 1276c72ffaaSAndy Whitcroftour $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 1286c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 1296c72ffaaSAndy Whitcroftour $Operators = qr{ 1306c72ffaaSAndy Whitcroft <=|>=|==|!=| 1316c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 132c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 1336c72ffaaSAndy Whitcroft }x; 1346c72ffaaSAndy Whitcroft 1358905a67cSAndy Whitcroftour $NonptrType; 1368905a67cSAndy Whitcroftour $Type; 1378905a67cSAndy Whitcroftour $Declare; 1388905a67cSAndy Whitcroft 139171ae1a4SAndy Whitcroftour $UTF8 = qr { 140171ae1a4SAndy Whitcroft [\x09\x0A\x0D\x20-\x7E] # ASCII 141171ae1a4SAndy Whitcroft | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 142171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 143171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 144171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 145171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 146171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 147171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 148171ae1a4SAndy Whitcroft}x; 149171ae1a4SAndy Whitcroft 1508ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 1518ed22cadSAndy Whitcroft (?:__)?(?:u|s|be|le)(?:\d|\d\d)| 1528ed22cadSAndy Whitcroft atomic_t 1538ed22cadSAndy Whitcroft)}; 1548ed22cadSAndy Whitcroft 1558905a67cSAndy Whitcroftour @typeList = ( 1568905a67cSAndy Whitcroft qr{void}, 157c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 158c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 159c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 160c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 161c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 162c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 163c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 1648905a67cSAndy Whitcroft qr{unsigned}, 1658905a67cSAndy Whitcroft qr{float}, 1668905a67cSAndy Whitcroft qr{double}, 1678905a67cSAndy Whitcroft qr{bool}, 1688905a67cSAndy Whitcroft qr{struct\s+$Ident}, 1698905a67cSAndy Whitcroft qr{union\s+$Ident}, 1708905a67cSAndy Whitcroft qr{enum\s+$Ident}, 1718905a67cSAndy Whitcroft qr{${Ident}_t}, 1728905a67cSAndy Whitcroft qr{${Ident}_handler}, 1738905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 1748905a67cSAndy Whitcroft); 175c45dcabdSAndy Whitcroftour @modifierList = ( 176c45dcabdSAndy Whitcroft qr{fastcall}, 177c45dcabdSAndy Whitcroft); 1788905a67cSAndy Whitcroft 1798905a67cSAndy Whitcroftsub build_types { 180d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 181d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 182c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1838905a67cSAndy Whitcroft $NonptrType = qr{ 184d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 185cf655043SAndy Whitcroft (?: 186c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 1878ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 188c45dcabdSAndy Whitcroft (?:${all}\b) 189cf655043SAndy Whitcroft ) 190c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 1918905a67cSAndy Whitcroft }x; 1928905a67cSAndy Whitcroft $Type = qr{ 193c45dcabdSAndy Whitcroft $NonptrType 19465863862SAndy Whitcroft (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 195c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 1968905a67cSAndy Whitcroft }x; 1978905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 1988905a67cSAndy Whitcroft} 1998905a67cSAndy Whitcroftbuild_types(); 2006c72ffaaSAndy Whitcroft 2016c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 2020a920b5bSAndy Whitcroft 2034a0df2efSAndy Whitcroftmy @dep_includes = (); 2044a0df2efSAndy Whitcroftmy @dep_functions = (); 2056c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 2066c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 2076c72ffaaSAndy Whitcroft open(REMOVE, "<$root/$removal") || 2086c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 2090a920b5bSAndy Whitcroft while (<REMOVE>) { 210f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 211f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 212f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 2134a0df2efSAndy Whitcroft push(@dep_includes, $1); 2144a0df2efSAndy Whitcroft 215f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 216f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 217f0a594c1SAndy Whitcroft } 2184a0df2efSAndy Whitcroft } 2190a920b5bSAndy Whitcroft } 2200a920b5bSAndy Whitcroft } 2210a920b5bSAndy Whitcroft} 2220a920b5bSAndy Whitcroft 22300df344fSAndy Whitcroftmy @rawlines = (); 224c2fdda0dSAndy Whitcroftmy @lines = (); 225c2fdda0dSAndy Whitcroftmy $vname; 2266c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 2276c72ffaaSAndy Whitcroft if ($file) { 2286c72ffaaSAndy Whitcroft open(FILE, "diff -u /dev/null $filename|") || 2296c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 2306c72ffaaSAndy Whitcroft } else { 2316c72ffaaSAndy Whitcroft open(FILE, "<$filename") || 2326c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 2336c72ffaaSAndy Whitcroft } 234c2fdda0dSAndy Whitcroft if ($filename eq '-') { 235c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 236c2fdda0dSAndy Whitcroft } else { 237c2fdda0dSAndy Whitcroft $vname = $filename; 238c2fdda0dSAndy Whitcroft } 2396c72ffaaSAndy Whitcroft while (<FILE>) { 2400a920b5bSAndy Whitcroft chomp; 24100df344fSAndy Whitcroft push(@rawlines, $_); 2426c72ffaaSAndy Whitcroft } 2436c72ffaaSAndy Whitcroft close(FILE); 244c2fdda0dSAndy Whitcroft if (!process($filename)) { 2450a920b5bSAndy Whitcroft $exit = 1; 2460a920b5bSAndy Whitcroft } 24700df344fSAndy Whitcroft @rawlines = (); 24813214adfSAndy Whitcroft @lines = (); 2490a920b5bSAndy Whitcroft} 2500a920b5bSAndy Whitcroft 2510a920b5bSAndy Whitcroftexit($exit); 2520a920b5bSAndy Whitcroft 2530a920b5bSAndy Whitcroftsub top_of_kernel_tree { 2546c72ffaaSAndy Whitcroft my ($root) = @_; 2556c72ffaaSAndy Whitcroft 2566c72ffaaSAndy Whitcroft my @tree_check = ( 2576c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 2586c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 2596c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 2606c72ffaaSAndy Whitcroft ); 2616c72ffaaSAndy Whitcroft 2626c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 2636c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 2640a920b5bSAndy Whitcroft return 0; 2650a920b5bSAndy Whitcroft } 2666c72ffaaSAndy Whitcroft } 2676c72ffaaSAndy Whitcroft return 1; 2686c72ffaaSAndy Whitcroft} 2690a920b5bSAndy Whitcroft 2700a920b5bSAndy Whitcroftsub expand_tabs { 2710a920b5bSAndy Whitcroft my ($str) = @_; 2720a920b5bSAndy Whitcroft 2730a920b5bSAndy Whitcroft my $res = ''; 2740a920b5bSAndy Whitcroft my $n = 0; 2750a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 2760a920b5bSAndy Whitcroft if ($c eq "\t") { 2770a920b5bSAndy Whitcroft $res .= ' '; 2780a920b5bSAndy Whitcroft $n++; 2790a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 2800a920b5bSAndy Whitcroft $res .= ' '; 2810a920b5bSAndy Whitcroft } 2820a920b5bSAndy Whitcroft next; 2830a920b5bSAndy Whitcroft } 2840a920b5bSAndy Whitcroft $res .= $c; 2850a920b5bSAndy Whitcroft $n++; 2860a920b5bSAndy Whitcroft } 2870a920b5bSAndy Whitcroft 2880a920b5bSAndy Whitcroft return $res; 2890a920b5bSAndy Whitcroft} 2906c72ffaaSAndy Whitcroftsub copy_spacing { 291773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 2926c72ffaaSAndy Whitcroft return $res; 2936c72ffaaSAndy Whitcroft} 2940a920b5bSAndy Whitcroft 2954a0df2efSAndy Whitcroftsub line_stats { 2964a0df2efSAndy Whitcroft my ($line) = @_; 2974a0df2efSAndy Whitcroft 2984a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 2994a0df2efSAndy Whitcroft $line =~ s/^.//; 3004a0df2efSAndy Whitcroft $line = expand_tabs($line); 3014a0df2efSAndy Whitcroft 3024a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 3034a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 3044a0df2efSAndy Whitcroft 3054a0df2efSAndy Whitcroft return (length($line), length($white)); 3064a0df2efSAndy Whitcroft} 3074a0df2efSAndy Whitcroft 308773647a0SAndy Whitcroftmy $sanitise_quote = ''; 309773647a0SAndy Whitcroft 310773647a0SAndy Whitcroftsub sanitise_line_reset { 311773647a0SAndy Whitcroft my ($in_comment) = @_; 312773647a0SAndy Whitcroft 313773647a0SAndy Whitcroft if ($in_comment) { 314773647a0SAndy Whitcroft $sanitise_quote = '*/'; 315773647a0SAndy Whitcroft } else { 316773647a0SAndy Whitcroft $sanitise_quote = ''; 317773647a0SAndy Whitcroft } 318773647a0SAndy Whitcroft} 31900df344fSAndy Whitcroftsub sanitise_line { 32000df344fSAndy Whitcroft my ($line) = @_; 32100df344fSAndy Whitcroft 32200df344fSAndy Whitcroft my $res = ''; 32300df344fSAndy Whitcroft my $l = ''; 32400df344fSAndy Whitcroft 325c2fdda0dSAndy Whitcroft my $qlen = 0; 326773647a0SAndy Whitcroft my $off = 0; 327773647a0SAndy Whitcroft my $c; 32800df344fSAndy Whitcroft 329773647a0SAndy Whitcroft # Always copy over the diff marker. 330773647a0SAndy Whitcroft $res = substr($line, 0, 1); 331773647a0SAndy Whitcroft 332773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 333773647a0SAndy Whitcroft $c = substr($line, $off, 1); 334773647a0SAndy Whitcroft 335773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 336773647a0SAndy Whitcroft # and end, all to $;. 337773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 338773647a0SAndy Whitcroft $sanitise_quote = '*/'; 339773647a0SAndy Whitcroft 340773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 341773647a0SAndy Whitcroft $off++; 34200df344fSAndy Whitcroft next; 343773647a0SAndy Whitcroft } 34481bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 345773647a0SAndy Whitcroft $sanitise_quote = ''; 346773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 347773647a0SAndy Whitcroft $off++; 348773647a0SAndy Whitcroft next; 349773647a0SAndy Whitcroft } 350773647a0SAndy Whitcroft 351773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 352773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 353773647a0SAndy Whitcroft $c eq "\\") { 354773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 355773647a0SAndy Whitcroft $off++; 356773647a0SAndy Whitcroft next; 357773647a0SAndy Whitcroft } 358773647a0SAndy Whitcroft # Regular quotes. 359773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 360773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 361773647a0SAndy Whitcroft $sanitise_quote = $c; 362773647a0SAndy Whitcroft 363773647a0SAndy Whitcroft substr($res, $off, 1, $c); 364773647a0SAndy Whitcroft next; 365773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 366773647a0SAndy Whitcroft $sanitise_quote = ''; 36700df344fSAndy Whitcroft } 36800df344fSAndy Whitcroft } 369773647a0SAndy Whitcroft 370fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 371773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 372773647a0SAndy Whitcroft substr($res, $off, 1, $;); 373773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 374773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 37500df344fSAndy Whitcroft } else { 376773647a0SAndy Whitcroft substr($res, $off, 1, $c); 37700df344fSAndy Whitcroft } 378c2fdda0dSAndy Whitcroft } 379c2fdda0dSAndy Whitcroft 380c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 381c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 382c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 383c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 384c2fdda0dSAndy Whitcroft 385c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 386c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 387c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 388c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 389c2fdda0dSAndy Whitcroft } 390c2fdda0dSAndy Whitcroft 39100df344fSAndy Whitcroft return $res; 39200df344fSAndy Whitcroft} 39300df344fSAndy Whitcroft 3948905a67cSAndy Whitcroftsub ctx_statement_block { 3958905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 3968905a67cSAndy Whitcroft my $line = $linenr - 1; 3978905a67cSAndy Whitcroft my $blk = ''; 3988905a67cSAndy Whitcroft my $soff = $off; 3998905a67cSAndy Whitcroft my $coff = $off - 1; 400773647a0SAndy Whitcroft my $coff_set = 0; 4018905a67cSAndy Whitcroft 40213214adfSAndy Whitcroft my $loff = 0; 40313214adfSAndy Whitcroft 4048905a67cSAndy Whitcroft my $type = ''; 4058905a67cSAndy Whitcroft my $level = 0; 406cf655043SAndy Whitcroft my $p; 4078905a67cSAndy Whitcroft my $c; 4088905a67cSAndy Whitcroft my $len = 0; 40913214adfSAndy Whitcroft 41013214adfSAndy Whitcroft my $remainder; 4118905a67cSAndy Whitcroft while (1) { 412773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 4138905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 4148905a67cSAndy Whitcroft # context. 4158905a67cSAndy Whitcroft if ($off >= $len) { 4168905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 417dea33496SAndy Whitcroft last if (!defined $lines[$line]); 418c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 4198905a67cSAndy Whitcroft $remain--; 42013214adfSAndy Whitcroft $loff = $len; 421c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 4228905a67cSAndy Whitcroft $len = length($blk); 4238905a67cSAndy Whitcroft $line++; 4248905a67cSAndy Whitcroft last; 4258905a67cSAndy Whitcroft } 4268905a67cSAndy Whitcroft # Bail if there is no further context. 4278905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 42813214adfSAndy Whitcroft if ($off >= $len) { 4298905a67cSAndy Whitcroft last; 4308905a67cSAndy Whitcroft } 4318905a67cSAndy Whitcroft } 432cf655043SAndy Whitcroft $p = $c; 4338905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 43413214adfSAndy Whitcroft $remainder = substr($blk, $off); 4358905a67cSAndy Whitcroft 436773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 4378905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 4388905a67cSAndy Whitcroft # outermost level. 4398905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 4408905a67cSAndy Whitcroft last; 4418905a67cSAndy Whitcroft } 4428905a67cSAndy Whitcroft 44313214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 444773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 445773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 446773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 447773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 448773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 449773647a0SAndy Whitcroft $coff_set = 1; 450773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 451773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 45213214adfSAndy Whitcroft } 45313214adfSAndy Whitcroft 4548905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 4558905a67cSAndy Whitcroft $level++; 4568905a67cSAndy Whitcroft $type = '('; 4578905a67cSAndy Whitcroft } 4588905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 4598905a67cSAndy Whitcroft $level--; 4608905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 4618905a67cSAndy Whitcroft 4628905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 4638905a67cSAndy Whitcroft $coff = $off; 464773647a0SAndy Whitcroft $coff_set = 1; 465773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 4668905a67cSAndy Whitcroft } 4678905a67cSAndy Whitcroft } 4688905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 4698905a67cSAndy Whitcroft $level++; 4708905a67cSAndy Whitcroft $type = '{'; 4718905a67cSAndy Whitcroft } 4728905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 4738905a67cSAndy Whitcroft $level--; 4748905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 4758905a67cSAndy Whitcroft 4768905a67cSAndy Whitcroft if ($level == 0) { 4778905a67cSAndy Whitcroft last; 4788905a67cSAndy Whitcroft } 4798905a67cSAndy Whitcroft } 4808905a67cSAndy Whitcroft $off++; 4818905a67cSAndy Whitcroft } 482a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 48313214adfSAndy Whitcroft if ($off == $len) { 484a3bb97a7SAndy Whitcroft $loff = $len + 1; 48513214adfSAndy Whitcroft $line++; 48613214adfSAndy Whitcroft $remain--; 48713214adfSAndy Whitcroft } 4888905a67cSAndy Whitcroft 4898905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 4908905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 4918905a67cSAndy Whitcroft 4928905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 4938905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 4948905a67cSAndy Whitcroft 495773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 49613214adfSAndy Whitcroft 49713214adfSAndy Whitcroft return ($statement, $condition, 49813214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 49913214adfSAndy Whitcroft} 50013214adfSAndy Whitcroft 501cf655043SAndy Whitcroftsub statement_lines { 502cf655043SAndy Whitcroft my ($stmt) = @_; 503cf655043SAndy Whitcroft 504cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 505cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 506cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 507cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 508cf655043SAndy Whitcroft 509cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 510cf655043SAndy Whitcroft 511cf655043SAndy Whitcroft return $#stmt_lines + 2; 512cf655043SAndy Whitcroft} 513cf655043SAndy Whitcroft 514cf655043SAndy Whitcroftsub statement_rawlines { 515cf655043SAndy Whitcroft my ($stmt) = @_; 516cf655043SAndy Whitcroft 517cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 518cf655043SAndy Whitcroft 519cf655043SAndy Whitcroft return $#stmt_lines + 2; 520cf655043SAndy Whitcroft} 521cf655043SAndy Whitcroft 522cf655043SAndy Whitcroftsub statement_block_size { 523cf655043SAndy Whitcroft my ($stmt) = @_; 524cf655043SAndy Whitcroft 525cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 526cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 527cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 528cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 529cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 530cf655043SAndy Whitcroft 531cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 532cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 533cf655043SAndy Whitcroft 534cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 535cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 536cf655043SAndy Whitcroft 537cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 538cf655043SAndy Whitcroft return $stmt_lines; 539cf655043SAndy Whitcroft } else { 540cf655043SAndy Whitcroft return $stmt_statements; 541cf655043SAndy Whitcroft } 542cf655043SAndy Whitcroft} 543cf655043SAndy Whitcroft 54413214adfSAndy Whitcroftsub ctx_statement_full { 54513214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 54613214adfSAndy Whitcroft my ($statement, $condition, $level); 54713214adfSAndy Whitcroft 54813214adfSAndy Whitcroft my (@chunks); 54913214adfSAndy Whitcroft 550cf655043SAndy Whitcroft # Grab the first conditional/block pair. 55113214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 55213214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 553773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 55413214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 555cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 556cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 557cf655043SAndy Whitcroft } 558cf655043SAndy Whitcroft 559cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 560cf655043SAndy Whitcroft # could continue the statement. 561cf655043SAndy Whitcroft for (;;) { 56213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 56313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 564cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 565773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 566cf655043SAndy Whitcroft #print "C: push\n"; 567cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 56813214adfSAndy Whitcroft } 56913214adfSAndy Whitcroft 57013214adfSAndy Whitcroft return ($level, $linenr, @chunks); 5718905a67cSAndy Whitcroft} 5728905a67cSAndy Whitcroft 5734a0df2efSAndy Whitcroftsub ctx_block_get { 574f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 5754a0df2efSAndy Whitcroft my $line; 5764a0df2efSAndy Whitcroft my $start = $linenr - 1; 5774a0df2efSAndy Whitcroft my $blk = ''; 5784a0df2efSAndy Whitcroft my @o; 5794a0df2efSAndy Whitcroft my @c; 5804a0df2efSAndy Whitcroft my @res = (); 5814a0df2efSAndy Whitcroft 582f0a594c1SAndy Whitcroft my $level = 0; 58300df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 58400df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 58500df344fSAndy Whitcroft $remain--; 58600df344fSAndy Whitcroft 58700df344fSAndy Whitcroft $blk .= $rawlines[$line]; 588f0a594c1SAndy Whitcroft foreach my $c (split(//, $rawlines[$line])) { 589f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 590f0a594c1SAndy Whitcroft if ($off > 0) { 591f0a594c1SAndy Whitcroft $off--; 592f0a594c1SAndy Whitcroft next; 593f0a594c1SAndy Whitcroft } 5944a0df2efSAndy Whitcroft 595f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 596f0a594c1SAndy Whitcroft $level--; 597f0a594c1SAndy Whitcroft last if ($level == 0); 598f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 599f0a594c1SAndy Whitcroft $level++; 600f0a594c1SAndy Whitcroft } 601f0a594c1SAndy Whitcroft } 6024a0df2efSAndy Whitcroft 603f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 60400df344fSAndy Whitcroft push(@res, $rawlines[$line]); 6054a0df2efSAndy Whitcroft } 6064a0df2efSAndy Whitcroft 607f0a594c1SAndy Whitcroft last if ($level == 0); 6084a0df2efSAndy Whitcroft } 6094a0df2efSAndy Whitcroft 610f0a594c1SAndy Whitcroft return ($level, @res); 6114a0df2efSAndy Whitcroft} 6124a0df2efSAndy Whitcroftsub ctx_block_outer { 6134a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6144a0df2efSAndy Whitcroft 615f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 616f0a594c1SAndy Whitcroft return @r; 6174a0df2efSAndy Whitcroft} 6184a0df2efSAndy Whitcroftsub ctx_block { 6194a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6204a0df2efSAndy Whitcroft 621f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 622f0a594c1SAndy Whitcroft return @r; 623653d4876SAndy Whitcroft} 624653d4876SAndy Whitcroftsub ctx_statement { 625f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 626f0a594c1SAndy Whitcroft 627f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 628f0a594c1SAndy Whitcroft return @r; 629f0a594c1SAndy Whitcroft} 630f0a594c1SAndy Whitcroftsub ctx_block_level { 631653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 632653d4876SAndy Whitcroft 633f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 6344a0df2efSAndy Whitcroft} 6359c0ca6f9SAndy Whitcroftsub ctx_statement_level { 6369c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 6379c0ca6f9SAndy Whitcroft 6389c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 6399c0ca6f9SAndy Whitcroft} 6404a0df2efSAndy Whitcroft 6414a0df2efSAndy Whitcroftsub ctx_locate_comment { 6424a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6434a0df2efSAndy Whitcroft 6444a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 645beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 6464a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 6474a0df2efSAndy Whitcroft 6484a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 6494a0df2efSAndy Whitcroft # comment. 6504a0df2efSAndy Whitcroft my $in_comment = 0; 6514a0df2efSAndy Whitcroft $current_comment = ''; 6524a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 65300df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 65400df344fSAndy Whitcroft #warn " $line\n"; 6554a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 6564a0df2efSAndy Whitcroft $in_comment = 1; 6574a0df2efSAndy Whitcroft } 6584a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 6594a0df2efSAndy Whitcroft $in_comment = 1; 6604a0df2efSAndy Whitcroft } 6614a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 6624a0df2efSAndy Whitcroft $current_comment = ''; 6634a0df2efSAndy Whitcroft } 6644a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 6654a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 6664a0df2efSAndy Whitcroft $in_comment = 0; 6674a0df2efSAndy Whitcroft } 6684a0df2efSAndy Whitcroft } 6694a0df2efSAndy Whitcroft 6704a0df2efSAndy Whitcroft chomp($current_comment); 6714a0df2efSAndy Whitcroft return($current_comment); 6724a0df2efSAndy Whitcroft} 6734a0df2efSAndy Whitcroftsub ctx_has_comment { 6744a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6754a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 6764a0df2efSAndy Whitcroft 67700df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 6784a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 6794a0df2efSAndy Whitcroft 6804a0df2efSAndy Whitcroft return ($cmt ne ''); 6814a0df2efSAndy Whitcroft} 6824a0df2efSAndy Whitcroft 6834d001e4dSAndy Whitcroftsub raw_line { 6844d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 6854d001e4dSAndy Whitcroft 6864d001e4dSAndy Whitcroft my $offset = $linenr - 1; 6874d001e4dSAndy Whitcroft $cnt++; 6884d001e4dSAndy Whitcroft 6894d001e4dSAndy Whitcroft my $line; 6904d001e4dSAndy Whitcroft while ($cnt) { 6914d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 6924d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 6934d001e4dSAndy Whitcroft $cnt--; 6944d001e4dSAndy Whitcroft } 6954d001e4dSAndy Whitcroft 6964d001e4dSAndy Whitcroft return $line; 6974d001e4dSAndy Whitcroft} 6984d001e4dSAndy Whitcroft 6990a920b5bSAndy Whitcroftsub cat_vet { 7000a920b5bSAndy Whitcroft my ($vet) = @_; 7019c0ca6f9SAndy Whitcroft my ($res, $coded); 7020a920b5bSAndy Whitcroft 7039c0ca6f9SAndy Whitcroft $res = ''; 7046c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 7056c72ffaaSAndy Whitcroft $res .= $1; 7066c72ffaaSAndy Whitcroft if ($2 ne '') { 7079c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 7086c72ffaaSAndy Whitcroft $res .= $coded; 7096c72ffaaSAndy Whitcroft } 7109c0ca6f9SAndy Whitcroft } 7119c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 7120a920b5bSAndy Whitcroft 7139c0ca6f9SAndy Whitcroft return $res; 7140a920b5bSAndy Whitcroft} 7150a920b5bSAndy Whitcroft 716c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 717cf655043SAndy Whitcroftmy $av_pending; 718c2fdda0dSAndy Whitcroftmy @av_paren_type; 7191f65f947SAndy Whitcroftmy $av_pend_colon; 720c2fdda0dSAndy Whitcroft 721c2fdda0dSAndy Whitcroftsub annotate_reset { 722c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 723cf655043SAndy Whitcroft $av_pending = '_'; 724cf655043SAndy Whitcroft @av_paren_type = ('E'); 7251f65f947SAndy Whitcroft $av_pend_colon = 'O'; 726c2fdda0dSAndy Whitcroft} 727c2fdda0dSAndy Whitcroft 7286c72ffaaSAndy Whitcroftsub annotate_values { 7296c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 7306c72ffaaSAndy Whitcroft 7316c72ffaaSAndy Whitcroft my $res; 7321f65f947SAndy Whitcroft my $var = '_' x length($stream); 7336c72ffaaSAndy Whitcroft my $cur = $stream; 7346c72ffaaSAndy Whitcroft 735c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 7366c72ffaaSAndy Whitcroft 7376c72ffaaSAndy Whitcroft while (length($cur)) { 738773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 739cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 740171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 7416c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 742c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 743c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 744cf655043SAndy Whitcroft $type = pop(@av_paren_type); 745c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 7466c72ffaaSAndy Whitcroft } 7476c72ffaaSAndy Whitcroft 7488ea3eb9aSAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) { 749c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 7506c72ffaaSAndy Whitcroft $type = 'T'; 7516c72ffaaSAndy Whitcroft 752389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 753389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 754389a2fe5SAndy Whitcroft $type = 'T'; 755389a2fe5SAndy Whitcroft 756c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 757171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 758c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 759171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 760171ae1a4SAndy Whitcroft if ($2 ne '') { 761cf655043SAndy Whitcroft $av_pending = 'N'; 762171ae1a4SAndy Whitcroft } 763171ae1a4SAndy Whitcroft $type = 'E'; 764171ae1a4SAndy Whitcroft 765c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 766171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 767171ae1a4SAndy Whitcroft $av_preprocessor = 1; 768171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 7696c72ffaaSAndy Whitcroft 770c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 771cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 772c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 773cf655043SAndy Whitcroft 774cf655043SAndy Whitcroft push(@av_paren_type, $type); 775cf655043SAndy Whitcroft push(@av_paren_type, $type); 776171ae1a4SAndy Whitcroft $type = 'E'; 777cf655043SAndy Whitcroft 778c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 779cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 780cf655043SAndy Whitcroft $av_preprocessor = 1; 781cf655043SAndy Whitcroft 782cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 783cf655043SAndy Whitcroft 784171ae1a4SAndy Whitcroft $type = 'E'; 785cf655043SAndy Whitcroft 786c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 787cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 788cf655043SAndy Whitcroft 789cf655043SAndy Whitcroft $av_preprocessor = 1; 790cf655043SAndy Whitcroft 791cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 792cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 793cf655043SAndy Whitcroft pop(@av_paren_type); 794cf655043SAndy Whitcroft push(@av_paren_type, $type); 795171ae1a4SAndy Whitcroft $type = 'E'; 7966c72ffaaSAndy Whitcroft 7976c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 798c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 7996c72ffaaSAndy Whitcroft 800171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 801171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 802171ae1a4SAndy Whitcroft $av_pending = $type; 803171ae1a4SAndy Whitcroft $type = 'N'; 804171ae1a4SAndy Whitcroft 8056c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 806c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 8076c72ffaaSAndy Whitcroft if (defined $2) { 808cf655043SAndy Whitcroft $av_pending = 'V'; 8096c72ffaaSAndy Whitcroft } 8106c72ffaaSAndy Whitcroft $type = 'N'; 8116c72ffaaSAndy Whitcroft 81214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 813c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 81414b111c1SAndy Whitcroft $av_pending = 'E'; 8156c72ffaaSAndy Whitcroft $type = 'N'; 8166c72ffaaSAndy Whitcroft 8171f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 8181f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 8191f65f947SAndy Whitcroft $av_pend_colon = 'C'; 8201f65f947SAndy Whitcroft $type = 'N'; 8211f65f947SAndy Whitcroft 82214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 823c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 8246c72ffaaSAndy Whitcroft $type = 'N'; 8256c72ffaaSAndy Whitcroft 8266c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 827c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 828cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 829cf655043SAndy Whitcroft $av_pending = '_'; 8306c72ffaaSAndy Whitcroft $type = 'N'; 8316c72ffaaSAndy Whitcroft 8326c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 833cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 834cf655043SAndy Whitcroft if ($new_type ne '_') { 835cf655043SAndy Whitcroft $type = $new_type; 836c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 837c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 8386c72ffaaSAndy Whitcroft } else { 839c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 8406c72ffaaSAndy Whitcroft } 8416c72ffaaSAndy Whitcroft 842c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 843c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 844c8cb2ca3SAndy Whitcroft $type = 'V'; 845cf655043SAndy Whitcroft $av_pending = 'V'; 8466c72ffaaSAndy Whitcroft 8478e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 8488e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 8491f65f947SAndy Whitcroft $av_pend_colon = 'B'; 8508e761b04SAndy Whitcroft } elsif ($type eq 'E') { 8518e761b04SAndy Whitcroft $av_pend_colon = 'L'; 8521f65f947SAndy Whitcroft } 8531f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 8541f65f947SAndy Whitcroft $type = 'V'; 8551f65f947SAndy Whitcroft 8566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 857c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 8586c72ffaaSAndy Whitcroft $type = 'V'; 8596c72ffaaSAndy Whitcroft 8606c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 861c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 8626c72ffaaSAndy Whitcroft $type = 'N'; 8636c72ffaaSAndy Whitcroft 864cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 865c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 86613214adfSAndy Whitcroft $type = 'E'; 8671f65f947SAndy Whitcroft $av_pend_colon = 'O'; 86813214adfSAndy Whitcroft 8698e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 8708e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 8718e761b04SAndy Whitcroft $type = 'C'; 8728e761b04SAndy Whitcroft 8731f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 8741f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 8751f65f947SAndy Whitcroft $type = 'N'; 8761f65f947SAndy Whitcroft 8771f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 8781f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 8791f65f947SAndy Whitcroft 8801f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 8811f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 8821f65f947SAndy Whitcroft $type = 'E'; 8831f65f947SAndy Whitcroft } else { 8841f65f947SAndy Whitcroft $type = 'N'; 8851f65f947SAndy Whitcroft } 8861f65f947SAndy Whitcroft $av_pend_colon = 'O'; 8871f65f947SAndy Whitcroft 8888e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 88913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 8906c72ffaaSAndy Whitcroft $type = 'N'; 8916c72ffaaSAndy Whitcroft 8920d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 89374048ed8SAndy Whitcroft my $variant; 89474048ed8SAndy Whitcroft 89574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 89674048ed8SAndy Whitcroft if ($type eq 'V') { 89774048ed8SAndy Whitcroft $variant = 'B'; 89874048ed8SAndy Whitcroft } else { 89974048ed8SAndy Whitcroft $variant = 'U'; 90074048ed8SAndy Whitcroft } 90174048ed8SAndy Whitcroft 90274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 90374048ed8SAndy Whitcroft $type = 'N'; 90474048ed8SAndy Whitcroft 9056c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 906c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 9076c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 9086c72ffaaSAndy Whitcroft $type = 'N'; 9096c72ffaaSAndy Whitcroft } 9106c72ffaaSAndy Whitcroft 9116c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 912c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 9136c72ffaaSAndy Whitcroft } 9146c72ffaaSAndy Whitcroft if (defined $1) { 9156c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 9166c72ffaaSAndy Whitcroft $res .= $type x length($1); 9176c72ffaaSAndy Whitcroft } 9186c72ffaaSAndy Whitcroft } 9196c72ffaaSAndy Whitcroft 9201f65f947SAndy Whitcroft return ($res, $var); 9216c72ffaaSAndy Whitcroft} 9226c72ffaaSAndy Whitcroft 9238905a67cSAndy Whitcroftsub possible { 92413214adfSAndy Whitcroft my ($possible, $line) = @_; 9258905a67cSAndy Whitcroft 9260776e594SAndy Whitcroft print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 9270776e594SAndy Whitcroft if ($possible !~ /(?: 9280776e594SAndy Whitcroft ^(?: 9290776e594SAndy Whitcroft $Modifier| 9300776e594SAndy Whitcroft $Storage| 9310776e594SAndy Whitcroft $Type| 9320776e594SAndy Whitcroft DEFINE_\S+| 9330776e594SAndy Whitcroft goto| 9340776e594SAndy Whitcroft return| 9350776e594SAndy Whitcroft case| 9360776e594SAndy Whitcroft else| 9370776e594SAndy Whitcroft asm|__asm__| 9380776e594SAndy Whitcroft do 9390776e594SAndy Whitcroft )$| 9400776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 9410776e594SAndy Whitcroft )/x) { 942c45dcabdSAndy Whitcroft # Check for modifiers. 943c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 944c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 945c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 946c45dcabdSAndy Whitcroft 947c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 948c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 949d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 950d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 951d2506586SAndy Whitcroft push(@modifierList, $modifier); 952d2506586SAndy Whitcroft } 953c45dcabdSAndy Whitcroft 954c45dcabdSAndy Whitcroft } else { 95513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 9568905a67cSAndy Whitcroft push(@typeList, $possible); 957c45dcabdSAndy Whitcroft } 9588905a67cSAndy Whitcroft build_types(); 9590776e594SAndy Whitcroft } else { 9600776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 9618905a67cSAndy Whitcroft } 9628905a67cSAndy Whitcroft} 9638905a67cSAndy Whitcroft 9646c72ffaaSAndy Whitcroftmy $prefix = ''; 9656c72ffaaSAndy Whitcroft 966f0a594c1SAndy Whitcroftsub report { 967773647a0SAndy Whitcroft if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) { 968773647a0SAndy Whitcroft return 0; 969773647a0SAndy Whitcroft } 9708905a67cSAndy Whitcroft my $line = $prefix . $_[0]; 9718905a67cSAndy Whitcroft 9728905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 9738905a67cSAndy Whitcroft 97413214adfSAndy Whitcroft push(our @report, $line); 975773647a0SAndy Whitcroft 976773647a0SAndy Whitcroft return 1; 977f0a594c1SAndy Whitcroft} 978f0a594c1SAndy Whitcroftsub report_dump { 97913214adfSAndy Whitcroft our @report; 980f0a594c1SAndy Whitcroft} 981de7d4f0eSAndy Whitcroftsub ERROR { 982773647a0SAndy Whitcroft if (report("ERROR: $_[0]\n")) { 983de7d4f0eSAndy Whitcroft our $clean = 0; 9846c72ffaaSAndy Whitcroft our $cnt_error++; 985de7d4f0eSAndy Whitcroft } 986773647a0SAndy Whitcroft} 987de7d4f0eSAndy Whitcroftsub WARN { 988773647a0SAndy Whitcroft if (report("WARNING: $_[0]\n")) { 989de7d4f0eSAndy Whitcroft our $clean = 0; 9906c72ffaaSAndy Whitcroft our $cnt_warn++; 991de7d4f0eSAndy Whitcroft } 992773647a0SAndy Whitcroft} 993de7d4f0eSAndy Whitcroftsub CHK { 994773647a0SAndy Whitcroft if ($check && report("CHECK: $_[0]\n")) { 995de7d4f0eSAndy Whitcroft our $clean = 0; 9966c72ffaaSAndy Whitcroft our $cnt_chk++; 9976c72ffaaSAndy Whitcroft } 998de7d4f0eSAndy Whitcroft} 999de7d4f0eSAndy Whitcroft 10006ecd9674SAndy Whitcroftsub check_absolute_file { 10016ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 10026ecd9674SAndy Whitcroft my $file = $absolute; 10036ecd9674SAndy Whitcroft 10046ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 10056ecd9674SAndy Whitcroft 10066ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 10076ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 10086ecd9674SAndy Whitcroft if (-f "$root/$file") { 10096ecd9674SAndy Whitcroft ##print "file<$file>\n"; 10106ecd9674SAndy Whitcroft last; 10116ecd9674SAndy Whitcroft } 10126ecd9674SAndy Whitcroft } 10136ecd9674SAndy Whitcroft if (! -f _) { 10146ecd9674SAndy Whitcroft return 0; 10156ecd9674SAndy Whitcroft } 10166ecd9674SAndy Whitcroft 10176ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 10186ecd9674SAndy Whitcroft my $prefix = $absolute; 10196ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 10206ecd9674SAndy Whitcroft 10216ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 10226ecd9674SAndy Whitcroft if ($prefix ne ".../") { 10236ecd9674SAndy Whitcroft WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr); 10246ecd9674SAndy Whitcroft } 10256ecd9674SAndy Whitcroft} 10266ecd9674SAndy Whitcroft 10270a920b5bSAndy Whitcroftsub process { 10280a920b5bSAndy Whitcroft my $filename = shift; 10290a920b5bSAndy Whitcroft 10300a920b5bSAndy Whitcroft my $linenr=0; 10310a920b5bSAndy Whitcroft my $prevline=""; 1032c2fdda0dSAndy Whitcroft my $prevrawline=""; 10330a920b5bSAndy Whitcroft my $stashline=""; 1034c2fdda0dSAndy Whitcroft my $stashrawline=""; 10350a920b5bSAndy Whitcroft 10364a0df2efSAndy Whitcroft my $length; 10370a920b5bSAndy Whitcroft my $indent; 10380a920b5bSAndy Whitcroft my $previndent=0; 10390a920b5bSAndy Whitcroft my $stashindent=0; 10400a920b5bSAndy Whitcroft 1041de7d4f0eSAndy Whitcroft our $clean = 1; 10420a920b5bSAndy Whitcroft my $signoff = 0; 10430a920b5bSAndy Whitcroft my $is_patch = 0; 10440a920b5bSAndy Whitcroft 104513214adfSAndy Whitcroft our @report = (); 10466c72ffaaSAndy Whitcroft our $cnt_lines = 0; 10476c72ffaaSAndy Whitcroft our $cnt_error = 0; 10486c72ffaaSAndy Whitcroft our $cnt_warn = 0; 10496c72ffaaSAndy Whitcroft our $cnt_chk = 0; 10506c72ffaaSAndy Whitcroft 10510a920b5bSAndy Whitcroft # Trace the real file/line as we go. 10520a920b5bSAndy Whitcroft my $realfile = ''; 10530a920b5bSAndy Whitcroft my $realline = 0; 10540a920b5bSAndy Whitcroft my $realcnt = 0; 10550a920b5bSAndy Whitcroft my $here = ''; 10560a920b5bSAndy Whitcroft my $in_comment = 0; 1057c2fdda0dSAndy Whitcroft my $comment_edge = 0; 10580a920b5bSAndy Whitcroft my $first_line = 0; 10590a920b5bSAndy Whitcroft 106013214adfSAndy Whitcroft my $prev_values = 'E'; 106113214adfSAndy Whitcroft 106213214adfSAndy Whitcroft # suppression flags 1063773647a0SAndy Whitcroft my %suppress_ifbraces; 1064170d3a22SAndy Whitcroft my %suppress_whiletrailers; 1065653d4876SAndy Whitcroft 1066c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1067de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1068c2fdda0dSAndy Whitcroft # 1069de7d4f0eSAndy Whitcroft my @setup_docs = (); 1070de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1071773647a0SAndy Whitcroft 1072773647a0SAndy Whitcroft sanitise_line_reset(); 1073c2fdda0dSAndy Whitcroft my $line; 1074c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1075773647a0SAndy Whitcroft $linenr++; 1076773647a0SAndy Whitcroft $line = $rawline; 1077c2fdda0dSAndy Whitcroft 1078773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1079de7d4f0eSAndy Whitcroft $setup_docs = 0; 1080de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1081de7d4f0eSAndy Whitcroft $setup_docs = 1; 1082de7d4f0eSAndy Whitcroft } 1083773647a0SAndy Whitcroft #next; 1084de7d4f0eSAndy Whitcroft } 1085773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1086773647a0SAndy Whitcroft $realline=$1-1; 1087773647a0SAndy Whitcroft if (defined $2) { 1088773647a0SAndy Whitcroft $realcnt=$3+1; 1089773647a0SAndy Whitcroft } else { 1090773647a0SAndy Whitcroft $realcnt=1+1; 1091773647a0SAndy Whitcroft } 1092c45dcabdSAndy Whitcroft $in_comment = 0; 1093773647a0SAndy Whitcroft 1094773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1095773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1096773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1097773647a0SAndy Whitcroft # at context start. 1098773647a0SAndy Whitcroft my $edge; 109901fa9147SAndy Whitcroft my $cnt = $realcnt; 110001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 110101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 110201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 110301fa9147SAndy Whitcroft $cnt--; 110401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1105721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1106fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1107fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1108fae17daeSAndy Whitcroft ($edge) = $1; 1109fae17daeSAndy Whitcroft last; 1110fae17daeSAndy Whitcroft } 1111773647a0SAndy Whitcroft } 1112773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1113773647a0SAndy Whitcroft $in_comment = 1; 1114773647a0SAndy Whitcroft } 1115773647a0SAndy Whitcroft 1116773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1117773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1118773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1119773647a0SAndy Whitcroft if (!defined $edge && 112083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1121773647a0SAndy Whitcroft { 1122773647a0SAndy Whitcroft $in_comment = 1; 1123773647a0SAndy Whitcroft } 1124773647a0SAndy Whitcroft 1125773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1126773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1127773647a0SAndy Whitcroft 1128171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1129773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1130171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1131773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1132773647a0SAndy Whitcroft } 1133773647a0SAndy Whitcroft push(@lines, $line); 1134773647a0SAndy Whitcroft 1135773647a0SAndy Whitcroft if ($realcnt > 1) { 1136773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1137773647a0SAndy Whitcroft } else { 1138773647a0SAndy Whitcroft $realcnt = 0; 1139773647a0SAndy Whitcroft } 1140773647a0SAndy Whitcroft 1141773647a0SAndy Whitcroft #print "==>$rawline\n"; 1142773647a0SAndy Whitcroft #print "-->$line\n"; 1143de7d4f0eSAndy Whitcroft 1144de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1145de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1146de7d4f0eSAndy Whitcroft } 1147de7d4f0eSAndy Whitcroft } 1148de7d4f0eSAndy Whitcroft 11496c72ffaaSAndy Whitcroft $prefix = ''; 11506c72ffaaSAndy Whitcroft 1151773647a0SAndy Whitcroft $realcnt = 0; 1152773647a0SAndy Whitcroft $linenr = 0; 11530a920b5bSAndy Whitcroft foreach my $line (@lines) { 11540a920b5bSAndy Whitcroft $linenr++; 11550a920b5bSAndy Whitcroft 1156c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 115730670854SAndy Whitcroft my $hunk_line = ($realcnt != 0); 11586c72ffaaSAndy Whitcroft 11590a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 11606c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 11610a920b5bSAndy Whitcroft $is_patch = 1; 11624a0df2efSAndy Whitcroft $first_line = $linenr + 1; 11630a920b5bSAndy Whitcroft $realline=$1-1; 11640a920b5bSAndy Whitcroft if (defined $2) { 11650a920b5bSAndy Whitcroft $realcnt=$3+1; 11660a920b5bSAndy Whitcroft } else { 11670a920b5bSAndy Whitcroft $realcnt=1+1; 11680a920b5bSAndy Whitcroft } 1169c2fdda0dSAndy Whitcroft annotate_reset(); 117013214adfSAndy Whitcroft $prev_values = 'E'; 117113214adfSAndy Whitcroft 1172773647a0SAndy Whitcroft %suppress_ifbraces = (); 1173170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 11740a920b5bSAndy Whitcroft next; 11750a920b5bSAndy Whitcroft 11764a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 11774a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 11784a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1179773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 11800a920b5bSAndy Whitcroft $realline++; 1181d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 11820a920b5bSAndy Whitcroft 11834a0df2efSAndy Whitcroft # Measure the line length and indent. 1184c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 11850a920b5bSAndy Whitcroft 11860a920b5bSAndy Whitcroft # Track the previous line. 11870a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 11880a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1189c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1190c2fdda0dSAndy Whitcroft 1191773647a0SAndy Whitcroft #warn "line<$line>\n"; 11926c72ffaaSAndy Whitcroft 1193d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1194d8aaf121SAndy Whitcroft $realcnt--; 11950a920b5bSAndy Whitcroft } 11960a920b5bSAndy Whitcroft 11970a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1198773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1199773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1200773647a0SAndy Whitcroft 12016c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 12026c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1203773647a0SAndy Whitcroft 1204773647a0SAndy Whitcroft # extract the filename as it passes 1205773647a0SAndy Whitcroft if ($line=~/^\+\+\+\s+(\S+)/) { 1206773647a0SAndy Whitcroft $realfile = $1; 1207773647a0SAndy Whitcroft $realfile =~ s@^[^/]*/@@; 1208773647a0SAndy Whitcroft 1209c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1210773647a0SAndy Whitcroft ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1211773647a0SAndy Whitcroft } 1212773647a0SAndy Whitcroft next; 1213773647a0SAndy Whitcroft } 1214773647a0SAndy Whitcroft 1215389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 12160a920b5bSAndy Whitcroft 1217c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1218c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1219c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 12200a920b5bSAndy Whitcroft 12216c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 12226c72ffaaSAndy Whitcroft 12230a920b5bSAndy Whitcroft#check the patch for a signoff: 1224d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 12254a0df2efSAndy Whitcroft # This is a signoff, if ugly, so do not double report. 12264a0df2efSAndy Whitcroft $signoff++; 12270a920b5bSAndy Whitcroft if (!($line =~ /^\s*Signed-off-by:/)) { 1228de7d4f0eSAndy Whitcroft WARN("Signed-off-by: is the preferred form\n" . 1229de7d4f0eSAndy Whitcroft $herecurr); 12300a920b5bSAndy Whitcroft } 12310a920b5bSAndy Whitcroft if ($line =~ /^\s*signed-off-by:\S/i) { 1232773647a0SAndy Whitcroft WARN("space required after Signed-off-by:\n" . 1233de7d4f0eSAndy Whitcroft $herecurr); 12340a920b5bSAndy Whitcroft } 12350a920b5bSAndy Whitcroft } 12360a920b5bSAndy Whitcroft 123700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 12388905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1239de7d4f0eSAndy Whitcroft ERROR("patch seems to be corrupt (line wrapped?)\n" . 12406c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1241de7d4f0eSAndy Whitcroft } 1242de7d4f0eSAndy Whitcroft 12436ecd9674SAndy Whitcroft# Check for absolute kernel paths. 12446ecd9674SAndy Whitcroft if ($tree) { 12456ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 12466ecd9674SAndy Whitcroft my $file = $1; 12476ecd9674SAndy Whitcroft 12486ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 12496ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 12506ecd9674SAndy Whitcroft # 12516ecd9674SAndy Whitcroft } else { 12526ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 12536ecd9674SAndy Whitcroft } 12546ecd9674SAndy Whitcroft } 12556ecd9674SAndy Whitcroft } 12566ecd9674SAndy Whitcroft 1257de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1258de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1259171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1260171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1261171ae1a4SAndy Whitcroft 1262171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1263171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1264171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1265171ae1a4SAndy Whitcroft 1266171ae1a4SAndy Whitcroft ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 126700df344fSAndy Whitcroft } 12680a920b5bSAndy Whitcroft 126930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 127030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 127100df344fSAndy Whitcroft 12720a920b5bSAndy Whitcroft#trailing whitespace 12739c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1274c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 12759c0ca6f9SAndy Whitcroft ERROR("DOS line endings\n" . $herevet); 12769c0ca6f9SAndy Whitcroft 1277c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1278c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1279de7d4f0eSAndy Whitcroft ERROR("trailing whitespace\n" . $herevet); 12800a920b5bSAndy Whitcroft } 12815368df20SAndy Whitcroft 12825368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 12835368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 12845368df20SAndy Whitcroft 12850a920b5bSAndy Whitcroft#80 column limit 1286c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1287f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 1288f4c014c0SAndy Whitcroft $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ && 1289f4c014c0SAndy Whitcroft $length > 80) 1290c45dcabdSAndy Whitcroft { 1291de7d4f0eSAndy Whitcroft WARN("line over 80 characters\n" . $herecurr); 12920a920b5bSAndy Whitcroft } 12930a920b5bSAndy Whitcroft 12948905a67cSAndy Whitcroft# check for adding lines without a newline. 12958905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 12968905a67cSAndy Whitcroft WARN("adding a line without newline at end of file\n" . $herecurr); 12978905a67cSAndy Whitcroft } 12988905a67cSAndy Whitcroft 1299b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1300b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 13010a920b5bSAndy Whitcroft 13020a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 13030a920b5bSAndy Whitcroft# more than 8 must use tabs. 1304c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1305c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1306c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1307171ae1a4SAndy Whitcroft ERROR("code indent should use tabs where possible\n" . $herevet); 13080a920b5bSAndy Whitcroft } 13090a920b5bSAndy Whitcroft 1310b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1311b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1312b9ea10d6SAndy Whitcroft 1313c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1314cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1315c2fdda0dSAndy Whitcroft WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1316c2fdda0dSAndy Whitcroft } 131722f2a2efSAndy Whitcroft 13189c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 1319170d3a22SAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next); 13209c9ba34eSAndy Whitcroft if ($realcnt && $line =~ /.\s*\S/) { 1321170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1322f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1323171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1324171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1325171ae1a4SAndy Whitcroft 1326171ae1a4SAndy Whitcroft my $s = $stat; 1327171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1328cf655043SAndy Whitcroft 1329c2fdda0dSAndy Whitcroft # Ignore goto labels. 1330171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1331c2fdda0dSAndy Whitcroft 1332c2fdda0dSAndy Whitcroft # Ignore functions being called 1333171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1334c2fdda0dSAndy Whitcroft 1335c45dcabdSAndy Whitcroft # declarations always start with types 1336d2506586SAndy Whitcroft } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) { 1337c45dcabdSAndy Whitcroft my $type = $1; 1338c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1339c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1340c45dcabdSAndy Whitcroft 13416c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1342a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1343c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1344c2fdda0dSAndy Whitcroft } 13458905a67cSAndy Whitcroft 13466c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 134765863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1348c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 13499c0ca6f9SAndy Whitcroft } 13508905a67cSAndy Whitcroft 13518905a67cSAndy Whitcroft # Check for any sort of function declaration. 13528905a67cSAndy Whitcroft # int foo(something bar, other baz); 13538905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1354171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 13558905a67cSAndy Whitcroft my ($name_len) = length($1); 13568905a67cSAndy Whitcroft 1357cf655043SAndy Whitcroft my $ctx = $s; 1358773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 13598905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1360cf655043SAndy Whitcroft 13618905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1362c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 13638905a67cSAndy Whitcroft 1364c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 13658905a67cSAndy Whitcroft } 13668905a67cSAndy Whitcroft } 13678905a67cSAndy Whitcroft } 13688905a67cSAndy Whitcroft 13699c0ca6f9SAndy Whitcroft } 13709c0ca6f9SAndy Whitcroft 137100df344fSAndy Whitcroft# 137200df344fSAndy Whitcroft# Checks which may be anchored in the context. 137300df344fSAndy Whitcroft# 137400df344fSAndy Whitcroft 137500df344fSAndy Whitcroft# Check for switch () and associated case and default 137600df344fSAndy Whitcroft# statements should be at the same indent. 137700df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 137800df344fSAndy Whitcroft my $err = ''; 137900df344fSAndy Whitcroft my $sep = ''; 138000df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 138100df344fSAndy Whitcroft shift(@ctx); 138200df344fSAndy Whitcroft for my $ctx (@ctx) { 138300df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 138400df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 138500df344fSAndy Whitcroft $indent != $cindent) { 138600df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 138700df344fSAndy Whitcroft $sep = ''; 138800df344fSAndy Whitcroft } else { 138900df344fSAndy Whitcroft $sep = "[...]\n"; 139000df344fSAndy Whitcroft } 139100df344fSAndy Whitcroft } 139200df344fSAndy Whitcroft if ($err ne '') { 13939c0ca6f9SAndy Whitcroft ERROR("switch and case should be at the same indent\n$hereline$err"); 1394de7d4f0eSAndy Whitcroft } 1395de7d4f0eSAndy Whitcroft } 1396de7d4f0eSAndy Whitcroft 1397de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1398de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1399c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1400773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1401773647a0SAndy Whitcroft 14029c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1403de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1404de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1405de7d4f0eSAndy Whitcroft 1406548596d5SAndy Whitcroft my $ctx_ln = $linenr; 1407548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 1408de7d4f0eSAndy Whitcroft 1409548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1410548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 1411548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 1412548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1413548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1414773647a0SAndy Whitcroft $ctx_ln++; 1415773647a0SAndy Whitcroft } 1416548596d5SAndy Whitcroft 141753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 141853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1419773647a0SAndy Whitcroft 1420773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1421773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . 1422c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 142300df344fSAndy Whitcroft } 1424773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1425773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1426773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1427773647a0SAndy Whitcroft { 14289c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 14299c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1430773647a0SAndy Whitcroft WARN("trailing semicolon indicates no statements, indent implies otherwise\n" . 1431c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 14329c0ca6f9SAndy Whitcroft } 14339c0ca6f9SAndy Whitcroft } 143400df344fSAndy Whitcroft } 143500df344fSAndy Whitcroft 14364d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 14374d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 14384d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 14394d001e4dSAndy Whitcroft 14404d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 14414d001e4dSAndy Whitcroft 14424d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 14434d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 14444d001e4dSAndy Whitcroft # where necessary. 14454d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 14464d001e4dSAndy Whitcroft 14474d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 14486f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 14496f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 14504d001e4dSAndy Whitcroft 14514d001e4dSAndy Whitcroft # We want to check the first line inside the block 14524d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 14534d001e4dSAndy Whitcroft # 1) any blank line termination 14544d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 14554d001e4dSAndy Whitcroft # 3) any do (...) { 14564d001e4dSAndy Whitcroft my $continuation = 0; 14574d001e4dSAndy Whitcroft my $check = 0; 14584d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 14594d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 14604d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 14614d001e4dSAndy Whitcroft $continuation = 1; 14624d001e4dSAndy Whitcroft } 14639bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 14644d001e4dSAndy Whitcroft $check = 1; 14654d001e4dSAndy Whitcroft $cond_lines++; 14664d001e4dSAndy Whitcroft } 14674d001e4dSAndy Whitcroft 14684d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 14694d001e4dSAndy Whitcroft # preprocessor statement. 14704d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 14714d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 14724d001e4dSAndy Whitcroft $check = 0; 14734d001e4dSAndy Whitcroft } 14744d001e4dSAndy Whitcroft 14759bd49efeSAndy Whitcroft my $cond_ptr = -1; 1476740504c6SAndy Whitcroft $continuation = 0; 14779bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 14789bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 14794d001e4dSAndy Whitcroft 1480f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 1481f16fa28fSAndy Whitcroft # is not linear. 1482f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1483f16fa28fSAndy Whitcroft $check = 0; 1484f16fa28fSAndy Whitcroft } 1485f16fa28fSAndy Whitcroft 14869bd49efeSAndy Whitcroft # Ignore: 14879bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 14889bd49efeSAndy Whitcroft # 2) preprocessor lines, and 14899bd49efeSAndy Whitcroft # 3) labels. 1490740504c6SAndy Whitcroft if ($continuation || 1491740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 14929bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 14939bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 1494740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 14959bd49efeSAndy Whitcroft $s =~ s/^.*?\n//; 14969bd49efeSAndy Whitcroft $cond_lines++; 14979bd49efeSAndy Whitcroft } 14984d001e4dSAndy Whitcroft } 14994d001e4dSAndy Whitcroft 15004d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 15014d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 15024d001e4dSAndy Whitcroft 15034d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 15044d001e4dSAndy Whitcroft # this is not this patch's fault. 15054d001e4dSAndy Whitcroft if (!defined($stat_real) || 15064d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 15074d001e4dSAndy Whitcroft $check = 0; 15084d001e4dSAndy Whitcroft } 15094d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 15104d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 15114d001e4dSAndy Whitcroft } 15124d001e4dSAndy Whitcroft 15139bd49efeSAndy Whitcroft #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; 15144d001e4dSAndy Whitcroft 15154d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 15164d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 15174d001e4dSAndy Whitcroft WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 15184d001e4dSAndy Whitcroft } 15194d001e4dSAndy Whitcroft } 15204d001e4dSAndy Whitcroft 15216c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 15226c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 15231f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 15241f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 15256c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 1526c2fdda0dSAndy Whitcroft if ($dbg_values) { 1527c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 1528cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 1529cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 15301f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 1531c2fdda0dSAndy Whitcroft } 15326c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 15336c72ffaaSAndy Whitcroft 153400df344fSAndy Whitcroft#ignore lines not being added 153500df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 153600df344fSAndy Whitcroft 1537653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 15387429c690SAndy Whitcroft if ($dbg_type) { 15397429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 15407429c690SAndy Whitcroft ERROR("TEST: is type\n" . $herecurr); 15417429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 15427429c690SAndy Whitcroft ERROR("TEST: is not type ($1 is)\n". $herecurr); 15437429c690SAndy Whitcroft } 1544653d4876SAndy Whitcroft next; 1545653d4876SAndy Whitcroft } 1546a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 1547a1ef277eSAndy Whitcroft if ($dbg_attr) { 1548a1ef277eSAndy Whitcroft if ($line =~ /^.\s*$Attribute\s*$/) { 1549a1ef277eSAndy Whitcroft ERROR("TEST: is attr\n" . $herecurr); 1550a1ef277eSAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) { 1551a1ef277eSAndy Whitcroft ERROR("TEST: is not attr ($1 is)\n". $herecurr); 1552a1ef277eSAndy Whitcroft } 1553a1ef277eSAndy Whitcroft next; 1554a1ef277eSAndy Whitcroft } 1555653d4876SAndy Whitcroft 1556f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 1557f0a594c1SAndy Whitcroft if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ && 1558f0a594c1SAndy Whitcroft $line =~ /^.\s*{/) { 1559773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . $hereprev); 1560f0a594c1SAndy Whitcroft } 1561f0a594c1SAndy Whitcroft 156200df344fSAndy Whitcroft# 156300df344fSAndy Whitcroft# Checks which are anchored on the added line. 156400df344fSAndy Whitcroft# 156500df344fSAndy Whitcroft 1566653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 1567c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 1568653d4876SAndy Whitcroft my $path = $1; 1569653d4876SAndy Whitcroft if ($path =~ m{//}) { 1570de7d4f0eSAndy Whitcroft ERROR("malformed #include filename\n" . 1571de7d4f0eSAndy Whitcroft $herecurr); 1572653d4876SAndy Whitcroft } 1573653d4876SAndy Whitcroft } 1574653d4876SAndy Whitcroft 157500df344fSAndy Whitcroft# no C99 // comments 157600df344fSAndy Whitcroft if ($line =~ m{//}) { 1577de7d4f0eSAndy Whitcroft ERROR("do not use C99 // comments\n" . $herecurr); 157800df344fSAndy Whitcroft } 157900df344fSAndy Whitcroft # Remove C99 comments. 15800a920b5bSAndy Whitcroft $line =~ s@//.*@@; 15816c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 15820a920b5bSAndy Whitcroft 15830a920b5bSAndy Whitcroft#EXPORT_SYMBOL should immediately follow its function closing }. 1584653d4876SAndy Whitcroft if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) || 1585653d4876SAndy Whitcroft ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 1586653d4876SAndy Whitcroft my $name = $1; 158748012058SAndy Whitcroft if ($prevline !~ /(?: 158848012058SAndy Whitcroft ^.}| 158948012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 159048012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 159148012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 159248012058SAndy Whitcroft ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 159348012058SAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[) 159448012058SAndy Whitcroft )/x) { 1595de7d4f0eSAndy Whitcroft WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 15960a920b5bSAndy Whitcroft } 15970a920b5bSAndy Whitcroft } 15980a920b5bSAndy Whitcroft 1599f0a594c1SAndy Whitcroft# check for external initialisers. 1600c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 1601f0a594c1SAndy Whitcroft ERROR("do not initialise externals to 0 or NULL\n" . 1602f0a594c1SAndy Whitcroft $herecurr); 1603f0a594c1SAndy Whitcroft } 16040a920b5bSAndy Whitcroft# check for static initialisers. 16059c9ba34eSAndy Whitcroft if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) { 1606de7d4f0eSAndy Whitcroft ERROR("do not initialise statics to 0 or NULL\n" . 1607de7d4f0eSAndy Whitcroft $herecurr); 16080a920b5bSAndy Whitcroft } 16090a920b5bSAndy Whitcroft 1610653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 1611653d4876SAndy Whitcroft# make sense. 1612653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 16139c0ca6f9SAndy Whitcroft $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ && 1614c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 16158ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 1616653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 1617de7d4f0eSAndy Whitcroft WARN("do not add new typedefs\n" . $herecurr); 16180a920b5bSAndy Whitcroft } 16190a920b5bSAndy Whitcroft 16200a920b5bSAndy Whitcroft# * goes on variable not on type 162165863862SAndy Whitcroft # (char*[ const]) 162265863862SAndy Whitcroft if ($line =~ m{\($NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)*)\)}) { 162365863862SAndy Whitcroft my ($from, $to) = ($1, $1); 1624d8aaf121SAndy Whitcroft 162565863862SAndy Whitcroft # Should start with a space. 162665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 162765863862SAndy Whitcroft # Should not end with a space. 162865863862SAndy Whitcroft $to =~ s/\s+$//; 162965863862SAndy Whitcroft # '*'s should not have spaces between. 163065863862SAndy Whitcroft while ($to =~ s/(.)\s\*/$1\*/) { 163165863862SAndy Whitcroft } 1632d8aaf121SAndy Whitcroft 163365863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 163465863862SAndy Whitcroft if ($from ne $to) { 163565863862SAndy Whitcroft ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 163665863862SAndy Whitcroft } 163765863862SAndy Whitcroft } elsif ($line =~ m{\b$NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)?)($Ident)}) { 163865863862SAndy Whitcroft my ($from, $to, $ident) = ($1, $1, $2); 1639d8aaf121SAndy Whitcroft 164065863862SAndy Whitcroft # Should start with a space. 164165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 164265863862SAndy Whitcroft # Should not end with a space. 164365863862SAndy Whitcroft $to =~ s/\s+$//; 164465863862SAndy Whitcroft # '*'s should not have spaces between. 164565863862SAndy Whitcroft while ($to =~ s/(.)\s\*/$1\*/) { 164665863862SAndy Whitcroft } 164765863862SAndy Whitcroft # Modifiers should have spaces. 164865863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 164965863862SAndy Whitcroft 165065863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 165165863862SAndy Whitcroft if ($from ne $to) { 165265863862SAndy Whitcroft ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 165365863862SAndy Whitcroft } 16540a920b5bSAndy Whitcroft } 16550a920b5bSAndy Whitcroft 16560a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 16570a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 16580a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 16590a920b5bSAndy Whitcroft# print "$herecurr"; 16600a920b5bSAndy Whitcroft# $clean = 0; 16610a920b5bSAndy Whitcroft# } 16620a920b5bSAndy Whitcroft 16638905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 1664c2fdda0dSAndy Whitcroft WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 16658905a67cSAndy Whitcroft } 16668905a67cSAndy Whitcroft 166700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 166800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 166900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 167000df344fSAndy Whitcroft# printk includes all preceeding printk's which have no newline on the end. 167100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 1672f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 167300df344fSAndy Whitcroft my $ok = 0; 167400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 167500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 167600df344fSAndy Whitcroft # we have a preceeding printk if it ends 167700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 167800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 167900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 168000df344fSAndy Whitcroft $ok = 1; 168100df344fSAndy Whitcroft } 168200df344fSAndy Whitcroft last; 168300df344fSAndy Whitcroft } 168400df344fSAndy Whitcroft } 168500df344fSAndy Whitcroft if ($ok == 0) { 1686de7d4f0eSAndy Whitcroft WARN("printk() should include KERN_ facility level\n" . $herecurr); 16870a920b5bSAndy Whitcroft } 168800df344fSAndy Whitcroft } 16890a920b5bSAndy Whitcroft 1690653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 1691653d4876SAndy Whitcroft# or if closed on same line 1692c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 1693c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 1694de7d4f0eSAndy Whitcroft ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 16950a920b5bSAndy Whitcroft } 1696653d4876SAndy Whitcroft 16978905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 16988905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 16998905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 17008905a67cSAndy Whitcroft ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 17018905a67cSAndy Whitcroft } 17028905a67cSAndy Whitcroft 17038d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 17048d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 1705fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 1706fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 17078d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 17088d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 17098d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 1710fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 1711fe2a7dbcSAndy Whitcroft $prefix !~ /{\s+$/) { 17128d31cfceSAndy Whitcroft ERROR("space prohibited before open square bracket '['\n" . $herecurr); 17138d31cfceSAndy Whitcroft } 17148d31cfceSAndy Whitcroft } 17158d31cfceSAndy Whitcroft 1716f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 17176c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 1718c2fdda0dSAndy Whitcroft my $name = $1; 1719773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 1720773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 1721c2fdda0dSAndy Whitcroft 1722c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 1723773647a0SAndy Whitcroft if ($name =~ /^(?: 1724773647a0SAndy Whitcroft if|for|while|switch|return|case| 1725773647a0SAndy Whitcroft volatile|__volatile__| 1726773647a0SAndy Whitcroft __attribute__|format|__extension__| 1727773647a0SAndy Whitcroft asm|__asm__)$/x) 1728773647a0SAndy Whitcroft { 1729c2fdda0dSAndy Whitcroft 1730c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 1731c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 1732c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 1733c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 1734773647a0SAndy Whitcroft 1735773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 1736c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 1737c2fdda0dSAndy Whitcroft 1738c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 1739c2fdda0dSAndy Whitcroft # likely a typedef for a function. 1740773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 1741c2fdda0dSAndy Whitcroft 1742c2fdda0dSAndy Whitcroft } else { 1743773647a0SAndy Whitcroft WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr); 1744f0a594c1SAndy Whitcroft } 17456c72ffaaSAndy Whitcroft } 1746653d4876SAndy Whitcroft# Check operator spacing. 17470a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 17489c0ca6f9SAndy Whitcroft my $ops = qr{ 17499c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 17509c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 17519c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 17521f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 17531f65f947SAndy Whitcroft \?|: 17549c0ca6f9SAndy Whitcroft }x; 1755cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 175600df344fSAndy Whitcroft my $off = 0; 17576c72ffaaSAndy Whitcroft 17586c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 17596c72ffaaSAndy Whitcroft 17600a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 17614a0df2efSAndy Whitcroft $off += length($elements[$n]); 17624a0df2efSAndy Whitcroft 1763773647a0SAndy Whitcroft # Pick up the preceeding and succeeding characters. 1764773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 1765773647a0SAndy Whitcroft my $cc = ''; 1766773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 1767773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 1768773647a0SAndy Whitcroft } 1769773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 1770773647a0SAndy Whitcroft 17714a0df2efSAndy Whitcroft my $a = ''; 17724a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 17734a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 1774cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 17754a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 17764a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 1777773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 17784a0df2efSAndy Whitcroft 17790a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 17804a0df2efSAndy Whitcroft 17814a0df2efSAndy Whitcroft my $c = ''; 17820a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 17834a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 17844a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 1785cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 17864a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 17874a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 178822f2a2efSAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/); 17894a0df2efSAndy Whitcroft } else { 17904a0df2efSAndy Whitcroft $c = 'E'; 17910a920b5bSAndy Whitcroft } 17920a920b5bSAndy Whitcroft 17934a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 17944a0df2efSAndy Whitcroft 17954a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 17964a0df2efSAndy Whitcroft 17976c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 1798de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 17990a920b5bSAndy Whitcroft 180074048ed8SAndy Whitcroft # Pull out the value of this operator. 18016c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 18020a920b5bSAndy Whitcroft 18031f65f947SAndy Whitcroft # Get the full operator variant. 18041f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 18051f65f947SAndy Whitcroft 180613214adfSAndy Whitcroft # Ignore operators passed as parameters. 180713214adfSAndy Whitcroft if ($op_type ne 'V' && 180813214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 180913214adfSAndy Whitcroft 1810cf655043SAndy Whitcroft# # Ignore comments 1811cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 181213214adfSAndy Whitcroft 1813d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 181413214adfSAndy Whitcroft } elsif ($op eq ';') { 1815cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 1816cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 1817773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 1818d8aaf121SAndy Whitcroft } 1819d8aaf121SAndy Whitcroft 1820d8aaf121SAndy Whitcroft # // is a comment 1821d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 18220a920b5bSAndy Whitcroft 18231f65f947SAndy Whitcroft # No spaces for: 18241f65f947SAndy Whitcroft # -> 18251f65f947SAndy Whitcroft # : when part of a bitfield 18261f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 18274a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 1828773647a0SAndy Whitcroft ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 18290a920b5bSAndy Whitcroft } 18300a920b5bSAndy Whitcroft 18310a920b5bSAndy Whitcroft # , must have a space on the right. 18320a920b5bSAndy Whitcroft } elsif ($op eq ',') { 1833cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 1834773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 18350a920b5bSAndy Whitcroft } 18360a920b5bSAndy Whitcroft 18379c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 183874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 18399c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 18409c0ca6f9SAndy Whitcroft 18419c0ca6f9SAndy Whitcroft # unary operators should have a space before and 18429c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 18439c0ca6f9SAndy Whitcroft # unary operator, or a cast 18449c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 184574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 18460d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 1847cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 1848773647a0SAndy Whitcroft ERROR("space required before that '$op' $at\n" . $hereptr); 18490a920b5bSAndy Whitcroft } 1850171ae1a4SAndy Whitcroft if ($op eq '*' && $cc =~/\s*const\b/) { 1851171ae1a4SAndy Whitcroft # A unary '*' may be const 1852171ae1a4SAndy Whitcroft 1853171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 1854773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 18550a920b5bSAndy Whitcroft } 18560a920b5bSAndy Whitcroft 18570a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 18580a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 1859773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 1860773647a0SAndy Whitcroft ERROR("space required one side of that '$op' $at\n" . $hereptr); 18610a920b5bSAndy Whitcroft } 1862773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 1863773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 1864773647a0SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 1865653d4876SAndy Whitcroft } 1866773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 1867773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 1868773647a0SAndy Whitcroft } 1869773647a0SAndy Whitcroft 18700a920b5bSAndy Whitcroft 18710a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 18729c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 18739c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 18749c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 1875c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 1876c2fdda0dSAndy Whitcroft $op eq '%') 18770a920b5bSAndy Whitcroft { 1878773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 1879de7d4f0eSAndy Whitcroft ERROR("need consistent spacing around '$op' $at\n" . 1880de7d4f0eSAndy Whitcroft $hereptr); 18810a920b5bSAndy Whitcroft } 18820a920b5bSAndy Whitcroft 18831f65f947SAndy Whitcroft # A colon needs no spaces before when it is 18841f65f947SAndy Whitcroft # terminating a case value or a label. 18851f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 18861f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 18871f65f947SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 18881f65f947SAndy Whitcroft } 18891f65f947SAndy Whitcroft 18900a920b5bSAndy Whitcroft # All the others need spaces both sides. 1891cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 18921f65f947SAndy Whitcroft my $ok = 0; 18931f65f947SAndy Whitcroft 189422f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 18951f65f947SAndy Whitcroft if (($op eq '<' && 18961f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 18971f65f947SAndy Whitcroft ($op eq '>' && 18981f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 18991f65f947SAndy Whitcroft { 19001f65f947SAndy Whitcroft $ok = 1; 19011f65f947SAndy Whitcroft } 19021f65f947SAndy Whitcroft 19031f65f947SAndy Whitcroft # Ignore ?: 19041f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 19051f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 19061f65f947SAndy Whitcroft $ok = 1; 19071f65f947SAndy Whitcroft } 19081f65f947SAndy Whitcroft 19091f65f947SAndy Whitcroft if ($ok == 0) { 1910773647a0SAndy Whitcroft ERROR("spaces required around that '$op' $at\n" . $hereptr); 19110a920b5bSAndy Whitcroft } 191222f2a2efSAndy Whitcroft } 19134a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 19140a920b5bSAndy Whitcroft } 19150a920b5bSAndy Whitcroft } 19160a920b5bSAndy Whitcroft 1917f0a594c1SAndy Whitcroft# check for multiple assignments 1918f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 19196c72ffaaSAndy Whitcroft CHK("multiple assignments should be avoided\n" . $herecurr); 1920f0a594c1SAndy Whitcroft } 1921f0a594c1SAndy Whitcroft 192222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 192322f2a2efSAndy Whitcroft## # continuation. 192422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 192522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 192622f2a2efSAndy Whitcroft## 192722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 192822f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 192922f2a2efSAndy Whitcroft## my $ln = $line; 193022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 193122f2a2efSAndy Whitcroft## } 193222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 193322f2a2efSAndy Whitcroft## WARN("declaring multiple variables together should be avoided\n" . $herecurr); 193422f2a2efSAndy Whitcroft## } 193522f2a2efSAndy Whitcroft## } 1936f0a594c1SAndy Whitcroft 19370a920b5bSAndy Whitcroft#need space before brace following if, while, etc 193822f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 193922f2a2efSAndy Whitcroft $line =~ /do{/) { 1940773647a0SAndy Whitcroft ERROR("space required before the open brace '{'\n" . $herecurr); 1941de7d4f0eSAndy Whitcroft } 1942de7d4f0eSAndy Whitcroft 1943de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 1944de7d4f0eSAndy Whitcroft# on the line 1945de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 1946773647a0SAndy Whitcroft ERROR("space required after that close brace '}'\n" . $herecurr); 19470a920b5bSAndy Whitcroft } 19480a920b5bSAndy Whitcroft 194922f2a2efSAndy Whitcroft# check spacing on square brackets 195022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 1951773647a0SAndy Whitcroft ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 195222f2a2efSAndy Whitcroft } 195322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 1954773647a0SAndy Whitcroft ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 195522f2a2efSAndy Whitcroft } 195622f2a2efSAndy Whitcroft 1957c45dcabdSAndy Whitcroft# check spacing on parentheses 19589c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 19599c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 1960773647a0SAndy Whitcroft ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 196122f2a2efSAndy Whitcroft } 196213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 1963c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 1964c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 1965773647a0SAndy Whitcroft ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 196622f2a2efSAndy Whitcroft } 196722f2a2efSAndy Whitcroft 19680a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 19694a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 19700a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 1971de7d4f0eSAndy Whitcroft WARN("labels should not be indented\n" . $herecurr); 19720a920b5bSAndy Whitcroft } 19730a920b5bSAndy Whitcroft 1974c45dcabdSAndy Whitcroft# Return is not a function. 1975c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 1976c45dcabdSAndy Whitcroft my $spacing = $1; 1977c45dcabdSAndy Whitcroft my $value = $2; 1978c45dcabdSAndy Whitcroft 1979c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 1980fee61c47SAndy Whitcroft $value =~ s/\)\(/\) \(/g; 1981c45dcabdSAndy Whitcroft while ($value =~ s/\([^\(\)]*\)/1/) { 1982c45dcabdSAndy Whitcroft } 1983c45dcabdSAndy Whitcroft 1984c45dcabdSAndy Whitcroft if ($value =~ /^(?:$Ident|-?$Constant)$/) { 1985c45dcabdSAndy Whitcroft ERROR("return is not a function, parentheses are not required\n" . $herecurr); 1986c45dcabdSAndy Whitcroft 1987c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 1988c45dcabdSAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 1989c45dcabdSAndy Whitcroft } 1990c45dcabdSAndy Whitcroft } 1991c45dcabdSAndy Whitcroft 19920a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 19934a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 1994773647a0SAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 19950a920b5bSAndy Whitcroft } 19960a920b5bSAndy Whitcroft 1997f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 1998f5fe35ddSAndy Whitcroft# statements after the conditional. 1999170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 2000170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2001170d3a22SAndy Whitcroft $remain_next, $off_next); 2002170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2003170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2004170d3a22SAndy Whitcroft 2005170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2006170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2007170d3a22SAndy Whitcroft # then count those as offsets. 2008170d3a22SAndy Whitcroft my ($whitespace) = 2009170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2010170d3a22SAndy Whitcroft my $offset = 2011170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2012170d3a22SAndy Whitcroft 2013170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2014170d3a22SAndy Whitcroft $offset} = 1; 2015170d3a22SAndy Whitcroft } 2016170d3a22SAndy Whitcroft } 2017170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2018170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2019171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 20208905a67cSAndy Whitcroft 20218905a67cSAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) { 2022c2fdda0dSAndy Whitcroft ERROR("do not use assignment in if condition\n" . $herecurr); 20238905a67cSAndy Whitcroft } 20248905a67cSAndy Whitcroft 20258905a67cSAndy Whitcroft # Find out what is on the end of the line after the 20268905a67cSAndy Whitcroft # conditional. 2027773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 20288905a67cSAndy Whitcroft $s =~ s/\n.*//g; 202913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 203053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 203153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2032773647a0SAndy Whitcroft { 2033bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2034bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2035bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 2036bb44ad39SAndy Whitcroft 2037bb44ad39SAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 2038bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2039bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2040bb44ad39SAndy Whitcroft } 2041bb44ad39SAndy Whitcroft 2042bb44ad39SAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); 20438905a67cSAndy Whitcroft } 20448905a67cSAndy Whitcroft } 20458905a67cSAndy Whitcroft 204613214adfSAndy Whitcroft# Check for bitwise tests written as boolean 204713214adfSAndy Whitcroft if ($line =~ / 204813214adfSAndy Whitcroft (?: 204913214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 205013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 205113214adfSAndy Whitcroft (?:\&\&|\|\|) 205213214adfSAndy Whitcroft | 205313214adfSAndy Whitcroft (?:\&\&|\|\|) 205413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 205513214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 205613214adfSAndy Whitcroft )/x) 205713214adfSAndy Whitcroft { 205813214adfSAndy Whitcroft WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 205913214adfSAndy Whitcroft } 206013214adfSAndy Whitcroft 20618905a67cSAndy Whitcroft# if and else should not have general statements after it 206213214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 206313214adfSAndy Whitcroft my $s = $1; 206413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 206513214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 20668905a67cSAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 20670a920b5bSAndy Whitcroft } 206813214adfSAndy Whitcroft } 2069a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2070a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2071a1080bf8SAndy Whitcroft $line !~ /\G(?: 20723fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2073a1080bf8SAndy Whitcroft \s*return\s+ 2074a1080bf8SAndy Whitcroft )/xg) 2075a1080bf8SAndy Whitcroft { 2076a1080bf8SAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 2077a1080bf8SAndy Whitcroft } 20780a920b5bSAndy Whitcroft 20790a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 20800a920b5bSAndy Whitcroft # indent level to be relevant to each other. 20810a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 20820a920b5bSAndy Whitcroft $previndent == $indent) { 2083de7d4f0eSAndy Whitcroft ERROR("else should follow close brace '}'\n" . $hereprev); 20840a920b5bSAndy Whitcroft } 20850a920b5bSAndy Whitcroft 2086c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2087c2fdda0dSAndy Whitcroft $previndent == $indent) { 2088c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2089c2fdda0dSAndy Whitcroft 2090c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2091c2fdda0dSAndy Whitcroft # conditional. 2092773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2093c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2094c2fdda0dSAndy Whitcroft 2095c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2096c2fdda0dSAndy Whitcroft ERROR("while should follow close brace '}'\n" . $hereprev); 2097c2fdda0dSAndy Whitcroft } 2098c2fdda0dSAndy Whitcroft } 2099c2fdda0dSAndy Whitcroft 21000a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 21010a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 21020a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 21030a920b5bSAndy Whitcroft# print "$herecurr"; 21040a920b5bSAndy Whitcroft# $clean = 0; 21050a920b5bSAndy Whitcroft# } 21060a920b5bSAndy Whitcroft 21070a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2108c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2109de7d4f0eSAndy Whitcroft WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr); 21100a920b5bSAndy Whitcroft } 21110a920b5bSAndy Whitcroft 2112653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2113c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2114e09dec48SAndy Whitcroft my $file = "$1.h"; 2115e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2116e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2117e09dec48SAndy Whitcroft $realfile ne $checkfile && 2118c45dcabdSAndy Whitcroft $1 ne 'irq') 2119c45dcabdSAndy Whitcroft { 2120e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2121e09dec48SAndy Whitcroft CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2122e09dec48SAndy Whitcroft } else { 2123e09dec48SAndy Whitcroft WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2124e09dec48SAndy Whitcroft } 21250a920b5bSAndy Whitcroft } 21260a920b5bSAndy Whitcroft } 21270a920b5bSAndy Whitcroft 2128653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2129653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2130cf655043SAndy Whitcroft# in a known good container 2131b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2132b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2133d8aaf121SAndy Whitcroft my $ln = $linenr; 2134d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2135c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2136c45dcabdSAndy Whitcroft my $ctx = ''; 2137653d4876SAndy Whitcroft 2138c45dcabdSAndy Whitcroft my $args = defined($1); 2139de7d4f0eSAndy Whitcroft 2140c45dcabdSAndy Whitcroft # Find the end of the macro and limit our statement 2141c45dcabdSAndy Whitcroft # search to that. 2142c45dcabdSAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1] && 2143c45dcabdSAndy Whitcroft $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2144c45dcabdSAndy Whitcroft { 2145c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1] . "\n"; 2146a3bb97a7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 2147c45dcabdSAndy Whitcroft $ln++; 2148de7d4f0eSAndy Whitcroft } 2149c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1]; 2150d8aaf121SAndy Whitcroft 2151c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2152c45dcabdSAndy Whitcroft ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2153c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2154a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2155c45dcabdSAndy Whitcroft 2156c45dcabdSAndy Whitcroft # Extract the remainder of the define (if any) and 2157c45dcabdSAndy Whitcroft # rip off surrounding spaces, and trailing \'s. 2158c45dcabdSAndy Whitcroft $rest = ''; 2159636d140aSAndy Whitcroft while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2160636d140aSAndy Whitcroft #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2161a3bb97a7SAndy Whitcroft if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2162c45dcabdSAndy Whitcroft $rest .= substr($lines[$ln - 1], $off) . "\n"; 2163c45dcabdSAndy Whitcroft $cnt--; 2164a3bb97a7SAndy Whitcroft } 2165a3bb97a7SAndy Whitcroft $ln++; 2166c45dcabdSAndy Whitcroft $off = 0; 2167c45dcabdSAndy Whitcroft } 2168c45dcabdSAndy Whitcroft $rest =~ s/\\\n.//g; 2169c45dcabdSAndy Whitcroft $rest =~ s/^\s*//s; 2170c45dcabdSAndy Whitcroft $rest =~ s/\s*$//s; 2171c45dcabdSAndy Whitcroft 2172c45dcabdSAndy Whitcroft # Clean up the original statement. 2173c45dcabdSAndy Whitcroft if ($args) { 2174c45dcabdSAndy Whitcroft substr($dstat, 0, length($dcond), ''); 2175d8aaf121SAndy Whitcroft } else { 2176c45dcabdSAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2177c45dcabdSAndy Whitcroft } 2178292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2179c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2180c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2181c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2182c45dcabdSAndy Whitcroft 2183c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2184bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2185bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2186bf30d6edSAndy Whitcroft $dstat =~ s/\[[^\{\}]*\]/1/) 2187bf30d6edSAndy Whitcroft { 2188c45dcabdSAndy Whitcroft } 2189c45dcabdSAndy Whitcroft 2190c45dcabdSAndy Whitcroft my $exceptions = qr{ 2191c45dcabdSAndy Whitcroft $Declare| 2192c45dcabdSAndy Whitcroft module_param_named| 2193c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2194c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2195c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2196383099fdSAndy Whitcroft __typeof__\(| 2197383099fdSAndy Whitcroft \.$Ident\s*=\s* 2198c45dcabdSAndy Whitcroft }x; 2199383099fdSAndy Whitcroft #print "REST<$rest> dstat<$dstat>\n"; 2200c45dcabdSAndy Whitcroft if ($rest ne '') { 2201c45dcabdSAndy Whitcroft if ($rest !~ /while\s*\(/ && 2202c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/) 2203c45dcabdSAndy Whitcroft { 2204c45dcabdSAndy Whitcroft ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2205c45dcabdSAndy Whitcroft } 2206c45dcabdSAndy Whitcroft 2207c45dcabdSAndy Whitcroft } elsif ($ctx !~ /;/) { 2208c45dcabdSAndy Whitcroft if ($dstat ne '' && 2209c45dcabdSAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2210c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/ && 2211b132e5d5SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && 2212c45dcabdSAndy Whitcroft $dstat =~ /$Operators/) 2213c45dcabdSAndy Whitcroft { 2214de7d4f0eSAndy Whitcroft ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2215d8aaf121SAndy Whitcroft } 22160a920b5bSAndy Whitcroft } 2217653d4876SAndy Whitcroft } 22180a920b5bSAndy Whitcroft 2219f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 222013214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 222113214adfSAndy Whitcroft my ($level, $endln, @chunks) = 2222cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 222313214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2224cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 2225cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 222613214adfSAndy Whitcroft my $allowed = 0; 222713214adfSAndy Whitcroft my $seen = 0; 2228773647a0SAndy Whitcroft my $herectx = $here . "\n"; 2229cf655043SAndy Whitcroft my $ln = $linenr - 1; 223013214adfSAndy Whitcroft for my $chunk (@chunks) { 223113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 223213214adfSAndy Whitcroft 2233773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 2234773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2235773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 2236773647a0SAndy Whitcroft 2237773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2238773647a0SAndy Whitcroft 2239773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 2240773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 2241773647a0SAndy Whitcroft 2242773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2243cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 2244cf655043SAndy Whitcroft 2245773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 224613214adfSAndy Whitcroft 224713214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 224813214adfSAndy Whitcroft 2249cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 2250cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2251cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 225213214adfSAndy Whitcroft $allowed = 1; 225313214adfSAndy Whitcroft } 225413214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2255cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 225613214adfSAndy Whitcroft $allowed = 1; 225713214adfSAndy Whitcroft } 2258cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2259cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 226013214adfSAndy Whitcroft $allowed = 1; 226113214adfSAndy Whitcroft } 226213214adfSAndy Whitcroft } 226313214adfSAndy Whitcroft if ($seen && !$allowed) { 2264cf655043SAndy Whitcroft WARN("braces {} are not necessary for any arm of this statement\n" . $herectx); 226513214adfSAndy Whitcroft } 226613214adfSAndy Whitcroft } 226713214adfSAndy Whitcroft } 2268773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 226913214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 2270cf655043SAndy Whitcroft my $allowed = 0; 2271f0a594c1SAndy Whitcroft 2272cf655043SAndy Whitcroft # Check the pre-context. 2273cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2274cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 2275cf655043SAndy Whitcroft $allowed = 1; 2276f0a594c1SAndy Whitcroft } 2277773647a0SAndy Whitcroft 2278773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 2279773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 2280773647a0SAndy Whitcroft 2281cf655043SAndy Whitcroft # Check the condition. 2282cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 2283773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 2284cf655043SAndy Whitcroft if (defined $cond) { 2285773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2286cf655043SAndy Whitcroft } 2287cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2288cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 2289cf655043SAndy Whitcroft $allowed = 1; 2290cf655043SAndy Whitcroft } 2291cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2292cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 2293cf655043SAndy Whitcroft $allowed = 1; 2294cf655043SAndy Whitcroft } 2295cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2296cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 2297cf655043SAndy Whitcroft $allowed = 1; 2298cf655043SAndy Whitcroft } 2299cf655043SAndy Whitcroft # Check the post-context. 2300cf655043SAndy Whitcroft if (defined $chunks[1]) { 2301cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 2302cf655043SAndy Whitcroft if (defined $cond) { 2303773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2304cf655043SAndy Whitcroft } 2305cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 2306cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 2307cf655043SAndy Whitcroft $allowed = 1; 2308cf655043SAndy Whitcroft } 2309cf655043SAndy Whitcroft } 2310cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 2311cf655043SAndy Whitcroft my $herectx = $here . "\n";; 2312f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 2313cf655043SAndy Whitcroft 2314f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 2315f055663cSAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n";; 2316cf655043SAndy Whitcroft } 2317cf655043SAndy Whitcroft 2318cf655043SAndy Whitcroft WARN("braces {} are not necessary for single statement blocks\n" . $herectx); 2319f0a594c1SAndy Whitcroft } 2320f0a594c1SAndy Whitcroft } 2321f0a594c1SAndy Whitcroft 2322653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 23234a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 2324c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 2325de7d4f0eSAndy Whitcroft ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 23260a920b5bSAndy Whitcroft } 23270a920b5bSAndy Whitcroft } 23280a920b5bSAndy Whitcroft 23294a0df2efSAndy Whitcroft# don't use deprecated functions 23304a0df2efSAndy Whitcroft for my $func (@dep_functions) { 233100df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 2332de7d4f0eSAndy Whitcroft ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 23334a0df2efSAndy Whitcroft } 23344a0df2efSAndy Whitcroft } 23354a0df2efSAndy Whitcroft 23364a0df2efSAndy Whitcroft# no volatiles please 23376c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 23386c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 2339de7d4f0eSAndy Whitcroft WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 23404a0df2efSAndy Whitcroft } 23414a0df2efSAndy Whitcroft 23429c0ca6f9SAndy Whitcroft# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated 23439c0ca6f9SAndy Whitcroft if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { 23449c0ca6f9SAndy Whitcroft ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr); 23459c0ca6f9SAndy Whitcroft } 23469c0ca6f9SAndy Whitcroft 234700df344fSAndy Whitcroft# warn about #if 0 2348c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2349de7d4f0eSAndy Whitcroft CHK("if this code is redundant consider removing it\n" . 2350de7d4f0eSAndy Whitcroft $herecurr); 23514a0df2efSAndy Whitcroft } 23524a0df2efSAndy Whitcroft 2353f0a594c1SAndy Whitcroft# check for needless kfree() checks 2354f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 2355f0a594c1SAndy Whitcroft my $expr = $1; 2356f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 23573c232147SWolfram Sang WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev); 2358f0a594c1SAndy Whitcroft } 2359f0a594c1SAndy Whitcroft } 23604c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 23614c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 23624c432a8fSGreg Kroah-Hartman my $expr = $1; 23634c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 23644c432a8fSGreg Kroah-Hartman WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 23654c432a8fSGreg Kroah-Hartman } 23664c432a8fSGreg Kroah-Hartman } 2367f0a594c1SAndy Whitcroft 236800df344fSAndy Whitcroft# warn about #ifdefs in C files 2369c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 237000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 237100df344fSAndy Whitcroft# print "$herecurr"; 237200df344fSAndy Whitcroft# $clean = 0; 237300df344fSAndy Whitcroft# } 237400df344fSAndy Whitcroft 237522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 2376c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 237722f2a2efSAndy Whitcroft ERROR("exactly one space required after that #$1\n" . $herecurr); 237822f2a2efSAndy Whitcroft } 237922f2a2efSAndy Whitcroft 23804a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 2381171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 2382171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 23834a0df2efSAndy Whitcroft my $which = $1; 23844a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2385de7d4f0eSAndy Whitcroft CHK("$1 definition without comment\n" . $herecurr); 23864a0df2efSAndy Whitcroft } 23874a0df2efSAndy Whitcroft } 23884a0df2efSAndy Whitcroft# check for memory barriers without a comment. 23894a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 23904a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2391de7d4f0eSAndy Whitcroft CHK("memory barrier without comment\n" . $herecurr); 23924a0df2efSAndy Whitcroft } 23934a0df2efSAndy Whitcroft } 23944a0df2efSAndy Whitcroft# check of hardware specific defines 2395c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 2396de7d4f0eSAndy Whitcroft CHK("architecture specific defines should be avoided\n" . $herecurr); 23970a920b5bSAndy Whitcroft } 2398653d4876SAndy Whitcroft 2399de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 2400de7d4f0eSAndy Whitcroft# storage class and type. 24019c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 24029c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 2403de7d4f0eSAndy Whitcroft ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 2404de7d4f0eSAndy Whitcroft } 2405de7d4f0eSAndy Whitcroft 24068905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 24078905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 24088905a67cSAndy Whitcroft WARN("plain inline is preferred over $1\n" . $herecurr); 24098905a67cSAndy Whitcroft } 24108905a67cSAndy Whitcroft 2411de7d4f0eSAndy Whitcroft# check for new externs in .c files. 2412171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 2413c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 2414171ae1a4SAndy Whitcroft { 2415c45dcabdSAndy Whitcroft my $function_name = $1; 2416c45dcabdSAndy Whitcroft my $paren_space = $2; 2417171ae1a4SAndy Whitcroft 2418171ae1a4SAndy Whitcroft my $s = $stat; 2419171ae1a4SAndy Whitcroft if (defined $cond) { 2420171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 2421171ae1a4SAndy Whitcroft } 2422c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 2423c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 2424c45dcabdSAndy Whitcroft { 2425de7d4f0eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2426de7d4f0eSAndy Whitcroft } 2427de7d4f0eSAndy Whitcroft 2428171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 2429171ae1a4SAndy Whitcroft WARN("arguments for function declarations should follow identifier\n" . $herecurr); 2430171ae1a4SAndy Whitcroft } 24319c9ba34eSAndy Whitcroft 24329c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 24339c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 24349c9ba34eSAndy Whitcroft { 24359c9ba34eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2436171ae1a4SAndy Whitcroft } 2437171ae1a4SAndy Whitcroft 2438de7d4f0eSAndy Whitcroft# checks for new __setup's 2439de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 2440de7d4f0eSAndy Whitcroft my $name = $1; 2441de7d4f0eSAndy Whitcroft 2442de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 2443de7d4f0eSAndy Whitcroft CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 2444de7d4f0eSAndy Whitcroft } 2445653d4876SAndy Whitcroft } 24469c0ca6f9SAndy Whitcroft 24479c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 24489c0ca6f9SAndy Whitcroft if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { 24499c0ca6f9SAndy Whitcroft WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 24509c0ca6f9SAndy Whitcroft } 245113214adfSAndy Whitcroft 245213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 245313214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 245413214adfSAndy Whitcroft WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 245513214adfSAndy Whitcroft } 2456773647a0SAndy Whitcroft 2457773647a0SAndy Whitcroft# check for semaphores used as mutexes 2458171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) { 2459773647a0SAndy Whitcroft WARN("mutexes are preferred for single holder semaphores\n" . $herecurr); 2460773647a0SAndy Whitcroft } 2461773647a0SAndy Whitcroft# check for semaphores used as mutexes 2462171ae1a4SAndy Whitcroft if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) { 2463773647a0SAndy Whitcroft WARN("consider using a completion\n" . $herecurr); 2464773647a0SAndy Whitcroft } 2465773647a0SAndy Whitcroft# recommend strict_strto* over simple_strto* 2466773647a0SAndy Whitcroft if ($line =~ /\bsimple_(strto.*?)\s*\(/) { 2467773647a0SAndy Whitcroft WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr); 2468773647a0SAndy Whitcroft } 2469f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 2470f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 2471f3db6639SMichael Ellerman WARN("please use device_initcall() instead of __initcall()\n" . $herecurr); 2472f3db6639SMichael Ellerman } 2473773647a0SAndy Whitcroft 2474773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 2475773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 2476773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 2477c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 2478c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 2479171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 2480171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 2481171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 2482773647a0SAndy Whitcroft { 2483773647a0SAndy Whitcroft WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 2484773647a0SAndy Whitcroft } 24859c9ba34eSAndy Whitcroft 24869c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 24879c9ba34eSAndy Whitcroft my $string; 24889c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 24899c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 24902a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 24919c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 24929c9ba34eSAndy Whitcroft WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 24939c9ba34eSAndy Whitcroft last; 24949c9ba34eSAndy Whitcroft } 24959c9ba34eSAndy Whitcroft } 2496691d77b6SAndy Whitcroft 2497691d77b6SAndy Whitcroft# whine mightly about in_atomic 2498691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 2499691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 2500691d77b6SAndy Whitcroft ERROR("do not use in_atomic in drivers\n" . $herecurr); 2501691d77b6SAndy Whitcroft } else { 2502691d77b6SAndy Whitcroft WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 2503691d77b6SAndy Whitcroft } 2504691d77b6SAndy Whitcroft } 250513214adfSAndy Whitcroft } 250613214adfSAndy Whitcroft 250713214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 250813214adfSAndy Whitcroft # so just keep quiet. 250913214adfSAndy Whitcroft if ($#rawlines == -1) { 251013214adfSAndy Whitcroft exit(0); 25110a920b5bSAndy Whitcroft } 25120a920b5bSAndy Whitcroft 25138905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 25148905a67cSAndy Whitcroft # things that appear to be patches. 25158905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 25168905a67cSAndy Whitcroft exit(0); 25178905a67cSAndy Whitcroft } 25188905a67cSAndy Whitcroft 25198905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 25208905a67cSAndy Whitcroft # just keep quiet. 25218905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 25228905a67cSAndy Whitcroft exit(0); 25238905a67cSAndy Whitcroft } 25248905a67cSAndy Whitcroft 25258905a67cSAndy Whitcroft if (!$is_patch) { 2526de7d4f0eSAndy Whitcroft ERROR("Does not appear to be a unified-diff format patch\n"); 25270a920b5bSAndy Whitcroft } 25280a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 2529de7d4f0eSAndy Whitcroft ERROR("Missing Signed-off-by: line(s)\n"); 25300a920b5bSAndy Whitcroft } 25310a920b5bSAndy Whitcroft 2532f0a594c1SAndy Whitcroft print report_dump(); 253313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 253413214adfSAndy Whitcroft print "$filename " if ($summary_file); 25356c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 25366c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 25376c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 25388905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 25396c72ffaaSAndy Whitcroft } 25408905a67cSAndy Whitcroft 25410a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 2542c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 25430a920b5bSAndy Whitcroft } 25440a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 2545c2fdda0dSAndy Whitcroft print "$vname has style problems, please review. If any of these errors\n"; 25460a920b5bSAndy Whitcroft print "are false positives report them to the maintainer, see\n"; 25470a920b5bSAndy Whitcroft print "CHECKPATCH in MAINTAINERS.\n"; 25480a920b5bSAndy Whitcroft } 254913214adfSAndy Whitcroft 25500a920b5bSAndy Whitcroft return $clean; 25510a920b5bSAndy Whitcroft} 2552