10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftmy $P = $0; 1100df344fSAndy Whitcroft$P =~ s@.*/@@g; 120a920b5bSAndy Whitcroft 13000d1cc1SJoe Perchesmy $V = '0.32'; 140a920b5bSAndy Whitcroft 150a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 160a920b5bSAndy Whitcroft 170a920b5bSAndy Whitcroftmy $quiet = 0; 180a920b5bSAndy Whitcroftmy $tree = 1; 190a920b5bSAndy Whitcroftmy $chk_signoff = 1; 200a920b5bSAndy Whitcroftmy $chk_patch = 1; 21773647a0SAndy Whitcroftmy $tst_only; 226c72ffaaSAndy Whitcroftmy $emacs = 0; 238905a67cSAndy Whitcroftmy $terse = 0; 246c72ffaaSAndy Whitcroftmy $file = 0; 256c72ffaaSAndy Whitcroftmy $check = 0; 268905a67cSAndy Whitcroftmy $summary = 1; 278905a67cSAndy Whitcroftmy $mailback = 0; 2813214adfSAndy Whitcroftmy $summary_file = 0; 29000d1cc1SJoe Perchesmy $show_types = 0; 306c72ffaaSAndy Whitcroftmy $root; 31c2fdda0dSAndy Whitcroftmy %debug; 32000d1cc1SJoe Perchesmy %ignore_type = (); 33000d1cc1SJoe Perchesmy @ignore = (); 3477f5b10aSHannes Edermy $help = 0; 35000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 3677f5b10aSHannes Eder 3777f5b10aSHannes Edersub help { 3877f5b10aSHannes Eder my ($exitcode) = @_; 3977f5b10aSHannes Eder 4077f5b10aSHannes Eder print << "EOM"; 4177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 4277f5b10aSHannes EderVersion: $V 4377f5b10aSHannes Eder 4477f5b10aSHannes EderOptions: 4577f5b10aSHannes Eder -q, --quiet quiet 4677f5b10aSHannes Eder --no-tree run without a kernel tree 4777f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 4877f5b10aSHannes Eder --patch treat FILE as patchfile (default) 4977f5b10aSHannes Eder --emacs emacs compile window format 5077f5b10aSHannes Eder --terse one line per report 5177f5b10aSHannes Eder -f, --file treat FILE as regular source file 5277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 53000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 54000d1cc1SJoe Perches --show-types show the message "types" in the output 5577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 5677f5b10aSHannes Eder --no-summary suppress the per-file summary 5777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 5877f5b10aSHannes Eder --summary-file include the filename in summary 5977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 6077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 6177f5b10aSHannes Eder is all off) 6277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 6377f5b10aSHannes Eder literally 6477f5b10aSHannes Eder -h, --help, --version display this help and exit 6577f5b10aSHannes Eder 6677f5b10aSHannes EderWhen FILE is - read standard input. 6777f5b10aSHannes EderEOM 6877f5b10aSHannes Eder 6977f5b10aSHannes Eder exit($exitcode); 7077f5b10aSHannes Eder} 7177f5b10aSHannes Eder 72000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 73000d1cc1SJoe Perchesif (-f $conf) { 74000d1cc1SJoe Perches my @conf_args; 75000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 76000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 77000d1cc1SJoe Perches 78000d1cc1SJoe Perches while (<$conffile>) { 79000d1cc1SJoe Perches my $line = $_; 80000d1cc1SJoe Perches 81000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 82000d1cc1SJoe Perches $line =~ s/^\s*//g; 83000d1cc1SJoe Perches $line =~ s/\s+/ /g; 84000d1cc1SJoe Perches 85000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 86000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 87000d1cc1SJoe Perches 88000d1cc1SJoe Perches my @words = split(" ", $line); 89000d1cc1SJoe Perches foreach my $word (@words) { 90000d1cc1SJoe Perches last if ($word =~ m/^#/); 91000d1cc1SJoe Perches push (@conf_args, $word); 92000d1cc1SJoe Perches } 93000d1cc1SJoe Perches } 94000d1cc1SJoe Perches close($conffile); 95000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 96000d1cc1SJoe Perches} 97000d1cc1SJoe Perches 980a920b5bSAndy WhitcroftGetOptions( 996c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1000a920b5bSAndy Whitcroft 'tree!' => \$tree, 1010a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1020a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1036c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1048905a67cSAndy Whitcroft 'terse!' => \$terse, 10577f5b10aSHannes Eder 'f|file!' => \$file, 1066c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1076c72ffaaSAndy Whitcroft 'strict!' => \$check, 108000d1cc1SJoe Perches 'ignore=s' => \@ignore, 109000d1cc1SJoe Perches 'show-types!' => \$show_types, 1106c72ffaaSAndy Whitcroft 'root=s' => \$root, 1118905a67cSAndy Whitcroft 'summary!' => \$summary, 1128905a67cSAndy Whitcroft 'mailback!' => \$mailback, 11313214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 11413214adfSAndy Whitcroft 115c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 116773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 11777f5b10aSHannes Eder 'h|help' => \$help, 11877f5b10aSHannes Eder 'version' => \$help 11977f5b10aSHannes Eder) or help(1); 12077f5b10aSHannes Eder 12177f5b10aSHannes Ederhelp(0) if ($help); 1220a920b5bSAndy Whitcroft 1230a920b5bSAndy Whitcroftmy $exit = 0; 1240a920b5bSAndy Whitcroft 1250a920b5bSAndy Whitcroftif ($#ARGV < 0) { 12677f5b10aSHannes Eder print "$P: no input files\n"; 1270a920b5bSAndy Whitcroft exit(1); 1280a920b5bSAndy Whitcroft} 1290a920b5bSAndy Whitcroft 130000d1cc1SJoe Perches@ignore = split(/,/, join(',',@ignore)); 131000d1cc1SJoe Perchesforeach my $word (@ignore) { 132000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 133000d1cc1SJoe Perches $word =~ s/^\s*//g; 134000d1cc1SJoe Perches $word =~ s/\s+/ /g; 135000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 136000d1cc1SJoe Perches 137000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 138000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 139000d1cc1SJoe Perches 140000d1cc1SJoe Perches $ignore_type{$word}++; 141000d1cc1SJoe Perches} 142000d1cc1SJoe Perches 143c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 144c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1457429c690SAndy Whitcroftmy $dbg_type = 0; 146a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 147c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 14821caa13cSAndy Whitcroft ## no critic 14921caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 15021caa13cSAndy Whitcroft die "$@" if ($@); 151c2fdda0dSAndy Whitcroft} 152c2fdda0dSAndy Whitcroft 153d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 154d2c0a235SAndy Whitcroft 1558905a67cSAndy Whitcroftif ($terse) { 1568905a67cSAndy Whitcroft $emacs = 1; 1578905a67cSAndy Whitcroft $quiet++; 1588905a67cSAndy Whitcroft} 1598905a67cSAndy Whitcroft 1606c72ffaaSAndy Whitcroftif ($tree) { 1616c72ffaaSAndy Whitcroft if (defined $root) { 1626c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 1636c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 1646c72ffaaSAndy Whitcroft } 1656c72ffaaSAndy Whitcroft } else { 1666c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 1676c72ffaaSAndy Whitcroft $root = '.'; 1686c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 1696c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 1706c72ffaaSAndy Whitcroft $root = $1; 1716c72ffaaSAndy Whitcroft } 1726c72ffaaSAndy Whitcroft } 1736c72ffaaSAndy Whitcroft 1746c72ffaaSAndy Whitcroft if (!defined $root) { 1750a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 1760a920b5bSAndy Whitcroft exit(2); 1770a920b5bSAndy Whitcroft } 1786c72ffaaSAndy Whitcroft} 1796c72ffaaSAndy Whitcroft 1806c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1816c72ffaaSAndy Whitcroft 1822ceb532bSAndy Whitcroftour $Ident = qr{ 1832ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 1842ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 1852ceb532bSAndy Whitcroft }x; 1866c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1876c72ffaaSAndy Whitcroftour $Sparse = qr{ 1886c72ffaaSAndy Whitcroft __user| 1896c72ffaaSAndy Whitcroft __kernel| 1906c72ffaaSAndy Whitcroft __force| 1916c72ffaaSAndy Whitcroft __iomem| 1926c72ffaaSAndy Whitcroft __must_check| 1936c72ffaaSAndy Whitcroft __init_refok| 194417495edSAndy Whitcroft __kprobes| 195165e72a6SSven Eckelmann __ref| 196165e72a6SSven Eckelmann __rcu 1976c72ffaaSAndy Whitcroft }x; 19852131292SWolfram Sang 19952131292SWolfram Sang# Notes to $Attribute: 20052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2016c72ffaaSAndy Whitcroftour $Attribute = qr{ 2026c72ffaaSAndy Whitcroft const| 20303f1df7dSJoe Perches __percpu| 20403f1df7dSJoe Perches __nocast| 20503f1df7dSJoe Perches __safe| 20603f1df7dSJoe Perches __bitwise__| 20703f1df7dSJoe Perches __packed__| 20803f1df7dSJoe Perches __packed2__| 20903f1df7dSJoe Perches __naked| 21003f1df7dSJoe Perches __maybe_unused| 21103f1df7dSJoe Perches __always_unused| 21203f1df7dSJoe Perches __noreturn| 21303f1df7dSJoe Perches __used| 21403f1df7dSJoe Perches __cold| 21503f1df7dSJoe Perches __noclone| 21603f1df7dSJoe Perches __deprecated| 2176c72ffaaSAndy Whitcroft __read_mostly| 2186c72ffaaSAndy Whitcroft __kprobes| 21952131292SWolfram Sang __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| 22024e1d81aSAndy Whitcroft ____cacheline_aligned| 22124e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2225fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2235fe3af11SAndy Whitcroft __weak 2246c72ffaaSAndy Whitcroft }x; 225c45dcabdSAndy Whitcroftour $Modifier; 2266c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2276c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2286c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2296c72ffaaSAndy Whitcroft 2306c72ffaaSAndy Whitcroftour $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 2316c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 23286f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 2336c72ffaaSAndy Whitcroftour $Operators = qr{ 2346c72ffaaSAndy Whitcroft <=|>=|==|!=| 2356c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 236c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 2376c72ffaaSAndy Whitcroft }x; 2386c72ffaaSAndy Whitcroft 2398905a67cSAndy Whitcroftour $NonptrType; 2408905a67cSAndy Whitcroftour $Type; 2418905a67cSAndy Whitcroftour $Declare; 2428905a67cSAndy Whitcroft 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 (?: 318c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 3198ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 320c45dcabdSAndy Whitcroft (?:${all}\b) 321cf655043SAndy Whitcroft ) 322c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 3238905a67cSAndy Whitcroft }x; 3248905a67cSAndy Whitcroft $Type = qr{ 325c45dcabdSAndy Whitcroft $NonptrType 32665863862SAndy Whitcroft (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 327c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 3288905a67cSAndy Whitcroft }x; 3298905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 3308905a67cSAndy Whitcroft} 3318905a67cSAndy Whitcroftbuild_types(); 3326c72ffaaSAndy Whitcroft 3337d2367afSJoe Perchesour $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/; 3347d2367afSJoe Perches 3357d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 3367d2367afSJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*}; 3377d2367afSJoe Perches 3387d2367afSJoe Perchessub deparenthesize { 3397d2367afSJoe Perches my ($string) = @_; 3407d2367afSJoe Perches return "" if (!defined($string)); 3417d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 3427d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 3437d2367afSJoe Perches $string =~ s@\s+@ @g; 3447d2367afSJoe Perches return $string; 3457d2367afSJoe Perches} 3467d2367afSJoe Perches 3476c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 3480a920b5bSAndy Whitcroft 3494a0df2efSAndy Whitcroftmy @dep_includes = (); 3504a0df2efSAndy Whitcroftmy @dep_functions = (); 3516c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 3526c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 35321caa13cSAndy Whitcroft open(my $REMOVE, '<', "$root/$removal") || 3546c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 35521caa13cSAndy Whitcroft while (<$REMOVE>) { 356f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 357f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 358f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 3594a0df2efSAndy Whitcroft push(@dep_includes, $1); 3604a0df2efSAndy Whitcroft 361f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 362f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 363f0a594c1SAndy Whitcroft } 3644a0df2efSAndy Whitcroft } 3650a920b5bSAndy Whitcroft } 3660a920b5bSAndy Whitcroft } 36721caa13cSAndy Whitcroft close($REMOVE); 3680a920b5bSAndy Whitcroft} 3690a920b5bSAndy Whitcroft 37000df344fSAndy Whitcroftmy @rawlines = (); 371c2fdda0dSAndy Whitcroftmy @lines = (); 372c2fdda0dSAndy Whitcroftmy $vname; 3736c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 37421caa13cSAndy Whitcroft my $FILE; 3756c72ffaaSAndy Whitcroft if ($file) { 37621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 3776c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 37821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 37921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 3806c72ffaaSAndy Whitcroft } else { 38121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 3826c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 3836c72ffaaSAndy Whitcroft } 384c2fdda0dSAndy Whitcroft if ($filename eq '-') { 385c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 386c2fdda0dSAndy Whitcroft } else { 387c2fdda0dSAndy Whitcroft $vname = $filename; 388c2fdda0dSAndy Whitcroft } 38921caa13cSAndy Whitcroft while (<$FILE>) { 3900a920b5bSAndy Whitcroft chomp; 39100df344fSAndy Whitcroft push(@rawlines, $_); 3926c72ffaaSAndy Whitcroft } 39321caa13cSAndy Whitcroft close($FILE); 394c2fdda0dSAndy Whitcroft if (!process($filename)) { 3950a920b5bSAndy Whitcroft $exit = 1; 3960a920b5bSAndy Whitcroft } 39700df344fSAndy Whitcroft @rawlines = (); 39813214adfSAndy Whitcroft @lines = (); 3990a920b5bSAndy Whitcroft} 4000a920b5bSAndy Whitcroft 4010a920b5bSAndy Whitcroftexit($exit); 4020a920b5bSAndy Whitcroft 4030a920b5bSAndy Whitcroftsub top_of_kernel_tree { 4046c72ffaaSAndy Whitcroft my ($root) = @_; 4056c72ffaaSAndy Whitcroft 4066c72ffaaSAndy Whitcroft my @tree_check = ( 4076c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 4086c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 4096c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 4106c72ffaaSAndy Whitcroft ); 4116c72ffaaSAndy Whitcroft 4126c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 4136c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 4140a920b5bSAndy Whitcroft return 0; 4150a920b5bSAndy Whitcroft } 4166c72ffaaSAndy Whitcroft } 4176c72ffaaSAndy Whitcroft return 1; 4186c72ffaaSAndy Whitcroft } 4190a920b5bSAndy Whitcroft 42020112475SJoe Perchessub parse_email { 42120112475SJoe Perches my ($formatted_email) = @_; 42220112475SJoe Perches 42320112475SJoe Perches my $name = ""; 42420112475SJoe Perches my $address = ""; 42520112475SJoe Perches my $comment = ""; 42620112475SJoe Perches 42720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 42820112475SJoe Perches $name = $1; 42920112475SJoe Perches $address = $2; 43020112475SJoe Perches $comment = $3 if defined $3; 43120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 43220112475SJoe Perches $address = $1; 43320112475SJoe Perches $comment = $2 if defined $2; 43420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 43520112475SJoe Perches $address = $1; 43620112475SJoe Perches $comment = $2 if defined $2; 43720112475SJoe Perches $formatted_email =~ s/$address.*$//; 43820112475SJoe Perches $name = $formatted_email; 43920112475SJoe Perches $name =~ s/^\s+|\s+$//g; 44020112475SJoe Perches $name =~ s/^\"|\"$//g; 44120112475SJoe Perches # If there's a name left after stripping spaces and 44220112475SJoe Perches # leading quotes, and the address doesn't have both 44320112475SJoe Perches # leading and trailing angle brackets, the address 44420112475SJoe Perches # is invalid. ie: 44520112475SJoe Perches # "joe smith [email protected]" bad 44620112475SJoe Perches # "joe smith <[email protected]" bad 44720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 44820112475SJoe Perches $name = ""; 44920112475SJoe Perches $address = ""; 45020112475SJoe Perches $comment = ""; 45120112475SJoe Perches } 45220112475SJoe Perches } 45320112475SJoe Perches 45420112475SJoe Perches $name =~ s/^\s+|\s+$//g; 45520112475SJoe Perches $name =~ s/^\"|\"$//g; 45620112475SJoe Perches $address =~ s/^\s+|\s+$//g; 45720112475SJoe Perches $address =~ s/^\<|\>$//g; 45820112475SJoe Perches 45920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 46020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 46120112475SJoe Perches $name = "\"$name\""; 46220112475SJoe Perches } 46320112475SJoe Perches 46420112475SJoe Perches return ($name, $address, $comment); 46520112475SJoe Perches} 46620112475SJoe Perches 46720112475SJoe Perchessub format_email { 46820112475SJoe Perches my ($name, $address) = @_; 46920112475SJoe Perches 47020112475SJoe Perches my $formatted_email; 47120112475SJoe Perches 47220112475SJoe Perches $name =~ s/^\s+|\s+$//g; 47320112475SJoe Perches $name =~ s/^\"|\"$//g; 47420112475SJoe Perches $address =~ s/^\s+|\s+$//g; 47520112475SJoe Perches 47620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 47720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 47820112475SJoe Perches $name = "\"$name\""; 47920112475SJoe Perches } 48020112475SJoe Perches 48120112475SJoe Perches if ("$name" eq "") { 48220112475SJoe Perches $formatted_email = "$address"; 48320112475SJoe Perches } else { 48420112475SJoe Perches $formatted_email = "$name <$address>"; 48520112475SJoe Perches } 48620112475SJoe Perches 48720112475SJoe Perches return $formatted_email; 48820112475SJoe Perches} 48920112475SJoe Perches 490000d1cc1SJoe Perchessub which_conf { 491000d1cc1SJoe Perches my ($conf) = @_; 492000d1cc1SJoe Perches 493000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 494000d1cc1SJoe Perches if (-e "$path/$conf") { 495000d1cc1SJoe Perches return "$path/$conf"; 496000d1cc1SJoe Perches } 497000d1cc1SJoe Perches } 498000d1cc1SJoe Perches 499000d1cc1SJoe Perches return ""; 500000d1cc1SJoe Perches} 501000d1cc1SJoe Perches 5020a920b5bSAndy Whitcroftsub expand_tabs { 5030a920b5bSAndy Whitcroft my ($str) = @_; 5040a920b5bSAndy Whitcroft 5050a920b5bSAndy Whitcroft my $res = ''; 5060a920b5bSAndy Whitcroft my $n = 0; 5070a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 5080a920b5bSAndy Whitcroft if ($c eq "\t") { 5090a920b5bSAndy Whitcroft $res .= ' '; 5100a920b5bSAndy Whitcroft $n++; 5110a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 5120a920b5bSAndy Whitcroft $res .= ' '; 5130a920b5bSAndy Whitcroft } 5140a920b5bSAndy Whitcroft next; 5150a920b5bSAndy Whitcroft } 5160a920b5bSAndy Whitcroft $res .= $c; 5170a920b5bSAndy Whitcroft $n++; 5180a920b5bSAndy Whitcroft } 5190a920b5bSAndy Whitcroft 5200a920b5bSAndy Whitcroft return $res; 5210a920b5bSAndy Whitcroft} 5226c72ffaaSAndy Whitcroftsub copy_spacing { 523773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 5246c72ffaaSAndy Whitcroft return $res; 5256c72ffaaSAndy Whitcroft} 5260a920b5bSAndy Whitcroft 5274a0df2efSAndy Whitcroftsub line_stats { 5284a0df2efSAndy Whitcroft my ($line) = @_; 5294a0df2efSAndy Whitcroft 5304a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 5314a0df2efSAndy Whitcroft $line =~ s/^.//; 5324a0df2efSAndy Whitcroft $line = expand_tabs($line); 5334a0df2efSAndy Whitcroft 5344a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 5354a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 5364a0df2efSAndy Whitcroft 5374a0df2efSAndy Whitcroft return (length($line), length($white)); 5384a0df2efSAndy Whitcroft} 5394a0df2efSAndy Whitcroft 540773647a0SAndy Whitcroftmy $sanitise_quote = ''; 541773647a0SAndy Whitcroft 542773647a0SAndy Whitcroftsub sanitise_line_reset { 543773647a0SAndy Whitcroft my ($in_comment) = @_; 544773647a0SAndy Whitcroft 545773647a0SAndy Whitcroft if ($in_comment) { 546773647a0SAndy Whitcroft $sanitise_quote = '*/'; 547773647a0SAndy Whitcroft } else { 548773647a0SAndy Whitcroft $sanitise_quote = ''; 549773647a0SAndy Whitcroft } 550773647a0SAndy Whitcroft} 55100df344fSAndy Whitcroftsub sanitise_line { 55200df344fSAndy Whitcroft my ($line) = @_; 55300df344fSAndy Whitcroft 55400df344fSAndy Whitcroft my $res = ''; 55500df344fSAndy Whitcroft my $l = ''; 55600df344fSAndy Whitcroft 557c2fdda0dSAndy Whitcroft my $qlen = 0; 558773647a0SAndy Whitcroft my $off = 0; 559773647a0SAndy Whitcroft my $c; 56000df344fSAndy Whitcroft 561773647a0SAndy Whitcroft # Always copy over the diff marker. 562773647a0SAndy Whitcroft $res = substr($line, 0, 1); 563773647a0SAndy Whitcroft 564773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 565773647a0SAndy Whitcroft $c = substr($line, $off, 1); 566773647a0SAndy Whitcroft 567773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 568773647a0SAndy Whitcroft # and end, all to $;. 569773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 570773647a0SAndy Whitcroft $sanitise_quote = '*/'; 571773647a0SAndy Whitcroft 572773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 573773647a0SAndy Whitcroft $off++; 57400df344fSAndy Whitcroft next; 575773647a0SAndy Whitcroft } 57681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 577773647a0SAndy Whitcroft $sanitise_quote = ''; 578773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 579773647a0SAndy Whitcroft $off++; 580773647a0SAndy Whitcroft next; 581773647a0SAndy Whitcroft } 582113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 583113f04a8SDaniel Walker $sanitise_quote = '//'; 584113f04a8SDaniel Walker 585113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 586113f04a8SDaniel Walker $off++; 587113f04a8SDaniel Walker next; 588113f04a8SDaniel Walker } 589773647a0SAndy Whitcroft 590773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 591773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 592773647a0SAndy Whitcroft $c eq "\\") { 593773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 594773647a0SAndy Whitcroft $off++; 595773647a0SAndy Whitcroft next; 596773647a0SAndy Whitcroft } 597773647a0SAndy Whitcroft # Regular quotes. 598773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 599773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 600773647a0SAndy Whitcroft $sanitise_quote = $c; 601773647a0SAndy Whitcroft 602773647a0SAndy Whitcroft substr($res, $off, 1, $c); 603773647a0SAndy Whitcroft next; 604773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 605773647a0SAndy Whitcroft $sanitise_quote = ''; 60600df344fSAndy Whitcroft } 60700df344fSAndy Whitcroft } 608773647a0SAndy Whitcroft 609fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 610773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 611773647a0SAndy Whitcroft substr($res, $off, 1, $;); 612113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 613113f04a8SDaniel Walker substr($res, $off, 1, $;); 614773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 615773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 61600df344fSAndy Whitcroft } else { 617773647a0SAndy Whitcroft substr($res, $off, 1, $c); 61800df344fSAndy Whitcroft } 619c2fdda0dSAndy Whitcroft } 620c2fdda0dSAndy Whitcroft 621113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 622113f04a8SDaniel Walker $sanitise_quote = ''; 623113f04a8SDaniel Walker } 624113f04a8SDaniel Walker 625c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 626c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 627c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 628c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 629c2fdda0dSAndy Whitcroft 630c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 631c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 632c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 633c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 634c2fdda0dSAndy Whitcroft } 635c2fdda0dSAndy Whitcroft 63600df344fSAndy Whitcroft return $res; 63700df344fSAndy Whitcroft} 63800df344fSAndy Whitcroft 6398905a67cSAndy Whitcroftsub ctx_statement_block { 6408905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6418905a67cSAndy Whitcroft my $line = $linenr - 1; 6428905a67cSAndy Whitcroft my $blk = ''; 6438905a67cSAndy Whitcroft my $soff = $off; 6448905a67cSAndy Whitcroft my $coff = $off - 1; 645773647a0SAndy Whitcroft my $coff_set = 0; 6468905a67cSAndy Whitcroft 64713214adfSAndy Whitcroft my $loff = 0; 64813214adfSAndy Whitcroft 6498905a67cSAndy Whitcroft my $type = ''; 6508905a67cSAndy Whitcroft my $level = 0; 651a2750645SAndy Whitcroft my @stack = (); 652cf655043SAndy Whitcroft my $p; 6538905a67cSAndy Whitcroft my $c; 6548905a67cSAndy Whitcroft my $len = 0; 65513214adfSAndy Whitcroft 65613214adfSAndy Whitcroft my $remainder; 6578905a67cSAndy Whitcroft while (1) { 658a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 659a2750645SAndy Whitcroft 660773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6618905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6628905a67cSAndy Whitcroft # context. 6638905a67cSAndy Whitcroft if ($off >= $len) { 6648905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 665dea33496SAndy Whitcroft last if (!defined $lines[$line]); 666c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6678905a67cSAndy Whitcroft $remain--; 66813214adfSAndy Whitcroft $loff = $len; 669c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6708905a67cSAndy Whitcroft $len = length($blk); 6718905a67cSAndy Whitcroft $line++; 6728905a67cSAndy Whitcroft last; 6738905a67cSAndy Whitcroft } 6748905a67cSAndy Whitcroft # Bail if there is no further context. 6758905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 67613214adfSAndy Whitcroft if ($off >= $len) { 6778905a67cSAndy Whitcroft last; 6788905a67cSAndy Whitcroft } 6798905a67cSAndy Whitcroft } 680cf655043SAndy Whitcroft $p = $c; 6818905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 68213214adfSAndy Whitcroft $remainder = substr($blk, $off); 6838905a67cSAndy Whitcroft 684773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6854635f4fbSAndy Whitcroft 6864635f4fbSAndy Whitcroft # Handle nested #if/#else. 6874635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6884635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6894635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 6904635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 6914635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 6924635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 6934635f4fbSAndy Whitcroft } 6944635f4fbSAndy Whitcroft 6958905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 6968905a67cSAndy Whitcroft # outermost level. 6978905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 6988905a67cSAndy Whitcroft last; 6998905a67cSAndy Whitcroft } 7008905a67cSAndy Whitcroft 70113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 702773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 703773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 704773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 705773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 706773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 707773647a0SAndy Whitcroft $coff_set = 1; 708773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 709773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 71013214adfSAndy Whitcroft } 71113214adfSAndy Whitcroft 7128905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7138905a67cSAndy Whitcroft $level++; 7148905a67cSAndy Whitcroft $type = '('; 7158905a67cSAndy Whitcroft } 7168905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7178905a67cSAndy Whitcroft $level--; 7188905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7198905a67cSAndy Whitcroft 7208905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7218905a67cSAndy Whitcroft $coff = $off; 722773647a0SAndy Whitcroft $coff_set = 1; 723773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7248905a67cSAndy Whitcroft } 7258905a67cSAndy Whitcroft } 7268905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7278905a67cSAndy Whitcroft $level++; 7288905a67cSAndy Whitcroft $type = '{'; 7298905a67cSAndy Whitcroft } 7308905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7318905a67cSAndy Whitcroft $level--; 7328905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7338905a67cSAndy Whitcroft 7348905a67cSAndy Whitcroft if ($level == 0) { 735b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 736b998e001SPatrick Pannuto $off++; 737b998e001SPatrick Pannuto } 7388905a67cSAndy Whitcroft last; 7398905a67cSAndy Whitcroft } 7408905a67cSAndy Whitcroft } 7418905a67cSAndy Whitcroft $off++; 7428905a67cSAndy Whitcroft } 743a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 74413214adfSAndy Whitcroft if ($off == $len) { 745a3bb97a7SAndy Whitcroft $loff = $len + 1; 74613214adfSAndy Whitcroft $line++; 74713214adfSAndy Whitcroft $remain--; 74813214adfSAndy Whitcroft } 7498905a67cSAndy Whitcroft 7508905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7518905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7528905a67cSAndy Whitcroft 7538905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7548905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7558905a67cSAndy Whitcroft 756773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 75713214adfSAndy Whitcroft 75813214adfSAndy Whitcroft return ($statement, $condition, 75913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 76013214adfSAndy Whitcroft} 76113214adfSAndy Whitcroft 762cf655043SAndy Whitcroftsub statement_lines { 763cf655043SAndy Whitcroft my ($stmt) = @_; 764cf655043SAndy Whitcroft 765cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 766cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 767cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 768cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 769cf655043SAndy Whitcroft 770cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 771cf655043SAndy Whitcroft 772cf655043SAndy Whitcroft return $#stmt_lines + 2; 773cf655043SAndy Whitcroft} 774cf655043SAndy Whitcroft 775cf655043SAndy Whitcroftsub statement_rawlines { 776cf655043SAndy Whitcroft my ($stmt) = @_; 777cf655043SAndy Whitcroft 778cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 779cf655043SAndy Whitcroft 780cf655043SAndy Whitcroft return $#stmt_lines + 2; 781cf655043SAndy Whitcroft} 782cf655043SAndy Whitcroft 783cf655043SAndy Whitcroftsub statement_block_size { 784cf655043SAndy Whitcroft my ($stmt) = @_; 785cf655043SAndy Whitcroft 786cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 787cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 788cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 789cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 790cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 791cf655043SAndy Whitcroft 792cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 793cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 794cf655043SAndy Whitcroft 795cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 796cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 797cf655043SAndy Whitcroft 798cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 799cf655043SAndy Whitcroft return $stmt_lines; 800cf655043SAndy Whitcroft } else { 801cf655043SAndy Whitcroft return $stmt_statements; 802cf655043SAndy Whitcroft } 803cf655043SAndy Whitcroft} 804cf655043SAndy Whitcroft 80513214adfSAndy Whitcroftsub ctx_statement_full { 80613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 80713214adfSAndy Whitcroft my ($statement, $condition, $level); 80813214adfSAndy Whitcroft 80913214adfSAndy Whitcroft my (@chunks); 81013214adfSAndy Whitcroft 811cf655043SAndy Whitcroft # Grab the first conditional/block pair. 81213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 81313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 814773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 81513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 816cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 817cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 818cf655043SAndy Whitcroft } 819cf655043SAndy Whitcroft 820cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 821cf655043SAndy Whitcroft # could continue the statement. 822cf655043SAndy Whitcroft for (;;) { 82313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 82413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 825cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 826773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 827cf655043SAndy Whitcroft #print "C: push\n"; 828cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 82913214adfSAndy Whitcroft } 83013214adfSAndy Whitcroft 83113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8328905a67cSAndy Whitcroft} 8338905a67cSAndy Whitcroft 8344a0df2efSAndy Whitcroftsub ctx_block_get { 835f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8364a0df2efSAndy Whitcroft my $line; 8374a0df2efSAndy Whitcroft my $start = $linenr - 1; 8384a0df2efSAndy Whitcroft my $blk = ''; 8394a0df2efSAndy Whitcroft my @o; 8404a0df2efSAndy Whitcroft my @c; 8414a0df2efSAndy Whitcroft my @res = (); 8424a0df2efSAndy Whitcroft 843f0a594c1SAndy Whitcroft my $level = 0; 8444635f4fbSAndy Whitcroft my @stack = ($level); 84500df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 84600df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 84700df344fSAndy Whitcroft $remain--; 84800df344fSAndy Whitcroft 84900df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8504635f4fbSAndy Whitcroft 8514635f4fbSAndy Whitcroft # Handle nested #if/#else. 85201464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8534635f4fbSAndy Whitcroft push(@stack, $level); 85401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8554635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 85601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8574635f4fbSAndy Whitcroft $level = pop(@stack); 8584635f4fbSAndy Whitcroft } 8594635f4fbSAndy Whitcroft 86001464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 861f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 862f0a594c1SAndy Whitcroft if ($off > 0) { 863f0a594c1SAndy Whitcroft $off--; 864f0a594c1SAndy Whitcroft next; 865f0a594c1SAndy Whitcroft } 8664a0df2efSAndy Whitcroft 867f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 868f0a594c1SAndy Whitcroft $level--; 869f0a594c1SAndy Whitcroft last if ($level == 0); 870f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 871f0a594c1SAndy Whitcroft $level++; 872f0a594c1SAndy Whitcroft } 873f0a594c1SAndy Whitcroft } 8744a0df2efSAndy Whitcroft 875f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 87600df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8774a0df2efSAndy Whitcroft } 8784a0df2efSAndy Whitcroft 879f0a594c1SAndy Whitcroft last if ($level == 0); 8804a0df2efSAndy Whitcroft } 8814a0df2efSAndy Whitcroft 882f0a594c1SAndy Whitcroft return ($level, @res); 8834a0df2efSAndy Whitcroft} 8844a0df2efSAndy Whitcroftsub ctx_block_outer { 8854a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8864a0df2efSAndy Whitcroft 887f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 888f0a594c1SAndy Whitcroft return @r; 8894a0df2efSAndy Whitcroft} 8904a0df2efSAndy Whitcroftsub ctx_block { 8914a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8924a0df2efSAndy Whitcroft 893f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 894f0a594c1SAndy Whitcroft return @r; 895653d4876SAndy Whitcroft} 896653d4876SAndy Whitcroftsub ctx_statement { 897f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 898f0a594c1SAndy Whitcroft 899f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 900f0a594c1SAndy Whitcroft return @r; 901f0a594c1SAndy Whitcroft} 902f0a594c1SAndy Whitcroftsub ctx_block_level { 903653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 904653d4876SAndy Whitcroft 905f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9064a0df2efSAndy Whitcroft} 9079c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9089c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9099c0ca6f9SAndy Whitcroft 9109c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9119c0ca6f9SAndy Whitcroft} 9124a0df2efSAndy Whitcroft 9134a0df2efSAndy Whitcroftsub ctx_locate_comment { 9144a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9154a0df2efSAndy Whitcroft 9164a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 917beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9184a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9194a0df2efSAndy Whitcroft 9204a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9214a0df2efSAndy Whitcroft # comment. 9224a0df2efSAndy Whitcroft my $in_comment = 0; 9234a0df2efSAndy Whitcroft $current_comment = ''; 9244a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 92500df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 92600df344fSAndy Whitcroft #warn " $line\n"; 9274a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9284a0df2efSAndy Whitcroft $in_comment = 1; 9294a0df2efSAndy Whitcroft } 9304a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9314a0df2efSAndy Whitcroft $in_comment = 1; 9324a0df2efSAndy Whitcroft } 9334a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9344a0df2efSAndy Whitcroft $current_comment = ''; 9354a0df2efSAndy Whitcroft } 9364a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9374a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9384a0df2efSAndy Whitcroft $in_comment = 0; 9394a0df2efSAndy Whitcroft } 9404a0df2efSAndy Whitcroft } 9414a0df2efSAndy Whitcroft 9424a0df2efSAndy Whitcroft chomp($current_comment); 9434a0df2efSAndy Whitcroft return($current_comment); 9444a0df2efSAndy Whitcroft} 9454a0df2efSAndy Whitcroftsub ctx_has_comment { 9464a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9474a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9484a0df2efSAndy Whitcroft 94900df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9504a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9514a0df2efSAndy Whitcroft 9524a0df2efSAndy Whitcroft return ($cmt ne ''); 9534a0df2efSAndy Whitcroft} 9544a0df2efSAndy Whitcroft 9554d001e4dSAndy Whitcroftsub raw_line { 9564d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9574d001e4dSAndy Whitcroft 9584d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9594d001e4dSAndy Whitcroft $cnt++; 9604d001e4dSAndy Whitcroft 9614d001e4dSAndy Whitcroft my $line; 9624d001e4dSAndy Whitcroft while ($cnt) { 9634d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9644d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9654d001e4dSAndy Whitcroft $cnt--; 9664d001e4dSAndy Whitcroft } 9674d001e4dSAndy Whitcroft 9684d001e4dSAndy Whitcroft return $line; 9694d001e4dSAndy Whitcroft} 9704d001e4dSAndy Whitcroft 9710a920b5bSAndy Whitcroftsub cat_vet { 9720a920b5bSAndy Whitcroft my ($vet) = @_; 9739c0ca6f9SAndy Whitcroft my ($res, $coded); 9740a920b5bSAndy Whitcroft 9759c0ca6f9SAndy Whitcroft $res = ''; 9766c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9776c72ffaaSAndy Whitcroft $res .= $1; 9786c72ffaaSAndy Whitcroft if ($2 ne '') { 9799c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9806c72ffaaSAndy Whitcroft $res .= $coded; 9816c72ffaaSAndy Whitcroft } 9829c0ca6f9SAndy Whitcroft } 9839c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 9840a920b5bSAndy Whitcroft 9859c0ca6f9SAndy Whitcroft return $res; 9860a920b5bSAndy Whitcroft} 9870a920b5bSAndy Whitcroft 988c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 989cf655043SAndy Whitcroftmy $av_pending; 990c2fdda0dSAndy Whitcroftmy @av_paren_type; 9911f65f947SAndy Whitcroftmy $av_pend_colon; 992c2fdda0dSAndy Whitcroft 993c2fdda0dSAndy Whitcroftsub annotate_reset { 994c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 995cf655043SAndy Whitcroft $av_pending = '_'; 996cf655043SAndy Whitcroft @av_paren_type = ('E'); 9971f65f947SAndy Whitcroft $av_pend_colon = 'O'; 998c2fdda0dSAndy Whitcroft} 999c2fdda0dSAndy Whitcroft 10006c72ffaaSAndy Whitcroftsub annotate_values { 10016c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10026c72ffaaSAndy Whitcroft 10036c72ffaaSAndy Whitcroft my $res; 10041f65f947SAndy Whitcroft my $var = '_' x length($stream); 10056c72ffaaSAndy Whitcroft my $cur = $stream; 10066c72ffaaSAndy Whitcroft 1007c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10086c72ffaaSAndy Whitcroft 10096c72ffaaSAndy Whitcroft while (length($cur)) { 1010773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1011cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1012171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10136c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1014c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1015c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1016cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1017c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10186c72ffaaSAndy Whitcroft } 10196c72ffaaSAndy Whitcroft 1020c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10219446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10229446ef56SAndy Whitcroft push(@av_paren_type, $type); 10239446ef56SAndy Whitcroft $type = 'C'; 10249446ef56SAndy Whitcroft 1025e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1026c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10276c72ffaaSAndy Whitcroft $type = 'T'; 10286c72ffaaSAndy Whitcroft 1029389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1030389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1031389a2fe5SAndy Whitcroft $type = 'T'; 1032389a2fe5SAndy Whitcroft 1033c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1034171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1035c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1036171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1037171ae1a4SAndy Whitcroft if ($2 ne '') { 1038cf655043SAndy Whitcroft $av_pending = 'N'; 1039171ae1a4SAndy Whitcroft } 1040171ae1a4SAndy Whitcroft $type = 'E'; 1041171ae1a4SAndy Whitcroft 1042c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1043171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1044171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1045171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10466c72ffaaSAndy Whitcroft 1047c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1048cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1049c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1050cf655043SAndy Whitcroft 1051cf655043SAndy Whitcroft push(@av_paren_type, $type); 1052cf655043SAndy Whitcroft push(@av_paren_type, $type); 1053171ae1a4SAndy Whitcroft $type = 'E'; 1054cf655043SAndy Whitcroft 1055c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1056cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1057cf655043SAndy Whitcroft $av_preprocessor = 1; 1058cf655043SAndy Whitcroft 1059cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1060cf655043SAndy Whitcroft 1061171ae1a4SAndy Whitcroft $type = 'E'; 1062cf655043SAndy Whitcroft 1063c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1064cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1065cf655043SAndy Whitcroft 1066cf655043SAndy Whitcroft $av_preprocessor = 1; 1067cf655043SAndy Whitcroft 1068cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1069cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1070cf655043SAndy Whitcroft pop(@av_paren_type); 1071cf655043SAndy Whitcroft push(@av_paren_type, $type); 1072171ae1a4SAndy Whitcroft $type = 'E'; 10736c72ffaaSAndy Whitcroft 10746c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1075c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10766c72ffaaSAndy Whitcroft 1077171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1078171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1079171ae1a4SAndy Whitcroft $av_pending = $type; 1080171ae1a4SAndy Whitcroft $type = 'N'; 1081171ae1a4SAndy Whitcroft 10826c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1083c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 10846c72ffaaSAndy Whitcroft if (defined $2) { 1085cf655043SAndy Whitcroft $av_pending = 'V'; 10866c72ffaaSAndy Whitcroft } 10876c72ffaaSAndy Whitcroft $type = 'N'; 10886c72ffaaSAndy Whitcroft 108914b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1090c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 109114b111c1SAndy Whitcroft $av_pending = 'E'; 10926c72ffaaSAndy Whitcroft $type = 'N'; 10936c72ffaaSAndy Whitcroft 10941f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 10951f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 10961f65f947SAndy Whitcroft $av_pend_colon = 'C'; 10971f65f947SAndy Whitcroft $type = 'N'; 10981f65f947SAndy Whitcroft 109914b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1100c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11016c72ffaaSAndy Whitcroft $type = 'N'; 11026c72ffaaSAndy Whitcroft 11036c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1104c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1105cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1106cf655043SAndy Whitcroft $av_pending = '_'; 11076c72ffaaSAndy Whitcroft $type = 'N'; 11086c72ffaaSAndy Whitcroft 11096c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1110cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1111cf655043SAndy Whitcroft if ($new_type ne '_') { 1112cf655043SAndy Whitcroft $type = $new_type; 1113c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1114c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11156c72ffaaSAndy Whitcroft } else { 1116c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11176c72ffaaSAndy Whitcroft } 11186c72ffaaSAndy Whitcroft 1119c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1120c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1121c8cb2ca3SAndy Whitcroft $type = 'V'; 1122cf655043SAndy Whitcroft $av_pending = 'V'; 11236c72ffaaSAndy Whitcroft 11248e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11258e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11261f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11278e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11288e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11291f65f947SAndy Whitcroft } 11301f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11311f65f947SAndy Whitcroft $type = 'V'; 11321f65f947SAndy Whitcroft 11336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1134c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11356c72ffaaSAndy Whitcroft $type = 'V'; 11366c72ffaaSAndy Whitcroft 11376c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1138c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11396c72ffaaSAndy Whitcroft $type = 'N'; 11406c72ffaaSAndy Whitcroft 1141cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1142c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 114313214adfSAndy Whitcroft $type = 'E'; 11441f65f947SAndy Whitcroft $av_pend_colon = 'O'; 114513214adfSAndy Whitcroft 11468e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11478e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11488e761b04SAndy Whitcroft $type = 'C'; 11498e761b04SAndy Whitcroft 11501f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11511f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11521f65f947SAndy Whitcroft $type = 'N'; 11531f65f947SAndy Whitcroft 11541f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11551f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11561f65f947SAndy Whitcroft 11571f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11581f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11591f65f947SAndy Whitcroft $type = 'E'; 11601f65f947SAndy Whitcroft } else { 11611f65f947SAndy Whitcroft $type = 'N'; 11621f65f947SAndy Whitcroft } 11631f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11641f65f947SAndy Whitcroft 11658e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 116613214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11676c72ffaaSAndy Whitcroft $type = 'N'; 11686c72ffaaSAndy Whitcroft 11690d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 117074048ed8SAndy Whitcroft my $variant; 117174048ed8SAndy Whitcroft 117274048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 117374048ed8SAndy Whitcroft if ($type eq 'V') { 117474048ed8SAndy Whitcroft $variant = 'B'; 117574048ed8SAndy Whitcroft } else { 117674048ed8SAndy Whitcroft $variant = 'U'; 117774048ed8SAndy Whitcroft } 117874048ed8SAndy Whitcroft 117974048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 118074048ed8SAndy Whitcroft $type = 'N'; 118174048ed8SAndy Whitcroft 11826c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1183c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 11846c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 11856c72ffaaSAndy Whitcroft $type = 'N'; 11866c72ffaaSAndy Whitcroft } 11876c72ffaaSAndy Whitcroft 11886c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1189c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 11906c72ffaaSAndy Whitcroft } 11916c72ffaaSAndy Whitcroft if (defined $1) { 11926c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 11936c72ffaaSAndy Whitcroft $res .= $type x length($1); 11946c72ffaaSAndy Whitcroft } 11956c72ffaaSAndy Whitcroft } 11966c72ffaaSAndy Whitcroft 11971f65f947SAndy Whitcroft return ($res, $var); 11986c72ffaaSAndy Whitcroft} 11996c72ffaaSAndy Whitcroft 12008905a67cSAndy Whitcroftsub possible { 120113214adfSAndy Whitcroft my ($possible, $line) = @_; 12029a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12030776e594SAndy Whitcroft ^(?: 12040776e594SAndy Whitcroft $Modifier| 12050776e594SAndy Whitcroft $Storage| 12060776e594SAndy Whitcroft $Type| 12079a974fdbSAndy Whitcroft DEFINE_\S+ 12089a974fdbSAndy Whitcroft )$| 12099a974fdbSAndy Whitcroft ^(?: 12100776e594SAndy Whitcroft goto| 12110776e594SAndy Whitcroft return| 12120776e594SAndy Whitcroft case| 12130776e594SAndy Whitcroft else| 12140776e594SAndy Whitcroft asm|__asm__| 12150776e594SAndy Whitcroft do 12169a974fdbSAndy Whitcroft )(?:\s|$)| 12170776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12189a974fdbSAndy Whitcroft )}x; 12199a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12209a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1221c45dcabdSAndy Whitcroft # Check for modifiers. 1222c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1223c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1224c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1225c45dcabdSAndy Whitcroft 1226c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1227c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1228d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12299a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1230d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1231d2506586SAndy Whitcroft push(@modifierList, $modifier); 1232d2506586SAndy Whitcroft } 12339a974fdbSAndy Whitcroft } 1234c45dcabdSAndy Whitcroft 1235c45dcabdSAndy Whitcroft } else { 123613214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12378905a67cSAndy Whitcroft push(@typeList, $possible); 1238c45dcabdSAndy Whitcroft } 12398905a67cSAndy Whitcroft build_types(); 12400776e594SAndy Whitcroft } else { 12410776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12428905a67cSAndy Whitcroft } 12438905a67cSAndy Whitcroft} 12448905a67cSAndy Whitcroft 12456c72ffaaSAndy Whitcroftmy $prefix = ''; 12466c72ffaaSAndy Whitcroft 1247000d1cc1SJoe Perchessub show_type { 1248000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1249000d1cc1SJoe Perches} 1250000d1cc1SJoe Perches 1251f0a594c1SAndy Whitcroftsub report { 1252000d1cc1SJoe Perches if (!show_type($_[1]) || 1253000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1254773647a0SAndy Whitcroft return 0; 1255773647a0SAndy Whitcroft } 1256000d1cc1SJoe Perches my $line; 1257000d1cc1SJoe Perches if ($show_types) { 1258000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1259000d1cc1SJoe Perches } else { 1260000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1261000d1cc1SJoe Perches } 12628905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12638905a67cSAndy Whitcroft 126413214adfSAndy Whitcroft push(our @report, $line); 1265773647a0SAndy Whitcroft 1266773647a0SAndy Whitcroft return 1; 1267f0a594c1SAndy Whitcroft} 1268f0a594c1SAndy Whitcroftsub report_dump { 126913214adfSAndy Whitcroft our @report; 1270f0a594c1SAndy Whitcroft} 1271000d1cc1SJoe Perches 1272de7d4f0eSAndy Whitcroftsub ERROR { 1273000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1274de7d4f0eSAndy Whitcroft our $clean = 0; 12756c72ffaaSAndy Whitcroft our $cnt_error++; 1276de7d4f0eSAndy Whitcroft } 1277773647a0SAndy Whitcroft} 1278de7d4f0eSAndy Whitcroftsub WARN { 1279000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1280de7d4f0eSAndy Whitcroft our $clean = 0; 12816c72ffaaSAndy Whitcroft our $cnt_warn++; 1282de7d4f0eSAndy Whitcroft } 1283773647a0SAndy Whitcroft} 1284de7d4f0eSAndy Whitcroftsub CHK { 1285000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1286de7d4f0eSAndy Whitcroft our $clean = 0; 12876c72ffaaSAndy Whitcroft our $cnt_chk++; 12886c72ffaaSAndy Whitcroft } 1289de7d4f0eSAndy Whitcroft} 1290de7d4f0eSAndy Whitcroft 12916ecd9674SAndy Whitcroftsub check_absolute_file { 12926ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 12936ecd9674SAndy Whitcroft my $file = $absolute; 12946ecd9674SAndy Whitcroft 12956ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 12966ecd9674SAndy Whitcroft 12976ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 12986ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 12996ecd9674SAndy Whitcroft if (-f "$root/$file") { 13006ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13016ecd9674SAndy Whitcroft last; 13026ecd9674SAndy Whitcroft } 13036ecd9674SAndy Whitcroft } 13046ecd9674SAndy Whitcroft if (! -f _) { 13056ecd9674SAndy Whitcroft return 0; 13066ecd9674SAndy Whitcroft } 13076ecd9674SAndy Whitcroft 13086ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13096ecd9674SAndy Whitcroft my $prefix = $absolute; 13106ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13116ecd9674SAndy Whitcroft 13126ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13136ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1314000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1315000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13166ecd9674SAndy Whitcroft } 13176ecd9674SAndy Whitcroft} 13186ecd9674SAndy Whitcroft 13190a920b5bSAndy Whitcroftsub process { 13200a920b5bSAndy Whitcroft my $filename = shift; 13210a920b5bSAndy Whitcroft 13220a920b5bSAndy Whitcroft my $linenr=0; 13230a920b5bSAndy Whitcroft my $prevline=""; 1324c2fdda0dSAndy Whitcroft my $prevrawline=""; 13250a920b5bSAndy Whitcroft my $stashline=""; 1326c2fdda0dSAndy Whitcroft my $stashrawline=""; 13270a920b5bSAndy Whitcroft 13284a0df2efSAndy Whitcroft my $length; 13290a920b5bSAndy Whitcroft my $indent; 13300a920b5bSAndy Whitcroft my $previndent=0; 13310a920b5bSAndy Whitcroft my $stashindent=0; 13320a920b5bSAndy Whitcroft 1333de7d4f0eSAndy Whitcroft our $clean = 1; 13340a920b5bSAndy Whitcroft my $signoff = 0; 13350a920b5bSAndy Whitcroft my $is_patch = 0; 13360a920b5bSAndy Whitcroft 133715662b3eSJoe Perches my $in_header_lines = 1; 133815662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 133915662b3eSJoe Perches 134013214adfSAndy Whitcroft our @report = (); 13416c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13426c72ffaaSAndy Whitcroft our $cnt_error = 0; 13436c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13446c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13456c72ffaaSAndy Whitcroft 13460a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13470a920b5bSAndy Whitcroft my $realfile = ''; 13480a920b5bSAndy Whitcroft my $realline = 0; 13490a920b5bSAndy Whitcroft my $realcnt = 0; 13500a920b5bSAndy Whitcroft my $here = ''; 13510a920b5bSAndy Whitcroft my $in_comment = 0; 1352c2fdda0dSAndy Whitcroft my $comment_edge = 0; 13530a920b5bSAndy Whitcroft my $first_line = 0; 13541e855726SWolfram Sang my $p1_prefix = ''; 13550a920b5bSAndy Whitcroft 135613214adfSAndy Whitcroft my $prev_values = 'E'; 135713214adfSAndy Whitcroft 135813214adfSAndy Whitcroft # suppression flags 1359773647a0SAndy Whitcroft my %suppress_ifbraces; 1360170d3a22SAndy Whitcroft my %suppress_whiletrailers; 13612b474a1aSAndy Whitcroft my %suppress_export; 1362653d4876SAndy Whitcroft 1363c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1364de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1365c2fdda0dSAndy Whitcroft # 1366de7d4f0eSAndy Whitcroft my @setup_docs = (); 1367de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1368773647a0SAndy Whitcroft 1369773647a0SAndy Whitcroft sanitise_line_reset(); 1370c2fdda0dSAndy Whitcroft my $line; 1371c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1372773647a0SAndy Whitcroft $linenr++; 1373773647a0SAndy Whitcroft $line = $rawline; 1374c2fdda0dSAndy Whitcroft 1375773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1376de7d4f0eSAndy Whitcroft $setup_docs = 0; 1377de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1378de7d4f0eSAndy Whitcroft $setup_docs = 1; 1379de7d4f0eSAndy Whitcroft } 1380773647a0SAndy Whitcroft #next; 1381de7d4f0eSAndy Whitcroft } 1382773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1383773647a0SAndy Whitcroft $realline=$1-1; 1384773647a0SAndy Whitcroft if (defined $2) { 1385773647a0SAndy Whitcroft $realcnt=$3+1; 1386773647a0SAndy Whitcroft } else { 1387773647a0SAndy Whitcroft $realcnt=1+1; 1388773647a0SAndy Whitcroft } 1389c45dcabdSAndy Whitcroft $in_comment = 0; 1390773647a0SAndy Whitcroft 1391773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1392773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1393773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1394773647a0SAndy Whitcroft # at context start. 1395773647a0SAndy Whitcroft my $edge; 139601fa9147SAndy Whitcroft my $cnt = $realcnt; 139701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 139801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 139901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 140001fa9147SAndy Whitcroft $cnt--; 140101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1402721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1403fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1404fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1405fae17daeSAndy Whitcroft ($edge) = $1; 1406fae17daeSAndy Whitcroft last; 1407fae17daeSAndy Whitcroft } 1408773647a0SAndy Whitcroft } 1409773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1410773647a0SAndy Whitcroft $in_comment = 1; 1411773647a0SAndy Whitcroft } 1412773647a0SAndy Whitcroft 1413773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1414773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1415773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1416773647a0SAndy Whitcroft if (!defined $edge && 141783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1418773647a0SAndy Whitcroft { 1419773647a0SAndy Whitcroft $in_comment = 1; 1420773647a0SAndy Whitcroft } 1421773647a0SAndy Whitcroft 1422773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1423773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1424773647a0SAndy Whitcroft 1425171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1426773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1427171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1428773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1429773647a0SAndy Whitcroft } 1430773647a0SAndy Whitcroft push(@lines, $line); 1431773647a0SAndy Whitcroft 1432773647a0SAndy Whitcroft if ($realcnt > 1) { 1433773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1434773647a0SAndy Whitcroft } else { 1435773647a0SAndy Whitcroft $realcnt = 0; 1436773647a0SAndy Whitcroft } 1437773647a0SAndy Whitcroft 1438773647a0SAndy Whitcroft #print "==>$rawline\n"; 1439773647a0SAndy Whitcroft #print "-->$line\n"; 1440de7d4f0eSAndy Whitcroft 1441de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1442de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1443de7d4f0eSAndy Whitcroft } 1444de7d4f0eSAndy Whitcroft } 1445de7d4f0eSAndy Whitcroft 14466c72ffaaSAndy Whitcroft $prefix = ''; 14476c72ffaaSAndy Whitcroft 1448773647a0SAndy Whitcroft $realcnt = 0; 1449773647a0SAndy Whitcroft $linenr = 0; 14500a920b5bSAndy Whitcroft foreach my $line (@lines) { 14510a920b5bSAndy Whitcroft $linenr++; 14520a920b5bSAndy Whitcroft 1453c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 14546c72ffaaSAndy Whitcroft 14550a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 14566c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14570a920b5bSAndy Whitcroft $is_patch = 1; 14584a0df2efSAndy Whitcroft $first_line = $linenr + 1; 14590a920b5bSAndy Whitcroft $realline=$1-1; 14600a920b5bSAndy Whitcroft if (defined $2) { 14610a920b5bSAndy Whitcroft $realcnt=$3+1; 14620a920b5bSAndy Whitcroft } else { 14630a920b5bSAndy Whitcroft $realcnt=1+1; 14640a920b5bSAndy Whitcroft } 1465c2fdda0dSAndy Whitcroft annotate_reset(); 146613214adfSAndy Whitcroft $prev_values = 'E'; 146713214adfSAndy Whitcroft 1468773647a0SAndy Whitcroft %suppress_ifbraces = (); 1469170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 14702b474a1aSAndy Whitcroft %suppress_export = (); 14710a920b5bSAndy Whitcroft next; 14720a920b5bSAndy Whitcroft 14734a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 14744a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 14754a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1476773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 14770a920b5bSAndy Whitcroft $realline++; 1478d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 14790a920b5bSAndy Whitcroft 14804a0df2efSAndy Whitcroft # Measure the line length and indent. 1481c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 14820a920b5bSAndy Whitcroft 14830a920b5bSAndy Whitcroft # Track the previous line. 14840a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 14850a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1486c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1487c2fdda0dSAndy Whitcroft 1488773647a0SAndy Whitcroft #warn "line<$line>\n"; 14896c72ffaaSAndy Whitcroft 1490d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1491d8aaf121SAndy Whitcroft $realcnt--; 14920a920b5bSAndy Whitcroft } 14930a920b5bSAndy Whitcroft 1494cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1495cc77cdcaSAndy Whitcroft 14960a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1497773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1498773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1499773647a0SAndy Whitcroft 15006c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15016c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1502773647a0SAndy Whitcroft 1503773647a0SAndy Whitcroft # extract the filename as it passes 15043bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15053bf9a009SRabin Vincent $realfile = $1; 15063bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1507270c49a0SJoe Perches $in_commit_log = 0; 15083bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1509773647a0SAndy Whitcroft $realfile = $1; 15101e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1511270c49a0SJoe Perches $in_commit_log = 0; 15121e855726SWolfram Sang 15131e855726SWolfram Sang $p1_prefix = $1; 1514e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1515e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1516000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1517000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15181e855726SWolfram Sang } 1519773647a0SAndy Whitcroft 1520c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1521000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1522000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1523773647a0SAndy Whitcroft } 1524773647a0SAndy Whitcroft next; 1525773647a0SAndy Whitcroft } 1526773647a0SAndy Whitcroft 1527389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15280a920b5bSAndy Whitcroft 1529c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1530c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1531c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15320a920b5bSAndy Whitcroft 15336c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15346c72ffaaSAndy Whitcroft 15353bf9a009SRabin Vincent# Check for incorrect file permissions 15363bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15373bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 15383bf9a009SRabin Vincent if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1539000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1540000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15413bf9a009SRabin Vincent } 15423bf9a009SRabin Vincent } 15433bf9a009SRabin Vincent 154420112475SJoe Perches# Check the patch for a signoff: 1545d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15464a0df2efSAndy Whitcroft $signoff++; 154715662b3eSJoe Perches $in_commit_log = 0; 15480a920b5bSAndy Whitcroft } 154920112475SJoe Perches 155020112475SJoe Perches# Check signature styles 1551270c49a0SJoe Perches if (!$in_header_lines && 1552270c49a0SJoe Perches $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) { 155320112475SJoe Perches my $space_before = $1; 155420112475SJoe Perches my $sign_off = $2; 155520112475SJoe Perches my $space_after = $3; 155620112475SJoe Perches my $email = $4; 155720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 155820112475SJoe Perches 155920112475SJoe Perches if (defined $space_before && $space_before ne "") { 1560000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1561000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 156220112475SJoe Perches } 156320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1564000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1565000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 156620112475SJoe Perches } 156720112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1568000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1569000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 157020112475SJoe Perches } 157120112475SJoe Perches 157220112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 157320112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 157420112475SJoe Perches if ($suggested_email eq "") { 1575000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1576000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 157720112475SJoe Perches } else { 157820112475SJoe Perches my $dequoted = $suggested_email; 157920112475SJoe Perches $dequoted =~ s/^"//; 158020112475SJoe Perches $dequoted =~ s/" </ </; 158120112475SJoe Perches # Don't force email to have quotes 158220112475SJoe Perches # Allow just an angle bracketed address 158320112475SJoe Perches if ("$dequoted$comment" ne $email && 158420112475SJoe Perches "<$email_address>$comment" ne $email && 158520112475SJoe Perches "$suggested_email$comment" ne $email) { 1586000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1587000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 158820112475SJoe Perches } 15890a920b5bSAndy Whitcroft } 15900a920b5bSAndy Whitcroft } 15910a920b5bSAndy Whitcroft 159200df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 15938905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1594000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1595000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 15966c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1597de7d4f0eSAndy Whitcroft } 1598de7d4f0eSAndy Whitcroft 15996ecd9674SAndy Whitcroft# Check for absolute kernel paths. 16006ecd9674SAndy Whitcroft if ($tree) { 16016ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 16026ecd9674SAndy Whitcroft my $file = $1; 16036ecd9674SAndy Whitcroft 16046ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16056ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16066ecd9674SAndy Whitcroft # 16076ecd9674SAndy Whitcroft } else { 16086ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16096ecd9674SAndy Whitcroft } 16106ecd9674SAndy Whitcroft } 16116ecd9674SAndy Whitcroft } 16126ecd9674SAndy Whitcroft 1613de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1614de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1615171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1616171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1617171ae1a4SAndy Whitcroft 1618171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1619171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1620171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1621171ae1a4SAndy Whitcroft 162234d99219SJoe Perches CHK("INVALID_UTF8", 1623000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 162400df344fSAndy Whitcroft } 16250a920b5bSAndy Whitcroft 162615662b3eSJoe Perches# Check if it's the start of a commit log 162715662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 162815662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1629270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 163015662b3eSJoe Perches $in_header_lines = 0; 163115662b3eSJoe Perches $in_commit_log = 1; 163215662b3eSJoe Perches } 163315662b3eSJoe Perches 163415662b3eSJoe Perches# Still not yet in a patch, check for any UTF-8 163515662b3eSJoe Perches if ($in_commit_log && $realfile =~ /^$/ && 163615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 163715662b3eSJoe Perches CHK("UTF8_BEFORE_PATCH", 163815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 163915662b3eSJoe Perches } 164015662b3eSJoe Perches 164130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 164230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 164300df344fSAndy Whitcroft 16440a920b5bSAndy Whitcroft#trailing whitespace 16459c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1646c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1647000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1648000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 16499c0ca6f9SAndy Whitcroft 1650c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1651c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1652000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1653000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1654d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 16550a920b5bSAndy Whitcroft } 16565368df20SAndy Whitcroft 16573354957aSAndi Kleen# check for Kconfig help text having a real description 16589fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 16599fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 16603354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 16619fe287d7SAndy Whitcroft $line =~ /\+\s*(?:---)?help(?:---)?$/) { 16623354957aSAndi Kleen my $length = 0; 16639fe287d7SAndy Whitcroft my $cnt = $realcnt; 16649fe287d7SAndy Whitcroft my $ln = $linenr + 1; 16659fe287d7SAndy Whitcroft my $f; 16669fe287d7SAndy Whitcroft my $is_end = 0; 16679fe287d7SAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1]) { 16689fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 16699fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 16709fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 16719fe287d7SAndy Whitcroft $ln++; 16729fe287d7SAndy Whitcroft 16739fe287d7SAndy Whitcroft next if ($f =~ /^-/); 16749fe287d7SAndy Whitcroft $f =~ s/^.//; 16753354957aSAndi Kleen $f =~ s/#.*//; 16763354957aSAndi Kleen $f =~ s/^\s+//; 16773354957aSAndi Kleen next if ($f =~ /^$/); 16789fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 16799fe287d7SAndy Whitcroft $is_end = 1; 16809fe287d7SAndy Whitcroft last; 16819fe287d7SAndy Whitcroft } 16823354957aSAndi Kleen $length++; 16833354957aSAndi Kleen } 1684000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1685000d1cc1SJoe Perches "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4); 16869fe287d7SAndy Whitcroft #print "is_end<$is_end> length<$length>\n"; 16873354957aSAndi Kleen } 16883354957aSAndi Kleen 1689c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1690c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1691c68e5878SArnaud Lacombe my $flag = $1; 1692c68e5878SArnaud Lacombe my $replacement = { 1693c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1694c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1695c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1696c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1697c68e5878SArnaud Lacombe }; 1698c68e5878SArnaud Lacombe 1699c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1700c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1701c68e5878SArnaud Lacombe } 1702c68e5878SArnaud Lacombe 17035368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 17045368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 17055368df20SAndy Whitcroft 17060a920b5bSAndy Whitcroft#80 column limit 1707c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1708f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 17090fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 17108bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1711f4c014c0SAndy Whitcroft $length > 80) 1712c45dcabdSAndy Whitcroft { 1713000d1cc1SJoe Perches WARN("LONG_LINE", 1714000d1cc1SJoe Perches "line over 80 characters\n" . $herecurr); 17150a920b5bSAndy Whitcroft } 17160a920b5bSAndy Whitcroft 17175e79d96eSJoe Perches# check for spaces before a quoted newline 17185e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1719000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1720000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 17215e79d96eSJoe Perches } 17225e79d96eSJoe Perches 17238905a67cSAndy Whitcroft# check for adding lines without a newline. 17248905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1725000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1726000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 17278905a67cSAndy Whitcroft } 17288905a67cSAndy Whitcroft 172942e41c54SMike Frysinger# Blackfin: use hi/lo macros 173042e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 173142e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 173242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1733000d1cc1SJoe Perches ERROR("LO_MACRO", 1734000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 173542e41c54SMike Frysinger } 173642e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 173742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1738000d1cc1SJoe Perches ERROR("HI_MACRO", 1739000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 174042e41c54SMike Frysinger } 174142e41c54SMike Frysinger } 174242e41c54SMike Frysinger 1743b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1744b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 17450a920b5bSAndy Whitcroft 17460a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 17470a920b5bSAndy Whitcroft# more than 8 must use tabs. 1748c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1749c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1750c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1751000d1cc1SJoe Perches ERROR("CODE_INDENT", 1752000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1753d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17540a920b5bSAndy Whitcroft } 17550a920b5bSAndy Whitcroft 175608e44365SAlberto Panizzo# check for space before tabs. 175708e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 175808e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1759000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1760000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 176108e44365SAlberto Panizzo } 176208e44365SAlberto Panizzo 17635f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 17646b4c5bebSAndy Whitcroft# Exceptions: 17656b4c5bebSAndy Whitcroft# 1) within comments 17666b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 17676b4c5bebSAndy Whitcroft# 3) hanging labels 17686b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 17695f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1770000d1cc1SJoe Perches WARN("LEADING_SPACE", 1771000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 17725f7ddae6SRaffaele Recalcati } 17735f7ddae6SRaffaele Recalcati 1774b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1775b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1776b9ea10d6SAndy Whitcroft 1777c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1778cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1779000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1780000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1781c2fdda0dSAndy Whitcroft } 178222f2a2efSAndy Whitcroft 178342e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 178442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 178542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1786000d1cc1SJoe Perches ERROR("CSYNC", 1787000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 178842e41c54SMike Frysinger } 178942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 179042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1791000d1cc1SJoe Perches ERROR("SSYNC", 1792000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 179342e41c54SMike Frysinger } 179442e41c54SMike Frysinger 17959c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 17962b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 17972b474a1aSAndy Whitcroft $realline_next); 17989c9ba34eSAndy Whitcroft if ($realcnt && $line =~ /.\s*\S/) { 1799170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1800f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1801171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1802171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1803171ae1a4SAndy Whitcroft 18042b474a1aSAndy Whitcroft # Find the real next line. 18052b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 18062b474a1aSAndy Whitcroft if (defined $realline_next && 18072b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 18082b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 18092b474a1aSAndy Whitcroft $realline_next++; 18102b474a1aSAndy Whitcroft } 18112b474a1aSAndy Whitcroft 1812171ae1a4SAndy Whitcroft my $s = $stat; 1813171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1814cf655043SAndy Whitcroft 1815c2fdda0dSAndy Whitcroft # Ignore goto labels. 1816171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1817c2fdda0dSAndy Whitcroft 1818c2fdda0dSAndy Whitcroft # Ignore functions being called 1819171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1820c2fdda0dSAndy Whitcroft 1821463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1822463f2864SAndy Whitcroft 1823c45dcabdSAndy Whitcroft # declarations always start with types 1824d2506586SAndy 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) { 1825c45dcabdSAndy Whitcroft my $type = $1; 1826c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1827c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1828c45dcabdSAndy Whitcroft 18296c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1830a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1831c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1832c2fdda0dSAndy Whitcroft } 18338905a67cSAndy Whitcroft 18346c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 183565863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1836c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 18379c0ca6f9SAndy Whitcroft } 18388905a67cSAndy Whitcroft 18398905a67cSAndy Whitcroft # Check for any sort of function declaration. 18408905a67cSAndy Whitcroft # int foo(something bar, other baz); 18418905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1842171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 18438905a67cSAndy Whitcroft my ($name_len) = length($1); 18448905a67cSAndy Whitcroft 1845cf655043SAndy Whitcroft my $ctx = $s; 1846773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 18478905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1848cf655043SAndy Whitcroft 18498905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1850c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 18518905a67cSAndy Whitcroft 1852c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 18538905a67cSAndy Whitcroft } 18548905a67cSAndy Whitcroft } 18558905a67cSAndy Whitcroft } 18568905a67cSAndy Whitcroft 18579c0ca6f9SAndy Whitcroft } 18589c0ca6f9SAndy Whitcroft 185900df344fSAndy Whitcroft# 186000df344fSAndy Whitcroft# Checks which may be anchored in the context. 186100df344fSAndy Whitcroft# 186200df344fSAndy Whitcroft 186300df344fSAndy Whitcroft# Check for switch () and associated case and default 186400df344fSAndy Whitcroft# statements should be at the same indent. 186500df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 186600df344fSAndy Whitcroft my $err = ''; 186700df344fSAndy Whitcroft my $sep = ''; 186800df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 186900df344fSAndy Whitcroft shift(@ctx); 187000df344fSAndy Whitcroft for my $ctx (@ctx) { 187100df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 187200df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 187300df344fSAndy Whitcroft $indent != $cindent) { 187400df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 187500df344fSAndy Whitcroft $sep = ''; 187600df344fSAndy Whitcroft } else { 187700df344fSAndy Whitcroft $sep = "[...]\n"; 187800df344fSAndy Whitcroft } 187900df344fSAndy Whitcroft } 188000df344fSAndy Whitcroft if ($err ne '') { 1881000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 1882000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 1883de7d4f0eSAndy Whitcroft } 1884de7d4f0eSAndy Whitcroft } 1885de7d4f0eSAndy Whitcroft 1886de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1887de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1888c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1889773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1890773647a0SAndy Whitcroft 18919c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1892de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1893de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1894de7d4f0eSAndy Whitcroft 1895548596d5SAndy Whitcroft my $ctx_ln = $linenr; 1896548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 1897de7d4f0eSAndy Whitcroft 1898548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1899548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 1900548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 1901548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1902548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1903773647a0SAndy Whitcroft $ctx_ln++; 1904773647a0SAndy Whitcroft } 1905548596d5SAndy Whitcroft 190653210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 190753210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1908773647a0SAndy Whitcroft 1909773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1910000d1cc1SJoe Perches ERROR("OPEN_BRACE", 1911000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 191201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 191300df344fSAndy Whitcroft } 1914773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1915773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1916773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1917773647a0SAndy Whitcroft { 19189c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 19199c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1920000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 1921000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 192201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 19239c0ca6f9SAndy Whitcroft } 19249c0ca6f9SAndy Whitcroft } 192500df344fSAndy Whitcroft } 192600df344fSAndy Whitcroft 19274d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 19284d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 19294d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 19304d001e4dSAndy Whitcroft 19314d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 19324d001e4dSAndy Whitcroft 19334d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 19344d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 19354d001e4dSAndy Whitcroft # where necessary. 19364d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 19374d001e4dSAndy Whitcroft 19384d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 19396f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 19406f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 19414d001e4dSAndy Whitcroft 19424d001e4dSAndy Whitcroft # We want to check the first line inside the block 19434d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 19444d001e4dSAndy Whitcroft # 1) any blank line termination 19454d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 19464d001e4dSAndy Whitcroft # 3) any do (...) { 19474d001e4dSAndy Whitcroft my $continuation = 0; 19484d001e4dSAndy Whitcroft my $check = 0; 19494d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 19504d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 19514d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 19524d001e4dSAndy Whitcroft $continuation = 1; 19534d001e4dSAndy Whitcroft } 19549bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 19554d001e4dSAndy Whitcroft $check = 1; 19564d001e4dSAndy Whitcroft $cond_lines++; 19574d001e4dSAndy Whitcroft } 19584d001e4dSAndy Whitcroft 19594d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 19604d001e4dSAndy Whitcroft # preprocessor statement. 19614d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 19624d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 19634d001e4dSAndy Whitcroft $check = 0; 19644d001e4dSAndy Whitcroft } 19654d001e4dSAndy Whitcroft 19669bd49efeSAndy Whitcroft my $cond_ptr = -1; 1967740504c6SAndy Whitcroft $continuation = 0; 19689bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 19699bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 19704d001e4dSAndy Whitcroft 1971f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 1972f16fa28fSAndy Whitcroft # is not linear. 1973f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1974f16fa28fSAndy Whitcroft $check = 0; 1975f16fa28fSAndy Whitcroft } 1976f16fa28fSAndy Whitcroft 19779bd49efeSAndy Whitcroft # Ignore: 19789bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 19799bd49efeSAndy Whitcroft # 2) preprocessor lines, and 19809bd49efeSAndy Whitcroft # 3) labels. 1981740504c6SAndy Whitcroft if ($continuation || 1982740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 19839bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 19849bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 1985740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 198630dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 19879bd49efeSAndy Whitcroft $cond_lines++; 19889bd49efeSAndy Whitcroft } 19894d001e4dSAndy Whitcroft } 199030dad6ebSAndy Whitcroft } 19914d001e4dSAndy Whitcroft 19924d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 19934d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 19944d001e4dSAndy Whitcroft 19954d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 19964d001e4dSAndy Whitcroft # this is not this patch's fault. 19974d001e4dSAndy Whitcroft if (!defined($stat_real) || 19984d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 19994d001e4dSAndy Whitcroft $check = 0; 20004d001e4dSAndy Whitcroft } 20014d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 20024d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 20034d001e4dSAndy Whitcroft } 20044d001e4dSAndy Whitcroft 20059bd49efeSAndy 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"; 20064d001e4dSAndy Whitcroft 20074d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 20084d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2009000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2010000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 20114d001e4dSAndy Whitcroft } 20124d001e4dSAndy Whitcroft } 20134d001e4dSAndy Whitcroft 20146c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 20156c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 20161f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 20171f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 20186c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2019c2fdda0dSAndy Whitcroft if ($dbg_values) { 2020c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2021cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2022cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 20231f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2024c2fdda0dSAndy Whitcroft } 20256c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 20266c72ffaaSAndy Whitcroft 202700df344fSAndy Whitcroft#ignore lines not being added 202800df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 202900df344fSAndy Whitcroft 2030653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 20317429c690SAndy Whitcroft if ($dbg_type) { 20327429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2033000d1cc1SJoe Perches ERROR("TEST_TYPE", 2034000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 20357429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2036000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2037000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 20387429c690SAndy Whitcroft } 2039653d4876SAndy Whitcroft next; 2040653d4876SAndy Whitcroft } 2041a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2042a1ef277eSAndy Whitcroft if ($dbg_attr) { 20439360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2044000d1cc1SJoe Perches ERROR("TEST_ATTR", 2045000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 20469360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2047000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2048000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2049a1ef277eSAndy Whitcroft } 2050a1ef277eSAndy Whitcroft next; 2051a1ef277eSAndy Whitcroft } 2052653d4876SAndy Whitcroft 2053f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 205499423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 205599423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2056000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2057000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2058f0a594c1SAndy Whitcroft } 2059f0a594c1SAndy Whitcroft 206000df344fSAndy Whitcroft# 206100df344fSAndy Whitcroft# Checks which are anchored on the added line. 206200df344fSAndy Whitcroft# 206300df344fSAndy Whitcroft 2064653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2065c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2066653d4876SAndy Whitcroft my $path = $1; 2067653d4876SAndy Whitcroft if ($path =~ m{//}) { 2068000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2069000d1cc1SJoe Perches "malformed #include filename\n" . 2070de7d4f0eSAndy Whitcroft $herecurr); 2071653d4876SAndy Whitcroft } 2072653d4876SAndy Whitcroft } 2073653d4876SAndy Whitcroft 207400df344fSAndy Whitcroft# no C99 // comments 207500df344fSAndy Whitcroft if ($line =~ m{//}) { 2076000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2077000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 207800df344fSAndy Whitcroft } 207900df344fSAndy Whitcroft # Remove C99 comments. 20800a920b5bSAndy Whitcroft $line =~ s@//.*@@; 20816c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 20820a920b5bSAndy Whitcroft 20832b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 20842b474a1aSAndy Whitcroft# the whole statement. 20852b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 20862b474a1aSAndy Whitcroft if (defined $realline_next && 20872b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 20882b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 20892b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 20902b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 20913cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 20923cbf62dfSAndy Whitcroft # a prefix: 20933cbf62dfSAndy Whitcroft # XXX(foo); 20943cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2095653d4876SAndy Whitcroft my $name = $1; 20963cbf62dfSAndy Whitcroft if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ && 20973cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 20983cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 20993cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 21003cbf62dfSAndy Whitcroft 21013cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 21022b474a1aSAndy Whitcroft \n.}\s*$| 210348012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 210448012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 210548012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 21062b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 21072b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 210848012058SAndy Whitcroft )/x) { 21092b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 21102b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 21112b474a1aSAndy Whitcroft } else { 21122b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 21130a920b5bSAndy Whitcroft } 21140a920b5bSAndy Whitcroft } 21152b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 21162b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 21172b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 21182b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 21192b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 21202b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 21212b474a1aSAndy Whitcroft } 21222b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 21232b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2124000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2125000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 21262b474a1aSAndy Whitcroft } 21270a920b5bSAndy Whitcroft 21285150bda4SJoe Eloff# check for global initialisers. 2129c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2130000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2131000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2132f0a594c1SAndy Whitcroft $herecurr); 2133f0a594c1SAndy Whitcroft } 21340a920b5bSAndy Whitcroft# check for static initialisers. 21352d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2136000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2137000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2138de7d4f0eSAndy Whitcroft $herecurr); 21390a920b5bSAndy Whitcroft } 21400a920b5bSAndy Whitcroft 2141cb710ecaSJoe Perches# check for static const char * arrays. 2142cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2143000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2144000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2145cb710ecaSJoe Perches $herecurr); 2146cb710ecaSJoe Perches } 2147cb710ecaSJoe Perches 2148cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2149cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2150000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2151000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2152cb710ecaSJoe Perches $herecurr); 2153cb710ecaSJoe Perches } 2154cb710ecaSJoe Perches 215593ed0e2dSJoe Perches# check for declarations of struct pci_device_id 215693ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2157000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2158000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 215993ed0e2dSJoe Perches } 216093ed0e2dSJoe Perches 2161653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2162653d4876SAndy Whitcroft# make sense. 2163653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 21648054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2165c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 21668ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2167653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2168000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2169000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 21700a920b5bSAndy Whitcroft } 21710a920b5bSAndy Whitcroft 21720a920b5bSAndy Whitcroft# * goes on variable not on type 217365863862SAndy Whitcroft # (char*[ const]) 217400ef4eceSAndy Whitcroft if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { 217565863862SAndy Whitcroft my ($from, $to) = ($1, $1); 2176d8aaf121SAndy Whitcroft 217765863862SAndy Whitcroft # Should start with a space. 217865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 217965863862SAndy Whitcroft # Should not end with a space. 218065863862SAndy Whitcroft $to =~ s/\s+$//; 218165863862SAndy Whitcroft # '*'s should not have spaces between. 2182f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 218365863862SAndy Whitcroft } 2184d8aaf121SAndy Whitcroft 218565863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 218665863862SAndy Whitcroft if ($from ne $to) { 2187000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2188000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 218965863862SAndy Whitcroft } 219000ef4eceSAndy Whitcroft } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { 219165863862SAndy Whitcroft my ($from, $to, $ident) = ($1, $1, $2); 2192d8aaf121SAndy Whitcroft 219365863862SAndy Whitcroft # Should start with a space. 219465863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 219565863862SAndy Whitcroft # Should not end with a space. 219665863862SAndy Whitcroft $to =~ s/\s+$//; 219765863862SAndy Whitcroft # '*'s should not have spaces between. 2198f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 219965863862SAndy Whitcroft } 220065863862SAndy Whitcroft # Modifiers should have spaces. 220165863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 220265863862SAndy Whitcroft 2203667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2204667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2205000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2206000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 220765863862SAndy Whitcroft } 22080a920b5bSAndy Whitcroft } 22090a920b5bSAndy Whitcroft 22100a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 22110a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 22120a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 22130a920b5bSAndy Whitcroft# print "$herecurr"; 22140a920b5bSAndy Whitcroft# $clean = 0; 22150a920b5bSAndy Whitcroft# } 22160a920b5bSAndy Whitcroft 22178905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2218000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2219000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 22208905a67cSAndy Whitcroft } 22218905a67cSAndy Whitcroft 222217441227SJoe Perches# check for uses of printk_ratelimit 222317441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2224000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2225000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 222617441227SJoe Perches } 222717441227SJoe Perches 222800df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 222900df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 223000df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 223125985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 223200df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2233f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 223400df344fSAndy Whitcroft my $ok = 0; 223500df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 223600df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 223725985edcSLucas De Marchi # we have a preceding printk if it ends 223800df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 223900df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 224000df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 224100df344fSAndy Whitcroft $ok = 1; 224200df344fSAndy Whitcroft } 224300df344fSAndy Whitcroft last; 224400df344fSAndy Whitcroft } 224500df344fSAndy Whitcroft } 224600df344fSAndy Whitcroft if ($ok == 0) { 2247000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2248000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 22490a920b5bSAndy Whitcroft } 225000df344fSAndy Whitcroft } 22510a920b5bSAndy Whitcroft 2252653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2253653d4876SAndy Whitcroft# or if closed on same line 2254c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2255c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2256000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2257000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 22580a920b5bSAndy Whitcroft } 2259653d4876SAndy Whitcroft 22608905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 22618905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 22628905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2263000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2264000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 22658905a67cSAndy Whitcroft } 22668905a67cSAndy Whitcroft 22670c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 22680c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2269000d1cc1SJoe Perches WARN("SPACING", 2270000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 22710c73b4ebSAndy Whitcroft } 22720c73b4ebSAndy Whitcroft 22738d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 22748d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2275fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2276fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 22778d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 22788d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 22798d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2280fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2281fe2a7dbcSAndy Whitcroft $prefix !~ /{\s+$/) { 2282000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2283000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 22848d31cfceSAndy Whitcroft } 22858d31cfceSAndy Whitcroft } 22868d31cfceSAndy Whitcroft 2287f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 22886c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2289c2fdda0dSAndy Whitcroft my $name = $1; 2290773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2291773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2292c2fdda0dSAndy Whitcroft 2293c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2294773647a0SAndy Whitcroft if ($name =~ /^(?: 2295773647a0SAndy Whitcroft if|for|while|switch|return|case| 2296773647a0SAndy Whitcroft volatile|__volatile__| 2297773647a0SAndy Whitcroft __attribute__|format|__extension__| 2298773647a0SAndy Whitcroft asm|__asm__)$/x) 2299773647a0SAndy Whitcroft { 2300c2fdda0dSAndy Whitcroft 2301c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2302c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2303c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2304c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2305773647a0SAndy Whitcroft 2306773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2307c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2308c2fdda0dSAndy Whitcroft 2309c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2310c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2311773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2312c2fdda0dSAndy Whitcroft 2313c2fdda0dSAndy Whitcroft } else { 2314000d1cc1SJoe Perches WARN("SPACING", 2315000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2316f0a594c1SAndy Whitcroft } 23176c72ffaaSAndy Whitcroft } 2318653d4876SAndy Whitcroft# Check operator spacing. 23190a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 23209c0ca6f9SAndy Whitcroft my $ops = qr{ 23219c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 23229c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 23239c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 23241f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 23251f65f947SAndy Whitcroft \?|: 23269c0ca6f9SAndy Whitcroft }x; 2327cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 232800df344fSAndy Whitcroft my $off = 0; 23296c72ffaaSAndy Whitcroft 23306c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 23316c72ffaaSAndy Whitcroft 23320a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 23334a0df2efSAndy Whitcroft $off += length($elements[$n]); 23344a0df2efSAndy Whitcroft 233525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2336773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2337773647a0SAndy Whitcroft my $cc = ''; 2338773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2339773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2340773647a0SAndy Whitcroft } 2341773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2342773647a0SAndy Whitcroft 23434a0df2efSAndy Whitcroft my $a = ''; 23444a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 23454a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2346cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 23474a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 23484a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2349773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 23504a0df2efSAndy Whitcroft 23510a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 23524a0df2efSAndy Whitcroft 23534a0df2efSAndy Whitcroft my $c = ''; 23540a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 23554a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 23564a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2357cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 23584a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 23594a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 23608b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 23614a0df2efSAndy Whitcroft } else { 23624a0df2efSAndy Whitcroft $c = 'E'; 23630a920b5bSAndy Whitcroft } 23640a920b5bSAndy Whitcroft 23654a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 23664a0df2efSAndy Whitcroft 23674a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 23684a0df2efSAndy Whitcroft 23696c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2370de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 23710a920b5bSAndy Whitcroft 237274048ed8SAndy Whitcroft # Pull out the value of this operator. 23736c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 23740a920b5bSAndy Whitcroft 23751f65f947SAndy Whitcroft # Get the full operator variant. 23761f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 23771f65f947SAndy Whitcroft 237813214adfSAndy Whitcroft # Ignore operators passed as parameters. 237913214adfSAndy Whitcroft if ($op_type ne 'V' && 238013214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 238113214adfSAndy Whitcroft 2382cf655043SAndy Whitcroft# # Ignore comments 2383cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 238413214adfSAndy Whitcroft 2385d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 238613214adfSAndy Whitcroft } elsif ($op eq ';') { 2387cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2388cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2389000d1cc1SJoe Perches ERROR("SPACING", 2390000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2391d8aaf121SAndy Whitcroft } 2392d8aaf121SAndy Whitcroft 2393d8aaf121SAndy Whitcroft # // is a comment 2394d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 23950a920b5bSAndy Whitcroft 23961f65f947SAndy Whitcroft # No spaces for: 23971f65f947SAndy Whitcroft # -> 23981f65f947SAndy Whitcroft # : when part of a bitfield 23991f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 24004a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2401000d1cc1SJoe Perches ERROR("SPACING", 2402000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 24030a920b5bSAndy Whitcroft } 24040a920b5bSAndy Whitcroft 24050a920b5bSAndy Whitcroft # , must have a space on the right. 24060a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2407cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2408000d1cc1SJoe Perches ERROR("SPACING", 2409000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 24100a920b5bSAndy Whitcroft } 24110a920b5bSAndy Whitcroft 24129c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 241374048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 24149c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 24159c0ca6f9SAndy Whitcroft 24169c0ca6f9SAndy Whitcroft # unary operators should have a space before and 24179c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 24189c0ca6f9SAndy Whitcroft # unary operator, or a cast 24199c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 242074048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 24210d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2422cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2423000d1cc1SJoe Perches ERROR("SPACING", 2424000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 24250a920b5bSAndy Whitcroft } 2426a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2427171ae1a4SAndy Whitcroft # A unary '*' may be const 2428171ae1a4SAndy Whitcroft 2429171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2430000d1cc1SJoe Perches ERROR("SPACING", 2431000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 24320a920b5bSAndy Whitcroft } 24330a920b5bSAndy Whitcroft 24340a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 24350a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2436773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2437000d1cc1SJoe Perches ERROR("SPACING", 2438000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 24390a920b5bSAndy Whitcroft } 2440773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2441773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2442000d1cc1SJoe Perches ERROR("SPACING", 2443000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2444653d4876SAndy Whitcroft } 2445773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2446000d1cc1SJoe Perches ERROR("SPACING", 2447000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2448773647a0SAndy Whitcroft } 2449773647a0SAndy Whitcroft 24500a920b5bSAndy Whitcroft 24510a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 24529c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 24539c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 24549c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2455c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2456c2fdda0dSAndy Whitcroft $op eq '%') 24570a920b5bSAndy Whitcroft { 2458773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2459000d1cc1SJoe Perches ERROR("SPACING", 2460000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2461de7d4f0eSAndy Whitcroft $hereptr); 24620a920b5bSAndy Whitcroft } 24630a920b5bSAndy Whitcroft 24641f65f947SAndy Whitcroft # A colon needs no spaces before when it is 24651f65f947SAndy Whitcroft # terminating a case value or a label. 24661f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 24671f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2468000d1cc1SJoe Perches ERROR("SPACING", 2469000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 24701f65f947SAndy Whitcroft } 24711f65f947SAndy Whitcroft 24720a920b5bSAndy Whitcroft # All the others need spaces both sides. 2473cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 24741f65f947SAndy Whitcroft my $ok = 0; 24751f65f947SAndy Whitcroft 247622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 24771f65f947SAndy Whitcroft if (($op eq '<' && 24781f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 24791f65f947SAndy Whitcroft ($op eq '>' && 24801f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 24811f65f947SAndy Whitcroft { 24821f65f947SAndy Whitcroft $ok = 1; 24831f65f947SAndy Whitcroft } 24841f65f947SAndy Whitcroft 24851f65f947SAndy Whitcroft # Ignore ?: 24861f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 24871f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 24881f65f947SAndy Whitcroft $ok = 1; 24891f65f947SAndy Whitcroft } 24901f65f947SAndy Whitcroft 24911f65f947SAndy Whitcroft if ($ok == 0) { 2492000d1cc1SJoe Perches ERROR("SPACING", 2493000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 24940a920b5bSAndy Whitcroft } 249522f2a2efSAndy Whitcroft } 24964a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 24970a920b5bSAndy Whitcroft } 24980a920b5bSAndy Whitcroft } 24990a920b5bSAndy Whitcroft 2500f0a594c1SAndy Whitcroft# check for multiple assignments 2501f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2502000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2503000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2504f0a594c1SAndy Whitcroft } 2505f0a594c1SAndy Whitcroft 250622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 250722f2a2efSAndy Whitcroft## # continuation. 250822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 250922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 251022f2a2efSAndy Whitcroft## 251122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 251222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 251322f2a2efSAndy Whitcroft## my $ln = $line; 251422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 251522f2a2efSAndy Whitcroft## } 251622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2517000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2518000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 251922f2a2efSAndy Whitcroft## } 252022f2a2efSAndy Whitcroft## } 2521f0a594c1SAndy Whitcroft 25220a920b5bSAndy Whitcroft#need space before brace following if, while, etc 252322f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 252422f2a2efSAndy Whitcroft $line =~ /do{/) { 2525000d1cc1SJoe Perches ERROR("SPACING", 2526000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2527de7d4f0eSAndy Whitcroft } 2528de7d4f0eSAndy Whitcroft 2529de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2530de7d4f0eSAndy Whitcroft# on the line 2531de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2532000d1cc1SJoe Perches ERROR("SPACING", 2533000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 25340a920b5bSAndy Whitcroft } 25350a920b5bSAndy Whitcroft 253622f2a2efSAndy Whitcroft# check spacing on square brackets 253722f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2538000d1cc1SJoe Perches ERROR("SPACING", 2539000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 254022f2a2efSAndy Whitcroft } 254122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2542000d1cc1SJoe Perches ERROR("SPACING", 2543000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 254422f2a2efSAndy Whitcroft } 254522f2a2efSAndy Whitcroft 2546c45dcabdSAndy Whitcroft# check spacing on parentheses 25479c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 25489c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2549000d1cc1SJoe Perches ERROR("SPACING", 2550000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 255122f2a2efSAndy Whitcroft } 255213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2553c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2554c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2555000d1cc1SJoe Perches ERROR("SPACING", 2556000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 255722f2a2efSAndy Whitcroft } 255822f2a2efSAndy Whitcroft 25590a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 25604a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 25610a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2562000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2563000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 25640a920b5bSAndy Whitcroft } 25650a920b5bSAndy Whitcroft 2566c45dcabdSAndy Whitcroft# Return is not a function. 2567c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2568c45dcabdSAndy Whitcroft my $spacing = $1; 2569c45dcabdSAndy Whitcroft my $value = $2; 2570c45dcabdSAndy Whitcroft 257186f9d059SAndy Whitcroft # Flatten any parentheses 2572fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2573fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 257463f17f89SAndy Whitcroft while ($value =~ s/\[[^\{\}]*\]/1/ || 257563f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 257663f17f89SAndy Whitcroft $Compare\s* 257763f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 257863f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2579c45dcabdSAndy Whitcroft } 2580fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2581fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2582000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2583000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2584c45dcabdSAndy Whitcroft 2585c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2586000d1cc1SJoe Perches ERROR("SPACING", 2587000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2588c45dcabdSAndy Whitcroft } 2589c45dcabdSAndy Whitcroft } 259053a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 259153a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 259253a3c448SAndy Whitcroft my $name = $1; 259353a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2594000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2595000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 259653a3c448SAndy Whitcroft } 259753a3c448SAndy Whitcroft } 2598c45dcabdSAndy Whitcroft 25997d2367afSJoe Perches# typecasts on min/max could be min_t/max_t 26007d2367afSJoe Perches if ($line =~ /^\+(?:.*?)\b(min|max)\s*\($Typecast{0,1}($LvalOrFunc)\s*,\s*$Typecast{0,1}($LvalOrFunc)\s*\)/) { 26017d2367afSJoe Perches if (defined $2 || defined $8) { 26027d2367afSJoe Perches my $call = $1; 26037d2367afSJoe Perches my $cast1 = deparenthesize($2); 26047d2367afSJoe Perches my $arg1 = $3; 26057d2367afSJoe Perches my $cast2 = deparenthesize($8); 26067d2367afSJoe Perches my $arg2 = $9; 26077d2367afSJoe Perches my $cast; 26087d2367afSJoe Perches 26097d2367afSJoe Perches if ($cast1 ne "" && $cast2 ne "") { 26107d2367afSJoe Perches $cast = "$cast1 or $cast2"; 26117d2367afSJoe Perches } elsif ($cast1 ne "") { 26127d2367afSJoe Perches $cast = $cast1; 26137d2367afSJoe Perches } else { 26147d2367afSJoe Perches $cast = $cast2; 26157d2367afSJoe Perches } 261630ecad51SHui Zhu WARN("MINMAX", 261730ecad51SHui Zhu "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . $herecurr); 26187d2367afSJoe Perches } 26197d2367afSJoe Perches } 26207d2367afSJoe Perches 26210a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 26224a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2623000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 26240a920b5bSAndy Whitcroft } 26250a920b5bSAndy Whitcroft 2626f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2627f5fe35ddSAndy Whitcroft# statements after the conditional. 2628170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 2629170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2630170d3a22SAndy Whitcroft $remain_next, $off_next); 2631170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2632170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2633170d3a22SAndy Whitcroft 2634170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2635170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2636170d3a22SAndy Whitcroft # then count those as offsets. 2637170d3a22SAndy Whitcroft my ($whitespace) = 2638170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2639170d3a22SAndy Whitcroft my $offset = 2640170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2641170d3a22SAndy Whitcroft 2642170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2643170d3a22SAndy Whitcroft $offset} = 1; 2644170d3a22SAndy Whitcroft } 2645170d3a22SAndy Whitcroft } 2646170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2647170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2648171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 26498905a67cSAndy Whitcroft 2650b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2651000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2652000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 26538905a67cSAndy Whitcroft } 26548905a67cSAndy Whitcroft 26558905a67cSAndy Whitcroft # Find out what is on the end of the line after the 26568905a67cSAndy Whitcroft # conditional. 2657773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 26588905a67cSAndy Whitcroft $s =~ s/\n.*//g; 265913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 266053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 266153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2662773647a0SAndy Whitcroft { 2663bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2664bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2665bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 266642bdf74cSHidetoshi Seto my $stat_real = ''; 2667bb44ad39SAndy Whitcroft 266842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 266942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2670bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2671bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2672bb44ad39SAndy Whitcroft } 2673bb44ad39SAndy Whitcroft 2674000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2675000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 26768905a67cSAndy Whitcroft } 26778905a67cSAndy Whitcroft } 26788905a67cSAndy Whitcroft 267913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 268013214adfSAndy Whitcroft if ($line =~ / 268113214adfSAndy Whitcroft (?: 268213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 268313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 268413214adfSAndy Whitcroft (?:\&\&|\|\|) 268513214adfSAndy Whitcroft | 268613214adfSAndy Whitcroft (?:\&\&|\|\|) 268713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 268813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 268913214adfSAndy Whitcroft )/x) 269013214adfSAndy Whitcroft { 2691000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2692000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 269313214adfSAndy Whitcroft } 269413214adfSAndy Whitcroft 26958905a67cSAndy Whitcroft# if and else should not have general statements after it 269613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 269713214adfSAndy Whitcroft my $s = $1; 269813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 269913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2700000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2701000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 27020a920b5bSAndy Whitcroft } 270313214adfSAndy Whitcroft } 270439667782SAndy Whitcroft# if should not continue a brace 270539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2706000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2707000d1cc1SJoe Perches "trailing statements should be on next line\n" . 270839667782SAndy Whitcroft $herecurr); 270939667782SAndy Whitcroft } 2710a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2711a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2712a1080bf8SAndy Whitcroft $line !~ /\G(?: 27133fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2714a1080bf8SAndy Whitcroft \s*return\s+ 2715a1080bf8SAndy Whitcroft )/xg) 2716a1080bf8SAndy Whitcroft { 2717000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2718000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2719a1080bf8SAndy Whitcroft } 27200a920b5bSAndy Whitcroft 27210a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 27220a920b5bSAndy Whitcroft # indent level to be relevant to each other. 27230a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 27240a920b5bSAndy Whitcroft $previndent == $indent) { 2725000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2726000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 27270a920b5bSAndy Whitcroft } 27280a920b5bSAndy Whitcroft 2729c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2730c2fdda0dSAndy Whitcroft $previndent == $indent) { 2731c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2732c2fdda0dSAndy Whitcroft 2733c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2734c2fdda0dSAndy Whitcroft # conditional. 2735773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2736c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2737c2fdda0dSAndy Whitcroft 2738c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2739000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2740000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2741c2fdda0dSAndy Whitcroft } 2742c2fdda0dSAndy Whitcroft } 2743c2fdda0dSAndy Whitcroft 27440a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 27450a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 27460a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 27470a920b5bSAndy Whitcroft# print "$herecurr"; 27480a920b5bSAndy Whitcroft# $clean = 0; 27490a920b5bSAndy Whitcroft# } 27500a920b5bSAndy Whitcroft 27510a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2752c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2753000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2754000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 27550a920b5bSAndy Whitcroft } 27560a920b5bSAndy Whitcroft 2757653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2758c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2759e09dec48SAndy Whitcroft my $file = "$1.h"; 2760e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2761e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2762e09dec48SAndy Whitcroft $realfile ne $checkfile && 27637840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2764c45dcabdSAndy Whitcroft { 2765e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2766000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2767000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2768e09dec48SAndy Whitcroft } else { 2769000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2770000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2771e09dec48SAndy Whitcroft } 27720a920b5bSAndy Whitcroft } 27730a920b5bSAndy Whitcroft } 27740a920b5bSAndy Whitcroft 2775653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2776653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2777cf655043SAndy Whitcroft# in a known good container 2778b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2779b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2780d8aaf121SAndy Whitcroft my $ln = $linenr; 2781d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2782c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2783c45dcabdSAndy Whitcroft my $ctx = ''; 2784653d4876SAndy Whitcroft 2785c45dcabdSAndy Whitcroft my $args = defined($1); 2786de7d4f0eSAndy Whitcroft 2787c45dcabdSAndy Whitcroft # Find the end of the macro and limit our statement 2788c45dcabdSAndy Whitcroft # search to that. 2789c45dcabdSAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1] && 2790c45dcabdSAndy Whitcroft $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2791c45dcabdSAndy Whitcroft { 2792c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1] . "\n"; 2793a3bb97a7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 2794c45dcabdSAndy Whitcroft $ln++; 2795de7d4f0eSAndy Whitcroft } 2796c45dcabdSAndy Whitcroft $ctx .= $rawlines[$ln - 1]; 2797d8aaf121SAndy Whitcroft 2798c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2799c45dcabdSAndy Whitcroft ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2800c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2801a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2802c45dcabdSAndy Whitcroft 2803c45dcabdSAndy Whitcroft # Extract the remainder of the define (if any) and 2804c45dcabdSAndy Whitcroft # rip off surrounding spaces, and trailing \'s. 2805c45dcabdSAndy Whitcroft $rest = ''; 2806636d140aSAndy Whitcroft while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2807636d140aSAndy Whitcroft #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2808a3bb97a7SAndy Whitcroft if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2809c45dcabdSAndy Whitcroft $rest .= substr($lines[$ln - 1], $off) . "\n"; 2810c45dcabdSAndy Whitcroft $cnt--; 2811a3bb97a7SAndy Whitcroft } 2812a3bb97a7SAndy Whitcroft $ln++; 2813c45dcabdSAndy Whitcroft $off = 0; 2814c45dcabdSAndy Whitcroft } 2815c45dcabdSAndy Whitcroft $rest =~ s/\\\n.//g; 2816c45dcabdSAndy Whitcroft $rest =~ s/^\s*//s; 2817c45dcabdSAndy Whitcroft $rest =~ s/\s*$//s; 2818c45dcabdSAndy Whitcroft 2819c45dcabdSAndy Whitcroft # Clean up the original statement. 2820c45dcabdSAndy Whitcroft if ($args) { 2821c45dcabdSAndy Whitcroft substr($dstat, 0, length($dcond), ''); 2822d8aaf121SAndy Whitcroft } else { 2823c45dcabdSAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2824c45dcabdSAndy Whitcroft } 2825292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2826c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2827c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2828c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2829c45dcabdSAndy Whitcroft 2830c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2831bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2832bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2833bf30d6edSAndy Whitcroft $dstat =~ s/\[[^\{\}]*\]/1/) 2834bf30d6edSAndy Whitcroft { 2835c45dcabdSAndy Whitcroft } 2836c45dcabdSAndy Whitcroft 2837c45dcabdSAndy Whitcroft my $exceptions = qr{ 2838c45dcabdSAndy Whitcroft $Declare| 2839c45dcabdSAndy Whitcroft module_param_named| 2840c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2841c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2842c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2843383099fdSAndy Whitcroft __typeof__\(| 284422fd2d3eSStefani Seibold union| 284522fd2d3eSStefani Seibold struct| 2846ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2847ea71a0a0SAndy Whitcroft ^\"|\"$ 2848c45dcabdSAndy Whitcroft }x; 28495eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 28505eaa20b9SAndy Whitcroft if ($rest ne '' && $rest ne ',') { 2851c45dcabdSAndy Whitcroft if ($rest !~ /while\s*\(/ && 2852c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/) 2853c45dcabdSAndy Whitcroft { 2854000d1cc1SJoe Perches ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 2855000d1cc1SJoe Perches "Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2856c45dcabdSAndy Whitcroft } 2857c45dcabdSAndy Whitcroft 2858c45dcabdSAndy Whitcroft } elsif ($ctx !~ /;/) { 2859c45dcabdSAndy Whitcroft if ($dstat ne '' && 2860c45dcabdSAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2861c45dcabdSAndy Whitcroft $dstat !~ /$exceptions/ && 2862b132e5d5SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && 2863c45dcabdSAndy Whitcroft $dstat =~ /$Operators/) 2864c45dcabdSAndy Whitcroft { 2865000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 2866000d1cc1SJoe Perches "Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2867d8aaf121SAndy Whitcroft } 28680a920b5bSAndy Whitcroft } 2869653d4876SAndy Whitcroft } 28700a920b5bSAndy Whitcroft 2871080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 2872080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 2873080ba929SMike Frysinger# . 2874080ba929SMike Frysinger# ALIGN(...) 2875080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 2876080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 2877000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 2878000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 2879080ba929SMike Frysinger } 2880080ba929SMike Frysinger 2881f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 288213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 288313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 2884cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 288513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2886cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 2887cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 288813214adfSAndy Whitcroft my $allowed = 0; 288913214adfSAndy Whitcroft my $seen = 0; 2890773647a0SAndy Whitcroft my $herectx = $here . "\n"; 2891cf655043SAndy Whitcroft my $ln = $linenr - 1; 289213214adfSAndy Whitcroft for my $chunk (@chunks) { 289313214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 289413214adfSAndy Whitcroft 2895773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 2896773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2897773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 2898773647a0SAndy Whitcroft 2899773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2900773647a0SAndy Whitcroft 2901773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 2902773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 2903773647a0SAndy Whitcroft 2904773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2905cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 2906cf655043SAndy Whitcroft 2907773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 290813214adfSAndy Whitcroft 290913214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 291013214adfSAndy Whitcroft 2911cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 2912cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2913cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 291413214adfSAndy Whitcroft $allowed = 1; 291513214adfSAndy Whitcroft } 291613214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2917cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 291813214adfSAndy Whitcroft $allowed = 1; 291913214adfSAndy Whitcroft } 2920cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2921cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 292213214adfSAndy Whitcroft $allowed = 1; 292313214adfSAndy Whitcroft } 292413214adfSAndy Whitcroft } 292513214adfSAndy Whitcroft if ($seen && !$allowed) { 2926000d1cc1SJoe Perches WARN("BRACES", 2927000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 292813214adfSAndy Whitcroft } 292913214adfSAndy Whitcroft } 293013214adfSAndy Whitcroft } 2931773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 293213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 2933cf655043SAndy Whitcroft my $allowed = 0; 2934f0a594c1SAndy Whitcroft 2935cf655043SAndy Whitcroft # Check the pre-context. 2936cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2937cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 2938cf655043SAndy Whitcroft $allowed = 1; 2939f0a594c1SAndy Whitcroft } 2940773647a0SAndy Whitcroft 2941773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 2942773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 2943773647a0SAndy Whitcroft 2944cf655043SAndy Whitcroft # Check the condition. 2945cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 2946773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 2947cf655043SAndy Whitcroft if (defined $cond) { 2948773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2949cf655043SAndy Whitcroft } 2950cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2951cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 2952cf655043SAndy Whitcroft $allowed = 1; 2953cf655043SAndy Whitcroft } 2954cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2955cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 2956cf655043SAndy Whitcroft $allowed = 1; 2957cf655043SAndy Whitcroft } 2958cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2959cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 2960cf655043SAndy Whitcroft $allowed = 1; 2961cf655043SAndy Whitcroft } 2962cf655043SAndy Whitcroft # Check the post-context. 2963cf655043SAndy Whitcroft if (defined $chunks[1]) { 2964cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 2965cf655043SAndy Whitcroft if (defined $cond) { 2966773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2967cf655043SAndy Whitcroft } 2968cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 2969cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 2970cf655043SAndy Whitcroft $allowed = 1; 2971cf655043SAndy Whitcroft } 2972cf655043SAndy Whitcroft } 2973cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 297469932487SJustin P. Mattock my $herectx = $here . "\n"; 2975f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 2976cf655043SAndy Whitcroft 2977f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 297869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 2979cf655043SAndy Whitcroft } 2980cf655043SAndy Whitcroft 2981000d1cc1SJoe Perches WARN("BRACES", 2982000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 2983f0a594c1SAndy Whitcroft } 2984f0a594c1SAndy Whitcroft } 2985f0a594c1SAndy Whitcroft 2986653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 29874a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 2988c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 2989000d1cc1SJoe Perches ERROR("DEPRECATED_INCLUDE", 2990000d1cc1SJoe Perches "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 29910a920b5bSAndy Whitcroft } 29920a920b5bSAndy Whitcroft } 29930a920b5bSAndy Whitcroft 29944a0df2efSAndy Whitcroft# don't use deprecated functions 29954a0df2efSAndy Whitcroft for my $func (@dep_functions) { 299600df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 2997000d1cc1SJoe Perches ERROR("DEPRECATED_FUNCTION", 2998000d1cc1SJoe Perches "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 29994a0df2efSAndy Whitcroft } 30004a0df2efSAndy Whitcroft } 30014a0df2efSAndy Whitcroft 30024a0df2efSAndy Whitcroft# no volatiles please 30036c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 30046c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3005000d1cc1SJoe Perches WARN("VOLATILE", 3006000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 30074a0df2efSAndy Whitcroft } 30084a0df2efSAndy Whitcroft 300900df344fSAndy Whitcroft# warn about #if 0 3010c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3011000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3012000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3013de7d4f0eSAndy Whitcroft $herecurr); 30144a0df2efSAndy Whitcroft } 30154a0df2efSAndy Whitcroft 3016f0a594c1SAndy Whitcroft# check for needless kfree() checks 3017f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3018f0a594c1SAndy Whitcroft my $expr = $1; 3019f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 3020000d1cc1SJoe Perches WARN("NEEDLESS_KFREE", 3021000d1cc1SJoe Perches "kfree(NULL) is safe this check is probably not required\n" . $hereprev); 3022f0a594c1SAndy Whitcroft } 3023f0a594c1SAndy Whitcroft } 30244c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 30254c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 30264c432a8fSGreg Kroah-Hartman my $expr = $1; 30274c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 3028000d1cc1SJoe Perches WARN("NEEDLESS_USB_FREE_URB", 3029000d1cc1SJoe Perches "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 30304c432a8fSGreg Kroah-Hartman } 30314c432a8fSGreg Kroah-Hartman } 3032f0a594c1SAndy Whitcroft 30331a15a250SPatrick Pannuto# prefer usleep_range over udelay 30341a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 30351a15a250SPatrick Pannuto # ignore udelay's < 10, however 30361a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3037000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3038000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 30391a15a250SPatrick Pannuto } 30401a15a250SPatrick Pannuto } 30411a15a250SPatrick Pannuto 304209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 304309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 304409ef8725SPatrick Pannuto if ($1 < 20) { 3045000d1cc1SJoe Perches WARN("MSLEEP", 3046000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 304709ef8725SPatrick Pannuto } 304809ef8725SPatrick Pannuto } 304909ef8725SPatrick Pannuto 305000df344fSAndy Whitcroft# warn about #ifdefs in C files 3051c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 305200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 305300df344fSAndy Whitcroft# print "$herecurr"; 305400df344fSAndy Whitcroft# $clean = 0; 305500df344fSAndy Whitcroft# } 305600df344fSAndy Whitcroft 305722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3058c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3059000d1cc1SJoe Perches ERROR("SPACING", 3060000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 306122f2a2efSAndy Whitcroft } 306222f2a2efSAndy Whitcroft 30634a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3064171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3065171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 30664a0df2efSAndy Whitcroft my $which = $1; 30674a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3068000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3069000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 30704a0df2efSAndy Whitcroft } 30714a0df2efSAndy Whitcroft } 30724a0df2efSAndy Whitcroft# check for memory barriers without a comment. 30734a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 30744a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3075000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3076000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 30774a0df2efSAndy Whitcroft } 30784a0df2efSAndy Whitcroft } 30794a0df2efSAndy Whitcroft# check of hardware specific defines 3080c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3081000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3082000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 30830a920b5bSAndy Whitcroft } 3084653d4876SAndy Whitcroft 3085d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3086d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3087000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3088000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3089d4977c78STobias Klauser } 3090d4977c78STobias Klauser 3091de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3092de7d4f0eSAndy Whitcroft# storage class and type. 30939c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 30949c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3095000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3096000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3097de7d4f0eSAndy Whitcroft } 3098de7d4f0eSAndy Whitcroft 30998905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 31008905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3101000d1cc1SJoe Perches WARN("INLINE", 3102000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 31038905a67cSAndy Whitcroft } 31048905a67cSAndy Whitcroft 31053d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 31063d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3107000d1cc1SJoe Perches WARN("PREFER_PACKED", 3108000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 31093d130fd0SJoe Perches } 31103d130fd0SJoe Perches 311139b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 311239b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3113000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3114000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 311539b7e287SJoe Perches } 311639b7e287SJoe Perches 3117*5f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 3118*5f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 3119*5f14d3bdSJoe Perches WARN("PREFER_PRINTF", 3120*5f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 3121*5f14d3bdSJoe Perches } 3122*5f14d3bdSJoe Perches 31238f53a9b8SJoe Perches# check for sizeof(&) 31248f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3125000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3126000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 31278f53a9b8SJoe Perches } 31288f53a9b8SJoe Perches 3129428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3130428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3131000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3132000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3133428e2fdcSJoe Perches } 3134428e2fdcSJoe Perches 3135de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3136171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3137c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3138171ae1a4SAndy Whitcroft { 3139c45dcabdSAndy Whitcroft my $function_name = $1; 3140c45dcabdSAndy Whitcroft my $paren_space = $2; 3141171ae1a4SAndy Whitcroft 3142171ae1a4SAndy Whitcroft my $s = $stat; 3143171ae1a4SAndy Whitcroft if (defined $cond) { 3144171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3145171ae1a4SAndy Whitcroft } 3146c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3147c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3148c45dcabdSAndy Whitcroft { 3149000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3150000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3151de7d4f0eSAndy Whitcroft } 3152de7d4f0eSAndy Whitcroft 3153171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3154000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3155000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3156171ae1a4SAndy Whitcroft } 31579c9ba34eSAndy Whitcroft 31589c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 31599c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 31609c9ba34eSAndy Whitcroft { 3161000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3162000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3163171ae1a4SAndy Whitcroft } 3164171ae1a4SAndy Whitcroft 3165de7d4f0eSAndy Whitcroft# checks for new __setup's 3166de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3167de7d4f0eSAndy Whitcroft my $name = $1; 3168de7d4f0eSAndy Whitcroft 3169de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3170000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3171000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3172de7d4f0eSAndy Whitcroft } 3173653d4876SAndy Whitcroft } 31749c0ca6f9SAndy Whitcroft 31759c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3176caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3177000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3178000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 31799c0ca6f9SAndy Whitcroft } 318013214adfSAndy Whitcroft 3181caf2a54fSJoe Perches# check for multiple semicolons 3182caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3183000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3184000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3185caf2a54fSJoe Perches } 3186caf2a54fSJoe Perches 318713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 318813214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3189000d1cc1SJoe Perches WARN("USE_FUNC", 3190000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 319113214adfSAndy Whitcroft } 3192773647a0SAndy Whitcroft 31934882720bSThomas Gleixner# check for semaphores initialized locked 31944882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3195000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3196000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 31971704f47bSPeter Zijlstra 3198773647a0SAndy Whitcroft } 319967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 320067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3201000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 320267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3203773647a0SAndy Whitcroft } 3204f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3205f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3206000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3207000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3208f3db6639SMichael Ellerman } 320979404849SEmese Revfy# check for various ops structs, ensure they are const. 321079404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 321179404849SEmese Revfy address_space_operations| 321279404849SEmese Revfy backlight_ops| 321379404849SEmese Revfy block_device_operations| 321479404849SEmese Revfy dentry_operations| 321579404849SEmese Revfy dev_pm_ops| 321679404849SEmese Revfy dma_map_ops| 321779404849SEmese Revfy extent_io_ops| 321879404849SEmese Revfy file_lock_operations| 321979404849SEmese Revfy file_operations| 322079404849SEmese Revfy hv_ops| 322179404849SEmese Revfy ide_dma_ops| 322279404849SEmese Revfy intel_dvo_dev_ops| 322379404849SEmese Revfy item_operations| 322479404849SEmese Revfy iwl_ops| 322579404849SEmese Revfy kgdb_arch| 322679404849SEmese Revfy kgdb_io| 322779404849SEmese Revfy kset_uevent_ops| 322879404849SEmese Revfy lock_manager_operations| 322979404849SEmese Revfy microcode_ops| 323079404849SEmese Revfy mtrr_ops| 323179404849SEmese Revfy neigh_ops| 323279404849SEmese Revfy nlmsvc_binding| 323379404849SEmese Revfy pci_raw_ops| 323479404849SEmese Revfy pipe_buf_operations| 323579404849SEmese Revfy platform_hibernation_ops| 323679404849SEmese Revfy platform_suspend_ops| 323779404849SEmese Revfy proto_ops| 323879404849SEmese Revfy rpc_pipe_ops| 323979404849SEmese Revfy seq_operations| 324079404849SEmese Revfy snd_ac97_build_ops| 324179404849SEmese Revfy soc_pcmcia_socket_ops| 324279404849SEmese Revfy stacktrace_ops| 324379404849SEmese Revfy sysfs_ops| 324479404849SEmese Revfy tty_operations| 324579404849SEmese Revfy usb_mon_operations| 324679404849SEmese Revfy wd_ops}x; 32476903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 324879404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3249000d1cc1SJoe Perches WARN("CONST_STRUCT", 3250000d1cc1SJoe Perches "struct $1 should normally be const\n" . 32516903ffb2SAndy Whitcroft $herecurr); 32522b6db5cbSAndy Whitcroft } 3253773647a0SAndy Whitcroft 3254773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3255773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3256773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3257c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3258c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3259171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3260171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3261171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3262773647a0SAndy Whitcroft { 3263000d1cc1SJoe Perches WARN("NR_CPUS", 3264000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3265773647a0SAndy Whitcroft } 32669c9ba34eSAndy Whitcroft 32679c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 32689c9ba34eSAndy Whitcroft my $string; 32699c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 32709c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 32712a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 32729c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3273000d1cc1SJoe Perches WARN("PRINTF_L", 3274000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 32759c9ba34eSAndy Whitcroft last; 32769c9ba34eSAndy Whitcroft } 32779c9ba34eSAndy Whitcroft } 3278691d77b6SAndy Whitcroft 3279691d77b6SAndy Whitcroft# whine mightly about in_atomic 3280691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3281691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3282000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3283000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3284f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3285000d1cc1SJoe Perches WARN("IN_ATOMIC", 3286000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3287691d77b6SAndy Whitcroft } 3288691d77b6SAndy Whitcroft } 32891704f47bSPeter Zijlstra 32901704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 32911704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 32921704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 32931704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 32941704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 32951704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3296000d1cc1SJoe Perches ERROR("LOCKDEP", 3297000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 32981704f47bSPeter Zijlstra } 32991704f47bSPeter Zijlstra } 330088f8831cSDave Jones 330188f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 330288f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3303000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3304000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 330588f8831cSDave Jones } 3306309c00c7SDave Jones 3307309c00c7SDave Jones # Check for memset with swapped arguments 3308309c00c7SDave Jones if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) { 3309000d1cc1SJoe Perches ERROR("MEMSET", 3310000d1cc1SJoe Perches "memset size is 3rd argument, not the second.\n" . $herecurr); 3311309c00c7SDave Jones } 331213214adfSAndy Whitcroft } 331313214adfSAndy Whitcroft 331413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 331513214adfSAndy Whitcroft # so just keep quiet. 331613214adfSAndy Whitcroft if ($#rawlines == -1) { 331713214adfSAndy Whitcroft exit(0); 33180a920b5bSAndy Whitcroft } 33190a920b5bSAndy Whitcroft 33208905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 33218905a67cSAndy Whitcroft # things that appear to be patches. 33228905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 33238905a67cSAndy Whitcroft exit(0); 33248905a67cSAndy Whitcroft } 33258905a67cSAndy Whitcroft 33268905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 33278905a67cSAndy Whitcroft # just keep quiet. 33288905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 33298905a67cSAndy Whitcroft exit(0); 33308905a67cSAndy Whitcroft } 33318905a67cSAndy Whitcroft 33328905a67cSAndy Whitcroft if (!$is_patch) { 3333000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3334000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 33350a920b5bSAndy Whitcroft } 33360a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3337000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3338000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 33390a920b5bSAndy Whitcroft } 33400a920b5bSAndy Whitcroft 3341f0a594c1SAndy Whitcroft print report_dump(); 334213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 334313214adfSAndy Whitcroft print "$filename " if ($summary_file); 33446c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 33456c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 33466c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 33478905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 33486c72ffaaSAndy Whitcroft } 33498905a67cSAndy Whitcroft 3350d2c0a235SAndy Whitcroft if ($quiet == 0) { 3351d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3352d2c0a235SAndy Whitcroft # then suggest that. 3353d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3354d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3355d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3356b0781216SMike Frysinger $rpt_cleaners = 0; 3357d2c0a235SAndy Whitcroft } 3358d2c0a235SAndy Whitcroft } 3359d2c0a235SAndy Whitcroft 3360000d1cc1SJoe Perches if (keys %ignore_type) { 3361000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3362000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3363000d1cc1SJoe Perches print " $ignore"; 3364000d1cc1SJoe Perches } 3365000d1cc1SJoe Perches print "\n"; 3366000d1cc1SJoe Perches print "\n" if ($quiet == 0); 3367000d1cc1SJoe Perches } 3368000d1cc1SJoe Perches 33690a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3370c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 33710a920b5bSAndy Whitcroft } 33720a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3373000d1cc1SJoe Perches print << "EOM"; 3374000d1cc1SJoe Perches$vname has style problems, please review. 3375000d1cc1SJoe Perches 3376000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3377000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3378000d1cc1SJoe PerchesEOM 33790a920b5bSAndy Whitcroft } 338013214adfSAndy Whitcroft 33810a920b5bSAndy Whitcroft return $clean; 33820a920b5bSAndy Whitcroft} 3383