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 230d7c76ba7SJoe Perchesour $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-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 24315662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 24415662b3eSJoe 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 25315662b3eSJoe Perchesour $UTF8 = qr{ 25415662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 25515662b3eSJoe Perches | $NON_ASCII_UTF8 25615662b3eSJoe Perches}x; 25715662b3eSJoe 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 (?: 3186b48db24SAndy Whitcroft (?:typeof|__typeof__)\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 326b337d8b8SAndy 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 Perches 3347d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 335d1fe9c09SJoe Perches 336d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 337d1fe9c09SJoe Perches# requires at least perl version v5.10.0 338d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 339d1fe9c09SJoe Perches 340d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 341d1fe9c09SJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; 342d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 3437d2367afSJoe Perches 3447d2367afSJoe Perchessub deparenthesize { 3457d2367afSJoe Perches my ($string) = @_; 3467d2367afSJoe Perches return "" if (!defined($string)); 3477d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 3487d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 3497d2367afSJoe Perches $string =~ s@\s+@ @g; 3507d2367afSJoe Perches return $string; 3517d2367afSJoe Perches} 3527d2367afSJoe Perches 3536c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 3540a920b5bSAndy Whitcroft 3554a0df2efSAndy Whitcroftmy @dep_includes = (); 3564a0df2efSAndy Whitcroftmy @dep_functions = (); 3576c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 3586c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 35921caa13cSAndy Whitcroft open(my $REMOVE, '<', "$root/$removal") || 3606c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 36121caa13cSAndy Whitcroft while (<$REMOVE>) { 362f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 363f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 364f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 3654a0df2efSAndy Whitcroft push(@dep_includes, $1); 3664a0df2efSAndy Whitcroft 367f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 368f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 369f0a594c1SAndy Whitcroft } 3704a0df2efSAndy Whitcroft } 3710a920b5bSAndy Whitcroft } 3720a920b5bSAndy Whitcroft } 37321caa13cSAndy Whitcroft close($REMOVE); 3740a920b5bSAndy Whitcroft} 3750a920b5bSAndy Whitcroft 37600df344fSAndy Whitcroftmy @rawlines = (); 377c2fdda0dSAndy Whitcroftmy @lines = (); 378c2fdda0dSAndy Whitcroftmy $vname; 3796c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 38021caa13cSAndy Whitcroft my $FILE; 3816c72ffaaSAndy Whitcroft if ($file) { 38221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 3836c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 38421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 38521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 3866c72ffaaSAndy Whitcroft } else { 38721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 3886c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 3896c72ffaaSAndy Whitcroft } 390c2fdda0dSAndy Whitcroft if ($filename eq '-') { 391c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 392c2fdda0dSAndy Whitcroft } else { 393c2fdda0dSAndy Whitcroft $vname = $filename; 394c2fdda0dSAndy Whitcroft } 39521caa13cSAndy Whitcroft while (<$FILE>) { 3960a920b5bSAndy Whitcroft chomp; 39700df344fSAndy Whitcroft push(@rawlines, $_); 3986c72ffaaSAndy Whitcroft } 39921caa13cSAndy Whitcroft close($FILE); 400c2fdda0dSAndy Whitcroft if (!process($filename)) { 4010a920b5bSAndy Whitcroft $exit = 1; 4020a920b5bSAndy Whitcroft } 40300df344fSAndy Whitcroft @rawlines = (); 40413214adfSAndy Whitcroft @lines = (); 4050a920b5bSAndy Whitcroft} 4060a920b5bSAndy Whitcroft 4070a920b5bSAndy Whitcroftexit($exit); 4080a920b5bSAndy Whitcroft 4090a920b5bSAndy Whitcroftsub top_of_kernel_tree { 4106c72ffaaSAndy Whitcroft my ($root) = @_; 4116c72ffaaSAndy Whitcroft 4126c72ffaaSAndy Whitcroft my @tree_check = ( 4136c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 4146c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 4156c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 4166c72ffaaSAndy Whitcroft ); 4176c72ffaaSAndy Whitcroft 4186c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 4196c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 4200a920b5bSAndy Whitcroft return 0; 4210a920b5bSAndy Whitcroft } 4226c72ffaaSAndy Whitcroft } 4236c72ffaaSAndy Whitcroft return 1; 4246c72ffaaSAndy Whitcroft} 4250a920b5bSAndy Whitcroft 42620112475SJoe Perchessub parse_email { 42720112475SJoe Perches my ($formatted_email) = @_; 42820112475SJoe Perches 42920112475SJoe Perches my $name = ""; 43020112475SJoe Perches my $address = ""; 43120112475SJoe Perches my $comment = ""; 43220112475SJoe Perches 43320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 43420112475SJoe Perches $name = $1; 43520112475SJoe Perches $address = $2; 43620112475SJoe Perches $comment = $3 if defined $3; 43720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 43820112475SJoe Perches $address = $1; 43920112475SJoe Perches $comment = $2 if defined $2; 44020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 44120112475SJoe Perches $address = $1; 44220112475SJoe Perches $comment = $2 if defined $2; 44320112475SJoe Perches $formatted_email =~ s/$address.*$//; 44420112475SJoe Perches $name = $formatted_email; 44520112475SJoe Perches $name =~ s/^\s+|\s+$//g; 44620112475SJoe Perches $name =~ s/^\"|\"$//g; 44720112475SJoe Perches # If there's a name left after stripping spaces and 44820112475SJoe Perches # leading quotes, and the address doesn't have both 44920112475SJoe Perches # leading and trailing angle brackets, the address 45020112475SJoe Perches # is invalid. ie: 45120112475SJoe Perches # "joe smith [email protected]" bad 45220112475SJoe Perches # "joe smith <[email protected]" bad 45320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 45420112475SJoe Perches $name = ""; 45520112475SJoe Perches $address = ""; 45620112475SJoe Perches $comment = ""; 45720112475SJoe Perches } 45820112475SJoe Perches } 45920112475SJoe Perches 46020112475SJoe Perches $name =~ s/^\s+|\s+$//g; 46120112475SJoe Perches $name =~ s/^\"|\"$//g; 46220112475SJoe Perches $address =~ s/^\s+|\s+$//g; 46320112475SJoe Perches $address =~ s/^\<|\>$//g; 46420112475SJoe Perches 46520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 46620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 46720112475SJoe Perches $name = "\"$name\""; 46820112475SJoe Perches } 46920112475SJoe Perches 47020112475SJoe Perches return ($name, $address, $comment); 47120112475SJoe Perches} 47220112475SJoe Perches 47320112475SJoe Perchessub format_email { 47420112475SJoe Perches my ($name, $address) = @_; 47520112475SJoe Perches 47620112475SJoe Perches my $formatted_email; 47720112475SJoe Perches 47820112475SJoe Perches $name =~ s/^\s+|\s+$//g; 47920112475SJoe Perches $name =~ s/^\"|\"$//g; 48020112475SJoe Perches $address =~ s/^\s+|\s+$//g; 48120112475SJoe Perches 48220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 48320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 48420112475SJoe Perches $name = "\"$name\""; 48520112475SJoe Perches } 48620112475SJoe Perches 48720112475SJoe Perches if ("$name" eq "") { 48820112475SJoe Perches $formatted_email = "$address"; 48920112475SJoe Perches } else { 49020112475SJoe Perches $formatted_email = "$name <$address>"; 49120112475SJoe Perches } 49220112475SJoe Perches 49320112475SJoe Perches return $formatted_email; 49420112475SJoe Perches} 49520112475SJoe Perches 496000d1cc1SJoe Perchessub which_conf { 497000d1cc1SJoe Perches my ($conf) = @_; 498000d1cc1SJoe Perches 499000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 500000d1cc1SJoe Perches if (-e "$path/$conf") { 501000d1cc1SJoe Perches return "$path/$conf"; 502000d1cc1SJoe Perches } 503000d1cc1SJoe Perches } 504000d1cc1SJoe Perches 505000d1cc1SJoe Perches return ""; 506000d1cc1SJoe Perches} 507000d1cc1SJoe Perches 5080a920b5bSAndy Whitcroftsub expand_tabs { 5090a920b5bSAndy Whitcroft my ($str) = @_; 5100a920b5bSAndy Whitcroft 5110a920b5bSAndy Whitcroft my $res = ''; 5120a920b5bSAndy Whitcroft my $n = 0; 5130a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 5140a920b5bSAndy Whitcroft if ($c eq "\t") { 5150a920b5bSAndy Whitcroft $res .= ' '; 5160a920b5bSAndy Whitcroft $n++; 5170a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 5180a920b5bSAndy Whitcroft $res .= ' '; 5190a920b5bSAndy Whitcroft } 5200a920b5bSAndy Whitcroft next; 5210a920b5bSAndy Whitcroft } 5220a920b5bSAndy Whitcroft $res .= $c; 5230a920b5bSAndy Whitcroft $n++; 5240a920b5bSAndy Whitcroft } 5250a920b5bSAndy Whitcroft 5260a920b5bSAndy Whitcroft return $res; 5270a920b5bSAndy Whitcroft} 5286c72ffaaSAndy Whitcroftsub copy_spacing { 529773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 5306c72ffaaSAndy Whitcroft return $res; 5316c72ffaaSAndy Whitcroft} 5320a920b5bSAndy Whitcroft 5334a0df2efSAndy Whitcroftsub line_stats { 5344a0df2efSAndy Whitcroft my ($line) = @_; 5354a0df2efSAndy Whitcroft 5364a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 5374a0df2efSAndy Whitcroft $line =~ s/^.//; 5384a0df2efSAndy Whitcroft $line = expand_tabs($line); 5394a0df2efSAndy Whitcroft 5404a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 5414a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 5424a0df2efSAndy Whitcroft 5434a0df2efSAndy Whitcroft return (length($line), length($white)); 5444a0df2efSAndy Whitcroft} 5454a0df2efSAndy Whitcroft 546773647a0SAndy Whitcroftmy $sanitise_quote = ''; 547773647a0SAndy Whitcroft 548773647a0SAndy Whitcroftsub sanitise_line_reset { 549773647a0SAndy Whitcroft my ($in_comment) = @_; 550773647a0SAndy Whitcroft 551773647a0SAndy Whitcroft if ($in_comment) { 552773647a0SAndy Whitcroft $sanitise_quote = '*/'; 553773647a0SAndy Whitcroft } else { 554773647a0SAndy Whitcroft $sanitise_quote = ''; 555773647a0SAndy Whitcroft } 556773647a0SAndy Whitcroft} 55700df344fSAndy Whitcroftsub sanitise_line { 55800df344fSAndy Whitcroft my ($line) = @_; 55900df344fSAndy Whitcroft 56000df344fSAndy Whitcroft my $res = ''; 56100df344fSAndy Whitcroft my $l = ''; 56200df344fSAndy Whitcroft 563c2fdda0dSAndy Whitcroft my $qlen = 0; 564773647a0SAndy Whitcroft my $off = 0; 565773647a0SAndy Whitcroft my $c; 56600df344fSAndy Whitcroft 567773647a0SAndy Whitcroft # Always copy over the diff marker. 568773647a0SAndy Whitcroft $res = substr($line, 0, 1); 569773647a0SAndy Whitcroft 570773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 571773647a0SAndy Whitcroft $c = substr($line, $off, 1); 572773647a0SAndy Whitcroft 573773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 574773647a0SAndy Whitcroft # and end, all to $;. 575773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 576773647a0SAndy Whitcroft $sanitise_quote = '*/'; 577773647a0SAndy Whitcroft 578773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 579773647a0SAndy Whitcroft $off++; 58000df344fSAndy Whitcroft next; 581773647a0SAndy Whitcroft } 58281bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 583773647a0SAndy Whitcroft $sanitise_quote = ''; 584773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 585773647a0SAndy Whitcroft $off++; 586773647a0SAndy Whitcroft next; 587773647a0SAndy Whitcroft } 588113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 589113f04a8SDaniel Walker $sanitise_quote = '//'; 590113f04a8SDaniel Walker 591113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 592113f04a8SDaniel Walker $off++; 593113f04a8SDaniel Walker next; 594113f04a8SDaniel Walker } 595773647a0SAndy Whitcroft 596773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 597773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 598773647a0SAndy Whitcroft $c eq "\\") { 599773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 600773647a0SAndy Whitcroft $off++; 601773647a0SAndy Whitcroft next; 602773647a0SAndy Whitcroft } 603773647a0SAndy Whitcroft # Regular quotes. 604773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 605773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 606773647a0SAndy Whitcroft $sanitise_quote = $c; 607773647a0SAndy Whitcroft 608773647a0SAndy Whitcroft substr($res, $off, 1, $c); 609773647a0SAndy Whitcroft next; 610773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 611773647a0SAndy Whitcroft $sanitise_quote = ''; 61200df344fSAndy Whitcroft } 61300df344fSAndy Whitcroft } 614773647a0SAndy Whitcroft 615fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 616773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 617773647a0SAndy Whitcroft substr($res, $off, 1, $;); 618113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 619113f04a8SDaniel Walker substr($res, $off, 1, $;); 620773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 621773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 62200df344fSAndy Whitcroft } else { 623773647a0SAndy Whitcroft substr($res, $off, 1, $c); 62400df344fSAndy Whitcroft } 625c2fdda0dSAndy Whitcroft } 626c2fdda0dSAndy Whitcroft 627113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 628113f04a8SDaniel Walker $sanitise_quote = ''; 629113f04a8SDaniel Walker } 630113f04a8SDaniel Walker 631c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 632c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 633c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 634c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 635c2fdda0dSAndy Whitcroft 636c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 637c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 638c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 639c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 640c2fdda0dSAndy Whitcroft } 641c2fdda0dSAndy Whitcroft 64200df344fSAndy Whitcroft return $res; 64300df344fSAndy Whitcroft} 64400df344fSAndy Whitcroft 6458905a67cSAndy Whitcroftsub ctx_statement_block { 6468905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6478905a67cSAndy Whitcroft my $line = $linenr - 1; 6488905a67cSAndy Whitcroft my $blk = ''; 6498905a67cSAndy Whitcroft my $soff = $off; 6508905a67cSAndy Whitcroft my $coff = $off - 1; 651773647a0SAndy Whitcroft my $coff_set = 0; 6528905a67cSAndy Whitcroft 65313214adfSAndy Whitcroft my $loff = 0; 65413214adfSAndy Whitcroft 6558905a67cSAndy Whitcroft my $type = ''; 6568905a67cSAndy Whitcroft my $level = 0; 657a2750645SAndy Whitcroft my @stack = (); 658cf655043SAndy Whitcroft my $p; 6598905a67cSAndy Whitcroft my $c; 6608905a67cSAndy Whitcroft my $len = 0; 66113214adfSAndy Whitcroft 66213214adfSAndy Whitcroft my $remainder; 6638905a67cSAndy Whitcroft while (1) { 664a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 665a2750645SAndy Whitcroft 666773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6678905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6688905a67cSAndy Whitcroft # context. 6698905a67cSAndy Whitcroft if ($off >= $len) { 6708905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 671dea33496SAndy Whitcroft last if (!defined $lines[$line]); 672c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6738905a67cSAndy Whitcroft $remain--; 67413214adfSAndy Whitcroft $loff = $len; 675c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6768905a67cSAndy Whitcroft $len = length($blk); 6778905a67cSAndy Whitcroft $line++; 6788905a67cSAndy Whitcroft last; 6798905a67cSAndy Whitcroft } 6808905a67cSAndy Whitcroft # Bail if there is no further context. 6818905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 68213214adfSAndy Whitcroft if ($off >= $len) { 6838905a67cSAndy Whitcroft last; 6848905a67cSAndy Whitcroft } 685f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 686f74bd194SAndy Whitcroft $level++; 687f74bd194SAndy Whitcroft $type = '#'; 688f74bd194SAndy Whitcroft } 6898905a67cSAndy Whitcroft } 690cf655043SAndy Whitcroft $p = $c; 6918905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 69213214adfSAndy Whitcroft $remainder = substr($blk, $off); 6938905a67cSAndy Whitcroft 694773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6954635f4fbSAndy Whitcroft 6964635f4fbSAndy Whitcroft # Handle nested #if/#else. 6974635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6984635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6994635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 7004635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 7014635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 7024635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 7034635f4fbSAndy Whitcroft } 7044635f4fbSAndy Whitcroft 7058905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 7068905a67cSAndy Whitcroft # outermost level. 7078905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 7088905a67cSAndy Whitcroft last; 7098905a67cSAndy Whitcroft } 7108905a67cSAndy Whitcroft 71113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 712773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 713773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 714773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 715773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 716773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 717773647a0SAndy Whitcroft $coff_set = 1; 718773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 719773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 72013214adfSAndy Whitcroft } 72113214adfSAndy Whitcroft 7228905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7238905a67cSAndy Whitcroft $level++; 7248905a67cSAndy Whitcroft $type = '('; 7258905a67cSAndy Whitcroft } 7268905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7278905a67cSAndy Whitcroft $level--; 7288905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7298905a67cSAndy Whitcroft 7308905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7318905a67cSAndy Whitcroft $coff = $off; 732773647a0SAndy Whitcroft $coff_set = 1; 733773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7348905a67cSAndy Whitcroft } 7358905a67cSAndy Whitcroft } 7368905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7378905a67cSAndy Whitcroft $level++; 7388905a67cSAndy Whitcroft $type = '{'; 7398905a67cSAndy Whitcroft } 7408905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7418905a67cSAndy Whitcroft $level--; 7428905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7438905a67cSAndy Whitcroft 7448905a67cSAndy Whitcroft if ($level == 0) { 745b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 746b998e001SPatrick Pannuto $off++; 747b998e001SPatrick Pannuto } 7488905a67cSAndy Whitcroft last; 7498905a67cSAndy Whitcroft } 7508905a67cSAndy Whitcroft } 751f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 752f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 753f74bd194SAndy Whitcroft $level--; 754f74bd194SAndy Whitcroft $type = ''; 755f74bd194SAndy Whitcroft $off++; 756f74bd194SAndy Whitcroft last; 757f74bd194SAndy Whitcroft } 7588905a67cSAndy Whitcroft $off++; 7598905a67cSAndy Whitcroft } 760a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 76113214adfSAndy Whitcroft if ($off == $len) { 762a3bb97a7SAndy Whitcroft $loff = $len + 1; 76313214adfSAndy Whitcroft $line++; 76413214adfSAndy Whitcroft $remain--; 76513214adfSAndy Whitcroft } 7668905a67cSAndy Whitcroft 7678905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7688905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7698905a67cSAndy Whitcroft 7708905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7718905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7728905a67cSAndy Whitcroft 773773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 77413214adfSAndy Whitcroft 77513214adfSAndy Whitcroft return ($statement, $condition, 77613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 77713214adfSAndy Whitcroft} 77813214adfSAndy Whitcroft 779cf655043SAndy Whitcroftsub statement_lines { 780cf655043SAndy Whitcroft my ($stmt) = @_; 781cf655043SAndy Whitcroft 782cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 783cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 784cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 785cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 786cf655043SAndy Whitcroft 787cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 788cf655043SAndy Whitcroft 789cf655043SAndy Whitcroft return $#stmt_lines + 2; 790cf655043SAndy Whitcroft} 791cf655043SAndy Whitcroft 792cf655043SAndy Whitcroftsub statement_rawlines { 793cf655043SAndy Whitcroft my ($stmt) = @_; 794cf655043SAndy Whitcroft 795cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 796cf655043SAndy Whitcroft 797cf655043SAndy Whitcroft return $#stmt_lines + 2; 798cf655043SAndy Whitcroft} 799cf655043SAndy Whitcroft 800cf655043SAndy Whitcroftsub statement_block_size { 801cf655043SAndy Whitcroft my ($stmt) = @_; 802cf655043SAndy Whitcroft 803cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 804cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 805cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 806cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 807cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 808cf655043SAndy Whitcroft 809cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 810cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 811cf655043SAndy Whitcroft 812cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 813cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 814cf655043SAndy Whitcroft 815cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 816cf655043SAndy Whitcroft return $stmt_lines; 817cf655043SAndy Whitcroft } else { 818cf655043SAndy Whitcroft return $stmt_statements; 819cf655043SAndy Whitcroft } 820cf655043SAndy Whitcroft} 821cf655043SAndy Whitcroft 82213214adfSAndy Whitcroftsub ctx_statement_full { 82313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 82413214adfSAndy Whitcroft my ($statement, $condition, $level); 82513214adfSAndy Whitcroft 82613214adfSAndy Whitcroft my (@chunks); 82713214adfSAndy Whitcroft 828cf655043SAndy Whitcroft # Grab the first conditional/block pair. 82913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 83013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 831773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 83213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 833cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 834cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 835cf655043SAndy Whitcroft } 836cf655043SAndy Whitcroft 837cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 838cf655043SAndy Whitcroft # could continue the statement. 839cf655043SAndy Whitcroft for (;;) { 84013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 84113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 842cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 843773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 844cf655043SAndy Whitcroft #print "C: push\n"; 845cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 84613214adfSAndy Whitcroft } 84713214adfSAndy Whitcroft 84813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8498905a67cSAndy Whitcroft} 8508905a67cSAndy Whitcroft 8514a0df2efSAndy Whitcroftsub ctx_block_get { 852f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8534a0df2efSAndy Whitcroft my $line; 8544a0df2efSAndy Whitcroft my $start = $linenr - 1; 8554a0df2efSAndy Whitcroft my $blk = ''; 8564a0df2efSAndy Whitcroft my @o; 8574a0df2efSAndy Whitcroft my @c; 8584a0df2efSAndy Whitcroft my @res = (); 8594a0df2efSAndy Whitcroft 860f0a594c1SAndy Whitcroft my $level = 0; 8614635f4fbSAndy Whitcroft my @stack = ($level); 86200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 86300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 86400df344fSAndy Whitcroft $remain--; 86500df344fSAndy Whitcroft 86600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8674635f4fbSAndy Whitcroft 8684635f4fbSAndy Whitcroft # Handle nested #if/#else. 86901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8704635f4fbSAndy Whitcroft push(@stack, $level); 87101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8724635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 87301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8744635f4fbSAndy Whitcroft $level = pop(@stack); 8754635f4fbSAndy Whitcroft } 8764635f4fbSAndy Whitcroft 87701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 878f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 879f0a594c1SAndy Whitcroft if ($off > 0) { 880f0a594c1SAndy Whitcroft $off--; 881f0a594c1SAndy Whitcroft next; 882f0a594c1SAndy Whitcroft } 8834a0df2efSAndy Whitcroft 884f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 885f0a594c1SAndy Whitcroft $level--; 886f0a594c1SAndy Whitcroft last if ($level == 0); 887f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 888f0a594c1SAndy Whitcroft $level++; 889f0a594c1SAndy Whitcroft } 890f0a594c1SAndy Whitcroft } 8914a0df2efSAndy Whitcroft 892f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 89300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8944a0df2efSAndy Whitcroft } 8954a0df2efSAndy Whitcroft 896f0a594c1SAndy Whitcroft last if ($level == 0); 8974a0df2efSAndy Whitcroft } 8984a0df2efSAndy Whitcroft 899f0a594c1SAndy Whitcroft return ($level, @res); 9004a0df2efSAndy Whitcroft} 9014a0df2efSAndy Whitcroftsub ctx_block_outer { 9024a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 9034a0df2efSAndy Whitcroft 904f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 905f0a594c1SAndy Whitcroft return @r; 9064a0df2efSAndy Whitcroft} 9074a0df2efSAndy Whitcroftsub ctx_block { 9084a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 9094a0df2efSAndy Whitcroft 910f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 911f0a594c1SAndy Whitcroft return @r; 912653d4876SAndy Whitcroft} 913653d4876SAndy Whitcroftsub ctx_statement { 914f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 915f0a594c1SAndy Whitcroft 916f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 917f0a594c1SAndy Whitcroft return @r; 918f0a594c1SAndy Whitcroft} 919f0a594c1SAndy Whitcroftsub ctx_block_level { 920653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 921653d4876SAndy Whitcroft 922f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9234a0df2efSAndy Whitcroft} 9249c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9259c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9269c0ca6f9SAndy Whitcroft 9279c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9289c0ca6f9SAndy Whitcroft} 9294a0df2efSAndy Whitcroft 9304a0df2efSAndy Whitcroftsub ctx_locate_comment { 9314a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9324a0df2efSAndy Whitcroft 9334a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 934beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9354a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9364a0df2efSAndy Whitcroft 9374a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9384a0df2efSAndy Whitcroft # comment. 9394a0df2efSAndy Whitcroft my $in_comment = 0; 9404a0df2efSAndy Whitcroft $current_comment = ''; 9414a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 94200df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 94300df344fSAndy Whitcroft #warn " $line\n"; 9444a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9454a0df2efSAndy Whitcroft $in_comment = 1; 9464a0df2efSAndy Whitcroft } 9474a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9484a0df2efSAndy Whitcroft $in_comment = 1; 9494a0df2efSAndy Whitcroft } 9504a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9514a0df2efSAndy Whitcroft $current_comment = ''; 9524a0df2efSAndy Whitcroft } 9534a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9544a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9554a0df2efSAndy Whitcroft $in_comment = 0; 9564a0df2efSAndy Whitcroft } 9574a0df2efSAndy Whitcroft } 9584a0df2efSAndy Whitcroft 9594a0df2efSAndy Whitcroft chomp($current_comment); 9604a0df2efSAndy Whitcroft return($current_comment); 9614a0df2efSAndy Whitcroft} 9624a0df2efSAndy Whitcroftsub ctx_has_comment { 9634a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9644a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9654a0df2efSAndy Whitcroft 96600df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9674a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9684a0df2efSAndy Whitcroft 9694a0df2efSAndy Whitcroft return ($cmt ne ''); 9704a0df2efSAndy Whitcroft} 9714a0df2efSAndy Whitcroft 9724d001e4dSAndy Whitcroftsub raw_line { 9734d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9744d001e4dSAndy Whitcroft 9754d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9764d001e4dSAndy Whitcroft $cnt++; 9774d001e4dSAndy Whitcroft 9784d001e4dSAndy Whitcroft my $line; 9794d001e4dSAndy Whitcroft while ($cnt) { 9804d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9814d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9824d001e4dSAndy Whitcroft $cnt--; 9834d001e4dSAndy Whitcroft } 9844d001e4dSAndy Whitcroft 9854d001e4dSAndy Whitcroft return $line; 9864d001e4dSAndy Whitcroft} 9874d001e4dSAndy Whitcroft 9880a920b5bSAndy Whitcroftsub cat_vet { 9890a920b5bSAndy Whitcroft my ($vet) = @_; 9909c0ca6f9SAndy Whitcroft my ($res, $coded); 9910a920b5bSAndy Whitcroft 9929c0ca6f9SAndy Whitcroft $res = ''; 9936c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9946c72ffaaSAndy Whitcroft $res .= $1; 9956c72ffaaSAndy Whitcroft if ($2 ne '') { 9969c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9976c72ffaaSAndy Whitcroft $res .= $coded; 9986c72ffaaSAndy Whitcroft } 9999c0ca6f9SAndy Whitcroft } 10009c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 10010a920b5bSAndy Whitcroft 10029c0ca6f9SAndy Whitcroft return $res; 10030a920b5bSAndy Whitcroft} 10040a920b5bSAndy Whitcroft 1005c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1006cf655043SAndy Whitcroftmy $av_pending; 1007c2fdda0dSAndy Whitcroftmy @av_paren_type; 10081f65f947SAndy Whitcroftmy $av_pend_colon; 1009c2fdda0dSAndy Whitcroft 1010c2fdda0dSAndy Whitcroftsub annotate_reset { 1011c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1012cf655043SAndy Whitcroft $av_pending = '_'; 1013cf655043SAndy Whitcroft @av_paren_type = ('E'); 10141f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1015c2fdda0dSAndy Whitcroft} 1016c2fdda0dSAndy Whitcroft 10176c72ffaaSAndy Whitcroftsub annotate_values { 10186c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10196c72ffaaSAndy Whitcroft 10206c72ffaaSAndy Whitcroft my $res; 10211f65f947SAndy Whitcroft my $var = '_' x length($stream); 10226c72ffaaSAndy Whitcroft my $cur = $stream; 10236c72ffaaSAndy Whitcroft 1024c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10256c72ffaaSAndy Whitcroft 10266c72ffaaSAndy Whitcroft while (length($cur)) { 1027773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1028cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1029171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10306c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1031c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1032c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1033cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1034c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10356c72ffaaSAndy Whitcroft } 10366c72ffaaSAndy Whitcroft 1037c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10389446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10399446ef56SAndy Whitcroft push(@av_paren_type, $type); 1040addcdceaSAndy Whitcroft $type = 'c'; 10419446ef56SAndy Whitcroft 1042e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1043c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10446c72ffaaSAndy Whitcroft $type = 'T'; 10456c72ffaaSAndy Whitcroft 1046389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1047389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1048389a2fe5SAndy Whitcroft $type = 'T'; 1049389a2fe5SAndy Whitcroft 1050c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1051171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1052c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1053171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1054171ae1a4SAndy Whitcroft if ($2 ne '') { 1055cf655043SAndy Whitcroft $av_pending = 'N'; 1056171ae1a4SAndy Whitcroft } 1057171ae1a4SAndy Whitcroft $type = 'E'; 1058171ae1a4SAndy Whitcroft 1059c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1060171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1061171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1062171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10636c72ffaaSAndy Whitcroft 1064c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1065cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1066c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1067cf655043SAndy Whitcroft 1068cf655043SAndy Whitcroft push(@av_paren_type, $type); 1069cf655043SAndy Whitcroft push(@av_paren_type, $type); 1070171ae1a4SAndy Whitcroft $type = 'E'; 1071cf655043SAndy Whitcroft 1072c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1073cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1074cf655043SAndy Whitcroft $av_preprocessor = 1; 1075cf655043SAndy Whitcroft 1076cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1077cf655043SAndy Whitcroft 1078171ae1a4SAndy Whitcroft $type = 'E'; 1079cf655043SAndy Whitcroft 1080c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1081cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1082cf655043SAndy Whitcroft 1083cf655043SAndy Whitcroft $av_preprocessor = 1; 1084cf655043SAndy Whitcroft 1085cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1086cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1087cf655043SAndy Whitcroft pop(@av_paren_type); 1088cf655043SAndy Whitcroft push(@av_paren_type, $type); 1089171ae1a4SAndy Whitcroft $type = 'E'; 10906c72ffaaSAndy Whitcroft 10916c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1092c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10936c72ffaaSAndy Whitcroft 1094171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1095171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1096171ae1a4SAndy Whitcroft $av_pending = $type; 1097171ae1a4SAndy Whitcroft $type = 'N'; 1098171ae1a4SAndy Whitcroft 10996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1100c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 11016c72ffaaSAndy Whitcroft if (defined $2) { 1102cf655043SAndy Whitcroft $av_pending = 'V'; 11036c72ffaaSAndy Whitcroft } 11046c72ffaaSAndy Whitcroft $type = 'N'; 11056c72ffaaSAndy Whitcroft 110614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1107c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 110814b111c1SAndy Whitcroft $av_pending = 'E'; 11096c72ffaaSAndy Whitcroft $type = 'N'; 11106c72ffaaSAndy Whitcroft 11111f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 11121f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 11131f65f947SAndy Whitcroft $av_pend_colon = 'C'; 11141f65f947SAndy Whitcroft $type = 'N'; 11151f65f947SAndy Whitcroft 111614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1117c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11186c72ffaaSAndy Whitcroft $type = 'N'; 11196c72ffaaSAndy Whitcroft 11206c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1121c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1122cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1123cf655043SAndy Whitcroft $av_pending = '_'; 11246c72ffaaSAndy Whitcroft $type = 'N'; 11256c72ffaaSAndy Whitcroft 11266c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1127cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1128cf655043SAndy Whitcroft if ($new_type ne '_') { 1129cf655043SAndy Whitcroft $type = $new_type; 1130c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1131c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11326c72ffaaSAndy Whitcroft } else { 1133c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11346c72ffaaSAndy Whitcroft } 11356c72ffaaSAndy Whitcroft 1136c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1137c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1138c8cb2ca3SAndy Whitcroft $type = 'V'; 1139cf655043SAndy Whitcroft $av_pending = 'V'; 11406c72ffaaSAndy Whitcroft 11418e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11428e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11431f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11448e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11458e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11461f65f947SAndy Whitcroft } 11471f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11481f65f947SAndy Whitcroft $type = 'V'; 11491f65f947SAndy Whitcroft 11506c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1151c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11526c72ffaaSAndy Whitcroft $type = 'V'; 11536c72ffaaSAndy Whitcroft 11546c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1155c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11566c72ffaaSAndy Whitcroft $type = 'N'; 11576c72ffaaSAndy Whitcroft 1158cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1159c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 116013214adfSAndy Whitcroft $type = 'E'; 11611f65f947SAndy Whitcroft $av_pend_colon = 'O'; 116213214adfSAndy Whitcroft 11638e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11648e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11658e761b04SAndy Whitcroft $type = 'C'; 11668e761b04SAndy Whitcroft 11671f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11681f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11691f65f947SAndy Whitcroft $type = 'N'; 11701f65f947SAndy Whitcroft 11711f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11721f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11731f65f947SAndy Whitcroft 11741f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11751f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11761f65f947SAndy Whitcroft $type = 'E'; 11771f65f947SAndy Whitcroft } else { 11781f65f947SAndy Whitcroft $type = 'N'; 11791f65f947SAndy Whitcroft } 11801f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11811f65f947SAndy Whitcroft 11828e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 118313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11846c72ffaaSAndy Whitcroft $type = 'N'; 11856c72ffaaSAndy Whitcroft 11860d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 118774048ed8SAndy Whitcroft my $variant; 118874048ed8SAndy Whitcroft 118974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 119074048ed8SAndy Whitcroft if ($type eq 'V') { 119174048ed8SAndy Whitcroft $variant = 'B'; 119274048ed8SAndy Whitcroft } else { 119374048ed8SAndy Whitcroft $variant = 'U'; 119474048ed8SAndy Whitcroft } 119574048ed8SAndy Whitcroft 119674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 119774048ed8SAndy Whitcroft $type = 'N'; 119874048ed8SAndy Whitcroft 11996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1200c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 12016c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 12026c72ffaaSAndy Whitcroft $type = 'N'; 12036c72ffaaSAndy Whitcroft } 12046c72ffaaSAndy Whitcroft 12056c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1206c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 12076c72ffaaSAndy Whitcroft } 12086c72ffaaSAndy Whitcroft if (defined $1) { 12096c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 12106c72ffaaSAndy Whitcroft $res .= $type x length($1); 12116c72ffaaSAndy Whitcroft } 12126c72ffaaSAndy Whitcroft } 12136c72ffaaSAndy Whitcroft 12141f65f947SAndy Whitcroft return ($res, $var); 12156c72ffaaSAndy Whitcroft} 12166c72ffaaSAndy Whitcroft 12178905a67cSAndy Whitcroftsub possible { 121813214adfSAndy Whitcroft my ($possible, $line) = @_; 12199a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12200776e594SAndy Whitcroft ^(?: 12210776e594SAndy Whitcroft $Modifier| 12220776e594SAndy Whitcroft $Storage| 12230776e594SAndy Whitcroft $Type| 12249a974fdbSAndy Whitcroft DEFINE_\S+ 12259a974fdbSAndy Whitcroft )$| 12269a974fdbSAndy Whitcroft ^(?: 12270776e594SAndy Whitcroft goto| 12280776e594SAndy Whitcroft return| 12290776e594SAndy Whitcroft case| 12300776e594SAndy Whitcroft else| 12310776e594SAndy Whitcroft asm|__asm__| 123289a88353SAndy Whitcroft do| 123389a88353SAndy Whitcroft \#| 123489a88353SAndy Whitcroft \#\#| 12359a974fdbSAndy Whitcroft )(?:\s|$)| 12360776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12379a974fdbSAndy Whitcroft )}x; 12389a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12399a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1240c45dcabdSAndy Whitcroft # Check for modifiers. 1241c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1242c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1243c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1244c45dcabdSAndy Whitcroft 1245c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1246c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1247d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12489a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1249d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1250d2506586SAndy Whitcroft push(@modifierList, $modifier); 1251d2506586SAndy Whitcroft } 12529a974fdbSAndy Whitcroft } 1253c45dcabdSAndy Whitcroft 1254c45dcabdSAndy Whitcroft } else { 125513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12568905a67cSAndy Whitcroft push(@typeList, $possible); 1257c45dcabdSAndy Whitcroft } 12588905a67cSAndy Whitcroft build_types(); 12590776e594SAndy Whitcroft } else { 12600776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12618905a67cSAndy Whitcroft } 12628905a67cSAndy Whitcroft} 12638905a67cSAndy Whitcroft 12646c72ffaaSAndy Whitcroftmy $prefix = ''; 12656c72ffaaSAndy Whitcroft 1266000d1cc1SJoe Perchessub show_type { 1267000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1268000d1cc1SJoe Perches} 1269000d1cc1SJoe Perches 1270f0a594c1SAndy Whitcroftsub report { 1271000d1cc1SJoe Perches if (!show_type($_[1]) || 1272000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1273773647a0SAndy Whitcroft return 0; 1274773647a0SAndy Whitcroft } 1275000d1cc1SJoe Perches my $line; 1276000d1cc1SJoe Perches if ($show_types) { 1277000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1278000d1cc1SJoe Perches } else { 1279000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1280000d1cc1SJoe Perches } 12818905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12828905a67cSAndy Whitcroft 128313214adfSAndy Whitcroft push(our @report, $line); 1284773647a0SAndy Whitcroft 1285773647a0SAndy Whitcroft return 1; 1286f0a594c1SAndy Whitcroft} 1287f0a594c1SAndy Whitcroftsub report_dump { 128813214adfSAndy Whitcroft our @report; 1289f0a594c1SAndy Whitcroft} 1290000d1cc1SJoe Perches 1291de7d4f0eSAndy Whitcroftsub ERROR { 1292000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1293de7d4f0eSAndy Whitcroft our $clean = 0; 12946c72ffaaSAndy Whitcroft our $cnt_error++; 1295de7d4f0eSAndy Whitcroft } 1296773647a0SAndy Whitcroft} 1297de7d4f0eSAndy Whitcroftsub WARN { 1298000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1299de7d4f0eSAndy Whitcroft our $clean = 0; 13006c72ffaaSAndy Whitcroft our $cnt_warn++; 1301de7d4f0eSAndy Whitcroft } 1302773647a0SAndy Whitcroft} 1303de7d4f0eSAndy Whitcroftsub CHK { 1304000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1305de7d4f0eSAndy Whitcroft our $clean = 0; 13066c72ffaaSAndy Whitcroft our $cnt_chk++; 13076c72ffaaSAndy Whitcroft } 1308de7d4f0eSAndy Whitcroft} 1309de7d4f0eSAndy Whitcroft 13106ecd9674SAndy Whitcroftsub check_absolute_file { 13116ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 13126ecd9674SAndy Whitcroft my $file = $absolute; 13136ecd9674SAndy Whitcroft 13146ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 13156ecd9674SAndy Whitcroft 13166ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 13176ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 13186ecd9674SAndy Whitcroft if (-f "$root/$file") { 13196ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13206ecd9674SAndy Whitcroft last; 13216ecd9674SAndy Whitcroft } 13226ecd9674SAndy Whitcroft } 13236ecd9674SAndy Whitcroft if (! -f _) { 13246ecd9674SAndy Whitcroft return 0; 13256ecd9674SAndy Whitcroft } 13266ecd9674SAndy Whitcroft 13276ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13286ecd9674SAndy Whitcroft my $prefix = $absolute; 13296ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13306ecd9674SAndy Whitcroft 13316ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13326ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1333000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1334000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13356ecd9674SAndy Whitcroft } 13366ecd9674SAndy Whitcroft} 13376ecd9674SAndy Whitcroft 1338d1fe9c09SJoe Perchessub pos_last_openparen { 1339d1fe9c09SJoe Perches my ($line) = @_; 1340d1fe9c09SJoe Perches 1341d1fe9c09SJoe Perches my $pos = 0; 1342d1fe9c09SJoe Perches 1343d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1344d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1345d1fe9c09SJoe Perches 1346d1fe9c09SJoe Perches my $last_openparen = 0; 1347d1fe9c09SJoe Perches 1348d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1349d1fe9c09SJoe Perches return -1; 1350d1fe9c09SJoe Perches } 1351d1fe9c09SJoe Perches 1352d1fe9c09SJoe Perches my $len = length($line); 1353d1fe9c09SJoe Perches 1354d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1355d1fe9c09SJoe Perches my $string = substr($line, $pos); 1356d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1357d1fe9c09SJoe Perches $pos += length($1) - 1; 1358d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1359d1fe9c09SJoe Perches $last_openparen = $pos; 1360d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1361d1fe9c09SJoe Perches last; 1362d1fe9c09SJoe Perches } 1363d1fe9c09SJoe Perches } 1364d1fe9c09SJoe Perches 1365d1fe9c09SJoe Perches return $last_openparen + 1; 1366d1fe9c09SJoe Perches} 1367d1fe9c09SJoe Perches 13680a920b5bSAndy Whitcroftsub process { 13690a920b5bSAndy Whitcroft my $filename = shift; 13700a920b5bSAndy Whitcroft 13710a920b5bSAndy Whitcroft my $linenr=0; 13720a920b5bSAndy Whitcroft my $prevline=""; 1373c2fdda0dSAndy Whitcroft my $prevrawline=""; 13740a920b5bSAndy Whitcroft my $stashline=""; 1375c2fdda0dSAndy Whitcroft my $stashrawline=""; 13760a920b5bSAndy Whitcroft 13774a0df2efSAndy Whitcroft my $length; 13780a920b5bSAndy Whitcroft my $indent; 13790a920b5bSAndy Whitcroft my $previndent=0; 13800a920b5bSAndy Whitcroft my $stashindent=0; 13810a920b5bSAndy Whitcroft 1382de7d4f0eSAndy Whitcroft our $clean = 1; 13830a920b5bSAndy Whitcroft my $signoff = 0; 13840a920b5bSAndy Whitcroft my $is_patch = 0; 13850a920b5bSAndy Whitcroft 138615662b3eSJoe Perches my $in_header_lines = 1; 138715662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 138815662b3eSJoe Perches 1389fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1390fa64205dSPasi Savanainen 139113214adfSAndy Whitcroft our @report = (); 13926c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13936c72ffaaSAndy Whitcroft our $cnt_error = 0; 13946c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13956c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13966c72ffaaSAndy Whitcroft 13970a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13980a920b5bSAndy Whitcroft my $realfile = ''; 13990a920b5bSAndy Whitcroft my $realline = 0; 14000a920b5bSAndy Whitcroft my $realcnt = 0; 14010a920b5bSAndy Whitcroft my $here = ''; 14020a920b5bSAndy Whitcroft my $in_comment = 0; 1403c2fdda0dSAndy Whitcroft my $comment_edge = 0; 14040a920b5bSAndy Whitcroft my $first_line = 0; 14051e855726SWolfram Sang my $p1_prefix = ''; 14060a920b5bSAndy Whitcroft 140713214adfSAndy Whitcroft my $prev_values = 'E'; 140813214adfSAndy Whitcroft 140913214adfSAndy Whitcroft # suppression flags 1410773647a0SAndy Whitcroft my %suppress_ifbraces; 1411170d3a22SAndy Whitcroft my %suppress_whiletrailers; 14122b474a1aSAndy Whitcroft my %suppress_export; 14133e469cdcSAndy Whitcroft my $suppress_statement = 0; 1414653d4876SAndy Whitcroft 1415c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1416de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1417c2fdda0dSAndy Whitcroft # 1418de7d4f0eSAndy Whitcroft my @setup_docs = (); 1419de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1420773647a0SAndy Whitcroft 1421773647a0SAndy Whitcroft sanitise_line_reset(); 1422c2fdda0dSAndy Whitcroft my $line; 1423c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1424773647a0SAndy Whitcroft $linenr++; 1425773647a0SAndy Whitcroft $line = $rawline; 1426c2fdda0dSAndy Whitcroft 1427773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1428de7d4f0eSAndy Whitcroft $setup_docs = 0; 1429de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1430de7d4f0eSAndy Whitcroft $setup_docs = 1; 1431de7d4f0eSAndy Whitcroft } 1432773647a0SAndy Whitcroft #next; 1433de7d4f0eSAndy Whitcroft } 1434773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1435773647a0SAndy Whitcroft $realline=$1-1; 1436773647a0SAndy Whitcroft if (defined $2) { 1437773647a0SAndy Whitcroft $realcnt=$3+1; 1438773647a0SAndy Whitcroft } else { 1439773647a0SAndy Whitcroft $realcnt=1+1; 1440773647a0SAndy Whitcroft } 1441c45dcabdSAndy Whitcroft $in_comment = 0; 1442773647a0SAndy Whitcroft 1443773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1444773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1445773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1446773647a0SAndy Whitcroft # at context start. 1447773647a0SAndy Whitcroft my $edge; 144801fa9147SAndy Whitcroft my $cnt = $realcnt; 144901fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 145001fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 145101fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 145201fa9147SAndy Whitcroft $cnt--; 145301fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1454721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1455fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1456fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1457fae17daeSAndy Whitcroft ($edge) = $1; 1458fae17daeSAndy Whitcroft last; 1459fae17daeSAndy Whitcroft } 1460773647a0SAndy Whitcroft } 1461773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1462773647a0SAndy Whitcroft $in_comment = 1; 1463773647a0SAndy Whitcroft } 1464773647a0SAndy Whitcroft 1465773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1466773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1467773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1468773647a0SAndy Whitcroft if (!defined $edge && 146983242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1470773647a0SAndy Whitcroft { 1471773647a0SAndy Whitcroft $in_comment = 1; 1472773647a0SAndy Whitcroft } 1473773647a0SAndy Whitcroft 1474773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1475773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1476773647a0SAndy Whitcroft 1477171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1478773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1479171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1480773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1481773647a0SAndy Whitcroft } 1482773647a0SAndy Whitcroft push(@lines, $line); 1483773647a0SAndy Whitcroft 1484773647a0SAndy Whitcroft if ($realcnt > 1) { 1485773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1486773647a0SAndy Whitcroft } else { 1487773647a0SAndy Whitcroft $realcnt = 0; 1488773647a0SAndy Whitcroft } 1489773647a0SAndy Whitcroft 1490773647a0SAndy Whitcroft #print "==>$rawline\n"; 1491773647a0SAndy Whitcroft #print "-->$line\n"; 1492de7d4f0eSAndy Whitcroft 1493de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1494de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1495de7d4f0eSAndy Whitcroft } 1496de7d4f0eSAndy Whitcroft } 1497de7d4f0eSAndy Whitcroft 14986c72ffaaSAndy Whitcroft $prefix = ''; 14996c72ffaaSAndy Whitcroft 1500773647a0SAndy Whitcroft $realcnt = 0; 1501773647a0SAndy Whitcroft $linenr = 0; 15020a920b5bSAndy Whitcroft foreach my $line (@lines) { 15030a920b5bSAndy Whitcroft $linenr++; 15040a920b5bSAndy Whitcroft 1505c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 15066c72ffaaSAndy Whitcroft 15070a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 15086c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 15090a920b5bSAndy Whitcroft $is_patch = 1; 15104a0df2efSAndy Whitcroft $first_line = $linenr + 1; 15110a920b5bSAndy Whitcroft $realline=$1-1; 15120a920b5bSAndy Whitcroft if (defined $2) { 15130a920b5bSAndy Whitcroft $realcnt=$3+1; 15140a920b5bSAndy Whitcroft } else { 15150a920b5bSAndy Whitcroft $realcnt=1+1; 15160a920b5bSAndy Whitcroft } 1517c2fdda0dSAndy Whitcroft annotate_reset(); 151813214adfSAndy Whitcroft $prev_values = 'E'; 151913214adfSAndy Whitcroft 1520773647a0SAndy Whitcroft %suppress_ifbraces = (); 1521170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 15222b474a1aSAndy Whitcroft %suppress_export = (); 15233e469cdcSAndy Whitcroft $suppress_statement = 0; 15240a920b5bSAndy Whitcroft next; 15250a920b5bSAndy Whitcroft 15264a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 15274a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 15284a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1529773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 15300a920b5bSAndy Whitcroft $realline++; 1531d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 15320a920b5bSAndy Whitcroft 15334a0df2efSAndy Whitcroft # Measure the line length and indent. 1534c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 15350a920b5bSAndy Whitcroft 15360a920b5bSAndy Whitcroft # Track the previous line. 15370a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 15380a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1539c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1540c2fdda0dSAndy Whitcroft 1541773647a0SAndy Whitcroft #warn "line<$line>\n"; 15426c72ffaaSAndy Whitcroft 1543d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1544d8aaf121SAndy Whitcroft $realcnt--; 15450a920b5bSAndy Whitcroft } 15460a920b5bSAndy Whitcroft 1547cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1548cc77cdcaSAndy Whitcroft 15490a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1550773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1551773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1552773647a0SAndy Whitcroft 15536c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15546c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1555773647a0SAndy Whitcroft 1556773647a0SAndy Whitcroft # extract the filename as it passes 15573bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15583bf9a009SRabin Vincent $realfile = $1; 15593bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1560270c49a0SJoe Perches $in_commit_log = 0; 15613bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1562773647a0SAndy Whitcroft $realfile = $1; 15631e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1564270c49a0SJoe Perches $in_commit_log = 0; 15651e855726SWolfram Sang 15661e855726SWolfram Sang $p1_prefix = $1; 1567e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1568e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1569000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1570000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15711e855726SWolfram Sang } 1572773647a0SAndy Whitcroft 1573c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1574000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1575000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1576773647a0SAndy Whitcroft } 1577773647a0SAndy Whitcroft next; 1578773647a0SAndy Whitcroft } 1579773647a0SAndy Whitcroft 1580389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15810a920b5bSAndy Whitcroft 1582c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1583c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1584c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15850a920b5bSAndy Whitcroft 15866c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15876c72ffaaSAndy Whitcroft 15883bf9a009SRabin Vincent# Check for incorrect file permissions 15893bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15903bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 15913bf9a009SRabin Vincent if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1592000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1593000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15943bf9a009SRabin Vincent } 15953bf9a009SRabin Vincent } 15963bf9a009SRabin Vincent 159720112475SJoe Perches# Check the patch for a signoff: 1598d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15994a0df2efSAndy Whitcroft $signoff++; 160015662b3eSJoe Perches $in_commit_log = 0; 16010a920b5bSAndy Whitcroft } 160220112475SJoe Perches 160320112475SJoe Perches# Check signature styles 1604270c49a0SJoe Perches if (!$in_header_lines && 1605ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 160620112475SJoe Perches my $space_before = $1; 160720112475SJoe Perches my $sign_off = $2; 160820112475SJoe Perches my $space_after = $3; 160920112475SJoe Perches my $email = $4; 161020112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 161120112475SJoe Perches 1612ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1613ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1614ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1615ce0338dfSJoe Perches } 161620112475SJoe Perches if (defined $space_before && $space_before ne "") { 1617000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1618000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 161920112475SJoe Perches } 162020112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1621000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1622000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 162320112475SJoe Perches } 162420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1625000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1626000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 162720112475SJoe Perches } 162820112475SJoe Perches 162920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 163020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 163120112475SJoe Perches if ($suggested_email eq "") { 1632000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1633000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 163420112475SJoe Perches } else { 163520112475SJoe Perches my $dequoted = $suggested_email; 163620112475SJoe Perches $dequoted =~ s/^"//; 163720112475SJoe Perches $dequoted =~ s/" </ </; 163820112475SJoe Perches # Don't force email to have quotes 163920112475SJoe Perches # Allow just an angle bracketed address 164020112475SJoe Perches if ("$dequoted$comment" ne $email && 164120112475SJoe Perches "<$email_address>$comment" ne $email && 164220112475SJoe Perches "$suggested_email$comment" ne $email) { 1643000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1644000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 164520112475SJoe Perches } 16460a920b5bSAndy Whitcroft } 16470a920b5bSAndy Whitcroft } 16480a920b5bSAndy Whitcroft 164900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 16508905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1651000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1652000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 16536c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1654de7d4f0eSAndy Whitcroft } 1655de7d4f0eSAndy Whitcroft 16566ecd9674SAndy Whitcroft# Check for absolute kernel paths. 16576ecd9674SAndy Whitcroft if ($tree) { 16586ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 16596ecd9674SAndy Whitcroft my $file = $1; 16606ecd9674SAndy Whitcroft 16616ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16626ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16636ecd9674SAndy Whitcroft # 16646ecd9674SAndy Whitcroft } else { 16656ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16666ecd9674SAndy Whitcroft } 16676ecd9674SAndy Whitcroft } 16686ecd9674SAndy Whitcroft } 16696ecd9674SAndy Whitcroft 1670de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1671de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1672171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1673171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1674171ae1a4SAndy Whitcroft 1675171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1676171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1677171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1678171ae1a4SAndy Whitcroft 167934d99219SJoe Perches CHK("INVALID_UTF8", 1680000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 168100df344fSAndy Whitcroft } 16820a920b5bSAndy Whitcroft 168315662b3eSJoe Perches# Check if it's the start of a commit log 168415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 168515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1686270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 168715662b3eSJoe Perches $in_header_lines = 0; 168815662b3eSJoe Perches $in_commit_log = 1; 168915662b3eSJoe Perches } 169015662b3eSJoe Perches 1691fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1692fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1693fa64205dSPasi Savanainen if ($in_header_lines && 1694fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1695fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1696fa64205dSPasi Savanainen $non_utf8_charset = 1; 1697fa64205dSPasi Savanainen } 1698fa64205dSPasi Savanainen 1699fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 170015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1701fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 170215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 170315662b3eSJoe Perches } 170415662b3eSJoe Perches 170530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 170630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 170700df344fSAndy Whitcroft 17080a920b5bSAndy Whitcroft#trailing whitespace 17099c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1710c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1711000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1712000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 17139c0ca6f9SAndy Whitcroft 1714c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1715c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1716000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1717000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1718d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17190a920b5bSAndy Whitcroft } 17205368df20SAndy Whitcroft 17213354957aSAndi Kleen# check for Kconfig help text having a real description 17229fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 17239fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 17243354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1725a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 17263354957aSAndi Kleen my $length = 0; 17279fe287d7SAndy Whitcroft my $cnt = $realcnt; 17289fe287d7SAndy Whitcroft my $ln = $linenr + 1; 17299fe287d7SAndy Whitcroft my $f; 1730a1385803SAndy Whitcroft my $is_start = 0; 17319fe287d7SAndy Whitcroft my $is_end = 0; 1732a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 17339fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 17349fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 17359fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 17369fe287d7SAndy Whitcroft 17379fe287d7SAndy Whitcroft next if ($f =~ /^-/); 1738a1385803SAndy Whitcroft 1739a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1740a1385803SAndy Whitcroft $is_start = 1; 1741a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1742a1385803SAndy Whitcroft $length = -1; 1743a1385803SAndy Whitcroft } 1744a1385803SAndy Whitcroft 17459fe287d7SAndy Whitcroft $f =~ s/^.//; 17463354957aSAndi Kleen $f =~ s/#.*//; 17473354957aSAndi Kleen $f =~ s/^\s+//; 17483354957aSAndi Kleen next if ($f =~ /^$/); 17499fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 17509fe287d7SAndy Whitcroft $is_end = 1; 17519fe287d7SAndy Whitcroft last; 17529fe287d7SAndy Whitcroft } 17533354957aSAndi Kleen $length++; 17543354957aSAndi Kleen } 1755000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1756a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 1757a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 17583354957aSAndi Kleen } 17593354957aSAndi Kleen 1760c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1761c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1762c68e5878SArnaud Lacombe my $flag = $1; 1763c68e5878SArnaud Lacombe my $replacement = { 1764c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1765c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1766c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1767c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1768c68e5878SArnaud Lacombe }; 1769c68e5878SArnaud Lacombe 1770c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1771c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1772c68e5878SArnaud Lacombe } 1773c68e5878SArnaud Lacombe 17745368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 17755368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 17765368df20SAndy Whitcroft 17770a920b5bSAndy Whitcroft#80 column limit 1778c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1779f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 17800fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 17818bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1782f4c014c0SAndy Whitcroft $length > 80) 1783c45dcabdSAndy Whitcroft { 1784000d1cc1SJoe Perches WARN("LONG_LINE", 1785000d1cc1SJoe Perches "line over 80 characters\n" . $herecurr); 17860a920b5bSAndy Whitcroft } 17870a920b5bSAndy Whitcroft 1788ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 1789ca56dc09SJosh Triplett# to grep for the string. Limited to strings used as parameters (those 1790ca56dc09SJosh Triplett# following an open parenthesis), which almost completely eliminates false 1791ca56dc09SJosh Triplett# positives, as well as warning only once per parameter rather than once per 1792ca56dc09SJosh Triplett# line of the string. Make an exception when the previous string ends in a 1793ca56dc09SJosh Triplett# newline (multiple lines in one string constant) or \n\t (common in inline 1794ca56dc09SJosh Triplett# assembly to indent the instruction on the following line). 1795ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 1796ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 1797ca56dc09SJosh Triplett $prevline =~ /\(/ && 1798ca56dc09SJosh Triplett $prevrawline !~ /\\n(?:\\t)*"\s*$/) { 1799ca56dc09SJosh Triplett WARN("SPLIT_STRING", 1800ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 1801ca56dc09SJosh Triplett } 1802ca56dc09SJosh Triplett 18035e79d96eSJoe Perches# check for spaces before a quoted newline 18045e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1805000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1806000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 18075e79d96eSJoe Perches } 18085e79d96eSJoe Perches 18098905a67cSAndy Whitcroft# check for adding lines without a newline. 18108905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1811000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1812000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 18138905a67cSAndy Whitcroft } 18148905a67cSAndy Whitcroft 181542e41c54SMike Frysinger# Blackfin: use hi/lo macros 181642e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 181742e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 181842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1819000d1cc1SJoe Perches ERROR("LO_MACRO", 1820000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 182142e41c54SMike Frysinger } 182242e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 182342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1824000d1cc1SJoe Perches ERROR("HI_MACRO", 1825000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 182642e41c54SMike Frysinger } 182742e41c54SMike Frysinger } 182842e41c54SMike Frysinger 1829b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1830b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 18310a920b5bSAndy Whitcroft 18320a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 18330a920b5bSAndy Whitcroft# more than 8 must use tabs. 1834c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1835c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1836c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1837000d1cc1SJoe Perches ERROR("CODE_INDENT", 1838000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1839d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 18400a920b5bSAndy Whitcroft } 18410a920b5bSAndy Whitcroft 184208e44365SAlberto Panizzo# check for space before tabs. 184308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 184408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1845000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1846000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 184708e44365SAlberto Panizzo } 184808e44365SAlberto Panizzo 1849d1fe9c09SJoe Perches# check for && or || at the start of a line 1850d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 1851d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 1852d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 1853d1fe9c09SJoe Perches } 1854d1fe9c09SJoe Perches 1855d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 1856d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 1857d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 1858d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 1859d1fe9c09SJoe Perches my $oldindent = $1; 1860d1fe9c09SJoe Perches my $rest = $2; 1861d1fe9c09SJoe Perches 1862d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 1863d1fe9c09SJoe Perches if ($pos >= 0) { 1864b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 1865b34a26f3SJoe Perches my $newindent = $2; 1866d1fe9c09SJoe Perches 1867d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 1868d1fe9c09SJoe Perches "\t" x ($pos / 8) . 1869d1fe9c09SJoe Perches " " x ($pos % 8); 1870d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 1871d1fe9c09SJoe Perches 1872d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 1873d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 1874d1fe9c09SJoe Perches CHK("PARENTHESIS_ALIGNMENT", 1875d1fe9c09SJoe Perches "Alignment should match open parenthesis\n" . $hereprev); 1876d1fe9c09SJoe Perches } 1877d1fe9c09SJoe Perches } 1878d1fe9c09SJoe Perches } 1879d1fe9c09SJoe Perches 1880aad4f614SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) { 1881aad4f614SJoe Perches CHK("SPACING", 1882aad4f614SJoe Perches "No space is necessary after a cast\n" . $hereprev); 1883aad4f614SJoe Perches } 1884aad4f614SJoe Perches 18855f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 18866b4c5bebSAndy Whitcroft# Exceptions: 18876b4c5bebSAndy Whitcroft# 1) within comments 18886b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 18896b4c5bebSAndy Whitcroft# 3) hanging labels 18906b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 18915f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1892000d1cc1SJoe Perches WARN("LEADING_SPACE", 1893000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 18945f7ddae6SRaffaele Recalcati } 18955f7ddae6SRaffaele Recalcati 1896b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1897b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1898b9ea10d6SAndy Whitcroft 1899c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1900cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1901000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1902000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1903c2fdda0dSAndy Whitcroft } 190422f2a2efSAndy Whitcroft 190542e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 190642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 190742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1908000d1cc1SJoe Perches ERROR("CSYNC", 1909000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 191042e41c54SMike Frysinger } 191142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 191242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1913000d1cc1SJoe Perches ERROR("SSYNC", 1914000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 191542e41c54SMike Frysinger } 191642e41c54SMike Frysinger 19179c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 19182b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 19192b474a1aSAndy Whitcroft $realline_next); 19203e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 19213e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 19223e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 1923170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1924f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1925171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1926171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1927171ae1a4SAndy Whitcroft 19283e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 19293e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 19303e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 19313e469cdcSAndy Whitcroft # until we hit end of it. 19323e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 19333e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 19343e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 19353e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 19363e469cdcSAndy Whitcroft } 1937f74bd194SAndy Whitcroft 19382b474a1aSAndy Whitcroft # Find the real next line. 19392b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 19402b474a1aSAndy Whitcroft if (defined $realline_next && 19412b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 19422b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 19432b474a1aSAndy Whitcroft $realline_next++; 19442b474a1aSAndy Whitcroft } 19452b474a1aSAndy Whitcroft 1946171ae1a4SAndy Whitcroft my $s = $stat; 1947171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1948cf655043SAndy Whitcroft 1949c2fdda0dSAndy Whitcroft # Ignore goto labels. 1950171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1951c2fdda0dSAndy Whitcroft 1952c2fdda0dSAndy Whitcroft # Ignore functions being called 1953171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1954c2fdda0dSAndy Whitcroft 1955463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1956463f2864SAndy Whitcroft 1957c45dcabdSAndy Whitcroft # declarations always start with types 1958d2506586SAndy 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) { 1959c45dcabdSAndy Whitcroft my $type = $1; 1960c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1961c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1962c45dcabdSAndy Whitcroft 19636c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1964a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1965c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1966c2fdda0dSAndy Whitcroft } 19678905a67cSAndy Whitcroft 19686c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 196965863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1970c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 19719c0ca6f9SAndy Whitcroft } 19728905a67cSAndy Whitcroft 19738905a67cSAndy Whitcroft # Check for any sort of function declaration. 19748905a67cSAndy Whitcroft # int foo(something bar, other baz); 19758905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1976171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 19778905a67cSAndy Whitcroft my ($name_len) = length($1); 19788905a67cSAndy Whitcroft 1979cf655043SAndy Whitcroft my $ctx = $s; 1980773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 19818905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1982cf655043SAndy Whitcroft 19838905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1984c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 19858905a67cSAndy Whitcroft 1986c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 19878905a67cSAndy Whitcroft } 19888905a67cSAndy Whitcroft } 19898905a67cSAndy Whitcroft } 19908905a67cSAndy Whitcroft 19919c0ca6f9SAndy Whitcroft } 19929c0ca6f9SAndy Whitcroft 199300df344fSAndy Whitcroft# 199400df344fSAndy Whitcroft# Checks which may be anchored in the context. 199500df344fSAndy Whitcroft# 199600df344fSAndy Whitcroft 199700df344fSAndy Whitcroft# Check for switch () and associated case and default 199800df344fSAndy Whitcroft# statements should be at the same indent. 199900df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 200000df344fSAndy Whitcroft my $err = ''; 200100df344fSAndy Whitcroft my $sep = ''; 200200df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 200300df344fSAndy Whitcroft shift(@ctx); 200400df344fSAndy Whitcroft for my $ctx (@ctx) { 200500df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 200600df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 200700df344fSAndy Whitcroft $indent != $cindent) { 200800df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 200900df344fSAndy Whitcroft $sep = ''; 201000df344fSAndy Whitcroft } else { 201100df344fSAndy Whitcroft $sep = "[...]\n"; 201200df344fSAndy Whitcroft } 201300df344fSAndy Whitcroft } 201400df344fSAndy Whitcroft if ($err ne '') { 2015000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2016000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2017de7d4f0eSAndy Whitcroft } 2018de7d4f0eSAndy Whitcroft } 2019de7d4f0eSAndy Whitcroft 2020de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2021de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2022c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2023773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2024773647a0SAndy Whitcroft 20259c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 20268eef05ddSJoe Perches 20278eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 20288eef05ddSJoe Perches WARN("DEEP_INDENTATION", 20298eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 20308eef05ddSJoe Perches } 20318eef05ddSJoe Perches 2032de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2033de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2034de7d4f0eSAndy Whitcroft 2035548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2036548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2037de7d4f0eSAndy Whitcroft 2038548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2039548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2040548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2041548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2042548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2043773647a0SAndy Whitcroft $ctx_ln++; 2044773647a0SAndy Whitcroft } 2045548596d5SAndy Whitcroft 204653210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 204753210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2048773647a0SAndy Whitcroft 2049773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2050000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2051000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 205201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 205300df344fSAndy Whitcroft } 2054773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2055773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2056773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2057773647a0SAndy Whitcroft { 20589c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 20599c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2060000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2061000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 206201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 20639c0ca6f9SAndy Whitcroft } 20649c0ca6f9SAndy Whitcroft } 206500df344fSAndy Whitcroft } 206600df344fSAndy Whitcroft 20674d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 20684d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 20693e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 20703e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 20713e469cdcSAndy Whitcroft if (!defined $stat); 20724d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 20734d001e4dSAndy Whitcroft 20744d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 20754d001e4dSAndy Whitcroft 20764d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 20774d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 20784d001e4dSAndy Whitcroft # where necessary. 20794d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 20804d001e4dSAndy Whitcroft 20814d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 20826f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 20836f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 20844d001e4dSAndy Whitcroft 20854d001e4dSAndy Whitcroft # We want to check the first line inside the block 20864d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 20874d001e4dSAndy Whitcroft # 1) any blank line termination 20884d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 20894d001e4dSAndy Whitcroft # 3) any do (...) { 20904d001e4dSAndy Whitcroft my $continuation = 0; 20914d001e4dSAndy Whitcroft my $check = 0; 20924d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 20934d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 20944d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 20954d001e4dSAndy Whitcroft $continuation = 1; 20964d001e4dSAndy Whitcroft } 20979bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 20984d001e4dSAndy Whitcroft $check = 1; 20994d001e4dSAndy Whitcroft $cond_lines++; 21004d001e4dSAndy Whitcroft } 21014d001e4dSAndy Whitcroft 21024d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 21034d001e4dSAndy Whitcroft # preprocessor statement. 21044d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 21054d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 21064d001e4dSAndy Whitcroft $check = 0; 21074d001e4dSAndy Whitcroft } 21084d001e4dSAndy Whitcroft 21099bd49efeSAndy Whitcroft my $cond_ptr = -1; 2110740504c6SAndy Whitcroft $continuation = 0; 21119bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 21129bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 21134d001e4dSAndy Whitcroft 2114f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2115f16fa28fSAndy Whitcroft # is not linear. 2116f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2117f16fa28fSAndy Whitcroft $check = 0; 2118f16fa28fSAndy Whitcroft } 2119f16fa28fSAndy Whitcroft 21209bd49efeSAndy Whitcroft # Ignore: 21219bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 21229bd49efeSAndy Whitcroft # 2) preprocessor lines, and 21239bd49efeSAndy Whitcroft # 3) labels. 2124740504c6SAndy Whitcroft if ($continuation || 2125740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 21269bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 21279bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2128740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 212930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 21309bd49efeSAndy Whitcroft $cond_lines++; 21319bd49efeSAndy Whitcroft } 21324d001e4dSAndy Whitcroft } 213330dad6ebSAndy Whitcroft } 21344d001e4dSAndy Whitcroft 21354d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 21364d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 21374d001e4dSAndy Whitcroft 21384d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 21394d001e4dSAndy Whitcroft # this is not this patch's fault. 21404d001e4dSAndy Whitcroft if (!defined($stat_real) || 21414d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 21424d001e4dSAndy Whitcroft $check = 0; 21434d001e4dSAndy Whitcroft } 21444d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 21454d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 21464d001e4dSAndy Whitcroft } 21474d001e4dSAndy Whitcroft 21489bd49efeSAndy 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"; 21494d001e4dSAndy Whitcroft 21504d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 21514d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2152000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2153000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 21544d001e4dSAndy Whitcroft } 21554d001e4dSAndy Whitcroft } 21564d001e4dSAndy Whitcroft 21576c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 21586c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 21591f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 21601f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 21616c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2162c2fdda0dSAndy Whitcroft if ($dbg_values) { 2163c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2164cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2165cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 21661f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2167c2fdda0dSAndy Whitcroft } 21686c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 21696c72ffaaSAndy Whitcroft 217000df344fSAndy Whitcroft#ignore lines not being added 217100df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 217200df344fSAndy Whitcroft 2173653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 21747429c690SAndy Whitcroft if ($dbg_type) { 21757429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2176000d1cc1SJoe Perches ERROR("TEST_TYPE", 2177000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 21787429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2179000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2180000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 21817429c690SAndy Whitcroft } 2182653d4876SAndy Whitcroft next; 2183653d4876SAndy Whitcroft } 2184a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2185a1ef277eSAndy Whitcroft if ($dbg_attr) { 21869360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2187000d1cc1SJoe Perches ERROR("TEST_ATTR", 2188000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 21899360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2190000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2191000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2192a1ef277eSAndy Whitcroft } 2193a1ef277eSAndy Whitcroft next; 2194a1ef277eSAndy Whitcroft } 2195653d4876SAndy Whitcroft 2196f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 219799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 219899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2199000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2200000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2201f0a594c1SAndy Whitcroft } 2202f0a594c1SAndy Whitcroft 220300df344fSAndy Whitcroft# 220400df344fSAndy Whitcroft# Checks which are anchored on the added line. 220500df344fSAndy Whitcroft# 220600df344fSAndy Whitcroft 2207653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2208c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2209653d4876SAndy Whitcroft my $path = $1; 2210653d4876SAndy Whitcroft if ($path =~ m{//}) { 2211000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2212000d1cc1SJoe Perches "malformed #include filename\n" . 2213de7d4f0eSAndy Whitcroft $herecurr); 2214653d4876SAndy Whitcroft } 2215653d4876SAndy Whitcroft } 2216653d4876SAndy Whitcroft 221700df344fSAndy Whitcroft# no C99 // comments 221800df344fSAndy Whitcroft if ($line =~ m{//}) { 2219000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2220000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 222100df344fSAndy Whitcroft } 222200df344fSAndy Whitcroft # Remove C99 comments. 22230a920b5bSAndy Whitcroft $line =~ s@//.*@@; 22246c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 22250a920b5bSAndy Whitcroft 22262b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 22272b474a1aSAndy Whitcroft# the whole statement. 22282b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 22292b474a1aSAndy Whitcroft if (defined $realline_next && 22302b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 22312b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 22322b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22332b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22343cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 22353cbf62dfSAndy Whitcroft # a prefix: 22363cbf62dfSAndy Whitcroft # XXX(foo); 22373cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2238653d4876SAndy Whitcroft my $name = $1; 223987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 22403cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 22413cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 22423cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 22433cbf62dfSAndy Whitcroft 22443cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 22452b474a1aSAndy Whitcroft \n.}\s*$| 224648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 224748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 224848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 22492b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 22502b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 225148012058SAndy Whitcroft )/x) { 22522b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 22532b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 22542b474a1aSAndy Whitcroft } else { 22552b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 22560a920b5bSAndy Whitcroft } 22570a920b5bSAndy Whitcroft } 22582b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 22592b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 22602b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22612b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22622b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 22632b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 22642b474a1aSAndy Whitcroft } 22652b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 22662b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2267000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2268000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 22692b474a1aSAndy Whitcroft } 22700a920b5bSAndy Whitcroft 22715150bda4SJoe Eloff# check for global initialisers. 2272c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2273000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2274000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2275f0a594c1SAndy Whitcroft $herecurr); 2276f0a594c1SAndy Whitcroft } 22770a920b5bSAndy Whitcroft# check for static initialisers. 22782d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2279000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2280000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2281de7d4f0eSAndy Whitcroft $herecurr); 22820a920b5bSAndy Whitcroft } 22830a920b5bSAndy Whitcroft 2284cb710ecaSJoe Perches# check for static const char * arrays. 2285cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2286000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2287000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2288cb710ecaSJoe Perches $herecurr); 2289cb710ecaSJoe Perches } 2290cb710ecaSJoe Perches 2291cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2292cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2293000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2294000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2295cb710ecaSJoe Perches $herecurr); 2296cb710ecaSJoe Perches } 2297cb710ecaSJoe Perches 229893ed0e2dSJoe Perches# check for declarations of struct pci_device_id 229993ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2300000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2301000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 230293ed0e2dSJoe Perches } 230393ed0e2dSJoe Perches 2304653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2305653d4876SAndy Whitcroft# make sense. 2306653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 23078054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2308c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 23098ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2310653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2311000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2312000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 23130a920b5bSAndy Whitcroft } 23140a920b5bSAndy Whitcroft 23150a920b5bSAndy Whitcroft# * goes on variable not on type 231665863862SAndy Whitcroft # (char*[ const]) 2317bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2318bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 2319bfcb2cc7SAndy Whitcroft my ($from, $to) = ($2, $2); 2320d8aaf121SAndy Whitcroft 232165863862SAndy Whitcroft # Should start with a space. 232265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 232365863862SAndy Whitcroft # Should not end with a space. 232465863862SAndy Whitcroft $to =~ s/\s+$//; 232565863862SAndy Whitcroft # '*'s should not have spaces between. 2326f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 232765863862SAndy Whitcroft } 2328d8aaf121SAndy Whitcroft 232965863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 233065863862SAndy Whitcroft if ($from ne $to) { 2331000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2332000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 233365863862SAndy Whitcroft } 2334bfcb2cc7SAndy Whitcroft } 2335bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2336bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 2337bfcb2cc7SAndy Whitcroft my ($from, $to, $ident) = ($2, $2, $3); 2338d8aaf121SAndy Whitcroft 233965863862SAndy Whitcroft # Should start with a space. 234065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 234165863862SAndy Whitcroft # Should not end with a space. 234265863862SAndy Whitcroft $to =~ s/\s+$//; 234365863862SAndy Whitcroft # '*'s should not have spaces between. 2344f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 234565863862SAndy Whitcroft } 234665863862SAndy Whitcroft # Modifiers should have spaces. 234765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 234865863862SAndy Whitcroft 2349667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2350667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2351000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2352000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 235365863862SAndy Whitcroft } 23540a920b5bSAndy Whitcroft } 23550a920b5bSAndy Whitcroft 23560a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 23570a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 23580a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 23590a920b5bSAndy Whitcroft# print "$herecurr"; 23600a920b5bSAndy Whitcroft# $clean = 0; 23610a920b5bSAndy Whitcroft# } 23620a920b5bSAndy Whitcroft 23638905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2364000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2365000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 23668905a67cSAndy Whitcroft } 23678905a67cSAndy Whitcroft 236817441227SJoe Perches# check for uses of printk_ratelimit 236917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2370000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2371000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 237217441227SJoe Perches } 237317441227SJoe Perches 237400df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 237500df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 237600df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 237725985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 237800df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2379f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 238000df344fSAndy Whitcroft my $ok = 0; 238100df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 238200df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 238325985edcSLucas De Marchi # we have a preceding printk if it ends 238400df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 238500df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 238600df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 238700df344fSAndy Whitcroft $ok = 1; 238800df344fSAndy Whitcroft } 238900df344fSAndy Whitcroft last; 239000df344fSAndy Whitcroft } 239100df344fSAndy Whitcroft } 239200df344fSAndy Whitcroft if ($ok == 0) { 2393000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2394000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 23950a920b5bSAndy Whitcroft } 239600df344fSAndy Whitcroft } 23970a920b5bSAndy Whitcroft 2398243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2399243f3803SJoe Perches my $orig = $1; 2400243f3803SJoe Perches my $level = lc($orig); 2401243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 2402*8f26b837SJoe Perches my $level2 = $level; 2403*8f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2404243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2405*8f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2406243f3803SJoe Perches } 2407243f3803SJoe Perches 2408243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2409243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2410243f3803SJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); 2411243f3803SJoe Perches } 2412243f3803SJoe Perches 2413653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2414653d4876SAndy Whitcroft# or if closed on same line 2415c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2416c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2417000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2418000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 24190a920b5bSAndy Whitcroft } 2420653d4876SAndy Whitcroft 24218905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 24228905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 24238905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2424000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2425000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 24268905a67cSAndy Whitcroft } 24278905a67cSAndy Whitcroft 24280c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 24290c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2430000d1cc1SJoe Perches WARN("SPACING", 2431000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 24320c73b4ebSAndy Whitcroft } 24330c73b4ebSAndy Whitcroft 24348d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 24358d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2436fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2437fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 24388d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 24398d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 24408d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2441fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2442daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 2443000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2444000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 24458d31cfceSAndy Whitcroft } 24468d31cfceSAndy Whitcroft } 24478d31cfceSAndy Whitcroft 2448f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 24496c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2450c2fdda0dSAndy Whitcroft my $name = $1; 2451773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2452773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2453c2fdda0dSAndy Whitcroft 2454c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2455773647a0SAndy Whitcroft if ($name =~ /^(?: 2456773647a0SAndy Whitcroft if|for|while|switch|return|case| 2457773647a0SAndy Whitcroft volatile|__volatile__| 2458773647a0SAndy Whitcroft __attribute__|format|__extension__| 2459773647a0SAndy Whitcroft asm|__asm__)$/x) 2460773647a0SAndy Whitcroft { 2461c2fdda0dSAndy Whitcroft 2462c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2463c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2464c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2465c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2466773647a0SAndy Whitcroft 2467773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2468c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2469c2fdda0dSAndy Whitcroft 2470c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2471c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2472773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2473c2fdda0dSAndy Whitcroft 2474c2fdda0dSAndy Whitcroft } else { 2475000d1cc1SJoe Perches WARN("SPACING", 2476000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2477f0a594c1SAndy Whitcroft } 24786c72ffaaSAndy Whitcroft } 24799a4cad4eSEric Nelson 24809a4cad4eSEric Nelson# check for whitespace before a non-naked semicolon 24819a4cad4eSEric Nelson if ($line =~ /^\+.*\S\s+;/) { 24829a4cad4eSEric Nelson CHK("SPACING", 24839a4cad4eSEric Nelson "space prohibited before semicolon\n" . $herecurr); 24849a4cad4eSEric Nelson } 24859a4cad4eSEric Nelson 2486653d4876SAndy Whitcroft# Check operator spacing. 24870a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 24889c0ca6f9SAndy Whitcroft my $ops = qr{ 24899c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 24909c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 24919c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 24921f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 24931f65f947SAndy Whitcroft \?|: 24949c0ca6f9SAndy Whitcroft }x; 2495cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 249600df344fSAndy Whitcroft my $off = 0; 24976c72ffaaSAndy Whitcroft 24986c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 24996c72ffaaSAndy Whitcroft 25000a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 25014a0df2efSAndy Whitcroft $off += length($elements[$n]); 25024a0df2efSAndy Whitcroft 250325985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2504773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2505773647a0SAndy Whitcroft my $cc = ''; 2506773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2507773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2508773647a0SAndy Whitcroft } 2509773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2510773647a0SAndy Whitcroft 25114a0df2efSAndy Whitcroft my $a = ''; 25124a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 25134a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2514cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 25154a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 25164a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2517773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 25184a0df2efSAndy Whitcroft 25190a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 25204a0df2efSAndy Whitcroft 25214a0df2efSAndy Whitcroft my $c = ''; 25220a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 25234a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 25244a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2525cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 25264a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 25274a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 25288b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 25294a0df2efSAndy Whitcroft } else { 25304a0df2efSAndy Whitcroft $c = 'E'; 25310a920b5bSAndy Whitcroft } 25320a920b5bSAndy Whitcroft 25334a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 25344a0df2efSAndy Whitcroft 25354a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 25364a0df2efSAndy Whitcroft 25376c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2538de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 25390a920b5bSAndy Whitcroft 254074048ed8SAndy Whitcroft # Pull out the value of this operator. 25416c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 25420a920b5bSAndy Whitcroft 25431f65f947SAndy Whitcroft # Get the full operator variant. 25441f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 25451f65f947SAndy Whitcroft 254613214adfSAndy Whitcroft # Ignore operators passed as parameters. 254713214adfSAndy Whitcroft if ($op_type ne 'V' && 254813214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 254913214adfSAndy Whitcroft 2550cf655043SAndy Whitcroft# # Ignore comments 2551cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 255213214adfSAndy Whitcroft 2553d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 255413214adfSAndy Whitcroft } elsif ($op eq ';') { 2555cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2556cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2557000d1cc1SJoe Perches ERROR("SPACING", 2558000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2559d8aaf121SAndy Whitcroft } 2560d8aaf121SAndy Whitcroft 2561d8aaf121SAndy Whitcroft # // is a comment 2562d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 25630a920b5bSAndy Whitcroft 25641f65f947SAndy Whitcroft # No spaces for: 25651f65f947SAndy Whitcroft # -> 25661f65f947SAndy Whitcroft # : when part of a bitfield 25671f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 25684a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2569000d1cc1SJoe Perches ERROR("SPACING", 2570000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 25710a920b5bSAndy Whitcroft } 25720a920b5bSAndy Whitcroft 25730a920b5bSAndy Whitcroft # , must have a space on the right. 25740a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2575cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2576000d1cc1SJoe Perches ERROR("SPACING", 2577000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 25780a920b5bSAndy Whitcroft } 25790a920b5bSAndy Whitcroft 25809c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 258174048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 25829c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 25839c0ca6f9SAndy Whitcroft 25849c0ca6f9SAndy Whitcroft # unary operators should have a space before and 25859c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 25869c0ca6f9SAndy Whitcroft # unary operator, or a cast 25879c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 258874048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 25890d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2590cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2591000d1cc1SJoe Perches ERROR("SPACING", 2592000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 25930a920b5bSAndy Whitcroft } 2594a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2595171ae1a4SAndy Whitcroft # A unary '*' may be const 2596171ae1a4SAndy Whitcroft 2597171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2598000d1cc1SJoe Perches ERROR("SPACING", 2599000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 26000a920b5bSAndy Whitcroft } 26010a920b5bSAndy Whitcroft 26020a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 26030a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2604773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2605000d1cc1SJoe Perches ERROR("SPACING", 2606000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 26070a920b5bSAndy Whitcroft } 2608773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2609773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2610000d1cc1SJoe Perches ERROR("SPACING", 2611000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2612653d4876SAndy Whitcroft } 2613773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2614000d1cc1SJoe Perches ERROR("SPACING", 2615000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2616773647a0SAndy Whitcroft } 2617773647a0SAndy Whitcroft 26180a920b5bSAndy Whitcroft 26190a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 26209c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 26219c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 26229c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2623c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2624c2fdda0dSAndy Whitcroft $op eq '%') 26250a920b5bSAndy Whitcroft { 2626773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2627000d1cc1SJoe Perches ERROR("SPACING", 2628000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2629de7d4f0eSAndy Whitcroft $hereptr); 26300a920b5bSAndy Whitcroft } 26310a920b5bSAndy Whitcroft 26321f65f947SAndy Whitcroft # A colon needs no spaces before when it is 26331f65f947SAndy Whitcroft # terminating a case value or a label. 26341f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 26351f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2636000d1cc1SJoe Perches ERROR("SPACING", 2637000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 26381f65f947SAndy Whitcroft } 26391f65f947SAndy Whitcroft 26400a920b5bSAndy Whitcroft # All the others need spaces both sides. 2641cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 26421f65f947SAndy Whitcroft my $ok = 0; 26431f65f947SAndy Whitcroft 264422f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 26451f65f947SAndy Whitcroft if (($op eq '<' && 26461f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 26471f65f947SAndy Whitcroft ($op eq '>' && 26481f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 26491f65f947SAndy Whitcroft { 26501f65f947SAndy Whitcroft $ok = 1; 26511f65f947SAndy Whitcroft } 26521f65f947SAndy Whitcroft 26531f65f947SAndy Whitcroft # Ignore ?: 26541f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 26551f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 26561f65f947SAndy Whitcroft $ok = 1; 26571f65f947SAndy Whitcroft } 26581f65f947SAndy Whitcroft 26591f65f947SAndy Whitcroft if ($ok == 0) { 2660000d1cc1SJoe Perches ERROR("SPACING", 2661000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 26620a920b5bSAndy Whitcroft } 266322f2a2efSAndy Whitcroft } 26644a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 26650a920b5bSAndy Whitcroft } 26660a920b5bSAndy Whitcroft } 26670a920b5bSAndy Whitcroft 2668f0a594c1SAndy Whitcroft# check for multiple assignments 2669f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2670000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2671000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2672f0a594c1SAndy Whitcroft } 2673f0a594c1SAndy Whitcroft 267422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 267522f2a2efSAndy Whitcroft## # continuation. 267622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 267722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 267822f2a2efSAndy Whitcroft## 267922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 268022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 268122f2a2efSAndy Whitcroft## my $ln = $line; 268222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 268322f2a2efSAndy Whitcroft## } 268422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2685000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2686000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 268722f2a2efSAndy Whitcroft## } 268822f2a2efSAndy Whitcroft## } 2689f0a594c1SAndy Whitcroft 26900a920b5bSAndy Whitcroft#need space before brace following if, while, etc 269122f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 269222f2a2efSAndy Whitcroft $line =~ /do{/) { 2693000d1cc1SJoe Perches ERROR("SPACING", 2694000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2695de7d4f0eSAndy Whitcroft } 2696de7d4f0eSAndy Whitcroft 2697de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2698de7d4f0eSAndy Whitcroft# on the line 2699de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2700000d1cc1SJoe Perches ERROR("SPACING", 2701000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 27020a920b5bSAndy Whitcroft } 27030a920b5bSAndy Whitcroft 270422f2a2efSAndy Whitcroft# check spacing on square brackets 270522f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2706000d1cc1SJoe Perches ERROR("SPACING", 2707000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 270822f2a2efSAndy Whitcroft } 270922f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2710000d1cc1SJoe Perches ERROR("SPACING", 2711000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 271222f2a2efSAndy Whitcroft } 271322f2a2efSAndy Whitcroft 2714c45dcabdSAndy Whitcroft# check spacing on parentheses 27159c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 27169c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2717000d1cc1SJoe Perches ERROR("SPACING", 2718000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 271922f2a2efSAndy Whitcroft } 272013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2721c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2722c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2723000d1cc1SJoe Perches ERROR("SPACING", 2724000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 272522f2a2efSAndy Whitcroft } 272622f2a2efSAndy Whitcroft 27270a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 27284a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 27290a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2730000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2731000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 27320a920b5bSAndy Whitcroft } 27330a920b5bSAndy Whitcroft 2734c45dcabdSAndy Whitcroft# Return is not a function. 2735c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2736c45dcabdSAndy Whitcroft my $spacing = $1; 2737c45dcabdSAndy Whitcroft my $value = $2; 2738c45dcabdSAndy Whitcroft 273986f9d059SAndy Whitcroft # Flatten any parentheses 2740fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2741fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 2742e01886adSAndy Whitcroft while ($value =~ s/\[[^\[\]]*\]/1/ || 274363f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 274463f17f89SAndy Whitcroft $Compare\s* 274563f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 274663f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2747c45dcabdSAndy Whitcroft } 2748fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2749fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2750000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2751000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2752c45dcabdSAndy Whitcroft 2753c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2754000d1cc1SJoe Perches ERROR("SPACING", 2755000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2756c45dcabdSAndy Whitcroft } 2757c45dcabdSAndy Whitcroft } 275853a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 275953a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 276053a3c448SAndy Whitcroft my $name = $1; 276153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2762000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2763000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 276453a3c448SAndy Whitcroft } 276553a3c448SAndy Whitcroft } 2766c45dcabdSAndy Whitcroft 27670a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 27684a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2769000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 27700a920b5bSAndy Whitcroft } 27710a920b5bSAndy Whitcroft 2772f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2773f5fe35ddSAndy Whitcroft# statements after the conditional. 2774170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 27753e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 27763e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 27773e469cdcSAndy Whitcroft if (!defined $stat); 2778170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2779170d3a22SAndy Whitcroft $remain_next, $off_next); 2780170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2781170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2782170d3a22SAndy Whitcroft 2783170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2784170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2785170d3a22SAndy Whitcroft # then count those as offsets. 2786170d3a22SAndy Whitcroft my ($whitespace) = 2787170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2788170d3a22SAndy Whitcroft my $offset = 2789170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2790170d3a22SAndy Whitcroft 2791170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2792170d3a22SAndy Whitcroft $offset} = 1; 2793170d3a22SAndy Whitcroft } 2794170d3a22SAndy Whitcroft } 2795170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2796170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2797171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 27988905a67cSAndy Whitcroft 2799b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2800000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2801000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 28028905a67cSAndy Whitcroft } 28038905a67cSAndy Whitcroft 28048905a67cSAndy Whitcroft # Find out what is on the end of the line after the 28058905a67cSAndy Whitcroft # conditional. 2806773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 28078905a67cSAndy Whitcroft $s =~ s/\n.*//g; 280813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 280953210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 281053210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2811773647a0SAndy Whitcroft { 2812bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2813bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2814bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 281542bdf74cSHidetoshi Seto my $stat_real = ''; 2816bb44ad39SAndy Whitcroft 281742bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 281842bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2819bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2820bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2821bb44ad39SAndy Whitcroft } 2822bb44ad39SAndy Whitcroft 2823000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2824000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 28258905a67cSAndy Whitcroft } 28268905a67cSAndy Whitcroft } 28278905a67cSAndy Whitcroft 282813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 282913214adfSAndy Whitcroft if ($line =~ / 283013214adfSAndy Whitcroft (?: 283113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 283213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 283313214adfSAndy Whitcroft (?:\&\&|\|\|) 283413214adfSAndy Whitcroft | 283513214adfSAndy Whitcroft (?:\&\&|\|\|) 283613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 283713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 283813214adfSAndy Whitcroft )/x) 283913214adfSAndy Whitcroft { 2840000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2841000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 284213214adfSAndy Whitcroft } 284313214adfSAndy Whitcroft 28448905a67cSAndy Whitcroft# if and else should not have general statements after it 284513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 284613214adfSAndy Whitcroft my $s = $1; 284713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 284813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2849000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2850000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 28510a920b5bSAndy Whitcroft } 285213214adfSAndy Whitcroft } 285339667782SAndy Whitcroft# if should not continue a brace 285439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2855000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2856000d1cc1SJoe Perches "trailing statements should be on next line\n" . 285739667782SAndy Whitcroft $herecurr); 285839667782SAndy Whitcroft } 2859a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2860a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2861a1080bf8SAndy Whitcroft $line !~ /\G(?: 28623fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2863a1080bf8SAndy Whitcroft \s*return\s+ 2864a1080bf8SAndy Whitcroft )/xg) 2865a1080bf8SAndy Whitcroft { 2866000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2867000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2868a1080bf8SAndy Whitcroft } 28690a920b5bSAndy Whitcroft 28700a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 28710a920b5bSAndy Whitcroft # indent level to be relevant to each other. 28720a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 28730a920b5bSAndy Whitcroft $previndent == $indent) { 2874000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2875000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 28760a920b5bSAndy Whitcroft } 28770a920b5bSAndy Whitcroft 2878c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2879c2fdda0dSAndy Whitcroft $previndent == $indent) { 2880c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2881c2fdda0dSAndy Whitcroft 2882c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2883c2fdda0dSAndy Whitcroft # conditional. 2884773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2885c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2886c2fdda0dSAndy Whitcroft 2887c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2888000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2889000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2890c2fdda0dSAndy Whitcroft } 2891c2fdda0dSAndy Whitcroft } 2892c2fdda0dSAndy Whitcroft 28930a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 28940a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 28950a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 28960a920b5bSAndy Whitcroft# print "$herecurr"; 28970a920b5bSAndy Whitcroft# $clean = 0; 28980a920b5bSAndy Whitcroft# } 28990a920b5bSAndy Whitcroft 29000a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2901c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2902000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2903000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 29040a920b5bSAndy Whitcroft } 29050a920b5bSAndy Whitcroft 2906653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2907c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2908e09dec48SAndy Whitcroft my $file = "$1.h"; 2909e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2910e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2911e09dec48SAndy Whitcroft $realfile ne $checkfile && 29127840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2913c45dcabdSAndy Whitcroft { 2914e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2915000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2916000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2917e09dec48SAndy Whitcroft } else { 2918000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2919000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2920e09dec48SAndy Whitcroft } 29210a920b5bSAndy Whitcroft } 29220a920b5bSAndy Whitcroft } 29230a920b5bSAndy Whitcroft 2924653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2925653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2926cf655043SAndy Whitcroft# in a known good container 2927b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2928b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2929d8aaf121SAndy Whitcroft my $ln = $linenr; 2930d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2931c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2932c45dcabdSAndy Whitcroft my $ctx = ''; 2933c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2934f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2935f74bd194SAndy Whitcroft $ctx = $dstat; 2936c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2937a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2938c45dcabdSAndy Whitcroft 2939f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2940292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2941c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2942c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2943c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2944c45dcabdSAndy Whitcroft 2945c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2946bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2947bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2948c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 2949bf30d6edSAndy Whitcroft { 2950c45dcabdSAndy Whitcroft } 2951c45dcabdSAndy Whitcroft 2952e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 2953e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 2954e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 2955e45bab8eSAndy Whitcroft { 2956e45bab8eSAndy Whitcroft } 2957e45bab8eSAndy Whitcroft 2958c45dcabdSAndy Whitcroft my $exceptions = qr{ 2959c45dcabdSAndy Whitcroft $Declare| 2960c45dcabdSAndy Whitcroft module_param_named| 2961c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2962c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2963c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2964383099fdSAndy Whitcroft __typeof__\(| 296522fd2d3eSStefani Seibold union| 296622fd2d3eSStefani Seibold struct| 2967ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2968ea71a0a0SAndy Whitcroft ^\"|\"$ 2969c45dcabdSAndy Whitcroft }x; 29705eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2971f74bd194SAndy Whitcroft if ($dstat ne '' && 2972f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 2973f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 2974fd1b57acSAndy Whitcroft $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo 2975b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 2976f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 2977f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 297872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 2979f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 2980f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 2981f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 2982f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 2983c45dcabdSAndy Whitcroft { 2984f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 2985f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 2986f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 2987f74bd194SAndy Whitcroft 2988f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 2989f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 2990c45dcabdSAndy Whitcroft } 2991c45dcabdSAndy Whitcroft 2992f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 2993f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 2994f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 2995f74bd194SAndy Whitcroft } else { 2996000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 2997f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 2998d8aaf121SAndy Whitcroft } 29990a920b5bSAndy Whitcroft } 3000653d4876SAndy Whitcroft } 30010a920b5bSAndy Whitcroft 3002b13edf7fSJoe Perches# do {} while (0) macro tests: 3003b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3004b13edf7fSJoe Perches# macro should not end with a semicolon 3005b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3006b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3007b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3008b13edf7fSJoe Perches my $ln = $linenr; 3009b13edf7fSJoe Perches my $cnt = $realcnt; 3010b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3011b13edf7fSJoe Perches my $ctx = ''; 3012b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3013b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3014b13edf7fSJoe Perches $ctx = $dstat; 3015b13edf7fSJoe Perches 3016b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3017b13edf7fSJoe Perches 3018b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3019b13edf7fSJoe Perches my $stmts = $2; 3020b13edf7fSJoe Perches my $semis = $3; 3021b13edf7fSJoe Perches 3022b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3023b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3024b13edf7fSJoe Perches my $herectx = $here . "\n"; 3025b13edf7fSJoe Perches 3026b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3027b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3028b13edf7fSJoe Perches } 3029b13edf7fSJoe Perches 3030ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3031ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3032b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3033b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3034b13edf7fSJoe Perches } 3035b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3036b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3037b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3038b13edf7fSJoe Perches } 3039b13edf7fSJoe Perches } 3040b13edf7fSJoe Perches } 3041b13edf7fSJoe Perches 3042080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3043080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3044080ba929SMike Frysinger# . 3045080ba929SMike Frysinger# ALIGN(...) 3046080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3047080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3048000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3049000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3050080ba929SMike Frysinger } 3051080ba929SMike Frysinger 3052f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 305313214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 305413214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3055cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 305613214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3057cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3058cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3059aad4f614SJoe Perches my @allowed = (); 3060aad4f614SJoe Perches my $allow = 0; 306113214adfSAndy Whitcroft my $seen = 0; 3062773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3063cf655043SAndy Whitcroft my $ln = $linenr - 1; 306413214adfSAndy Whitcroft for my $chunk (@chunks) { 306513214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 306613214adfSAndy Whitcroft 3067773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3068773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3069773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3070773647a0SAndy Whitcroft 3071aad4f614SJoe Perches $allowed[$allow] = 0; 3072773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3073773647a0SAndy Whitcroft 3074773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3075773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3076773647a0SAndy Whitcroft 3077773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3078cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3079cf655043SAndy Whitcroft 3080773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 308113214adfSAndy Whitcroft 308213214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 308313214adfSAndy Whitcroft 3084aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3085cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3086cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3087aad4f614SJoe Perches $allowed[$allow] = 1; 308813214adfSAndy Whitcroft } 308913214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3090cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3091aad4f614SJoe Perches $allowed[$allow] = 1; 309213214adfSAndy Whitcroft } 3093cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3094cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3095aad4f614SJoe Perches $allowed[$allow] = 1; 309613214adfSAndy Whitcroft } 3097aad4f614SJoe Perches $allow++; 309813214adfSAndy Whitcroft } 3099aad4f614SJoe Perches if ($seen) { 3100aad4f614SJoe Perches my $sum_allowed = 0; 3101aad4f614SJoe Perches foreach (@allowed) { 3102aad4f614SJoe Perches $sum_allowed += $_; 3103aad4f614SJoe Perches } 3104aad4f614SJoe Perches if ($sum_allowed == 0) { 3105000d1cc1SJoe Perches WARN("BRACES", 3106000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3107aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3108aad4f614SJoe Perches $seen != $allow) { 3109aad4f614SJoe Perches CHK("BRACES", 3110aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3111aad4f614SJoe Perches } 311213214adfSAndy Whitcroft } 311313214adfSAndy Whitcroft } 311413214adfSAndy Whitcroft } 3115773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 311613214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3117cf655043SAndy Whitcroft my $allowed = 0; 3118f0a594c1SAndy Whitcroft 3119cf655043SAndy Whitcroft # Check the pre-context. 3120cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3121cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3122cf655043SAndy Whitcroft $allowed = 1; 3123f0a594c1SAndy Whitcroft } 3124773647a0SAndy Whitcroft 3125773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3126773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3127773647a0SAndy Whitcroft 3128cf655043SAndy Whitcroft # Check the condition. 3129cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3130773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3131cf655043SAndy Whitcroft if (defined $cond) { 3132773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3133cf655043SAndy Whitcroft } 3134cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3135cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3136cf655043SAndy Whitcroft $allowed = 1; 3137cf655043SAndy Whitcroft } 3138cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3139cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3140cf655043SAndy Whitcroft $allowed = 1; 3141cf655043SAndy Whitcroft } 3142cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3143cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3144cf655043SAndy Whitcroft $allowed = 1; 3145cf655043SAndy Whitcroft } 3146cf655043SAndy Whitcroft # Check the post-context. 3147cf655043SAndy Whitcroft if (defined $chunks[1]) { 3148cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3149cf655043SAndy Whitcroft if (defined $cond) { 3150773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3151cf655043SAndy Whitcroft } 3152cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3153cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3154cf655043SAndy Whitcroft $allowed = 1; 3155cf655043SAndy Whitcroft } 3156cf655043SAndy Whitcroft } 3157cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 315869932487SJustin P. Mattock my $herectx = $here . "\n"; 3159f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3160cf655043SAndy Whitcroft 3161f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 316269932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3163cf655043SAndy Whitcroft } 3164cf655043SAndy Whitcroft 3165000d1cc1SJoe Perches WARN("BRACES", 3166000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3167f0a594c1SAndy Whitcroft } 3168f0a594c1SAndy Whitcroft } 3169f0a594c1SAndy Whitcroft 3170653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 31714a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 3172c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 3173000d1cc1SJoe Perches ERROR("DEPRECATED_INCLUDE", 3174000d1cc1SJoe Perches "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 31750a920b5bSAndy Whitcroft } 31760a920b5bSAndy Whitcroft } 31770a920b5bSAndy Whitcroft 31784a0df2efSAndy Whitcroft# don't use deprecated functions 31794a0df2efSAndy Whitcroft for my $func (@dep_functions) { 318000df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 3181000d1cc1SJoe Perches ERROR("DEPRECATED_FUNCTION", 3182000d1cc1SJoe Perches "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 31834a0df2efSAndy Whitcroft } 31844a0df2efSAndy Whitcroft } 31854a0df2efSAndy Whitcroft 31864a0df2efSAndy Whitcroft# no volatiles please 31876c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 31886c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3189000d1cc1SJoe Perches WARN("VOLATILE", 3190000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 31914a0df2efSAndy Whitcroft } 31924a0df2efSAndy Whitcroft 319300df344fSAndy Whitcroft# warn about #if 0 3194c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3195000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3196000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3197de7d4f0eSAndy Whitcroft $herecurr); 31984a0df2efSAndy Whitcroft } 31994a0df2efSAndy Whitcroft 3200f0a594c1SAndy Whitcroft# check for needless kfree() checks 3201f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3202f0a594c1SAndy Whitcroft my $expr = $1; 3203f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 3204000d1cc1SJoe Perches WARN("NEEDLESS_KFREE", 3205000d1cc1SJoe Perches "kfree(NULL) is safe this check is probably not required\n" . $hereprev); 3206f0a594c1SAndy Whitcroft } 3207f0a594c1SAndy Whitcroft } 32084c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 32094c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 32104c432a8fSGreg Kroah-Hartman my $expr = $1; 32114c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 3212000d1cc1SJoe Perches WARN("NEEDLESS_USB_FREE_URB", 3213000d1cc1SJoe Perches "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 32144c432a8fSGreg Kroah-Hartman } 32154c432a8fSGreg Kroah-Hartman } 3216f0a594c1SAndy Whitcroft 32171a15a250SPatrick Pannuto# prefer usleep_range over udelay 32181a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 32191a15a250SPatrick Pannuto # ignore udelay's < 10, however 32201a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3221000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3222000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 32231a15a250SPatrick Pannuto } 32241a15a250SPatrick Pannuto } 32251a15a250SPatrick Pannuto 322609ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 322709ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 322809ef8725SPatrick Pannuto if ($1 < 20) { 3229000d1cc1SJoe Perches WARN("MSLEEP", 3230000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 323109ef8725SPatrick Pannuto } 323209ef8725SPatrick Pannuto } 323309ef8725SPatrick Pannuto 323400df344fSAndy Whitcroft# warn about #ifdefs in C files 3235c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 323600df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 323700df344fSAndy Whitcroft# print "$herecurr"; 323800df344fSAndy Whitcroft# $clean = 0; 323900df344fSAndy Whitcroft# } 324000df344fSAndy Whitcroft 324122f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3242c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3243000d1cc1SJoe Perches ERROR("SPACING", 3244000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 324522f2a2efSAndy Whitcroft } 324622f2a2efSAndy Whitcroft 32474a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3248171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3249171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 32504a0df2efSAndy Whitcroft my $which = $1; 32514a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3252000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3253000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 32544a0df2efSAndy Whitcroft } 32554a0df2efSAndy Whitcroft } 32564a0df2efSAndy Whitcroft# check for memory barriers without a comment. 32574a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 32584a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3259000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3260000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 32614a0df2efSAndy Whitcroft } 32624a0df2efSAndy Whitcroft } 32634a0df2efSAndy Whitcroft# check of hardware specific defines 3264c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3265000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3266000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 32670a920b5bSAndy Whitcroft } 3268653d4876SAndy Whitcroft 3269d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3270d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3271000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3272000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3273d4977c78STobias Klauser } 3274d4977c78STobias Klauser 3275de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3276de7d4f0eSAndy Whitcroft# storage class and type. 32779c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 32789c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3279000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3280000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3281de7d4f0eSAndy Whitcroft } 3282de7d4f0eSAndy Whitcroft 32838905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 32848905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3285000d1cc1SJoe Perches WARN("INLINE", 3286000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 32878905a67cSAndy Whitcroft } 32888905a67cSAndy Whitcroft 32893d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 32903d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3291000d1cc1SJoe Perches WARN("PREFER_PACKED", 3292000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 32933d130fd0SJoe Perches } 32943d130fd0SJoe Perches 329539b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 329639b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3297000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3298000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 329939b7e287SJoe Perches } 330039b7e287SJoe Perches 33015f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 33025f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 33035f14d3bdSJoe Perches WARN("PREFER_PRINTF", 33045f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 33055f14d3bdSJoe Perches } 33065f14d3bdSJoe Perches 33076061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 33086061d949SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 33096061d949SJoe Perches WARN("PREFER_SCANF", 33106061d949SJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); 33116061d949SJoe Perches } 33126061d949SJoe Perches 33138f53a9b8SJoe Perches# check for sizeof(&) 33148f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3315000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3316000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 33178f53a9b8SJoe Perches } 33188f53a9b8SJoe Perches 331966c80b60SJoe Perches# check for sizeof without parenthesis 332066c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 332166c80b60SJoe Perches WARN("SIZEOF_PARENTHESIS", 332266c80b60SJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr); 332366c80b60SJoe Perches } 332466c80b60SJoe Perches 3325428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3326428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3327000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3328000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3329428e2fdcSJoe Perches } 3330428e2fdcSJoe Perches 3331554e165cSAndy Whitcroft# Check for misused memsets 3332d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3333d1fe9c09SJoe Perches defined $stat && 3334d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3335554e165cSAndy Whitcroft 3336d7c76ba7SJoe Perches my $ms_addr = $2; 3337d1fe9c09SJoe Perches my $ms_val = $7; 3338d1fe9c09SJoe Perches my $ms_size = $12; 3339d7c76ba7SJoe Perches 3340554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3341554e165cSAndy Whitcroft ERROR("MEMSET", 3342d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3343554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3344554e165cSAndy Whitcroft WARN("MEMSET", 3345d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3346d7c76ba7SJoe Perches } 3347d7c76ba7SJoe Perches } 3348d7c76ba7SJoe Perches 3349d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3350d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3351d1fe9c09SJoe Perches defined $stat && 3352d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3353d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3354d7c76ba7SJoe Perches my $call = $1; 3355d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3356d7c76ba7SJoe Perches my $arg1 = $3; 3357d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3358d1fe9c09SJoe Perches my $arg2 = $8; 3359d7c76ba7SJoe Perches my $cast; 3360d7c76ba7SJoe Perches 3361d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3362d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3363d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3364d7c76ba7SJoe Perches $cast = $cast1; 3365d7c76ba7SJoe Perches } else { 3366d7c76ba7SJoe Perches $cast = $cast2; 3367d7c76ba7SJoe Perches } 3368d7c76ba7SJoe Perches WARN("MINMAX", 3369d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3370554e165cSAndy Whitcroft } 3371554e165cSAndy Whitcroft } 3372554e165cSAndy Whitcroft 33734a273195SJoe Perches# check usleep_range arguments 33744a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 33754a273195SJoe Perches defined $stat && 33764a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 33774a273195SJoe Perches my $min = $1; 33784a273195SJoe Perches my $max = $7; 33794a273195SJoe Perches if ($min eq $max) { 33804a273195SJoe Perches WARN("USLEEP_RANGE", 33814a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 33824a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 33834a273195SJoe Perches $min > $max) { 33844a273195SJoe Perches WARN("USLEEP_RANGE", 33854a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 33864a273195SJoe Perches } 33874a273195SJoe Perches } 33884a273195SJoe Perches 3389de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3390171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3391c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3392171ae1a4SAndy Whitcroft { 3393c45dcabdSAndy Whitcroft my $function_name = $1; 3394c45dcabdSAndy Whitcroft my $paren_space = $2; 3395171ae1a4SAndy Whitcroft 3396171ae1a4SAndy Whitcroft my $s = $stat; 3397171ae1a4SAndy Whitcroft if (defined $cond) { 3398171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3399171ae1a4SAndy Whitcroft } 3400c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3401c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3402c45dcabdSAndy Whitcroft { 3403000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3404000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3405de7d4f0eSAndy Whitcroft } 3406de7d4f0eSAndy Whitcroft 3407171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3408000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3409000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3410171ae1a4SAndy Whitcroft } 34119c9ba34eSAndy Whitcroft 34129c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 34139c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 34149c9ba34eSAndy Whitcroft { 3415000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3416000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3417171ae1a4SAndy Whitcroft } 3418171ae1a4SAndy Whitcroft 3419de7d4f0eSAndy Whitcroft# checks for new __setup's 3420de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3421de7d4f0eSAndy Whitcroft my $name = $1; 3422de7d4f0eSAndy Whitcroft 3423de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3424000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3425000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3426de7d4f0eSAndy Whitcroft } 3427653d4876SAndy Whitcroft } 34289c0ca6f9SAndy Whitcroft 34299c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3430caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3431000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3432000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 34339c0ca6f9SAndy Whitcroft } 343413214adfSAndy Whitcroft 3435caf2a54fSJoe Perches# check for multiple semicolons 3436caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3437000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3438000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3439caf2a54fSJoe Perches } 3440caf2a54fSJoe Perches 344113214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 344213214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3443000d1cc1SJoe Perches WARN("USE_FUNC", 3444000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 344513214adfSAndy Whitcroft } 3446773647a0SAndy Whitcroft 34472c92488aSJoe Perches# check for use of yield() 34482c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 34492c92488aSJoe Perches WARN("YIELD", 34502c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 34512c92488aSJoe Perches } 34522c92488aSJoe Perches 34534882720bSThomas Gleixner# check for semaphores initialized locked 34544882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3455000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3456000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 3457773647a0SAndy Whitcroft } 34586712d858SJoe Perches 345967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 346067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3461000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 346267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3463773647a0SAndy Whitcroft } 34646712d858SJoe Perches 3465f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3466f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3467000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3468000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3469f3db6639SMichael Ellerman } 34706712d858SJoe Perches 347179404849SEmese Revfy# check for various ops structs, ensure they are const. 347279404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 347379404849SEmese Revfy address_space_operations| 347479404849SEmese Revfy backlight_ops| 347579404849SEmese Revfy block_device_operations| 347679404849SEmese Revfy dentry_operations| 347779404849SEmese Revfy dev_pm_ops| 347879404849SEmese Revfy dma_map_ops| 347979404849SEmese Revfy extent_io_ops| 348079404849SEmese Revfy file_lock_operations| 348179404849SEmese Revfy file_operations| 348279404849SEmese Revfy hv_ops| 348379404849SEmese Revfy ide_dma_ops| 348479404849SEmese Revfy intel_dvo_dev_ops| 348579404849SEmese Revfy item_operations| 348679404849SEmese Revfy iwl_ops| 348779404849SEmese Revfy kgdb_arch| 348879404849SEmese Revfy kgdb_io| 348979404849SEmese Revfy kset_uevent_ops| 349079404849SEmese Revfy lock_manager_operations| 349179404849SEmese Revfy microcode_ops| 349279404849SEmese Revfy mtrr_ops| 349379404849SEmese Revfy neigh_ops| 349479404849SEmese Revfy nlmsvc_binding| 349579404849SEmese Revfy pci_raw_ops| 349679404849SEmese Revfy pipe_buf_operations| 349779404849SEmese Revfy platform_hibernation_ops| 349879404849SEmese Revfy platform_suspend_ops| 349979404849SEmese Revfy proto_ops| 350079404849SEmese Revfy rpc_pipe_ops| 350179404849SEmese Revfy seq_operations| 350279404849SEmese Revfy snd_ac97_build_ops| 350379404849SEmese Revfy soc_pcmcia_socket_ops| 350479404849SEmese Revfy stacktrace_ops| 350579404849SEmese Revfy sysfs_ops| 350679404849SEmese Revfy tty_operations| 350779404849SEmese Revfy usb_mon_operations| 350879404849SEmese Revfy wd_ops}x; 35096903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 351079404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3511000d1cc1SJoe Perches WARN("CONST_STRUCT", 3512000d1cc1SJoe Perches "struct $1 should normally be const\n" . 35136903ffb2SAndy Whitcroft $herecurr); 35142b6db5cbSAndy Whitcroft } 3515773647a0SAndy Whitcroft 3516773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3517773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3518773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3519c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3520c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3521171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3522171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3523171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3524773647a0SAndy Whitcroft { 3525000d1cc1SJoe Perches WARN("NR_CPUS", 3526000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3527773647a0SAndy Whitcroft } 35289c9ba34eSAndy Whitcroft 35299c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 35309c9ba34eSAndy Whitcroft my $string; 35319c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 35329c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 35332a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 35349c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3535000d1cc1SJoe Perches WARN("PRINTF_L", 3536000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 35379c9ba34eSAndy Whitcroft last; 35389c9ba34eSAndy Whitcroft } 35399c9ba34eSAndy Whitcroft } 3540691d77b6SAndy Whitcroft 3541691d77b6SAndy Whitcroft# whine mightly about in_atomic 3542691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3543691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3544000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3545000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3546f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3547000d1cc1SJoe Perches WARN("IN_ATOMIC", 3548000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3549691d77b6SAndy Whitcroft } 3550691d77b6SAndy Whitcroft } 35511704f47bSPeter Zijlstra 35521704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 35531704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 35541704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 35551704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 35561704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 35571704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3558000d1cc1SJoe Perches ERROR("LOCKDEP", 3559000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 35601704f47bSPeter Zijlstra } 35611704f47bSPeter Zijlstra } 356288f8831cSDave Jones 356388f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 356488f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3565000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3566000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 356788f8831cSDave Jones } 356813214adfSAndy Whitcroft } 356913214adfSAndy Whitcroft 357013214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 357113214adfSAndy Whitcroft # so just keep quiet. 357213214adfSAndy Whitcroft if ($#rawlines == -1) { 357313214adfSAndy Whitcroft exit(0); 35740a920b5bSAndy Whitcroft } 35750a920b5bSAndy Whitcroft 35768905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 35778905a67cSAndy Whitcroft # things that appear to be patches. 35788905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 35798905a67cSAndy Whitcroft exit(0); 35808905a67cSAndy Whitcroft } 35818905a67cSAndy Whitcroft 35828905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 35838905a67cSAndy Whitcroft # just keep quiet. 35848905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 35858905a67cSAndy Whitcroft exit(0); 35868905a67cSAndy Whitcroft } 35878905a67cSAndy Whitcroft 35888905a67cSAndy Whitcroft if (!$is_patch) { 3589000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3590000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 35910a920b5bSAndy Whitcroft } 35920a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3593000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3594000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 35950a920b5bSAndy Whitcroft } 35960a920b5bSAndy Whitcroft 3597f0a594c1SAndy Whitcroft print report_dump(); 359813214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 359913214adfSAndy Whitcroft print "$filename " if ($summary_file); 36006c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 36016c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 36026c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 36038905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 36046c72ffaaSAndy Whitcroft } 36058905a67cSAndy Whitcroft 3606d2c0a235SAndy Whitcroft if ($quiet == 0) { 3607d1fe9c09SJoe Perches 3608d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 3609d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 3610d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 3611d1fe9c09SJoe Perches } 3612d1fe9c09SJoe Perches 3613d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3614d2c0a235SAndy Whitcroft # then suggest that. 3615d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3616d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3617d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3618b0781216SMike Frysinger $rpt_cleaners = 0; 3619d2c0a235SAndy Whitcroft } 3620d2c0a235SAndy Whitcroft } 3621d2c0a235SAndy Whitcroft 362211232688SArtem Bityutskiy if ($quiet == 0 && keys %ignore_type) { 3623000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3624000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3625000d1cc1SJoe Perches print " $ignore"; 3626000d1cc1SJoe Perches } 362711232688SArtem Bityutskiy print "\n\n"; 3628000d1cc1SJoe Perches } 3629000d1cc1SJoe Perches 36300a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3631c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 36320a920b5bSAndy Whitcroft } 36330a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3634000d1cc1SJoe Perches print << "EOM"; 3635000d1cc1SJoe Perches$vname has style problems, please review. 3636000d1cc1SJoe Perches 3637000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3638000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3639000d1cc1SJoe PerchesEOM 36400a920b5bSAndy Whitcroft } 364113214adfSAndy Whitcroft 36420a920b5bSAndy Whitcroft return $clean; 36430a920b5bSAndy Whitcroft} 3644