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) 4*2a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5*2a5a2c25SAndy Whitcroft# (c) 2008, Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftmy $P = $0; 1100df344fSAndy Whitcroft$P =~ s@.*/@@g; 120a920b5bSAndy Whitcroft 1350a7dcfbSAndy Whitcroftmy $V = '0.25'; 140a920b5bSAndy Whitcroft 150a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 160a920b5bSAndy Whitcroft 170a920b5bSAndy Whitcroftmy $quiet = 0; 180a920b5bSAndy Whitcroftmy $tree = 1; 190a920b5bSAndy Whitcroftmy $chk_signoff = 1; 200a920b5bSAndy Whitcroftmy $chk_patch = 1; 21773647a0SAndy Whitcroftmy $tst_only; 226c72ffaaSAndy Whitcroftmy $emacs = 0; 238905a67cSAndy Whitcroftmy $terse = 0; 246c72ffaaSAndy Whitcroftmy $file = 0; 256c72ffaaSAndy Whitcroftmy $check = 0; 268905a67cSAndy Whitcroftmy $summary = 1; 278905a67cSAndy Whitcroftmy $mailback = 0; 2813214adfSAndy Whitcroftmy $summary_file = 0; 296c72ffaaSAndy Whitcroftmy $root; 30c2fdda0dSAndy Whitcroftmy %debug; 310a920b5bSAndy WhitcroftGetOptions( 326c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 330a920b5bSAndy Whitcroft 'tree!' => \$tree, 340a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 350a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 366c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 378905a67cSAndy Whitcroft 'terse!' => \$terse, 386c72ffaaSAndy Whitcroft 'file!' => \$file, 396c72ffaaSAndy Whitcroft 'subjective!' => \$check, 406c72ffaaSAndy Whitcroft 'strict!' => \$check, 416c72ffaaSAndy Whitcroft 'root=s' => \$root, 428905a67cSAndy Whitcroft 'summary!' => \$summary, 438905a67cSAndy Whitcroft 'mailback!' => \$mailback, 4413214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 4513214adfSAndy Whitcroft 46c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 47773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 480a920b5bSAndy Whitcroft) or exit; 490a920b5bSAndy Whitcroft 500a920b5bSAndy Whitcroftmy $exit = 0; 510a920b5bSAndy Whitcroft 520a920b5bSAndy Whitcroftif ($#ARGV < 0) { 5300df344fSAndy Whitcroft print "usage: $P [options] patchfile\n"; 540a920b5bSAndy Whitcroft print "version: $V\n"; 550a920b5bSAndy Whitcroft print "options: -q => quiet\n"; 560a920b5bSAndy Whitcroft print " --no-tree => run without a kernel tree\n"; 578905a67cSAndy Whitcroft print " --terse => one line per report\n"; 586c72ffaaSAndy Whitcroft print " --emacs => emacs compile window format\n"; 596c72ffaaSAndy Whitcroft print " --file => check a source file\n"; 606c72ffaaSAndy Whitcroft print " --strict => enable more subjective tests\n"; 616c72ffaaSAndy Whitcroft print " --root => path to the kernel tree root\n"; 6213214adfSAndy Whitcroft print " --no-summary => suppress the per-file summary\n"; 6313214adfSAndy Whitcroft print " --summary-file => include the filename in summary\n"; 640a920b5bSAndy Whitcroft exit(1); 650a920b5bSAndy Whitcroft} 660a920b5bSAndy Whitcroft 67c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 68c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 697429c690SAndy Whitcroftmy $dbg_type = 0; 70a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 71c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 72c2fdda0dSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';" 73c2fdda0dSAndy Whitcroft} 74c2fdda0dSAndy Whitcroft 758905a67cSAndy Whitcroftif ($terse) { 768905a67cSAndy Whitcroft $emacs = 1; 778905a67cSAndy Whitcroft $quiet++; 788905a67cSAndy Whitcroft} 798905a67cSAndy Whitcroft 806c72ffaaSAndy Whitcroftif ($tree) { 816c72ffaaSAndy Whitcroft if (defined $root) { 826c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 836c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 846c72ffaaSAndy Whitcroft } 856c72ffaaSAndy Whitcroft } else { 866c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 876c72ffaaSAndy Whitcroft $root = '.'; 886c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 896c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 906c72ffaaSAndy Whitcroft $root = $1; 916c72ffaaSAndy Whitcroft } 926c72ffaaSAndy Whitcroft } 936c72ffaaSAndy Whitcroft 946c72ffaaSAndy Whitcroft if (!defined $root) { 950a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 960a920b5bSAndy Whitcroft exit(2); 970a920b5bSAndy Whitcroft } 986c72ffaaSAndy Whitcroft} 996c72ffaaSAndy Whitcroft 1006c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1016c72ffaaSAndy Whitcroft 1026c72ffaaSAndy Whitcroftour $Ident = qr{[A-Za-z_][A-Za-z\d_]*}; 1036c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1046c72ffaaSAndy Whitcroftour $Sparse = qr{ 1056c72ffaaSAndy Whitcroft __user| 1066c72ffaaSAndy Whitcroft __kernel| 1076c72ffaaSAndy Whitcroft __force| 1086c72ffaaSAndy Whitcroft __iomem| 1096c72ffaaSAndy Whitcroft __must_check| 1106c72ffaaSAndy Whitcroft __init_refok| 111cf655043SAndy Whitcroft __kprobes 1126c72ffaaSAndy Whitcroft }x; 1136c72ffaaSAndy Whitcroftour $Attribute = qr{ 1146c72ffaaSAndy Whitcroft const| 1156c72ffaaSAndy Whitcroft __read_mostly| 1166c72ffaaSAndy Whitcroft __kprobes| 11724e1d81aSAndy Whitcroft __(?:mem|cpu|dev|)(?:initdata|init)| 11824e1d81aSAndy Whitcroft ____cacheline_aligned| 11924e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 1205fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 1215fe3af11SAndy Whitcroft __weak 1226c72ffaaSAndy Whitcroft }x; 123c45dcabdSAndy Whitcroftour $Modifier; 1246c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 1256c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 1266c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 1276c72ffaaSAndy Whitcroft 1286c72ffaaSAndy Whitcroftour $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 1296c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 1306c72ffaaSAndy Whitcroftour $Operators = qr{ 1316c72ffaaSAndy Whitcroft <=|>=|==|!=| 1326c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 133c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 1346c72ffaaSAndy Whitcroft }x; 1356c72ffaaSAndy Whitcroft 1368905a67cSAndy Whitcroftour $NonptrType; 1378905a67cSAndy Whitcroftour $Type; 1388905a67cSAndy Whitcroftour $Declare; 1398905a67cSAndy Whitcroft 140171ae1a4SAndy Whitcroftour $UTF8 = qr { 141171ae1a4SAndy Whitcroft [\x09\x0A\x0D\x20-\x7E] # ASCII 142171ae1a4SAndy Whitcroft | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 143171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 144171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 145171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 146171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 147171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 148171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 149171ae1a4SAndy Whitcroft}x; 150171ae1a4SAndy Whitcroft 1518ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 1528ed22cadSAndy Whitcroft (?:__)?(?:u|s|be|le)(?:\d|\d\d)| 1538ed22cadSAndy Whitcroft atomic_t 1548ed22cadSAndy Whitcroft)}; 1558ed22cadSAndy Whitcroft 1568905a67cSAndy Whitcroftour @typeList = ( 1578905a67cSAndy Whitcroft qr{void}, 158c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 159c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 160c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 161c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 162c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 163c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 164c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 1658905a67cSAndy Whitcroft qr{unsigned}, 1668905a67cSAndy Whitcroft qr{float}, 1678905a67cSAndy Whitcroft qr{double}, 1688905a67cSAndy Whitcroft qr{bool}, 1698905a67cSAndy Whitcroft qr{struct\s+$Ident}, 1708905a67cSAndy Whitcroft qr{union\s+$Ident}, 1718905a67cSAndy Whitcroft qr{enum\s+$Ident}, 1728905a67cSAndy Whitcroft qr{${Ident}_t}, 1738905a67cSAndy Whitcroft qr{${Ident}_handler}, 1748905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 1758905a67cSAndy Whitcroft); 176c45dcabdSAndy Whitcroftour @modifierList = ( 177c45dcabdSAndy Whitcroft qr{fastcall}, 178c45dcabdSAndy Whitcroft); 1798905a67cSAndy Whitcroft 1808905a67cSAndy Whitcroftsub build_types { 181d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 182d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 183c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1848905a67cSAndy Whitcroft $NonptrType = qr{ 185d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 186cf655043SAndy Whitcroft (?: 187c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 1888ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 189c45dcabdSAndy Whitcroft (?:${all}\b) 190cf655043SAndy Whitcroft ) 191c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 1928905a67cSAndy Whitcroft }x; 1938905a67cSAndy Whitcroft $Type = qr{ 194c45dcabdSAndy Whitcroft $NonptrType 19565863862SAndy Whitcroft (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 196c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 1978905a67cSAndy Whitcroft }x; 1988905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 1998905a67cSAndy Whitcroft} 2008905a67cSAndy Whitcroftbuild_types(); 2016c72ffaaSAndy Whitcroft 2026c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 2030a920b5bSAndy Whitcroft 2044a0df2efSAndy Whitcroftmy @dep_includes = (); 2054a0df2efSAndy Whitcroftmy @dep_functions = (); 2066c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 2076c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 2086c72ffaaSAndy Whitcroft open(REMOVE, "<$root/$removal") || 2096c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 2100a920b5bSAndy Whitcroft while (<REMOVE>) { 211f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 212f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 213f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 2144a0df2efSAndy Whitcroft push(@dep_includes, $1); 2154a0df2efSAndy Whitcroft 216f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 217f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 218f0a594c1SAndy Whitcroft } 2194a0df2efSAndy Whitcroft } 2200a920b5bSAndy Whitcroft } 2210a920b5bSAndy Whitcroft } 2220a920b5bSAndy Whitcroft} 2230a920b5bSAndy Whitcroft 22400df344fSAndy Whitcroftmy @rawlines = (); 225c2fdda0dSAndy Whitcroftmy @lines = (); 226c2fdda0dSAndy Whitcroftmy $vname; 2276c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 2286c72ffaaSAndy Whitcroft if ($file) { 2296c72ffaaSAndy Whitcroft open(FILE, "diff -u /dev/null $filename|") || 2306c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 2316c72ffaaSAndy Whitcroft } else { 2326c72ffaaSAndy Whitcroft open(FILE, "<$filename") || 2336c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 2346c72ffaaSAndy Whitcroft } 235c2fdda0dSAndy Whitcroft if ($filename eq '-') { 236c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 237c2fdda0dSAndy Whitcroft } else { 238c2fdda0dSAndy Whitcroft $vname = $filename; 239c2fdda0dSAndy Whitcroft } 2406c72ffaaSAndy Whitcroft while (<FILE>) { 2410a920b5bSAndy Whitcroft chomp; 24200df344fSAndy Whitcroft push(@rawlines, $_); 2436c72ffaaSAndy Whitcroft } 2446c72ffaaSAndy Whitcroft close(FILE); 245c2fdda0dSAndy Whitcroft if (!process($filename)) { 2460a920b5bSAndy Whitcroft $exit = 1; 2470a920b5bSAndy Whitcroft } 24800df344fSAndy Whitcroft @rawlines = (); 24913214adfSAndy Whitcroft @lines = (); 2500a920b5bSAndy Whitcroft} 2510a920b5bSAndy Whitcroft 2520a920b5bSAndy Whitcroftexit($exit); 2530a920b5bSAndy Whitcroft 2540a920b5bSAndy Whitcroftsub top_of_kernel_tree { 2556c72ffaaSAndy Whitcroft my ($root) = @_; 2566c72ffaaSAndy Whitcroft 2576c72ffaaSAndy Whitcroft my @tree_check = ( 2586c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 2596c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 2606c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 2616c72ffaaSAndy Whitcroft ); 2626c72ffaaSAndy Whitcroft 2636c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 2646c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 2650a920b5bSAndy Whitcroft return 0; 2660a920b5bSAndy Whitcroft } 2676c72ffaaSAndy Whitcroft } 2686c72ffaaSAndy Whitcroft return 1; 2696c72ffaaSAndy Whitcroft} 2700a920b5bSAndy Whitcroft 2710a920b5bSAndy Whitcroftsub expand_tabs { 2720a920b5bSAndy Whitcroft my ($str) = @_; 2730a920b5bSAndy Whitcroft 2740a920b5bSAndy Whitcroft my $res = ''; 2750a920b5bSAndy Whitcroft my $n = 0; 2760a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 2770a920b5bSAndy Whitcroft if ($c eq "\t") { 2780a920b5bSAndy Whitcroft $res .= ' '; 2790a920b5bSAndy Whitcroft $n++; 2800a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 2810a920b5bSAndy Whitcroft $res .= ' '; 2820a920b5bSAndy Whitcroft } 2830a920b5bSAndy Whitcroft next; 2840a920b5bSAndy Whitcroft } 2850a920b5bSAndy Whitcroft $res .= $c; 2860a920b5bSAndy Whitcroft $n++; 2870a920b5bSAndy Whitcroft } 2880a920b5bSAndy Whitcroft 2890a920b5bSAndy Whitcroft return $res; 2900a920b5bSAndy Whitcroft} 2916c72ffaaSAndy Whitcroftsub copy_spacing { 292773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 2936c72ffaaSAndy Whitcroft return $res; 2946c72ffaaSAndy Whitcroft} 2950a920b5bSAndy Whitcroft 2964a0df2efSAndy Whitcroftsub line_stats { 2974a0df2efSAndy Whitcroft my ($line) = @_; 2984a0df2efSAndy Whitcroft 2994a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 3004a0df2efSAndy Whitcroft $line =~ s/^.//; 3014a0df2efSAndy Whitcroft $line = expand_tabs($line); 3024a0df2efSAndy Whitcroft 3034a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 3044a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 3054a0df2efSAndy Whitcroft 3064a0df2efSAndy Whitcroft return (length($line), length($white)); 3074a0df2efSAndy Whitcroft} 3084a0df2efSAndy Whitcroft 309773647a0SAndy Whitcroftmy $sanitise_quote = ''; 310773647a0SAndy Whitcroft 311773647a0SAndy Whitcroftsub sanitise_line_reset { 312773647a0SAndy Whitcroft my ($in_comment) = @_; 313773647a0SAndy Whitcroft 314773647a0SAndy Whitcroft if ($in_comment) { 315773647a0SAndy Whitcroft $sanitise_quote = '*/'; 316773647a0SAndy Whitcroft } else { 317773647a0SAndy Whitcroft $sanitise_quote = ''; 318773647a0SAndy Whitcroft } 319773647a0SAndy Whitcroft} 32000df344fSAndy Whitcroftsub sanitise_line { 32100df344fSAndy Whitcroft my ($line) = @_; 32200df344fSAndy Whitcroft 32300df344fSAndy Whitcroft my $res = ''; 32400df344fSAndy Whitcroft my $l = ''; 32500df344fSAndy Whitcroft 326c2fdda0dSAndy Whitcroft my $qlen = 0; 327773647a0SAndy Whitcroft my $off = 0; 328773647a0SAndy Whitcroft my $c; 32900df344fSAndy Whitcroft 330773647a0SAndy Whitcroft # Always copy over the diff marker. 331773647a0SAndy Whitcroft $res = substr($line, 0, 1); 332773647a0SAndy Whitcroft 333773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 334773647a0SAndy Whitcroft $c = substr($line, $off, 1); 335773647a0SAndy Whitcroft 336773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 337773647a0SAndy Whitcroft # and end, all to $;. 338773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 339773647a0SAndy Whitcroft $sanitise_quote = '*/'; 340773647a0SAndy Whitcroft 341773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 342773647a0SAndy Whitcroft $off++; 34300df344fSAndy Whitcroft next; 344773647a0SAndy Whitcroft } 34581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 346773647a0SAndy Whitcroft $sanitise_quote = ''; 347773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 348773647a0SAndy Whitcroft $off++; 349773647a0SAndy Whitcroft next; 350773647a0SAndy Whitcroft } 351773647a0SAndy Whitcroft 352773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 353773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 354773647a0SAndy Whitcroft $c eq "\\") { 355773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 356773647a0SAndy Whitcroft $off++; 357773647a0SAndy Whitcroft next; 358773647a0SAndy Whitcroft } 359773647a0SAndy Whitcroft # Regular quotes. 360773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 361773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 362773647a0SAndy Whitcroft $sanitise_quote = $c; 363773647a0SAndy Whitcroft 364773647a0SAndy Whitcroft substr($res, $off, 1, $c); 365773647a0SAndy Whitcroft next; 366773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 367773647a0SAndy Whitcroft $sanitise_quote = ''; 36800df344fSAndy Whitcroft } 36900df344fSAndy Whitcroft } 370773647a0SAndy Whitcroft 371fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 372773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 373773647a0SAndy Whitcroft substr($res, $off, 1, $;); 374773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 375773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 37600df344fSAndy Whitcroft } else { 377773647a0SAndy Whitcroft substr($res, $off, 1, $c); 37800df344fSAndy Whitcroft } 379c2fdda0dSAndy Whitcroft } 380c2fdda0dSAndy Whitcroft 381c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 382c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 383c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 384c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 385c2fdda0dSAndy Whitcroft 386c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 387c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 388c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 389c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 390c2fdda0dSAndy Whitcroft } 391c2fdda0dSAndy Whitcroft 39200df344fSAndy Whitcroft return $res; 39300df344fSAndy Whitcroft} 39400df344fSAndy Whitcroft 3958905a67cSAndy Whitcroftsub ctx_statement_block { 3968905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 3978905a67cSAndy Whitcroft my $line = $linenr - 1; 3988905a67cSAndy Whitcroft my $blk = ''; 3998905a67cSAndy Whitcroft my $soff = $off; 4008905a67cSAndy Whitcroft my $coff = $off - 1; 401773647a0SAndy Whitcroft my $coff_set = 0; 4028905a67cSAndy Whitcroft 40313214adfSAndy Whitcroft my $loff = 0; 40413214adfSAndy Whitcroft 4058905a67cSAndy Whitcroft my $type = ''; 4068905a67cSAndy Whitcroft my $level = 0; 407cf655043SAndy Whitcroft my $p; 4088905a67cSAndy Whitcroft my $c; 4098905a67cSAndy Whitcroft my $len = 0; 41013214adfSAndy Whitcroft 41113214adfSAndy Whitcroft my $remainder; 4128905a67cSAndy Whitcroft while (1) { 413773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 4148905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 4158905a67cSAndy Whitcroft # context. 4168905a67cSAndy Whitcroft if ($off >= $len) { 4178905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 418dea33496SAndy Whitcroft last if (!defined $lines[$line]); 419c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 4208905a67cSAndy Whitcroft $remain--; 42113214adfSAndy Whitcroft $loff = $len; 422c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 4238905a67cSAndy Whitcroft $len = length($blk); 4248905a67cSAndy Whitcroft $line++; 4258905a67cSAndy Whitcroft last; 4268905a67cSAndy Whitcroft } 4278905a67cSAndy Whitcroft # Bail if there is no further context. 4288905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 42913214adfSAndy Whitcroft if ($off >= $len) { 4308905a67cSAndy Whitcroft last; 4318905a67cSAndy Whitcroft } 4328905a67cSAndy Whitcroft } 433cf655043SAndy Whitcroft $p = $c; 4348905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 43513214adfSAndy Whitcroft $remainder = substr($blk, $off); 4368905a67cSAndy Whitcroft 437773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 4388905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 4398905a67cSAndy Whitcroft # outermost level. 4408905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 4418905a67cSAndy Whitcroft last; 4428905a67cSAndy Whitcroft } 4438905a67cSAndy Whitcroft 44413214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 445773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 446773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 447773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 448773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 449773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 450773647a0SAndy Whitcroft $coff_set = 1; 451773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 452773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 45313214adfSAndy Whitcroft } 45413214adfSAndy Whitcroft 4558905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 4568905a67cSAndy Whitcroft $level++; 4578905a67cSAndy Whitcroft $type = '('; 4588905a67cSAndy Whitcroft } 4598905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 4608905a67cSAndy Whitcroft $level--; 4618905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 4628905a67cSAndy Whitcroft 4638905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 4648905a67cSAndy Whitcroft $coff = $off; 465773647a0SAndy Whitcroft $coff_set = 1; 466773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 4678905a67cSAndy Whitcroft } 4688905a67cSAndy Whitcroft } 4698905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 4708905a67cSAndy Whitcroft $level++; 4718905a67cSAndy Whitcroft $type = '{'; 4728905a67cSAndy Whitcroft } 4738905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 4748905a67cSAndy Whitcroft $level--; 4758905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 4768905a67cSAndy Whitcroft 4778905a67cSAndy Whitcroft if ($level == 0) { 4788905a67cSAndy Whitcroft last; 4798905a67cSAndy Whitcroft } 4808905a67cSAndy Whitcroft } 4818905a67cSAndy Whitcroft $off++; 4828905a67cSAndy Whitcroft } 483a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 48413214adfSAndy Whitcroft if ($off == $len) { 485a3bb97a7SAndy Whitcroft $loff = $len + 1; 48613214adfSAndy Whitcroft $line++; 48713214adfSAndy Whitcroft $remain--; 48813214adfSAndy Whitcroft } 4898905a67cSAndy Whitcroft 4908905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 4918905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 4928905a67cSAndy Whitcroft 4938905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 4948905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 4958905a67cSAndy Whitcroft 496773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 49713214adfSAndy Whitcroft 49813214adfSAndy Whitcroft return ($statement, $condition, 49913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 50013214adfSAndy Whitcroft} 50113214adfSAndy Whitcroft 502cf655043SAndy Whitcroftsub statement_lines { 503cf655043SAndy Whitcroft my ($stmt) = @_; 504cf655043SAndy Whitcroft 505cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 506cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 507cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 508cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 509cf655043SAndy Whitcroft 510cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 511cf655043SAndy Whitcroft 512cf655043SAndy Whitcroft return $#stmt_lines + 2; 513cf655043SAndy Whitcroft} 514cf655043SAndy Whitcroft 515cf655043SAndy Whitcroftsub statement_rawlines { 516cf655043SAndy Whitcroft my ($stmt) = @_; 517cf655043SAndy Whitcroft 518cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 519cf655043SAndy Whitcroft 520cf655043SAndy Whitcroft return $#stmt_lines + 2; 521cf655043SAndy Whitcroft} 522cf655043SAndy Whitcroft 523cf655043SAndy Whitcroftsub statement_block_size { 524cf655043SAndy Whitcroft my ($stmt) = @_; 525cf655043SAndy Whitcroft 526cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 527cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 528cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 529cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 530cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 531cf655043SAndy Whitcroft 532cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 533cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 534cf655043SAndy Whitcroft 535cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 536cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 537cf655043SAndy Whitcroft 538cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 539cf655043SAndy Whitcroft return $stmt_lines; 540cf655043SAndy Whitcroft } else { 541cf655043SAndy Whitcroft return $stmt_statements; 542cf655043SAndy Whitcroft } 543cf655043SAndy Whitcroft} 544cf655043SAndy Whitcroft 54513214adfSAndy Whitcroftsub ctx_statement_full { 54613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 54713214adfSAndy Whitcroft my ($statement, $condition, $level); 54813214adfSAndy Whitcroft 54913214adfSAndy Whitcroft my (@chunks); 55013214adfSAndy Whitcroft 551cf655043SAndy Whitcroft # Grab the first conditional/block pair. 55213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 55313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 554773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 55513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 556cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 557cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 558cf655043SAndy Whitcroft } 559cf655043SAndy Whitcroft 560cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 561cf655043SAndy Whitcroft # could continue the statement. 562cf655043SAndy Whitcroft for (;;) { 56313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 56413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 565cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 566773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 567cf655043SAndy Whitcroft #print "C: push\n"; 568cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 56913214adfSAndy Whitcroft } 57013214adfSAndy Whitcroft 57113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 5728905a67cSAndy Whitcroft} 5738905a67cSAndy Whitcroft 5744a0df2efSAndy Whitcroftsub ctx_block_get { 575f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 5764a0df2efSAndy Whitcroft my $line; 5774a0df2efSAndy Whitcroft my $start = $linenr - 1; 5784a0df2efSAndy Whitcroft my $blk = ''; 5794a0df2efSAndy Whitcroft my @o; 5804a0df2efSAndy Whitcroft my @c; 5814a0df2efSAndy Whitcroft my @res = (); 5824a0df2efSAndy Whitcroft 583f0a594c1SAndy Whitcroft my $level = 0; 58400df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 58500df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 58600df344fSAndy Whitcroft $remain--; 58700df344fSAndy Whitcroft 58800df344fSAndy Whitcroft $blk .= $rawlines[$line]; 589f0a594c1SAndy Whitcroft foreach my $c (split(//, $rawlines[$line])) { 590f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 591f0a594c1SAndy Whitcroft if ($off > 0) { 592f0a594c1SAndy Whitcroft $off--; 593f0a594c1SAndy Whitcroft next; 594f0a594c1SAndy Whitcroft } 5954a0df2efSAndy Whitcroft 596f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 597f0a594c1SAndy Whitcroft $level--; 598f0a594c1SAndy Whitcroft last if ($level == 0); 599f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 600f0a594c1SAndy Whitcroft $level++; 601f0a594c1SAndy Whitcroft } 602f0a594c1SAndy Whitcroft } 6034a0df2efSAndy Whitcroft 604f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 60500df344fSAndy Whitcroft push(@res, $rawlines[$line]); 6064a0df2efSAndy Whitcroft } 6074a0df2efSAndy Whitcroft 608f0a594c1SAndy Whitcroft last if ($level == 0); 6094a0df2efSAndy Whitcroft } 6104a0df2efSAndy Whitcroft 611f0a594c1SAndy Whitcroft return ($level, @res); 6124a0df2efSAndy Whitcroft} 6134a0df2efSAndy Whitcroftsub ctx_block_outer { 6144a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6154a0df2efSAndy Whitcroft 616f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 617f0a594c1SAndy Whitcroft return @r; 6184a0df2efSAndy Whitcroft} 6194a0df2efSAndy Whitcroftsub ctx_block { 6204a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6214a0df2efSAndy Whitcroft 622f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 623f0a594c1SAndy Whitcroft return @r; 624653d4876SAndy Whitcroft} 625653d4876SAndy Whitcroftsub ctx_statement { 626f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 627f0a594c1SAndy Whitcroft 628f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 629f0a594c1SAndy Whitcroft return @r; 630f0a594c1SAndy Whitcroft} 631f0a594c1SAndy Whitcroftsub ctx_block_level { 632653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 633653d4876SAndy Whitcroft 634f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 6354a0df2efSAndy Whitcroft} 6369c0ca6f9SAndy Whitcroftsub ctx_statement_level { 6379c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 6389c0ca6f9SAndy Whitcroft 6399c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 6409c0ca6f9SAndy Whitcroft} 6414a0df2efSAndy Whitcroft 6424a0df2efSAndy Whitcroftsub ctx_locate_comment { 6434a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6444a0df2efSAndy Whitcroft 6454a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 646beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 6474a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 6484a0df2efSAndy Whitcroft 6494a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 6504a0df2efSAndy Whitcroft # comment. 6514a0df2efSAndy Whitcroft my $in_comment = 0; 6524a0df2efSAndy Whitcroft $current_comment = ''; 6534a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 65400df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 65500df344fSAndy Whitcroft #warn " $line\n"; 6564a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 6574a0df2efSAndy Whitcroft $in_comment = 1; 6584a0df2efSAndy Whitcroft } 6594a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 6604a0df2efSAndy Whitcroft $in_comment = 1; 6614a0df2efSAndy Whitcroft } 6624a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 6634a0df2efSAndy Whitcroft $current_comment = ''; 6644a0df2efSAndy Whitcroft } 6654a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 6664a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 6674a0df2efSAndy Whitcroft $in_comment = 0; 6684a0df2efSAndy Whitcroft } 6694a0df2efSAndy Whitcroft } 6704a0df2efSAndy Whitcroft 6714a0df2efSAndy Whitcroft chomp($current_comment); 6724a0df2efSAndy Whitcroft return($current_comment); 6734a0df2efSAndy Whitcroft} 6744a0df2efSAndy Whitcroftsub ctx_has_comment { 6754a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6764a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 6774a0df2efSAndy Whitcroft 67800df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 6794a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 6804a0df2efSAndy Whitcroft 6814a0df2efSAndy Whitcroft return ($cmt ne ''); 6824a0df2efSAndy Whitcroft} 6834a0df2efSAndy Whitcroft 6844d001e4dSAndy Whitcroftsub raw_line { 6854d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 6864d001e4dSAndy Whitcroft 6874d001e4dSAndy Whitcroft my $offset = $linenr - 1; 6884d001e4dSAndy Whitcroft $cnt++; 6894d001e4dSAndy Whitcroft 6904d001e4dSAndy Whitcroft my $line; 6914d001e4dSAndy Whitcroft while ($cnt) { 6924d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 6934d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 6944d001e4dSAndy Whitcroft $cnt--; 6954d001e4dSAndy Whitcroft } 6964d001e4dSAndy Whitcroft 6974d001e4dSAndy Whitcroft return $line; 6984d001e4dSAndy Whitcroft} 6994d001e4dSAndy Whitcroft 7000a920b5bSAndy Whitcroftsub cat_vet { 7010a920b5bSAndy Whitcroft my ($vet) = @_; 7029c0ca6f9SAndy Whitcroft my ($res, $coded); 7030a920b5bSAndy Whitcroft 7049c0ca6f9SAndy Whitcroft $res = ''; 7056c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 7066c72ffaaSAndy Whitcroft $res .= $1; 7076c72ffaaSAndy Whitcroft if ($2 ne '') { 7089c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 7096c72ffaaSAndy Whitcroft $res .= $coded; 7106c72ffaaSAndy Whitcroft } 7119c0ca6f9SAndy Whitcroft } 7129c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 7130a920b5bSAndy Whitcroft 7149c0ca6f9SAndy Whitcroft return $res; 7150a920b5bSAndy Whitcroft} 7160a920b5bSAndy Whitcroft 717c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 718cf655043SAndy Whitcroftmy $av_pending; 719c2fdda0dSAndy Whitcroftmy @av_paren_type; 7201f65f947SAndy Whitcroftmy $av_pend_colon; 721c2fdda0dSAndy Whitcroft 722c2fdda0dSAndy Whitcroftsub annotate_reset { 723c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 724cf655043SAndy Whitcroft $av_pending = '_'; 725cf655043SAndy Whitcroft @av_paren_type = ('E'); 7261f65f947SAndy Whitcroft $av_pend_colon = 'O'; 727c2fdda0dSAndy Whitcroft} 728c2fdda0dSAndy Whitcroft 7296c72ffaaSAndy Whitcroftsub annotate_values { 7306c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 7316c72ffaaSAndy Whitcroft 7326c72ffaaSAndy Whitcroft my $res; 7331f65f947SAndy Whitcroft my $var = '_' x length($stream); 7346c72ffaaSAndy Whitcroft my $cur = $stream; 7356c72ffaaSAndy Whitcroft 736c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 7376c72ffaaSAndy Whitcroft 7386c72ffaaSAndy Whitcroft while (length($cur)) { 739773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 740cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 741171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 7426c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 743c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 744c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 745cf655043SAndy Whitcroft $type = pop(@av_paren_type); 746c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 7476c72ffaaSAndy Whitcroft } 7486c72ffaaSAndy Whitcroft 7498ea3eb9aSAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) { 750c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 7516c72ffaaSAndy Whitcroft $type = 'T'; 7526c72ffaaSAndy Whitcroft 753389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 754389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 755389a2fe5SAndy Whitcroft $type = 'T'; 756389a2fe5SAndy Whitcroft 757c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 758171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 759c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 760171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 761171ae1a4SAndy Whitcroft if ($2 ne '') { 762cf655043SAndy Whitcroft $av_pending = 'N'; 763171ae1a4SAndy Whitcroft } 764171ae1a4SAndy Whitcroft $type = 'E'; 765171ae1a4SAndy Whitcroft 766c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 767171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 768171ae1a4SAndy Whitcroft $av_preprocessor = 1; 769171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 7706c72ffaaSAndy Whitcroft 771c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 772cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 773c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 774cf655043SAndy Whitcroft 775cf655043SAndy Whitcroft push(@av_paren_type, $type); 776cf655043SAndy Whitcroft push(@av_paren_type, $type); 777171ae1a4SAndy Whitcroft $type = 'E'; 778cf655043SAndy Whitcroft 779c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 780cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 781cf655043SAndy Whitcroft $av_preprocessor = 1; 782cf655043SAndy Whitcroft 783cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 784cf655043SAndy Whitcroft 785171ae1a4SAndy Whitcroft $type = 'E'; 786cf655043SAndy Whitcroft 787c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 788cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 789cf655043SAndy Whitcroft 790cf655043SAndy Whitcroft $av_preprocessor = 1; 791cf655043SAndy Whitcroft 792cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 793cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 794cf655043SAndy Whitcroft pop(@av_paren_type); 795cf655043SAndy Whitcroft push(@av_paren_type, $type); 796171ae1a4SAndy Whitcroft $type = 'E'; 7976c72ffaaSAndy Whitcroft 7986c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 799c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 8006c72ffaaSAndy Whitcroft 801171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 802171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 803171ae1a4SAndy Whitcroft $av_pending = $type; 804171ae1a4SAndy Whitcroft $type = 'N'; 805171ae1a4SAndy Whitcroft 8066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 807c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 8086c72ffaaSAndy Whitcroft if (defined $2) { 809cf655043SAndy Whitcroft $av_pending = 'V'; 8106c72ffaaSAndy Whitcroft } 8116c72ffaaSAndy Whitcroft $type = 'N'; 8126c72ffaaSAndy Whitcroft 81314b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 814c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 81514b111c1SAndy Whitcroft $av_pending = 'E'; 8166c72ffaaSAndy Whitcroft $type = 'N'; 8176c72ffaaSAndy Whitcroft 8181f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 8191f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 8201f65f947SAndy Whitcroft $av_pend_colon = 'C'; 8211f65f947SAndy Whitcroft $type = 'N'; 8221f65f947SAndy Whitcroft 82314b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 824c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 8256c72ffaaSAndy Whitcroft $type = 'N'; 8266c72ffaaSAndy Whitcroft 8276c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 828c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 829cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 830cf655043SAndy Whitcroft $av_pending = '_'; 8316c72ffaaSAndy Whitcroft $type = 'N'; 8326c72ffaaSAndy Whitcroft 8336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 834cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 835cf655043SAndy Whitcroft if ($new_type ne '_') { 836cf655043SAndy Whitcroft $type = $new_type; 837c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 838c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 8396c72ffaaSAndy Whitcroft } else { 840c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 8416c72ffaaSAndy Whitcroft } 8426c72ffaaSAndy Whitcroft 843c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 844c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 845c8cb2ca3SAndy Whitcroft $type = 'V'; 846cf655043SAndy Whitcroft $av_pending = 'V'; 8476c72ffaaSAndy Whitcroft 8488e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 8498e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 8501f65f947SAndy Whitcroft $av_pend_colon = 'B'; 8518e761b04SAndy Whitcroft } elsif ($type eq 'E') { 8528e761b04SAndy Whitcroft $av_pend_colon = 'L'; 8531f65f947SAndy Whitcroft } 8541f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 8551f65f947SAndy Whitcroft $type = 'V'; 8561f65f947SAndy Whitcroft 8576c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 858c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 8596c72ffaaSAndy Whitcroft $type = 'V'; 8606c72ffaaSAndy Whitcroft 8616c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 862c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 8636c72ffaaSAndy Whitcroft $type = 'N'; 8646c72ffaaSAndy Whitcroft 865cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 866c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 86713214adfSAndy Whitcroft $type = 'E'; 8681f65f947SAndy Whitcroft $av_pend_colon = 'O'; 86913214adfSAndy Whitcroft 8708e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 8718e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 8728e761b04SAndy Whitcroft $type = 'C'; 8738e761b04SAndy Whitcroft 8741f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 8751f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 8761f65f947SAndy Whitcroft $type = 'N'; 8771f65f947SAndy Whitcroft 8781f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 8791f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 8801f65f947SAndy Whitcroft 8811f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 8821f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 8831f65f947SAndy Whitcroft $type = 'E'; 8841f65f947SAndy Whitcroft } else { 8851f65f947SAndy Whitcroft $type = 'N'; 8861f65f947SAndy Whitcroft } 8871f65f947SAndy Whitcroft $av_pend_colon = 'O'; 8881f65f947SAndy Whitcroft 8898e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 89013214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 8916c72ffaaSAndy Whitcroft $type = 'N'; 8926c72ffaaSAndy Whitcroft 8930d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 89474048ed8SAndy Whitcroft my $variant; 89574048ed8SAndy Whitcroft 89674048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 89774048ed8SAndy Whitcroft if ($type eq 'V') { 89874048ed8SAndy Whitcroft $variant = 'B'; 89974048ed8SAndy Whitcroft } else { 90074048ed8SAndy Whitcroft $variant = 'U'; 90174048ed8SAndy Whitcroft } 90274048ed8SAndy Whitcroft 90374048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 90474048ed8SAndy Whitcroft $type = 'N'; 90574048ed8SAndy Whitcroft 9066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 907c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 9086c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 9096c72ffaaSAndy Whitcroft $type = 'N'; 9106c72ffaaSAndy Whitcroft } 9116c72ffaaSAndy Whitcroft 9126c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 913c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 9146c72ffaaSAndy Whitcroft } 9156c72ffaaSAndy Whitcroft if (defined $1) { 9166c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 9176c72ffaaSAndy Whitcroft $res .= $type x length($1); 9186c72ffaaSAndy Whitcroft } 9196c72ffaaSAndy Whitcroft } 9206c72ffaaSAndy Whitcroft 9211f65f947SAndy Whitcroft return ($res, $var); 9226c72ffaaSAndy Whitcroft} 9236c72ffaaSAndy Whitcroft 9248905a67cSAndy Whitcroftsub possible { 92513214adfSAndy Whitcroft my ($possible, $line) = @_; 9268905a67cSAndy Whitcroft 9270776e594SAndy Whitcroft print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 9280776e594SAndy Whitcroft if ($possible !~ /(?: 9290776e594SAndy Whitcroft ^(?: 9300776e594SAndy Whitcroft $Modifier| 9310776e594SAndy Whitcroft $Storage| 9320776e594SAndy Whitcroft $Type| 9330776e594SAndy Whitcroft DEFINE_\S+| 9340776e594SAndy Whitcroft goto| 9350776e594SAndy Whitcroft return| 9360776e594SAndy Whitcroft case| 9370776e594SAndy Whitcroft else| 9380776e594SAndy Whitcroft asm|__asm__| 9390776e594SAndy Whitcroft do 9400776e594SAndy Whitcroft )$| 9410776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 9420776e594SAndy Whitcroft )/x) { 943c45dcabdSAndy Whitcroft # Check for modifiers. 944c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 945c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 946c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 947c45dcabdSAndy Whitcroft 948c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 949c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 950d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 951d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 952d2506586SAndy Whitcroft push(@modifierList, $modifier); 953d2506586SAndy Whitcroft } 954c45dcabdSAndy Whitcroft 955c45dcabdSAndy Whitcroft } else { 95613214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 9578905a67cSAndy Whitcroft push(@typeList, $possible); 958c45dcabdSAndy Whitcroft } 9598905a67cSAndy Whitcroft build_types(); 9600776e594SAndy Whitcroft } else { 9610776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 9628905a67cSAndy Whitcroft } 9638905a67cSAndy Whitcroft} 9648905a67cSAndy Whitcroft 9656c72ffaaSAndy Whitcroftmy $prefix = ''; 9666c72ffaaSAndy Whitcroft 967f0a594c1SAndy Whitcroftsub report { 968773647a0SAndy Whitcroft if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) { 969773647a0SAndy Whitcroft return 0; 970773647a0SAndy Whitcroft } 9718905a67cSAndy Whitcroft my $line = $prefix . $_[0]; 9728905a67cSAndy Whitcroft 9738905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 9748905a67cSAndy Whitcroft 97513214adfSAndy Whitcroft push(our @report, $line); 976773647a0SAndy Whitcroft 977773647a0SAndy Whitcroft return 1; 978f0a594c1SAndy Whitcroft} 979f0a594c1SAndy Whitcroftsub report_dump { 98013214adfSAndy Whitcroft our @report; 981f0a594c1SAndy Whitcroft} 982de7d4f0eSAndy Whitcroftsub ERROR { 983773647a0SAndy Whitcroft if (report("ERROR: $_[0]\n")) { 984de7d4f0eSAndy Whitcroft our $clean = 0; 9856c72ffaaSAndy Whitcroft our $cnt_error++; 986de7d4f0eSAndy Whitcroft } 987773647a0SAndy Whitcroft} 988de7d4f0eSAndy Whitcroftsub WARN { 989773647a0SAndy Whitcroft if (report("WARNING: $_[0]\n")) { 990de7d4f0eSAndy Whitcroft our $clean = 0; 9916c72ffaaSAndy Whitcroft our $cnt_warn++; 992de7d4f0eSAndy Whitcroft } 993773647a0SAndy Whitcroft} 994de7d4f0eSAndy Whitcroftsub CHK { 995773647a0SAndy Whitcroft if ($check && report("CHECK: $_[0]\n")) { 996de7d4f0eSAndy Whitcroft our $clean = 0; 9976c72ffaaSAndy Whitcroft our $cnt_chk++; 9986c72ffaaSAndy Whitcroft } 999de7d4f0eSAndy Whitcroft} 1000de7d4f0eSAndy Whitcroft 10016ecd9674SAndy Whitcroftsub check_absolute_file { 10026ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 10036ecd9674SAndy Whitcroft my $file = $absolute; 10046ecd9674SAndy Whitcroft 10056ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 10066ecd9674SAndy Whitcroft 10076ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 10086ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 10096ecd9674SAndy Whitcroft if (-f "$root/$file") { 10106ecd9674SAndy Whitcroft ##print "file<$file>\n"; 10116ecd9674SAndy Whitcroft last; 10126ecd9674SAndy Whitcroft } 10136ecd9674SAndy Whitcroft } 10146ecd9674SAndy Whitcroft if (! -f _) { 10156ecd9674SAndy Whitcroft return 0; 10166ecd9674SAndy Whitcroft } 10176ecd9674SAndy Whitcroft 10186ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 10196ecd9674SAndy Whitcroft my $prefix = $absolute; 10206ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 10216ecd9674SAndy Whitcroft 10226ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 10236ecd9674SAndy Whitcroft if ($prefix ne ".../") { 10246ecd9674SAndy Whitcroft WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr); 10256ecd9674SAndy Whitcroft } 10266ecd9674SAndy Whitcroft} 10276ecd9674SAndy Whitcroft 10280a920b5bSAndy Whitcroftsub process { 10290a920b5bSAndy Whitcroft my $filename = shift; 10300a920b5bSAndy Whitcroft 10310a920b5bSAndy Whitcroft my $linenr=0; 10320a920b5bSAndy Whitcroft my $prevline=""; 1033c2fdda0dSAndy Whitcroft my $prevrawline=""; 10340a920b5bSAndy Whitcroft my $stashline=""; 1035c2fdda0dSAndy Whitcroft my $stashrawline=""; 10360a920b5bSAndy Whitcroft 10374a0df2efSAndy Whitcroft my $length; 10380a920b5bSAndy Whitcroft my $indent; 10390a920b5bSAndy Whitcroft my $previndent=0; 10400a920b5bSAndy Whitcroft my $stashindent=0; 10410a920b5bSAndy Whitcroft 1042de7d4f0eSAndy Whitcroft our $clean = 1; 10430a920b5bSAndy Whitcroft my $signoff = 0; 10440a920b5bSAndy Whitcroft my $is_patch = 0; 10450a920b5bSAndy Whitcroft 104613214adfSAndy Whitcroft our @report = (); 10476c72ffaaSAndy Whitcroft our $cnt_lines = 0; 10486c72ffaaSAndy Whitcroft our $cnt_error = 0; 10496c72ffaaSAndy Whitcroft our $cnt_warn = 0; 10506c72ffaaSAndy Whitcroft our $cnt_chk = 0; 10516c72ffaaSAndy Whitcroft 10520a920b5bSAndy Whitcroft # Trace the real file/line as we go. 10530a920b5bSAndy Whitcroft my $realfile = ''; 10540a920b5bSAndy Whitcroft my $realline = 0; 10550a920b5bSAndy Whitcroft my $realcnt = 0; 10560a920b5bSAndy Whitcroft my $here = ''; 10570a920b5bSAndy Whitcroft my $in_comment = 0; 1058c2fdda0dSAndy Whitcroft my $comment_edge = 0; 10590a920b5bSAndy Whitcroft my $first_line = 0; 10600a920b5bSAndy Whitcroft 106113214adfSAndy Whitcroft my $prev_values = 'E'; 106213214adfSAndy Whitcroft 106313214adfSAndy Whitcroft # suppression flags 1064773647a0SAndy Whitcroft my %suppress_ifbraces; 1065170d3a22SAndy Whitcroft my %suppress_whiletrailers; 1066653d4876SAndy Whitcroft 1067c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1068de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1069c2fdda0dSAndy Whitcroft # 1070de7d4f0eSAndy Whitcroft my @setup_docs = (); 1071de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1072773647a0SAndy Whitcroft 1073773647a0SAndy Whitcroft sanitise_line_reset(); 1074c2fdda0dSAndy Whitcroft my $line; 1075c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1076773647a0SAndy Whitcroft $linenr++; 1077773647a0SAndy Whitcroft $line = $rawline; 1078c2fdda0dSAndy Whitcroft 1079773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1080de7d4f0eSAndy Whitcroft $setup_docs = 0; 1081de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1082de7d4f0eSAndy Whitcroft $setup_docs = 1; 1083de7d4f0eSAndy Whitcroft } 1084773647a0SAndy Whitcroft #next; 1085de7d4f0eSAndy Whitcroft } 1086773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1087773647a0SAndy Whitcroft $realline=$1-1; 1088773647a0SAndy Whitcroft if (defined $2) { 1089773647a0SAndy Whitcroft $realcnt=$3+1; 1090773647a0SAndy Whitcroft } else { 1091773647a0SAndy Whitcroft $realcnt=1+1; 1092773647a0SAndy Whitcroft } 1093c45dcabdSAndy Whitcroft $in_comment = 0; 1094773647a0SAndy Whitcroft 1095773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1096773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1097773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1098773647a0SAndy Whitcroft # at context start. 1099773647a0SAndy Whitcroft my $edge; 110001fa9147SAndy Whitcroft my $cnt = $realcnt; 110101fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 110201fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 110301fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 110401fa9147SAndy Whitcroft $cnt--; 110501fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1106721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1107fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1108fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1109fae17daeSAndy Whitcroft ($edge) = $1; 1110fae17daeSAndy Whitcroft last; 1111fae17daeSAndy Whitcroft } 1112773647a0SAndy Whitcroft } 1113773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1114773647a0SAndy Whitcroft $in_comment = 1; 1115773647a0SAndy Whitcroft } 1116773647a0SAndy Whitcroft 1117773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1118773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1119773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1120773647a0SAndy Whitcroft if (!defined $edge && 112183242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1122773647a0SAndy Whitcroft { 1123773647a0SAndy Whitcroft $in_comment = 1; 1124773647a0SAndy Whitcroft } 1125773647a0SAndy Whitcroft 1126773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1127773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1128773647a0SAndy Whitcroft 1129171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1130773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1131171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1132773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1133773647a0SAndy Whitcroft } 1134773647a0SAndy Whitcroft push(@lines, $line); 1135773647a0SAndy Whitcroft 1136773647a0SAndy Whitcroft if ($realcnt > 1) { 1137773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1138773647a0SAndy Whitcroft } else { 1139773647a0SAndy Whitcroft $realcnt = 0; 1140773647a0SAndy Whitcroft } 1141773647a0SAndy Whitcroft 1142773647a0SAndy Whitcroft #print "==>$rawline\n"; 1143773647a0SAndy Whitcroft #print "-->$line\n"; 1144de7d4f0eSAndy Whitcroft 1145de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1146de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1147de7d4f0eSAndy Whitcroft } 1148de7d4f0eSAndy Whitcroft } 1149de7d4f0eSAndy Whitcroft 11506c72ffaaSAndy Whitcroft $prefix = ''; 11516c72ffaaSAndy Whitcroft 1152773647a0SAndy Whitcroft $realcnt = 0; 1153773647a0SAndy Whitcroft $linenr = 0; 11540a920b5bSAndy Whitcroft foreach my $line (@lines) { 11550a920b5bSAndy Whitcroft $linenr++; 11560a920b5bSAndy Whitcroft 1157c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 115830670854SAndy Whitcroft my $hunk_line = ($realcnt != 0); 11596c72ffaaSAndy Whitcroft 11600a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 11616c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 11620a920b5bSAndy Whitcroft $is_patch = 1; 11634a0df2efSAndy Whitcroft $first_line = $linenr + 1; 11640a920b5bSAndy Whitcroft $realline=$1-1; 11650a920b5bSAndy Whitcroft if (defined $2) { 11660a920b5bSAndy Whitcroft $realcnt=$3+1; 11670a920b5bSAndy Whitcroft } else { 11680a920b5bSAndy Whitcroft $realcnt=1+1; 11690a920b5bSAndy Whitcroft } 1170c2fdda0dSAndy Whitcroft annotate_reset(); 117113214adfSAndy Whitcroft $prev_values = 'E'; 117213214adfSAndy Whitcroft 1173773647a0SAndy Whitcroft %suppress_ifbraces = (); 1174170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 11750a920b5bSAndy Whitcroft next; 11760a920b5bSAndy Whitcroft 11774a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 11784a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 11794a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1180773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 11810a920b5bSAndy Whitcroft $realline++; 1182d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 11830a920b5bSAndy Whitcroft 11844a0df2efSAndy Whitcroft # Measure the line length and indent. 1185c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 11860a920b5bSAndy Whitcroft 11870a920b5bSAndy Whitcroft # Track the previous line. 11880a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 11890a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1190c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1191c2fdda0dSAndy Whitcroft 1192773647a0SAndy Whitcroft #warn "line<$line>\n"; 11936c72ffaaSAndy Whitcroft 1194d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1195d8aaf121SAndy Whitcroft $realcnt--; 11960a920b5bSAndy Whitcroft } 11970a920b5bSAndy Whitcroft 11980a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1199773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1200773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1201773647a0SAndy Whitcroft 12026c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 12036c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1204773647a0SAndy Whitcroft 1205773647a0SAndy Whitcroft # extract the filename as it passes 1206773647a0SAndy Whitcroft if ($line=~/^\+\+\+\s+(\S+)/) { 1207773647a0SAndy Whitcroft $realfile = $1; 1208773647a0SAndy Whitcroft $realfile =~ s@^[^/]*/@@; 1209773647a0SAndy Whitcroft 1210c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1211773647a0SAndy Whitcroft ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1212773647a0SAndy Whitcroft } 1213773647a0SAndy Whitcroft next; 1214773647a0SAndy Whitcroft } 1215773647a0SAndy Whitcroft 1216389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 12170a920b5bSAndy Whitcroft 1218c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1219c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1220c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 12210a920b5bSAndy Whitcroft 12226c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 12236c72ffaaSAndy Whitcroft 12240a920b5bSAndy Whitcroft#check the patch for a signoff: 1225d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 12264a0df2efSAndy Whitcroft # This is a signoff, if ugly, so do not double report. 12274a0df2efSAndy Whitcroft $signoff++; 12280a920b5bSAndy Whitcroft if (!($line =~ /^\s*Signed-off-by:/)) { 1229de7d4f0eSAndy Whitcroft WARN("Signed-off-by: is the preferred form\n" . 1230de7d4f0eSAndy Whitcroft $herecurr); 12310a920b5bSAndy Whitcroft } 12320a920b5bSAndy Whitcroft if ($line =~ /^\s*signed-off-by:\S/i) { 1233773647a0SAndy Whitcroft WARN("space required after Signed-off-by:\n" . 1234de7d4f0eSAndy Whitcroft $herecurr); 12350a920b5bSAndy Whitcroft } 12360a920b5bSAndy Whitcroft } 12370a920b5bSAndy Whitcroft 123800df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 12398905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1240de7d4f0eSAndy Whitcroft ERROR("patch seems to be corrupt (line wrapped?)\n" . 12416c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1242de7d4f0eSAndy Whitcroft } 1243de7d4f0eSAndy Whitcroft 12446ecd9674SAndy Whitcroft# Check for absolute kernel paths. 12456ecd9674SAndy Whitcroft if ($tree) { 12466ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 12476ecd9674SAndy Whitcroft my $file = $1; 12486ecd9674SAndy Whitcroft 12496ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 12506ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 12516ecd9674SAndy Whitcroft # 12526ecd9674SAndy Whitcroft } else { 12536ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 12546ecd9674SAndy Whitcroft } 12556ecd9674SAndy Whitcroft } 12566ecd9674SAndy Whitcroft } 12576ecd9674SAndy Whitcroft 1258de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1259de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1260171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1261171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1262171ae1a4SAndy Whitcroft 1263171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1264171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1265171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1266171ae1a4SAndy Whitcroft 1267171ae1a4SAndy Whitcroft ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 126800df344fSAndy Whitcroft } 12690a920b5bSAndy Whitcroft 127030670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 127130670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 127200df344fSAndy Whitcroft 12730a920b5bSAndy Whitcroft#trailing whitespace 12749c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1275c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 12769c0ca6f9SAndy Whitcroft ERROR("DOS line endings\n" . $herevet); 12779c0ca6f9SAndy Whitcroft 1278c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1279c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1280de7d4f0eSAndy Whitcroft ERROR("trailing whitespace\n" . $herevet); 12810a920b5bSAndy Whitcroft } 12825368df20SAndy Whitcroft 12835368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 12845368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 12855368df20SAndy Whitcroft 12860a920b5bSAndy Whitcroft#80 column limit 1287c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1288f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 1289f4c014c0SAndy Whitcroft $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ && 1290f4c014c0SAndy Whitcroft $length > 80) 1291c45dcabdSAndy Whitcroft { 1292de7d4f0eSAndy Whitcroft WARN("line over 80 characters\n" . $herecurr); 12930a920b5bSAndy Whitcroft } 12940a920b5bSAndy Whitcroft 12958905a67cSAndy Whitcroft# check for adding lines without a newline. 12968905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 12978905a67cSAndy Whitcroft WARN("adding a line without newline at end of file\n" . $herecurr); 12988905a67cSAndy Whitcroft } 12998905a67cSAndy Whitcroft 1300b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1301b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 13020a920b5bSAndy Whitcroft 13030a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 13040a920b5bSAndy Whitcroft# more than 8 must use tabs. 1305c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1306c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1307c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1308171ae1a4SAndy Whitcroft ERROR("code indent should use tabs where possible\n" . $herevet); 13090a920b5bSAndy Whitcroft } 13100a920b5bSAndy Whitcroft 1311b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1312b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1313b9ea10d6SAndy Whitcroft 1314c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1315cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1316c2fdda0dSAndy Whitcroft WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1317c2fdda0dSAndy Whitcroft } 131822f2a2efSAndy Whitcroft 13199c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 1320170d3a22SAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next); 13219c9ba34eSAndy Whitcroft if ($realcnt && $line =~ /.\s*\S/) { 1322170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1323f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1324171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1325171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1326171ae1a4SAndy Whitcroft 1327171ae1a4SAndy Whitcroft my $s = $stat; 1328171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1329cf655043SAndy Whitcroft 1330c2fdda0dSAndy Whitcroft # Ignore goto labels. 1331171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1332c2fdda0dSAndy Whitcroft 1333c2fdda0dSAndy Whitcroft # Ignore functions being called 1334171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1335c2fdda0dSAndy Whitcroft 1336c45dcabdSAndy Whitcroft # declarations always start with types 1337d2506586SAndy 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) { 1338c45dcabdSAndy Whitcroft my $type = $1; 1339c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1340c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1341c45dcabdSAndy Whitcroft 13426c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1343a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1344c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1345c2fdda0dSAndy Whitcroft } 13468905a67cSAndy Whitcroft 13476c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 134865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1349c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 13509c0ca6f9SAndy Whitcroft } 13518905a67cSAndy Whitcroft 13528905a67cSAndy Whitcroft # Check for any sort of function declaration. 13538905a67cSAndy Whitcroft # int foo(something bar, other baz); 13548905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1355171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 13568905a67cSAndy Whitcroft my ($name_len) = length($1); 13578905a67cSAndy Whitcroft 1358cf655043SAndy Whitcroft my $ctx = $s; 1359773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 13608905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1361cf655043SAndy Whitcroft 13628905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1363c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 13648905a67cSAndy Whitcroft 1365c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 13668905a67cSAndy Whitcroft } 13678905a67cSAndy Whitcroft } 13688905a67cSAndy Whitcroft } 13698905a67cSAndy Whitcroft 13709c0ca6f9SAndy Whitcroft } 13719c0ca6f9SAndy Whitcroft 137200df344fSAndy Whitcroft# 137300df344fSAndy Whitcroft# Checks which may be anchored in the context. 137400df344fSAndy Whitcroft# 137500df344fSAndy Whitcroft 137600df344fSAndy Whitcroft# Check for switch () and associated case and default 137700df344fSAndy Whitcroft# statements should be at the same indent. 137800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 137900df344fSAndy Whitcroft my $err = ''; 138000df344fSAndy Whitcroft my $sep = ''; 138100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 138200df344fSAndy Whitcroft shift(@ctx); 138300df344fSAndy Whitcroft for my $ctx (@ctx) { 138400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 138500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 138600df344fSAndy Whitcroft $indent != $cindent) { 138700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 138800df344fSAndy Whitcroft $sep = ''; 138900df344fSAndy Whitcroft } else { 139000df344fSAndy Whitcroft $sep = "[...]\n"; 139100df344fSAndy Whitcroft } 139200df344fSAndy Whitcroft } 139300df344fSAndy Whitcroft if ($err ne '') { 13949c0ca6f9SAndy Whitcroft ERROR("switch and case should be at the same indent\n$hereline$err"); 1395de7d4f0eSAndy Whitcroft } 1396de7d4f0eSAndy Whitcroft } 1397de7d4f0eSAndy Whitcroft 1398de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1399de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1400c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1401773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1402773647a0SAndy Whitcroft 14039c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1404de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1405de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1406de7d4f0eSAndy Whitcroft 1407548596d5SAndy Whitcroft my $ctx_ln = $linenr; 1408548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 1409de7d4f0eSAndy Whitcroft 1410548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1411548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 1412548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 1413548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1414548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1415773647a0SAndy Whitcroft $ctx_ln++; 1416773647a0SAndy Whitcroft } 1417548596d5SAndy Whitcroft 141853210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 141953210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1420773647a0SAndy Whitcroft 1421773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1422773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . 1423c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 142400df344fSAndy Whitcroft } 1425773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1426773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1427773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1428773647a0SAndy Whitcroft { 14299c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 14309c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1431773647a0SAndy Whitcroft WARN("trailing semicolon indicates no statements, indent implies otherwise\n" . 1432c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 14339c0ca6f9SAndy Whitcroft } 14349c0ca6f9SAndy Whitcroft } 143500df344fSAndy Whitcroft } 143600df344fSAndy Whitcroft 14374d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 14384d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 14394d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 14404d001e4dSAndy Whitcroft 14414d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 14424d001e4dSAndy Whitcroft 14434d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 14444d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 14454d001e4dSAndy Whitcroft # where necessary. 14464d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 14474d001e4dSAndy Whitcroft 14484d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 14496f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 14506f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 14514d001e4dSAndy Whitcroft 14524d001e4dSAndy Whitcroft # We want to check the first line inside the block 14534d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 14544d001e4dSAndy Whitcroft # 1) any blank line termination 14554d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 14564d001e4dSAndy Whitcroft # 3) any do (...) { 14574d001e4dSAndy Whitcroft my $continuation = 0; 14584d001e4dSAndy Whitcroft my $check = 0; 14594d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 14604d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 14614d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 14624d001e4dSAndy Whitcroft $continuation = 1; 14634d001e4dSAndy Whitcroft } 14649bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 14654d001e4dSAndy Whitcroft $check = 1; 14664d001e4dSAndy Whitcroft $cond_lines++; 14674d001e4dSAndy Whitcroft } 14684d001e4dSAndy Whitcroft 14694d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 14704d001e4dSAndy Whitcroft # preprocessor statement. 14714d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 14724d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 14734d001e4dSAndy Whitcroft $check = 0; 14744d001e4dSAndy Whitcroft } 14754d001e4dSAndy Whitcroft 14769bd49efeSAndy Whitcroft my $cond_ptr = -1; 1477740504c6SAndy Whitcroft $continuation = 0; 14789bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 14799bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 14804d001e4dSAndy Whitcroft 1481f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 1482f16fa28fSAndy Whitcroft # is not linear. 1483f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1484f16fa28fSAndy Whitcroft $check = 0; 1485f16fa28fSAndy Whitcroft } 1486f16fa28fSAndy Whitcroft 14879bd49efeSAndy Whitcroft # Ignore: 14889bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 14899bd49efeSAndy Whitcroft # 2) preprocessor lines, and 14909bd49efeSAndy Whitcroft # 3) labels. 1491740504c6SAndy Whitcroft if ($continuation || 1492740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 14939bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 14949bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 1495740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 14969bd49efeSAndy Whitcroft $s =~ s/^.*?\n//; 14979bd49efeSAndy Whitcroft $cond_lines++; 14989bd49efeSAndy Whitcroft } 14994d001e4dSAndy Whitcroft } 15004d001e4dSAndy Whitcroft 15014d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 15024d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 15034d001e4dSAndy Whitcroft 15044d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 15054d001e4dSAndy Whitcroft # this is not this patch's fault. 15064d001e4dSAndy Whitcroft if (!defined($stat_real) || 15074d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 15084d001e4dSAndy Whitcroft $check = 0; 15094d001e4dSAndy Whitcroft } 15104d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 15114d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 15124d001e4dSAndy Whitcroft } 15134d001e4dSAndy Whitcroft 15149bd49efeSAndy 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"; 15154d001e4dSAndy Whitcroft 15164d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 15174d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 15184d001e4dSAndy Whitcroft WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 15194d001e4dSAndy Whitcroft } 15204d001e4dSAndy Whitcroft } 15214d001e4dSAndy Whitcroft 15226c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 15236c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 15241f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 15251f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 15266c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 1527c2fdda0dSAndy Whitcroft if ($dbg_values) { 1528c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 1529cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 1530cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 15311f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 1532c2fdda0dSAndy Whitcroft } 15336c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 15346c72ffaaSAndy Whitcroft 153500df344fSAndy Whitcroft#ignore lines not being added 153600df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 153700df344fSAndy Whitcroft 1538653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 15397429c690SAndy Whitcroft if ($dbg_type) { 15407429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 15417429c690SAndy Whitcroft ERROR("TEST: is type\n" . $herecurr); 15427429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 15437429c690SAndy Whitcroft ERROR("TEST: is not type ($1 is)\n". $herecurr); 15447429c690SAndy Whitcroft } 1545653d4876SAndy Whitcroft next; 1546653d4876SAndy Whitcroft } 1547a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 1548a1ef277eSAndy Whitcroft if ($dbg_attr) { 1549a1ef277eSAndy Whitcroft if ($line =~ /^.\s*$Attribute\s*$/) { 1550a1ef277eSAndy Whitcroft ERROR("TEST: is attr\n" . $herecurr); 1551a1ef277eSAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) { 1552a1ef277eSAndy Whitcroft ERROR("TEST: is not attr ($1 is)\n". $herecurr); 1553a1ef277eSAndy Whitcroft } 1554a1ef277eSAndy Whitcroft next; 1555a1ef277eSAndy Whitcroft } 1556653d4876SAndy Whitcroft 1557f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 1558f0a594c1SAndy Whitcroft if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ && 1559f0a594c1SAndy Whitcroft $line =~ /^.\s*{/) { 1560773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . $hereprev); 1561f0a594c1SAndy Whitcroft } 1562f0a594c1SAndy Whitcroft 156300df344fSAndy Whitcroft# 156400df344fSAndy Whitcroft# Checks which are anchored on the added line. 156500df344fSAndy Whitcroft# 156600df344fSAndy Whitcroft 1567653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 1568c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 1569653d4876SAndy Whitcroft my $path = $1; 1570653d4876SAndy Whitcroft if ($path =~ m{//}) { 1571de7d4f0eSAndy Whitcroft ERROR("malformed #include filename\n" . 1572de7d4f0eSAndy Whitcroft $herecurr); 1573653d4876SAndy Whitcroft } 1574653d4876SAndy Whitcroft } 1575653d4876SAndy Whitcroft 157600df344fSAndy Whitcroft# no C99 // comments 157700df344fSAndy Whitcroft if ($line =~ m{//}) { 1578de7d4f0eSAndy Whitcroft ERROR("do not use C99 // comments\n" . $herecurr); 157900df344fSAndy Whitcroft } 158000df344fSAndy Whitcroft # Remove C99 comments. 15810a920b5bSAndy Whitcroft $line =~ s@//.*@@; 15826c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 15830a920b5bSAndy Whitcroft 15840a920b5bSAndy Whitcroft#EXPORT_SYMBOL should immediately follow its function closing }. 1585653d4876SAndy Whitcroft if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) || 1586653d4876SAndy Whitcroft ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 1587653d4876SAndy Whitcroft my $name = $1; 158848012058SAndy Whitcroft if ($prevline !~ /(?: 158948012058SAndy Whitcroft ^.}| 159048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 159148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 159248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 159348012058SAndy Whitcroft ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 159448012058SAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[) 159548012058SAndy Whitcroft )/x) { 1596de7d4f0eSAndy Whitcroft WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 15970a920b5bSAndy Whitcroft } 15980a920b5bSAndy Whitcroft } 15990a920b5bSAndy Whitcroft 1600f0a594c1SAndy Whitcroft# check for external initialisers. 1601c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 1602f0a594c1SAndy Whitcroft ERROR("do not initialise externals to 0 or NULL\n" . 1603f0a594c1SAndy Whitcroft $herecurr); 1604f0a594c1SAndy Whitcroft } 16050a920b5bSAndy Whitcroft# check for static initialisers. 16069c9ba34eSAndy Whitcroft if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) { 1607de7d4f0eSAndy Whitcroft ERROR("do not initialise statics to 0 or NULL\n" . 1608de7d4f0eSAndy Whitcroft $herecurr); 16090a920b5bSAndy Whitcroft } 16100a920b5bSAndy Whitcroft 1611653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 1612653d4876SAndy Whitcroft# make sense. 1613653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 16149c0ca6f9SAndy Whitcroft $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ && 1615c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 16168ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 1617653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 1618de7d4f0eSAndy Whitcroft WARN("do not add new typedefs\n" . $herecurr); 16190a920b5bSAndy Whitcroft } 16200a920b5bSAndy Whitcroft 16210a920b5bSAndy Whitcroft# * goes on variable not on type 162265863862SAndy Whitcroft # (char*[ const]) 162365863862SAndy Whitcroft if ($line =~ m{\($NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)*)\)}) { 162465863862SAndy Whitcroft my ($from, $to) = ($1, $1); 1625d8aaf121SAndy Whitcroft 162665863862SAndy Whitcroft # Should start with a space. 162765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 162865863862SAndy Whitcroft # Should not end with a space. 162965863862SAndy Whitcroft $to =~ s/\s+$//; 163065863862SAndy Whitcroft # '*'s should not have spaces between. 163165863862SAndy Whitcroft while ($to =~ s/(.)\s\*/$1\*/) { 163265863862SAndy Whitcroft } 1633d8aaf121SAndy Whitcroft 163465863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 163565863862SAndy Whitcroft if ($from ne $to) { 163665863862SAndy Whitcroft ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 163765863862SAndy Whitcroft } 163865863862SAndy Whitcroft } elsif ($line =~ m{\b$NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)?)($Ident)}) { 163965863862SAndy Whitcroft my ($from, $to, $ident) = ($1, $1, $2); 1640d8aaf121SAndy Whitcroft 164165863862SAndy Whitcroft # Should start with a space. 164265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 164365863862SAndy Whitcroft # Should not end with a space. 164465863862SAndy Whitcroft $to =~ s/\s+$//; 164565863862SAndy Whitcroft # '*'s should not have spaces between. 164665863862SAndy Whitcroft while ($to =~ s/(.)\s\*/$1\*/) { 164765863862SAndy Whitcroft } 164865863862SAndy Whitcroft # Modifiers should have spaces. 164965863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 165065863862SAndy Whitcroft 165165863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 165265863862SAndy Whitcroft if ($from ne $to) { 165365863862SAndy Whitcroft ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 165465863862SAndy Whitcroft } 16550a920b5bSAndy Whitcroft } 16560a920b5bSAndy Whitcroft 16570a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 16580a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 16590a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 16600a920b5bSAndy Whitcroft# print "$herecurr"; 16610a920b5bSAndy Whitcroft# $clean = 0; 16620a920b5bSAndy Whitcroft# } 16630a920b5bSAndy Whitcroft 16648905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 1665c2fdda0dSAndy Whitcroft WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 16668905a67cSAndy Whitcroft } 16678905a67cSAndy Whitcroft 166800df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 166900df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 167000df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 167100df344fSAndy Whitcroft# printk includes all preceeding printk's which have no newline on the end. 167200df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 1673f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 167400df344fSAndy Whitcroft my $ok = 0; 167500df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 167600df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 167700df344fSAndy Whitcroft # we have a preceeding printk if it ends 167800df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 167900df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 168000df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 168100df344fSAndy Whitcroft $ok = 1; 168200df344fSAndy Whitcroft } 168300df344fSAndy Whitcroft last; 168400df344fSAndy Whitcroft } 168500df344fSAndy Whitcroft } 168600df344fSAndy Whitcroft if ($ok == 0) { 1687de7d4f0eSAndy Whitcroft WARN("printk() should include KERN_ facility level\n" . $herecurr); 16880a920b5bSAndy Whitcroft } 168900df344fSAndy Whitcroft } 16900a920b5bSAndy Whitcroft 1691653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 1692653d4876SAndy Whitcroft# or if closed on same line 1693c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 1694c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 1695de7d4f0eSAndy Whitcroft ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 16960a920b5bSAndy Whitcroft } 1697653d4876SAndy Whitcroft 16988905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 16998905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 17008905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 17018905a67cSAndy Whitcroft ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 17028905a67cSAndy Whitcroft } 17038905a67cSAndy Whitcroft 17048d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 17058d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 1706fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 1707fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 17088d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 17098d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 17108d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 1711fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 1712fe2a7dbcSAndy Whitcroft $prefix !~ /{\s+$/) { 17138d31cfceSAndy Whitcroft ERROR("space prohibited before open square bracket '['\n" . $herecurr); 17148d31cfceSAndy Whitcroft } 17158d31cfceSAndy Whitcroft } 17168d31cfceSAndy Whitcroft 1717f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 17186c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 1719c2fdda0dSAndy Whitcroft my $name = $1; 1720773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 1721773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 1722c2fdda0dSAndy Whitcroft 1723c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 1724773647a0SAndy Whitcroft if ($name =~ /^(?: 1725773647a0SAndy Whitcroft if|for|while|switch|return|case| 1726773647a0SAndy Whitcroft volatile|__volatile__| 1727773647a0SAndy Whitcroft __attribute__|format|__extension__| 1728773647a0SAndy Whitcroft asm|__asm__)$/x) 1729773647a0SAndy Whitcroft { 1730c2fdda0dSAndy Whitcroft 1731c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 1732c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 1733c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 1734c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 1735773647a0SAndy Whitcroft 1736773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 1737c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 1738c2fdda0dSAndy Whitcroft 1739c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 1740c2fdda0dSAndy Whitcroft # likely a typedef for a function. 1741773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 1742c2fdda0dSAndy Whitcroft 1743c2fdda0dSAndy Whitcroft } else { 1744773647a0SAndy Whitcroft WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr); 1745f0a594c1SAndy Whitcroft } 17466c72ffaaSAndy Whitcroft } 1747653d4876SAndy Whitcroft# Check operator spacing. 17480a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 17499c0ca6f9SAndy Whitcroft my $ops = qr{ 17509c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 17519c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 17529c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 17531f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 17541f65f947SAndy Whitcroft \?|: 17559c0ca6f9SAndy Whitcroft }x; 1756cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 175700df344fSAndy Whitcroft my $off = 0; 17586c72ffaaSAndy Whitcroft 17596c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 17606c72ffaaSAndy Whitcroft 17610a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 17624a0df2efSAndy Whitcroft $off += length($elements[$n]); 17634a0df2efSAndy Whitcroft 1764773647a0SAndy Whitcroft # Pick up the preceeding and succeeding characters. 1765773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 1766773647a0SAndy Whitcroft my $cc = ''; 1767773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 1768773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 1769773647a0SAndy Whitcroft } 1770773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 1771773647a0SAndy Whitcroft 17724a0df2efSAndy Whitcroft my $a = ''; 17734a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 17744a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 1775cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 17764a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 17774a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 1778773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 17794a0df2efSAndy Whitcroft 17800a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 17814a0df2efSAndy Whitcroft 17824a0df2efSAndy Whitcroft my $c = ''; 17830a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 17844a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 17854a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 1786cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 17874a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 17884a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 178922f2a2efSAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/); 17904a0df2efSAndy Whitcroft } else { 17914a0df2efSAndy Whitcroft $c = 'E'; 17920a920b5bSAndy Whitcroft } 17930a920b5bSAndy Whitcroft 17944a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 17954a0df2efSAndy Whitcroft 17964a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 17974a0df2efSAndy Whitcroft 17986c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 1799de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 18000a920b5bSAndy Whitcroft 180174048ed8SAndy Whitcroft # Pull out the value of this operator. 18026c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 18030a920b5bSAndy Whitcroft 18041f65f947SAndy Whitcroft # Get the full operator variant. 18051f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 18061f65f947SAndy Whitcroft 180713214adfSAndy Whitcroft # Ignore operators passed as parameters. 180813214adfSAndy Whitcroft if ($op_type ne 'V' && 180913214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 181013214adfSAndy Whitcroft 1811cf655043SAndy Whitcroft# # Ignore comments 1812cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 181313214adfSAndy Whitcroft 1814d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 181513214adfSAndy Whitcroft } elsif ($op eq ';') { 1816cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 1817cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 1818773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 1819d8aaf121SAndy Whitcroft } 1820d8aaf121SAndy Whitcroft 1821d8aaf121SAndy Whitcroft # // is a comment 1822d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 18230a920b5bSAndy Whitcroft 18241f65f947SAndy Whitcroft # No spaces for: 18251f65f947SAndy Whitcroft # -> 18261f65f947SAndy Whitcroft # : when part of a bitfield 18271f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 18284a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 1829773647a0SAndy Whitcroft ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 18300a920b5bSAndy Whitcroft } 18310a920b5bSAndy Whitcroft 18320a920b5bSAndy Whitcroft # , must have a space on the right. 18330a920b5bSAndy Whitcroft } elsif ($op eq ',') { 1834cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 1835773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 18360a920b5bSAndy Whitcroft } 18370a920b5bSAndy Whitcroft 18389c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 183974048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 18409c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 18419c0ca6f9SAndy Whitcroft 18429c0ca6f9SAndy Whitcroft # unary operators should have a space before and 18439c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 18449c0ca6f9SAndy Whitcroft # unary operator, or a cast 18459c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 184674048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 18470d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 1848cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 1849773647a0SAndy Whitcroft ERROR("space required before that '$op' $at\n" . $hereptr); 18500a920b5bSAndy Whitcroft } 1851171ae1a4SAndy Whitcroft if ($op eq '*' && $cc =~/\s*const\b/) { 1852171ae1a4SAndy Whitcroft # A unary '*' may be const 1853171ae1a4SAndy Whitcroft 1854171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 1855773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 18560a920b5bSAndy Whitcroft } 18570a920b5bSAndy Whitcroft 18580a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 18590a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 1860773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 1861773647a0SAndy Whitcroft ERROR("space required one side of that '$op' $at\n" . $hereptr); 18620a920b5bSAndy Whitcroft } 1863773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 1864773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 1865773647a0SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 1866653d4876SAndy Whitcroft } 1867773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 1868773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 1869773647a0SAndy Whitcroft } 1870773647a0SAndy Whitcroft 18710a920b5bSAndy Whitcroft 18720a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 18739c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 18749c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 18759c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 1876c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 1877c2fdda0dSAndy Whitcroft $op eq '%') 18780a920b5bSAndy Whitcroft { 1879773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 1880de7d4f0eSAndy Whitcroft ERROR("need consistent spacing around '$op' $at\n" . 1881de7d4f0eSAndy Whitcroft $hereptr); 18820a920b5bSAndy Whitcroft } 18830a920b5bSAndy Whitcroft 18841f65f947SAndy Whitcroft # A colon needs no spaces before when it is 18851f65f947SAndy Whitcroft # terminating a case value or a label. 18861f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 18871f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 18881f65f947SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 18891f65f947SAndy Whitcroft } 18901f65f947SAndy Whitcroft 18910a920b5bSAndy Whitcroft # All the others need spaces both sides. 1892cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 18931f65f947SAndy Whitcroft my $ok = 0; 18941f65f947SAndy Whitcroft 189522f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 18961f65f947SAndy Whitcroft if (($op eq '<' && 18971f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 18981f65f947SAndy Whitcroft ($op eq '>' && 18991f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 19001f65f947SAndy Whitcroft { 19011f65f947SAndy Whitcroft $ok = 1; 19021f65f947SAndy Whitcroft } 19031f65f947SAndy Whitcroft 19041f65f947SAndy Whitcroft # Ignore ?: 19051f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 19061f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 19071f65f947SAndy Whitcroft $ok = 1; 19081f65f947SAndy Whitcroft } 19091f65f947SAndy Whitcroft 19101f65f947SAndy Whitcroft if ($ok == 0) { 1911773647a0SAndy Whitcroft ERROR("spaces required around that '$op' $at\n" . $hereptr); 19120a920b5bSAndy Whitcroft } 191322f2a2efSAndy Whitcroft } 19144a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 19150a920b5bSAndy Whitcroft } 19160a920b5bSAndy Whitcroft } 19170a920b5bSAndy Whitcroft 1918f0a594c1SAndy Whitcroft# check for multiple assignments 1919f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 19206c72ffaaSAndy Whitcroft CHK("multiple assignments should be avoided\n" . $herecurr); 1921f0a594c1SAndy Whitcroft } 1922f0a594c1SAndy Whitcroft 192322f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 192422f2a2efSAndy Whitcroft## # continuation. 192522f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 192622f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 192722f2a2efSAndy Whitcroft## 192822f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 192922f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 193022f2a2efSAndy Whitcroft## my $ln = $line; 193122f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 193222f2a2efSAndy Whitcroft## } 193322f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 193422f2a2efSAndy Whitcroft## WARN("declaring multiple variables together should be avoided\n" . $herecurr); 193522f2a2efSAndy Whitcroft## } 193622f2a2efSAndy Whitcroft## } 1937f0a594c1SAndy Whitcroft 19380a920b5bSAndy Whitcroft#need space before brace following if, while, etc 193922f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 194022f2a2efSAndy Whitcroft $line =~ /do{/) { 1941773647a0SAndy Whitcroft ERROR("space required before the open brace '{'\n" . $herecurr); 1942de7d4f0eSAndy Whitcroft } 1943de7d4f0eSAndy Whitcroft 1944de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 1945de7d4f0eSAndy Whitcroft# on the line 1946de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 1947773647a0SAndy Whitcroft ERROR("space required after that close brace '}'\n" . $herecurr); 19480a920b5bSAndy Whitcroft } 19490a920b5bSAndy Whitcroft 195022f2a2efSAndy Whitcroft# check spacing on square brackets 195122f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 1952773647a0SAndy Whitcroft ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 195322f2a2efSAndy Whitcroft } 195422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 1955773647a0SAndy Whitcroft ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 195622f2a2efSAndy Whitcroft } 195722f2a2efSAndy Whitcroft 1958c45dcabdSAndy Whitcroft# check spacing on parentheses 19599c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 19609c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 1961773647a0SAndy Whitcroft ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 196222f2a2efSAndy Whitcroft } 196313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 1964c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 1965c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 1966773647a0SAndy Whitcroft ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 196722f2a2efSAndy Whitcroft } 196822f2a2efSAndy Whitcroft 19690a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 19704a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 19710a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 1972de7d4f0eSAndy Whitcroft WARN("labels should not be indented\n" . $herecurr); 19730a920b5bSAndy Whitcroft } 19740a920b5bSAndy Whitcroft 1975c45dcabdSAndy Whitcroft# Return is not a function. 1976c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 1977c45dcabdSAndy Whitcroft my $spacing = $1; 1978c45dcabdSAndy Whitcroft my $value = $2; 1979c45dcabdSAndy Whitcroft 1980c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 1981fee61c47SAndy Whitcroft $value =~ s/\)\(/\) \(/g; 1982c45dcabdSAndy Whitcroft while ($value =~ s/\([^\(\)]*\)/1/) { 1983c45dcabdSAndy Whitcroft } 1984c45dcabdSAndy Whitcroft 1985c45dcabdSAndy Whitcroft if ($value =~ /^(?:$Ident|-?$Constant)$/) { 1986c45dcabdSAndy Whitcroft ERROR("return is not a function, parentheses are not required\n" . $herecurr); 1987c45dcabdSAndy Whitcroft 1988c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 1989c45dcabdSAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 1990c45dcabdSAndy Whitcroft } 1991c45dcabdSAndy Whitcroft } 1992c45dcabdSAndy Whitcroft 19930a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 19944a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 1995773647a0SAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 19960a920b5bSAndy Whitcroft } 19970a920b5bSAndy Whitcroft 1998f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 1999f5fe35ddSAndy Whitcroft# statements after the conditional. 2000170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 2001170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2002170d3a22SAndy Whitcroft $remain_next, $off_next); 2003170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2004170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2005170d3a22SAndy Whitcroft 2006170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2007170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2008170d3a22SAndy Whitcroft # then count those as offsets. 2009170d3a22SAndy Whitcroft my ($whitespace) = 2010170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2011170d3a22SAndy Whitcroft my $offset = 2012170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2013170d3a22SAndy Whitcroft 2014170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2015170d3a22SAndy Whitcroft $offset} = 1; 2016170d3a22SAndy Whitcroft } 2017170d3a22SAndy Whitcroft } 2018170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2019170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2020171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 20218905a67cSAndy Whitcroft 20228905a67cSAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) { 2023c2fdda0dSAndy Whitcroft ERROR("do not use assignment in if condition\n" . $herecurr); 20248905a67cSAndy Whitcroft } 20258905a67cSAndy Whitcroft 20268905a67cSAndy Whitcroft # Find out what is on the end of the line after the 20278905a67cSAndy Whitcroft # conditional. 2028773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 20298905a67cSAndy Whitcroft $s =~ s/\n.*//g; 203013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 203153210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 203253210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2033773647a0SAndy Whitcroft { 2034bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2035bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2036bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 2037bb44ad39SAndy Whitcroft 2038bb44ad39SAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 2039bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2040bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2041bb44ad39SAndy Whitcroft } 2042bb44ad39SAndy Whitcroft 2043bb44ad39SAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); 20448905a67cSAndy Whitcroft } 20458905a67cSAndy Whitcroft } 20468905a67cSAndy Whitcroft 204713214adfSAndy Whitcroft# Check for bitwise tests written as boolean 204813214adfSAndy Whitcroft if ($line =~ / 204913214adfSAndy Whitcroft (?: 205013214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 205113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 205213214adfSAndy Whitcroft (?:\&\&|\|\|) 205313214adfSAndy Whitcroft | 205413214adfSAndy Whitcroft (?:\&\&|\|\|) 205513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 205613214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 205713214adfSAndy Whitcroft )/x) 205813214adfSAndy Whitcroft { 205913214adfSAndy Whitcroft WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 206013214adfSAndy Whitcroft } 206113214adfSAndy Whitcroft 20628905a67cSAndy Whitcroft# if and else should not have general statements after it 206313214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 206413214adfSAndy Whitcroft my $s = $1; 206513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 206613214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 20678905a67cSAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 20680a920b5bSAndy Whitcroft } 206913214adfSAndy Whitcroft } 2070a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2071a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2072a1080bf8SAndy Whitcroft $line !~ /\G(?: 20733fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2074a1080bf8SAndy Whitcroft \s*return\s+ 2075a1080bf8SAndy Whitcroft )/xg) 2076a1080bf8SAndy Whitcroft { 2077a1080bf8SAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 2078a1080bf8SAndy Whitcroft } 20790a920b5bSAndy Whitcroft 20800a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 20810a920b5bSAndy Whitcroft # indent level to be relevant to each other. 20820a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 20830a920b5bSAndy Whitcroft $previndent == $indent) { 2084de7d4f0eSAndy Whitcroft ERROR("else should follow close brace '}'\n" . $hereprev); 20850a920b5bSAndy Whitcroft } 20860a920b5bSAndy Whitcroft 2087c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2088c2fdda0dSAndy Whitcroft $previndent == $indent) { 2089c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2090c2fdda0dSAndy Whitcroft 2091c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2092c2fdda0dSAndy Whitcroft # conditional. 2093773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2094c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2095c2fdda0dSAndy Whitcroft 2096c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2097c2fdda0dSAndy Whitcroft ERROR("while should follow close brace '}'\n" . $hereprev); 2098c2fdda0dSAndy Whitcroft } 2099c2fdda0dSAndy Whitcroft } 2100c2fdda0dSAndy Whitcroft 21010a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 21020a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 21030a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 21040a920b5bSAndy Whitcroft# print "$herecurr"; 21050a920b5bSAndy Whitcroft# $clean = 0; 21060a920b5bSAndy Whitcroft# } 21070a920b5bSAndy Whitcroft 21080a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2109c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2110de7d4f0eSAndy Whitcroft WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr); 21110a920b5bSAndy Whitcroft } 21120a920b5bSAndy Whitcroft 2113653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2114c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2115e09dec48SAndy Whitcroft my $file = "$1.h"; 2116e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2117e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2118e09dec48SAndy Whitcroft $realfile ne $checkfile && 2119c45dcabdSAndy Whitcroft $1 ne 'irq') 2120c45dcabdSAndy Whitcroft { 2121e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2122e09dec48SAndy Whitcroft CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2123e09dec48SAndy Whitcroft } else { 2124e09dec48SAndy Whitcroft WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2125e09dec48SAndy Whitcroft } 21260a920b5bSAndy Whitcroft } 21270a920b5bSAndy Whitcroft } 21280a920b5bSAndy Whitcroft 2129653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2130653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2131cf655043SAndy Whitcroft# in a known good container 2132b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2133b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2134d8aaf121SAndy Whitcroft my $ln = $linenr; 2135d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2136c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2137c45dcabdSAndy Whitcroft my $ctx = ''; 2138653d4876SAndy Whitcroft 2139c45dcabdSAndy Whitcroft my $args = defined($1); 2140de7d4f0eSAndy Whitcroft 2141c45dcabdSAndy Whitcroft # Find the end of the macro and limit our statement 2142c45dcabdSAndy Whitcroft # search to that. 2143c45dcabdSAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1] && 2144c45dcabdSAndy Whitcroft $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2145c45dcabdSAndy Whitcroft { 2146c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1] . "\n"; 2147a3bb97a7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 2148c45dcabdSAndy Whitcroft $ln++; 2149de7d4f0eSAndy Whitcroft } 2150c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1]; 2151d8aaf121SAndy Whitcroft 2152c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2153c45dcabdSAndy Whitcroft ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2154c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2155a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2156c45dcabdSAndy Whitcroft 2157c45dcabdSAndy Whitcroft # Extract the remainder of the define (if any) and 2158c45dcabdSAndy Whitcroft # rip off surrounding spaces, and trailing \'s. 2159c45dcabdSAndy Whitcroft $rest = ''; 2160636d140aSAndy Whitcroft while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2161636d140aSAndy Whitcroft #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2162a3bb97a7SAndy Whitcroft if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2163c45dcabdSAndy Whitcroft $rest .= substr($lines[$ln - 1], $off) . "\n"; 2164c45dcabdSAndy Whitcroft $cnt--; 2165a3bb97a7SAndy Whitcroft } 2166a3bb97a7SAndy Whitcroft $ln++; 2167c45dcabdSAndy Whitcroft $off = 0; 2168c45dcabdSAndy Whitcroft } 2169c45dcabdSAndy Whitcroft $rest =~ s/\\\n.//g; 2170c45dcabdSAndy Whitcroft $rest =~ s/^\s*//s; 2171c45dcabdSAndy Whitcroft $rest =~ s/\s*$//s; 2172c45dcabdSAndy Whitcroft 2173c45dcabdSAndy Whitcroft # Clean up the original statement. 2174c45dcabdSAndy Whitcroft if ($args) { 2175c45dcabdSAndy Whitcroft substr($dstat, 0, length($dcond), ''); 2176d8aaf121SAndy Whitcroft } else { 2177c45dcabdSAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2178c45dcabdSAndy Whitcroft } 2179292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2180c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2181c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2182c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2183c45dcabdSAndy Whitcroft 2184c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2185bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2186bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2187bf30d6edSAndy Whitcroft $dstat =~ s/\[[^\{\}]*\]/1/) 2188bf30d6edSAndy Whitcroft { 2189c45dcabdSAndy Whitcroft } 2190c45dcabdSAndy Whitcroft 2191c45dcabdSAndy Whitcroft my $exceptions = qr{ 2192c45dcabdSAndy Whitcroft $Declare| 2193c45dcabdSAndy Whitcroft module_param_named| 2194c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2195c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2196c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2197383099fdSAndy Whitcroft __typeof__\(| 2198383099fdSAndy Whitcroft \.$Ident\s*=\s* 2199c45dcabdSAndy Whitcroft }x; 2200383099fdSAndy Whitcroft #print "REST<$rest> dstat<$dstat>\n"; 2201c45dcabdSAndy Whitcroft if ($rest ne '') { 2202c45dcabdSAndy Whitcroft if ($rest !~ /while\s*\(/ && 2203c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/) 2204c45dcabdSAndy Whitcroft { 2205c45dcabdSAndy Whitcroft ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2206c45dcabdSAndy Whitcroft } 2207c45dcabdSAndy Whitcroft 2208c45dcabdSAndy Whitcroft } elsif ($ctx !~ /;/) { 2209c45dcabdSAndy Whitcroft if ($dstat ne '' && 2210c45dcabdSAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2211c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/ && 2212b132e5d5SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && 2213c45dcabdSAndy Whitcroft $dstat =~ /$Operators/) 2214c45dcabdSAndy Whitcroft { 2215de7d4f0eSAndy Whitcroft ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2216d8aaf121SAndy Whitcroft } 22170a920b5bSAndy Whitcroft } 2218653d4876SAndy Whitcroft } 22190a920b5bSAndy Whitcroft 2220f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 222113214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 222213214adfSAndy Whitcroft my ($level, $endln, @chunks) = 2223cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 222413214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2225cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 2226cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 222713214adfSAndy Whitcroft my $allowed = 0; 222813214adfSAndy Whitcroft my $seen = 0; 2229773647a0SAndy Whitcroft my $herectx = $here . "\n"; 2230cf655043SAndy Whitcroft my $ln = $linenr - 1; 223113214adfSAndy Whitcroft for my $chunk (@chunks) { 223213214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 223313214adfSAndy Whitcroft 2234773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 2235773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2236773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 2237773647a0SAndy Whitcroft 2238773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2239773647a0SAndy Whitcroft 2240773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 2241773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 2242773647a0SAndy Whitcroft 2243773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2244cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 2245cf655043SAndy Whitcroft 2246773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 224713214adfSAndy Whitcroft 224813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 224913214adfSAndy Whitcroft 2250cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 2251cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2252cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 225313214adfSAndy Whitcroft $allowed = 1; 225413214adfSAndy Whitcroft } 225513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2256cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 225713214adfSAndy Whitcroft $allowed = 1; 225813214adfSAndy Whitcroft } 2259cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2260cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 226113214adfSAndy Whitcroft $allowed = 1; 226213214adfSAndy Whitcroft } 226313214adfSAndy Whitcroft } 226413214adfSAndy Whitcroft if ($seen && !$allowed) { 2265cf655043SAndy Whitcroft WARN("braces {} are not necessary for any arm of this statement\n" . $herectx); 226613214adfSAndy Whitcroft } 226713214adfSAndy Whitcroft } 226813214adfSAndy Whitcroft } 2269773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 227013214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 2271cf655043SAndy Whitcroft my $allowed = 0; 2272f0a594c1SAndy Whitcroft 2273cf655043SAndy Whitcroft # Check the pre-context. 2274cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2275cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 2276cf655043SAndy Whitcroft $allowed = 1; 2277f0a594c1SAndy Whitcroft } 2278773647a0SAndy Whitcroft 2279773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 2280773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 2281773647a0SAndy Whitcroft 2282cf655043SAndy Whitcroft # Check the condition. 2283cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 2284773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 2285cf655043SAndy Whitcroft if (defined $cond) { 2286773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2287cf655043SAndy Whitcroft } 2288cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2289cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 2290cf655043SAndy Whitcroft $allowed = 1; 2291cf655043SAndy Whitcroft } 2292cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2293cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 2294cf655043SAndy Whitcroft $allowed = 1; 2295cf655043SAndy Whitcroft } 2296cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2297cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 2298cf655043SAndy Whitcroft $allowed = 1; 2299cf655043SAndy Whitcroft } 2300cf655043SAndy Whitcroft # Check the post-context. 2301cf655043SAndy Whitcroft if (defined $chunks[1]) { 2302cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 2303cf655043SAndy Whitcroft if (defined $cond) { 2304773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2305cf655043SAndy Whitcroft } 2306cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 2307cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 2308cf655043SAndy Whitcroft $allowed = 1; 2309cf655043SAndy Whitcroft } 2310cf655043SAndy Whitcroft } 2311cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 2312cf655043SAndy Whitcroft my $herectx = $here . "\n";; 2313f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 2314cf655043SAndy Whitcroft 2315f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 2316f055663cSAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n";; 2317cf655043SAndy Whitcroft } 2318cf655043SAndy Whitcroft 2319cf655043SAndy Whitcroft WARN("braces {} are not necessary for single statement blocks\n" . $herectx); 2320f0a594c1SAndy Whitcroft } 2321f0a594c1SAndy Whitcroft } 2322f0a594c1SAndy Whitcroft 2323653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 23244a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 2325c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 2326de7d4f0eSAndy Whitcroft ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 23270a920b5bSAndy Whitcroft } 23280a920b5bSAndy Whitcroft } 23290a920b5bSAndy Whitcroft 23304a0df2efSAndy Whitcroft# don't use deprecated functions 23314a0df2efSAndy Whitcroft for my $func (@dep_functions) { 233200df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 2333de7d4f0eSAndy Whitcroft ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 23344a0df2efSAndy Whitcroft } 23354a0df2efSAndy Whitcroft } 23364a0df2efSAndy Whitcroft 23374a0df2efSAndy Whitcroft# no volatiles please 23386c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 23396c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 2340de7d4f0eSAndy Whitcroft WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 23414a0df2efSAndy Whitcroft } 23424a0df2efSAndy Whitcroft 23439c0ca6f9SAndy Whitcroft# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated 23449c0ca6f9SAndy Whitcroft if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { 23459c0ca6f9SAndy Whitcroft ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr); 23469c0ca6f9SAndy Whitcroft } 23479c0ca6f9SAndy Whitcroft 234800df344fSAndy Whitcroft# warn about #if 0 2349c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2350de7d4f0eSAndy Whitcroft CHK("if this code is redundant consider removing it\n" . 2351de7d4f0eSAndy Whitcroft $herecurr); 23524a0df2efSAndy Whitcroft } 23534a0df2efSAndy Whitcroft 2354f0a594c1SAndy Whitcroft# check for needless kfree() checks 2355f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 2356f0a594c1SAndy Whitcroft my $expr = $1; 2357f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 23583c232147SWolfram Sang WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev); 2359f0a594c1SAndy Whitcroft } 2360f0a594c1SAndy Whitcroft } 23614c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 23624c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 23634c432a8fSGreg Kroah-Hartman my $expr = $1; 23644c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 23654c432a8fSGreg Kroah-Hartman WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 23664c432a8fSGreg Kroah-Hartman } 23674c432a8fSGreg Kroah-Hartman } 2368f0a594c1SAndy Whitcroft 236900df344fSAndy Whitcroft# warn about #ifdefs in C files 2370c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 237100df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 237200df344fSAndy Whitcroft# print "$herecurr"; 237300df344fSAndy Whitcroft# $clean = 0; 237400df344fSAndy Whitcroft# } 237500df344fSAndy Whitcroft 237622f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 2377c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 237822f2a2efSAndy Whitcroft ERROR("exactly one space required after that #$1\n" . $herecurr); 237922f2a2efSAndy Whitcroft } 238022f2a2efSAndy Whitcroft 23814a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 2382171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 2383171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 23844a0df2efSAndy Whitcroft my $which = $1; 23854a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2386de7d4f0eSAndy Whitcroft CHK("$1 definition without comment\n" . $herecurr); 23874a0df2efSAndy Whitcroft } 23884a0df2efSAndy Whitcroft } 23894a0df2efSAndy Whitcroft# check for memory barriers without a comment. 23904a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 23914a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2392de7d4f0eSAndy Whitcroft CHK("memory barrier without comment\n" . $herecurr); 23934a0df2efSAndy Whitcroft } 23944a0df2efSAndy Whitcroft } 23954a0df2efSAndy Whitcroft# check of hardware specific defines 2396c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 2397de7d4f0eSAndy Whitcroft CHK("architecture specific defines should be avoided\n" . $herecurr); 23980a920b5bSAndy Whitcroft } 2399653d4876SAndy Whitcroft 2400de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 2401de7d4f0eSAndy Whitcroft# storage class and type. 24029c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 24039c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 2404de7d4f0eSAndy Whitcroft ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 2405de7d4f0eSAndy Whitcroft } 2406de7d4f0eSAndy Whitcroft 24078905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 24088905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 24098905a67cSAndy Whitcroft WARN("plain inline is preferred over $1\n" . $herecurr); 24108905a67cSAndy Whitcroft } 24118905a67cSAndy Whitcroft 2412de7d4f0eSAndy Whitcroft# check for new externs in .c files. 2413171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 2414c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 2415171ae1a4SAndy Whitcroft { 2416c45dcabdSAndy Whitcroft my $function_name = $1; 2417c45dcabdSAndy Whitcroft my $paren_space = $2; 2418171ae1a4SAndy Whitcroft 2419171ae1a4SAndy Whitcroft my $s = $stat; 2420171ae1a4SAndy Whitcroft if (defined $cond) { 2421171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 2422171ae1a4SAndy Whitcroft } 2423c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 2424c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 2425c45dcabdSAndy Whitcroft { 2426de7d4f0eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2427de7d4f0eSAndy Whitcroft } 2428de7d4f0eSAndy Whitcroft 2429171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 2430171ae1a4SAndy Whitcroft WARN("arguments for function declarations should follow identifier\n" . $herecurr); 2431171ae1a4SAndy Whitcroft } 24329c9ba34eSAndy Whitcroft 24339c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 24349c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 24359c9ba34eSAndy Whitcroft { 24369c9ba34eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2437171ae1a4SAndy Whitcroft } 2438171ae1a4SAndy Whitcroft 2439de7d4f0eSAndy Whitcroft# checks for new __setup's 2440de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 2441de7d4f0eSAndy Whitcroft my $name = $1; 2442de7d4f0eSAndy Whitcroft 2443de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 2444de7d4f0eSAndy Whitcroft CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 2445de7d4f0eSAndy Whitcroft } 2446653d4876SAndy Whitcroft } 24479c0ca6f9SAndy Whitcroft 24489c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 24499c0ca6f9SAndy Whitcroft if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { 24509c0ca6f9SAndy Whitcroft WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 24519c0ca6f9SAndy Whitcroft } 245213214adfSAndy Whitcroft 245313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 245413214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 245513214adfSAndy Whitcroft WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 245613214adfSAndy Whitcroft } 2457773647a0SAndy Whitcroft 2458773647a0SAndy Whitcroft# check for semaphores used as mutexes 2459171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) { 2460773647a0SAndy Whitcroft WARN("mutexes are preferred for single holder semaphores\n" . $herecurr); 2461773647a0SAndy Whitcroft } 2462773647a0SAndy Whitcroft# check for semaphores used as mutexes 2463171ae1a4SAndy Whitcroft if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) { 2464773647a0SAndy Whitcroft WARN("consider using a completion\n" . $herecurr); 2465773647a0SAndy Whitcroft } 2466773647a0SAndy Whitcroft# recommend strict_strto* over simple_strto* 2467773647a0SAndy Whitcroft if ($line =~ /\bsimple_(strto.*?)\s*\(/) { 2468773647a0SAndy Whitcroft WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr); 2469773647a0SAndy Whitcroft } 2470f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 2471f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 2472f3db6639SMichael Ellerman WARN("please use device_initcall() instead of __initcall()\n" . $herecurr); 2473f3db6639SMichael Ellerman } 2474773647a0SAndy Whitcroft 2475773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 2476773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 2477773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 2478c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 2479c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 2480171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 2481171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 2482171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 2483773647a0SAndy Whitcroft { 2484773647a0SAndy Whitcroft WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 2485773647a0SAndy Whitcroft } 24869c9ba34eSAndy Whitcroft 24879c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 24889c9ba34eSAndy Whitcroft my $string; 24899c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 24909c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 24912a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 24929c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 24939c9ba34eSAndy Whitcroft WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 24949c9ba34eSAndy Whitcroft last; 24959c9ba34eSAndy Whitcroft } 24969c9ba34eSAndy Whitcroft } 2497691d77b6SAndy Whitcroft 2498691d77b6SAndy Whitcroft# whine mightly about in_atomic 2499691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 2500691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 2501691d77b6SAndy Whitcroft ERROR("do not use in_atomic in drivers\n" . $herecurr); 2502691d77b6SAndy Whitcroft } else { 2503691d77b6SAndy Whitcroft WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 2504691d77b6SAndy Whitcroft } 2505691d77b6SAndy Whitcroft } 250613214adfSAndy Whitcroft } 250713214adfSAndy Whitcroft 250813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 250913214adfSAndy Whitcroft # so just keep quiet. 251013214adfSAndy Whitcroft if ($#rawlines == -1) { 251113214adfSAndy Whitcroft exit(0); 25120a920b5bSAndy Whitcroft } 25130a920b5bSAndy Whitcroft 25148905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 25158905a67cSAndy Whitcroft # things that appear to be patches. 25168905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 25178905a67cSAndy Whitcroft exit(0); 25188905a67cSAndy Whitcroft } 25198905a67cSAndy Whitcroft 25208905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 25218905a67cSAndy Whitcroft # just keep quiet. 25228905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 25238905a67cSAndy Whitcroft exit(0); 25248905a67cSAndy Whitcroft } 25258905a67cSAndy Whitcroft 25268905a67cSAndy Whitcroft if (!$is_patch) { 2527de7d4f0eSAndy Whitcroft ERROR("Does not appear to be a unified-diff format patch\n"); 25280a920b5bSAndy Whitcroft } 25290a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 2530de7d4f0eSAndy Whitcroft ERROR("Missing Signed-off-by: line(s)\n"); 25310a920b5bSAndy Whitcroft } 25320a920b5bSAndy Whitcroft 2533f0a594c1SAndy Whitcroft print report_dump(); 253413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 253513214adfSAndy Whitcroft print "$filename " if ($summary_file); 25366c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 25376c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 25386c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 25398905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 25406c72ffaaSAndy Whitcroft } 25418905a67cSAndy Whitcroft 25420a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 2543c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 25440a920b5bSAndy Whitcroft } 25450a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 2546c2fdda0dSAndy Whitcroft print "$vname has style problems, please review. If any of these errors\n"; 25470a920b5bSAndy Whitcroft print "are false positives report them to the maintainer, see\n"; 25480a920b5bSAndy Whitcroft print "CHECKPATCH in MAINTAINERS.\n"; 25490a920b5bSAndy Whitcroft } 255013214adfSAndy Whitcroft 25510a920b5bSAndy Whitcroft return $clean; 25520a920b5bSAndy Whitcroft} 2553