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) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 52a5a2c25SAndy 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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 13086f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 1316c72ffaaSAndy Whitcroftour $Operators = qr{ 1326c72ffaaSAndy Whitcroft <=|>=|==|!=| 1336c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 134c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 1356c72ffaaSAndy Whitcroft }x; 1366c72ffaaSAndy Whitcroft 1378905a67cSAndy Whitcroftour $NonptrType; 1388905a67cSAndy Whitcroftour $Type; 1398905a67cSAndy Whitcroftour $Declare; 1408905a67cSAndy Whitcroft 141171ae1a4SAndy Whitcroftour $UTF8 = qr { 142171ae1a4SAndy Whitcroft [\x09\x0A\x0D\x20-\x7E] # ASCII 143171ae1a4SAndy Whitcroft | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 144171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 145171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 146171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 147171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 148171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 149171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 150171ae1a4SAndy Whitcroft}x; 151171ae1a4SAndy Whitcroft 1528ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 1538ed22cadSAndy Whitcroft (?:__)?(?:u|s|be|le)(?:\d|\d\d)| 1548ed22cadSAndy Whitcroft atomic_t 1558ed22cadSAndy Whitcroft)}; 1568ed22cadSAndy Whitcroft 1578905a67cSAndy Whitcroftour @typeList = ( 1588905a67cSAndy Whitcroft qr{void}, 159c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 160c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 161c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 162c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 163c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 164c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 165c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 1668905a67cSAndy Whitcroft qr{unsigned}, 1678905a67cSAndy Whitcroft qr{float}, 1688905a67cSAndy Whitcroft qr{double}, 1698905a67cSAndy Whitcroft qr{bool}, 1708905a67cSAndy Whitcroft qr{struct\s+$Ident}, 1718905a67cSAndy Whitcroft qr{union\s+$Ident}, 1728905a67cSAndy Whitcroft qr{enum\s+$Ident}, 1738905a67cSAndy Whitcroft qr{${Ident}_t}, 1748905a67cSAndy Whitcroft qr{${Ident}_handler}, 1758905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 1768905a67cSAndy Whitcroft); 177c45dcabdSAndy Whitcroftour @modifierList = ( 178c45dcabdSAndy Whitcroft qr{fastcall}, 179c45dcabdSAndy Whitcroft); 1808905a67cSAndy Whitcroft 1818905a67cSAndy Whitcroftsub build_types { 182d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 183d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 184c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 1858905a67cSAndy Whitcroft $NonptrType = qr{ 186d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 187cf655043SAndy Whitcroft (?: 188c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 1898ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 190c45dcabdSAndy Whitcroft (?:${all}\b) 191cf655043SAndy Whitcroft ) 192c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 1938905a67cSAndy Whitcroft }x; 1948905a67cSAndy Whitcroft $Type = qr{ 195c45dcabdSAndy Whitcroft $NonptrType 19665863862SAndy Whitcroft (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 197c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 1988905a67cSAndy Whitcroft }x; 1998905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 2008905a67cSAndy Whitcroft} 2018905a67cSAndy Whitcroftbuild_types(); 2026c72ffaaSAndy Whitcroft 2036c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 2040a920b5bSAndy Whitcroft 2054a0df2efSAndy Whitcroftmy @dep_includes = (); 2064a0df2efSAndy Whitcroftmy @dep_functions = (); 2076c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 2086c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 2096c72ffaaSAndy Whitcroft open(REMOVE, "<$root/$removal") || 2106c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 2110a920b5bSAndy Whitcroft while (<REMOVE>) { 212f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 213f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 214f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 2154a0df2efSAndy Whitcroft push(@dep_includes, $1); 2164a0df2efSAndy Whitcroft 217f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 218f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 219f0a594c1SAndy Whitcroft } 2204a0df2efSAndy Whitcroft } 2210a920b5bSAndy Whitcroft } 2220a920b5bSAndy Whitcroft } 2230a920b5bSAndy Whitcroft} 2240a920b5bSAndy Whitcroft 22500df344fSAndy Whitcroftmy @rawlines = (); 226c2fdda0dSAndy Whitcroftmy @lines = (); 227c2fdda0dSAndy Whitcroftmy $vname; 2286c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 2296c72ffaaSAndy Whitcroft if ($file) { 2306c72ffaaSAndy Whitcroft open(FILE, "diff -u /dev/null $filename|") || 2316c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 2326c72ffaaSAndy Whitcroft } else { 2336c72ffaaSAndy Whitcroft open(FILE, "<$filename") || 2346c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 2356c72ffaaSAndy Whitcroft } 236c2fdda0dSAndy Whitcroft if ($filename eq '-') { 237c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 238c2fdda0dSAndy Whitcroft } else { 239c2fdda0dSAndy Whitcroft $vname = $filename; 240c2fdda0dSAndy Whitcroft } 2416c72ffaaSAndy Whitcroft while (<FILE>) { 2420a920b5bSAndy Whitcroft chomp; 24300df344fSAndy Whitcroft push(@rawlines, $_); 2446c72ffaaSAndy Whitcroft } 2456c72ffaaSAndy Whitcroft close(FILE); 246c2fdda0dSAndy Whitcroft if (!process($filename)) { 2470a920b5bSAndy Whitcroft $exit = 1; 2480a920b5bSAndy Whitcroft } 24900df344fSAndy Whitcroft @rawlines = (); 25013214adfSAndy Whitcroft @lines = (); 2510a920b5bSAndy Whitcroft} 2520a920b5bSAndy Whitcroft 2530a920b5bSAndy Whitcroftexit($exit); 2540a920b5bSAndy Whitcroft 2550a920b5bSAndy Whitcroftsub top_of_kernel_tree { 2566c72ffaaSAndy Whitcroft my ($root) = @_; 2576c72ffaaSAndy Whitcroft 2586c72ffaaSAndy Whitcroft my @tree_check = ( 2596c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 2606c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 2616c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 2626c72ffaaSAndy Whitcroft ); 2636c72ffaaSAndy Whitcroft 2646c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 2656c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 2660a920b5bSAndy Whitcroft return 0; 2670a920b5bSAndy Whitcroft } 2686c72ffaaSAndy Whitcroft } 2696c72ffaaSAndy Whitcroft return 1; 2706c72ffaaSAndy Whitcroft} 2710a920b5bSAndy Whitcroft 2720a920b5bSAndy Whitcroftsub expand_tabs { 2730a920b5bSAndy Whitcroft my ($str) = @_; 2740a920b5bSAndy Whitcroft 2750a920b5bSAndy Whitcroft my $res = ''; 2760a920b5bSAndy Whitcroft my $n = 0; 2770a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 2780a920b5bSAndy Whitcroft if ($c eq "\t") { 2790a920b5bSAndy Whitcroft $res .= ' '; 2800a920b5bSAndy Whitcroft $n++; 2810a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 2820a920b5bSAndy Whitcroft $res .= ' '; 2830a920b5bSAndy Whitcroft } 2840a920b5bSAndy Whitcroft next; 2850a920b5bSAndy Whitcroft } 2860a920b5bSAndy Whitcroft $res .= $c; 2870a920b5bSAndy Whitcroft $n++; 2880a920b5bSAndy Whitcroft } 2890a920b5bSAndy Whitcroft 2900a920b5bSAndy Whitcroft return $res; 2910a920b5bSAndy Whitcroft} 2926c72ffaaSAndy Whitcroftsub copy_spacing { 293773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 2946c72ffaaSAndy Whitcroft return $res; 2956c72ffaaSAndy Whitcroft} 2960a920b5bSAndy Whitcroft 2974a0df2efSAndy Whitcroftsub line_stats { 2984a0df2efSAndy Whitcroft my ($line) = @_; 2994a0df2efSAndy Whitcroft 3004a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 3014a0df2efSAndy Whitcroft $line =~ s/^.//; 3024a0df2efSAndy Whitcroft $line = expand_tabs($line); 3034a0df2efSAndy Whitcroft 3044a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 3054a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 3064a0df2efSAndy Whitcroft 3074a0df2efSAndy Whitcroft return (length($line), length($white)); 3084a0df2efSAndy Whitcroft} 3094a0df2efSAndy Whitcroft 310773647a0SAndy Whitcroftmy $sanitise_quote = ''; 311773647a0SAndy Whitcroft 312773647a0SAndy Whitcroftsub sanitise_line_reset { 313773647a0SAndy Whitcroft my ($in_comment) = @_; 314773647a0SAndy Whitcroft 315773647a0SAndy Whitcroft if ($in_comment) { 316773647a0SAndy Whitcroft $sanitise_quote = '*/'; 317773647a0SAndy Whitcroft } else { 318773647a0SAndy Whitcroft $sanitise_quote = ''; 319773647a0SAndy Whitcroft } 320773647a0SAndy Whitcroft} 32100df344fSAndy Whitcroftsub sanitise_line { 32200df344fSAndy Whitcroft my ($line) = @_; 32300df344fSAndy Whitcroft 32400df344fSAndy Whitcroft my $res = ''; 32500df344fSAndy Whitcroft my $l = ''; 32600df344fSAndy Whitcroft 327c2fdda0dSAndy Whitcroft my $qlen = 0; 328773647a0SAndy Whitcroft my $off = 0; 329773647a0SAndy Whitcroft my $c; 33000df344fSAndy Whitcroft 331773647a0SAndy Whitcroft # Always copy over the diff marker. 332773647a0SAndy Whitcroft $res = substr($line, 0, 1); 333773647a0SAndy Whitcroft 334773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 335773647a0SAndy Whitcroft $c = substr($line, $off, 1); 336773647a0SAndy Whitcroft 337773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 338773647a0SAndy Whitcroft # and end, all to $;. 339773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 340773647a0SAndy Whitcroft $sanitise_quote = '*/'; 341773647a0SAndy Whitcroft 342773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 343773647a0SAndy Whitcroft $off++; 34400df344fSAndy Whitcroft next; 345773647a0SAndy Whitcroft } 34681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 347773647a0SAndy Whitcroft $sanitise_quote = ''; 348773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 349773647a0SAndy Whitcroft $off++; 350773647a0SAndy Whitcroft next; 351773647a0SAndy Whitcroft } 352773647a0SAndy Whitcroft 353773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 354773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 355773647a0SAndy Whitcroft $c eq "\\") { 356773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 357773647a0SAndy Whitcroft $off++; 358773647a0SAndy Whitcroft next; 359773647a0SAndy Whitcroft } 360773647a0SAndy Whitcroft # Regular quotes. 361773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 362773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 363773647a0SAndy Whitcroft $sanitise_quote = $c; 364773647a0SAndy Whitcroft 365773647a0SAndy Whitcroft substr($res, $off, 1, $c); 366773647a0SAndy Whitcroft next; 367773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 368773647a0SAndy Whitcroft $sanitise_quote = ''; 36900df344fSAndy Whitcroft } 37000df344fSAndy Whitcroft } 371773647a0SAndy Whitcroft 372fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 373773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 374773647a0SAndy Whitcroft substr($res, $off, 1, $;); 375773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 376773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 37700df344fSAndy Whitcroft } else { 378773647a0SAndy Whitcroft substr($res, $off, 1, $c); 37900df344fSAndy Whitcroft } 380c2fdda0dSAndy Whitcroft } 381c2fdda0dSAndy Whitcroft 382c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 383c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 384c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 385c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 386c2fdda0dSAndy Whitcroft 387c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 388c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 389c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 390c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 391c2fdda0dSAndy Whitcroft } 392c2fdda0dSAndy Whitcroft 39300df344fSAndy Whitcroft return $res; 39400df344fSAndy Whitcroft} 39500df344fSAndy Whitcroft 3968905a67cSAndy Whitcroftsub ctx_statement_block { 3978905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 3988905a67cSAndy Whitcroft my $line = $linenr - 1; 3998905a67cSAndy Whitcroft my $blk = ''; 4008905a67cSAndy Whitcroft my $soff = $off; 4018905a67cSAndy Whitcroft my $coff = $off - 1; 402773647a0SAndy Whitcroft my $coff_set = 0; 4038905a67cSAndy Whitcroft 40413214adfSAndy Whitcroft my $loff = 0; 40513214adfSAndy Whitcroft 4068905a67cSAndy Whitcroft my $type = ''; 4078905a67cSAndy Whitcroft my $level = 0; 408*4635f4fbSAndy Whitcroft my @stack = ([$type, $level]); 409cf655043SAndy Whitcroft my $p; 4108905a67cSAndy Whitcroft my $c; 4118905a67cSAndy Whitcroft my $len = 0; 41213214adfSAndy Whitcroft 41313214adfSAndy Whitcroft my $remainder; 4148905a67cSAndy Whitcroft while (1) { 415773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 4168905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 4178905a67cSAndy Whitcroft # context. 4188905a67cSAndy Whitcroft if ($off >= $len) { 4198905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 420dea33496SAndy Whitcroft last if (!defined $lines[$line]); 421c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 4228905a67cSAndy Whitcroft $remain--; 42313214adfSAndy Whitcroft $loff = $len; 424c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 4258905a67cSAndy Whitcroft $len = length($blk); 4268905a67cSAndy Whitcroft $line++; 4278905a67cSAndy Whitcroft last; 4288905a67cSAndy Whitcroft } 4298905a67cSAndy Whitcroft # Bail if there is no further context. 4308905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 43113214adfSAndy Whitcroft if ($off >= $len) { 4328905a67cSAndy Whitcroft last; 4338905a67cSAndy Whitcroft } 4348905a67cSAndy Whitcroft } 435cf655043SAndy Whitcroft $p = $c; 4368905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 43713214adfSAndy Whitcroft $remainder = substr($blk, $off); 4388905a67cSAndy Whitcroft 439773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 440*4635f4fbSAndy Whitcroft 441*4635f4fbSAndy Whitcroft # Handle nested #if/#else. 442*4635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 443*4635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 444*4635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 445*4635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 446*4635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 447*4635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 448*4635f4fbSAndy Whitcroft } 449*4635f4fbSAndy Whitcroft 4508905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 4518905a67cSAndy Whitcroft # outermost level. 4528905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 4538905a67cSAndy Whitcroft last; 4548905a67cSAndy Whitcroft } 4558905a67cSAndy Whitcroft 45613214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 457773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 458773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 459773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 460773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 461773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 462773647a0SAndy Whitcroft $coff_set = 1; 463773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 464773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 46513214adfSAndy Whitcroft } 46613214adfSAndy Whitcroft 4678905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 4688905a67cSAndy Whitcroft $level++; 4698905a67cSAndy Whitcroft $type = '('; 4708905a67cSAndy Whitcroft } 4718905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 4728905a67cSAndy Whitcroft $level--; 4738905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 4748905a67cSAndy Whitcroft 4758905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 4768905a67cSAndy Whitcroft $coff = $off; 477773647a0SAndy Whitcroft $coff_set = 1; 478773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 4798905a67cSAndy Whitcroft } 4808905a67cSAndy Whitcroft } 4818905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 4828905a67cSAndy Whitcroft $level++; 4838905a67cSAndy Whitcroft $type = '{'; 4848905a67cSAndy Whitcroft } 4858905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 4868905a67cSAndy Whitcroft $level--; 4878905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 4888905a67cSAndy Whitcroft 4898905a67cSAndy Whitcroft if ($level == 0) { 4908905a67cSAndy Whitcroft last; 4918905a67cSAndy Whitcroft } 4928905a67cSAndy Whitcroft } 4938905a67cSAndy Whitcroft $off++; 4948905a67cSAndy Whitcroft } 495a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 49613214adfSAndy Whitcroft if ($off == $len) { 497a3bb97a7SAndy Whitcroft $loff = $len + 1; 49813214adfSAndy Whitcroft $line++; 49913214adfSAndy Whitcroft $remain--; 50013214adfSAndy Whitcroft } 5018905a67cSAndy Whitcroft 5028905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 5038905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 5048905a67cSAndy Whitcroft 5058905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 5068905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 5078905a67cSAndy Whitcroft 508773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 50913214adfSAndy Whitcroft 51013214adfSAndy Whitcroft return ($statement, $condition, 51113214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 51213214adfSAndy Whitcroft} 51313214adfSAndy Whitcroft 514cf655043SAndy Whitcroftsub statement_lines { 515cf655043SAndy Whitcroft my ($stmt) = @_; 516cf655043SAndy Whitcroft 517cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 518cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 519cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 520cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 521cf655043SAndy Whitcroft 522cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 523cf655043SAndy Whitcroft 524cf655043SAndy Whitcroft return $#stmt_lines + 2; 525cf655043SAndy Whitcroft} 526cf655043SAndy Whitcroft 527cf655043SAndy Whitcroftsub statement_rawlines { 528cf655043SAndy Whitcroft my ($stmt) = @_; 529cf655043SAndy Whitcroft 530cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 531cf655043SAndy Whitcroft 532cf655043SAndy Whitcroft return $#stmt_lines + 2; 533cf655043SAndy Whitcroft} 534cf655043SAndy Whitcroft 535cf655043SAndy Whitcroftsub statement_block_size { 536cf655043SAndy Whitcroft my ($stmt) = @_; 537cf655043SAndy Whitcroft 538cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 539cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 540cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 541cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 542cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 543cf655043SAndy Whitcroft 544cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 545cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 546cf655043SAndy Whitcroft 547cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 548cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 549cf655043SAndy Whitcroft 550cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 551cf655043SAndy Whitcroft return $stmt_lines; 552cf655043SAndy Whitcroft } else { 553cf655043SAndy Whitcroft return $stmt_statements; 554cf655043SAndy Whitcroft } 555cf655043SAndy Whitcroft} 556cf655043SAndy Whitcroft 55713214adfSAndy Whitcroftsub ctx_statement_full { 55813214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 55913214adfSAndy Whitcroft my ($statement, $condition, $level); 56013214adfSAndy Whitcroft 56113214adfSAndy Whitcroft my (@chunks); 56213214adfSAndy Whitcroft 563cf655043SAndy Whitcroft # Grab the first conditional/block pair. 56413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 56513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 566773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 56713214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 568cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 569cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 570cf655043SAndy Whitcroft } 571cf655043SAndy Whitcroft 572cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 573cf655043SAndy Whitcroft # could continue the statement. 574cf655043SAndy Whitcroft for (;;) { 57513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 57613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 577cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 578773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 579cf655043SAndy Whitcroft #print "C: push\n"; 580cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 58113214adfSAndy Whitcroft } 58213214adfSAndy Whitcroft 58313214adfSAndy Whitcroft return ($level, $linenr, @chunks); 5848905a67cSAndy Whitcroft} 5858905a67cSAndy Whitcroft 5864a0df2efSAndy Whitcroftsub ctx_block_get { 587f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 5884a0df2efSAndy Whitcroft my $line; 5894a0df2efSAndy Whitcroft my $start = $linenr - 1; 5904a0df2efSAndy Whitcroft my $blk = ''; 5914a0df2efSAndy Whitcroft my @o; 5924a0df2efSAndy Whitcroft my @c; 5934a0df2efSAndy Whitcroft my @res = (); 5944a0df2efSAndy Whitcroft 595f0a594c1SAndy Whitcroft my $level = 0; 596*4635f4fbSAndy Whitcroft my @stack = ($level); 59700df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 59800df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 59900df344fSAndy Whitcroft $remain--; 60000df344fSAndy Whitcroft 60100df344fSAndy Whitcroft $blk .= $rawlines[$line]; 602*4635f4fbSAndy Whitcroft 603*4635f4fbSAndy Whitcroft # Handle nested #if/#else. 604*4635f4fbSAndy Whitcroft if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 605*4635f4fbSAndy Whitcroft push(@stack, $level); 606*4635f4fbSAndy Whitcroft } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 607*4635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 608*4635f4fbSAndy Whitcroft } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) { 609*4635f4fbSAndy Whitcroft $level = pop(@stack); 610*4635f4fbSAndy Whitcroft } 611*4635f4fbSAndy Whitcroft 612f0a594c1SAndy Whitcroft foreach my $c (split(//, $rawlines[$line])) { 613f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 614f0a594c1SAndy Whitcroft if ($off > 0) { 615f0a594c1SAndy Whitcroft $off--; 616f0a594c1SAndy Whitcroft next; 617f0a594c1SAndy Whitcroft } 6184a0df2efSAndy Whitcroft 619f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 620f0a594c1SAndy Whitcroft $level--; 621f0a594c1SAndy Whitcroft last if ($level == 0); 622f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 623f0a594c1SAndy Whitcroft $level++; 624f0a594c1SAndy Whitcroft } 625f0a594c1SAndy Whitcroft } 6264a0df2efSAndy Whitcroft 627f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 62800df344fSAndy Whitcroft push(@res, $rawlines[$line]); 6294a0df2efSAndy Whitcroft } 6304a0df2efSAndy Whitcroft 631f0a594c1SAndy Whitcroft last if ($level == 0); 6324a0df2efSAndy Whitcroft } 6334a0df2efSAndy Whitcroft 634f0a594c1SAndy Whitcroft return ($level, @res); 6354a0df2efSAndy Whitcroft} 6364a0df2efSAndy Whitcroftsub ctx_block_outer { 6374a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6384a0df2efSAndy Whitcroft 639f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 640f0a594c1SAndy Whitcroft return @r; 6414a0df2efSAndy Whitcroft} 6424a0df2efSAndy Whitcroftsub ctx_block { 6434a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 6444a0df2efSAndy Whitcroft 645f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 646f0a594c1SAndy Whitcroft return @r; 647653d4876SAndy Whitcroft} 648653d4876SAndy Whitcroftsub ctx_statement { 649f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 650f0a594c1SAndy Whitcroft 651f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 652f0a594c1SAndy Whitcroft return @r; 653f0a594c1SAndy Whitcroft} 654f0a594c1SAndy Whitcroftsub ctx_block_level { 655653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 656653d4876SAndy Whitcroft 657f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 6584a0df2efSAndy Whitcroft} 6599c0ca6f9SAndy Whitcroftsub ctx_statement_level { 6609c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 6619c0ca6f9SAndy Whitcroft 6629c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 6639c0ca6f9SAndy Whitcroft} 6644a0df2efSAndy Whitcroft 6654a0df2efSAndy Whitcroftsub ctx_locate_comment { 6664a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6674a0df2efSAndy Whitcroft 6684a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 669beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 6704a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 6714a0df2efSAndy Whitcroft 6724a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 6734a0df2efSAndy Whitcroft # comment. 6744a0df2efSAndy Whitcroft my $in_comment = 0; 6754a0df2efSAndy Whitcroft $current_comment = ''; 6764a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 67700df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 67800df344fSAndy Whitcroft #warn " $line\n"; 6794a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 6804a0df2efSAndy Whitcroft $in_comment = 1; 6814a0df2efSAndy Whitcroft } 6824a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 6834a0df2efSAndy Whitcroft $in_comment = 1; 6844a0df2efSAndy Whitcroft } 6854a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 6864a0df2efSAndy Whitcroft $current_comment = ''; 6874a0df2efSAndy Whitcroft } 6884a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 6894a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 6904a0df2efSAndy Whitcroft $in_comment = 0; 6914a0df2efSAndy Whitcroft } 6924a0df2efSAndy Whitcroft } 6934a0df2efSAndy Whitcroft 6944a0df2efSAndy Whitcroft chomp($current_comment); 6954a0df2efSAndy Whitcroft return($current_comment); 6964a0df2efSAndy Whitcroft} 6974a0df2efSAndy Whitcroftsub ctx_has_comment { 6984a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 6994a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 7004a0df2efSAndy Whitcroft 70100df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 7024a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 7034a0df2efSAndy Whitcroft 7044a0df2efSAndy Whitcroft return ($cmt ne ''); 7054a0df2efSAndy Whitcroft} 7064a0df2efSAndy Whitcroft 7074d001e4dSAndy Whitcroftsub raw_line { 7084d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 7094d001e4dSAndy Whitcroft 7104d001e4dSAndy Whitcroft my $offset = $linenr - 1; 7114d001e4dSAndy Whitcroft $cnt++; 7124d001e4dSAndy Whitcroft 7134d001e4dSAndy Whitcroft my $line; 7144d001e4dSAndy Whitcroft while ($cnt) { 7154d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 7164d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 7174d001e4dSAndy Whitcroft $cnt--; 7184d001e4dSAndy Whitcroft } 7194d001e4dSAndy Whitcroft 7204d001e4dSAndy Whitcroft return $line; 7214d001e4dSAndy Whitcroft} 7224d001e4dSAndy Whitcroft 7230a920b5bSAndy Whitcroftsub cat_vet { 7240a920b5bSAndy Whitcroft my ($vet) = @_; 7259c0ca6f9SAndy Whitcroft my ($res, $coded); 7260a920b5bSAndy Whitcroft 7279c0ca6f9SAndy Whitcroft $res = ''; 7286c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 7296c72ffaaSAndy Whitcroft $res .= $1; 7306c72ffaaSAndy Whitcroft if ($2 ne '') { 7319c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 7326c72ffaaSAndy Whitcroft $res .= $coded; 7336c72ffaaSAndy Whitcroft } 7349c0ca6f9SAndy Whitcroft } 7359c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 7360a920b5bSAndy Whitcroft 7379c0ca6f9SAndy Whitcroft return $res; 7380a920b5bSAndy Whitcroft} 7390a920b5bSAndy Whitcroft 740c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 741cf655043SAndy Whitcroftmy $av_pending; 742c2fdda0dSAndy Whitcroftmy @av_paren_type; 7431f65f947SAndy Whitcroftmy $av_pend_colon; 744c2fdda0dSAndy Whitcroft 745c2fdda0dSAndy Whitcroftsub annotate_reset { 746c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 747cf655043SAndy Whitcroft $av_pending = '_'; 748cf655043SAndy Whitcroft @av_paren_type = ('E'); 7491f65f947SAndy Whitcroft $av_pend_colon = 'O'; 750c2fdda0dSAndy Whitcroft} 751c2fdda0dSAndy Whitcroft 7526c72ffaaSAndy Whitcroftsub annotate_values { 7536c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 7546c72ffaaSAndy Whitcroft 7556c72ffaaSAndy Whitcroft my $res; 7561f65f947SAndy Whitcroft my $var = '_' x length($stream); 7576c72ffaaSAndy Whitcroft my $cur = $stream; 7586c72ffaaSAndy Whitcroft 759c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 7606c72ffaaSAndy Whitcroft 7616c72ffaaSAndy Whitcroft while (length($cur)) { 762773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 763cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 764171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 7656c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 766c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 767c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 768cf655043SAndy Whitcroft $type = pop(@av_paren_type); 769c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 7706c72ffaaSAndy Whitcroft } 7716c72ffaaSAndy Whitcroft 7728ea3eb9aSAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) { 773c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 7746c72ffaaSAndy Whitcroft $type = 'T'; 7756c72ffaaSAndy Whitcroft 776389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 777389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 778389a2fe5SAndy Whitcroft $type = 'T'; 779389a2fe5SAndy Whitcroft 780c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 781171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 782c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 783171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 784171ae1a4SAndy Whitcroft if ($2 ne '') { 785cf655043SAndy Whitcroft $av_pending = 'N'; 786171ae1a4SAndy Whitcroft } 787171ae1a4SAndy Whitcroft $type = 'E'; 788171ae1a4SAndy Whitcroft 789c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 790171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 791171ae1a4SAndy Whitcroft $av_preprocessor = 1; 792171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 7936c72ffaaSAndy Whitcroft 794c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 795cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 796c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 797cf655043SAndy Whitcroft 798cf655043SAndy Whitcroft push(@av_paren_type, $type); 799cf655043SAndy Whitcroft push(@av_paren_type, $type); 800171ae1a4SAndy Whitcroft $type = 'E'; 801cf655043SAndy Whitcroft 802c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 803cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 804cf655043SAndy Whitcroft $av_preprocessor = 1; 805cf655043SAndy Whitcroft 806cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 807cf655043SAndy Whitcroft 808171ae1a4SAndy Whitcroft $type = 'E'; 809cf655043SAndy Whitcroft 810c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 811cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 812cf655043SAndy Whitcroft 813cf655043SAndy Whitcroft $av_preprocessor = 1; 814cf655043SAndy Whitcroft 815cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 816cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 817cf655043SAndy Whitcroft pop(@av_paren_type); 818cf655043SAndy Whitcroft push(@av_paren_type, $type); 819171ae1a4SAndy Whitcroft $type = 'E'; 8206c72ffaaSAndy Whitcroft 8216c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 822c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 8236c72ffaaSAndy Whitcroft 824171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 825171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 826171ae1a4SAndy Whitcroft $av_pending = $type; 827171ae1a4SAndy Whitcroft $type = 'N'; 828171ae1a4SAndy Whitcroft 8296c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 830c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 8316c72ffaaSAndy Whitcroft if (defined $2) { 832cf655043SAndy Whitcroft $av_pending = 'V'; 8336c72ffaaSAndy Whitcroft } 8346c72ffaaSAndy Whitcroft $type = 'N'; 8356c72ffaaSAndy Whitcroft 83614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 837c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 83814b111c1SAndy Whitcroft $av_pending = 'E'; 8396c72ffaaSAndy Whitcroft $type = 'N'; 8406c72ffaaSAndy Whitcroft 8411f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 8421f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 8431f65f947SAndy Whitcroft $av_pend_colon = 'C'; 8441f65f947SAndy Whitcroft $type = 'N'; 8451f65f947SAndy Whitcroft 84614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 847c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 8486c72ffaaSAndy Whitcroft $type = 'N'; 8496c72ffaaSAndy Whitcroft 8506c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 851c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 852cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 853cf655043SAndy Whitcroft $av_pending = '_'; 8546c72ffaaSAndy Whitcroft $type = 'N'; 8556c72ffaaSAndy Whitcroft 8566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 857cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 858cf655043SAndy Whitcroft if ($new_type ne '_') { 859cf655043SAndy Whitcroft $type = $new_type; 860c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 861c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 8626c72ffaaSAndy Whitcroft } else { 863c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 8646c72ffaaSAndy Whitcroft } 8656c72ffaaSAndy Whitcroft 866c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 867c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 868c8cb2ca3SAndy Whitcroft $type = 'V'; 869cf655043SAndy Whitcroft $av_pending = 'V'; 8706c72ffaaSAndy Whitcroft 8718e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 8728e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 8731f65f947SAndy Whitcroft $av_pend_colon = 'B'; 8748e761b04SAndy Whitcroft } elsif ($type eq 'E') { 8758e761b04SAndy Whitcroft $av_pend_colon = 'L'; 8761f65f947SAndy Whitcroft } 8771f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 8781f65f947SAndy Whitcroft $type = 'V'; 8791f65f947SAndy Whitcroft 8806c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 881c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 8826c72ffaaSAndy Whitcroft $type = 'V'; 8836c72ffaaSAndy Whitcroft 8846c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 885c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 8866c72ffaaSAndy Whitcroft $type = 'N'; 8876c72ffaaSAndy Whitcroft 888cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 889c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 89013214adfSAndy Whitcroft $type = 'E'; 8911f65f947SAndy Whitcroft $av_pend_colon = 'O'; 89213214adfSAndy Whitcroft 8938e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 8948e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 8958e761b04SAndy Whitcroft $type = 'C'; 8968e761b04SAndy Whitcroft 8971f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 8981f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 8991f65f947SAndy Whitcroft $type = 'N'; 9001f65f947SAndy Whitcroft 9011f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 9021f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 9031f65f947SAndy Whitcroft 9041f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 9051f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 9061f65f947SAndy Whitcroft $type = 'E'; 9071f65f947SAndy Whitcroft } else { 9081f65f947SAndy Whitcroft $type = 'N'; 9091f65f947SAndy Whitcroft } 9101f65f947SAndy Whitcroft $av_pend_colon = 'O'; 9111f65f947SAndy Whitcroft 9128e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 91313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 9146c72ffaaSAndy Whitcroft $type = 'N'; 9156c72ffaaSAndy Whitcroft 9160d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 91774048ed8SAndy Whitcroft my $variant; 91874048ed8SAndy Whitcroft 91974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 92074048ed8SAndy Whitcroft if ($type eq 'V') { 92174048ed8SAndy Whitcroft $variant = 'B'; 92274048ed8SAndy Whitcroft } else { 92374048ed8SAndy Whitcroft $variant = 'U'; 92474048ed8SAndy Whitcroft } 92574048ed8SAndy Whitcroft 92674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 92774048ed8SAndy Whitcroft $type = 'N'; 92874048ed8SAndy Whitcroft 9296c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 930c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 9316c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 9326c72ffaaSAndy Whitcroft $type = 'N'; 9336c72ffaaSAndy Whitcroft } 9346c72ffaaSAndy Whitcroft 9356c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 936c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 9376c72ffaaSAndy Whitcroft } 9386c72ffaaSAndy Whitcroft if (defined $1) { 9396c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 9406c72ffaaSAndy Whitcroft $res .= $type x length($1); 9416c72ffaaSAndy Whitcroft } 9426c72ffaaSAndy Whitcroft } 9436c72ffaaSAndy Whitcroft 9441f65f947SAndy Whitcroft return ($res, $var); 9456c72ffaaSAndy Whitcroft} 9466c72ffaaSAndy Whitcroft 9478905a67cSAndy Whitcroftsub possible { 94813214adfSAndy Whitcroft my ($possible, $line) = @_; 9498905a67cSAndy Whitcroft 9500776e594SAndy Whitcroft print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 9510776e594SAndy Whitcroft if ($possible !~ /(?: 9520776e594SAndy Whitcroft ^(?: 9530776e594SAndy Whitcroft $Modifier| 9540776e594SAndy Whitcroft $Storage| 9550776e594SAndy Whitcroft $Type| 9560776e594SAndy Whitcroft DEFINE_\S+| 9570776e594SAndy Whitcroft goto| 9580776e594SAndy Whitcroft return| 9590776e594SAndy Whitcroft case| 9600776e594SAndy Whitcroft else| 9610776e594SAndy Whitcroft asm|__asm__| 9620776e594SAndy Whitcroft do 9630776e594SAndy Whitcroft )$| 9640776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 9650776e594SAndy Whitcroft )/x) { 966c45dcabdSAndy Whitcroft # Check for modifiers. 967c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 968c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 969c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 970c45dcabdSAndy Whitcroft 971c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 972c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 973d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 974d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 975d2506586SAndy Whitcroft push(@modifierList, $modifier); 976d2506586SAndy Whitcroft } 977c45dcabdSAndy Whitcroft 978c45dcabdSAndy Whitcroft } else { 97913214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 9808905a67cSAndy Whitcroft push(@typeList, $possible); 981c45dcabdSAndy Whitcroft } 9828905a67cSAndy Whitcroft build_types(); 9830776e594SAndy Whitcroft } else { 9840776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 9858905a67cSAndy Whitcroft } 9868905a67cSAndy Whitcroft} 9878905a67cSAndy Whitcroft 9886c72ffaaSAndy Whitcroftmy $prefix = ''; 9896c72ffaaSAndy Whitcroft 990f0a594c1SAndy Whitcroftsub report { 991773647a0SAndy Whitcroft if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) { 992773647a0SAndy Whitcroft return 0; 993773647a0SAndy Whitcroft } 9948905a67cSAndy Whitcroft my $line = $prefix . $_[0]; 9958905a67cSAndy Whitcroft 9968905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 9978905a67cSAndy Whitcroft 99813214adfSAndy Whitcroft push(our @report, $line); 999773647a0SAndy Whitcroft 1000773647a0SAndy Whitcroft return 1; 1001f0a594c1SAndy Whitcroft} 1002f0a594c1SAndy Whitcroftsub report_dump { 100313214adfSAndy Whitcroft our @report; 1004f0a594c1SAndy Whitcroft} 1005de7d4f0eSAndy Whitcroftsub ERROR { 1006773647a0SAndy Whitcroft if (report("ERROR: $_[0]\n")) { 1007de7d4f0eSAndy Whitcroft our $clean = 0; 10086c72ffaaSAndy Whitcroft our $cnt_error++; 1009de7d4f0eSAndy Whitcroft } 1010773647a0SAndy Whitcroft} 1011de7d4f0eSAndy Whitcroftsub WARN { 1012773647a0SAndy Whitcroft if (report("WARNING: $_[0]\n")) { 1013de7d4f0eSAndy Whitcroft our $clean = 0; 10146c72ffaaSAndy Whitcroft our $cnt_warn++; 1015de7d4f0eSAndy Whitcroft } 1016773647a0SAndy Whitcroft} 1017de7d4f0eSAndy Whitcroftsub CHK { 1018773647a0SAndy Whitcroft if ($check && report("CHECK: $_[0]\n")) { 1019de7d4f0eSAndy Whitcroft our $clean = 0; 10206c72ffaaSAndy Whitcroft our $cnt_chk++; 10216c72ffaaSAndy Whitcroft } 1022de7d4f0eSAndy Whitcroft} 1023de7d4f0eSAndy Whitcroft 10246ecd9674SAndy Whitcroftsub check_absolute_file { 10256ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 10266ecd9674SAndy Whitcroft my $file = $absolute; 10276ecd9674SAndy Whitcroft 10286ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 10296ecd9674SAndy Whitcroft 10306ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 10316ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 10326ecd9674SAndy Whitcroft if (-f "$root/$file") { 10336ecd9674SAndy Whitcroft ##print "file<$file>\n"; 10346ecd9674SAndy Whitcroft last; 10356ecd9674SAndy Whitcroft } 10366ecd9674SAndy Whitcroft } 10376ecd9674SAndy Whitcroft if (! -f _) { 10386ecd9674SAndy Whitcroft return 0; 10396ecd9674SAndy Whitcroft } 10406ecd9674SAndy Whitcroft 10416ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 10426ecd9674SAndy Whitcroft my $prefix = $absolute; 10436ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 10446ecd9674SAndy Whitcroft 10456ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 10466ecd9674SAndy Whitcroft if ($prefix ne ".../") { 10476ecd9674SAndy Whitcroft WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr); 10486ecd9674SAndy Whitcroft } 10496ecd9674SAndy Whitcroft} 10506ecd9674SAndy Whitcroft 10510a920b5bSAndy Whitcroftsub process { 10520a920b5bSAndy Whitcroft my $filename = shift; 10530a920b5bSAndy Whitcroft 10540a920b5bSAndy Whitcroft my $linenr=0; 10550a920b5bSAndy Whitcroft my $prevline=""; 1056c2fdda0dSAndy Whitcroft my $prevrawline=""; 10570a920b5bSAndy Whitcroft my $stashline=""; 1058c2fdda0dSAndy Whitcroft my $stashrawline=""; 10590a920b5bSAndy Whitcroft 10604a0df2efSAndy Whitcroft my $length; 10610a920b5bSAndy Whitcroft my $indent; 10620a920b5bSAndy Whitcroft my $previndent=0; 10630a920b5bSAndy Whitcroft my $stashindent=0; 10640a920b5bSAndy Whitcroft 1065de7d4f0eSAndy Whitcroft our $clean = 1; 10660a920b5bSAndy Whitcroft my $signoff = 0; 10670a920b5bSAndy Whitcroft my $is_patch = 0; 10680a920b5bSAndy Whitcroft 106913214adfSAndy Whitcroft our @report = (); 10706c72ffaaSAndy Whitcroft our $cnt_lines = 0; 10716c72ffaaSAndy Whitcroft our $cnt_error = 0; 10726c72ffaaSAndy Whitcroft our $cnt_warn = 0; 10736c72ffaaSAndy Whitcroft our $cnt_chk = 0; 10746c72ffaaSAndy Whitcroft 10750a920b5bSAndy Whitcroft # Trace the real file/line as we go. 10760a920b5bSAndy Whitcroft my $realfile = ''; 10770a920b5bSAndy Whitcroft my $realline = 0; 10780a920b5bSAndy Whitcroft my $realcnt = 0; 10790a920b5bSAndy Whitcroft my $here = ''; 10800a920b5bSAndy Whitcroft my $in_comment = 0; 1081c2fdda0dSAndy Whitcroft my $comment_edge = 0; 10820a920b5bSAndy Whitcroft my $first_line = 0; 10831e855726SWolfram Sang my $p1_prefix = ''; 10840a920b5bSAndy Whitcroft 108513214adfSAndy Whitcroft my $prev_values = 'E'; 108613214adfSAndy Whitcroft 108713214adfSAndy Whitcroft # suppression flags 1088773647a0SAndy Whitcroft my %suppress_ifbraces; 1089170d3a22SAndy Whitcroft my %suppress_whiletrailers; 1090653d4876SAndy Whitcroft 1091c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1092de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1093c2fdda0dSAndy Whitcroft # 1094de7d4f0eSAndy Whitcroft my @setup_docs = (); 1095de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1096773647a0SAndy Whitcroft 1097773647a0SAndy Whitcroft sanitise_line_reset(); 1098c2fdda0dSAndy Whitcroft my $line; 1099c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1100773647a0SAndy Whitcroft $linenr++; 1101773647a0SAndy Whitcroft $line = $rawline; 1102c2fdda0dSAndy Whitcroft 1103773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1104de7d4f0eSAndy Whitcroft $setup_docs = 0; 1105de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1106de7d4f0eSAndy Whitcroft $setup_docs = 1; 1107de7d4f0eSAndy Whitcroft } 1108773647a0SAndy Whitcroft #next; 1109de7d4f0eSAndy Whitcroft } 1110773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1111773647a0SAndy Whitcroft $realline=$1-1; 1112773647a0SAndy Whitcroft if (defined $2) { 1113773647a0SAndy Whitcroft $realcnt=$3+1; 1114773647a0SAndy Whitcroft } else { 1115773647a0SAndy Whitcroft $realcnt=1+1; 1116773647a0SAndy Whitcroft } 1117c45dcabdSAndy Whitcroft $in_comment = 0; 1118773647a0SAndy Whitcroft 1119773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1120773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1121773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1122773647a0SAndy Whitcroft # at context start. 1123773647a0SAndy Whitcroft my $edge; 112401fa9147SAndy Whitcroft my $cnt = $realcnt; 112501fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 112601fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 112701fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 112801fa9147SAndy Whitcroft $cnt--; 112901fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1130721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1131fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1132fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1133fae17daeSAndy Whitcroft ($edge) = $1; 1134fae17daeSAndy Whitcroft last; 1135fae17daeSAndy Whitcroft } 1136773647a0SAndy Whitcroft } 1137773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1138773647a0SAndy Whitcroft $in_comment = 1; 1139773647a0SAndy Whitcroft } 1140773647a0SAndy Whitcroft 1141773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1142773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1143773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1144773647a0SAndy Whitcroft if (!defined $edge && 114583242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1146773647a0SAndy Whitcroft { 1147773647a0SAndy Whitcroft $in_comment = 1; 1148773647a0SAndy Whitcroft } 1149773647a0SAndy Whitcroft 1150773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1151773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1152773647a0SAndy Whitcroft 1153171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1154773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1155171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1156773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1157773647a0SAndy Whitcroft } 1158773647a0SAndy Whitcroft push(@lines, $line); 1159773647a0SAndy Whitcroft 1160773647a0SAndy Whitcroft if ($realcnt > 1) { 1161773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1162773647a0SAndy Whitcroft } else { 1163773647a0SAndy Whitcroft $realcnt = 0; 1164773647a0SAndy Whitcroft } 1165773647a0SAndy Whitcroft 1166773647a0SAndy Whitcroft #print "==>$rawline\n"; 1167773647a0SAndy Whitcroft #print "-->$line\n"; 1168de7d4f0eSAndy Whitcroft 1169de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1170de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1171de7d4f0eSAndy Whitcroft } 1172de7d4f0eSAndy Whitcroft } 1173de7d4f0eSAndy Whitcroft 11746c72ffaaSAndy Whitcroft $prefix = ''; 11756c72ffaaSAndy Whitcroft 1176773647a0SAndy Whitcroft $realcnt = 0; 1177773647a0SAndy Whitcroft $linenr = 0; 11780a920b5bSAndy Whitcroft foreach my $line (@lines) { 11790a920b5bSAndy Whitcroft $linenr++; 11800a920b5bSAndy Whitcroft 1181c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 118230670854SAndy Whitcroft my $hunk_line = ($realcnt != 0); 11836c72ffaaSAndy Whitcroft 11840a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 11856c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 11860a920b5bSAndy Whitcroft $is_patch = 1; 11874a0df2efSAndy Whitcroft $first_line = $linenr + 1; 11880a920b5bSAndy Whitcroft $realline=$1-1; 11890a920b5bSAndy Whitcroft if (defined $2) { 11900a920b5bSAndy Whitcroft $realcnt=$3+1; 11910a920b5bSAndy Whitcroft } else { 11920a920b5bSAndy Whitcroft $realcnt=1+1; 11930a920b5bSAndy Whitcroft } 1194c2fdda0dSAndy Whitcroft annotate_reset(); 119513214adfSAndy Whitcroft $prev_values = 'E'; 119613214adfSAndy Whitcroft 1197773647a0SAndy Whitcroft %suppress_ifbraces = (); 1198170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 11990a920b5bSAndy Whitcroft next; 12000a920b5bSAndy Whitcroft 12014a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 12024a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 12034a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1204773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 12050a920b5bSAndy Whitcroft $realline++; 1206d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 12070a920b5bSAndy Whitcroft 12084a0df2efSAndy Whitcroft # Measure the line length and indent. 1209c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 12100a920b5bSAndy Whitcroft 12110a920b5bSAndy Whitcroft # Track the previous line. 12120a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 12130a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1214c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1215c2fdda0dSAndy Whitcroft 1216773647a0SAndy Whitcroft #warn "line<$line>\n"; 12176c72ffaaSAndy Whitcroft 1218d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1219d8aaf121SAndy Whitcroft $realcnt--; 12200a920b5bSAndy Whitcroft } 12210a920b5bSAndy Whitcroft 12220a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1223773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1224773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1225773647a0SAndy Whitcroft 12266c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 12276c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1228773647a0SAndy Whitcroft 1229773647a0SAndy Whitcroft # extract the filename as it passes 1230773647a0SAndy Whitcroft if ($line=~/^\+\+\+\s+(\S+)/) { 1231773647a0SAndy Whitcroft $realfile = $1; 12321e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 12331e855726SWolfram Sang 12341e855726SWolfram Sang $p1_prefix = $1; 12351e855726SWolfram Sang if ($tree && $p1_prefix ne '' && -e "$root/$p1_prefix") { 12361e855726SWolfram Sang WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 12371e855726SWolfram Sang } 1238773647a0SAndy Whitcroft 1239c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1240773647a0SAndy Whitcroft ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1241773647a0SAndy Whitcroft } 1242773647a0SAndy Whitcroft next; 1243773647a0SAndy Whitcroft } 1244773647a0SAndy Whitcroft 1245389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 12460a920b5bSAndy Whitcroft 1247c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1248c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1249c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 12500a920b5bSAndy Whitcroft 12516c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 12526c72ffaaSAndy Whitcroft 12530a920b5bSAndy Whitcroft#check the patch for a signoff: 1254d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 12554a0df2efSAndy Whitcroft # This is a signoff, if ugly, so do not double report. 12564a0df2efSAndy Whitcroft $signoff++; 12570a920b5bSAndy Whitcroft if (!($line =~ /^\s*Signed-off-by:/)) { 1258de7d4f0eSAndy Whitcroft WARN("Signed-off-by: is the preferred form\n" . 1259de7d4f0eSAndy Whitcroft $herecurr); 12600a920b5bSAndy Whitcroft } 12610a920b5bSAndy Whitcroft if ($line =~ /^\s*signed-off-by:\S/i) { 1262773647a0SAndy Whitcroft WARN("space required after Signed-off-by:\n" . 1263de7d4f0eSAndy Whitcroft $herecurr); 12640a920b5bSAndy Whitcroft } 12650a920b5bSAndy Whitcroft } 12660a920b5bSAndy Whitcroft 126700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 12688905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1269de7d4f0eSAndy Whitcroft ERROR("patch seems to be corrupt (line wrapped?)\n" . 12706c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1271de7d4f0eSAndy Whitcroft } 1272de7d4f0eSAndy Whitcroft 12736ecd9674SAndy Whitcroft# Check for absolute kernel paths. 12746ecd9674SAndy Whitcroft if ($tree) { 12756ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 12766ecd9674SAndy Whitcroft my $file = $1; 12776ecd9674SAndy Whitcroft 12786ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 12796ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 12806ecd9674SAndy Whitcroft # 12816ecd9674SAndy Whitcroft } else { 12826ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 12836ecd9674SAndy Whitcroft } 12846ecd9674SAndy Whitcroft } 12856ecd9674SAndy Whitcroft } 12866ecd9674SAndy Whitcroft 1287de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1288de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1289171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1290171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1291171ae1a4SAndy Whitcroft 1292171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1293171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1294171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1295171ae1a4SAndy Whitcroft 1296171ae1a4SAndy Whitcroft ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 129700df344fSAndy Whitcroft } 12980a920b5bSAndy Whitcroft 129930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 130030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 130100df344fSAndy Whitcroft 13020a920b5bSAndy Whitcroft#trailing whitespace 13039c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1304c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 13059c0ca6f9SAndy Whitcroft ERROR("DOS line endings\n" . $herevet); 13069c0ca6f9SAndy Whitcroft 1307c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1308c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1309de7d4f0eSAndy Whitcroft ERROR("trailing whitespace\n" . $herevet); 13100a920b5bSAndy Whitcroft } 13115368df20SAndy Whitcroft 13125368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 13135368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 13145368df20SAndy Whitcroft 13150a920b5bSAndy Whitcroft#80 column limit 1316c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1317f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 1318f4c014c0SAndy Whitcroft $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ && 1319f4c014c0SAndy Whitcroft $length > 80) 1320c45dcabdSAndy Whitcroft { 1321de7d4f0eSAndy Whitcroft WARN("line over 80 characters\n" . $herecurr); 13220a920b5bSAndy Whitcroft } 13230a920b5bSAndy Whitcroft 13248905a67cSAndy Whitcroft# check for adding lines without a newline. 13258905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 13268905a67cSAndy Whitcroft WARN("adding a line without newline at end of file\n" . $herecurr); 13278905a67cSAndy Whitcroft } 13288905a67cSAndy Whitcroft 1329b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1330b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 13310a920b5bSAndy Whitcroft 13320a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 13330a920b5bSAndy Whitcroft# more than 8 must use tabs. 1334c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1335c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1336c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1337171ae1a4SAndy Whitcroft ERROR("code indent should use tabs where possible\n" . $herevet); 13380a920b5bSAndy Whitcroft } 13390a920b5bSAndy Whitcroft 1340b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1341b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1342b9ea10d6SAndy Whitcroft 1343c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1344cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1345c2fdda0dSAndy Whitcroft WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1346c2fdda0dSAndy Whitcroft } 134722f2a2efSAndy Whitcroft 13489c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 1349170d3a22SAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next); 13509c9ba34eSAndy Whitcroft if ($realcnt && $line =~ /.\s*\S/) { 1351170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1352f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1353171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1354171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1355171ae1a4SAndy Whitcroft 1356171ae1a4SAndy Whitcroft my $s = $stat; 1357171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1358cf655043SAndy Whitcroft 1359c2fdda0dSAndy Whitcroft # Ignore goto labels. 1360171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1361c2fdda0dSAndy Whitcroft 1362c2fdda0dSAndy Whitcroft # Ignore functions being called 1363171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1364c2fdda0dSAndy Whitcroft 1365c45dcabdSAndy Whitcroft # declarations always start with types 1366d2506586SAndy 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) { 1367c45dcabdSAndy Whitcroft my $type = $1; 1368c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1369c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1370c45dcabdSAndy Whitcroft 13716c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1372a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1373c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1374c2fdda0dSAndy Whitcroft } 13758905a67cSAndy Whitcroft 13766c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 137765863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1378c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 13799c0ca6f9SAndy Whitcroft } 13808905a67cSAndy Whitcroft 13818905a67cSAndy Whitcroft # Check for any sort of function declaration. 13828905a67cSAndy Whitcroft # int foo(something bar, other baz); 13838905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1384171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 13858905a67cSAndy Whitcroft my ($name_len) = length($1); 13868905a67cSAndy Whitcroft 1387cf655043SAndy Whitcroft my $ctx = $s; 1388773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 13898905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1390cf655043SAndy Whitcroft 13918905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1392c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 13938905a67cSAndy Whitcroft 1394c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 13958905a67cSAndy Whitcroft } 13968905a67cSAndy Whitcroft } 13978905a67cSAndy Whitcroft } 13988905a67cSAndy Whitcroft 13999c0ca6f9SAndy Whitcroft } 14009c0ca6f9SAndy Whitcroft 140100df344fSAndy Whitcroft# 140200df344fSAndy Whitcroft# Checks which may be anchored in the context. 140300df344fSAndy Whitcroft# 140400df344fSAndy Whitcroft 140500df344fSAndy Whitcroft# Check for switch () and associated case and default 140600df344fSAndy Whitcroft# statements should be at the same indent. 140700df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 140800df344fSAndy Whitcroft my $err = ''; 140900df344fSAndy Whitcroft my $sep = ''; 141000df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 141100df344fSAndy Whitcroft shift(@ctx); 141200df344fSAndy Whitcroft for my $ctx (@ctx) { 141300df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 141400df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 141500df344fSAndy Whitcroft $indent != $cindent) { 141600df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 141700df344fSAndy Whitcroft $sep = ''; 141800df344fSAndy Whitcroft } else { 141900df344fSAndy Whitcroft $sep = "[...]\n"; 142000df344fSAndy Whitcroft } 142100df344fSAndy Whitcroft } 142200df344fSAndy Whitcroft if ($err ne '') { 14239c0ca6f9SAndy Whitcroft ERROR("switch and case should be at the same indent\n$hereline$err"); 1424de7d4f0eSAndy Whitcroft } 1425de7d4f0eSAndy Whitcroft } 1426de7d4f0eSAndy Whitcroft 1427de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1428de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1429c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1430773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1431773647a0SAndy Whitcroft 14329c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1433de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1434de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1435de7d4f0eSAndy Whitcroft 1436548596d5SAndy Whitcroft my $ctx_ln = $linenr; 1437548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 1438de7d4f0eSAndy Whitcroft 1439548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1440548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 1441548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 1442548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1443548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1444773647a0SAndy Whitcroft $ctx_ln++; 1445773647a0SAndy Whitcroft } 1446548596d5SAndy Whitcroft 144753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 144853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1449773647a0SAndy Whitcroft 1450773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1451773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . 1452c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 145300df344fSAndy Whitcroft } 1454773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1455773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1456773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1457773647a0SAndy Whitcroft { 14589c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 14599c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1460773647a0SAndy Whitcroft WARN("trailing semicolon indicates no statements, indent implies otherwise\n" . 1461c45dcabdSAndy Whitcroft "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); 14629c0ca6f9SAndy Whitcroft } 14639c0ca6f9SAndy Whitcroft } 146400df344fSAndy Whitcroft } 146500df344fSAndy Whitcroft 14664d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 14674d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 14684d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 14694d001e4dSAndy Whitcroft 14704d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 14714d001e4dSAndy Whitcroft 14724d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 14734d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 14744d001e4dSAndy Whitcroft # where necessary. 14754d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 14764d001e4dSAndy Whitcroft 14774d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 14786f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 14796f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 14804d001e4dSAndy Whitcroft 14814d001e4dSAndy Whitcroft # We want to check the first line inside the block 14824d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 14834d001e4dSAndy Whitcroft # 1) any blank line termination 14844d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 14854d001e4dSAndy Whitcroft # 3) any do (...) { 14864d001e4dSAndy Whitcroft my $continuation = 0; 14874d001e4dSAndy Whitcroft my $check = 0; 14884d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 14894d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 14904d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 14914d001e4dSAndy Whitcroft $continuation = 1; 14924d001e4dSAndy Whitcroft } 14939bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 14944d001e4dSAndy Whitcroft $check = 1; 14954d001e4dSAndy Whitcroft $cond_lines++; 14964d001e4dSAndy Whitcroft } 14974d001e4dSAndy Whitcroft 14984d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 14994d001e4dSAndy Whitcroft # preprocessor statement. 15004d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 15014d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 15024d001e4dSAndy Whitcroft $check = 0; 15034d001e4dSAndy Whitcroft } 15044d001e4dSAndy Whitcroft 15059bd49efeSAndy Whitcroft my $cond_ptr = -1; 1506740504c6SAndy Whitcroft $continuation = 0; 15079bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 15089bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 15094d001e4dSAndy Whitcroft 1510f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 1511f16fa28fSAndy Whitcroft # is not linear. 1512f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1513f16fa28fSAndy Whitcroft $check = 0; 1514f16fa28fSAndy Whitcroft } 1515f16fa28fSAndy Whitcroft 15169bd49efeSAndy Whitcroft # Ignore: 15179bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 15189bd49efeSAndy Whitcroft # 2) preprocessor lines, and 15199bd49efeSAndy Whitcroft # 3) labels. 1520740504c6SAndy Whitcroft if ($continuation || 1521740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 15229bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 15239bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 1524740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 15259bd49efeSAndy Whitcroft $s =~ s/^.*?\n//; 15269bd49efeSAndy Whitcroft $cond_lines++; 15279bd49efeSAndy Whitcroft } 15284d001e4dSAndy Whitcroft } 15294d001e4dSAndy Whitcroft 15304d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 15314d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 15324d001e4dSAndy Whitcroft 15334d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 15344d001e4dSAndy Whitcroft # this is not this patch's fault. 15354d001e4dSAndy Whitcroft if (!defined($stat_real) || 15364d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 15374d001e4dSAndy Whitcroft $check = 0; 15384d001e4dSAndy Whitcroft } 15394d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 15404d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 15414d001e4dSAndy Whitcroft } 15424d001e4dSAndy Whitcroft 15439bd49efeSAndy 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"; 15444d001e4dSAndy Whitcroft 15454d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 15464d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 15474d001e4dSAndy Whitcroft WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 15484d001e4dSAndy Whitcroft } 15494d001e4dSAndy Whitcroft } 15504d001e4dSAndy Whitcroft 15516c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 15526c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 15531f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 15541f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 15556c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 1556c2fdda0dSAndy Whitcroft if ($dbg_values) { 1557c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 1558cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 1559cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 15601f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 1561c2fdda0dSAndy Whitcroft } 15626c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 15636c72ffaaSAndy Whitcroft 156400df344fSAndy Whitcroft#ignore lines not being added 156500df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 156600df344fSAndy Whitcroft 1567653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 15687429c690SAndy Whitcroft if ($dbg_type) { 15697429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 15707429c690SAndy Whitcroft ERROR("TEST: is type\n" . $herecurr); 15717429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 15727429c690SAndy Whitcroft ERROR("TEST: is not type ($1 is)\n". $herecurr); 15737429c690SAndy Whitcroft } 1574653d4876SAndy Whitcroft next; 1575653d4876SAndy Whitcroft } 1576a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 1577a1ef277eSAndy Whitcroft if ($dbg_attr) { 1578a1ef277eSAndy Whitcroft if ($line =~ /^.\s*$Attribute\s*$/) { 1579a1ef277eSAndy Whitcroft ERROR("TEST: is attr\n" . $herecurr); 1580a1ef277eSAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) { 1581a1ef277eSAndy Whitcroft ERROR("TEST: is not attr ($1 is)\n". $herecurr); 1582a1ef277eSAndy Whitcroft } 1583a1ef277eSAndy Whitcroft next; 1584a1ef277eSAndy Whitcroft } 1585653d4876SAndy Whitcroft 1586f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 1587f0a594c1SAndy Whitcroft if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ && 1588f0a594c1SAndy Whitcroft $line =~ /^.\s*{/) { 1589773647a0SAndy Whitcroft ERROR("that open brace { should be on the previous line\n" . $hereprev); 1590f0a594c1SAndy Whitcroft } 1591f0a594c1SAndy Whitcroft 159200df344fSAndy Whitcroft# 159300df344fSAndy Whitcroft# Checks which are anchored on the added line. 159400df344fSAndy Whitcroft# 159500df344fSAndy Whitcroft 1596653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 1597c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 1598653d4876SAndy Whitcroft my $path = $1; 1599653d4876SAndy Whitcroft if ($path =~ m{//}) { 1600de7d4f0eSAndy Whitcroft ERROR("malformed #include filename\n" . 1601de7d4f0eSAndy Whitcroft $herecurr); 1602653d4876SAndy Whitcroft } 1603653d4876SAndy Whitcroft } 1604653d4876SAndy Whitcroft 160500df344fSAndy Whitcroft# no C99 // comments 160600df344fSAndy Whitcroft if ($line =~ m{//}) { 1607de7d4f0eSAndy Whitcroft ERROR("do not use C99 // comments\n" . $herecurr); 160800df344fSAndy Whitcroft } 160900df344fSAndy Whitcroft # Remove C99 comments. 16100a920b5bSAndy Whitcroft $line =~ s@//.*@@; 16116c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 16120a920b5bSAndy Whitcroft 16130a920b5bSAndy Whitcroft#EXPORT_SYMBOL should immediately follow its function closing }. 1614653d4876SAndy Whitcroft if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) || 1615653d4876SAndy Whitcroft ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 1616653d4876SAndy Whitcroft my $name = $1; 161748012058SAndy Whitcroft if ($prevline !~ /(?: 161848012058SAndy Whitcroft ^.}| 161948012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 162048012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 162148012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 162248012058SAndy Whitcroft ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 162348012058SAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[) 162448012058SAndy Whitcroft )/x) { 1625de7d4f0eSAndy Whitcroft WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 16260a920b5bSAndy Whitcroft } 16270a920b5bSAndy Whitcroft } 16280a920b5bSAndy Whitcroft 1629f0a594c1SAndy Whitcroft# check for external initialisers. 1630c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 1631f0a594c1SAndy Whitcroft ERROR("do not initialise externals to 0 or NULL\n" . 1632f0a594c1SAndy Whitcroft $herecurr); 1633f0a594c1SAndy Whitcroft } 16340a920b5bSAndy Whitcroft# check for static initialisers. 16359c9ba34eSAndy Whitcroft if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) { 1636de7d4f0eSAndy Whitcroft ERROR("do not initialise statics to 0 or NULL\n" . 1637de7d4f0eSAndy Whitcroft $herecurr); 16380a920b5bSAndy Whitcroft } 16390a920b5bSAndy Whitcroft 1640653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 1641653d4876SAndy Whitcroft# make sense. 1642653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 16438054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 1644c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 16458ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 1646653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 1647de7d4f0eSAndy Whitcroft WARN("do not add new typedefs\n" . $herecurr); 16480a920b5bSAndy Whitcroft } 16490a920b5bSAndy Whitcroft 16500a920b5bSAndy Whitcroft# * goes on variable not on type 165165863862SAndy Whitcroft # (char*[ const]) 165265863862SAndy Whitcroft if ($line =~ m{\($NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)*)\)}) { 165365863862SAndy Whitcroft my ($from, $to) = ($1, $1); 1654d8aaf121SAndy Whitcroft 165565863862SAndy Whitcroft # Should start with a space. 165665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 165765863862SAndy Whitcroft # Should not end with a space. 165865863862SAndy Whitcroft $to =~ s/\s+$//; 165965863862SAndy Whitcroft # '*'s should not have spaces between. 166065863862SAndy Whitcroft while ($to =~ s/(.)\s\*/$1\*/) { 166165863862SAndy Whitcroft } 1662d8aaf121SAndy Whitcroft 166365863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 166465863862SAndy Whitcroft if ($from ne $to) { 166565863862SAndy Whitcroft ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 166665863862SAndy Whitcroft } 166765863862SAndy Whitcroft } elsif ($line =~ m{\b$NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)?)($Ident)}) { 166865863862SAndy Whitcroft my ($from, $to, $ident) = ($1, $1, $2); 1669d8aaf121SAndy Whitcroft 167065863862SAndy Whitcroft # Should start with a space. 167165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 167265863862SAndy Whitcroft # Should not end with a space. 167365863862SAndy Whitcroft $to =~ s/\s+$//; 167465863862SAndy Whitcroft # '*'s should not have spaces between. 167565863862SAndy Whitcroft while ($to =~ s/(.)\s\*/$1\*/) { 167665863862SAndy Whitcroft } 167765863862SAndy Whitcroft # Modifiers should have spaces. 167865863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 167965863862SAndy Whitcroft 168065863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 168165863862SAndy Whitcroft if ($from ne $to) { 168265863862SAndy Whitcroft ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 168365863862SAndy Whitcroft } 16840a920b5bSAndy Whitcroft } 16850a920b5bSAndy Whitcroft 16860a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 16870a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 16880a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 16890a920b5bSAndy Whitcroft# print "$herecurr"; 16900a920b5bSAndy Whitcroft# $clean = 0; 16910a920b5bSAndy Whitcroft# } 16920a920b5bSAndy Whitcroft 16938905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 1694c2fdda0dSAndy Whitcroft WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 16958905a67cSAndy Whitcroft } 16968905a67cSAndy Whitcroft 169700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 169800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 169900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 170000df344fSAndy Whitcroft# printk includes all preceeding printk's which have no newline on the end. 170100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 1702f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 170300df344fSAndy Whitcroft my $ok = 0; 170400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 170500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 170600df344fSAndy Whitcroft # we have a preceeding printk if it ends 170700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 170800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 170900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 171000df344fSAndy Whitcroft $ok = 1; 171100df344fSAndy Whitcroft } 171200df344fSAndy Whitcroft last; 171300df344fSAndy Whitcroft } 171400df344fSAndy Whitcroft } 171500df344fSAndy Whitcroft if ($ok == 0) { 1716de7d4f0eSAndy Whitcroft WARN("printk() should include KERN_ facility level\n" . $herecurr); 17170a920b5bSAndy Whitcroft } 171800df344fSAndy Whitcroft } 17190a920b5bSAndy Whitcroft 1720653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 1721653d4876SAndy Whitcroft# or if closed on same line 1722c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 1723c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 1724de7d4f0eSAndy Whitcroft ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 17250a920b5bSAndy Whitcroft } 1726653d4876SAndy Whitcroft 17278905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 17288905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 17298905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 17308905a67cSAndy Whitcroft ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 17318905a67cSAndy Whitcroft } 17328905a67cSAndy Whitcroft 17338d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 17348d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 1735fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 1736fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 17378d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 17388d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 17398d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 1740fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 1741fe2a7dbcSAndy Whitcroft $prefix !~ /{\s+$/) { 17428d31cfceSAndy Whitcroft ERROR("space prohibited before open square bracket '['\n" . $herecurr); 17438d31cfceSAndy Whitcroft } 17448d31cfceSAndy Whitcroft } 17458d31cfceSAndy Whitcroft 1746f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 17476c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 1748c2fdda0dSAndy Whitcroft my $name = $1; 1749773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 1750773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 1751c2fdda0dSAndy Whitcroft 1752c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 1753773647a0SAndy Whitcroft if ($name =~ /^(?: 1754773647a0SAndy Whitcroft if|for|while|switch|return|case| 1755773647a0SAndy Whitcroft volatile|__volatile__| 1756773647a0SAndy Whitcroft __attribute__|format|__extension__| 1757773647a0SAndy Whitcroft asm|__asm__)$/x) 1758773647a0SAndy Whitcroft { 1759c2fdda0dSAndy Whitcroft 1760c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 1761c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 1762c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 1763c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 1764773647a0SAndy Whitcroft 1765773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 1766c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 1767c2fdda0dSAndy Whitcroft 1768c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 1769c2fdda0dSAndy Whitcroft # likely a typedef for a function. 1770773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 1771c2fdda0dSAndy Whitcroft 1772c2fdda0dSAndy Whitcroft } else { 1773773647a0SAndy Whitcroft WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr); 1774f0a594c1SAndy Whitcroft } 17756c72ffaaSAndy Whitcroft } 1776653d4876SAndy Whitcroft# Check operator spacing. 17770a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 17789c0ca6f9SAndy Whitcroft my $ops = qr{ 17799c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 17809c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 17819c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 17821f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 17831f65f947SAndy Whitcroft \?|: 17849c0ca6f9SAndy Whitcroft }x; 1785cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 178600df344fSAndy Whitcroft my $off = 0; 17876c72ffaaSAndy Whitcroft 17886c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 17896c72ffaaSAndy Whitcroft 17900a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 17914a0df2efSAndy Whitcroft $off += length($elements[$n]); 17924a0df2efSAndy Whitcroft 1793773647a0SAndy Whitcroft # Pick up the preceeding and succeeding characters. 1794773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 1795773647a0SAndy Whitcroft my $cc = ''; 1796773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 1797773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 1798773647a0SAndy Whitcroft } 1799773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 1800773647a0SAndy Whitcroft 18014a0df2efSAndy Whitcroft my $a = ''; 18024a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 18034a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 1804cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 18054a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 18064a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 1807773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 18084a0df2efSAndy Whitcroft 18090a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 18104a0df2efSAndy Whitcroft 18114a0df2efSAndy Whitcroft my $c = ''; 18120a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 18134a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 18144a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 1815cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 18164a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 18174a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 18188b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 18194a0df2efSAndy Whitcroft } else { 18204a0df2efSAndy Whitcroft $c = 'E'; 18210a920b5bSAndy Whitcroft } 18220a920b5bSAndy Whitcroft 18234a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 18244a0df2efSAndy Whitcroft 18254a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 18264a0df2efSAndy Whitcroft 18276c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 1828de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 18290a920b5bSAndy Whitcroft 183074048ed8SAndy Whitcroft # Pull out the value of this operator. 18316c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 18320a920b5bSAndy Whitcroft 18331f65f947SAndy Whitcroft # Get the full operator variant. 18341f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 18351f65f947SAndy Whitcroft 183613214adfSAndy Whitcroft # Ignore operators passed as parameters. 183713214adfSAndy Whitcroft if ($op_type ne 'V' && 183813214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 183913214adfSAndy Whitcroft 1840cf655043SAndy Whitcroft# # Ignore comments 1841cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 184213214adfSAndy Whitcroft 1843d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 184413214adfSAndy Whitcroft } elsif ($op eq ';') { 1845cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 1846cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 1847773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 1848d8aaf121SAndy Whitcroft } 1849d8aaf121SAndy Whitcroft 1850d8aaf121SAndy Whitcroft # // is a comment 1851d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 18520a920b5bSAndy Whitcroft 18531f65f947SAndy Whitcroft # No spaces for: 18541f65f947SAndy Whitcroft # -> 18551f65f947SAndy Whitcroft # : when part of a bitfield 18561f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 18574a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 1858773647a0SAndy Whitcroft ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 18590a920b5bSAndy Whitcroft } 18600a920b5bSAndy Whitcroft 18610a920b5bSAndy Whitcroft # , must have a space on the right. 18620a920b5bSAndy Whitcroft } elsif ($op eq ',') { 1863cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 1864773647a0SAndy Whitcroft ERROR("space required after that '$op' $at\n" . $hereptr); 18650a920b5bSAndy Whitcroft } 18660a920b5bSAndy Whitcroft 18679c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 186874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 18699c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 18709c0ca6f9SAndy Whitcroft 18719c0ca6f9SAndy Whitcroft # unary operators should have a space before and 18729c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 18739c0ca6f9SAndy Whitcroft # unary operator, or a cast 18749c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 187574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 18760d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 1877cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 1878773647a0SAndy Whitcroft ERROR("space required before that '$op' $at\n" . $hereptr); 18790a920b5bSAndy Whitcroft } 1880171ae1a4SAndy Whitcroft if ($op eq '*' && $cc =~/\s*const\b/) { 1881171ae1a4SAndy Whitcroft # A unary '*' may be const 1882171ae1a4SAndy Whitcroft 1883171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 1884773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 18850a920b5bSAndy Whitcroft } 18860a920b5bSAndy Whitcroft 18870a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 18880a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 1889773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 1890773647a0SAndy Whitcroft ERROR("space required one side of that '$op' $at\n" . $hereptr); 18910a920b5bSAndy Whitcroft } 1892773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 1893773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 1894773647a0SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 1895653d4876SAndy Whitcroft } 1896773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 1897773647a0SAndy Whitcroft ERROR("space prohibited after that '$op' $at\n" . $hereptr); 1898773647a0SAndy Whitcroft } 1899773647a0SAndy Whitcroft 19000a920b5bSAndy Whitcroft 19010a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 19029c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 19039c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 19049c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 1905c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 1906c2fdda0dSAndy Whitcroft $op eq '%') 19070a920b5bSAndy Whitcroft { 1908773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 1909de7d4f0eSAndy Whitcroft ERROR("need consistent spacing around '$op' $at\n" . 1910de7d4f0eSAndy Whitcroft $hereptr); 19110a920b5bSAndy Whitcroft } 19120a920b5bSAndy Whitcroft 19131f65f947SAndy Whitcroft # A colon needs no spaces before when it is 19141f65f947SAndy Whitcroft # terminating a case value or a label. 19151f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 19161f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 19171f65f947SAndy Whitcroft ERROR("space prohibited before that '$op' $at\n" . $hereptr); 19181f65f947SAndy Whitcroft } 19191f65f947SAndy Whitcroft 19200a920b5bSAndy Whitcroft # All the others need spaces both sides. 1921cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 19221f65f947SAndy Whitcroft my $ok = 0; 19231f65f947SAndy Whitcroft 192422f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 19251f65f947SAndy Whitcroft if (($op eq '<' && 19261f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 19271f65f947SAndy Whitcroft ($op eq '>' && 19281f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 19291f65f947SAndy Whitcroft { 19301f65f947SAndy Whitcroft $ok = 1; 19311f65f947SAndy Whitcroft } 19321f65f947SAndy Whitcroft 19331f65f947SAndy Whitcroft # Ignore ?: 19341f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 19351f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 19361f65f947SAndy Whitcroft $ok = 1; 19371f65f947SAndy Whitcroft } 19381f65f947SAndy Whitcroft 19391f65f947SAndy Whitcroft if ($ok == 0) { 1940773647a0SAndy Whitcroft ERROR("spaces required around that '$op' $at\n" . $hereptr); 19410a920b5bSAndy Whitcroft } 194222f2a2efSAndy Whitcroft } 19434a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 19440a920b5bSAndy Whitcroft } 19450a920b5bSAndy Whitcroft } 19460a920b5bSAndy Whitcroft 1947f0a594c1SAndy Whitcroft# check for multiple assignments 1948f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 19496c72ffaaSAndy Whitcroft CHK("multiple assignments should be avoided\n" . $herecurr); 1950f0a594c1SAndy Whitcroft } 1951f0a594c1SAndy Whitcroft 195222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 195322f2a2efSAndy Whitcroft## # continuation. 195422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 195522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 195622f2a2efSAndy Whitcroft## 195722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 195822f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 195922f2a2efSAndy Whitcroft## my $ln = $line; 196022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 196122f2a2efSAndy Whitcroft## } 196222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 196322f2a2efSAndy Whitcroft## WARN("declaring multiple variables together should be avoided\n" . $herecurr); 196422f2a2efSAndy Whitcroft## } 196522f2a2efSAndy Whitcroft## } 1966f0a594c1SAndy Whitcroft 19670a920b5bSAndy Whitcroft#need space before brace following if, while, etc 196822f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 196922f2a2efSAndy Whitcroft $line =~ /do{/) { 1970773647a0SAndy Whitcroft ERROR("space required before the open brace '{'\n" . $herecurr); 1971de7d4f0eSAndy Whitcroft } 1972de7d4f0eSAndy Whitcroft 1973de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 1974de7d4f0eSAndy Whitcroft# on the line 1975de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 1976773647a0SAndy Whitcroft ERROR("space required after that close brace '}'\n" . $herecurr); 19770a920b5bSAndy Whitcroft } 19780a920b5bSAndy Whitcroft 197922f2a2efSAndy Whitcroft# check spacing on square brackets 198022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 1981773647a0SAndy Whitcroft ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 198222f2a2efSAndy Whitcroft } 198322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 1984773647a0SAndy Whitcroft ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 198522f2a2efSAndy Whitcroft } 198622f2a2efSAndy Whitcroft 1987c45dcabdSAndy Whitcroft# check spacing on parentheses 19889c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 19899c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 1990773647a0SAndy Whitcroft ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 199122f2a2efSAndy Whitcroft } 199213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 1993c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 1994c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 1995773647a0SAndy Whitcroft ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 199622f2a2efSAndy Whitcroft } 199722f2a2efSAndy Whitcroft 19980a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 19994a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 20000a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2001de7d4f0eSAndy Whitcroft WARN("labels should not be indented\n" . $herecurr); 20020a920b5bSAndy Whitcroft } 20030a920b5bSAndy Whitcroft 2004c45dcabdSAndy Whitcroft# Return is not a function. 2005c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2006c45dcabdSAndy Whitcroft my $spacing = $1; 2007c45dcabdSAndy Whitcroft my $value = $2; 2008c45dcabdSAndy Whitcroft 200986f9d059SAndy Whitcroft # Flatten any parentheses 2010fee61c47SAndy Whitcroft $value =~ s/\)\(/\) \(/g; 201186f9d059SAndy Whitcroft while ($value !~ /(?:$Ident|-?$Constant)\s*$Compare\s*(?:$Ident|-?$Constant)/ && $value =~ s/\([^\(\)]*\)/1/) { 2012c45dcabdSAndy Whitcroft } 2013c45dcabdSAndy Whitcroft 2014c45dcabdSAndy Whitcroft if ($value =~ /^(?:$Ident|-?$Constant)$/) { 2015c45dcabdSAndy Whitcroft ERROR("return is not a function, parentheses are not required\n" . $herecurr); 2016c45dcabdSAndy Whitcroft 2017c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2018c45dcabdSAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 2019c45dcabdSAndy Whitcroft } 2020c45dcabdSAndy Whitcroft } 2021c45dcabdSAndy Whitcroft 20220a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 20234a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2024773647a0SAndy Whitcroft ERROR("space required before the open parenthesis '('\n" . $herecurr); 20250a920b5bSAndy Whitcroft } 20260a920b5bSAndy Whitcroft 2027f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2028f5fe35ddSAndy Whitcroft# statements after the conditional. 2029170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 2030170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2031170d3a22SAndy Whitcroft $remain_next, $off_next); 2032170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2033170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2034170d3a22SAndy Whitcroft 2035170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2036170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2037170d3a22SAndy Whitcroft # then count those as offsets. 2038170d3a22SAndy Whitcroft my ($whitespace) = 2039170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2040170d3a22SAndy Whitcroft my $offset = 2041170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2042170d3a22SAndy Whitcroft 2043170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2044170d3a22SAndy Whitcroft $offset} = 1; 2045170d3a22SAndy Whitcroft } 2046170d3a22SAndy Whitcroft } 2047170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2048170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2049171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 20508905a67cSAndy Whitcroft 20518905a67cSAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) { 2052c2fdda0dSAndy Whitcroft ERROR("do not use assignment in if condition\n" . $herecurr); 20538905a67cSAndy Whitcroft } 20548905a67cSAndy Whitcroft 20558905a67cSAndy Whitcroft # Find out what is on the end of the line after the 20568905a67cSAndy Whitcroft # conditional. 2057773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 20588905a67cSAndy Whitcroft $s =~ s/\n.*//g; 205913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 206053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 206153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2062773647a0SAndy Whitcroft { 2063bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2064bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2065bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 2066bb44ad39SAndy Whitcroft 2067bb44ad39SAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 2068bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2069bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2070bb44ad39SAndy Whitcroft } 2071bb44ad39SAndy Whitcroft 2072bb44ad39SAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); 20738905a67cSAndy Whitcroft } 20748905a67cSAndy Whitcroft } 20758905a67cSAndy Whitcroft 207613214adfSAndy Whitcroft# Check for bitwise tests written as boolean 207713214adfSAndy Whitcroft if ($line =~ / 207813214adfSAndy Whitcroft (?: 207913214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 208013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 208113214adfSAndy Whitcroft (?:\&\&|\|\|) 208213214adfSAndy Whitcroft | 208313214adfSAndy Whitcroft (?:\&\&|\|\|) 208413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 208513214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 208613214adfSAndy Whitcroft )/x) 208713214adfSAndy Whitcroft { 208813214adfSAndy Whitcroft WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 208913214adfSAndy Whitcroft } 209013214adfSAndy Whitcroft 20918905a67cSAndy Whitcroft# if and else should not have general statements after it 209213214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 209313214adfSAndy Whitcroft my $s = $1; 209413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 209513214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 20968905a67cSAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 20970a920b5bSAndy Whitcroft } 209813214adfSAndy Whitcroft } 2099a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2100a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2101a1080bf8SAndy Whitcroft $line !~ /\G(?: 21023fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2103a1080bf8SAndy Whitcroft \s*return\s+ 2104a1080bf8SAndy Whitcroft )/xg) 2105a1080bf8SAndy Whitcroft { 2106a1080bf8SAndy Whitcroft ERROR("trailing statements should be on next line\n" . $herecurr); 2107a1080bf8SAndy Whitcroft } 21080a920b5bSAndy Whitcroft 21090a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 21100a920b5bSAndy Whitcroft # indent level to be relevant to each other. 21110a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 21120a920b5bSAndy Whitcroft $previndent == $indent) { 2113de7d4f0eSAndy Whitcroft ERROR("else should follow close brace '}'\n" . $hereprev); 21140a920b5bSAndy Whitcroft } 21150a920b5bSAndy Whitcroft 2116c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2117c2fdda0dSAndy Whitcroft $previndent == $indent) { 2118c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2119c2fdda0dSAndy Whitcroft 2120c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2121c2fdda0dSAndy Whitcroft # conditional. 2122773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2123c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2124c2fdda0dSAndy Whitcroft 2125c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2126c2fdda0dSAndy Whitcroft ERROR("while should follow close brace '}'\n" . $hereprev); 2127c2fdda0dSAndy Whitcroft } 2128c2fdda0dSAndy Whitcroft } 2129c2fdda0dSAndy Whitcroft 21300a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 21310a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 21320a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 21330a920b5bSAndy Whitcroft# print "$herecurr"; 21340a920b5bSAndy Whitcroft# $clean = 0; 21350a920b5bSAndy Whitcroft# } 21360a920b5bSAndy Whitcroft 21370a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2138c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2139de7d4f0eSAndy Whitcroft WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr); 21400a920b5bSAndy Whitcroft } 21410a920b5bSAndy Whitcroft 2142653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2143c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2144e09dec48SAndy Whitcroft my $file = "$1.h"; 2145e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2146e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2147e09dec48SAndy Whitcroft $realfile ne $checkfile && 2148c45dcabdSAndy Whitcroft $1 ne 'irq') 2149c45dcabdSAndy Whitcroft { 2150e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2151e09dec48SAndy Whitcroft CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2152e09dec48SAndy Whitcroft } else { 2153e09dec48SAndy Whitcroft WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2154e09dec48SAndy Whitcroft } 21550a920b5bSAndy Whitcroft } 21560a920b5bSAndy Whitcroft } 21570a920b5bSAndy Whitcroft 2158653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2159653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2160cf655043SAndy Whitcroft# in a known good container 2161b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2162b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2163d8aaf121SAndy Whitcroft my $ln = $linenr; 2164d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2165c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2166c45dcabdSAndy Whitcroft my $ctx = ''; 2167653d4876SAndy Whitcroft 2168c45dcabdSAndy Whitcroft my $args = defined($1); 2169de7d4f0eSAndy Whitcroft 2170c45dcabdSAndy Whitcroft # Find the end of the macro and limit our statement 2171c45dcabdSAndy Whitcroft # search to that. 2172c45dcabdSAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1] && 2173c45dcabdSAndy Whitcroft $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2174c45dcabdSAndy Whitcroft { 2175c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1] . "\n"; 2176a3bb97a7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 2177c45dcabdSAndy Whitcroft $ln++; 2178de7d4f0eSAndy Whitcroft } 2179c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1]; 2180d8aaf121SAndy Whitcroft 2181c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2182c45dcabdSAndy Whitcroft ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2183c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2184a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2185c45dcabdSAndy Whitcroft 2186c45dcabdSAndy Whitcroft # Extract the remainder of the define (if any) and 2187c45dcabdSAndy Whitcroft # rip off surrounding spaces, and trailing \'s. 2188c45dcabdSAndy Whitcroft $rest = ''; 2189636d140aSAndy Whitcroft while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2190636d140aSAndy Whitcroft #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2191a3bb97a7SAndy Whitcroft if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2192c45dcabdSAndy Whitcroft $rest .= substr($lines[$ln - 1], $off) . "\n"; 2193c45dcabdSAndy Whitcroft $cnt--; 2194a3bb97a7SAndy Whitcroft } 2195a3bb97a7SAndy Whitcroft $ln++; 2196c45dcabdSAndy Whitcroft $off = 0; 2197c45dcabdSAndy Whitcroft } 2198c45dcabdSAndy Whitcroft $rest =~ s/\\\n.//g; 2199c45dcabdSAndy Whitcroft $rest =~ s/^\s*//s; 2200c45dcabdSAndy Whitcroft $rest =~ s/\s*$//s; 2201c45dcabdSAndy Whitcroft 2202c45dcabdSAndy Whitcroft # Clean up the original statement. 2203c45dcabdSAndy Whitcroft if ($args) { 2204c45dcabdSAndy Whitcroft substr($dstat, 0, length($dcond), ''); 2205d8aaf121SAndy Whitcroft } else { 2206c45dcabdSAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2207c45dcabdSAndy Whitcroft } 2208292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2209c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2210c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2211c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2212c45dcabdSAndy Whitcroft 2213c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2214bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2215bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2216bf30d6edSAndy Whitcroft $dstat =~ s/\[[^\{\}]*\]/1/) 2217bf30d6edSAndy Whitcroft { 2218c45dcabdSAndy Whitcroft } 2219c45dcabdSAndy Whitcroft 2220c45dcabdSAndy Whitcroft my $exceptions = qr{ 2221c45dcabdSAndy Whitcroft $Declare| 2222c45dcabdSAndy Whitcroft module_param_named| 2223c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2224c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2225c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2226383099fdSAndy Whitcroft __typeof__\(| 2227383099fdSAndy Whitcroft \.$Ident\s*=\s* 2228c45dcabdSAndy Whitcroft }x; 2229383099fdSAndy Whitcroft #print "REST<$rest> dstat<$dstat>\n"; 2230c45dcabdSAndy Whitcroft if ($rest ne '') { 2231c45dcabdSAndy Whitcroft if ($rest !~ /while\s*\(/ && 2232c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/) 2233c45dcabdSAndy Whitcroft { 2234c45dcabdSAndy Whitcroft ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2235c45dcabdSAndy Whitcroft } 2236c45dcabdSAndy Whitcroft 2237c45dcabdSAndy Whitcroft } elsif ($ctx !~ /;/) { 2238c45dcabdSAndy Whitcroft if ($dstat ne '' && 2239c45dcabdSAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2240c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/ && 2241b132e5d5SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && 2242c45dcabdSAndy Whitcroft $dstat =~ /$Operators/) 2243c45dcabdSAndy Whitcroft { 2244de7d4f0eSAndy Whitcroft ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2245d8aaf121SAndy Whitcroft } 22460a920b5bSAndy Whitcroft } 2247653d4876SAndy Whitcroft } 22480a920b5bSAndy Whitcroft 2249080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 2250080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 2251080ba929SMike Frysinger# . 2252080ba929SMike Frysinger# ALIGN(...) 2253080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 2254080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 2255080ba929SMike Frysinger WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 2256080ba929SMike Frysinger } 2257080ba929SMike Frysinger 2258f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 225913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 226013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 2261cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 226213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2263cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 2264cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 226513214adfSAndy Whitcroft my $allowed = 0; 226613214adfSAndy Whitcroft my $seen = 0; 2267773647a0SAndy Whitcroft my $herectx = $here . "\n"; 2268cf655043SAndy Whitcroft my $ln = $linenr - 1; 226913214adfSAndy Whitcroft for my $chunk (@chunks) { 227013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 227113214adfSAndy Whitcroft 2272773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 2273773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2274773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 2275773647a0SAndy Whitcroft 2276773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2277773647a0SAndy Whitcroft 2278773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 2279773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 2280773647a0SAndy Whitcroft 2281773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2282cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 2283cf655043SAndy Whitcroft 2284773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 228513214adfSAndy Whitcroft 228613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 228713214adfSAndy Whitcroft 2288cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 2289cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2290cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 229113214adfSAndy Whitcroft $allowed = 1; 229213214adfSAndy Whitcroft } 229313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2294cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 229513214adfSAndy Whitcroft $allowed = 1; 229613214adfSAndy Whitcroft } 2297cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2298cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 229913214adfSAndy Whitcroft $allowed = 1; 230013214adfSAndy Whitcroft } 230113214adfSAndy Whitcroft } 230213214adfSAndy Whitcroft if ($seen && !$allowed) { 2303cf655043SAndy Whitcroft WARN("braces {} are not necessary for any arm of this statement\n" . $herectx); 230413214adfSAndy Whitcroft } 230513214adfSAndy Whitcroft } 230613214adfSAndy Whitcroft } 2307773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 230813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 2309cf655043SAndy Whitcroft my $allowed = 0; 2310f0a594c1SAndy Whitcroft 2311cf655043SAndy Whitcroft # Check the pre-context. 2312cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2313cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 2314cf655043SAndy Whitcroft $allowed = 1; 2315f0a594c1SAndy Whitcroft } 2316773647a0SAndy Whitcroft 2317773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 2318773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 2319773647a0SAndy Whitcroft 2320cf655043SAndy Whitcroft # Check the condition. 2321cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 2322773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 2323cf655043SAndy Whitcroft if (defined $cond) { 2324773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2325cf655043SAndy Whitcroft } 2326cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2327cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 2328cf655043SAndy Whitcroft $allowed = 1; 2329cf655043SAndy Whitcroft } 2330cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2331cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 2332cf655043SAndy Whitcroft $allowed = 1; 2333cf655043SAndy Whitcroft } 2334cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2335cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 2336cf655043SAndy Whitcroft $allowed = 1; 2337cf655043SAndy Whitcroft } 2338cf655043SAndy Whitcroft # Check the post-context. 2339cf655043SAndy Whitcroft if (defined $chunks[1]) { 2340cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 2341cf655043SAndy Whitcroft if (defined $cond) { 2342773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2343cf655043SAndy Whitcroft } 2344cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 2345cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 2346cf655043SAndy Whitcroft $allowed = 1; 2347cf655043SAndy Whitcroft } 2348cf655043SAndy Whitcroft } 2349cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 2350cf655043SAndy Whitcroft my $herectx = $here . "\n";; 2351f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 2352cf655043SAndy Whitcroft 2353f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 2354f055663cSAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n";; 2355cf655043SAndy Whitcroft } 2356cf655043SAndy Whitcroft 2357cf655043SAndy Whitcroft WARN("braces {} are not necessary for single statement blocks\n" . $herectx); 2358f0a594c1SAndy Whitcroft } 2359f0a594c1SAndy Whitcroft } 2360f0a594c1SAndy Whitcroft 2361653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 23624a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 2363c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 2364de7d4f0eSAndy Whitcroft ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 23650a920b5bSAndy Whitcroft } 23660a920b5bSAndy Whitcroft } 23670a920b5bSAndy Whitcroft 23684a0df2efSAndy Whitcroft# don't use deprecated functions 23694a0df2efSAndy Whitcroft for my $func (@dep_functions) { 237000df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 2371de7d4f0eSAndy Whitcroft ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 23724a0df2efSAndy Whitcroft } 23734a0df2efSAndy Whitcroft } 23744a0df2efSAndy Whitcroft 23754a0df2efSAndy Whitcroft# no volatiles please 23766c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 23776c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 2378de7d4f0eSAndy Whitcroft WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 23794a0df2efSAndy Whitcroft } 23804a0df2efSAndy Whitcroft 23819c0ca6f9SAndy Whitcroft# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated 23829c0ca6f9SAndy Whitcroft if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { 23839c0ca6f9SAndy Whitcroft ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr); 23849c0ca6f9SAndy Whitcroft } 23859c0ca6f9SAndy Whitcroft 238600df344fSAndy Whitcroft# warn about #if 0 2387c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2388de7d4f0eSAndy Whitcroft CHK("if this code is redundant consider removing it\n" . 2389de7d4f0eSAndy Whitcroft $herecurr); 23904a0df2efSAndy Whitcroft } 23914a0df2efSAndy Whitcroft 2392f0a594c1SAndy Whitcroft# check for needless kfree() checks 2393f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 2394f0a594c1SAndy Whitcroft my $expr = $1; 2395f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 23963c232147SWolfram Sang WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev); 2397f0a594c1SAndy Whitcroft } 2398f0a594c1SAndy Whitcroft } 23994c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 24004c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 24014c432a8fSGreg Kroah-Hartman my $expr = $1; 24024c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 24034c432a8fSGreg Kroah-Hartman WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 24044c432a8fSGreg Kroah-Hartman } 24054c432a8fSGreg Kroah-Hartman } 2406f0a594c1SAndy Whitcroft 240700df344fSAndy Whitcroft# warn about #ifdefs in C files 2408c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 240900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 241000df344fSAndy Whitcroft# print "$herecurr"; 241100df344fSAndy Whitcroft# $clean = 0; 241200df344fSAndy Whitcroft# } 241300df344fSAndy Whitcroft 241422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 2415c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 241622f2a2efSAndy Whitcroft ERROR("exactly one space required after that #$1\n" . $herecurr); 241722f2a2efSAndy Whitcroft } 241822f2a2efSAndy Whitcroft 24194a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 2420171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 2421171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 24224a0df2efSAndy Whitcroft my $which = $1; 24234a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2424de7d4f0eSAndy Whitcroft CHK("$1 definition without comment\n" . $herecurr); 24254a0df2efSAndy Whitcroft } 24264a0df2efSAndy Whitcroft } 24274a0df2efSAndy Whitcroft# check for memory barriers without a comment. 24284a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 24294a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 2430de7d4f0eSAndy Whitcroft CHK("memory barrier without comment\n" . $herecurr); 24314a0df2efSAndy Whitcroft } 24324a0df2efSAndy Whitcroft } 24334a0df2efSAndy Whitcroft# check of hardware specific defines 2434c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 2435de7d4f0eSAndy Whitcroft CHK("architecture specific defines should be avoided\n" . $herecurr); 24360a920b5bSAndy Whitcroft } 2437653d4876SAndy Whitcroft 2438de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 2439de7d4f0eSAndy Whitcroft# storage class and type. 24409c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 24419c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 2442de7d4f0eSAndy Whitcroft ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 2443de7d4f0eSAndy Whitcroft } 2444de7d4f0eSAndy Whitcroft 24458905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 24468905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 24478905a67cSAndy Whitcroft WARN("plain inline is preferred over $1\n" . $herecurr); 24488905a67cSAndy Whitcroft } 24498905a67cSAndy Whitcroft 2450de7d4f0eSAndy Whitcroft# check for new externs in .c files. 2451171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 2452c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 2453171ae1a4SAndy Whitcroft { 2454c45dcabdSAndy Whitcroft my $function_name = $1; 2455c45dcabdSAndy Whitcroft my $paren_space = $2; 2456171ae1a4SAndy Whitcroft 2457171ae1a4SAndy Whitcroft my $s = $stat; 2458171ae1a4SAndy Whitcroft if (defined $cond) { 2459171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 2460171ae1a4SAndy Whitcroft } 2461c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 2462c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 2463c45dcabdSAndy Whitcroft { 2464de7d4f0eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2465de7d4f0eSAndy Whitcroft } 2466de7d4f0eSAndy Whitcroft 2467171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 2468171ae1a4SAndy Whitcroft WARN("arguments for function declarations should follow identifier\n" . $herecurr); 2469171ae1a4SAndy Whitcroft } 24709c9ba34eSAndy Whitcroft 24719c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 24729c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 24739c9ba34eSAndy Whitcroft { 24749c9ba34eSAndy Whitcroft WARN("externs should be avoided in .c files\n" . $herecurr); 2475171ae1a4SAndy Whitcroft } 2476171ae1a4SAndy Whitcroft 2477de7d4f0eSAndy Whitcroft# checks for new __setup's 2478de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 2479de7d4f0eSAndy Whitcroft my $name = $1; 2480de7d4f0eSAndy Whitcroft 2481de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 2482de7d4f0eSAndy Whitcroft CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 2483de7d4f0eSAndy Whitcroft } 2484653d4876SAndy Whitcroft } 24859c0ca6f9SAndy Whitcroft 24869c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 24879c0ca6f9SAndy Whitcroft if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { 24889c0ca6f9SAndy Whitcroft WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 24899c0ca6f9SAndy Whitcroft } 249013214adfSAndy Whitcroft 249113214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 249213214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 249313214adfSAndy Whitcroft WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 249413214adfSAndy Whitcroft } 2495773647a0SAndy Whitcroft 2496773647a0SAndy Whitcroft# check for semaphores used as mutexes 2497171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) { 2498773647a0SAndy Whitcroft WARN("mutexes are preferred for single holder semaphores\n" . $herecurr); 2499773647a0SAndy Whitcroft } 2500773647a0SAndy Whitcroft# check for semaphores used as mutexes 2501171ae1a4SAndy Whitcroft if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) { 2502773647a0SAndy Whitcroft WARN("consider using a completion\n" . $herecurr); 2503773647a0SAndy Whitcroft } 2504773647a0SAndy Whitcroft# recommend strict_strto* over simple_strto* 2505773647a0SAndy Whitcroft if ($line =~ /\bsimple_(strto.*?)\s*\(/) { 2506773647a0SAndy Whitcroft WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr); 2507773647a0SAndy Whitcroft } 2508f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 2509f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 2510f3db6639SMichael Ellerman WARN("please use device_initcall() instead of __initcall()\n" . $herecurr); 2511f3db6639SMichael Ellerman } 2512773647a0SAndy Whitcroft 2513773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 2514773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 2515773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 2516c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 2517c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 2518171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 2519171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 2520171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 2521773647a0SAndy Whitcroft { 2522773647a0SAndy Whitcroft WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 2523773647a0SAndy Whitcroft } 25249c9ba34eSAndy Whitcroft 25259c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 25269c9ba34eSAndy Whitcroft my $string; 25279c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 25289c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 25292a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 25309c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 25319c9ba34eSAndy Whitcroft WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 25329c9ba34eSAndy Whitcroft last; 25339c9ba34eSAndy Whitcroft } 25349c9ba34eSAndy Whitcroft } 2535691d77b6SAndy Whitcroft 2536691d77b6SAndy Whitcroft# whine mightly about in_atomic 2537691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 2538691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 2539691d77b6SAndy Whitcroft ERROR("do not use in_atomic in drivers\n" . $herecurr); 2540691d77b6SAndy Whitcroft } else { 2541691d77b6SAndy Whitcroft WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 2542691d77b6SAndy Whitcroft } 2543691d77b6SAndy Whitcroft } 254413214adfSAndy Whitcroft } 254513214adfSAndy Whitcroft 254613214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 254713214adfSAndy Whitcroft # so just keep quiet. 254813214adfSAndy Whitcroft if ($#rawlines == -1) { 254913214adfSAndy Whitcroft exit(0); 25500a920b5bSAndy Whitcroft } 25510a920b5bSAndy Whitcroft 25528905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 25538905a67cSAndy Whitcroft # things that appear to be patches. 25548905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 25558905a67cSAndy Whitcroft exit(0); 25568905a67cSAndy Whitcroft } 25578905a67cSAndy Whitcroft 25588905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 25598905a67cSAndy Whitcroft # just keep quiet. 25608905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 25618905a67cSAndy Whitcroft exit(0); 25628905a67cSAndy Whitcroft } 25638905a67cSAndy Whitcroft 25648905a67cSAndy Whitcroft if (!$is_patch) { 2565de7d4f0eSAndy Whitcroft ERROR("Does not appear to be a unified-diff format patch\n"); 25660a920b5bSAndy Whitcroft } 25670a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 2568de7d4f0eSAndy Whitcroft ERROR("Missing Signed-off-by: line(s)\n"); 25690a920b5bSAndy Whitcroft } 25700a920b5bSAndy Whitcroft 2571f0a594c1SAndy Whitcroft print report_dump(); 257213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 257313214adfSAndy Whitcroft print "$filename " if ($summary_file); 25746c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 25756c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 25766c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 25778905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 25786c72ffaaSAndy Whitcroft } 25798905a67cSAndy Whitcroft 25800a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 2581c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 25820a920b5bSAndy Whitcroft } 25830a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 2584c2fdda0dSAndy Whitcroft print "$vname has style problems, please review. If any of these errors\n"; 25850a920b5bSAndy Whitcroft print "are false positives report them to the maintainer, see\n"; 25860a920b5bSAndy Whitcroft print "CHECKPATCH in MAINTAINERS.\n"; 25870a920b5bSAndy Whitcroft } 258813214adfSAndy Whitcroft 25890a920b5bSAndy Whitcroft return $clean; 25900a920b5bSAndy Whitcroft} 2591