10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (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) 5015830beSAndy Whitcroft# (c) 2008-2010 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 13000d1cc1SJoe Perchesmy $V = '0.32'; 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; 29000d1cc1SJoe Perchesmy $show_types = 0; 306c72ffaaSAndy Whitcroftmy $root; 31c2fdda0dSAndy Whitcroftmy %debug; 32000d1cc1SJoe Perchesmy %ignore_type = (); 33000d1cc1SJoe Perchesmy @ignore = (); 3477f5b10aSHannes Edermy $help = 0; 35000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 3677f5b10aSHannes Eder 3777f5b10aSHannes Edersub help { 3877f5b10aSHannes Eder my ($exitcode) = @_; 3977f5b10aSHannes Eder 4077f5b10aSHannes Eder print << "EOM"; 4177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 4277f5b10aSHannes EderVersion: $V 4377f5b10aSHannes Eder 4477f5b10aSHannes EderOptions: 4577f5b10aSHannes Eder -q, --quiet quiet 4677f5b10aSHannes Eder --no-tree run without a kernel tree 4777f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 4877f5b10aSHannes Eder --patch treat FILE as patchfile (default) 4977f5b10aSHannes Eder --emacs emacs compile window format 5077f5b10aSHannes Eder --terse one line per report 5177f5b10aSHannes Eder -f, --file treat FILE as regular source file 5277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 53000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 54000d1cc1SJoe Perches --show-types show the message "types" in the output 5577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 5677f5b10aSHannes Eder --no-summary suppress the per-file summary 5777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 5877f5b10aSHannes Eder --summary-file include the filename in summary 5977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 6077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 6177f5b10aSHannes Eder is all off) 6277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 6377f5b10aSHannes Eder literally 6477f5b10aSHannes Eder -h, --help, --version display this help and exit 6577f5b10aSHannes Eder 6677f5b10aSHannes EderWhen FILE is - read standard input. 6777f5b10aSHannes EderEOM 6877f5b10aSHannes Eder 6977f5b10aSHannes Eder exit($exitcode); 7077f5b10aSHannes Eder} 7177f5b10aSHannes Eder 72000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 73000d1cc1SJoe Perchesif (-f $conf) { 74000d1cc1SJoe Perches my @conf_args; 75000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 76000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 77000d1cc1SJoe Perches 78000d1cc1SJoe Perches while (<$conffile>) { 79000d1cc1SJoe Perches my $line = $_; 80000d1cc1SJoe Perches 81000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 82000d1cc1SJoe Perches $line =~ s/^\s*//g; 83000d1cc1SJoe Perches $line =~ s/\s+/ /g; 84000d1cc1SJoe Perches 85000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 86000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 87000d1cc1SJoe Perches 88000d1cc1SJoe Perches my @words = split(" ", $line); 89000d1cc1SJoe Perches foreach my $word (@words) { 90000d1cc1SJoe Perches last if ($word =~ m/^#/); 91000d1cc1SJoe Perches push (@conf_args, $word); 92000d1cc1SJoe Perches } 93000d1cc1SJoe Perches } 94000d1cc1SJoe Perches close($conffile); 95000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 96000d1cc1SJoe Perches} 97000d1cc1SJoe Perches 980a920b5bSAndy WhitcroftGetOptions( 996c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1000a920b5bSAndy Whitcroft 'tree!' => \$tree, 1010a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1020a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1036c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1048905a67cSAndy Whitcroft 'terse!' => \$terse, 10577f5b10aSHannes Eder 'f|file!' => \$file, 1066c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1076c72ffaaSAndy Whitcroft 'strict!' => \$check, 108000d1cc1SJoe Perches 'ignore=s' => \@ignore, 109000d1cc1SJoe Perches 'show-types!' => \$show_types, 1106c72ffaaSAndy Whitcroft 'root=s' => \$root, 1118905a67cSAndy Whitcroft 'summary!' => \$summary, 1128905a67cSAndy Whitcroft 'mailback!' => \$mailback, 11313214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 11413214adfSAndy Whitcroft 115c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 116773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 11777f5b10aSHannes Eder 'h|help' => \$help, 11877f5b10aSHannes Eder 'version' => \$help 11977f5b10aSHannes Eder) or help(1); 12077f5b10aSHannes Eder 12177f5b10aSHannes Ederhelp(0) if ($help); 1220a920b5bSAndy Whitcroft 1230a920b5bSAndy Whitcroftmy $exit = 0; 1240a920b5bSAndy Whitcroft 1250a920b5bSAndy Whitcroftif ($#ARGV < 0) { 12677f5b10aSHannes Eder print "$P: no input files\n"; 1270a920b5bSAndy Whitcroft exit(1); 1280a920b5bSAndy Whitcroft} 1290a920b5bSAndy Whitcroft 130000d1cc1SJoe Perches@ignore = split(/,/, join(',',@ignore)); 131000d1cc1SJoe Perchesforeach my $word (@ignore) { 132000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 133000d1cc1SJoe Perches $word =~ s/^\s*//g; 134000d1cc1SJoe Perches $word =~ s/\s+/ /g; 135000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 136000d1cc1SJoe Perches 137000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 138000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 139000d1cc1SJoe Perches 140000d1cc1SJoe Perches $ignore_type{$word}++; 141000d1cc1SJoe Perches} 142000d1cc1SJoe Perches 143c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 144c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1457429c690SAndy Whitcroftmy $dbg_type = 0; 146a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 147c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 14821caa13cSAndy Whitcroft ## no critic 14921caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 15021caa13cSAndy Whitcroft die "$@" if ($@); 151c2fdda0dSAndy Whitcroft} 152c2fdda0dSAndy Whitcroft 153d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 154d2c0a235SAndy Whitcroft 1558905a67cSAndy Whitcroftif ($terse) { 1568905a67cSAndy Whitcroft $emacs = 1; 1578905a67cSAndy Whitcroft $quiet++; 1588905a67cSAndy Whitcroft} 1598905a67cSAndy Whitcroft 1606c72ffaaSAndy Whitcroftif ($tree) { 1616c72ffaaSAndy Whitcroft if (defined $root) { 1626c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 1636c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 1646c72ffaaSAndy Whitcroft } 1656c72ffaaSAndy Whitcroft } else { 1666c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 1676c72ffaaSAndy Whitcroft $root = '.'; 1686c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 1696c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 1706c72ffaaSAndy Whitcroft $root = $1; 1716c72ffaaSAndy Whitcroft } 1726c72ffaaSAndy Whitcroft } 1736c72ffaaSAndy Whitcroft 1746c72ffaaSAndy Whitcroft if (!defined $root) { 1750a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 1760a920b5bSAndy Whitcroft exit(2); 1770a920b5bSAndy Whitcroft } 1786c72ffaaSAndy Whitcroft} 1796c72ffaaSAndy Whitcroft 1806c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1816c72ffaaSAndy Whitcroft 1822ceb532bSAndy Whitcroftour $Ident = qr{ 1832ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 1842ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 1852ceb532bSAndy Whitcroft }x; 1866c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1876c72ffaaSAndy Whitcroftour $Sparse = qr{ 1886c72ffaaSAndy Whitcroft __user| 1896c72ffaaSAndy Whitcroft __kernel| 1906c72ffaaSAndy Whitcroft __force| 1916c72ffaaSAndy Whitcroft __iomem| 1926c72ffaaSAndy Whitcroft __must_check| 1936c72ffaaSAndy Whitcroft __init_refok| 194417495edSAndy Whitcroft __kprobes| 195165e72a6SSven Eckelmann __ref| 196165e72a6SSven Eckelmann __rcu 1976c72ffaaSAndy Whitcroft }x; 19852131292SWolfram Sang 19952131292SWolfram Sang# Notes to $Attribute: 20052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2016c72ffaaSAndy Whitcroftour $Attribute = qr{ 2026c72ffaaSAndy Whitcroft const| 20303f1df7dSJoe Perches __percpu| 20403f1df7dSJoe Perches __nocast| 20503f1df7dSJoe Perches __safe| 20603f1df7dSJoe Perches __bitwise__| 20703f1df7dSJoe Perches __packed__| 20803f1df7dSJoe Perches __packed2__| 20903f1df7dSJoe Perches __naked| 21003f1df7dSJoe Perches __maybe_unused| 21103f1df7dSJoe Perches __always_unused| 21203f1df7dSJoe Perches __noreturn| 21303f1df7dSJoe Perches __used| 21403f1df7dSJoe Perches __cold| 21503f1df7dSJoe Perches __noclone| 21603f1df7dSJoe Perches __deprecated| 2176c72ffaaSAndy Whitcroft __read_mostly| 2186c72ffaaSAndy Whitcroft __kprobes| 21952131292SWolfram Sang __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| 22024e1d81aSAndy Whitcroft ____cacheline_aligned| 22124e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2225fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2235fe3af11SAndy Whitcroft __weak 2246c72ffaaSAndy Whitcroft }x; 225c45dcabdSAndy Whitcroftour $Modifier; 2266c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2276c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2286c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2296c72ffaaSAndy Whitcroft 2306c72ffaaSAndy Whitcroftour $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 2316c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 23286f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 2336c72ffaaSAndy Whitcroftour $Operators = qr{ 2346c72ffaaSAndy Whitcroft <=|>=|==|!=| 2356c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 236c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 2376c72ffaaSAndy Whitcroft }x; 2386c72ffaaSAndy Whitcroft 2398905a67cSAndy Whitcroftour $NonptrType; 2408905a67cSAndy Whitcroftour $Type; 2418905a67cSAndy Whitcroftour $Declare; 2428905a67cSAndy Whitcroft 243*15662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 244*15662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 245171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 246171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 247171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 248171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 249171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 250171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 251171ae1a4SAndy Whitcroft}x; 252171ae1a4SAndy Whitcroft 253*15662b3eSJoe Perchesour $UTF8 = qr{ 254*15662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 255*15662b3eSJoe Perches | $NON_ASCII_UTF8 256*15662b3eSJoe Perches}x; 257*15662b3eSJoe Perches 2588ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 259fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 2608ed22cadSAndy Whitcroft atomic_t 2618ed22cadSAndy Whitcroft)}; 2628ed22cadSAndy Whitcroft 263691e669bSJoe Perchesour $logFunctions = qr{(?x: 2646e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 2656e60c02eSJoe Perches [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 2666e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 267b0531722SJoe Perches panic| 268b0531722SJoe Perches MODULE_[A-Z_]+ 269691e669bSJoe Perches)}; 270691e669bSJoe Perches 27120112475SJoe Perchesour $signature_tags = qr{(?xi: 27220112475SJoe Perches Signed-off-by:| 27320112475SJoe Perches Acked-by:| 27420112475SJoe Perches Tested-by:| 27520112475SJoe Perches Reviewed-by:| 27620112475SJoe Perches Reported-by:| 27720112475SJoe Perches To:| 27820112475SJoe Perches Cc: 27920112475SJoe Perches)}; 28020112475SJoe Perches 2818905a67cSAndy Whitcroftour @typeList = ( 2828905a67cSAndy Whitcroft qr{void}, 283c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 284c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 285c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 286c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 287c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 288c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 289c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 2908905a67cSAndy Whitcroft qr{unsigned}, 2918905a67cSAndy Whitcroft qr{float}, 2928905a67cSAndy Whitcroft qr{double}, 2938905a67cSAndy Whitcroft qr{bool}, 2948905a67cSAndy Whitcroft qr{struct\s+$Ident}, 2958905a67cSAndy Whitcroft qr{union\s+$Ident}, 2968905a67cSAndy Whitcroft qr{enum\s+$Ident}, 2978905a67cSAndy Whitcroft qr{${Ident}_t}, 2988905a67cSAndy Whitcroft qr{${Ident}_handler}, 2998905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3008905a67cSAndy Whitcroft); 301c45dcabdSAndy Whitcroftour @modifierList = ( 302c45dcabdSAndy Whitcroft qr{fastcall}, 303c45dcabdSAndy Whitcroft); 3048905a67cSAndy Whitcroft 3057840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3067840a94cSWolfram Sang irq| 3077840a94cSWolfram Sang memory 3087840a94cSWolfram Sang)}; 3097840a94cSWolfram Sang# memory.h: ARM has a custom one 3107840a94cSWolfram Sang 3118905a67cSAndy Whitcroftsub build_types { 312d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 313d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 314c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3158905a67cSAndy Whitcroft $NonptrType = qr{ 316d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 317cf655043SAndy Whitcroft (?: 318c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 3198ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 320c45dcabdSAndy Whitcroft (?:${all}\b) 321cf655043SAndy Whitcroft ) 322c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 3238905a67cSAndy Whitcroft }x; 3248905a67cSAndy Whitcroft $Type = qr{ 325c45dcabdSAndy Whitcroft $NonptrType 32665863862SAndy Whitcroft (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 327c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 3288905a67cSAndy Whitcroft }x; 3298905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 3308905a67cSAndy Whitcroft} 3318905a67cSAndy Whitcroftbuild_types(); 3326c72ffaaSAndy Whitcroft 3337d2367afSJoe Perchesour $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/; 3347d2367afSJoe Perches 3357d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 3367d2367afSJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*}; 3377d2367afSJoe Perches 3387d2367afSJoe Perchessub deparenthesize { 3397d2367afSJoe Perches my ($string) = @_; 3407d2367afSJoe Perches return "" if (!defined($string)); 3417d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 3427d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 3437d2367afSJoe Perches $string =~ s@\s+@ @g; 3447d2367afSJoe Perches return $string; 3457d2367afSJoe Perches} 3467d2367afSJoe Perches 3476c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 3480a920b5bSAndy Whitcroft 3494a0df2efSAndy Whitcroftmy @dep_includes = (); 3504a0df2efSAndy Whitcroftmy @dep_functions = (); 3516c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 3526c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 35321caa13cSAndy Whitcroft open(my $REMOVE, '<', "$root/$removal") || 3546c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 35521caa13cSAndy Whitcroft while (<$REMOVE>) { 356f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 357f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 358f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 3594a0df2efSAndy Whitcroft push(@dep_includes, $1); 3604a0df2efSAndy Whitcroft 361f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 362f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 363f0a594c1SAndy Whitcroft } 3644a0df2efSAndy Whitcroft } 3650a920b5bSAndy Whitcroft } 3660a920b5bSAndy Whitcroft } 36721caa13cSAndy Whitcroft close($REMOVE); 3680a920b5bSAndy Whitcroft} 3690a920b5bSAndy Whitcroft 37000df344fSAndy Whitcroftmy @rawlines = (); 371c2fdda0dSAndy Whitcroftmy @lines = (); 372c2fdda0dSAndy Whitcroftmy $vname; 3736c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 37421caa13cSAndy Whitcroft my $FILE; 3756c72ffaaSAndy Whitcroft if ($file) { 37621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 3776c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 37821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 37921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 3806c72ffaaSAndy Whitcroft } else { 38121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 3826c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 3836c72ffaaSAndy Whitcroft } 384c2fdda0dSAndy Whitcroft if ($filename eq '-') { 385c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 386c2fdda0dSAndy Whitcroft } else { 387c2fdda0dSAndy Whitcroft $vname = $filename; 388c2fdda0dSAndy Whitcroft } 38921caa13cSAndy Whitcroft while (<$FILE>) { 3900a920b5bSAndy Whitcroft chomp; 39100df344fSAndy Whitcroft push(@rawlines, $_); 3926c72ffaaSAndy Whitcroft } 39321caa13cSAndy Whitcroft close($FILE); 394c2fdda0dSAndy Whitcroft if (!process($filename)) { 3950a920b5bSAndy Whitcroft $exit = 1; 3960a920b5bSAndy Whitcroft } 39700df344fSAndy Whitcroft @rawlines = (); 39813214adfSAndy Whitcroft @lines = (); 3990a920b5bSAndy Whitcroft} 4000a920b5bSAndy Whitcroft 4010a920b5bSAndy Whitcroftexit($exit); 4020a920b5bSAndy Whitcroft 4030a920b5bSAndy Whitcroftsub top_of_kernel_tree { 4046c72ffaaSAndy Whitcroft my ($root) = @_; 4056c72ffaaSAndy Whitcroft 4066c72ffaaSAndy Whitcroft my @tree_check = ( 4076c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 4086c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 4096c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 4106c72ffaaSAndy Whitcroft ); 4116c72ffaaSAndy Whitcroft 4126c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 4136c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 4140a920b5bSAndy Whitcroft return 0; 4150a920b5bSAndy Whitcroft } 4166c72ffaaSAndy Whitcroft } 4176c72ffaaSAndy Whitcroft return 1; 4186c72ffaaSAndy Whitcroft } 4190a920b5bSAndy Whitcroft 42020112475SJoe Perchessub parse_email { 42120112475SJoe Perches my ($formatted_email) = @_; 42220112475SJoe Perches 42320112475SJoe Perches my $name = ""; 42420112475SJoe Perches my $address = ""; 42520112475SJoe Perches my $comment = ""; 42620112475SJoe Perches 42720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 42820112475SJoe Perches $name = $1; 42920112475SJoe Perches $address = $2; 43020112475SJoe Perches $comment = $3 if defined $3; 43120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 43220112475SJoe Perches $address = $1; 43320112475SJoe Perches $comment = $2 if defined $2; 43420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 43520112475SJoe Perches $address = $1; 43620112475SJoe Perches $comment = $2 if defined $2; 43720112475SJoe Perches $formatted_email =~ s/$address.*$//; 43820112475SJoe Perches $name = $formatted_email; 43920112475SJoe Perches $name =~ s/^\s+|\s+$//g; 44020112475SJoe Perches $name =~ s/^\"|\"$//g; 44120112475SJoe Perches # If there's a name left after stripping spaces and 44220112475SJoe Perches # leading quotes, and the address doesn't have both 44320112475SJoe Perches # leading and trailing angle brackets, the address 44420112475SJoe Perches # is invalid. ie: 44520112475SJoe Perches # "joe smith [email protected]" bad 44620112475SJoe Perches # "joe smith <[email protected]" bad 44720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 44820112475SJoe Perches $name = ""; 44920112475SJoe Perches $address = ""; 45020112475SJoe Perches $comment = ""; 45120112475SJoe Perches } 45220112475SJoe Perches } 45320112475SJoe Perches 45420112475SJoe Perches $name =~ s/^\s+|\s+$//g; 45520112475SJoe Perches $name =~ s/^\"|\"$//g; 45620112475SJoe Perches $address =~ s/^\s+|\s+$//g; 45720112475SJoe Perches $address =~ s/^\<|\>$//g; 45820112475SJoe Perches 45920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 46020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 46120112475SJoe Perches $name = "\"$name\""; 46220112475SJoe Perches } 46320112475SJoe Perches 46420112475SJoe Perches return ($name, $address, $comment); 46520112475SJoe Perches} 46620112475SJoe Perches 46720112475SJoe Perchessub format_email { 46820112475SJoe Perches my ($name, $address) = @_; 46920112475SJoe Perches 47020112475SJoe Perches my $formatted_email; 47120112475SJoe Perches 47220112475SJoe Perches $name =~ s/^\s+|\s+$//g; 47320112475SJoe Perches $name =~ s/^\"|\"$//g; 47420112475SJoe Perches $address =~ s/^\s+|\s+$//g; 47520112475SJoe Perches 47620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 47720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 47820112475SJoe Perches $name = "\"$name\""; 47920112475SJoe Perches } 48020112475SJoe Perches 48120112475SJoe Perches if ("$name" eq "") { 48220112475SJoe Perches $formatted_email = "$address"; 48320112475SJoe Perches } else { 48420112475SJoe Perches $formatted_email = "$name <$address>"; 48520112475SJoe Perches } 48620112475SJoe Perches 48720112475SJoe Perches return $formatted_email; 48820112475SJoe Perches} 48920112475SJoe Perches 490000d1cc1SJoe Perchessub which_conf { 491000d1cc1SJoe Perches my ($conf) = @_; 492000d1cc1SJoe Perches 493000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 494000d1cc1SJoe Perches if (-e "$path/$conf") { 495000d1cc1SJoe Perches return "$path/$conf"; 496000d1cc1SJoe Perches } 497000d1cc1SJoe Perches } 498000d1cc1SJoe Perches 499000d1cc1SJoe Perches return ""; 500000d1cc1SJoe Perches} 501000d1cc1SJoe Perches 5020a920b5bSAndy Whitcroftsub expand_tabs { 5030a920b5bSAndy Whitcroft my ($str) = @_; 5040a920b5bSAndy Whitcroft 5050a920b5bSAndy Whitcroft my $res = ''; 5060a920b5bSAndy Whitcroft my $n = 0; 5070a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 5080a920b5bSAndy Whitcroft if ($c eq "\t") { 5090a920b5bSAndy Whitcroft $res .= ' '; 5100a920b5bSAndy Whitcroft $n++; 5110a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 5120a920b5bSAndy Whitcroft $res .= ' '; 5130a920b5bSAndy Whitcroft } 5140a920b5bSAndy Whitcroft next; 5150a920b5bSAndy Whitcroft } 5160a920b5bSAndy Whitcroft $res .= $c; 5170a920b5bSAndy Whitcroft $n++; 5180a920b5bSAndy Whitcroft } 5190a920b5bSAndy Whitcroft 5200a920b5bSAndy Whitcroft return $res; 5210a920b5bSAndy Whitcroft} 5226c72ffaaSAndy Whitcroftsub copy_spacing { 523773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 5246c72ffaaSAndy Whitcroft return $res; 5256c72ffaaSAndy Whitcroft} 5260a920b5bSAndy Whitcroft 5274a0df2efSAndy Whitcroftsub line_stats { 5284a0df2efSAndy Whitcroft my ($line) = @_; 5294a0df2efSAndy Whitcroft 5304a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 5314a0df2efSAndy Whitcroft $line =~ s/^.//; 5324a0df2efSAndy Whitcroft $line = expand_tabs($line); 5334a0df2efSAndy Whitcroft 5344a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 5354a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 5364a0df2efSAndy Whitcroft 5374a0df2efSAndy Whitcroft return (length($line), length($white)); 5384a0df2efSAndy Whitcroft} 5394a0df2efSAndy Whitcroft 540773647a0SAndy Whitcroftmy $sanitise_quote = ''; 541773647a0SAndy Whitcroft 542773647a0SAndy Whitcroftsub sanitise_line_reset { 543773647a0SAndy Whitcroft my ($in_comment) = @_; 544773647a0SAndy Whitcroft 545773647a0SAndy Whitcroft if ($in_comment) { 546773647a0SAndy Whitcroft $sanitise_quote = '*/'; 547773647a0SAndy Whitcroft } else { 548773647a0SAndy Whitcroft $sanitise_quote = ''; 549773647a0SAndy Whitcroft } 550773647a0SAndy Whitcroft} 55100df344fSAndy Whitcroftsub sanitise_line { 55200df344fSAndy Whitcroft my ($line) = @_; 55300df344fSAndy Whitcroft 55400df344fSAndy Whitcroft my $res = ''; 55500df344fSAndy Whitcroft my $l = ''; 55600df344fSAndy Whitcroft 557c2fdda0dSAndy Whitcroft my $qlen = 0; 558773647a0SAndy Whitcroft my $off = 0; 559773647a0SAndy Whitcroft my $c; 56000df344fSAndy Whitcroft 561773647a0SAndy Whitcroft # Always copy over the diff marker. 562773647a0SAndy Whitcroft $res = substr($line, 0, 1); 563773647a0SAndy Whitcroft 564773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 565773647a0SAndy Whitcroft $c = substr($line, $off, 1); 566773647a0SAndy Whitcroft 567773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 568773647a0SAndy Whitcroft # and end, all to $;. 569773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 570773647a0SAndy Whitcroft $sanitise_quote = '*/'; 571773647a0SAndy Whitcroft 572773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 573773647a0SAndy Whitcroft $off++; 57400df344fSAndy Whitcroft next; 575773647a0SAndy Whitcroft } 57681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 577773647a0SAndy Whitcroft $sanitise_quote = ''; 578773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 579773647a0SAndy Whitcroft $off++; 580773647a0SAndy Whitcroft next; 581773647a0SAndy Whitcroft } 582113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 583113f04a8SDaniel Walker $sanitise_quote = '//'; 584113f04a8SDaniel Walker 585113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 586113f04a8SDaniel Walker $off++; 587113f04a8SDaniel Walker next; 588113f04a8SDaniel Walker } 589773647a0SAndy Whitcroft 590773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 591773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 592773647a0SAndy Whitcroft $c eq "\\") { 593773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 594773647a0SAndy Whitcroft $off++; 595773647a0SAndy Whitcroft next; 596773647a0SAndy Whitcroft } 597773647a0SAndy Whitcroft # Regular quotes. 598773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 599773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 600773647a0SAndy Whitcroft $sanitise_quote = $c; 601773647a0SAndy Whitcroft 602773647a0SAndy Whitcroft substr($res, $off, 1, $c); 603773647a0SAndy Whitcroft next; 604773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 605773647a0SAndy Whitcroft $sanitise_quote = ''; 60600df344fSAndy Whitcroft } 60700df344fSAndy Whitcroft } 608773647a0SAndy Whitcroft 609fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 610773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 611773647a0SAndy Whitcroft substr($res, $off, 1, $;); 612113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 613113f04a8SDaniel Walker substr($res, $off, 1, $;); 614773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 615773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 61600df344fSAndy Whitcroft } else { 617773647a0SAndy Whitcroft substr($res, $off, 1, $c); 61800df344fSAndy Whitcroft } 619c2fdda0dSAndy Whitcroft } 620c2fdda0dSAndy Whitcroft 621113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 622113f04a8SDaniel Walker $sanitise_quote = ''; 623113f04a8SDaniel Walker } 624113f04a8SDaniel Walker 625c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 626c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 627c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 628c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 629c2fdda0dSAndy Whitcroft 630c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 631c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 632c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 633c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 634c2fdda0dSAndy Whitcroft } 635c2fdda0dSAndy Whitcroft 63600df344fSAndy Whitcroft return $res; 63700df344fSAndy Whitcroft} 63800df344fSAndy Whitcroft 6398905a67cSAndy Whitcroftsub ctx_statement_block { 6408905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6418905a67cSAndy Whitcroft my $line = $linenr - 1; 6428905a67cSAndy Whitcroft my $blk = ''; 6438905a67cSAndy Whitcroft my $soff = $off; 6448905a67cSAndy Whitcroft my $coff = $off - 1; 645773647a0SAndy Whitcroft my $coff_set = 0; 6468905a67cSAndy Whitcroft 64713214adfSAndy Whitcroft my $loff = 0; 64813214adfSAndy Whitcroft 6498905a67cSAndy Whitcroft my $type = ''; 6508905a67cSAndy Whitcroft my $level = 0; 651a2750645SAndy Whitcroft my @stack = (); 652cf655043SAndy Whitcroft my $p; 6538905a67cSAndy Whitcroft my $c; 6548905a67cSAndy Whitcroft my $len = 0; 65513214adfSAndy Whitcroft 65613214adfSAndy Whitcroft my $remainder; 6578905a67cSAndy Whitcroft while (1) { 658a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 659a2750645SAndy Whitcroft 660773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6618905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6628905a67cSAndy Whitcroft # context. 6638905a67cSAndy Whitcroft if ($off >= $len) { 6648905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 665dea33496SAndy Whitcroft last if (!defined $lines[$line]); 666c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6678905a67cSAndy Whitcroft $remain--; 66813214adfSAndy Whitcroft $loff = $len; 669c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6708905a67cSAndy Whitcroft $len = length($blk); 6718905a67cSAndy Whitcroft $line++; 6728905a67cSAndy Whitcroft last; 6738905a67cSAndy Whitcroft } 6748905a67cSAndy Whitcroft # Bail if there is no further context. 6758905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 67613214adfSAndy Whitcroft if ($off >= $len) { 6778905a67cSAndy Whitcroft last; 6788905a67cSAndy Whitcroft } 6798905a67cSAndy Whitcroft } 680cf655043SAndy Whitcroft $p = $c; 6818905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 68213214adfSAndy Whitcroft $remainder = substr($blk, $off); 6838905a67cSAndy Whitcroft 684773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6854635f4fbSAndy Whitcroft 6864635f4fbSAndy Whitcroft # Handle nested #if/#else. 6874635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6884635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6894635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 6904635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 6914635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 6924635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 6934635f4fbSAndy Whitcroft } 6944635f4fbSAndy Whitcroft 6958905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 6968905a67cSAndy Whitcroft # outermost level. 6978905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 6988905a67cSAndy Whitcroft last; 6998905a67cSAndy Whitcroft } 7008905a67cSAndy Whitcroft 70113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 702773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 703773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 704773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 705773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 706773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 707773647a0SAndy Whitcroft $coff_set = 1; 708773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 709773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 71013214adfSAndy Whitcroft } 71113214adfSAndy Whitcroft 7128905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7138905a67cSAndy Whitcroft $level++; 7148905a67cSAndy Whitcroft $type = '('; 7158905a67cSAndy Whitcroft } 7168905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7178905a67cSAndy Whitcroft $level--; 7188905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7198905a67cSAndy Whitcroft 7208905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7218905a67cSAndy Whitcroft $coff = $off; 722773647a0SAndy Whitcroft $coff_set = 1; 723773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7248905a67cSAndy Whitcroft } 7258905a67cSAndy Whitcroft } 7268905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7278905a67cSAndy Whitcroft $level++; 7288905a67cSAndy Whitcroft $type = '{'; 7298905a67cSAndy Whitcroft } 7308905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7318905a67cSAndy Whitcroft $level--; 7328905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7338905a67cSAndy Whitcroft 7348905a67cSAndy Whitcroft if ($level == 0) { 735b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 736b998e001SPatrick Pannuto $off++; 737b998e001SPatrick Pannuto } 7388905a67cSAndy Whitcroft last; 7398905a67cSAndy Whitcroft } 7408905a67cSAndy Whitcroft } 7418905a67cSAndy Whitcroft $off++; 7428905a67cSAndy Whitcroft } 743a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 74413214adfSAndy Whitcroft if ($off == $len) { 745a3bb97a7SAndy Whitcroft $loff = $len + 1; 74613214adfSAndy Whitcroft $line++; 74713214adfSAndy Whitcroft $remain--; 74813214adfSAndy Whitcroft } 7498905a67cSAndy Whitcroft 7508905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7518905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7528905a67cSAndy Whitcroft 7538905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7548905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7558905a67cSAndy Whitcroft 756773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 75713214adfSAndy Whitcroft 75813214adfSAndy Whitcroft return ($statement, $condition, 75913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 76013214adfSAndy Whitcroft} 76113214adfSAndy Whitcroft 762cf655043SAndy Whitcroftsub statement_lines { 763cf655043SAndy Whitcroft my ($stmt) = @_; 764cf655043SAndy Whitcroft 765cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 766cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 767cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 768cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 769cf655043SAndy Whitcroft 770cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 771cf655043SAndy Whitcroft 772cf655043SAndy Whitcroft return $#stmt_lines + 2; 773cf655043SAndy Whitcroft} 774cf655043SAndy Whitcroft 775cf655043SAndy Whitcroftsub statement_rawlines { 776cf655043SAndy Whitcroft my ($stmt) = @_; 777cf655043SAndy Whitcroft 778cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 779cf655043SAndy Whitcroft 780cf655043SAndy Whitcroft return $#stmt_lines + 2; 781cf655043SAndy Whitcroft} 782cf655043SAndy Whitcroft 783cf655043SAndy Whitcroftsub statement_block_size { 784cf655043SAndy Whitcroft my ($stmt) = @_; 785cf655043SAndy Whitcroft 786cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 787cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 788cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 789cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 790cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 791cf655043SAndy Whitcroft 792cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 793cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 794cf655043SAndy Whitcroft 795cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 796cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 797cf655043SAndy Whitcroft 798cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 799cf655043SAndy Whitcroft return $stmt_lines; 800cf655043SAndy Whitcroft } else { 801cf655043SAndy Whitcroft return $stmt_statements; 802cf655043SAndy Whitcroft } 803cf655043SAndy Whitcroft} 804cf655043SAndy Whitcroft 80513214adfSAndy Whitcroftsub ctx_statement_full { 80613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 80713214adfSAndy Whitcroft my ($statement, $condition, $level); 80813214adfSAndy Whitcroft 80913214adfSAndy Whitcroft my (@chunks); 81013214adfSAndy Whitcroft 811cf655043SAndy Whitcroft # Grab the first conditional/block pair. 81213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 81313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 814773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 81513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 816cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 817cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 818cf655043SAndy Whitcroft } 819cf655043SAndy Whitcroft 820cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 821cf655043SAndy Whitcroft # could continue the statement. 822cf655043SAndy Whitcroft for (;;) { 82313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 82413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 825cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 826773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 827cf655043SAndy Whitcroft #print "C: push\n"; 828cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 82913214adfSAndy Whitcroft } 83013214adfSAndy Whitcroft 83113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8328905a67cSAndy Whitcroft} 8338905a67cSAndy Whitcroft 8344a0df2efSAndy Whitcroftsub ctx_block_get { 835f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8364a0df2efSAndy Whitcroft my $line; 8374a0df2efSAndy Whitcroft my $start = $linenr - 1; 8384a0df2efSAndy Whitcroft my $blk = ''; 8394a0df2efSAndy Whitcroft my @o; 8404a0df2efSAndy Whitcroft my @c; 8414a0df2efSAndy Whitcroft my @res = (); 8424a0df2efSAndy Whitcroft 843f0a594c1SAndy Whitcroft my $level = 0; 8444635f4fbSAndy Whitcroft my @stack = ($level); 84500df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 84600df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 84700df344fSAndy Whitcroft $remain--; 84800df344fSAndy Whitcroft 84900df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8504635f4fbSAndy Whitcroft 8514635f4fbSAndy Whitcroft # Handle nested #if/#else. 85201464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8534635f4fbSAndy Whitcroft push(@stack, $level); 85401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8554635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 85601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8574635f4fbSAndy Whitcroft $level = pop(@stack); 8584635f4fbSAndy Whitcroft } 8594635f4fbSAndy Whitcroft 86001464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 861f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 862f0a594c1SAndy Whitcroft if ($off > 0) { 863f0a594c1SAndy Whitcroft $off--; 864f0a594c1SAndy Whitcroft next; 865f0a594c1SAndy Whitcroft } 8664a0df2efSAndy Whitcroft 867f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 868f0a594c1SAndy Whitcroft $level--; 869f0a594c1SAndy Whitcroft last if ($level == 0); 870f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 871f0a594c1SAndy Whitcroft $level++; 872f0a594c1SAndy Whitcroft } 873f0a594c1SAndy Whitcroft } 8744a0df2efSAndy Whitcroft 875f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 87600df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8774a0df2efSAndy Whitcroft } 8784a0df2efSAndy Whitcroft 879f0a594c1SAndy Whitcroft last if ($level == 0); 8804a0df2efSAndy Whitcroft } 8814a0df2efSAndy Whitcroft 882f0a594c1SAndy Whitcroft return ($level, @res); 8834a0df2efSAndy Whitcroft} 8844a0df2efSAndy Whitcroftsub ctx_block_outer { 8854a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8864a0df2efSAndy Whitcroft 887f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 888f0a594c1SAndy Whitcroft return @r; 8894a0df2efSAndy Whitcroft} 8904a0df2efSAndy Whitcroftsub ctx_block { 8914a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8924a0df2efSAndy Whitcroft 893f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 894f0a594c1SAndy Whitcroft return @r; 895653d4876SAndy Whitcroft} 896653d4876SAndy Whitcroftsub ctx_statement { 897f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 898f0a594c1SAndy Whitcroft 899f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 900f0a594c1SAndy Whitcroft return @r; 901f0a594c1SAndy Whitcroft} 902f0a594c1SAndy Whitcroftsub ctx_block_level { 903653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 904653d4876SAndy Whitcroft 905f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9064a0df2efSAndy Whitcroft} 9079c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9089c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9099c0ca6f9SAndy Whitcroft 9109c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9119c0ca6f9SAndy Whitcroft} 9124a0df2efSAndy Whitcroft 9134a0df2efSAndy Whitcroftsub ctx_locate_comment { 9144a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9154a0df2efSAndy Whitcroft 9164a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 917beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9184a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9194a0df2efSAndy Whitcroft 9204a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9214a0df2efSAndy Whitcroft # comment. 9224a0df2efSAndy Whitcroft my $in_comment = 0; 9234a0df2efSAndy Whitcroft $current_comment = ''; 9244a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 92500df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 92600df344fSAndy Whitcroft #warn " $line\n"; 9274a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9284a0df2efSAndy Whitcroft $in_comment = 1; 9294a0df2efSAndy Whitcroft } 9304a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9314a0df2efSAndy Whitcroft $in_comment = 1; 9324a0df2efSAndy Whitcroft } 9334a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9344a0df2efSAndy Whitcroft $current_comment = ''; 9354a0df2efSAndy Whitcroft } 9364a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9374a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9384a0df2efSAndy Whitcroft $in_comment = 0; 9394a0df2efSAndy Whitcroft } 9404a0df2efSAndy Whitcroft } 9414a0df2efSAndy Whitcroft 9424a0df2efSAndy Whitcroft chomp($current_comment); 9434a0df2efSAndy Whitcroft return($current_comment); 9444a0df2efSAndy Whitcroft} 9454a0df2efSAndy Whitcroftsub ctx_has_comment { 9464a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9474a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9484a0df2efSAndy Whitcroft 94900df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9504a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9514a0df2efSAndy Whitcroft 9524a0df2efSAndy Whitcroft return ($cmt ne ''); 9534a0df2efSAndy Whitcroft} 9544a0df2efSAndy Whitcroft 9554d001e4dSAndy Whitcroftsub raw_line { 9564d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9574d001e4dSAndy Whitcroft 9584d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9594d001e4dSAndy Whitcroft $cnt++; 9604d001e4dSAndy Whitcroft 9614d001e4dSAndy Whitcroft my $line; 9624d001e4dSAndy Whitcroft while ($cnt) { 9634d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9644d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9654d001e4dSAndy Whitcroft $cnt--; 9664d001e4dSAndy Whitcroft } 9674d001e4dSAndy Whitcroft 9684d001e4dSAndy Whitcroft return $line; 9694d001e4dSAndy Whitcroft} 9704d001e4dSAndy Whitcroft 9710a920b5bSAndy Whitcroftsub cat_vet { 9720a920b5bSAndy Whitcroft my ($vet) = @_; 9739c0ca6f9SAndy Whitcroft my ($res, $coded); 9740a920b5bSAndy Whitcroft 9759c0ca6f9SAndy Whitcroft $res = ''; 9766c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9776c72ffaaSAndy Whitcroft $res .= $1; 9786c72ffaaSAndy Whitcroft if ($2 ne '') { 9799c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9806c72ffaaSAndy Whitcroft $res .= $coded; 9816c72ffaaSAndy Whitcroft } 9829c0ca6f9SAndy Whitcroft } 9839c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 9840a920b5bSAndy Whitcroft 9859c0ca6f9SAndy Whitcroft return $res; 9860a920b5bSAndy Whitcroft} 9870a920b5bSAndy Whitcroft 988c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 989cf655043SAndy Whitcroftmy $av_pending; 990c2fdda0dSAndy Whitcroftmy @av_paren_type; 9911f65f947SAndy Whitcroftmy $av_pend_colon; 992c2fdda0dSAndy Whitcroft 993c2fdda0dSAndy Whitcroftsub annotate_reset { 994c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 995cf655043SAndy Whitcroft $av_pending = '_'; 996cf655043SAndy Whitcroft @av_paren_type = ('E'); 9971f65f947SAndy Whitcroft $av_pend_colon = 'O'; 998c2fdda0dSAndy Whitcroft} 999c2fdda0dSAndy Whitcroft 10006c72ffaaSAndy Whitcroftsub annotate_values { 10016c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10026c72ffaaSAndy Whitcroft 10036c72ffaaSAndy Whitcroft my $res; 10041f65f947SAndy Whitcroft my $var = '_' x length($stream); 10056c72ffaaSAndy Whitcroft my $cur = $stream; 10066c72ffaaSAndy Whitcroft 1007c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10086c72ffaaSAndy Whitcroft 10096c72ffaaSAndy Whitcroft while (length($cur)) { 1010773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1011cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1012171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10136c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1014c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1015c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1016cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1017c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10186c72ffaaSAndy Whitcroft } 10196c72ffaaSAndy Whitcroft 1020c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10219446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10229446ef56SAndy Whitcroft push(@av_paren_type, $type); 10239446ef56SAndy Whitcroft $type = 'C'; 10249446ef56SAndy Whitcroft 1025e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1026c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10276c72ffaaSAndy Whitcroft $type = 'T'; 10286c72ffaaSAndy Whitcroft 1029389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1030389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1031389a2fe5SAndy Whitcroft $type = 'T'; 1032389a2fe5SAndy Whitcroft 1033c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1034171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1035c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1036171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1037171ae1a4SAndy Whitcroft if ($2 ne '') { 1038cf655043SAndy Whitcroft $av_pending = 'N'; 1039171ae1a4SAndy Whitcroft } 1040171ae1a4SAndy Whitcroft $type = 'E'; 1041171ae1a4SAndy Whitcroft 1042c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1043171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1044171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1045171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10466c72ffaaSAndy Whitcroft 1047c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1048cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1049c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1050cf655043SAndy Whitcroft 1051cf655043SAndy Whitcroft push(@av_paren_type, $type); 1052cf655043SAndy Whitcroft push(@av_paren_type, $type); 1053171ae1a4SAndy Whitcroft $type = 'E'; 1054cf655043SAndy Whitcroft 1055c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1056cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1057cf655043SAndy Whitcroft $av_preprocessor = 1; 1058cf655043SAndy Whitcroft 1059cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1060cf655043SAndy Whitcroft 1061171ae1a4SAndy Whitcroft $type = 'E'; 1062cf655043SAndy Whitcroft 1063c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1064cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1065cf655043SAndy Whitcroft 1066cf655043SAndy Whitcroft $av_preprocessor = 1; 1067cf655043SAndy Whitcroft 1068cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1069cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1070cf655043SAndy Whitcroft pop(@av_paren_type); 1071cf655043SAndy Whitcroft push(@av_paren_type, $type); 1072171ae1a4SAndy Whitcroft $type = 'E'; 10736c72ffaaSAndy Whitcroft 10746c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1075c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10766c72ffaaSAndy Whitcroft 1077171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1078171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1079171ae1a4SAndy Whitcroft $av_pending = $type; 1080171ae1a4SAndy Whitcroft $type = 'N'; 1081171ae1a4SAndy Whitcroft 10826c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1083c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 10846c72ffaaSAndy Whitcroft if (defined $2) { 1085cf655043SAndy Whitcroft $av_pending = 'V'; 10866c72ffaaSAndy Whitcroft } 10876c72ffaaSAndy Whitcroft $type = 'N'; 10886c72ffaaSAndy Whitcroft 108914b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1090c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 109114b111c1SAndy Whitcroft $av_pending = 'E'; 10926c72ffaaSAndy Whitcroft $type = 'N'; 10936c72ffaaSAndy Whitcroft 10941f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 10951f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 10961f65f947SAndy Whitcroft $av_pend_colon = 'C'; 10971f65f947SAndy Whitcroft $type = 'N'; 10981f65f947SAndy Whitcroft 109914b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1100c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11016c72ffaaSAndy Whitcroft $type = 'N'; 11026c72ffaaSAndy Whitcroft 11036c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1104c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1105cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1106cf655043SAndy Whitcroft $av_pending = '_'; 11076c72ffaaSAndy Whitcroft $type = 'N'; 11086c72ffaaSAndy Whitcroft 11096c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1110cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1111cf655043SAndy Whitcroft if ($new_type ne '_') { 1112cf655043SAndy Whitcroft $type = $new_type; 1113c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1114c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11156c72ffaaSAndy Whitcroft } else { 1116c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11176c72ffaaSAndy Whitcroft } 11186c72ffaaSAndy Whitcroft 1119c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1120c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1121c8cb2ca3SAndy Whitcroft $type = 'V'; 1122cf655043SAndy Whitcroft $av_pending = 'V'; 11236c72ffaaSAndy Whitcroft 11248e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11258e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11261f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11278e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11288e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11291f65f947SAndy Whitcroft } 11301f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11311f65f947SAndy Whitcroft $type = 'V'; 11321f65f947SAndy Whitcroft 11336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1134c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11356c72ffaaSAndy Whitcroft $type = 'V'; 11366c72ffaaSAndy Whitcroft 11376c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1138c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11396c72ffaaSAndy Whitcroft $type = 'N'; 11406c72ffaaSAndy Whitcroft 1141cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1142c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 114313214adfSAndy Whitcroft $type = 'E'; 11441f65f947SAndy Whitcroft $av_pend_colon = 'O'; 114513214adfSAndy Whitcroft 11468e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11478e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11488e761b04SAndy Whitcroft $type = 'C'; 11498e761b04SAndy Whitcroft 11501f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11511f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11521f65f947SAndy Whitcroft $type = 'N'; 11531f65f947SAndy Whitcroft 11541f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11551f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11561f65f947SAndy Whitcroft 11571f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11581f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11591f65f947SAndy Whitcroft $type = 'E'; 11601f65f947SAndy Whitcroft } else { 11611f65f947SAndy Whitcroft $type = 'N'; 11621f65f947SAndy Whitcroft } 11631f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11641f65f947SAndy Whitcroft 11658e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 116613214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11676c72ffaaSAndy Whitcroft $type = 'N'; 11686c72ffaaSAndy Whitcroft 11690d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 117074048ed8SAndy Whitcroft my $variant; 117174048ed8SAndy Whitcroft 117274048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 117374048ed8SAndy Whitcroft if ($type eq 'V') { 117474048ed8SAndy Whitcroft $variant = 'B'; 117574048ed8SAndy Whitcroft } else { 117674048ed8SAndy Whitcroft $variant = 'U'; 117774048ed8SAndy Whitcroft } 117874048ed8SAndy Whitcroft 117974048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 118074048ed8SAndy Whitcroft $type = 'N'; 118174048ed8SAndy Whitcroft 11826c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1183c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 11846c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 11856c72ffaaSAndy Whitcroft $type = 'N'; 11866c72ffaaSAndy Whitcroft } 11876c72ffaaSAndy Whitcroft 11886c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1189c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 11906c72ffaaSAndy Whitcroft } 11916c72ffaaSAndy Whitcroft if (defined $1) { 11926c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 11936c72ffaaSAndy Whitcroft $res .= $type x length($1); 11946c72ffaaSAndy Whitcroft } 11956c72ffaaSAndy Whitcroft } 11966c72ffaaSAndy Whitcroft 11971f65f947SAndy Whitcroft return ($res, $var); 11986c72ffaaSAndy Whitcroft} 11996c72ffaaSAndy Whitcroft 12008905a67cSAndy Whitcroftsub possible { 120113214adfSAndy Whitcroft my ($possible, $line) = @_; 12029a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12030776e594SAndy Whitcroft ^(?: 12040776e594SAndy Whitcroft $Modifier| 12050776e594SAndy Whitcroft $Storage| 12060776e594SAndy Whitcroft $Type| 12079a974fdbSAndy Whitcroft DEFINE_\S+ 12089a974fdbSAndy Whitcroft )$| 12099a974fdbSAndy Whitcroft ^(?: 12100776e594SAndy Whitcroft goto| 12110776e594SAndy Whitcroft return| 12120776e594SAndy Whitcroft case| 12130776e594SAndy Whitcroft else| 12140776e594SAndy Whitcroft asm|__asm__| 12150776e594SAndy Whitcroft do 12169a974fdbSAndy Whitcroft )(?:\s|$)| 12170776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12189a974fdbSAndy Whitcroft )}x; 12199a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12209a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1221c45dcabdSAndy Whitcroft # Check for modifiers. 1222c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1223c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1224c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1225c45dcabdSAndy Whitcroft 1226c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1227c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1228d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12299a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1230d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1231d2506586SAndy Whitcroft push(@modifierList, $modifier); 1232d2506586SAndy Whitcroft } 12339a974fdbSAndy Whitcroft } 1234c45dcabdSAndy Whitcroft 1235c45dcabdSAndy Whitcroft } else { 123613214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12378905a67cSAndy Whitcroft push(@typeList, $possible); 1238c45dcabdSAndy Whitcroft } 12398905a67cSAndy Whitcroft build_types(); 12400776e594SAndy Whitcroft } else { 12410776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12428905a67cSAndy Whitcroft } 12438905a67cSAndy Whitcroft} 12448905a67cSAndy Whitcroft 12456c72ffaaSAndy Whitcroftmy $prefix = ''; 12466c72ffaaSAndy Whitcroft 1247000d1cc1SJoe Perchessub show_type { 1248000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1249000d1cc1SJoe Perches} 1250000d1cc1SJoe Perches 1251f0a594c1SAndy Whitcroftsub report { 1252000d1cc1SJoe Perches if (!show_type($_[1]) || 1253000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1254773647a0SAndy Whitcroft return 0; 1255773647a0SAndy Whitcroft } 1256000d1cc1SJoe Perches my $line; 1257000d1cc1SJoe Perches if ($show_types) { 1258000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1259000d1cc1SJoe Perches } else { 1260000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1261000d1cc1SJoe Perches } 12628905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12638905a67cSAndy Whitcroft 126413214adfSAndy Whitcroft push(our @report, $line); 1265773647a0SAndy Whitcroft 1266773647a0SAndy Whitcroft return 1; 1267f0a594c1SAndy Whitcroft} 1268f0a594c1SAndy Whitcroftsub report_dump { 126913214adfSAndy Whitcroft our @report; 1270f0a594c1SAndy Whitcroft} 1271000d1cc1SJoe Perches 1272de7d4f0eSAndy Whitcroftsub ERROR { 1273000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1274de7d4f0eSAndy Whitcroft our $clean = 0; 12756c72ffaaSAndy Whitcroft our $cnt_error++; 1276de7d4f0eSAndy Whitcroft } 1277773647a0SAndy Whitcroft} 1278de7d4f0eSAndy Whitcroftsub WARN { 1279000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1280de7d4f0eSAndy Whitcroft our $clean = 0; 12816c72ffaaSAndy Whitcroft our $cnt_warn++; 1282de7d4f0eSAndy Whitcroft } 1283773647a0SAndy Whitcroft} 1284de7d4f0eSAndy Whitcroftsub CHK { 1285000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1286de7d4f0eSAndy Whitcroft our $clean = 0; 12876c72ffaaSAndy Whitcroft our $cnt_chk++; 12886c72ffaaSAndy Whitcroft } 1289de7d4f0eSAndy Whitcroft} 1290de7d4f0eSAndy Whitcroft 12916ecd9674SAndy Whitcroftsub check_absolute_file { 12926ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 12936ecd9674SAndy Whitcroft my $file = $absolute; 12946ecd9674SAndy Whitcroft 12956ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 12966ecd9674SAndy Whitcroft 12976ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 12986ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 12996ecd9674SAndy Whitcroft if (-f "$root/$file") { 13006ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13016ecd9674SAndy Whitcroft last; 13026ecd9674SAndy Whitcroft } 13036ecd9674SAndy Whitcroft } 13046ecd9674SAndy Whitcroft if (! -f _) { 13056ecd9674SAndy Whitcroft return 0; 13066ecd9674SAndy Whitcroft } 13076ecd9674SAndy Whitcroft 13086ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13096ecd9674SAndy Whitcroft my $prefix = $absolute; 13106ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13116ecd9674SAndy Whitcroft 13126ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13136ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1314000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1315000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13166ecd9674SAndy Whitcroft } 13176ecd9674SAndy Whitcroft} 13186ecd9674SAndy Whitcroft 13190a920b5bSAndy Whitcroftsub process { 13200a920b5bSAndy Whitcroft my $filename = shift; 13210a920b5bSAndy Whitcroft 13220a920b5bSAndy Whitcroft my $linenr=0; 13230a920b5bSAndy Whitcroft my $prevline=""; 1324c2fdda0dSAndy Whitcroft my $prevrawline=""; 13250a920b5bSAndy Whitcroft my $stashline=""; 1326c2fdda0dSAndy Whitcroft my $stashrawline=""; 13270a920b5bSAndy Whitcroft 13284a0df2efSAndy Whitcroft my $length; 13290a920b5bSAndy Whitcroft my $indent; 13300a920b5bSAndy Whitcroft my $previndent=0; 13310a920b5bSAndy Whitcroft my $stashindent=0; 13320a920b5bSAndy Whitcroft 1333de7d4f0eSAndy Whitcroft our $clean = 1; 13340a920b5bSAndy Whitcroft my $signoff = 0; 13350a920b5bSAndy Whitcroft my $is_patch = 0; 13360a920b5bSAndy Whitcroft 1337*15662b3eSJoe Perches my $in_header_lines = 1; 1338*15662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 1339*15662b3eSJoe Perches 134013214adfSAndy Whitcroft our @report = (); 13416c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13426c72ffaaSAndy Whitcroft our $cnt_error = 0; 13436c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13446c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13456c72ffaaSAndy Whitcroft 13460a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13470a920b5bSAndy Whitcroft my $realfile = ''; 13480a920b5bSAndy Whitcroft my $realline = 0; 13490a920b5bSAndy Whitcroft my $realcnt = 0; 13500a920b5bSAndy Whitcroft my $here = ''; 13510a920b5bSAndy Whitcroft my $in_comment = 0; 1352c2fdda0dSAndy Whitcroft my $comment_edge = 0; 13530a920b5bSAndy Whitcroft my $first_line = 0; 13541e855726SWolfram Sang my $p1_prefix = ''; 13550a920b5bSAndy Whitcroft 135613214adfSAndy Whitcroft my $prev_values = 'E'; 135713214adfSAndy Whitcroft 135813214adfSAndy Whitcroft # suppression flags 1359773647a0SAndy Whitcroft my %suppress_ifbraces; 1360170d3a22SAndy Whitcroft my %suppress_whiletrailers; 13612b474a1aSAndy Whitcroft my %suppress_export; 1362653d4876SAndy Whitcroft 1363c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1364de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1365c2fdda0dSAndy Whitcroft # 1366de7d4f0eSAndy Whitcroft my @setup_docs = (); 1367de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1368773647a0SAndy Whitcroft 1369773647a0SAndy Whitcroft sanitise_line_reset(); 1370c2fdda0dSAndy Whitcroft my $line; 1371c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1372773647a0SAndy Whitcroft $linenr++; 1373773647a0SAndy Whitcroft $line = $rawline; 1374c2fdda0dSAndy Whitcroft 1375773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1376de7d4f0eSAndy Whitcroft $setup_docs = 0; 1377de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1378de7d4f0eSAndy Whitcroft $setup_docs = 1; 1379de7d4f0eSAndy Whitcroft } 1380773647a0SAndy Whitcroft #next; 1381de7d4f0eSAndy Whitcroft } 1382773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1383773647a0SAndy Whitcroft $realline=$1-1; 1384773647a0SAndy Whitcroft if (defined $2) { 1385773647a0SAndy Whitcroft $realcnt=$3+1; 1386773647a0SAndy Whitcroft } else { 1387773647a0SAndy Whitcroft $realcnt=1+1; 1388773647a0SAndy Whitcroft } 1389c45dcabdSAndy Whitcroft $in_comment = 0; 1390773647a0SAndy Whitcroft 1391773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1392773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1393773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1394773647a0SAndy Whitcroft # at context start. 1395773647a0SAndy Whitcroft my $edge; 139601fa9147SAndy Whitcroft my $cnt = $realcnt; 139701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 139801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 139901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 140001fa9147SAndy Whitcroft $cnt--; 140101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1402721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1403fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1404fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1405fae17daeSAndy Whitcroft ($edge) = $1; 1406fae17daeSAndy Whitcroft last; 1407fae17daeSAndy Whitcroft } 1408773647a0SAndy Whitcroft } 1409773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1410773647a0SAndy Whitcroft $in_comment = 1; 1411773647a0SAndy Whitcroft } 1412773647a0SAndy Whitcroft 1413773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1414773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1415773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1416773647a0SAndy Whitcroft if (!defined $edge && 141783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1418773647a0SAndy Whitcroft { 1419773647a0SAndy Whitcroft $in_comment = 1; 1420773647a0SAndy Whitcroft } 1421773647a0SAndy Whitcroft 1422773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1423773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1424773647a0SAndy Whitcroft 1425171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1426773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1427171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1428773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1429773647a0SAndy Whitcroft } 1430773647a0SAndy Whitcroft push(@lines, $line); 1431773647a0SAndy Whitcroft 1432773647a0SAndy Whitcroft if ($realcnt > 1) { 1433773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1434773647a0SAndy Whitcroft } else { 1435773647a0SAndy Whitcroft $realcnt = 0; 1436773647a0SAndy Whitcroft } 1437773647a0SAndy Whitcroft 1438773647a0SAndy Whitcroft #print "==>$rawline\n"; 1439773647a0SAndy Whitcroft #print "-->$line\n"; 1440de7d4f0eSAndy Whitcroft 1441de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1442de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1443de7d4f0eSAndy Whitcroft } 1444de7d4f0eSAndy Whitcroft } 1445de7d4f0eSAndy Whitcroft 14466c72ffaaSAndy Whitcroft $prefix = ''; 14476c72ffaaSAndy Whitcroft 1448773647a0SAndy Whitcroft $realcnt = 0; 1449773647a0SAndy Whitcroft $linenr = 0; 14500a920b5bSAndy Whitcroft foreach my $line (@lines) { 14510a920b5bSAndy Whitcroft $linenr++; 14520a920b5bSAndy Whitcroft 1453c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 14546c72ffaaSAndy Whitcroft 14550a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 14566c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14570a920b5bSAndy Whitcroft $is_patch = 1; 14584a0df2efSAndy Whitcroft $first_line = $linenr + 1; 14590a920b5bSAndy Whitcroft $realline=$1-1; 14600a920b5bSAndy Whitcroft if (defined $2) { 14610a920b5bSAndy Whitcroft $realcnt=$3+1; 14620a920b5bSAndy Whitcroft } else { 14630a920b5bSAndy Whitcroft $realcnt=1+1; 14640a920b5bSAndy Whitcroft } 1465c2fdda0dSAndy Whitcroft annotate_reset(); 146613214adfSAndy Whitcroft $prev_values = 'E'; 146713214adfSAndy Whitcroft 1468773647a0SAndy Whitcroft %suppress_ifbraces = (); 1469170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 14702b474a1aSAndy Whitcroft %suppress_export = (); 14710a920b5bSAndy Whitcroft next; 14720a920b5bSAndy Whitcroft 14734a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 14744a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 14754a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1476773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 14770a920b5bSAndy Whitcroft $realline++; 1478d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 14790a920b5bSAndy Whitcroft 14804a0df2efSAndy Whitcroft # Measure the line length and indent. 1481c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 14820a920b5bSAndy Whitcroft 14830a920b5bSAndy Whitcroft # Track the previous line. 14840a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 14850a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1486c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1487c2fdda0dSAndy Whitcroft 1488773647a0SAndy Whitcroft #warn "line<$line>\n"; 14896c72ffaaSAndy Whitcroft 1490d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1491d8aaf121SAndy Whitcroft $realcnt--; 14920a920b5bSAndy Whitcroft } 14930a920b5bSAndy Whitcroft 1494cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1495cc77cdcaSAndy Whitcroft 14960a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1497773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1498773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1499773647a0SAndy Whitcroft 15006c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15016c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1502773647a0SAndy Whitcroft 1503773647a0SAndy Whitcroft # extract the filename as it passes 15043bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15053bf9a009SRabin Vincent $realfile = $1; 15063bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 15073bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1508773647a0SAndy Whitcroft $realfile = $1; 15091e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 15101e855726SWolfram Sang 15111e855726SWolfram Sang $p1_prefix = $1; 1512e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1513e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1514000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1515000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15161e855726SWolfram Sang } 1517773647a0SAndy Whitcroft 1518c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1519000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1520000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1521773647a0SAndy Whitcroft } 1522773647a0SAndy Whitcroft next; 1523773647a0SAndy Whitcroft } 1524773647a0SAndy Whitcroft 1525389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15260a920b5bSAndy Whitcroft 1527c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1528c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1529c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15300a920b5bSAndy Whitcroft 15316c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15326c72ffaaSAndy Whitcroft 15333bf9a009SRabin Vincent# Check for incorrect file permissions 15343bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15353bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 15363bf9a009SRabin Vincent if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1537000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1538000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15393bf9a009SRabin Vincent } 15403bf9a009SRabin Vincent } 15413bf9a009SRabin Vincent 154220112475SJoe Perches# Check the patch for a signoff: 1543d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15444a0df2efSAndy Whitcroft $signoff++; 1545*15662b3eSJoe Perches $in_commit_log = 0; 15460a920b5bSAndy Whitcroft } 154720112475SJoe Perches 154820112475SJoe Perches# Check signature styles 154920112475SJoe Perches if ($line =~ /^(\s*)($signature_tags)(\s*)(.*)/) { 155020112475SJoe Perches my $space_before = $1; 155120112475SJoe Perches my $sign_off = $2; 155220112475SJoe Perches my $space_after = $3; 155320112475SJoe Perches my $email = $4; 155420112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 155520112475SJoe Perches 155620112475SJoe Perches if (defined $space_before && $space_before ne "") { 1557000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1558000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 155920112475SJoe Perches } 156020112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1561000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1562000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 156320112475SJoe Perches } 156420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1565000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1566000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 156720112475SJoe Perches } 156820112475SJoe Perches 156920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 157020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 157120112475SJoe Perches if ($suggested_email eq "") { 1572000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1573000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 157420112475SJoe Perches } else { 157520112475SJoe Perches my $dequoted = $suggested_email; 157620112475SJoe Perches $dequoted =~ s/^"//; 157720112475SJoe Perches $dequoted =~ s/" </ </; 157820112475SJoe Perches # Don't force email to have quotes 157920112475SJoe Perches # Allow just an angle bracketed address 158020112475SJoe Perches if ("$dequoted$comment" ne $email && 158120112475SJoe Perches "<$email_address>$comment" ne $email && 158220112475SJoe Perches "$suggested_email$comment" ne $email) { 1583000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1584000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 158520112475SJoe Perches } 15860a920b5bSAndy Whitcroft } 15870a920b5bSAndy Whitcroft } 15880a920b5bSAndy Whitcroft 158900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 15908905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1591000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1592000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 15936c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1594de7d4f0eSAndy Whitcroft } 1595de7d4f0eSAndy Whitcroft 15966ecd9674SAndy Whitcroft# Check for absolute kernel paths. 15976ecd9674SAndy Whitcroft if ($tree) { 15986ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 15996ecd9674SAndy Whitcroft my $file = $1; 16006ecd9674SAndy Whitcroft 16016ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16026ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16036ecd9674SAndy Whitcroft # 16046ecd9674SAndy Whitcroft } else { 16056ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16066ecd9674SAndy Whitcroft } 16076ecd9674SAndy Whitcroft } 16086ecd9674SAndy Whitcroft } 16096ecd9674SAndy Whitcroft 1610de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1611de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1612171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1613171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1614171ae1a4SAndy Whitcroft 1615171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1616171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1617171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1618171ae1a4SAndy Whitcroft 161934d99219SJoe Perches CHK("INVALID_UTF8", 1620000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 162100df344fSAndy Whitcroft } 16220a920b5bSAndy Whitcroft 1623*15662b3eSJoe Perches# Check if it's the start of a commit log 1624*15662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 1625*15662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1626*15662b3eSJoe Perches $rawline !~ /^(commit\b|from\b|\w+:).+$/i) { 1627*15662b3eSJoe Perches $in_header_lines = 0; 1628*15662b3eSJoe Perches $in_commit_log = 1; 1629*15662b3eSJoe Perches } 1630*15662b3eSJoe Perches 1631*15662b3eSJoe Perches# Still not yet in a patch, check for any UTF-8 1632*15662b3eSJoe Perches if ($in_commit_log && $realfile =~ /^$/ && 1633*15662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1634*15662b3eSJoe Perches CHK("UTF8_BEFORE_PATCH", 1635*15662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 1636*15662b3eSJoe Perches } 1637*15662b3eSJoe Perches 163830670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 163930670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 164000df344fSAndy Whitcroft 16410a920b5bSAndy Whitcroft#trailing whitespace 16429c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1643c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1644000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1645000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 16469c0ca6f9SAndy Whitcroft 1647c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1648c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1649000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1650000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1651d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 16520a920b5bSAndy Whitcroft } 16535368df20SAndy Whitcroft 16543354957aSAndi Kleen# check for Kconfig help text having a real description 16559fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 16569fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 16573354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 16589fe287d7SAndy Whitcroft $line =~ /\+\s*(?:---)?help(?:---)?$/) { 16593354957aSAndi Kleen my $length = 0; 16609fe287d7SAndy Whitcroft my $cnt = $realcnt; 16619fe287d7SAndy Whitcroft my $ln = $linenr + 1; 16629fe287d7SAndy Whitcroft my $f; 16639fe287d7SAndy Whitcroft my $is_end = 0; 16649fe287d7SAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1]) { 16659fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 16669fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 16679fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 16689fe287d7SAndy Whitcroft $ln++; 16699fe287d7SAndy Whitcroft 16709fe287d7SAndy Whitcroft next if ($f =~ /^-/); 16719fe287d7SAndy Whitcroft $f =~ s/^.//; 16723354957aSAndi Kleen $f =~ s/#.*//; 16733354957aSAndi Kleen $f =~ s/^\s+//; 16743354957aSAndi Kleen next if ($f =~ /^$/); 16759fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 16769fe287d7SAndy Whitcroft $is_end = 1; 16779fe287d7SAndy Whitcroft last; 16789fe287d7SAndy Whitcroft } 16793354957aSAndi Kleen $length++; 16803354957aSAndi Kleen } 1681000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1682000d1cc1SJoe Perches "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4); 16839fe287d7SAndy Whitcroft #print "is_end<$is_end> length<$length>\n"; 16843354957aSAndi Kleen } 16853354957aSAndi Kleen 16865368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 16875368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 16885368df20SAndy Whitcroft 16890a920b5bSAndy Whitcroft#80 column limit 1690c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1691f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 16920fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 16938bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1694f4c014c0SAndy Whitcroft $length > 80) 1695c45dcabdSAndy Whitcroft { 1696000d1cc1SJoe Perches WARN("LONG_LINE", 1697000d1cc1SJoe Perches "line over 80 characters\n" . $herecurr); 16980a920b5bSAndy Whitcroft } 16990a920b5bSAndy Whitcroft 17005e79d96eSJoe Perches# check for spaces before a quoted newline 17015e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1702000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1703000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 17045e79d96eSJoe Perches } 17055e79d96eSJoe Perches 17068905a67cSAndy Whitcroft# check for adding lines without a newline. 17078905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1708000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1709000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 17108905a67cSAndy Whitcroft } 17118905a67cSAndy Whitcroft 171242e41c54SMike Frysinger# Blackfin: use hi/lo macros 171342e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 171442e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 171542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1716000d1cc1SJoe Perches ERROR("LO_MACRO", 1717000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 171842e41c54SMike Frysinger } 171942e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 172042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1721000d1cc1SJoe Perches ERROR("HI_MACRO", 1722000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 172342e41c54SMike Frysinger } 172442e41c54SMike Frysinger } 172542e41c54SMike Frysinger 1726b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1727b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 17280a920b5bSAndy Whitcroft 17290a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 17300a920b5bSAndy Whitcroft# more than 8 must use tabs. 1731c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1732c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1733c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1734000d1cc1SJoe Perches ERROR("CODE_INDENT", 1735000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1736d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17370a920b5bSAndy Whitcroft } 17380a920b5bSAndy Whitcroft 173908e44365SAlberto Panizzo# check for space before tabs. 174008e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 174108e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1742000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1743000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 174408e44365SAlberto Panizzo } 174508e44365SAlberto Panizzo 17465f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 17476b4c5bebSAndy Whitcroft# Exceptions: 17486b4c5bebSAndy Whitcroft# 1) within comments 17496b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 17506b4c5bebSAndy Whitcroft# 3) hanging labels 17516b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 17525f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1753000d1cc1SJoe Perches WARN("LEADING_SPACE", 1754000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 17555f7ddae6SRaffaele Recalcati } 17565f7ddae6SRaffaele Recalcati 1757b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1758b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1759b9ea10d6SAndy Whitcroft 1760c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1761cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1762000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1763000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1764c2fdda0dSAndy Whitcroft } 176522f2a2efSAndy Whitcroft 176642e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 176742e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 176842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1769000d1cc1SJoe Perches ERROR("CSYNC", 1770000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 177142e41c54SMike Frysinger } 177242e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 177342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1774000d1cc1SJoe Perches ERROR("SSYNC", 1775000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 177642e41c54SMike Frysinger } 177742e41c54SMike Frysinger 17789c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 17792b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 17802b474a1aSAndy Whitcroft $realline_next); 17819c9ba34eSAndy Whitcroft if ($realcnt && $line =~ /.\s*\S/) { 1782170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1783f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1784171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1785171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1786171ae1a4SAndy Whitcroft 17872b474a1aSAndy Whitcroft # Find the real next line. 17882b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 17892b474a1aSAndy Whitcroft if (defined $realline_next && 17902b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 17912b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 17922b474a1aSAndy Whitcroft $realline_next++; 17932b474a1aSAndy Whitcroft } 17942b474a1aSAndy Whitcroft 1795171ae1a4SAndy Whitcroft my $s = $stat; 1796171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1797cf655043SAndy Whitcroft 1798c2fdda0dSAndy Whitcroft # Ignore goto labels. 1799171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1800c2fdda0dSAndy Whitcroft 1801c2fdda0dSAndy Whitcroft # Ignore functions being called 1802171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1803c2fdda0dSAndy Whitcroft 1804463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1805463f2864SAndy Whitcroft 1806c45dcabdSAndy Whitcroft # declarations always start with types 1807d2506586SAndy 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) { 1808c45dcabdSAndy Whitcroft my $type = $1; 1809c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1810c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1811c45dcabdSAndy Whitcroft 18126c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1813a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1814c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1815c2fdda0dSAndy Whitcroft } 18168905a67cSAndy Whitcroft 18176c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 181865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1819c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 18209c0ca6f9SAndy Whitcroft } 18218905a67cSAndy Whitcroft 18228905a67cSAndy Whitcroft # Check for any sort of function declaration. 18238905a67cSAndy Whitcroft # int foo(something bar, other baz); 18248905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1825171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 18268905a67cSAndy Whitcroft my ($name_len) = length($1); 18278905a67cSAndy Whitcroft 1828cf655043SAndy Whitcroft my $ctx = $s; 1829773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 18308905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1831cf655043SAndy Whitcroft 18328905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1833c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 18348905a67cSAndy Whitcroft 1835c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 18368905a67cSAndy Whitcroft } 18378905a67cSAndy Whitcroft } 18388905a67cSAndy Whitcroft } 18398905a67cSAndy Whitcroft 18409c0ca6f9SAndy Whitcroft } 18419c0ca6f9SAndy Whitcroft 184200df344fSAndy Whitcroft# 184300df344fSAndy Whitcroft# Checks which may be anchored in the context. 184400df344fSAndy Whitcroft# 184500df344fSAndy Whitcroft 184600df344fSAndy Whitcroft# Check for switch () and associated case and default 184700df344fSAndy Whitcroft# statements should be at the same indent. 184800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 184900df344fSAndy Whitcroft my $err = ''; 185000df344fSAndy Whitcroft my $sep = ''; 185100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 185200df344fSAndy Whitcroft shift(@ctx); 185300df344fSAndy Whitcroft for my $ctx (@ctx) { 185400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 185500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 185600df344fSAndy Whitcroft $indent != $cindent) { 185700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 185800df344fSAndy Whitcroft $sep = ''; 185900df344fSAndy Whitcroft } else { 186000df344fSAndy Whitcroft $sep = "[...]\n"; 186100df344fSAndy Whitcroft } 186200df344fSAndy Whitcroft } 186300df344fSAndy Whitcroft if ($err ne '') { 1864000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 1865000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 1866de7d4f0eSAndy Whitcroft } 1867de7d4f0eSAndy Whitcroft } 1868de7d4f0eSAndy Whitcroft 1869de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1870de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1871c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1872773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1873773647a0SAndy Whitcroft 18749c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1875de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1876de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1877de7d4f0eSAndy Whitcroft 1878548596d5SAndy Whitcroft my $ctx_ln = $linenr; 1879548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 1880de7d4f0eSAndy Whitcroft 1881548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1882548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 1883548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 1884548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1885548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1886773647a0SAndy Whitcroft $ctx_ln++; 1887773647a0SAndy Whitcroft } 1888548596d5SAndy Whitcroft 188953210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 189053210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1891773647a0SAndy Whitcroft 1892773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1893000d1cc1SJoe Perches ERROR("OPEN_BRACE", 1894000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 189501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 189600df344fSAndy Whitcroft } 1897773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1898773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1899773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1900773647a0SAndy Whitcroft { 19019c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 19029c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1903000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 1904000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 190501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 19069c0ca6f9SAndy Whitcroft } 19079c0ca6f9SAndy Whitcroft } 190800df344fSAndy Whitcroft } 190900df344fSAndy Whitcroft 19104d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 19114d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 19124d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 19134d001e4dSAndy Whitcroft 19144d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 19154d001e4dSAndy Whitcroft 19164d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 19174d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 19184d001e4dSAndy Whitcroft # where necessary. 19194d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 19204d001e4dSAndy Whitcroft 19214d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 19226f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 19236f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 19244d001e4dSAndy Whitcroft 19254d001e4dSAndy Whitcroft # We want to check the first line inside the block 19264d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 19274d001e4dSAndy Whitcroft # 1) any blank line termination 19284d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 19294d001e4dSAndy Whitcroft # 3) any do (...) { 19304d001e4dSAndy Whitcroft my $continuation = 0; 19314d001e4dSAndy Whitcroft my $check = 0; 19324d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 19334d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 19344d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 19354d001e4dSAndy Whitcroft $continuation = 1; 19364d001e4dSAndy Whitcroft } 19379bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 19384d001e4dSAndy Whitcroft $check = 1; 19394d001e4dSAndy Whitcroft $cond_lines++; 19404d001e4dSAndy Whitcroft } 19414d001e4dSAndy Whitcroft 19424d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 19434d001e4dSAndy Whitcroft # preprocessor statement. 19444d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 19454d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 19464d001e4dSAndy Whitcroft $check = 0; 19474d001e4dSAndy Whitcroft } 19484d001e4dSAndy Whitcroft 19499bd49efeSAndy Whitcroft my $cond_ptr = -1; 1950740504c6SAndy Whitcroft $continuation = 0; 19519bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 19529bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 19534d001e4dSAndy Whitcroft 1954f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 1955f16fa28fSAndy Whitcroft # is not linear. 1956f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1957f16fa28fSAndy Whitcroft $check = 0; 1958f16fa28fSAndy Whitcroft } 1959f16fa28fSAndy Whitcroft 19609bd49efeSAndy Whitcroft # Ignore: 19619bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 19629bd49efeSAndy Whitcroft # 2) preprocessor lines, and 19639bd49efeSAndy Whitcroft # 3) labels. 1964740504c6SAndy Whitcroft if ($continuation || 1965740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 19669bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 19679bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 1968740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 196930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 19709bd49efeSAndy Whitcroft $cond_lines++; 19719bd49efeSAndy Whitcroft } 19724d001e4dSAndy Whitcroft } 197330dad6ebSAndy Whitcroft } 19744d001e4dSAndy Whitcroft 19754d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 19764d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 19774d001e4dSAndy Whitcroft 19784d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 19794d001e4dSAndy Whitcroft # this is not this patch's fault. 19804d001e4dSAndy Whitcroft if (!defined($stat_real) || 19814d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 19824d001e4dSAndy Whitcroft $check = 0; 19834d001e4dSAndy Whitcroft } 19844d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 19854d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 19864d001e4dSAndy Whitcroft } 19874d001e4dSAndy Whitcroft 19889bd49efeSAndy 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"; 19894d001e4dSAndy Whitcroft 19904d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 19914d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 1992000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 1993000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 19944d001e4dSAndy Whitcroft } 19954d001e4dSAndy Whitcroft } 19964d001e4dSAndy Whitcroft 19976c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 19986c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 19991f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 20001f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 20016c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2002c2fdda0dSAndy Whitcroft if ($dbg_values) { 2003c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2004cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2005cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 20061f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2007c2fdda0dSAndy Whitcroft } 20086c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 20096c72ffaaSAndy Whitcroft 201000df344fSAndy Whitcroft#ignore lines not being added 201100df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 201200df344fSAndy Whitcroft 2013653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 20147429c690SAndy Whitcroft if ($dbg_type) { 20157429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2016000d1cc1SJoe Perches ERROR("TEST_TYPE", 2017000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 20187429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2019000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2020000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 20217429c690SAndy Whitcroft } 2022653d4876SAndy Whitcroft next; 2023653d4876SAndy Whitcroft } 2024a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2025a1ef277eSAndy Whitcroft if ($dbg_attr) { 20269360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2027000d1cc1SJoe Perches ERROR("TEST_ATTR", 2028000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 20299360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2030000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2031000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2032a1ef277eSAndy Whitcroft } 2033a1ef277eSAndy Whitcroft next; 2034a1ef277eSAndy Whitcroft } 2035653d4876SAndy Whitcroft 2036f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 203799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 203899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2039000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2040000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2041f0a594c1SAndy Whitcroft } 2042f0a594c1SAndy Whitcroft 204300df344fSAndy Whitcroft# 204400df344fSAndy Whitcroft# Checks which are anchored on the added line. 204500df344fSAndy Whitcroft# 204600df344fSAndy Whitcroft 2047653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2048c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2049653d4876SAndy Whitcroft my $path = $1; 2050653d4876SAndy Whitcroft if ($path =~ m{//}) { 2051000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2052000d1cc1SJoe Perches "malformed #include filename\n" . 2053de7d4f0eSAndy Whitcroft $herecurr); 2054653d4876SAndy Whitcroft } 2055653d4876SAndy Whitcroft } 2056653d4876SAndy Whitcroft 205700df344fSAndy Whitcroft# no C99 // comments 205800df344fSAndy Whitcroft if ($line =~ m{//}) { 2059000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2060000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 206100df344fSAndy Whitcroft } 206200df344fSAndy Whitcroft # Remove C99 comments. 20630a920b5bSAndy Whitcroft $line =~ s@//.*@@; 20646c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 20650a920b5bSAndy Whitcroft 20662b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 20672b474a1aSAndy Whitcroft# the whole statement. 20682b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 20692b474a1aSAndy Whitcroft if (defined $realline_next && 20702b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 20712b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 20722b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 20732b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 20743cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 20753cbf62dfSAndy Whitcroft # a prefix: 20763cbf62dfSAndy Whitcroft # XXX(foo); 20773cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2078653d4876SAndy Whitcroft my $name = $1; 20793cbf62dfSAndy Whitcroft if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ && 20803cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 20813cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 20823cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 20833cbf62dfSAndy Whitcroft 20843cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 20852b474a1aSAndy Whitcroft \n.}\s*$| 208648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 208748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 208848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 20892b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 20902b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 209148012058SAndy Whitcroft )/x) { 20922b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 20932b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 20942b474a1aSAndy Whitcroft } else { 20952b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 20960a920b5bSAndy Whitcroft } 20970a920b5bSAndy Whitcroft } 20982b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 20992b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 21002b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 21012b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 21022b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 21032b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 21042b474a1aSAndy Whitcroft } 21052b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 21062b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2107000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2108000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 21092b474a1aSAndy Whitcroft } 21100a920b5bSAndy Whitcroft 21115150bda4SJoe Eloff# check for global initialisers. 2112c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2113000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2114000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2115f0a594c1SAndy Whitcroft $herecurr); 2116f0a594c1SAndy Whitcroft } 21170a920b5bSAndy Whitcroft# check for static initialisers. 21182d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2119000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2120000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2121de7d4f0eSAndy Whitcroft $herecurr); 21220a920b5bSAndy Whitcroft } 21230a920b5bSAndy Whitcroft 2124cb710ecaSJoe Perches# check for static const char * arrays. 2125cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2126000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2127000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2128cb710ecaSJoe Perches $herecurr); 2129cb710ecaSJoe Perches } 2130cb710ecaSJoe Perches 2131cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2132cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2133000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2134000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2135cb710ecaSJoe Perches $herecurr); 2136cb710ecaSJoe Perches } 2137cb710ecaSJoe Perches 213893ed0e2dSJoe Perches# check for declarations of struct pci_device_id 213993ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2140000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2141000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 214293ed0e2dSJoe Perches } 214393ed0e2dSJoe Perches 2144653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2145653d4876SAndy Whitcroft# make sense. 2146653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 21478054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2148c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 21498ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2150653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2151000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2152000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 21530a920b5bSAndy Whitcroft } 21540a920b5bSAndy Whitcroft 21550a920b5bSAndy Whitcroft# * goes on variable not on type 215665863862SAndy Whitcroft # (char*[ const]) 215700ef4eceSAndy Whitcroft if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { 215865863862SAndy Whitcroft my ($from, $to) = ($1, $1); 2159d8aaf121SAndy Whitcroft 216065863862SAndy Whitcroft # Should start with a space. 216165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 216265863862SAndy Whitcroft # Should not end with a space. 216365863862SAndy Whitcroft $to =~ s/\s+$//; 216465863862SAndy Whitcroft # '*'s should not have spaces between. 2165f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 216665863862SAndy Whitcroft } 2167d8aaf121SAndy Whitcroft 216865863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 216965863862SAndy Whitcroft if ($from ne $to) { 2170000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2171000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 217265863862SAndy Whitcroft } 217300ef4eceSAndy Whitcroft } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { 217465863862SAndy Whitcroft my ($from, $to, $ident) = ($1, $1, $2); 2175d8aaf121SAndy Whitcroft 217665863862SAndy Whitcroft # Should start with a space. 217765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 217865863862SAndy Whitcroft # Should not end with a space. 217965863862SAndy Whitcroft $to =~ s/\s+$//; 218065863862SAndy Whitcroft # '*'s should not have spaces between. 2181f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 218265863862SAndy Whitcroft } 218365863862SAndy Whitcroft # Modifiers should have spaces. 218465863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 218565863862SAndy Whitcroft 2186667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2187667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2188000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2189000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 219065863862SAndy Whitcroft } 21910a920b5bSAndy Whitcroft } 21920a920b5bSAndy Whitcroft 21930a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 21940a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 21950a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 21960a920b5bSAndy Whitcroft# print "$herecurr"; 21970a920b5bSAndy Whitcroft# $clean = 0; 21980a920b5bSAndy Whitcroft# } 21990a920b5bSAndy Whitcroft 22008905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2201000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2202000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 22038905a67cSAndy Whitcroft } 22048905a67cSAndy Whitcroft 220517441227SJoe Perches# check for uses of printk_ratelimit 220617441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2207000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2208000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 220917441227SJoe Perches } 221017441227SJoe Perches 221100df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 221200df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 221300df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 221425985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 221500df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2216f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 221700df344fSAndy Whitcroft my $ok = 0; 221800df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 221900df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 222025985edcSLucas De Marchi # we have a preceding printk if it ends 222100df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 222200df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 222300df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 222400df344fSAndy Whitcroft $ok = 1; 222500df344fSAndy Whitcroft } 222600df344fSAndy Whitcroft last; 222700df344fSAndy Whitcroft } 222800df344fSAndy Whitcroft } 222900df344fSAndy Whitcroft if ($ok == 0) { 2230000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2231000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 22320a920b5bSAndy Whitcroft } 223300df344fSAndy Whitcroft } 22340a920b5bSAndy Whitcroft 2235653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2236653d4876SAndy Whitcroft# or if closed on same line 2237c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2238c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2239000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2240000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 22410a920b5bSAndy Whitcroft } 2242653d4876SAndy Whitcroft 22438905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 22448905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 22458905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2246000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2247000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 22488905a67cSAndy Whitcroft } 22498905a67cSAndy Whitcroft 22500c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 22510c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2252000d1cc1SJoe Perches WARN("SPACING", 2253000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 22540c73b4ebSAndy Whitcroft } 22550c73b4ebSAndy Whitcroft 22568d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 22578d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2258fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2259fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 22608d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 22618d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 22628d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2263fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2264fe2a7dbcSAndy Whitcroft $prefix !~ /{\s+$/) { 2265000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2266000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 22678d31cfceSAndy Whitcroft } 22688d31cfceSAndy Whitcroft } 22698d31cfceSAndy Whitcroft 2270f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 22716c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2272c2fdda0dSAndy Whitcroft my $name = $1; 2273773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2274773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2275c2fdda0dSAndy Whitcroft 2276c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2277773647a0SAndy Whitcroft if ($name =~ /^(?: 2278773647a0SAndy Whitcroft if|for|while|switch|return|case| 2279773647a0SAndy Whitcroft volatile|__volatile__| 2280773647a0SAndy Whitcroft __attribute__|format|__extension__| 2281773647a0SAndy Whitcroft asm|__asm__)$/x) 2282773647a0SAndy Whitcroft { 2283c2fdda0dSAndy Whitcroft 2284c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2285c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2286c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2287c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2288773647a0SAndy Whitcroft 2289773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2290c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2291c2fdda0dSAndy Whitcroft 2292c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2293c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2294773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2295c2fdda0dSAndy Whitcroft 2296c2fdda0dSAndy Whitcroft } else { 2297000d1cc1SJoe Perches WARN("SPACING", 2298000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2299f0a594c1SAndy Whitcroft } 23006c72ffaaSAndy Whitcroft } 2301653d4876SAndy Whitcroft# Check operator spacing. 23020a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 23039c0ca6f9SAndy Whitcroft my $ops = qr{ 23049c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 23059c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 23069c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 23071f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 23081f65f947SAndy Whitcroft \?|: 23099c0ca6f9SAndy Whitcroft }x; 2310cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 231100df344fSAndy Whitcroft my $off = 0; 23126c72ffaaSAndy Whitcroft 23136c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 23146c72ffaaSAndy Whitcroft 23150a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 23164a0df2efSAndy Whitcroft $off += length($elements[$n]); 23174a0df2efSAndy Whitcroft 231825985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2319773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2320773647a0SAndy Whitcroft my $cc = ''; 2321773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2322773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2323773647a0SAndy Whitcroft } 2324773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2325773647a0SAndy Whitcroft 23264a0df2efSAndy Whitcroft my $a = ''; 23274a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 23284a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2329cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 23304a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 23314a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2332773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 23334a0df2efSAndy Whitcroft 23340a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 23354a0df2efSAndy Whitcroft 23364a0df2efSAndy Whitcroft my $c = ''; 23370a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 23384a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 23394a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2340cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 23414a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 23424a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 23438b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 23444a0df2efSAndy Whitcroft } else { 23454a0df2efSAndy Whitcroft $c = 'E'; 23460a920b5bSAndy Whitcroft } 23470a920b5bSAndy Whitcroft 23484a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 23494a0df2efSAndy Whitcroft 23504a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 23514a0df2efSAndy Whitcroft 23526c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2353de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 23540a920b5bSAndy Whitcroft 235574048ed8SAndy Whitcroft # Pull out the value of this operator. 23566c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 23570a920b5bSAndy Whitcroft 23581f65f947SAndy Whitcroft # Get the full operator variant. 23591f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 23601f65f947SAndy Whitcroft 236113214adfSAndy Whitcroft # Ignore operators passed as parameters. 236213214adfSAndy Whitcroft if ($op_type ne 'V' && 236313214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 236413214adfSAndy Whitcroft 2365cf655043SAndy Whitcroft# # Ignore comments 2366cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 236713214adfSAndy Whitcroft 2368d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 236913214adfSAndy Whitcroft } elsif ($op eq ';') { 2370cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2371cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2372000d1cc1SJoe Perches ERROR("SPACING", 2373000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2374d8aaf121SAndy Whitcroft } 2375d8aaf121SAndy Whitcroft 2376d8aaf121SAndy Whitcroft # // is a comment 2377d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 23780a920b5bSAndy Whitcroft 23791f65f947SAndy Whitcroft # No spaces for: 23801f65f947SAndy Whitcroft # -> 23811f65f947SAndy Whitcroft # : when part of a bitfield 23821f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 23834a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2384000d1cc1SJoe Perches ERROR("SPACING", 2385000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 23860a920b5bSAndy Whitcroft } 23870a920b5bSAndy Whitcroft 23880a920b5bSAndy Whitcroft # , must have a space on the right. 23890a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2390cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2391000d1cc1SJoe Perches ERROR("SPACING", 2392000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 23930a920b5bSAndy Whitcroft } 23940a920b5bSAndy Whitcroft 23959c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 239674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 23979c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 23989c0ca6f9SAndy Whitcroft 23999c0ca6f9SAndy Whitcroft # unary operators should have a space before and 24009c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 24019c0ca6f9SAndy Whitcroft # unary operator, or a cast 24029c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 240374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 24040d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2405cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2406000d1cc1SJoe Perches ERROR("SPACING", 2407000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 24080a920b5bSAndy Whitcroft } 2409a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2410171ae1a4SAndy Whitcroft # A unary '*' may be const 2411171ae1a4SAndy Whitcroft 2412171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2413000d1cc1SJoe Perches ERROR("SPACING", 2414000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 24150a920b5bSAndy Whitcroft } 24160a920b5bSAndy Whitcroft 24170a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 24180a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2419773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2420000d1cc1SJoe Perches ERROR("SPACING", 2421000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 24220a920b5bSAndy Whitcroft } 2423773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2424773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2425000d1cc1SJoe Perches ERROR("SPACING", 2426000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2427653d4876SAndy Whitcroft } 2428773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2429000d1cc1SJoe Perches ERROR("SPACING", 2430000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2431773647a0SAndy Whitcroft } 2432773647a0SAndy Whitcroft 24330a920b5bSAndy Whitcroft 24340a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 24359c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 24369c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 24379c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2438c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2439c2fdda0dSAndy Whitcroft $op eq '%') 24400a920b5bSAndy Whitcroft { 2441773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2442000d1cc1SJoe Perches ERROR("SPACING", 2443000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2444de7d4f0eSAndy Whitcroft $hereptr); 24450a920b5bSAndy Whitcroft } 24460a920b5bSAndy Whitcroft 24471f65f947SAndy Whitcroft # A colon needs no spaces before when it is 24481f65f947SAndy Whitcroft # terminating a case value or a label. 24491f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 24501f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2451000d1cc1SJoe Perches ERROR("SPACING", 2452000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 24531f65f947SAndy Whitcroft } 24541f65f947SAndy Whitcroft 24550a920b5bSAndy Whitcroft # All the others need spaces both sides. 2456cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 24571f65f947SAndy Whitcroft my $ok = 0; 24581f65f947SAndy Whitcroft 245922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 24601f65f947SAndy Whitcroft if (($op eq '<' && 24611f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 24621f65f947SAndy Whitcroft ($op eq '>' && 24631f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 24641f65f947SAndy Whitcroft { 24651f65f947SAndy Whitcroft $ok = 1; 24661f65f947SAndy Whitcroft } 24671f65f947SAndy Whitcroft 24681f65f947SAndy Whitcroft # Ignore ?: 24691f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 24701f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 24711f65f947SAndy Whitcroft $ok = 1; 24721f65f947SAndy Whitcroft } 24731f65f947SAndy Whitcroft 24741f65f947SAndy Whitcroft if ($ok == 0) { 2475000d1cc1SJoe Perches ERROR("SPACING", 2476000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 24770a920b5bSAndy Whitcroft } 247822f2a2efSAndy Whitcroft } 24794a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 24800a920b5bSAndy Whitcroft } 24810a920b5bSAndy Whitcroft } 24820a920b5bSAndy Whitcroft 2483f0a594c1SAndy Whitcroft# check for multiple assignments 2484f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2485000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2486000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2487f0a594c1SAndy Whitcroft } 2488f0a594c1SAndy Whitcroft 248922f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 249022f2a2efSAndy Whitcroft## # continuation. 249122f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 249222f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 249322f2a2efSAndy Whitcroft## 249422f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 249522f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 249622f2a2efSAndy Whitcroft## my $ln = $line; 249722f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 249822f2a2efSAndy Whitcroft## } 249922f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2500000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2501000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 250222f2a2efSAndy Whitcroft## } 250322f2a2efSAndy Whitcroft## } 2504f0a594c1SAndy Whitcroft 25050a920b5bSAndy Whitcroft#need space before brace following if, while, etc 250622f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 250722f2a2efSAndy Whitcroft $line =~ /do{/) { 2508000d1cc1SJoe Perches ERROR("SPACING", 2509000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2510de7d4f0eSAndy Whitcroft } 2511de7d4f0eSAndy Whitcroft 2512de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2513de7d4f0eSAndy Whitcroft# on the line 2514de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2515000d1cc1SJoe Perches ERROR("SPACING", 2516000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 25170a920b5bSAndy Whitcroft } 25180a920b5bSAndy Whitcroft 251922f2a2efSAndy Whitcroft# check spacing on square brackets 252022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2521000d1cc1SJoe Perches ERROR("SPACING", 2522000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 252322f2a2efSAndy Whitcroft } 252422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2525000d1cc1SJoe Perches ERROR("SPACING", 2526000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 252722f2a2efSAndy Whitcroft } 252822f2a2efSAndy Whitcroft 2529c45dcabdSAndy Whitcroft# check spacing on parentheses 25309c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 25319c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2532000d1cc1SJoe Perches ERROR("SPACING", 2533000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 253422f2a2efSAndy Whitcroft } 253513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2536c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2537c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2538000d1cc1SJoe Perches ERROR("SPACING", 2539000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 254022f2a2efSAndy Whitcroft } 254122f2a2efSAndy Whitcroft 25420a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 25434a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 25440a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2545000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2546000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 25470a920b5bSAndy Whitcroft } 25480a920b5bSAndy Whitcroft 2549c45dcabdSAndy Whitcroft# Return is not a function. 2550c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2551c45dcabdSAndy Whitcroft my $spacing = $1; 2552c45dcabdSAndy Whitcroft my $value = $2; 2553c45dcabdSAndy Whitcroft 255486f9d059SAndy Whitcroft # Flatten any parentheses 2555fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2556fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 255763f17f89SAndy Whitcroft while ($value =~ s/\[[^\{\}]*\]/1/ || 255863f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 255963f17f89SAndy Whitcroft $Compare\s* 256063f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 256163f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2562c45dcabdSAndy Whitcroft } 2563fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2564fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2565000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2566000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2567c45dcabdSAndy Whitcroft 2568c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2569000d1cc1SJoe Perches ERROR("SPACING", 2570000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2571c45dcabdSAndy Whitcroft } 2572c45dcabdSAndy Whitcroft } 257353a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 257453a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 257553a3c448SAndy Whitcroft my $name = $1; 257653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2577000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2578000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 257953a3c448SAndy Whitcroft } 258053a3c448SAndy Whitcroft } 2581c45dcabdSAndy Whitcroft 25827d2367afSJoe Perches# typecasts on min/max could be min_t/max_t 25837d2367afSJoe Perches if ($line =~ /^\+(?:.*?)\b(min|max)\s*\($Typecast{0,1}($LvalOrFunc)\s*,\s*$Typecast{0,1}($LvalOrFunc)\s*\)/) { 25847d2367afSJoe Perches if (defined $2 || defined $8) { 25857d2367afSJoe Perches my $call = $1; 25867d2367afSJoe Perches my $cast1 = deparenthesize($2); 25877d2367afSJoe Perches my $arg1 = $3; 25887d2367afSJoe Perches my $cast2 = deparenthesize($8); 25897d2367afSJoe Perches my $arg2 = $9; 25907d2367afSJoe Perches my $cast; 25917d2367afSJoe Perches 25927d2367afSJoe Perches if ($cast1 ne "" && $cast2 ne "") { 25937d2367afSJoe Perches $cast = "$cast1 or $cast2"; 25947d2367afSJoe Perches } elsif ($cast1 ne "") { 25957d2367afSJoe Perches $cast = $cast1; 25967d2367afSJoe Perches } else { 25977d2367afSJoe Perches $cast = $cast2; 25987d2367afSJoe Perches } 259930ecad51SHui Zhu WARN("MINMAX", 260030ecad51SHui Zhu "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . $herecurr); 26017d2367afSJoe Perches } 26027d2367afSJoe Perches } 26037d2367afSJoe Perches 26040a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 26054a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2606000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 26070a920b5bSAndy Whitcroft } 26080a920b5bSAndy Whitcroft 2609f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2610f5fe35ddSAndy Whitcroft# statements after the conditional. 2611170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 2612170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2613170d3a22SAndy Whitcroft $remain_next, $off_next); 2614170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2615170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2616170d3a22SAndy Whitcroft 2617170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2618170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2619170d3a22SAndy Whitcroft # then count those as offsets. 2620170d3a22SAndy Whitcroft my ($whitespace) = 2621170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2622170d3a22SAndy Whitcroft my $offset = 2623170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2624170d3a22SAndy Whitcroft 2625170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2626170d3a22SAndy Whitcroft $offset} = 1; 2627170d3a22SAndy Whitcroft } 2628170d3a22SAndy Whitcroft } 2629170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2630170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2631171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 26328905a67cSAndy Whitcroft 2633b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2634000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2635000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 26368905a67cSAndy Whitcroft } 26378905a67cSAndy Whitcroft 26388905a67cSAndy Whitcroft # Find out what is on the end of the line after the 26398905a67cSAndy Whitcroft # conditional. 2640773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 26418905a67cSAndy Whitcroft $s =~ s/\n.*//g; 264213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 264353210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 264453210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2645773647a0SAndy Whitcroft { 2646bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2647bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2648bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 264942bdf74cSHidetoshi Seto my $stat_real = ''; 2650bb44ad39SAndy Whitcroft 265142bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 265242bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2653bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2654bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2655bb44ad39SAndy Whitcroft } 2656bb44ad39SAndy Whitcroft 2657000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2658000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 26598905a67cSAndy Whitcroft } 26608905a67cSAndy Whitcroft } 26618905a67cSAndy Whitcroft 266213214adfSAndy Whitcroft# Check for bitwise tests written as boolean 266313214adfSAndy Whitcroft if ($line =~ / 266413214adfSAndy Whitcroft (?: 266513214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 266613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 266713214adfSAndy Whitcroft (?:\&\&|\|\|) 266813214adfSAndy Whitcroft | 266913214adfSAndy Whitcroft (?:\&\&|\|\|) 267013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 267113214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 267213214adfSAndy Whitcroft )/x) 267313214adfSAndy Whitcroft { 2674000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2675000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 267613214adfSAndy Whitcroft } 267713214adfSAndy Whitcroft 26788905a67cSAndy Whitcroft# if and else should not have general statements after it 267913214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 268013214adfSAndy Whitcroft my $s = $1; 268113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 268213214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2683000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2684000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 26850a920b5bSAndy Whitcroft } 268613214adfSAndy Whitcroft } 268739667782SAndy Whitcroft# if should not continue a brace 268839667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2689000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2690000d1cc1SJoe Perches "trailing statements should be on next line\n" . 269139667782SAndy Whitcroft $herecurr); 269239667782SAndy Whitcroft } 2693a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2694a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2695a1080bf8SAndy Whitcroft $line !~ /\G(?: 26963fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2697a1080bf8SAndy Whitcroft \s*return\s+ 2698a1080bf8SAndy Whitcroft )/xg) 2699a1080bf8SAndy Whitcroft { 2700000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2701000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2702a1080bf8SAndy Whitcroft } 27030a920b5bSAndy Whitcroft 27040a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 27050a920b5bSAndy Whitcroft # indent level to be relevant to each other. 27060a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 27070a920b5bSAndy Whitcroft $previndent == $indent) { 2708000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2709000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 27100a920b5bSAndy Whitcroft } 27110a920b5bSAndy Whitcroft 2712c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2713c2fdda0dSAndy Whitcroft $previndent == $indent) { 2714c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2715c2fdda0dSAndy Whitcroft 2716c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2717c2fdda0dSAndy Whitcroft # conditional. 2718773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2719c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2720c2fdda0dSAndy Whitcroft 2721c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2722000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2723000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2724c2fdda0dSAndy Whitcroft } 2725c2fdda0dSAndy Whitcroft } 2726c2fdda0dSAndy Whitcroft 27270a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 27280a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 27290a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 27300a920b5bSAndy Whitcroft# print "$herecurr"; 27310a920b5bSAndy Whitcroft# $clean = 0; 27320a920b5bSAndy Whitcroft# } 27330a920b5bSAndy Whitcroft 27340a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2735c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2736000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2737000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 27380a920b5bSAndy Whitcroft } 27390a920b5bSAndy Whitcroft 2740653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2741c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2742e09dec48SAndy Whitcroft my $file = "$1.h"; 2743e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2744e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2745e09dec48SAndy Whitcroft $realfile ne $checkfile && 27467840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2747c45dcabdSAndy Whitcroft { 2748e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2749000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2750000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2751e09dec48SAndy Whitcroft } else { 2752000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2753000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2754e09dec48SAndy Whitcroft } 27550a920b5bSAndy Whitcroft } 27560a920b5bSAndy Whitcroft } 27570a920b5bSAndy Whitcroft 2758653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2759653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2760cf655043SAndy Whitcroft# in a known good container 2761b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2762b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2763d8aaf121SAndy Whitcroft my $ln = $linenr; 2764d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2765c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2766c45dcabdSAndy Whitcroft my $ctx = ''; 2767653d4876SAndy Whitcroft 2768c45dcabdSAndy Whitcroft my $args = defined($1); 2769de7d4f0eSAndy Whitcroft 2770c45dcabdSAndy Whitcroft # Find the end of the macro and limit our statement 2771c45dcabdSAndy Whitcroft # search to that. 2772c45dcabdSAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1] && 2773c45dcabdSAndy Whitcroft $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2774c45dcabdSAndy Whitcroft { 2775c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1] . "\n"; 2776a3bb97a7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 2777c45dcabdSAndy Whitcroft $ln++; 2778de7d4f0eSAndy Whitcroft } 2779c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1]; 2780d8aaf121SAndy Whitcroft 2781c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2782c45dcabdSAndy Whitcroft ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2783c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2784a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2785c45dcabdSAndy Whitcroft 2786c45dcabdSAndy Whitcroft # Extract the remainder of the define (if any) and 2787c45dcabdSAndy Whitcroft # rip off surrounding spaces, and trailing \'s. 2788c45dcabdSAndy Whitcroft $rest = ''; 2789636d140aSAndy Whitcroft while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2790636d140aSAndy Whitcroft #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2791a3bb97a7SAndy Whitcroft if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2792c45dcabdSAndy Whitcroft $rest .= substr($lines[$ln - 1], $off) . "\n"; 2793c45dcabdSAndy Whitcroft $cnt--; 2794a3bb97a7SAndy Whitcroft } 2795a3bb97a7SAndy Whitcroft $ln++; 2796c45dcabdSAndy Whitcroft $off = 0; 2797c45dcabdSAndy Whitcroft } 2798c45dcabdSAndy Whitcroft $rest =~ s/\\\n.//g; 2799c45dcabdSAndy Whitcroft $rest =~ s/^\s*//s; 2800c45dcabdSAndy Whitcroft $rest =~ s/\s*$//s; 2801c45dcabdSAndy Whitcroft 2802c45dcabdSAndy Whitcroft # Clean up the original statement. 2803c45dcabdSAndy Whitcroft if ($args) { 2804c45dcabdSAndy Whitcroft substr($dstat, 0, length($dcond), ''); 2805d8aaf121SAndy Whitcroft } else { 2806c45dcabdSAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2807c45dcabdSAndy Whitcroft } 2808292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2809c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2810c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2811c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2812c45dcabdSAndy Whitcroft 2813c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2814bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2815bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2816bf30d6edSAndy Whitcroft $dstat =~ s/\[[^\{\}]*\]/1/) 2817bf30d6edSAndy Whitcroft { 2818c45dcabdSAndy Whitcroft } 2819c45dcabdSAndy Whitcroft 2820c45dcabdSAndy Whitcroft my $exceptions = qr{ 2821c45dcabdSAndy Whitcroft $Declare| 2822c45dcabdSAndy Whitcroft module_param_named| 2823c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2824c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2825c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2826383099fdSAndy Whitcroft __typeof__\(| 282722fd2d3eSStefani Seibold union| 282822fd2d3eSStefani Seibold struct| 2829ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2830ea71a0a0SAndy Whitcroft ^\"|\"$ 2831c45dcabdSAndy Whitcroft }x; 28325eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 28335eaa20b9SAndy Whitcroft if ($rest ne '' && $rest ne ',') { 2834c45dcabdSAndy Whitcroft if ($rest !~ /while\s*\(/ && 2835c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/) 2836c45dcabdSAndy Whitcroft { 2837000d1cc1SJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 2838000d1cc1SJoe Perches "Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2839c45dcabdSAndy Whitcroft } 2840c45dcabdSAndy Whitcroft 2841c45dcabdSAndy Whitcroft } elsif ($ctx !~ /;/) { 2842c45dcabdSAndy Whitcroft if ($dstat ne '' && 2843c45dcabdSAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2844c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/ && 2845b132e5d5SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && 2846c45dcabdSAndy Whitcroft $dstat =~ /$Operators/) 2847c45dcabdSAndy Whitcroft { 2848000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 2849000d1cc1SJoe Perches "Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2850d8aaf121SAndy Whitcroft } 28510a920b5bSAndy Whitcroft } 2852653d4876SAndy Whitcroft } 28530a920b5bSAndy Whitcroft 2854080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 2855080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 2856080ba929SMike Frysinger# . 2857080ba929SMike Frysinger# ALIGN(...) 2858080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 2859080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 2860000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 2861000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 2862080ba929SMike Frysinger } 2863080ba929SMike Frysinger 2864f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 286513214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 286613214adfSAndy Whitcroft my ($level, $endln, @chunks) = 2867cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 286813214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2869cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 2870cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 287113214adfSAndy Whitcroft my $allowed = 0; 287213214adfSAndy Whitcroft my $seen = 0; 2873773647a0SAndy Whitcroft my $herectx = $here . "\n"; 2874cf655043SAndy Whitcroft my $ln = $linenr - 1; 287513214adfSAndy Whitcroft for my $chunk (@chunks) { 287613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 287713214adfSAndy Whitcroft 2878773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 2879773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2880773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 2881773647a0SAndy Whitcroft 2882773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2883773647a0SAndy Whitcroft 2884773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 2885773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 2886773647a0SAndy Whitcroft 2887773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2888cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 2889cf655043SAndy Whitcroft 2890773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 289113214adfSAndy Whitcroft 289213214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 289313214adfSAndy Whitcroft 2894cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 2895cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2896cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 289713214adfSAndy Whitcroft $allowed = 1; 289813214adfSAndy Whitcroft } 289913214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2900cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 290113214adfSAndy Whitcroft $allowed = 1; 290213214adfSAndy Whitcroft } 2903cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2904cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 290513214adfSAndy Whitcroft $allowed = 1; 290613214adfSAndy Whitcroft } 290713214adfSAndy Whitcroft } 290813214adfSAndy Whitcroft if ($seen && !$allowed) { 2909000d1cc1SJoe Perches WARN("BRACES", 2910000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 291113214adfSAndy Whitcroft } 291213214adfSAndy Whitcroft } 291313214adfSAndy Whitcroft } 2914773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 291513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 2916cf655043SAndy Whitcroft my $allowed = 0; 2917f0a594c1SAndy Whitcroft 2918cf655043SAndy Whitcroft # Check the pre-context. 2919cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2920cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 2921cf655043SAndy Whitcroft $allowed = 1; 2922f0a594c1SAndy Whitcroft } 2923773647a0SAndy Whitcroft 2924773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 2925773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 2926773647a0SAndy Whitcroft 2927cf655043SAndy Whitcroft # Check the condition. 2928cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 2929773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 2930cf655043SAndy Whitcroft if (defined $cond) { 2931773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2932cf655043SAndy Whitcroft } 2933cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2934cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 2935cf655043SAndy Whitcroft $allowed = 1; 2936cf655043SAndy Whitcroft } 2937cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2938cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 2939cf655043SAndy Whitcroft $allowed = 1; 2940cf655043SAndy Whitcroft } 2941cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2942cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 2943cf655043SAndy Whitcroft $allowed = 1; 2944cf655043SAndy Whitcroft } 2945cf655043SAndy Whitcroft # Check the post-context. 2946cf655043SAndy Whitcroft if (defined $chunks[1]) { 2947cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 2948cf655043SAndy Whitcroft if (defined $cond) { 2949773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2950cf655043SAndy Whitcroft } 2951cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 2952cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 2953cf655043SAndy Whitcroft $allowed = 1; 2954cf655043SAndy Whitcroft } 2955cf655043SAndy Whitcroft } 2956cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 295769932487SJustin P. Mattock my $herectx = $here . "\n"; 2958f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 2959cf655043SAndy Whitcroft 2960f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 296169932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 2962cf655043SAndy Whitcroft } 2963cf655043SAndy Whitcroft 2964000d1cc1SJoe Perches WARN("BRACES", 2965000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 2966f0a594c1SAndy Whitcroft } 2967f0a594c1SAndy Whitcroft } 2968f0a594c1SAndy Whitcroft 2969653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 29704a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 2971c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 2972000d1cc1SJoe Perches ERROR("DEPRECATED_INCLUDE", 2973000d1cc1SJoe Perches "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 29740a920b5bSAndy Whitcroft } 29750a920b5bSAndy Whitcroft } 29760a920b5bSAndy Whitcroft 29774a0df2efSAndy Whitcroft# don't use deprecated functions 29784a0df2efSAndy Whitcroft for my $func (@dep_functions) { 297900df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 2980000d1cc1SJoe Perches ERROR("DEPRECATED_FUNCTION", 2981000d1cc1SJoe Perches "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 29824a0df2efSAndy Whitcroft } 29834a0df2efSAndy Whitcroft } 29844a0df2efSAndy Whitcroft 29854a0df2efSAndy Whitcroft# no volatiles please 29866c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 29876c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 2988000d1cc1SJoe Perches WARN("VOLATILE", 2989000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 29904a0df2efSAndy Whitcroft } 29914a0df2efSAndy Whitcroft 299200df344fSAndy Whitcroft# warn about #if 0 2993c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2994000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 2995000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 2996de7d4f0eSAndy Whitcroft $herecurr); 29974a0df2efSAndy Whitcroft } 29984a0df2efSAndy Whitcroft 2999f0a594c1SAndy Whitcroft# check for needless kfree() checks 3000f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3001f0a594c1SAndy Whitcroft my $expr = $1; 3002f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 3003000d1cc1SJoe Perches WARN("NEEDLESS_KFREE", 3004000d1cc1SJoe Perches "kfree(NULL) is safe this check is probably not required\n" . $hereprev); 3005f0a594c1SAndy Whitcroft } 3006f0a594c1SAndy Whitcroft } 30074c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 30084c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 30094c432a8fSGreg Kroah-Hartman my $expr = $1; 30104c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 3011000d1cc1SJoe Perches WARN("NEEDLESS_USB_FREE_URB", 3012000d1cc1SJoe Perches "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 30134c432a8fSGreg Kroah-Hartman } 30144c432a8fSGreg Kroah-Hartman } 3015f0a594c1SAndy Whitcroft 30161a15a250SPatrick Pannuto# prefer usleep_range over udelay 30171a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 30181a15a250SPatrick Pannuto # ignore udelay's < 10, however 30191a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3020000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3021000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 30221a15a250SPatrick Pannuto } 30231a15a250SPatrick Pannuto } 30241a15a250SPatrick Pannuto 302509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 302609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 302709ef8725SPatrick Pannuto if ($1 < 20) { 3028000d1cc1SJoe Perches WARN("MSLEEP", 3029000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 303009ef8725SPatrick Pannuto } 303109ef8725SPatrick Pannuto } 303209ef8725SPatrick Pannuto 303300df344fSAndy Whitcroft# warn about #ifdefs in C files 3034c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 303500df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 303600df344fSAndy Whitcroft# print "$herecurr"; 303700df344fSAndy Whitcroft# $clean = 0; 303800df344fSAndy Whitcroft# } 303900df344fSAndy Whitcroft 304022f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3041c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3042000d1cc1SJoe Perches ERROR("SPACING", 3043000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 304422f2a2efSAndy Whitcroft } 304522f2a2efSAndy Whitcroft 30464a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3047171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3048171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 30494a0df2efSAndy Whitcroft my $which = $1; 30504a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3051000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3052000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 30534a0df2efSAndy Whitcroft } 30544a0df2efSAndy Whitcroft } 30554a0df2efSAndy Whitcroft# check for memory barriers without a comment. 30564a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 30574a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3058000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3059000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 30604a0df2efSAndy Whitcroft } 30614a0df2efSAndy Whitcroft } 30624a0df2efSAndy Whitcroft# check of hardware specific defines 3063c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3064000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3065000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 30660a920b5bSAndy Whitcroft } 3067653d4876SAndy Whitcroft 3068d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3069d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3070000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3071000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3072d4977c78STobias Klauser } 3073d4977c78STobias Klauser 3074de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3075de7d4f0eSAndy Whitcroft# storage class and type. 30769c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 30779c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3078000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3079000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3080de7d4f0eSAndy Whitcroft } 3081de7d4f0eSAndy Whitcroft 30828905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 30838905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3084000d1cc1SJoe Perches WARN("INLINE", 3085000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 30868905a67cSAndy Whitcroft } 30878905a67cSAndy Whitcroft 30883d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 30893d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3090000d1cc1SJoe Perches WARN("PREFER_PACKED", 3091000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 30923d130fd0SJoe Perches } 30933d130fd0SJoe Perches 309439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 309539b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3096000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3097000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 309839b7e287SJoe Perches } 309939b7e287SJoe Perches 31008f53a9b8SJoe Perches# check for sizeof(&) 31018f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3102000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3103000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 31048f53a9b8SJoe Perches } 31058f53a9b8SJoe Perches 3106428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3107428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3108000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3109000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3110428e2fdcSJoe Perches } 3111428e2fdcSJoe Perches 3112de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3113171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3114c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3115171ae1a4SAndy Whitcroft { 3116c45dcabdSAndy Whitcroft my $function_name = $1; 3117c45dcabdSAndy Whitcroft my $paren_space = $2; 3118171ae1a4SAndy Whitcroft 3119171ae1a4SAndy Whitcroft my $s = $stat; 3120171ae1a4SAndy Whitcroft if (defined $cond) { 3121171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3122171ae1a4SAndy Whitcroft } 3123c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3124c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3125c45dcabdSAndy Whitcroft { 3126000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3127000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3128de7d4f0eSAndy Whitcroft } 3129de7d4f0eSAndy Whitcroft 3130171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3131000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3132000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3133171ae1a4SAndy Whitcroft } 31349c9ba34eSAndy Whitcroft 31359c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 31369c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 31379c9ba34eSAndy Whitcroft { 3138000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3139000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3140171ae1a4SAndy Whitcroft } 3141171ae1a4SAndy Whitcroft 3142de7d4f0eSAndy Whitcroft# checks for new __setup's 3143de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3144de7d4f0eSAndy Whitcroft my $name = $1; 3145de7d4f0eSAndy Whitcroft 3146de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3147000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3148000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3149de7d4f0eSAndy Whitcroft } 3150653d4876SAndy Whitcroft } 31519c0ca6f9SAndy Whitcroft 31529c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3153caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3154000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3155000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 31569c0ca6f9SAndy Whitcroft } 315713214adfSAndy Whitcroft 3158caf2a54fSJoe Perches# check for multiple semicolons 3159caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3160000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3161000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3162caf2a54fSJoe Perches } 3163caf2a54fSJoe Perches 316413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 316513214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3166000d1cc1SJoe Perches WARN("USE_FUNC", 3167000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 316813214adfSAndy Whitcroft } 3169773647a0SAndy Whitcroft 31704882720bSThomas Gleixner# check for semaphores initialized locked 31714882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3172000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3173000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 31741704f47bSPeter Zijlstra 3175773647a0SAndy Whitcroft } 317667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 317767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3178000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 317967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3180773647a0SAndy Whitcroft } 3181f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3182f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3183000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3184000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3185f3db6639SMichael Ellerman } 318679404849SEmese Revfy# check for various ops structs, ensure they are const. 318779404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 318879404849SEmese Revfy address_space_operations| 318979404849SEmese Revfy backlight_ops| 319079404849SEmese Revfy block_device_operations| 319179404849SEmese Revfy dentry_operations| 319279404849SEmese Revfy dev_pm_ops| 319379404849SEmese Revfy dma_map_ops| 319479404849SEmese Revfy extent_io_ops| 319579404849SEmese Revfy file_lock_operations| 319679404849SEmese Revfy file_operations| 319779404849SEmese Revfy hv_ops| 319879404849SEmese Revfy ide_dma_ops| 319979404849SEmese Revfy intel_dvo_dev_ops| 320079404849SEmese Revfy item_operations| 320179404849SEmese Revfy iwl_ops| 320279404849SEmese Revfy kgdb_arch| 320379404849SEmese Revfy kgdb_io| 320479404849SEmese Revfy kset_uevent_ops| 320579404849SEmese Revfy lock_manager_operations| 320679404849SEmese Revfy microcode_ops| 320779404849SEmese Revfy mtrr_ops| 320879404849SEmese Revfy neigh_ops| 320979404849SEmese Revfy nlmsvc_binding| 321079404849SEmese Revfy pci_raw_ops| 321179404849SEmese Revfy pipe_buf_operations| 321279404849SEmese Revfy platform_hibernation_ops| 321379404849SEmese Revfy platform_suspend_ops| 321479404849SEmese Revfy proto_ops| 321579404849SEmese Revfy rpc_pipe_ops| 321679404849SEmese Revfy seq_operations| 321779404849SEmese Revfy snd_ac97_build_ops| 321879404849SEmese Revfy soc_pcmcia_socket_ops| 321979404849SEmese Revfy stacktrace_ops| 322079404849SEmese Revfy sysfs_ops| 322179404849SEmese Revfy tty_operations| 322279404849SEmese Revfy usb_mon_operations| 322379404849SEmese Revfy wd_ops}x; 32246903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 322579404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3226000d1cc1SJoe Perches WARN("CONST_STRUCT", 3227000d1cc1SJoe Perches "struct $1 should normally be const\n" . 32286903ffb2SAndy Whitcroft $herecurr); 32292b6db5cbSAndy Whitcroft } 3230773647a0SAndy Whitcroft 3231773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3232773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3233773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3234c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3235c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3236171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3237171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3238171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3239773647a0SAndy Whitcroft { 3240000d1cc1SJoe Perches WARN("NR_CPUS", 3241000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3242773647a0SAndy Whitcroft } 32439c9ba34eSAndy Whitcroft 32449c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 32459c9ba34eSAndy Whitcroft my $string; 32469c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 32479c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 32482a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 32499c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3250000d1cc1SJoe Perches WARN("PRINTF_L", 3251000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 32529c9ba34eSAndy Whitcroft last; 32539c9ba34eSAndy Whitcroft } 32549c9ba34eSAndy Whitcroft } 3255691d77b6SAndy Whitcroft 3256691d77b6SAndy Whitcroft# whine mightly about in_atomic 3257691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3258691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3259000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3260000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3261f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3262000d1cc1SJoe Perches WARN("IN_ATOMIC", 3263000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3264691d77b6SAndy Whitcroft } 3265691d77b6SAndy Whitcroft } 32661704f47bSPeter Zijlstra 32671704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 32681704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 32691704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 32701704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 32711704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 32721704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3273000d1cc1SJoe Perches ERROR("LOCKDEP", 3274000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 32751704f47bSPeter Zijlstra } 32761704f47bSPeter Zijlstra } 327788f8831cSDave Jones 327888f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 327988f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3280000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3281000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 328288f8831cSDave Jones } 3283309c00c7SDave Jones 3284309c00c7SDave Jones # Check for memset with swapped arguments 3285309c00c7SDave Jones if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) { 3286000d1cc1SJoe Perches ERROR("MEMSET", 3287000d1cc1SJoe Perches "memset size is 3rd argument, not the second.\n" . $herecurr); 3288309c00c7SDave Jones } 328913214adfSAndy Whitcroft } 329013214adfSAndy Whitcroft 329113214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 329213214adfSAndy Whitcroft # so just keep quiet. 329313214adfSAndy Whitcroft if ($#rawlines == -1) { 329413214adfSAndy Whitcroft exit(0); 32950a920b5bSAndy Whitcroft } 32960a920b5bSAndy Whitcroft 32978905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 32988905a67cSAndy Whitcroft # things that appear to be patches. 32998905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 33008905a67cSAndy Whitcroft exit(0); 33018905a67cSAndy Whitcroft } 33028905a67cSAndy Whitcroft 33038905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 33048905a67cSAndy Whitcroft # just keep quiet. 33058905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 33068905a67cSAndy Whitcroft exit(0); 33078905a67cSAndy Whitcroft } 33088905a67cSAndy Whitcroft 33098905a67cSAndy Whitcroft if (!$is_patch) { 3310000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3311000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 33120a920b5bSAndy Whitcroft } 33130a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3314000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3315000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 33160a920b5bSAndy Whitcroft } 33170a920b5bSAndy Whitcroft 3318f0a594c1SAndy Whitcroft print report_dump(); 331913214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 332013214adfSAndy Whitcroft print "$filename " if ($summary_file); 33216c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 33226c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 33236c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 33248905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 33256c72ffaaSAndy Whitcroft } 33268905a67cSAndy Whitcroft 3327d2c0a235SAndy Whitcroft if ($quiet == 0) { 3328d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3329d2c0a235SAndy Whitcroft # then suggest that. 3330d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3331d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3332d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3333b0781216SMike Frysinger $rpt_cleaners = 0; 3334d2c0a235SAndy Whitcroft } 3335d2c0a235SAndy Whitcroft } 3336d2c0a235SAndy Whitcroft 3337000d1cc1SJoe Perches if (keys %ignore_type) { 3338000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3339000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3340000d1cc1SJoe Perches print " $ignore"; 3341000d1cc1SJoe Perches } 3342000d1cc1SJoe Perches print "\n"; 3343000d1cc1SJoe Perches print "\n" if ($quiet == 0); 3344000d1cc1SJoe Perches } 3345000d1cc1SJoe Perches 33460a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3347c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 33480a920b5bSAndy Whitcroft } 33490a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3350000d1cc1SJoe Perches print << "EOM"; 3351000d1cc1SJoe Perches$vname has style problems, please review. 3352000d1cc1SJoe Perches 3353000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3354000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3355000d1cc1SJoe PerchesEOM 33560a920b5bSAndy Whitcroft } 335713214adfSAndy Whitcroft 33580a920b5bSAndy Whitcroft return $clean; 33590a920b5bSAndy Whitcroft} 3360