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 188505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 188605880600SJoe Perches $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 188705880600SJoe Perches $prevrawline =~ /^\+[ \t]*$/) { 188805880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 188905880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 189005880600SJoe Perches } 189105880600SJoe Perches 189205880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 189305880600SJoe Perches $rawline !~ m@^\+[ \t]*(\/\*|\*\/)@ && 189405880600SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { 189505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 189605880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 189705880600SJoe Perches } 189805880600SJoe Perches 18995f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 19006b4c5bebSAndy Whitcroft# Exceptions: 19016b4c5bebSAndy Whitcroft# 1) within comments 19026b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 19036b4c5bebSAndy Whitcroft# 3) hanging labels 19046b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 19055f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1906000d1cc1SJoe Perches WARN("LEADING_SPACE", 1907000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 19085f7ddae6SRaffaele Recalcati } 19095f7ddae6SRaffaele Recalcati 1910b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1911b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1912b9ea10d6SAndy Whitcroft 1913c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1914cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1915000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1916000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1917c2fdda0dSAndy Whitcroft } 191822f2a2efSAndy Whitcroft 191942e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 192042e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 192142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1922000d1cc1SJoe Perches ERROR("CSYNC", 1923000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 192442e41c54SMike Frysinger } 192542e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 192642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1927000d1cc1SJoe Perches ERROR("SSYNC", 1928000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 192942e41c54SMike Frysinger } 193042e41c54SMike Frysinger 19319c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 19322b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 19332b474a1aSAndy Whitcroft $realline_next); 19343e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 19353e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 19363e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 1937170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1938f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1939171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1940171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1941171ae1a4SAndy Whitcroft 19423e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 19433e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 19443e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 19453e469cdcSAndy Whitcroft # until we hit end of it. 19463e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 19473e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 19483e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 19493e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 19503e469cdcSAndy Whitcroft } 1951f74bd194SAndy Whitcroft 19522b474a1aSAndy Whitcroft # Find the real next line. 19532b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 19542b474a1aSAndy Whitcroft if (defined $realline_next && 19552b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 19562b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 19572b474a1aSAndy Whitcroft $realline_next++; 19582b474a1aSAndy Whitcroft } 19592b474a1aSAndy Whitcroft 1960171ae1a4SAndy Whitcroft my $s = $stat; 1961171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1962cf655043SAndy Whitcroft 1963c2fdda0dSAndy Whitcroft # Ignore goto labels. 1964171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1965c2fdda0dSAndy Whitcroft 1966c2fdda0dSAndy Whitcroft # Ignore functions being called 1967171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1968c2fdda0dSAndy Whitcroft 1969463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1970463f2864SAndy Whitcroft 1971c45dcabdSAndy Whitcroft # declarations always start with types 1972d2506586SAndy 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) { 1973c45dcabdSAndy Whitcroft my $type = $1; 1974c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1975c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1976c45dcabdSAndy Whitcroft 19776c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1978a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1979c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1980c2fdda0dSAndy Whitcroft } 19818905a67cSAndy Whitcroft 19826c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 198365863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1984c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 19859c0ca6f9SAndy Whitcroft } 19868905a67cSAndy Whitcroft 19878905a67cSAndy Whitcroft # Check for any sort of function declaration. 19888905a67cSAndy Whitcroft # int foo(something bar, other baz); 19898905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1990171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 19918905a67cSAndy Whitcroft my ($name_len) = length($1); 19928905a67cSAndy Whitcroft 1993cf655043SAndy Whitcroft my $ctx = $s; 1994773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 19958905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1996cf655043SAndy Whitcroft 19978905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1998c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 19998905a67cSAndy Whitcroft 2000c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 20018905a67cSAndy Whitcroft } 20028905a67cSAndy Whitcroft } 20038905a67cSAndy Whitcroft } 20048905a67cSAndy Whitcroft 20059c0ca6f9SAndy Whitcroft } 20069c0ca6f9SAndy Whitcroft 200700df344fSAndy Whitcroft# 200800df344fSAndy Whitcroft# Checks which may be anchored in the context. 200900df344fSAndy Whitcroft# 201000df344fSAndy Whitcroft 201100df344fSAndy Whitcroft# Check for switch () and associated case and default 201200df344fSAndy Whitcroft# statements should be at the same indent. 201300df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 201400df344fSAndy Whitcroft my $err = ''; 201500df344fSAndy Whitcroft my $sep = ''; 201600df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 201700df344fSAndy Whitcroft shift(@ctx); 201800df344fSAndy Whitcroft for my $ctx (@ctx) { 201900df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 202000df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 202100df344fSAndy Whitcroft $indent != $cindent) { 202200df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 202300df344fSAndy Whitcroft $sep = ''; 202400df344fSAndy Whitcroft } else { 202500df344fSAndy Whitcroft $sep = "[...]\n"; 202600df344fSAndy Whitcroft } 202700df344fSAndy Whitcroft } 202800df344fSAndy Whitcroft if ($err ne '') { 2029000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2030000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2031de7d4f0eSAndy Whitcroft } 2032de7d4f0eSAndy Whitcroft } 2033de7d4f0eSAndy Whitcroft 2034de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2035de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2036c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2037773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2038773647a0SAndy Whitcroft 20399c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 20408eef05ddSJoe Perches 20418eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 20428eef05ddSJoe Perches WARN("DEEP_INDENTATION", 20438eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 20448eef05ddSJoe Perches } 20458eef05ddSJoe Perches 2046de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2047de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2048de7d4f0eSAndy Whitcroft 2049548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2050548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2051de7d4f0eSAndy Whitcroft 2052548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2053548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2054548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2055548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2056548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2057773647a0SAndy Whitcroft $ctx_ln++; 2058773647a0SAndy Whitcroft } 2059548596d5SAndy Whitcroft 206053210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 206153210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2062773647a0SAndy Whitcroft 2063773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2064000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2065000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 206601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 206700df344fSAndy Whitcroft } 2068773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2069773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2070773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2071773647a0SAndy Whitcroft { 20729c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 20739c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2074000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2075000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 207601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 20779c0ca6f9SAndy Whitcroft } 20789c0ca6f9SAndy Whitcroft } 207900df344fSAndy Whitcroft } 208000df344fSAndy Whitcroft 20814d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 20824d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 20833e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 20843e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 20853e469cdcSAndy Whitcroft if (!defined $stat); 20864d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 20874d001e4dSAndy Whitcroft 20884d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 20894d001e4dSAndy Whitcroft 20904d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 20914d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 20924d001e4dSAndy Whitcroft # where necessary. 20934d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 20944d001e4dSAndy Whitcroft 20954d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 20966f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 20976f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 20984d001e4dSAndy Whitcroft 20994d001e4dSAndy Whitcroft # We want to check the first line inside the block 21004d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 21014d001e4dSAndy Whitcroft # 1) any blank line termination 21024d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 21034d001e4dSAndy Whitcroft # 3) any do (...) { 21044d001e4dSAndy Whitcroft my $continuation = 0; 21054d001e4dSAndy Whitcroft my $check = 0; 21064d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 21074d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 21084d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 21094d001e4dSAndy Whitcroft $continuation = 1; 21104d001e4dSAndy Whitcroft } 21119bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 21124d001e4dSAndy Whitcroft $check = 1; 21134d001e4dSAndy Whitcroft $cond_lines++; 21144d001e4dSAndy Whitcroft } 21154d001e4dSAndy Whitcroft 21164d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 21174d001e4dSAndy Whitcroft # preprocessor statement. 21184d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 21194d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 21204d001e4dSAndy Whitcroft $check = 0; 21214d001e4dSAndy Whitcroft } 21224d001e4dSAndy Whitcroft 21239bd49efeSAndy Whitcroft my $cond_ptr = -1; 2124740504c6SAndy Whitcroft $continuation = 0; 21259bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 21269bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 21274d001e4dSAndy Whitcroft 2128f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2129f16fa28fSAndy Whitcroft # is not linear. 2130f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2131f16fa28fSAndy Whitcroft $check = 0; 2132f16fa28fSAndy Whitcroft } 2133f16fa28fSAndy Whitcroft 21349bd49efeSAndy Whitcroft # Ignore: 21359bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 21369bd49efeSAndy Whitcroft # 2) preprocessor lines, and 21379bd49efeSAndy Whitcroft # 3) labels. 2138740504c6SAndy Whitcroft if ($continuation || 2139740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 21409bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 21419bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2142740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 214330dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 21449bd49efeSAndy Whitcroft $cond_lines++; 21459bd49efeSAndy Whitcroft } 21464d001e4dSAndy Whitcroft } 214730dad6ebSAndy Whitcroft } 21484d001e4dSAndy Whitcroft 21494d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 21504d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 21514d001e4dSAndy Whitcroft 21524d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 21534d001e4dSAndy Whitcroft # this is not this patch's fault. 21544d001e4dSAndy Whitcroft if (!defined($stat_real) || 21554d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 21564d001e4dSAndy Whitcroft $check = 0; 21574d001e4dSAndy Whitcroft } 21584d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 21594d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 21604d001e4dSAndy Whitcroft } 21614d001e4dSAndy Whitcroft 21629bd49efeSAndy 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"; 21634d001e4dSAndy Whitcroft 21644d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 21654d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2166000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2167000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 21684d001e4dSAndy Whitcroft } 21694d001e4dSAndy Whitcroft } 21704d001e4dSAndy Whitcroft 21716c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 21726c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 21731f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 21741f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 21756c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2176c2fdda0dSAndy Whitcroft if ($dbg_values) { 2177c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2178cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2179cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 21801f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2181c2fdda0dSAndy Whitcroft } 21826c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 21836c72ffaaSAndy Whitcroft 218400df344fSAndy Whitcroft#ignore lines not being added 218500df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 218600df344fSAndy Whitcroft 2187653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 21887429c690SAndy Whitcroft if ($dbg_type) { 21897429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2190000d1cc1SJoe Perches ERROR("TEST_TYPE", 2191000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 21927429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2193000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2194000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 21957429c690SAndy Whitcroft } 2196653d4876SAndy Whitcroft next; 2197653d4876SAndy Whitcroft } 2198a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2199a1ef277eSAndy Whitcroft if ($dbg_attr) { 22009360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2201000d1cc1SJoe Perches ERROR("TEST_ATTR", 2202000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 22039360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2204000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2205000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2206a1ef277eSAndy Whitcroft } 2207a1ef277eSAndy Whitcroft next; 2208a1ef277eSAndy Whitcroft } 2209653d4876SAndy Whitcroft 2210f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 221199423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 221299423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2213000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2214000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2215f0a594c1SAndy Whitcroft } 2216f0a594c1SAndy Whitcroft 221700df344fSAndy Whitcroft# 221800df344fSAndy Whitcroft# Checks which are anchored on the added line. 221900df344fSAndy Whitcroft# 222000df344fSAndy Whitcroft 2221653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2222c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2223653d4876SAndy Whitcroft my $path = $1; 2224653d4876SAndy Whitcroft if ($path =~ m{//}) { 2225000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2226000d1cc1SJoe Perches "malformed #include filename\n" . 2227de7d4f0eSAndy Whitcroft $herecurr); 2228653d4876SAndy Whitcroft } 2229653d4876SAndy Whitcroft } 2230653d4876SAndy Whitcroft 223100df344fSAndy Whitcroft# no C99 // comments 223200df344fSAndy Whitcroft if ($line =~ m{//}) { 2233000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2234000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 223500df344fSAndy Whitcroft } 223600df344fSAndy Whitcroft # Remove C99 comments. 22370a920b5bSAndy Whitcroft $line =~ s@//.*@@; 22386c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 22390a920b5bSAndy Whitcroft 22402b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 22412b474a1aSAndy Whitcroft# the whole statement. 22422b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 22432b474a1aSAndy Whitcroft if (defined $realline_next && 22442b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 22452b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 22462b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22472b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22483cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 22493cbf62dfSAndy Whitcroft # a prefix: 22503cbf62dfSAndy Whitcroft # XXX(foo); 22513cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2252653d4876SAndy Whitcroft my $name = $1; 225387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 22543cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 22553cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 22563cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 22573cbf62dfSAndy Whitcroft 22583cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 22592b474a1aSAndy Whitcroft \n.}\s*$| 226048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 226148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 226248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 22632b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 22642b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 226548012058SAndy Whitcroft )/x) { 22662b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 22672b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 22682b474a1aSAndy Whitcroft } else { 22692b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 22700a920b5bSAndy Whitcroft } 22710a920b5bSAndy Whitcroft } 22722b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 22732b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 22742b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22752b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22762b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 22772b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 22782b474a1aSAndy Whitcroft } 22792b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 22802b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2281000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2282000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 22832b474a1aSAndy Whitcroft } 22840a920b5bSAndy Whitcroft 22855150bda4SJoe Eloff# check for global initialisers. 2286c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2287000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2288000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2289f0a594c1SAndy Whitcroft $herecurr); 2290f0a594c1SAndy Whitcroft } 22910a920b5bSAndy Whitcroft# check for static initialisers. 22922d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2293000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2294000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2295de7d4f0eSAndy Whitcroft $herecurr); 22960a920b5bSAndy Whitcroft } 22970a920b5bSAndy Whitcroft 2298cb710ecaSJoe Perches# check for static const char * arrays. 2299cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2300000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2301000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2302cb710ecaSJoe Perches $herecurr); 2303cb710ecaSJoe Perches } 2304cb710ecaSJoe Perches 2305cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2306cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2307000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2308000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2309cb710ecaSJoe Perches $herecurr); 2310cb710ecaSJoe Perches } 2311cb710ecaSJoe Perches 231293ed0e2dSJoe Perches# check for declarations of struct pci_device_id 231393ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2314000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2315000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 231693ed0e2dSJoe Perches } 231793ed0e2dSJoe Perches 2318653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2319653d4876SAndy Whitcroft# make sense. 2320653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 23218054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2322c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 23238ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2324653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2325000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2326000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 23270a920b5bSAndy Whitcroft } 23280a920b5bSAndy Whitcroft 23290a920b5bSAndy Whitcroft# * goes on variable not on type 233065863862SAndy Whitcroft # (char*[ const]) 2331bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2332bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 2333bfcb2cc7SAndy Whitcroft my ($from, $to) = ($2, $2); 2334d8aaf121SAndy Whitcroft 233565863862SAndy Whitcroft # Should start with a space. 233665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 233765863862SAndy Whitcroft # Should not end with a space. 233865863862SAndy Whitcroft $to =~ s/\s+$//; 233965863862SAndy Whitcroft # '*'s should not have spaces between. 2340f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 234165863862SAndy Whitcroft } 2342d8aaf121SAndy Whitcroft 234365863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 234465863862SAndy Whitcroft if ($from ne $to) { 2345000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2346000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 234765863862SAndy Whitcroft } 2348bfcb2cc7SAndy Whitcroft } 2349bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2350bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 2351bfcb2cc7SAndy Whitcroft my ($from, $to, $ident) = ($2, $2, $3); 2352d8aaf121SAndy Whitcroft 235365863862SAndy Whitcroft # Should start with a space. 235465863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 235565863862SAndy Whitcroft # Should not end with a space. 235665863862SAndy Whitcroft $to =~ s/\s+$//; 235765863862SAndy Whitcroft # '*'s should not have spaces between. 2358f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 235965863862SAndy Whitcroft } 236065863862SAndy Whitcroft # Modifiers should have spaces. 236165863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 236265863862SAndy Whitcroft 2363667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2364667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2365000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2366000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 236765863862SAndy Whitcroft } 23680a920b5bSAndy Whitcroft } 23690a920b5bSAndy Whitcroft 23700a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 23710a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 23720a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 23730a920b5bSAndy Whitcroft# print "$herecurr"; 23740a920b5bSAndy Whitcroft# $clean = 0; 23750a920b5bSAndy Whitcroft# } 23760a920b5bSAndy Whitcroft 23778905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2378000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2379000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 23808905a67cSAndy Whitcroft } 23818905a67cSAndy Whitcroft 238217441227SJoe Perches# check for uses of printk_ratelimit 238317441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2384000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2385000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 238617441227SJoe Perches } 238717441227SJoe Perches 238800df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 238900df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 239000df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 239125985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 239200df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2393f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 239400df344fSAndy Whitcroft my $ok = 0; 239500df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 239600df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 239725985edcSLucas De Marchi # we have a preceding printk if it ends 239800df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 239900df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 240000df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 240100df344fSAndy Whitcroft $ok = 1; 240200df344fSAndy Whitcroft } 240300df344fSAndy Whitcroft last; 240400df344fSAndy Whitcroft } 240500df344fSAndy Whitcroft } 240600df344fSAndy Whitcroft if ($ok == 0) { 2407000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2408000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 24090a920b5bSAndy Whitcroft } 241000df344fSAndy Whitcroft } 24110a920b5bSAndy Whitcroft 2412243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2413243f3803SJoe Perches my $orig = $1; 2414243f3803SJoe Perches my $level = lc($orig); 2415243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 24168f26b837SJoe Perches my $level2 = $level; 24178f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2418243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 24198f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2420243f3803SJoe Perches } 2421243f3803SJoe Perches 2422243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2423243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2424243f3803SJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); 2425243f3803SJoe Perches } 2426243f3803SJoe Perches 2427653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2428653d4876SAndy Whitcroft# or if closed on same line 2429c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2430c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2431000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2432000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 24330a920b5bSAndy Whitcroft } 2434653d4876SAndy Whitcroft 24358905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 24368905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 24378905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2438000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2439000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 24408905a67cSAndy Whitcroft } 24418905a67cSAndy Whitcroft 24420c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 24430c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2444000d1cc1SJoe Perches WARN("SPACING", 2445000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 24460c73b4ebSAndy Whitcroft } 24470c73b4ebSAndy Whitcroft 24488d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 24498d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2450fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2451fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 24528d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 24538d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 24548d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2455fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2456daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 2457000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2458000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 24598d31cfceSAndy Whitcroft } 24608d31cfceSAndy Whitcroft } 24618d31cfceSAndy Whitcroft 2462f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 24636c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2464c2fdda0dSAndy Whitcroft my $name = $1; 2465773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2466773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2467c2fdda0dSAndy Whitcroft 2468c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2469773647a0SAndy Whitcroft if ($name =~ /^(?: 2470773647a0SAndy Whitcroft if|for|while|switch|return|case| 2471773647a0SAndy Whitcroft volatile|__volatile__| 2472773647a0SAndy Whitcroft __attribute__|format|__extension__| 2473773647a0SAndy Whitcroft asm|__asm__)$/x) 2474773647a0SAndy Whitcroft { 2475c2fdda0dSAndy Whitcroft 2476c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2477c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2478c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2479c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2480773647a0SAndy Whitcroft 2481773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2482c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2483c2fdda0dSAndy Whitcroft 2484c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2485c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2486773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2487c2fdda0dSAndy Whitcroft 2488c2fdda0dSAndy Whitcroft } else { 2489000d1cc1SJoe Perches WARN("SPACING", 2490000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2491f0a594c1SAndy Whitcroft } 24926c72ffaaSAndy Whitcroft } 24939a4cad4eSEric Nelson 24949a4cad4eSEric Nelson# check for whitespace before a non-naked semicolon 24959a4cad4eSEric Nelson if ($line =~ /^\+.*\S\s+;/) { 24969a4cad4eSEric Nelson CHK("SPACING", 24979a4cad4eSEric Nelson "space prohibited before semicolon\n" . $herecurr); 24989a4cad4eSEric Nelson } 24999a4cad4eSEric Nelson 2500653d4876SAndy Whitcroft# Check operator spacing. 25010a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 25029c0ca6f9SAndy Whitcroft my $ops = qr{ 25039c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 25049c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 25059c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 25061f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 25071f65f947SAndy Whitcroft \?|: 25089c0ca6f9SAndy Whitcroft }x; 2509cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 251000df344fSAndy Whitcroft my $off = 0; 25116c72ffaaSAndy Whitcroft 25126c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 25136c72ffaaSAndy Whitcroft 25140a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 25154a0df2efSAndy Whitcroft $off += length($elements[$n]); 25164a0df2efSAndy Whitcroft 251725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2518773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2519773647a0SAndy Whitcroft my $cc = ''; 2520773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2521773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2522773647a0SAndy Whitcroft } 2523773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2524773647a0SAndy Whitcroft 25254a0df2efSAndy Whitcroft my $a = ''; 25264a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 25274a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2528cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 25294a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 25304a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2531773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 25324a0df2efSAndy Whitcroft 25330a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 25344a0df2efSAndy Whitcroft 25354a0df2efSAndy Whitcroft my $c = ''; 25360a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 25374a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 25384a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2539cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 25404a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 25414a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 25428b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 25434a0df2efSAndy Whitcroft } else { 25444a0df2efSAndy Whitcroft $c = 'E'; 25450a920b5bSAndy Whitcroft } 25460a920b5bSAndy Whitcroft 25474a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 25484a0df2efSAndy Whitcroft 25494a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 25504a0df2efSAndy Whitcroft 25516c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2552de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 25530a920b5bSAndy Whitcroft 255474048ed8SAndy Whitcroft # Pull out the value of this operator. 25556c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 25560a920b5bSAndy Whitcroft 25571f65f947SAndy Whitcroft # Get the full operator variant. 25581f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 25591f65f947SAndy Whitcroft 256013214adfSAndy Whitcroft # Ignore operators passed as parameters. 256113214adfSAndy Whitcroft if ($op_type ne 'V' && 256213214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 256313214adfSAndy Whitcroft 2564cf655043SAndy Whitcroft# # Ignore comments 2565cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 256613214adfSAndy Whitcroft 2567d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 256813214adfSAndy Whitcroft } elsif ($op eq ';') { 2569cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2570cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2571000d1cc1SJoe Perches ERROR("SPACING", 2572000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2573d8aaf121SAndy Whitcroft } 2574d8aaf121SAndy Whitcroft 2575d8aaf121SAndy Whitcroft # // is a comment 2576d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 25770a920b5bSAndy Whitcroft 25781f65f947SAndy Whitcroft # No spaces for: 25791f65f947SAndy Whitcroft # -> 25801f65f947SAndy Whitcroft # : when part of a bitfield 25811f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 25824a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2583000d1cc1SJoe Perches ERROR("SPACING", 2584000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 25850a920b5bSAndy Whitcroft } 25860a920b5bSAndy Whitcroft 25870a920b5bSAndy Whitcroft # , must have a space on the right. 25880a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2589cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2590000d1cc1SJoe Perches ERROR("SPACING", 2591000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 25920a920b5bSAndy Whitcroft } 25930a920b5bSAndy Whitcroft 25949c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 259574048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 25969c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 25979c0ca6f9SAndy Whitcroft 25989c0ca6f9SAndy Whitcroft # unary operators should have a space before and 25999c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 26009c0ca6f9SAndy Whitcroft # unary operator, or a cast 26019c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 260274048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 26030d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2604cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2605000d1cc1SJoe Perches ERROR("SPACING", 2606000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 26070a920b5bSAndy Whitcroft } 2608a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2609171ae1a4SAndy Whitcroft # A unary '*' may be const 2610171ae1a4SAndy Whitcroft 2611171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2612000d1cc1SJoe Perches ERROR("SPACING", 2613000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 26140a920b5bSAndy Whitcroft } 26150a920b5bSAndy Whitcroft 26160a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 26170a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2618773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2619000d1cc1SJoe Perches ERROR("SPACING", 2620000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 26210a920b5bSAndy Whitcroft } 2622773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2623773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2624000d1cc1SJoe Perches ERROR("SPACING", 2625000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2626653d4876SAndy Whitcroft } 2627773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2628000d1cc1SJoe Perches ERROR("SPACING", 2629000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2630773647a0SAndy Whitcroft } 2631773647a0SAndy Whitcroft 26320a920b5bSAndy Whitcroft 26330a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 26349c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 26359c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 26369c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2637c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2638c2fdda0dSAndy Whitcroft $op eq '%') 26390a920b5bSAndy Whitcroft { 2640773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2641000d1cc1SJoe Perches ERROR("SPACING", 2642000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2643de7d4f0eSAndy Whitcroft $hereptr); 26440a920b5bSAndy Whitcroft } 26450a920b5bSAndy Whitcroft 26461f65f947SAndy Whitcroft # A colon needs no spaces before when it is 26471f65f947SAndy Whitcroft # terminating a case value or a label. 26481f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 26491f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2650000d1cc1SJoe Perches ERROR("SPACING", 2651000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 26521f65f947SAndy Whitcroft } 26531f65f947SAndy Whitcroft 26540a920b5bSAndy Whitcroft # All the others need spaces both sides. 2655cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 26561f65f947SAndy Whitcroft my $ok = 0; 26571f65f947SAndy Whitcroft 265822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 26591f65f947SAndy Whitcroft if (($op eq '<' && 26601f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 26611f65f947SAndy Whitcroft ($op eq '>' && 26621f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 26631f65f947SAndy Whitcroft { 26641f65f947SAndy Whitcroft $ok = 1; 26651f65f947SAndy Whitcroft } 26661f65f947SAndy Whitcroft 26671f65f947SAndy Whitcroft # Ignore ?: 26681f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 26691f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 26701f65f947SAndy Whitcroft $ok = 1; 26711f65f947SAndy Whitcroft } 26721f65f947SAndy Whitcroft 26731f65f947SAndy Whitcroft if ($ok == 0) { 2674000d1cc1SJoe Perches ERROR("SPACING", 2675000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 26760a920b5bSAndy Whitcroft } 267722f2a2efSAndy Whitcroft } 26784a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 26790a920b5bSAndy Whitcroft } 26800a920b5bSAndy Whitcroft } 26810a920b5bSAndy Whitcroft 2682f0a594c1SAndy Whitcroft# check for multiple assignments 2683f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2684000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2685000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2686f0a594c1SAndy Whitcroft } 2687f0a594c1SAndy Whitcroft 268822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 268922f2a2efSAndy Whitcroft## # continuation. 269022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 269122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 269222f2a2efSAndy Whitcroft## 269322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 269422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 269522f2a2efSAndy Whitcroft## my $ln = $line; 269622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 269722f2a2efSAndy Whitcroft## } 269822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2699000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2700000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 270122f2a2efSAndy Whitcroft## } 270222f2a2efSAndy Whitcroft## } 2703f0a594c1SAndy Whitcroft 27040a920b5bSAndy Whitcroft#need space before brace following if, while, etc 270522f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 270622f2a2efSAndy Whitcroft $line =~ /do{/) { 2707000d1cc1SJoe Perches ERROR("SPACING", 2708000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2709de7d4f0eSAndy Whitcroft } 2710de7d4f0eSAndy Whitcroft 2711de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2712de7d4f0eSAndy Whitcroft# on the line 2713de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2714000d1cc1SJoe Perches ERROR("SPACING", 2715000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 27160a920b5bSAndy Whitcroft } 27170a920b5bSAndy Whitcroft 271822f2a2efSAndy Whitcroft# check spacing on square brackets 271922f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2720000d1cc1SJoe Perches ERROR("SPACING", 2721000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 272222f2a2efSAndy Whitcroft } 272322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2724000d1cc1SJoe Perches ERROR("SPACING", 2725000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 272622f2a2efSAndy Whitcroft } 272722f2a2efSAndy Whitcroft 2728c45dcabdSAndy Whitcroft# check spacing on parentheses 27299c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 27309c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2731000d1cc1SJoe Perches ERROR("SPACING", 2732000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 273322f2a2efSAndy Whitcroft } 273413214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2735c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2736c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2737000d1cc1SJoe Perches ERROR("SPACING", 2738000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 273922f2a2efSAndy Whitcroft } 274022f2a2efSAndy Whitcroft 27410a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 27424a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 27430a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2744000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2745000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 27460a920b5bSAndy Whitcroft } 27470a920b5bSAndy Whitcroft 2748c45dcabdSAndy Whitcroft# Return is not a function. 2749c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2750c45dcabdSAndy Whitcroft my $spacing = $1; 2751c45dcabdSAndy Whitcroft my $value = $2; 2752c45dcabdSAndy Whitcroft 275386f9d059SAndy Whitcroft # Flatten any parentheses 2754fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2755fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 2756e01886adSAndy Whitcroft while ($value =~ s/\[[^\[\]]*\]/1/ || 275763f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 275863f17f89SAndy Whitcroft $Compare\s* 275963f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 276063f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2761c45dcabdSAndy Whitcroft } 2762fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2763fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2764000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2765000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2766c45dcabdSAndy Whitcroft 2767c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2768000d1cc1SJoe Perches ERROR("SPACING", 2769000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2770c45dcabdSAndy Whitcroft } 2771c45dcabdSAndy Whitcroft } 277253a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 277353a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 277453a3c448SAndy Whitcroft my $name = $1; 277553a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2776000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2777000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 277853a3c448SAndy Whitcroft } 277953a3c448SAndy Whitcroft } 2780c45dcabdSAndy Whitcroft 27810a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 27824a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2783000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 27840a920b5bSAndy Whitcroft } 27850a920b5bSAndy Whitcroft 2786f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2787f5fe35ddSAndy Whitcroft# statements after the conditional. 2788170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 27893e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 27903e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 27913e469cdcSAndy Whitcroft if (!defined $stat); 2792170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2793170d3a22SAndy Whitcroft $remain_next, $off_next); 2794170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2795170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2796170d3a22SAndy Whitcroft 2797170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2798170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2799170d3a22SAndy Whitcroft # then count those as offsets. 2800170d3a22SAndy Whitcroft my ($whitespace) = 2801170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2802170d3a22SAndy Whitcroft my $offset = 2803170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2804170d3a22SAndy Whitcroft 2805170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2806170d3a22SAndy Whitcroft $offset} = 1; 2807170d3a22SAndy Whitcroft } 2808170d3a22SAndy Whitcroft } 2809170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2810170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2811171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 28128905a67cSAndy Whitcroft 2813b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2814000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2815000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 28168905a67cSAndy Whitcroft } 28178905a67cSAndy Whitcroft 28188905a67cSAndy Whitcroft # Find out what is on the end of the line after the 28198905a67cSAndy Whitcroft # conditional. 2820773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 28218905a67cSAndy Whitcroft $s =~ s/\n.*//g; 282213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 282353210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 282453210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2825773647a0SAndy Whitcroft { 2826bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2827bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2828bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 282942bdf74cSHidetoshi Seto my $stat_real = ''; 2830bb44ad39SAndy Whitcroft 283142bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 283242bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2833bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2834bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2835bb44ad39SAndy Whitcroft } 2836bb44ad39SAndy Whitcroft 2837000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2838000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 28398905a67cSAndy Whitcroft } 28408905a67cSAndy Whitcroft } 28418905a67cSAndy Whitcroft 284213214adfSAndy Whitcroft# Check for bitwise tests written as boolean 284313214adfSAndy Whitcroft if ($line =~ / 284413214adfSAndy Whitcroft (?: 284513214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 284613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 284713214adfSAndy Whitcroft (?:\&\&|\|\|) 284813214adfSAndy Whitcroft | 284913214adfSAndy Whitcroft (?:\&\&|\|\|) 285013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 285113214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 285213214adfSAndy Whitcroft )/x) 285313214adfSAndy Whitcroft { 2854000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2855000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 285613214adfSAndy Whitcroft } 285713214adfSAndy Whitcroft 28588905a67cSAndy Whitcroft# if and else should not have general statements after it 285913214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 286013214adfSAndy Whitcroft my $s = $1; 286113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 286213214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2863000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2864000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 28650a920b5bSAndy Whitcroft } 286613214adfSAndy Whitcroft } 286739667782SAndy Whitcroft# if should not continue a brace 286839667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2869000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2870000d1cc1SJoe Perches "trailing statements should be on next line\n" . 287139667782SAndy Whitcroft $herecurr); 287239667782SAndy Whitcroft } 2873a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2874a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2875a1080bf8SAndy Whitcroft $line !~ /\G(?: 28763fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2877a1080bf8SAndy Whitcroft \s*return\s+ 2878a1080bf8SAndy Whitcroft )/xg) 2879a1080bf8SAndy Whitcroft { 2880000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2881000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2882a1080bf8SAndy Whitcroft } 28830a920b5bSAndy Whitcroft 28840a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 28850a920b5bSAndy Whitcroft # indent level to be relevant to each other. 28860a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 28870a920b5bSAndy Whitcroft $previndent == $indent) { 2888000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2889000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 28900a920b5bSAndy Whitcroft } 28910a920b5bSAndy Whitcroft 2892c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2893c2fdda0dSAndy Whitcroft $previndent == $indent) { 2894c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2895c2fdda0dSAndy Whitcroft 2896c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2897c2fdda0dSAndy Whitcroft # conditional. 2898773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2899c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2900c2fdda0dSAndy Whitcroft 2901c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2902000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2903000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2904c2fdda0dSAndy Whitcroft } 2905c2fdda0dSAndy Whitcroft } 2906c2fdda0dSAndy Whitcroft 29070a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 29080a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 29090a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 29100a920b5bSAndy Whitcroft# print "$herecurr"; 29110a920b5bSAndy Whitcroft# $clean = 0; 29120a920b5bSAndy Whitcroft# } 29130a920b5bSAndy Whitcroft 29140a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2915c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2916000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2917000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 29180a920b5bSAndy Whitcroft } 29190a920b5bSAndy Whitcroft 2920653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2921c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2922e09dec48SAndy Whitcroft my $file = "$1.h"; 2923e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2924e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2925e09dec48SAndy Whitcroft $realfile ne $checkfile && 29267840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2927c45dcabdSAndy Whitcroft { 2928e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2929000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2930000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2931e09dec48SAndy Whitcroft } else { 2932000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2933000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2934e09dec48SAndy Whitcroft } 29350a920b5bSAndy Whitcroft } 29360a920b5bSAndy Whitcroft } 29370a920b5bSAndy Whitcroft 2938653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2939653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2940cf655043SAndy Whitcroft# in a known good container 2941b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2942b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2943d8aaf121SAndy Whitcroft my $ln = $linenr; 2944d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2945c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2946c45dcabdSAndy Whitcroft my $ctx = ''; 2947c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2948f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2949f74bd194SAndy Whitcroft $ctx = $dstat; 2950c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2951a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2952c45dcabdSAndy Whitcroft 2953f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2954292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2955c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2956c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2957c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2958c45dcabdSAndy Whitcroft 2959c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2960bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2961bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2962c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 2963bf30d6edSAndy Whitcroft { 2964c45dcabdSAndy Whitcroft } 2965c45dcabdSAndy Whitcroft 2966e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 2967e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 2968e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 2969e45bab8eSAndy Whitcroft { 2970e45bab8eSAndy Whitcroft } 2971e45bab8eSAndy Whitcroft 2972c45dcabdSAndy Whitcroft my $exceptions = qr{ 2973c45dcabdSAndy Whitcroft $Declare| 2974c45dcabdSAndy Whitcroft module_param_named| 2975*a0a0a7a9SKees Cook MODULE_PARM_DESC| 2976c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2977c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2978383099fdSAndy Whitcroft __typeof__\(| 297922fd2d3eSStefani Seibold union| 298022fd2d3eSStefani Seibold struct| 2981ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2982ea71a0a0SAndy Whitcroft ^\"|\"$ 2983c45dcabdSAndy Whitcroft }x; 29845eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2985f74bd194SAndy Whitcroft if ($dstat ne '' && 2986f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 2987f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 2988fd1b57acSAndy Whitcroft $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo 2989b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 2990f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 2991f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 299272f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 2993f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 2994f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 2995f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 2996f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 2997c45dcabdSAndy Whitcroft { 2998f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 2999f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3000f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3001f74bd194SAndy Whitcroft 3002f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3003f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3004c45dcabdSAndy Whitcroft } 3005c45dcabdSAndy Whitcroft 3006f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3007f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3008f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3009f74bd194SAndy Whitcroft } else { 3010000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3011f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3012d8aaf121SAndy Whitcroft } 30130a920b5bSAndy Whitcroft } 3014653d4876SAndy Whitcroft } 30150a920b5bSAndy Whitcroft 3016b13edf7fSJoe Perches# do {} while (0) macro tests: 3017b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3018b13edf7fSJoe Perches# macro should not end with a semicolon 3019b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3020b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3021b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3022b13edf7fSJoe Perches my $ln = $linenr; 3023b13edf7fSJoe Perches my $cnt = $realcnt; 3024b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3025b13edf7fSJoe Perches my $ctx = ''; 3026b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3027b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3028b13edf7fSJoe Perches $ctx = $dstat; 3029b13edf7fSJoe Perches 3030b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3031b13edf7fSJoe Perches 3032b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3033b13edf7fSJoe Perches my $stmts = $2; 3034b13edf7fSJoe Perches my $semis = $3; 3035b13edf7fSJoe Perches 3036b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3037b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3038b13edf7fSJoe Perches my $herectx = $here . "\n"; 3039b13edf7fSJoe Perches 3040b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3041b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3042b13edf7fSJoe Perches } 3043b13edf7fSJoe Perches 3044ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3045ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3046b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3047b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3048b13edf7fSJoe Perches } 3049b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3050b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3051b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3052b13edf7fSJoe Perches } 3053b13edf7fSJoe Perches } 3054b13edf7fSJoe Perches } 3055b13edf7fSJoe Perches 3056080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3057080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3058080ba929SMike Frysinger# . 3059080ba929SMike Frysinger# ALIGN(...) 3060080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3061080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3062000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3063000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3064080ba929SMike Frysinger } 3065080ba929SMike Frysinger 3066f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 306713214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 306813214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3069cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 307013214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3071cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3072cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3073aad4f614SJoe Perches my @allowed = (); 3074aad4f614SJoe Perches my $allow = 0; 307513214adfSAndy Whitcroft my $seen = 0; 3076773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3077cf655043SAndy Whitcroft my $ln = $linenr - 1; 307813214adfSAndy Whitcroft for my $chunk (@chunks) { 307913214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 308013214adfSAndy Whitcroft 3081773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3082773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3083773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3084773647a0SAndy Whitcroft 3085aad4f614SJoe Perches $allowed[$allow] = 0; 3086773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3087773647a0SAndy Whitcroft 3088773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3089773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3090773647a0SAndy Whitcroft 3091773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3092cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3093cf655043SAndy Whitcroft 3094773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 309513214adfSAndy Whitcroft 309613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 309713214adfSAndy Whitcroft 3098aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3099cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3100cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3101aad4f614SJoe Perches $allowed[$allow] = 1; 310213214adfSAndy Whitcroft } 310313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3104cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3105aad4f614SJoe Perches $allowed[$allow] = 1; 310613214adfSAndy Whitcroft } 3107cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3108cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3109aad4f614SJoe Perches $allowed[$allow] = 1; 311013214adfSAndy Whitcroft } 3111aad4f614SJoe Perches $allow++; 311213214adfSAndy Whitcroft } 3113aad4f614SJoe Perches if ($seen) { 3114aad4f614SJoe Perches my $sum_allowed = 0; 3115aad4f614SJoe Perches foreach (@allowed) { 3116aad4f614SJoe Perches $sum_allowed += $_; 3117aad4f614SJoe Perches } 3118aad4f614SJoe Perches if ($sum_allowed == 0) { 3119000d1cc1SJoe Perches WARN("BRACES", 3120000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3121aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3122aad4f614SJoe Perches $seen != $allow) { 3123aad4f614SJoe Perches CHK("BRACES", 3124aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3125aad4f614SJoe Perches } 312613214adfSAndy Whitcroft } 312713214adfSAndy Whitcroft } 312813214adfSAndy Whitcroft } 3129773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 313013214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3131cf655043SAndy Whitcroft my $allowed = 0; 3132f0a594c1SAndy Whitcroft 3133cf655043SAndy Whitcroft # Check the pre-context. 3134cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3135cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3136cf655043SAndy Whitcroft $allowed = 1; 3137f0a594c1SAndy Whitcroft } 3138773647a0SAndy Whitcroft 3139773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3140773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3141773647a0SAndy Whitcroft 3142cf655043SAndy Whitcroft # Check the condition. 3143cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3144773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3145cf655043SAndy Whitcroft if (defined $cond) { 3146773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3147cf655043SAndy Whitcroft } 3148cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3149cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3150cf655043SAndy Whitcroft $allowed = 1; 3151cf655043SAndy Whitcroft } 3152cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3153cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3154cf655043SAndy Whitcroft $allowed = 1; 3155cf655043SAndy Whitcroft } 3156cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3157cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3158cf655043SAndy Whitcroft $allowed = 1; 3159cf655043SAndy Whitcroft } 3160cf655043SAndy Whitcroft # Check the post-context. 3161cf655043SAndy Whitcroft if (defined $chunks[1]) { 3162cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3163cf655043SAndy Whitcroft if (defined $cond) { 3164773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3165cf655043SAndy Whitcroft } 3166cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3167cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3168cf655043SAndy Whitcroft $allowed = 1; 3169cf655043SAndy Whitcroft } 3170cf655043SAndy Whitcroft } 3171cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 317269932487SJustin P. Mattock my $herectx = $here . "\n"; 3173f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3174cf655043SAndy Whitcroft 3175f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 317669932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3177cf655043SAndy Whitcroft } 3178cf655043SAndy Whitcroft 3179000d1cc1SJoe Perches WARN("BRACES", 3180000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3181f0a594c1SAndy Whitcroft } 3182f0a594c1SAndy Whitcroft } 3183f0a594c1SAndy Whitcroft 3184653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 31854a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 3186c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 3187000d1cc1SJoe Perches ERROR("DEPRECATED_INCLUDE", 3188000d1cc1SJoe Perches "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 31890a920b5bSAndy Whitcroft } 31900a920b5bSAndy Whitcroft } 31910a920b5bSAndy Whitcroft 31924a0df2efSAndy Whitcroft# don't use deprecated functions 31934a0df2efSAndy Whitcroft for my $func (@dep_functions) { 319400df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 3195000d1cc1SJoe Perches ERROR("DEPRECATED_FUNCTION", 3196000d1cc1SJoe Perches "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 31974a0df2efSAndy Whitcroft } 31984a0df2efSAndy Whitcroft } 31994a0df2efSAndy Whitcroft 32004a0df2efSAndy Whitcroft# no volatiles please 32016c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 32026c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3203000d1cc1SJoe Perches WARN("VOLATILE", 3204000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 32054a0df2efSAndy Whitcroft } 32064a0df2efSAndy Whitcroft 320700df344fSAndy Whitcroft# warn about #if 0 3208c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3209000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3210000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3211de7d4f0eSAndy Whitcroft $herecurr); 32124a0df2efSAndy Whitcroft } 32134a0df2efSAndy Whitcroft 3214f0a594c1SAndy Whitcroft# check for needless kfree() checks 3215f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3216f0a594c1SAndy Whitcroft my $expr = $1; 3217f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 3218000d1cc1SJoe Perches WARN("NEEDLESS_KFREE", 3219000d1cc1SJoe Perches "kfree(NULL) is safe this check is probably not required\n" . $hereprev); 3220f0a594c1SAndy Whitcroft } 3221f0a594c1SAndy Whitcroft } 32224c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 32234c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 32244c432a8fSGreg Kroah-Hartman my $expr = $1; 32254c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 3226000d1cc1SJoe Perches WARN("NEEDLESS_USB_FREE_URB", 3227000d1cc1SJoe Perches "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 32284c432a8fSGreg Kroah-Hartman } 32294c432a8fSGreg Kroah-Hartman } 3230f0a594c1SAndy Whitcroft 32311a15a250SPatrick Pannuto# prefer usleep_range over udelay 32321a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 32331a15a250SPatrick Pannuto # ignore udelay's < 10, however 32341a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3235000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3236000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 32371a15a250SPatrick Pannuto } 32381a15a250SPatrick Pannuto } 32391a15a250SPatrick Pannuto 324009ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 324109ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 324209ef8725SPatrick Pannuto if ($1 < 20) { 3243000d1cc1SJoe Perches WARN("MSLEEP", 3244000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 324509ef8725SPatrick Pannuto } 324609ef8725SPatrick Pannuto } 324709ef8725SPatrick Pannuto 324800df344fSAndy Whitcroft# warn about #ifdefs in C files 3249c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 325000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 325100df344fSAndy Whitcroft# print "$herecurr"; 325200df344fSAndy Whitcroft# $clean = 0; 325300df344fSAndy Whitcroft# } 325400df344fSAndy Whitcroft 325522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3256c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3257000d1cc1SJoe Perches ERROR("SPACING", 3258000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 325922f2a2efSAndy Whitcroft } 326022f2a2efSAndy Whitcroft 32614a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3262171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3263171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 32644a0df2efSAndy Whitcroft my $which = $1; 32654a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3266000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3267000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 32684a0df2efSAndy Whitcroft } 32694a0df2efSAndy Whitcroft } 32704a0df2efSAndy Whitcroft# check for memory barriers without a comment. 32714a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 32724a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3273000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3274000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 32754a0df2efSAndy Whitcroft } 32764a0df2efSAndy Whitcroft } 32774a0df2efSAndy Whitcroft# check of hardware specific defines 3278c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3279000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3280000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 32810a920b5bSAndy Whitcroft } 3282653d4876SAndy Whitcroft 3283d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3284d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3285000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3286000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3287d4977c78STobias Klauser } 3288d4977c78STobias Klauser 3289de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3290de7d4f0eSAndy Whitcroft# storage class and type. 32919c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 32929c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3293000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3294000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3295de7d4f0eSAndy Whitcroft } 3296de7d4f0eSAndy Whitcroft 32978905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 32988905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3299000d1cc1SJoe Perches WARN("INLINE", 3300000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 33018905a67cSAndy Whitcroft } 33028905a67cSAndy Whitcroft 33033d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 33043d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3305000d1cc1SJoe Perches WARN("PREFER_PACKED", 3306000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 33073d130fd0SJoe Perches } 33083d130fd0SJoe Perches 330939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 331039b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3311000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3312000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 331339b7e287SJoe Perches } 331439b7e287SJoe Perches 33155f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 33165f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 33175f14d3bdSJoe Perches WARN("PREFER_PRINTF", 33185f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 33195f14d3bdSJoe Perches } 33205f14d3bdSJoe Perches 33216061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 33226061d949SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 33236061d949SJoe Perches WARN("PREFER_SCANF", 33246061d949SJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); 33256061d949SJoe Perches } 33266061d949SJoe Perches 33278f53a9b8SJoe Perches# check for sizeof(&) 33288f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3329000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3330000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 33318f53a9b8SJoe Perches } 33328f53a9b8SJoe Perches 333366c80b60SJoe Perches# check for sizeof without parenthesis 333466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 333566c80b60SJoe Perches WARN("SIZEOF_PARENTHESIS", 333666c80b60SJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr); 333766c80b60SJoe Perches } 333866c80b60SJoe Perches 3339428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3340428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3341000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3342000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3343428e2fdcSJoe Perches } 3344428e2fdcSJoe Perches 3345554e165cSAndy Whitcroft# Check for misused memsets 3346d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3347d1fe9c09SJoe Perches defined $stat && 3348d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3349554e165cSAndy Whitcroft 3350d7c76ba7SJoe Perches my $ms_addr = $2; 3351d1fe9c09SJoe Perches my $ms_val = $7; 3352d1fe9c09SJoe Perches my $ms_size = $12; 3353d7c76ba7SJoe Perches 3354554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3355554e165cSAndy Whitcroft ERROR("MEMSET", 3356d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3357554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3358554e165cSAndy Whitcroft WARN("MEMSET", 3359d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3360d7c76ba7SJoe Perches } 3361d7c76ba7SJoe Perches } 3362d7c76ba7SJoe Perches 3363d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3364d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3365d1fe9c09SJoe Perches defined $stat && 3366d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3367d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3368d7c76ba7SJoe Perches my $call = $1; 3369d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3370d7c76ba7SJoe Perches my $arg1 = $3; 3371d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3372d1fe9c09SJoe Perches my $arg2 = $8; 3373d7c76ba7SJoe Perches my $cast; 3374d7c76ba7SJoe Perches 3375d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3376d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3377d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3378d7c76ba7SJoe Perches $cast = $cast1; 3379d7c76ba7SJoe Perches } else { 3380d7c76ba7SJoe Perches $cast = $cast2; 3381d7c76ba7SJoe Perches } 3382d7c76ba7SJoe Perches WARN("MINMAX", 3383d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3384554e165cSAndy Whitcroft } 3385554e165cSAndy Whitcroft } 3386554e165cSAndy Whitcroft 33874a273195SJoe Perches# check usleep_range arguments 33884a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 33894a273195SJoe Perches defined $stat && 33904a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 33914a273195SJoe Perches my $min = $1; 33924a273195SJoe Perches my $max = $7; 33934a273195SJoe Perches if ($min eq $max) { 33944a273195SJoe Perches WARN("USLEEP_RANGE", 33954a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 33964a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 33974a273195SJoe Perches $min > $max) { 33984a273195SJoe Perches WARN("USLEEP_RANGE", 33994a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34004a273195SJoe Perches } 34014a273195SJoe Perches } 34024a273195SJoe Perches 3403de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3404171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3405c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3406171ae1a4SAndy Whitcroft { 3407c45dcabdSAndy Whitcroft my $function_name = $1; 3408c45dcabdSAndy Whitcroft my $paren_space = $2; 3409171ae1a4SAndy Whitcroft 3410171ae1a4SAndy Whitcroft my $s = $stat; 3411171ae1a4SAndy Whitcroft if (defined $cond) { 3412171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3413171ae1a4SAndy Whitcroft } 3414c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3415c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3416c45dcabdSAndy Whitcroft { 3417000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3418000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3419de7d4f0eSAndy Whitcroft } 3420de7d4f0eSAndy Whitcroft 3421171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3422000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3423000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3424171ae1a4SAndy Whitcroft } 34259c9ba34eSAndy Whitcroft 34269c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 34279c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 34289c9ba34eSAndy Whitcroft { 3429000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3430000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3431171ae1a4SAndy Whitcroft } 3432171ae1a4SAndy Whitcroft 3433de7d4f0eSAndy Whitcroft# checks for new __setup's 3434de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3435de7d4f0eSAndy Whitcroft my $name = $1; 3436de7d4f0eSAndy Whitcroft 3437de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3438000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3439000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3440de7d4f0eSAndy Whitcroft } 3441653d4876SAndy Whitcroft } 34429c0ca6f9SAndy Whitcroft 34439c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3444caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3445000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3446000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 34479c0ca6f9SAndy Whitcroft } 344813214adfSAndy Whitcroft 3449caf2a54fSJoe Perches# check for multiple semicolons 3450caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3451000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3452000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3453caf2a54fSJoe Perches } 3454caf2a54fSJoe Perches 345513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 345613214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3457000d1cc1SJoe Perches WARN("USE_FUNC", 3458000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 345913214adfSAndy Whitcroft } 3460773647a0SAndy Whitcroft 34612c92488aSJoe Perches# check for use of yield() 34622c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 34632c92488aSJoe Perches WARN("YIELD", 34642c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 34652c92488aSJoe Perches } 34662c92488aSJoe Perches 34674882720bSThomas Gleixner# check for semaphores initialized locked 34684882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3469000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3470000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 3471773647a0SAndy Whitcroft } 34726712d858SJoe Perches 347367d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 347467d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3475000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 347667d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3477773647a0SAndy Whitcroft } 34786712d858SJoe Perches 3479f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3480f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3481000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3482000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3483f3db6639SMichael Ellerman } 34846712d858SJoe Perches 348579404849SEmese Revfy# check for various ops structs, ensure they are const. 348679404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 348779404849SEmese Revfy address_space_operations| 348879404849SEmese Revfy backlight_ops| 348979404849SEmese Revfy block_device_operations| 349079404849SEmese Revfy dentry_operations| 349179404849SEmese Revfy dev_pm_ops| 349279404849SEmese Revfy dma_map_ops| 349379404849SEmese Revfy extent_io_ops| 349479404849SEmese Revfy file_lock_operations| 349579404849SEmese Revfy file_operations| 349679404849SEmese Revfy hv_ops| 349779404849SEmese Revfy ide_dma_ops| 349879404849SEmese Revfy intel_dvo_dev_ops| 349979404849SEmese Revfy item_operations| 350079404849SEmese Revfy iwl_ops| 350179404849SEmese Revfy kgdb_arch| 350279404849SEmese Revfy kgdb_io| 350379404849SEmese Revfy kset_uevent_ops| 350479404849SEmese Revfy lock_manager_operations| 350579404849SEmese Revfy microcode_ops| 350679404849SEmese Revfy mtrr_ops| 350779404849SEmese Revfy neigh_ops| 350879404849SEmese Revfy nlmsvc_binding| 350979404849SEmese Revfy pci_raw_ops| 351079404849SEmese Revfy pipe_buf_operations| 351179404849SEmese Revfy platform_hibernation_ops| 351279404849SEmese Revfy platform_suspend_ops| 351379404849SEmese Revfy proto_ops| 351479404849SEmese Revfy rpc_pipe_ops| 351579404849SEmese Revfy seq_operations| 351679404849SEmese Revfy snd_ac97_build_ops| 351779404849SEmese Revfy soc_pcmcia_socket_ops| 351879404849SEmese Revfy stacktrace_ops| 351979404849SEmese Revfy sysfs_ops| 352079404849SEmese Revfy tty_operations| 352179404849SEmese Revfy usb_mon_operations| 352279404849SEmese Revfy wd_ops}x; 35236903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 352479404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3525000d1cc1SJoe Perches WARN("CONST_STRUCT", 3526000d1cc1SJoe Perches "struct $1 should normally be const\n" . 35276903ffb2SAndy Whitcroft $herecurr); 35282b6db5cbSAndy Whitcroft } 3529773647a0SAndy Whitcroft 3530773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3531773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3532773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3533c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3534c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3535171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3536171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3537171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3538773647a0SAndy Whitcroft { 3539000d1cc1SJoe Perches WARN("NR_CPUS", 3540000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3541773647a0SAndy Whitcroft } 35429c9ba34eSAndy Whitcroft 35439c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 35449c9ba34eSAndy Whitcroft my $string; 35459c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 35469c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 35472a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 35489c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3549000d1cc1SJoe Perches WARN("PRINTF_L", 3550000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 35519c9ba34eSAndy Whitcroft last; 35529c9ba34eSAndy Whitcroft } 35539c9ba34eSAndy Whitcroft } 3554691d77b6SAndy Whitcroft 3555691d77b6SAndy Whitcroft# whine mightly about in_atomic 3556691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3557691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3558000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3559000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3560f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3561000d1cc1SJoe Perches WARN("IN_ATOMIC", 3562000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3563691d77b6SAndy Whitcroft } 3564691d77b6SAndy Whitcroft } 35651704f47bSPeter Zijlstra 35661704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 35671704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 35681704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 35691704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 35701704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 35711704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3572000d1cc1SJoe Perches ERROR("LOCKDEP", 3573000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 35741704f47bSPeter Zijlstra } 35751704f47bSPeter Zijlstra } 357688f8831cSDave Jones 357788f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 357888f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3579000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3580000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 358188f8831cSDave Jones } 358213214adfSAndy Whitcroft } 358313214adfSAndy Whitcroft 358413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 358513214adfSAndy Whitcroft # so just keep quiet. 358613214adfSAndy Whitcroft if ($#rawlines == -1) { 358713214adfSAndy Whitcroft exit(0); 35880a920b5bSAndy Whitcroft } 35890a920b5bSAndy Whitcroft 35908905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 35918905a67cSAndy Whitcroft # things that appear to be patches. 35928905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 35938905a67cSAndy Whitcroft exit(0); 35948905a67cSAndy Whitcroft } 35958905a67cSAndy Whitcroft 35968905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 35978905a67cSAndy Whitcroft # just keep quiet. 35988905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 35998905a67cSAndy Whitcroft exit(0); 36008905a67cSAndy Whitcroft } 36018905a67cSAndy Whitcroft 36028905a67cSAndy Whitcroft if (!$is_patch) { 3603000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3604000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 36050a920b5bSAndy Whitcroft } 36060a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3607000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3608000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 36090a920b5bSAndy Whitcroft } 36100a920b5bSAndy Whitcroft 3611f0a594c1SAndy Whitcroft print report_dump(); 361213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 361313214adfSAndy Whitcroft print "$filename " if ($summary_file); 36146c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 36156c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 36166c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 36178905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 36186c72ffaaSAndy Whitcroft } 36198905a67cSAndy Whitcroft 3620d2c0a235SAndy Whitcroft if ($quiet == 0) { 3621d1fe9c09SJoe Perches 3622d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 3623d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 3624d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 3625d1fe9c09SJoe Perches } 3626d1fe9c09SJoe Perches 3627d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3628d2c0a235SAndy Whitcroft # then suggest that. 3629d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3630d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3631d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3632b0781216SMike Frysinger $rpt_cleaners = 0; 3633d2c0a235SAndy Whitcroft } 3634d2c0a235SAndy Whitcroft } 3635d2c0a235SAndy Whitcroft 363611232688SArtem Bityutskiy if ($quiet == 0 && keys %ignore_type) { 3637000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3638000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3639000d1cc1SJoe Perches print " $ignore"; 3640000d1cc1SJoe Perches } 364111232688SArtem Bityutskiy print "\n\n"; 3642000d1cc1SJoe Perches } 3643000d1cc1SJoe Perches 36440a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3645c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 36460a920b5bSAndy Whitcroft } 36470a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3648000d1cc1SJoe Perches print << "EOM"; 3649000d1cc1SJoe Perches$vname has style problems, please review. 3650000d1cc1SJoe Perches 3651000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3652000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3653000d1cc1SJoe PerchesEOM 36540a920b5bSAndy Whitcroft } 365513214adfSAndy Whitcroft 36560a920b5bSAndy Whitcroft return $clean; 36570a920b5bSAndy Whitcroft} 3658