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"; 366cd7f386SJoe Perchesmy $max_line_length = 80; 3777f5b10aSHannes Eder 3877f5b10aSHannes Edersub help { 3977f5b10aSHannes Eder my ($exitcode) = @_; 4077f5b10aSHannes Eder 4177f5b10aSHannes Eder print << "EOM"; 4277f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 4377f5b10aSHannes EderVersion: $V 4477f5b10aSHannes Eder 4577f5b10aSHannes EderOptions: 4677f5b10aSHannes Eder -q, --quiet quiet 4777f5b10aSHannes Eder --no-tree run without a kernel tree 4877f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 4977f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5077f5b10aSHannes Eder --emacs emacs compile window format 5177f5b10aSHannes Eder --terse one line per report 5277f5b10aSHannes Eder -f, --file treat FILE as regular source file 5377f5b10aSHannes Eder --subjective, --strict enable more subjective tests 54000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 556cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 56000d1cc1SJoe Perches --show-types show the message "types" in the output 5777f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 5877f5b10aSHannes Eder --no-summary suppress the per-file summary 5977f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6077f5b10aSHannes Eder --summary-file include the filename in summary 6177f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 6277f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 6377f5b10aSHannes Eder is all off) 6477f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 6577f5b10aSHannes Eder literally 6677f5b10aSHannes Eder -h, --help, --version display this help and exit 6777f5b10aSHannes Eder 6877f5b10aSHannes EderWhen FILE is - read standard input. 6977f5b10aSHannes EderEOM 7077f5b10aSHannes Eder 7177f5b10aSHannes Eder exit($exitcode); 7277f5b10aSHannes Eder} 7377f5b10aSHannes Eder 74000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 75000d1cc1SJoe Perchesif (-f $conf) { 76000d1cc1SJoe Perches my @conf_args; 77000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 78000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 79000d1cc1SJoe Perches 80000d1cc1SJoe Perches while (<$conffile>) { 81000d1cc1SJoe Perches my $line = $_; 82000d1cc1SJoe Perches 83000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 84000d1cc1SJoe Perches $line =~ s/^\s*//g; 85000d1cc1SJoe Perches $line =~ s/\s+/ /g; 86000d1cc1SJoe Perches 87000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 88000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 89000d1cc1SJoe Perches 90000d1cc1SJoe Perches my @words = split(" ", $line); 91000d1cc1SJoe Perches foreach my $word (@words) { 92000d1cc1SJoe Perches last if ($word =~ m/^#/); 93000d1cc1SJoe Perches push (@conf_args, $word); 94000d1cc1SJoe Perches } 95000d1cc1SJoe Perches } 96000d1cc1SJoe Perches close($conffile); 97000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 98000d1cc1SJoe Perches} 99000d1cc1SJoe Perches 1000a920b5bSAndy WhitcroftGetOptions( 1016c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1020a920b5bSAndy Whitcroft 'tree!' => \$tree, 1030a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1040a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1056c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1068905a67cSAndy Whitcroft 'terse!' => \$terse, 10777f5b10aSHannes Eder 'f|file!' => \$file, 1086c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1096c72ffaaSAndy Whitcroft 'strict!' => \$check, 110000d1cc1SJoe Perches 'ignore=s' => \@ignore, 111000d1cc1SJoe Perches 'show-types!' => \$show_types, 1126cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1136c72ffaaSAndy Whitcroft 'root=s' => \$root, 1148905a67cSAndy Whitcroft 'summary!' => \$summary, 1158905a67cSAndy Whitcroft 'mailback!' => \$mailback, 11613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 11713214adfSAndy Whitcroft 118c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 119773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 12077f5b10aSHannes Eder 'h|help' => \$help, 12177f5b10aSHannes Eder 'version' => \$help 12277f5b10aSHannes Eder) or help(1); 12377f5b10aSHannes Eder 12477f5b10aSHannes Ederhelp(0) if ($help); 1250a920b5bSAndy Whitcroft 1260a920b5bSAndy Whitcroftmy $exit = 0; 1270a920b5bSAndy Whitcroft 1280a920b5bSAndy Whitcroftif ($#ARGV < 0) { 12977f5b10aSHannes Eder print "$P: no input files\n"; 1300a920b5bSAndy Whitcroft exit(1); 1310a920b5bSAndy Whitcroft} 1320a920b5bSAndy Whitcroft 133000d1cc1SJoe Perches@ignore = split(/,/, join(',',@ignore)); 134000d1cc1SJoe Perchesforeach my $word (@ignore) { 135000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 136000d1cc1SJoe Perches $word =~ s/^\s*//g; 137000d1cc1SJoe Perches $word =~ s/\s+/ /g; 138000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 139000d1cc1SJoe Perches 140000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 141000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 142000d1cc1SJoe Perches 143000d1cc1SJoe Perches $ignore_type{$word}++; 144000d1cc1SJoe Perches} 145000d1cc1SJoe Perches 146c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 147c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1487429c690SAndy Whitcroftmy $dbg_type = 0; 149a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 150c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 15121caa13cSAndy Whitcroft ## no critic 15221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 15321caa13cSAndy Whitcroft die "$@" if ($@); 154c2fdda0dSAndy Whitcroft} 155c2fdda0dSAndy Whitcroft 156d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 157d2c0a235SAndy Whitcroft 1588905a67cSAndy Whitcroftif ($terse) { 1598905a67cSAndy Whitcroft $emacs = 1; 1608905a67cSAndy Whitcroft $quiet++; 1618905a67cSAndy Whitcroft} 1628905a67cSAndy Whitcroft 1636c72ffaaSAndy Whitcroftif ($tree) { 1646c72ffaaSAndy Whitcroft if (defined $root) { 1656c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 1666c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 1676c72ffaaSAndy Whitcroft } 1686c72ffaaSAndy Whitcroft } else { 1696c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 1706c72ffaaSAndy Whitcroft $root = '.'; 1716c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 1726c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 1736c72ffaaSAndy Whitcroft $root = $1; 1746c72ffaaSAndy Whitcroft } 1756c72ffaaSAndy Whitcroft } 1766c72ffaaSAndy Whitcroft 1776c72ffaaSAndy Whitcroft if (!defined $root) { 1780a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 1790a920b5bSAndy Whitcroft exit(2); 1800a920b5bSAndy Whitcroft } 1816c72ffaaSAndy Whitcroft} 1826c72ffaaSAndy Whitcroft 1836c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1846c72ffaaSAndy Whitcroft 1852ceb532bSAndy Whitcroftour $Ident = qr{ 1862ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 1872ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 1882ceb532bSAndy Whitcroft }x; 1896c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1906c72ffaaSAndy Whitcroftour $Sparse = qr{ 1916c72ffaaSAndy Whitcroft __user| 1926c72ffaaSAndy Whitcroft __kernel| 1936c72ffaaSAndy Whitcroft __force| 1946c72ffaaSAndy Whitcroft __iomem| 1956c72ffaaSAndy Whitcroft __must_check| 1966c72ffaaSAndy Whitcroft __init_refok| 197417495edSAndy Whitcroft __kprobes| 198165e72a6SSven Eckelmann __ref| 199165e72a6SSven Eckelmann __rcu 2006c72ffaaSAndy Whitcroft }x; 20152131292SWolfram Sang 20252131292SWolfram Sang# Notes to $Attribute: 20352131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2046c72ffaaSAndy Whitcroftour $Attribute = qr{ 2056c72ffaaSAndy Whitcroft const| 20603f1df7dSJoe Perches __percpu| 20703f1df7dSJoe Perches __nocast| 20803f1df7dSJoe Perches __safe| 20903f1df7dSJoe Perches __bitwise__| 21003f1df7dSJoe Perches __packed__| 21103f1df7dSJoe Perches __packed2__| 21203f1df7dSJoe Perches __naked| 21303f1df7dSJoe Perches __maybe_unused| 21403f1df7dSJoe Perches __always_unused| 21503f1df7dSJoe Perches __noreturn| 21603f1df7dSJoe Perches __used| 21703f1df7dSJoe Perches __cold| 21803f1df7dSJoe Perches __noclone| 21903f1df7dSJoe Perches __deprecated| 2206c72ffaaSAndy Whitcroft __read_mostly| 2216c72ffaaSAndy Whitcroft __kprobes| 22252131292SWolfram Sang __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| 22324e1d81aSAndy Whitcroft ____cacheline_aligned| 22424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2255fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2265fe3af11SAndy Whitcroft __weak 2276c72ffaaSAndy Whitcroft }x; 228c45dcabdSAndy Whitcroftour $Modifier; 2296c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2306c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2316c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2326c72ffaaSAndy Whitcroft 233*74349bccSJoe Perchesour $Float_hex = qr{(?i:0x[0-9a-f]+p-?[0-9]+[fl]?)}; 234*74349bccSJoe Perchesour $Float_dec = qr{(?i:((?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?))}; 235*74349bccSJoe Perchesour $Float_int = qr{(?i:[0-9]+e-?[0-9]+[fl]?)}; 236*74349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 237*74349bccSJoe Perchesour $Constant = qr{(?:$Float|(?i:(?:0x[0-9a-f]+|[0-9]+)[ul]*))}; 2386c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 23986f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 2406c72ffaaSAndy Whitcroftour $Operators = qr{ 2416c72ffaaSAndy Whitcroft <=|>=|==|!=| 2426c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 243c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 2446c72ffaaSAndy Whitcroft }x; 2456c72ffaaSAndy Whitcroft 2468905a67cSAndy Whitcroftour $NonptrType; 2478905a67cSAndy Whitcroftour $Type; 2488905a67cSAndy Whitcroftour $Declare; 2498905a67cSAndy Whitcroft 25015662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 25115662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 252171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 253171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 254171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 255171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 256171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 257171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 258171ae1a4SAndy Whitcroft}x; 259171ae1a4SAndy Whitcroft 26015662b3eSJoe Perchesour $UTF8 = qr{ 26115662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 26215662b3eSJoe Perches | $NON_ASCII_UTF8 26315662b3eSJoe Perches}x; 26415662b3eSJoe Perches 2658ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 266fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 2678ed22cadSAndy Whitcroft atomic_t 2688ed22cadSAndy Whitcroft)}; 2698ed22cadSAndy Whitcroft 270691e669bSJoe Perchesour $logFunctions = qr{(?x: 2716e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 2726e60c02eSJoe Perches [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 2736e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 274b0531722SJoe Perches panic| 275b0531722SJoe Perches MODULE_[A-Z_]+ 276691e669bSJoe Perches)}; 277691e669bSJoe Perches 27820112475SJoe Perchesour $signature_tags = qr{(?xi: 27920112475SJoe Perches Signed-off-by:| 28020112475SJoe Perches Acked-by:| 28120112475SJoe Perches Tested-by:| 28220112475SJoe Perches Reviewed-by:| 28320112475SJoe Perches Reported-by:| 28420112475SJoe Perches To:| 28520112475SJoe Perches Cc: 28620112475SJoe Perches)}; 28720112475SJoe Perches 2888905a67cSAndy Whitcroftour @typeList = ( 2898905a67cSAndy Whitcroft qr{void}, 290c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 291c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 292c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 293c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 294c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 295c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 296c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 2978905a67cSAndy Whitcroft qr{unsigned}, 2988905a67cSAndy Whitcroft qr{float}, 2998905a67cSAndy Whitcroft qr{double}, 3008905a67cSAndy Whitcroft qr{bool}, 3018905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3028905a67cSAndy Whitcroft qr{union\s+$Ident}, 3038905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3048905a67cSAndy Whitcroft qr{${Ident}_t}, 3058905a67cSAndy Whitcroft qr{${Ident}_handler}, 3068905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3078905a67cSAndy Whitcroft); 308c45dcabdSAndy Whitcroftour @modifierList = ( 309c45dcabdSAndy Whitcroft qr{fastcall}, 310c45dcabdSAndy Whitcroft); 3118905a67cSAndy Whitcroft 3127840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3137840a94cSWolfram Sang irq| 3147840a94cSWolfram Sang memory 3157840a94cSWolfram Sang)}; 3167840a94cSWolfram Sang# memory.h: ARM has a custom one 3177840a94cSWolfram Sang 3188905a67cSAndy Whitcroftsub build_types { 319d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 320d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 321c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3228905a67cSAndy Whitcroft $NonptrType = qr{ 323d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 324cf655043SAndy Whitcroft (?: 3256b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 3268ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 327c45dcabdSAndy Whitcroft (?:${all}\b) 328cf655043SAndy Whitcroft ) 329c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 3308905a67cSAndy Whitcroft }x; 3318905a67cSAndy Whitcroft $Type = qr{ 332c45dcabdSAndy Whitcroft $NonptrType 333b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 334c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 3358905a67cSAndy Whitcroft }x; 3368905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 3378905a67cSAndy Whitcroft} 3388905a67cSAndy Whitcroftbuild_types(); 3396c72ffaaSAndy Whitcroft 3407d2367afSJoe Perches 3417d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 342d1fe9c09SJoe Perches 343d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 344d1fe9c09SJoe Perches# requires at least perl version v5.10.0 345d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 346d1fe9c09SJoe Perches 347d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 348d1fe9c09SJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; 349d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 3507d2367afSJoe Perches 3517d2367afSJoe Perchessub deparenthesize { 3527d2367afSJoe Perches my ($string) = @_; 3537d2367afSJoe Perches return "" if (!defined($string)); 3547d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 3557d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 3567d2367afSJoe Perches $string =~ s@\s+@ @g; 3577d2367afSJoe Perches return $string; 3587d2367afSJoe Perches} 3597d2367afSJoe Perches 3606c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 3610a920b5bSAndy Whitcroft 36200df344fSAndy Whitcroftmy @rawlines = (); 363c2fdda0dSAndy Whitcroftmy @lines = (); 364c2fdda0dSAndy Whitcroftmy $vname; 3656c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 36621caa13cSAndy Whitcroft my $FILE; 3676c72ffaaSAndy Whitcroft if ($file) { 36821caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 3696c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 37021caa13cSAndy Whitcroft } elsif ($filename eq '-') { 37121caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 3726c72ffaaSAndy Whitcroft } else { 37321caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 3746c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 3756c72ffaaSAndy Whitcroft } 376c2fdda0dSAndy Whitcroft if ($filename eq '-') { 377c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 378c2fdda0dSAndy Whitcroft } else { 379c2fdda0dSAndy Whitcroft $vname = $filename; 380c2fdda0dSAndy Whitcroft } 38121caa13cSAndy Whitcroft while (<$FILE>) { 3820a920b5bSAndy Whitcroft chomp; 38300df344fSAndy Whitcroft push(@rawlines, $_); 3846c72ffaaSAndy Whitcroft } 38521caa13cSAndy Whitcroft close($FILE); 386c2fdda0dSAndy Whitcroft if (!process($filename)) { 3870a920b5bSAndy Whitcroft $exit = 1; 3880a920b5bSAndy Whitcroft } 38900df344fSAndy Whitcroft @rawlines = (); 39013214adfSAndy Whitcroft @lines = (); 3910a920b5bSAndy Whitcroft} 3920a920b5bSAndy Whitcroft 3930a920b5bSAndy Whitcroftexit($exit); 3940a920b5bSAndy Whitcroft 3950a920b5bSAndy Whitcroftsub top_of_kernel_tree { 3966c72ffaaSAndy Whitcroft my ($root) = @_; 3976c72ffaaSAndy Whitcroft 3986c72ffaaSAndy Whitcroft my @tree_check = ( 3996c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 4006c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 4016c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 4026c72ffaaSAndy Whitcroft ); 4036c72ffaaSAndy Whitcroft 4046c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 4056c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 4060a920b5bSAndy Whitcroft return 0; 4070a920b5bSAndy Whitcroft } 4086c72ffaaSAndy Whitcroft } 4096c72ffaaSAndy Whitcroft return 1; 4106c72ffaaSAndy Whitcroft} 4110a920b5bSAndy Whitcroft 41220112475SJoe Perchessub parse_email { 41320112475SJoe Perches my ($formatted_email) = @_; 41420112475SJoe Perches 41520112475SJoe Perches my $name = ""; 41620112475SJoe Perches my $address = ""; 41720112475SJoe Perches my $comment = ""; 41820112475SJoe Perches 41920112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 42020112475SJoe Perches $name = $1; 42120112475SJoe Perches $address = $2; 42220112475SJoe Perches $comment = $3 if defined $3; 42320112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 42420112475SJoe Perches $address = $1; 42520112475SJoe Perches $comment = $2 if defined $2; 42620112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 42720112475SJoe Perches $address = $1; 42820112475SJoe Perches $comment = $2 if defined $2; 42920112475SJoe Perches $formatted_email =~ s/$address.*$//; 43020112475SJoe Perches $name = $formatted_email; 43120112475SJoe Perches $name =~ s/^\s+|\s+$//g; 43220112475SJoe Perches $name =~ s/^\"|\"$//g; 43320112475SJoe Perches # If there's a name left after stripping spaces and 43420112475SJoe Perches # leading quotes, and the address doesn't have both 43520112475SJoe Perches # leading and trailing angle brackets, the address 43620112475SJoe Perches # is invalid. ie: 43720112475SJoe Perches # "joe smith [email protected]" bad 43820112475SJoe Perches # "joe smith <[email protected]" bad 43920112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 44020112475SJoe Perches $name = ""; 44120112475SJoe Perches $address = ""; 44220112475SJoe Perches $comment = ""; 44320112475SJoe Perches } 44420112475SJoe Perches } 44520112475SJoe Perches 44620112475SJoe Perches $name =~ s/^\s+|\s+$//g; 44720112475SJoe Perches $name =~ s/^\"|\"$//g; 44820112475SJoe Perches $address =~ s/^\s+|\s+$//g; 44920112475SJoe Perches $address =~ s/^\<|\>$//g; 45020112475SJoe Perches 45120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 45220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 45320112475SJoe Perches $name = "\"$name\""; 45420112475SJoe Perches } 45520112475SJoe Perches 45620112475SJoe Perches return ($name, $address, $comment); 45720112475SJoe Perches} 45820112475SJoe Perches 45920112475SJoe Perchessub format_email { 46020112475SJoe Perches my ($name, $address) = @_; 46120112475SJoe Perches 46220112475SJoe Perches my $formatted_email; 46320112475SJoe Perches 46420112475SJoe Perches $name =~ s/^\s+|\s+$//g; 46520112475SJoe Perches $name =~ s/^\"|\"$//g; 46620112475SJoe Perches $address =~ s/^\s+|\s+$//g; 46720112475SJoe Perches 46820112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 46920112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 47020112475SJoe Perches $name = "\"$name\""; 47120112475SJoe Perches } 47220112475SJoe Perches 47320112475SJoe Perches if ("$name" eq "") { 47420112475SJoe Perches $formatted_email = "$address"; 47520112475SJoe Perches } else { 47620112475SJoe Perches $formatted_email = "$name <$address>"; 47720112475SJoe Perches } 47820112475SJoe Perches 47920112475SJoe Perches return $formatted_email; 48020112475SJoe Perches} 48120112475SJoe Perches 482000d1cc1SJoe Perchessub which_conf { 483000d1cc1SJoe Perches my ($conf) = @_; 484000d1cc1SJoe Perches 485000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 486000d1cc1SJoe Perches if (-e "$path/$conf") { 487000d1cc1SJoe Perches return "$path/$conf"; 488000d1cc1SJoe Perches } 489000d1cc1SJoe Perches } 490000d1cc1SJoe Perches 491000d1cc1SJoe Perches return ""; 492000d1cc1SJoe Perches} 493000d1cc1SJoe Perches 4940a920b5bSAndy Whitcroftsub expand_tabs { 4950a920b5bSAndy Whitcroft my ($str) = @_; 4960a920b5bSAndy Whitcroft 4970a920b5bSAndy Whitcroft my $res = ''; 4980a920b5bSAndy Whitcroft my $n = 0; 4990a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 5000a920b5bSAndy Whitcroft if ($c eq "\t") { 5010a920b5bSAndy Whitcroft $res .= ' '; 5020a920b5bSAndy Whitcroft $n++; 5030a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 5040a920b5bSAndy Whitcroft $res .= ' '; 5050a920b5bSAndy Whitcroft } 5060a920b5bSAndy Whitcroft next; 5070a920b5bSAndy Whitcroft } 5080a920b5bSAndy Whitcroft $res .= $c; 5090a920b5bSAndy Whitcroft $n++; 5100a920b5bSAndy Whitcroft } 5110a920b5bSAndy Whitcroft 5120a920b5bSAndy Whitcroft return $res; 5130a920b5bSAndy Whitcroft} 5146c72ffaaSAndy Whitcroftsub copy_spacing { 515773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 5166c72ffaaSAndy Whitcroft return $res; 5176c72ffaaSAndy Whitcroft} 5180a920b5bSAndy Whitcroft 5194a0df2efSAndy Whitcroftsub line_stats { 5204a0df2efSAndy Whitcroft my ($line) = @_; 5214a0df2efSAndy Whitcroft 5224a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 5234a0df2efSAndy Whitcroft $line =~ s/^.//; 5244a0df2efSAndy Whitcroft $line = expand_tabs($line); 5254a0df2efSAndy Whitcroft 5264a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 5274a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 5284a0df2efSAndy Whitcroft 5294a0df2efSAndy Whitcroft return (length($line), length($white)); 5304a0df2efSAndy Whitcroft} 5314a0df2efSAndy Whitcroft 532773647a0SAndy Whitcroftmy $sanitise_quote = ''; 533773647a0SAndy Whitcroft 534773647a0SAndy Whitcroftsub sanitise_line_reset { 535773647a0SAndy Whitcroft my ($in_comment) = @_; 536773647a0SAndy Whitcroft 537773647a0SAndy Whitcroft if ($in_comment) { 538773647a0SAndy Whitcroft $sanitise_quote = '*/'; 539773647a0SAndy Whitcroft } else { 540773647a0SAndy Whitcroft $sanitise_quote = ''; 541773647a0SAndy Whitcroft } 542773647a0SAndy Whitcroft} 54300df344fSAndy Whitcroftsub sanitise_line { 54400df344fSAndy Whitcroft my ($line) = @_; 54500df344fSAndy Whitcroft 54600df344fSAndy Whitcroft my $res = ''; 54700df344fSAndy Whitcroft my $l = ''; 54800df344fSAndy Whitcroft 549c2fdda0dSAndy Whitcroft my $qlen = 0; 550773647a0SAndy Whitcroft my $off = 0; 551773647a0SAndy Whitcroft my $c; 55200df344fSAndy Whitcroft 553773647a0SAndy Whitcroft # Always copy over the diff marker. 554773647a0SAndy Whitcroft $res = substr($line, 0, 1); 555773647a0SAndy Whitcroft 556773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 557773647a0SAndy Whitcroft $c = substr($line, $off, 1); 558773647a0SAndy Whitcroft 559773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 560773647a0SAndy Whitcroft # and end, all to $;. 561773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 562773647a0SAndy Whitcroft $sanitise_quote = '*/'; 563773647a0SAndy Whitcroft 564773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 565773647a0SAndy Whitcroft $off++; 56600df344fSAndy Whitcroft next; 567773647a0SAndy Whitcroft } 56881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 569773647a0SAndy Whitcroft $sanitise_quote = ''; 570773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 571773647a0SAndy Whitcroft $off++; 572773647a0SAndy Whitcroft next; 573773647a0SAndy Whitcroft } 574113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 575113f04a8SDaniel Walker $sanitise_quote = '//'; 576113f04a8SDaniel Walker 577113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 578113f04a8SDaniel Walker $off++; 579113f04a8SDaniel Walker next; 580113f04a8SDaniel Walker } 581773647a0SAndy Whitcroft 582773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 583773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 584773647a0SAndy Whitcroft $c eq "\\") { 585773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 586773647a0SAndy Whitcroft $off++; 587773647a0SAndy Whitcroft next; 588773647a0SAndy Whitcroft } 589773647a0SAndy Whitcroft # Regular quotes. 590773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 591773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 592773647a0SAndy Whitcroft $sanitise_quote = $c; 593773647a0SAndy Whitcroft 594773647a0SAndy Whitcroft substr($res, $off, 1, $c); 595773647a0SAndy Whitcroft next; 596773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 597773647a0SAndy Whitcroft $sanitise_quote = ''; 59800df344fSAndy Whitcroft } 59900df344fSAndy Whitcroft } 600773647a0SAndy Whitcroft 601fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 602773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 603773647a0SAndy Whitcroft substr($res, $off, 1, $;); 604113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 605113f04a8SDaniel Walker substr($res, $off, 1, $;); 606773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 607773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 60800df344fSAndy Whitcroft } else { 609773647a0SAndy Whitcroft substr($res, $off, 1, $c); 61000df344fSAndy Whitcroft } 611c2fdda0dSAndy Whitcroft } 612c2fdda0dSAndy Whitcroft 613113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 614113f04a8SDaniel Walker $sanitise_quote = ''; 615113f04a8SDaniel Walker } 616113f04a8SDaniel Walker 617c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 618c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 619c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 620c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 621c2fdda0dSAndy Whitcroft 622c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 623c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 624c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 625c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 626c2fdda0dSAndy Whitcroft } 627c2fdda0dSAndy Whitcroft 62800df344fSAndy Whitcroft return $res; 62900df344fSAndy Whitcroft} 63000df344fSAndy Whitcroft 6318905a67cSAndy Whitcroftsub ctx_statement_block { 6328905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6338905a67cSAndy Whitcroft my $line = $linenr - 1; 6348905a67cSAndy Whitcroft my $blk = ''; 6358905a67cSAndy Whitcroft my $soff = $off; 6368905a67cSAndy Whitcroft my $coff = $off - 1; 637773647a0SAndy Whitcroft my $coff_set = 0; 6388905a67cSAndy Whitcroft 63913214adfSAndy Whitcroft my $loff = 0; 64013214adfSAndy Whitcroft 6418905a67cSAndy Whitcroft my $type = ''; 6428905a67cSAndy Whitcroft my $level = 0; 643a2750645SAndy Whitcroft my @stack = (); 644cf655043SAndy Whitcroft my $p; 6458905a67cSAndy Whitcroft my $c; 6468905a67cSAndy Whitcroft my $len = 0; 64713214adfSAndy Whitcroft 64813214adfSAndy Whitcroft my $remainder; 6498905a67cSAndy Whitcroft while (1) { 650a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 651a2750645SAndy Whitcroft 652773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6538905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6548905a67cSAndy Whitcroft # context. 6558905a67cSAndy Whitcroft if ($off >= $len) { 6568905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 657dea33496SAndy Whitcroft last if (!defined $lines[$line]); 658c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6598905a67cSAndy Whitcroft $remain--; 66013214adfSAndy Whitcroft $loff = $len; 661c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6628905a67cSAndy Whitcroft $len = length($blk); 6638905a67cSAndy Whitcroft $line++; 6648905a67cSAndy Whitcroft last; 6658905a67cSAndy Whitcroft } 6668905a67cSAndy Whitcroft # Bail if there is no further context. 6678905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 66813214adfSAndy Whitcroft if ($off >= $len) { 6698905a67cSAndy Whitcroft last; 6708905a67cSAndy Whitcroft } 671f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 672f74bd194SAndy Whitcroft $level++; 673f74bd194SAndy Whitcroft $type = '#'; 674f74bd194SAndy Whitcroft } 6758905a67cSAndy Whitcroft } 676cf655043SAndy Whitcroft $p = $c; 6778905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 67813214adfSAndy Whitcroft $remainder = substr($blk, $off); 6798905a67cSAndy Whitcroft 680773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6814635f4fbSAndy Whitcroft 6824635f4fbSAndy Whitcroft # Handle nested #if/#else. 6834635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6844635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6854635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 6864635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 6874635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 6884635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 6894635f4fbSAndy Whitcroft } 6904635f4fbSAndy Whitcroft 6918905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 6928905a67cSAndy Whitcroft # outermost level. 6938905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 6948905a67cSAndy Whitcroft last; 6958905a67cSAndy Whitcroft } 6968905a67cSAndy Whitcroft 69713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 698773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 699773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 700773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 701773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 702773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 703773647a0SAndy Whitcroft $coff_set = 1; 704773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 705773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 70613214adfSAndy Whitcroft } 70713214adfSAndy Whitcroft 7088905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7098905a67cSAndy Whitcroft $level++; 7108905a67cSAndy Whitcroft $type = '('; 7118905a67cSAndy Whitcroft } 7128905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7138905a67cSAndy Whitcroft $level--; 7148905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7158905a67cSAndy Whitcroft 7168905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7178905a67cSAndy Whitcroft $coff = $off; 718773647a0SAndy Whitcroft $coff_set = 1; 719773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7208905a67cSAndy Whitcroft } 7218905a67cSAndy Whitcroft } 7228905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7238905a67cSAndy Whitcroft $level++; 7248905a67cSAndy Whitcroft $type = '{'; 7258905a67cSAndy Whitcroft } 7268905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7278905a67cSAndy Whitcroft $level--; 7288905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7298905a67cSAndy Whitcroft 7308905a67cSAndy Whitcroft if ($level == 0) { 731b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 732b998e001SPatrick Pannuto $off++; 733b998e001SPatrick Pannuto } 7348905a67cSAndy Whitcroft last; 7358905a67cSAndy Whitcroft } 7368905a67cSAndy Whitcroft } 737f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 738f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 739f74bd194SAndy Whitcroft $level--; 740f74bd194SAndy Whitcroft $type = ''; 741f74bd194SAndy Whitcroft $off++; 742f74bd194SAndy Whitcroft last; 743f74bd194SAndy Whitcroft } 7448905a67cSAndy Whitcroft $off++; 7458905a67cSAndy Whitcroft } 746a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 74713214adfSAndy Whitcroft if ($off == $len) { 748a3bb97a7SAndy Whitcroft $loff = $len + 1; 74913214adfSAndy Whitcroft $line++; 75013214adfSAndy Whitcroft $remain--; 75113214adfSAndy Whitcroft } 7528905a67cSAndy Whitcroft 7538905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7548905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7558905a67cSAndy Whitcroft 7568905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7578905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7588905a67cSAndy Whitcroft 759773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 76013214adfSAndy Whitcroft 76113214adfSAndy Whitcroft return ($statement, $condition, 76213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 76313214adfSAndy Whitcroft} 76413214adfSAndy Whitcroft 765cf655043SAndy Whitcroftsub statement_lines { 766cf655043SAndy Whitcroft my ($stmt) = @_; 767cf655043SAndy Whitcroft 768cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 769cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 770cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 771cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 772cf655043SAndy Whitcroft 773cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 774cf655043SAndy Whitcroft 775cf655043SAndy Whitcroft return $#stmt_lines + 2; 776cf655043SAndy Whitcroft} 777cf655043SAndy Whitcroft 778cf655043SAndy Whitcroftsub statement_rawlines { 779cf655043SAndy Whitcroft my ($stmt) = @_; 780cf655043SAndy Whitcroft 781cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 782cf655043SAndy Whitcroft 783cf655043SAndy Whitcroft return $#stmt_lines + 2; 784cf655043SAndy Whitcroft} 785cf655043SAndy Whitcroft 786cf655043SAndy Whitcroftsub statement_block_size { 787cf655043SAndy Whitcroft my ($stmt) = @_; 788cf655043SAndy Whitcroft 789cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 790cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 791cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 792cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 793cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 794cf655043SAndy Whitcroft 795cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 796cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 797cf655043SAndy Whitcroft 798cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 799cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 800cf655043SAndy Whitcroft 801cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 802cf655043SAndy Whitcroft return $stmt_lines; 803cf655043SAndy Whitcroft } else { 804cf655043SAndy Whitcroft return $stmt_statements; 805cf655043SAndy Whitcroft } 806cf655043SAndy Whitcroft} 807cf655043SAndy Whitcroft 80813214adfSAndy Whitcroftsub ctx_statement_full { 80913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 81013214adfSAndy Whitcroft my ($statement, $condition, $level); 81113214adfSAndy Whitcroft 81213214adfSAndy Whitcroft my (@chunks); 81313214adfSAndy Whitcroft 814cf655043SAndy Whitcroft # Grab the first conditional/block pair. 81513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 81613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 817773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 81813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 819cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 820cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 821cf655043SAndy Whitcroft } 822cf655043SAndy Whitcroft 823cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 824cf655043SAndy Whitcroft # could continue the statement. 825cf655043SAndy Whitcroft for (;;) { 82613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 82713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 828cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 829773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 830cf655043SAndy Whitcroft #print "C: push\n"; 831cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 83213214adfSAndy Whitcroft } 83313214adfSAndy Whitcroft 83413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8358905a67cSAndy Whitcroft} 8368905a67cSAndy Whitcroft 8374a0df2efSAndy Whitcroftsub ctx_block_get { 838f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8394a0df2efSAndy Whitcroft my $line; 8404a0df2efSAndy Whitcroft my $start = $linenr - 1; 8414a0df2efSAndy Whitcroft my $blk = ''; 8424a0df2efSAndy Whitcroft my @o; 8434a0df2efSAndy Whitcroft my @c; 8444a0df2efSAndy Whitcroft my @res = (); 8454a0df2efSAndy Whitcroft 846f0a594c1SAndy Whitcroft my $level = 0; 8474635f4fbSAndy Whitcroft my @stack = ($level); 84800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 84900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 85000df344fSAndy Whitcroft $remain--; 85100df344fSAndy Whitcroft 85200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8534635f4fbSAndy Whitcroft 8544635f4fbSAndy Whitcroft # Handle nested #if/#else. 85501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8564635f4fbSAndy Whitcroft push(@stack, $level); 85701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8584635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 85901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8604635f4fbSAndy Whitcroft $level = pop(@stack); 8614635f4fbSAndy Whitcroft } 8624635f4fbSAndy Whitcroft 86301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 864f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 865f0a594c1SAndy Whitcroft if ($off > 0) { 866f0a594c1SAndy Whitcroft $off--; 867f0a594c1SAndy Whitcroft next; 868f0a594c1SAndy Whitcroft } 8694a0df2efSAndy Whitcroft 870f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 871f0a594c1SAndy Whitcroft $level--; 872f0a594c1SAndy Whitcroft last if ($level == 0); 873f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 874f0a594c1SAndy Whitcroft $level++; 875f0a594c1SAndy Whitcroft } 876f0a594c1SAndy Whitcroft } 8774a0df2efSAndy Whitcroft 878f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 87900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8804a0df2efSAndy Whitcroft } 8814a0df2efSAndy Whitcroft 882f0a594c1SAndy Whitcroft last if ($level == 0); 8834a0df2efSAndy Whitcroft } 8844a0df2efSAndy Whitcroft 885f0a594c1SAndy Whitcroft return ($level, @res); 8864a0df2efSAndy Whitcroft} 8874a0df2efSAndy Whitcroftsub ctx_block_outer { 8884a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8894a0df2efSAndy Whitcroft 890f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 891f0a594c1SAndy Whitcroft return @r; 8924a0df2efSAndy Whitcroft} 8934a0df2efSAndy Whitcroftsub ctx_block { 8944a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8954a0df2efSAndy Whitcroft 896f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 897f0a594c1SAndy Whitcroft return @r; 898653d4876SAndy Whitcroft} 899653d4876SAndy Whitcroftsub ctx_statement { 900f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 901f0a594c1SAndy Whitcroft 902f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 903f0a594c1SAndy Whitcroft return @r; 904f0a594c1SAndy Whitcroft} 905f0a594c1SAndy Whitcroftsub ctx_block_level { 906653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 907653d4876SAndy Whitcroft 908f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9094a0df2efSAndy Whitcroft} 9109c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9119c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9129c0ca6f9SAndy Whitcroft 9139c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9149c0ca6f9SAndy Whitcroft} 9154a0df2efSAndy Whitcroft 9164a0df2efSAndy Whitcroftsub ctx_locate_comment { 9174a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9184a0df2efSAndy Whitcroft 9194a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 920beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9214a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9224a0df2efSAndy Whitcroft 9234a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9244a0df2efSAndy Whitcroft # comment. 9254a0df2efSAndy Whitcroft my $in_comment = 0; 9264a0df2efSAndy Whitcroft $current_comment = ''; 9274a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 92800df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 92900df344fSAndy Whitcroft #warn " $line\n"; 9304a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9314a0df2efSAndy Whitcroft $in_comment = 1; 9324a0df2efSAndy Whitcroft } 9334a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9344a0df2efSAndy Whitcroft $in_comment = 1; 9354a0df2efSAndy Whitcroft } 9364a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9374a0df2efSAndy Whitcroft $current_comment = ''; 9384a0df2efSAndy Whitcroft } 9394a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9404a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9414a0df2efSAndy Whitcroft $in_comment = 0; 9424a0df2efSAndy Whitcroft } 9434a0df2efSAndy Whitcroft } 9444a0df2efSAndy Whitcroft 9454a0df2efSAndy Whitcroft chomp($current_comment); 9464a0df2efSAndy Whitcroft return($current_comment); 9474a0df2efSAndy Whitcroft} 9484a0df2efSAndy Whitcroftsub ctx_has_comment { 9494a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9504a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9514a0df2efSAndy Whitcroft 95200df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9534a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9544a0df2efSAndy Whitcroft 9554a0df2efSAndy Whitcroft return ($cmt ne ''); 9564a0df2efSAndy Whitcroft} 9574a0df2efSAndy Whitcroft 9584d001e4dSAndy Whitcroftsub raw_line { 9594d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9604d001e4dSAndy Whitcroft 9614d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9624d001e4dSAndy Whitcroft $cnt++; 9634d001e4dSAndy Whitcroft 9644d001e4dSAndy Whitcroft my $line; 9654d001e4dSAndy Whitcroft while ($cnt) { 9664d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9674d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9684d001e4dSAndy Whitcroft $cnt--; 9694d001e4dSAndy Whitcroft } 9704d001e4dSAndy Whitcroft 9714d001e4dSAndy Whitcroft return $line; 9724d001e4dSAndy Whitcroft} 9734d001e4dSAndy Whitcroft 9740a920b5bSAndy Whitcroftsub cat_vet { 9750a920b5bSAndy Whitcroft my ($vet) = @_; 9769c0ca6f9SAndy Whitcroft my ($res, $coded); 9770a920b5bSAndy Whitcroft 9789c0ca6f9SAndy Whitcroft $res = ''; 9796c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9806c72ffaaSAndy Whitcroft $res .= $1; 9816c72ffaaSAndy Whitcroft if ($2 ne '') { 9829c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9836c72ffaaSAndy Whitcroft $res .= $coded; 9846c72ffaaSAndy Whitcroft } 9859c0ca6f9SAndy Whitcroft } 9869c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 9870a920b5bSAndy Whitcroft 9889c0ca6f9SAndy Whitcroft return $res; 9890a920b5bSAndy Whitcroft} 9900a920b5bSAndy Whitcroft 991c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 992cf655043SAndy Whitcroftmy $av_pending; 993c2fdda0dSAndy Whitcroftmy @av_paren_type; 9941f65f947SAndy Whitcroftmy $av_pend_colon; 995c2fdda0dSAndy Whitcroft 996c2fdda0dSAndy Whitcroftsub annotate_reset { 997c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 998cf655043SAndy Whitcroft $av_pending = '_'; 999cf655043SAndy Whitcroft @av_paren_type = ('E'); 10001f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1001c2fdda0dSAndy Whitcroft} 1002c2fdda0dSAndy Whitcroft 10036c72ffaaSAndy Whitcroftsub annotate_values { 10046c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10056c72ffaaSAndy Whitcroft 10066c72ffaaSAndy Whitcroft my $res; 10071f65f947SAndy Whitcroft my $var = '_' x length($stream); 10086c72ffaaSAndy Whitcroft my $cur = $stream; 10096c72ffaaSAndy Whitcroft 1010c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10116c72ffaaSAndy Whitcroft 10126c72ffaaSAndy Whitcroft while (length($cur)) { 1013773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1014cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1015171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10166c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1017c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1018c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1019cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1020c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10216c72ffaaSAndy Whitcroft } 10226c72ffaaSAndy Whitcroft 1023c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10249446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10259446ef56SAndy Whitcroft push(@av_paren_type, $type); 1026addcdceaSAndy Whitcroft $type = 'c'; 10279446ef56SAndy Whitcroft 1028e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1029c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10306c72ffaaSAndy Whitcroft $type = 'T'; 10316c72ffaaSAndy Whitcroft 1032389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1033389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1034389a2fe5SAndy Whitcroft $type = 'T'; 1035389a2fe5SAndy Whitcroft 1036c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1037171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1038c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1039171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1040171ae1a4SAndy Whitcroft if ($2 ne '') { 1041cf655043SAndy Whitcroft $av_pending = 'N'; 1042171ae1a4SAndy Whitcroft } 1043171ae1a4SAndy Whitcroft $type = 'E'; 1044171ae1a4SAndy Whitcroft 1045c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1046171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1047171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1048171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10496c72ffaaSAndy Whitcroft 1050c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1051cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1052c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1053cf655043SAndy Whitcroft 1054cf655043SAndy Whitcroft push(@av_paren_type, $type); 1055cf655043SAndy Whitcroft push(@av_paren_type, $type); 1056171ae1a4SAndy Whitcroft $type = 'E'; 1057cf655043SAndy Whitcroft 1058c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1059cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1060cf655043SAndy Whitcroft $av_preprocessor = 1; 1061cf655043SAndy Whitcroft 1062cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1063cf655043SAndy Whitcroft 1064171ae1a4SAndy Whitcroft $type = 'E'; 1065cf655043SAndy Whitcroft 1066c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1067cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1068cf655043SAndy Whitcroft 1069cf655043SAndy Whitcroft $av_preprocessor = 1; 1070cf655043SAndy Whitcroft 1071cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1072cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1073cf655043SAndy Whitcroft pop(@av_paren_type); 1074cf655043SAndy Whitcroft push(@av_paren_type, $type); 1075171ae1a4SAndy Whitcroft $type = 'E'; 10766c72ffaaSAndy Whitcroft 10776c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1078c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10796c72ffaaSAndy Whitcroft 1080171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1081171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1082171ae1a4SAndy Whitcroft $av_pending = $type; 1083171ae1a4SAndy Whitcroft $type = 'N'; 1084171ae1a4SAndy Whitcroft 10856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1086c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 10876c72ffaaSAndy Whitcroft if (defined $2) { 1088cf655043SAndy Whitcroft $av_pending = 'V'; 10896c72ffaaSAndy Whitcroft } 10906c72ffaaSAndy Whitcroft $type = 'N'; 10916c72ffaaSAndy Whitcroft 109214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1093c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 109414b111c1SAndy Whitcroft $av_pending = 'E'; 10956c72ffaaSAndy Whitcroft $type = 'N'; 10966c72ffaaSAndy Whitcroft 10971f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 10981f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 10991f65f947SAndy Whitcroft $av_pend_colon = 'C'; 11001f65f947SAndy Whitcroft $type = 'N'; 11011f65f947SAndy Whitcroft 110214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1103c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11046c72ffaaSAndy Whitcroft $type = 'N'; 11056c72ffaaSAndy Whitcroft 11066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1107c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1108cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1109cf655043SAndy Whitcroft $av_pending = '_'; 11106c72ffaaSAndy Whitcroft $type = 'N'; 11116c72ffaaSAndy Whitcroft 11126c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1113cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1114cf655043SAndy Whitcroft if ($new_type ne '_') { 1115cf655043SAndy Whitcroft $type = $new_type; 1116c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1117c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11186c72ffaaSAndy Whitcroft } else { 1119c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11206c72ffaaSAndy Whitcroft } 11216c72ffaaSAndy Whitcroft 1122c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1123c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1124c8cb2ca3SAndy Whitcroft $type = 'V'; 1125cf655043SAndy Whitcroft $av_pending = 'V'; 11266c72ffaaSAndy Whitcroft 11278e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11288e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11291f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11308e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11318e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11321f65f947SAndy Whitcroft } 11331f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11341f65f947SAndy Whitcroft $type = 'V'; 11351f65f947SAndy Whitcroft 11366c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1137c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11386c72ffaaSAndy Whitcroft $type = 'V'; 11396c72ffaaSAndy Whitcroft 11406c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1141c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11426c72ffaaSAndy Whitcroft $type = 'N'; 11436c72ffaaSAndy Whitcroft 1144cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1145c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 114613214adfSAndy Whitcroft $type = 'E'; 11471f65f947SAndy Whitcroft $av_pend_colon = 'O'; 114813214adfSAndy Whitcroft 11498e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11508e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11518e761b04SAndy Whitcroft $type = 'C'; 11528e761b04SAndy Whitcroft 11531f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11541f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11551f65f947SAndy Whitcroft $type = 'N'; 11561f65f947SAndy Whitcroft 11571f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11581f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11591f65f947SAndy Whitcroft 11601f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11611f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11621f65f947SAndy Whitcroft $type = 'E'; 11631f65f947SAndy Whitcroft } else { 11641f65f947SAndy Whitcroft $type = 'N'; 11651f65f947SAndy Whitcroft } 11661f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11671f65f947SAndy Whitcroft 11688e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 116913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11706c72ffaaSAndy Whitcroft $type = 'N'; 11716c72ffaaSAndy Whitcroft 11720d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 117374048ed8SAndy Whitcroft my $variant; 117474048ed8SAndy Whitcroft 117574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 117674048ed8SAndy Whitcroft if ($type eq 'V') { 117774048ed8SAndy Whitcroft $variant = 'B'; 117874048ed8SAndy Whitcroft } else { 117974048ed8SAndy Whitcroft $variant = 'U'; 118074048ed8SAndy Whitcroft } 118174048ed8SAndy Whitcroft 118274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 118374048ed8SAndy Whitcroft $type = 'N'; 118474048ed8SAndy Whitcroft 11856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1186c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 11876c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 11886c72ffaaSAndy Whitcroft $type = 'N'; 11896c72ffaaSAndy Whitcroft } 11906c72ffaaSAndy Whitcroft 11916c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1192c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 11936c72ffaaSAndy Whitcroft } 11946c72ffaaSAndy Whitcroft if (defined $1) { 11956c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 11966c72ffaaSAndy Whitcroft $res .= $type x length($1); 11976c72ffaaSAndy Whitcroft } 11986c72ffaaSAndy Whitcroft } 11996c72ffaaSAndy Whitcroft 12001f65f947SAndy Whitcroft return ($res, $var); 12016c72ffaaSAndy Whitcroft} 12026c72ffaaSAndy Whitcroft 12038905a67cSAndy Whitcroftsub possible { 120413214adfSAndy Whitcroft my ($possible, $line) = @_; 12059a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12060776e594SAndy Whitcroft ^(?: 12070776e594SAndy Whitcroft $Modifier| 12080776e594SAndy Whitcroft $Storage| 12090776e594SAndy Whitcroft $Type| 12109a974fdbSAndy Whitcroft DEFINE_\S+ 12119a974fdbSAndy Whitcroft )$| 12129a974fdbSAndy Whitcroft ^(?: 12130776e594SAndy Whitcroft goto| 12140776e594SAndy Whitcroft return| 12150776e594SAndy Whitcroft case| 12160776e594SAndy Whitcroft else| 12170776e594SAndy Whitcroft asm|__asm__| 121889a88353SAndy Whitcroft do| 121989a88353SAndy Whitcroft \#| 122089a88353SAndy Whitcroft \#\#| 12219a974fdbSAndy Whitcroft )(?:\s|$)| 12220776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12239a974fdbSAndy Whitcroft )}x; 12249a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12259a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1226c45dcabdSAndy Whitcroft # Check for modifiers. 1227c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1228c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1229c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1230c45dcabdSAndy Whitcroft 1231c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1232c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1233d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12349a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1235d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1236d2506586SAndy Whitcroft push(@modifierList, $modifier); 1237d2506586SAndy Whitcroft } 12389a974fdbSAndy Whitcroft } 1239c45dcabdSAndy Whitcroft 1240c45dcabdSAndy Whitcroft } else { 124113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12428905a67cSAndy Whitcroft push(@typeList, $possible); 1243c45dcabdSAndy Whitcroft } 12448905a67cSAndy Whitcroft build_types(); 12450776e594SAndy Whitcroft } else { 12460776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12478905a67cSAndy Whitcroft } 12488905a67cSAndy Whitcroft} 12498905a67cSAndy Whitcroft 12506c72ffaaSAndy Whitcroftmy $prefix = ''; 12516c72ffaaSAndy Whitcroft 1252000d1cc1SJoe Perchessub show_type { 1253000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1254000d1cc1SJoe Perches} 1255000d1cc1SJoe Perches 1256f0a594c1SAndy Whitcroftsub report { 1257000d1cc1SJoe Perches if (!show_type($_[1]) || 1258000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1259773647a0SAndy Whitcroft return 0; 1260773647a0SAndy Whitcroft } 1261000d1cc1SJoe Perches my $line; 1262000d1cc1SJoe Perches if ($show_types) { 1263000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1264000d1cc1SJoe Perches } else { 1265000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1266000d1cc1SJoe Perches } 12678905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12688905a67cSAndy Whitcroft 126913214adfSAndy Whitcroft push(our @report, $line); 1270773647a0SAndy Whitcroft 1271773647a0SAndy Whitcroft return 1; 1272f0a594c1SAndy Whitcroft} 1273f0a594c1SAndy Whitcroftsub report_dump { 127413214adfSAndy Whitcroft our @report; 1275f0a594c1SAndy Whitcroft} 1276000d1cc1SJoe Perches 1277de7d4f0eSAndy Whitcroftsub ERROR { 1278000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1279de7d4f0eSAndy Whitcroft our $clean = 0; 12806c72ffaaSAndy Whitcroft our $cnt_error++; 1281de7d4f0eSAndy Whitcroft } 1282773647a0SAndy Whitcroft} 1283de7d4f0eSAndy Whitcroftsub WARN { 1284000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1285de7d4f0eSAndy Whitcroft our $clean = 0; 12866c72ffaaSAndy Whitcroft our $cnt_warn++; 1287de7d4f0eSAndy Whitcroft } 1288773647a0SAndy Whitcroft} 1289de7d4f0eSAndy Whitcroftsub CHK { 1290000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1291de7d4f0eSAndy Whitcroft our $clean = 0; 12926c72ffaaSAndy Whitcroft our $cnt_chk++; 12936c72ffaaSAndy Whitcroft } 1294de7d4f0eSAndy Whitcroft} 1295de7d4f0eSAndy Whitcroft 12966ecd9674SAndy Whitcroftsub check_absolute_file { 12976ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 12986ecd9674SAndy Whitcroft my $file = $absolute; 12996ecd9674SAndy Whitcroft 13006ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 13016ecd9674SAndy Whitcroft 13026ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 13036ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 13046ecd9674SAndy Whitcroft if (-f "$root/$file") { 13056ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13066ecd9674SAndy Whitcroft last; 13076ecd9674SAndy Whitcroft } 13086ecd9674SAndy Whitcroft } 13096ecd9674SAndy Whitcroft if (! -f _) { 13106ecd9674SAndy Whitcroft return 0; 13116ecd9674SAndy Whitcroft } 13126ecd9674SAndy Whitcroft 13136ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13146ecd9674SAndy Whitcroft my $prefix = $absolute; 13156ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13166ecd9674SAndy Whitcroft 13176ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13186ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1319000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1320000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13216ecd9674SAndy Whitcroft } 13226ecd9674SAndy Whitcroft} 13236ecd9674SAndy Whitcroft 1324d1fe9c09SJoe Perchessub pos_last_openparen { 1325d1fe9c09SJoe Perches my ($line) = @_; 1326d1fe9c09SJoe Perches 1327d1fe9c09SJoe Perches my $pos = 0; 1328d1fe9c09SJoe Perches 1329d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1330d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1331d1fe9c09SJoe Perches 1332d1fe9c09SJoe Perches my $last_openparen = 0; 1333d1fe9c09SJoe Perches 1334d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1335d1fe9c09SJoe Perches return -1; 1336d1fe9c09SJoe Perches } 1337d1fe9c09SJoe Perches 1338d1fe9c09SJoe Perches my $len = length($line); 1339d1fe9c09SJoe Perches 1340d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1341d1fe9c09SJoe Perches my $string = substr($line, $pos); 1342d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1343d1fe9c09SJoe Perches $pos += length($1) - 1; 1344d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1345d1fe9c09SJoe Perches $last_openparen = $pos; 1346d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1347d1fe9c09SJoe Perches last; 1348d1fe9c09SJoe Perches } 1349d1fe9c09SJoe Perches } 1350d1fe9c09SJoe Perches 1351d1fe9c09SJoe Perches return $last_openparen + 1; 1352d1fe9c09SJoe Perches} 1353d1fe9c09SJoe Perches 13540a920b5bSAndy Whitcroftsub process { 13550a920b5bSAndy Whitcroft my $filename = shift; 13560a920b5bSAndy Whitcroft 13570a920b5bSAndy Whitcroft my $linenr=0; 13580a920b5bSAndy Whitcroft my $prevline=""; 1359c2fdda0dSAndy Whitcroft my $prevrawline=""; 13600a920b5bSAndy Whitcroft my $stashline=""; 1361c2fdda0dSAndy Whitcroft my $stashrawline=""; 13620a920b5bSAndy Whitcroft 13634a0df2efSAndy Whitcroft my $length; 13640a920b5bSAndy Whitcroft my $indent; 13650a920b5bSAndy Whitcroft my $previndent=0; 13660a920b5bSAndy Whitcroft my $stashindent=0; 13670a920b5bSAndy Whitcroft 1368de7d4f0eSAndy Whitcroft our $clean = 1; 13690a920b5bSAndy Whitcroft my $signoff = 0; 13700a920b5bSAndy Whitcroft my $is_patch = 0; 13710a920b5bSAndy Whitcroft 137215662b3eSJoe Perches my $in_header_lines = 1; 137315662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 137415662b3eSJoe Perches 1375fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1376fa64205dSPasi Savanainen 137713214adfSAndy Whitcroft our @report = (); 13786c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13796c72ffaaSAndy Whitcroft our $cnt_error = 0; 13806c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13816c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13826c72ffaaSAndy Whitcroft 13830a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13840a920b5bSAndy Whitcroft my $realfile = ''; 13850a920b5bSAndy Whitcroft my $realline = 0; 13860a920b5bSAndy Whitcroft my $realcnt = 0; 13870a920b5bSAndy Whitcroft my $here = ''; 13880a920b5bSAndy Whitcroft my $in_comment = 0; 1389c2fdda0dSAndy Whitcroft my $comment_edge = 0; 13900a920b5bSAndy Whitcroft my $first_line = 0; 13911e855726SWolfram Sang my $p1_prefix = ''; 13920a920b5bSAndy Whitcroft 139313214adfSAndy Whitcroft my $prev_values = 'E'; 139413214adfSAndy Whitcroft 139513214adfSAndy Whitcroft # suppression flags 1396773647a0SAndy Whitcroft my %suppress_ifbraces; 1397170d3a22SAndy Whitcroft my %suppress_whiletrailers; 13982b474a1aSAndy Whitcroft my %suppress_export; 13993e469cdcSAndy Whitcroft my $suppress_statement = 0; 1400653d4876SAndy Whitcroft 1401c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1402de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1403c2fdda0dSAndy Whitcroft # 1404de7d4f0eSAndy Whitcroft my @setup_docs = (); 1405de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1406773647a0SAndy Whitcroft 1407773647a0SAndy Whitcroft sanitise_line_reset(); 1408c2fdda0dSAndy Whitcroft my $line; 1409c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1410773647a0SAndy Whitcroft $linenr++; 1411773647a0SAndy Whitcroft $line = $rawline; 1412c2fdda0dSAndy Whitcroft 1413773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1414de7d4f0eSAndy Whitcroft $setup_docs = 0; 1415de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1416de7d4f0eSAndy Whitcroft $setup_docs = 1; 1417de7d4f0eSAndy Whitcroft } 1418773647a0SAndy Whitcroft #next; 1419de7d4f0eSAndy Whitcroft } 1420773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1421773647a0SAndy Whitcroft $realline=$1-1; 1422773647a0SAndy Whitcroft if (defined $2) { 1423773647a0SAndy Whitcroft $realcnt=$3+1; 1424773647a0SAndy Whitcroft } else { 1425773647a0SAndy Whitcroft $realcnt=1+1; 1426773647a0SAndy Whitcroft } 1427c45dcabdSAndy Whitcroft $in_comment = 0; 1428773647a0SAndy Whitcroft 1429773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1430773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1431773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1432773647a0SAndy Whitcroft # at context start. 1433773647a0SAndy Whitcroft my $edge; 143401fa9147SAndy Whitcroft my $cnt = $realcnt; 143501fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 143601fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 143701fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 143801fa9147SAndy Whitcroft $cnt--; 143901fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1440721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1441fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1442fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1443fae17daeSAndy Whitcroft ($edge) = $1; 1444fae17daeSAndy Whitcroft last; 1445fae17daeSAndy Whitcroft } 1446773647a0SAndy Whitcroft } 1447773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1448773647a0SAndy Whitcroft $in_comment = 1; 1449773647a0SAndy Whitcroft } 1450773647a0SAndy Whitcroft 1451773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1452773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1453773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1454773647a0SAndy Whitcroft if (!defined $edge && 145583242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1456773647a0SAndy Whitcroft { 1457773647a0SAndy Whitcroft $in_comment = 1; 1458773647a0SAndy Whitcroft } 1459773647a0SAndy Whitcroft 1460773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1461773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1462773647a0SAndy Whitcroft 1463171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1464773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1465171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1466773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1467773647a0SAndy Whitcroft } 1468773647a0SAndy Whitcroft push(@lines, $line); 1469773647a0SAndy Whitcroft 1470773647a0SAndy Whitcroft if ($realcnt > 1) { 1471773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1472773647a0SAndy Whitcroft } else { 1473773647a0SAndy Whitcroft $realcnt = 0; 1474773647a0SAndy Whitcroft } 1475773647a0SAndy Whitcroft 1476773647a0SAndy Whitcroft #print "==>$rawline\n"; 1477773647a0SAndy Whitcroft #print "-->$line\n"; 1478de7d4f0eSAndy Whitcroft 1479de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1480de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1481de7d4f0eSAndy Whitcroft } 1482de7d4f0eSAndy Whitcroft } 1483de7d4f0eSAndy Whitcroft 14846c72ffaaSAndy Whitcroft $prefix = ''; 14856c72ffaaSAndy Whitcroft 1486773647a0SAndy Whitcroft $realcnt = 0; 1487773647a0SAndy Whitcroft $linenr = 0; 14880a920b5bSAndy Whitcroft foreach my $line (@lines) { 14890a920b5bSAndy Whitcroft $linenr++; 14900a920b5bSAndy Whitcroft 1491c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 14926c72ffaaSAndy Whitcroft 14930a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 14946c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14950a920b5bSAndy Whitcroft $is_patch = 1; 14964a0df2efSAndy Whitcroft $first_line = $linenr + 1; 14970a920b5bSAndy Whitcroft $realline=$1-1; 14980a920b5bSAndy Whitcroft if (defined $2) { 14990a920b5bSAndy Whitcroft $realcnt=$3+1; 15000a920b5bSAndy Whitcroft } else { 15010a920b5bSAndy Whitcroft $realcnt=1+1; 15020a920b5bSAndy Whitcroft } 1503c2fdda0dSAndy Whitcroft annotate_reset(); 150413214adfSAndy Whitcroft $prev_values = 'E'; 150513214adfSAndy Whitcroft 1506773647a0SAndy Whitcroft %suppress_ifbraces = (); 1507170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 15082b474a1aSAndy Whitcroft %suppress_export = (); 15093e469cdcSAndy Whitcroft $suppress_statement = 0; 15100a920b5bSAndy Whitcroft next; 15110a920b5bSAndy Whitcroft 15124a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 15134a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 15144a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1515773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 15160a920b5bSAndy Whitcroft $realline++; 1517d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 15180a920b5bSAndy Whitcroft 15194a0df2efSAndy Whitcroft # Measure the line length and indent. 1520c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 15210a920b5bSAndy Whitcroft 15220a920b5bSAndy Whitcroft # Track the previous line. 15230a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 15240a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1525c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1526c2fdda0dSAndy Whitcroft 1527773647a0SAndy Whitcroft #warn "line<$line>\n"; 15286c72ffaaSAndy Whitcroft 1529d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1530d8aaf121SAndy Whitcroft $realcnt--; 15310a920b5bSAndy Whitcroft } 15320a920b5bSAndy Whitcroft 1533cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1534cc77cdcaSAndy Whitcroft 15350a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1536773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1537773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1538773647a0SAndy Whitcroft 15396c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15406c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1541773647a0SAndy Whitcroft 1542773647a0SAndy Whitcroft # extract the filename as it passes 15433bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15443bf9a009SRabin Vincent $realfile = $1; 15453bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1546270c49a0SJoe Perches $in_commit_log = 0; 15473bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1548773647a0SAndy Whitcroft $realfile = $1; 15491e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1550270c49a0SJoe Perches $in_commit_log = 0; 15511e855726SWolfram Sang 15521e855726SWolfram Sang $p1_prefix = $1; 1553e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1554e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1555000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1556000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15571e855726SWolfram Sang } 1558773647a0SAndy Whitcroft 1559c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1560000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1561000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1562773647a0SAndy Whitcroft } 1563773647a0SAndy Whitcroft next; 1564773647a0SAndy Whitcroft } 1565773647a0SAndy Whitcroft 1566389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15670a920b5bSAndy Whitcroft 1568c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1569c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1570c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15710a920b5bSAndy Whitcroft 15726c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15736c72ffaaSAndy Whitcroft 15743bf9a009SRabin Vincent# Check for incorrect file permissions 15753bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15763bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 15773bf9a009SRabin Vincent if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1578000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1579000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15803bf9a009SRabin Vincent } 15813bf9a009SRabin Vincent } 15823bf9a009SRabin Vincent 158320112475SJoe Perches# Check the patch for a signoff: 1584d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15854a0df2efSAndy Whitcroft $signoff++; 158615662b3eSJoe Perches $in_commit_log = 0; 15870a920b5bSAndy Whitcroft } 158820112475SJoe Perches 158920112475SJoe Perches# Check signature styles 1590270c49a0SJoe Perches if (!$in_header_lines && 1591ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 159220112475SJoe Perches my $space_before = $1; 159320112475SJoe Perches my $sign_off = $2; 159420112475SJoe Perches my $space_after = $3; 159520112475SJoe Perches my $email = $4; 159620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 159720112475SJoe Perches 1598ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1599ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1600ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1601ce0338dfSJoe Perches } 160220112475SJoe Perches if (defined $space_before && $space_before ne "") { 1603000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1604000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 160520112475SJoe Perches } 160620112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1607000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1608000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 160920112475SJoe Perches } 161020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1611000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1612000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 161320112475SJoe Perches } 161420112475SJoe Perches 161520112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 161620112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 161720112475SJoe Perches if ($suggested_email eq "") { 1618000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1619000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 162020112475SJoe Perches } else { 162120112475SJoe Perches my $dequoted = $suggested_email; 162220112475SJoe Perches $dequoted =~ s/^"//; 162320112475SJoe Perches $dequoted =~ s/" </ </; 162420112475SJoe Perches # Don't force email to have quotes 162520112475SJoe Perches # Allow just an angle bracketed address 162620112475SJoe Perches if ("$dequoted$comment" ne $email && 162720112475SJoe Perches "<$email_address>$comment" ne $email && 162820112475SJoe Perches "$suggested_email$comment" ne $email) { 1629000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1630000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 163120112475SJoe Perches } 16320a920b5bSAndy Whitcroft } 16330a920b5bSAndy Whitcroft } 16340a920b5bSAndy Whitcroft 163500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 16368905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1637000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1638000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 16396c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1640de7d4f0eSAndy Whitcroft } 1641de7d4f0eSAndy Whitcroft 16426ecd9674SAndy Whitcroft# Check for absolute kernel paths. 16436ecd9674SAndy Whitcroft if ($tree) { 16446ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 16456ecd9674SAndy Whitcroft my $file = $1; 16466ecd9674SAndy Whitcroft 16476ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16486ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16496ecd9674SAndy Whitcroft # 16506ecd9674SAndy Whitcroft } else { 16516ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16526ecd9674SAndy Whitcroft } 16536ecd9674SAndy Whitcroft } 16546ecd9674SAndy Whitcroft } 16556ecd9674SAndy Whitcroft 1656de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1657de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1658171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1659171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1660171ae1a4SAndy Whitcroft 1661171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1662171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1663171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1664171ae1a4SAndy Whitcroft 166534d99219SJoe Perches CHK("INVALID_UTF8", 1666000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 166700df344fSAndy Whitcroft } 16680a920b5bSAndy Whitcroft 166915662b3eSJoe Perches# Check if it's the start of a commit log 167015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 167115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1672270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 167315662b3eSJoe Perches $in_header_lines = 0; 167415662b3eSJoe Perches $in_commit_log = 1; 167515662b3eSJoe Perches } 167615662b3eSJoe Perches 1677fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1678fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1679fa64205dSPasi Savanainen if ($in_header_lines && 1680fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1681fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1682fa64205dSPasi Savanainen $non_utf8_charset = 1; 1683fa64205dSPasi Savanainen } 1684fa64205dSPasi Savanainen 1685fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 168615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1687fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 168815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 168915662b3eSJoe Perches } 169015662b3eSJoe Perches 169130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 169230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 169300df344fSAndy Whitcroft 16940a920b5bSAndy Whitcroft#trailing whitespace 16959c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1696c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1697000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1698000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 16999c0ca6f9SAndy Whitcroft 1700c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1701c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1702000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1703000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1704d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17050a920b5bSAndy Whitcroft } 17065368df20SAndy Whitcroft 17073354957aSAndi Kleen# check for Kconfig help text having a real description 17089fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 17099fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 17103354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1711a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 17123354957aSAndi Kleen my $length = 0; 17139fe287d7SAndy Whitcroft my $cnt = $realcnt; 17149fe287d7SAndy Whitcroft my $ln = $linenr + 1; 17159fe287d7SAndy Whitcroft my $f; 1716a1385803SAndy Whitcroft my $is_start = 0; 17179fe287d7SAndy Whitcroft my $is_end = 0; 1718a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 17199fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 17209fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 17219fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 17229fe287d7SAndy Whitcroft 17239fe287d7SAndy Whitcroft next if ($f =~ /^-/); 1724a1385803SAndy Whitcroft 1725a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1726a1385803SAndy Whitcroft $is_start = 1; 1727a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1728a1385803SAndy Whitcroft $length = -1; 1729a1385803SAndy Whitcroft } 1730a1385803SAndy Whitcroft 17319fe287d7SAndy Whitcroft $f =~ s/^.//; 17323354957aSAndi Kleen $f =~ s/#.*//; 17333354957aSAndi Kleen $f =~ s/^\s+//; 17343354957aSAndi Kleen next if ($f =~ /^$/); 17359fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 17369fe287d7SAndy Whitcroft $is_end = 1; 17379fe287d7SAndy Whitcroft last; 17389fe287d7SAndy Whitcroft } 17393354957aSAndi Kleen $length++; 17403354957aSAndi Kleen } 1741000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1742a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 1743a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 17443354957aSAndi Kleen } 17453354957aSAndi Kleen 17461ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 17471ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 17481ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 17491ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 17501ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 17511ba8dfd1SKees Cook } 17521ba8dfd1SKees Cook 1753c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1754c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1755c68e5878SArnaud Lacombe my $flag = $1; 1756c68e5878SArnaud Lacombe my $replacement = { 1757c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1758c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1759c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1760c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1761c68e5878SArnaud Lacombe }; 1762c68e5878SArnaud Lacombe 1763c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1764c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1765c68e5878SArnaud Lacombe } 1766c68e5878SArnaud Lacombe 17675368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 17685368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 17695368df20SAndy Whitcroft 17706cd7f386SJoe Perches#line length limit 1771c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1772f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 17730fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 17748bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 17756cd7f386SJoe Perches $length > $max_line_length) 1776c45dcabdSAndy Whitcroft { 1777000d1cc1SJoe Perches WARN("LONG_LINE", 17786cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 17790a920b5bSAndy Whitcroft } 17800a920b5bSAndy Whitcroft 1781ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 1782ca56dc09SJosh Triplett# to grep for the string. Limited to strings used as parameters (those 1783ca56dc09SJosh Triplett# following an open parenthesis), which almost completely eliminates false 1784ca56dc09SJosh Triplett# positives, as well as warning only once per parameter rather than once per 1785ca56dc09SJosh Triplett# line of the string. Make an exception when the previous string ends in a 1786ca56dc09SJosh Triplett# newline (multiple lines in one string constant) or \n\t (common in inline 1787ca56dc09SJosh Triplett# assembly to indent the instruction on the following line). 1788ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 1789ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 1790ca56dc09SJosh Triplett $prevline =~ /\(/ && 1791ca56dc09SJosh Triplett $prevrawline !~ /\\n(?:\\t)*"\s*$/) { 1792ca56dc09SJosh Triplett WARN("SPLIT_STRING", 1793ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 1794ca56dc09SJosh Triplett } 1795ca56dc09SJosh Triplett 17965e79d96eSJoe Perches# check for spaces before a quoted newline 17975e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1798000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1799000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 18005e79d96eSJoe Perches } 18015e79d96eSJoe Perches 18028905a67cSAndy Whitcroft# check for adding lines without a newline. 18038905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1804000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1805000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 18068905a67cSAndy Whitcroft } 18078905a67cSAndy Whitcroft 180842e41c54SMike Frysinger# Blackfin: use hi/lo macros 180942e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 181042e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 181142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1812000d1cc1SJoe Perches ERROR("LO_MACRO", 1813000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 181442e41c54SMike Frysinger } 181542e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 181642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1817000d1cc1SJoe Perches ERROR("HI_MACRO", 1818000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 181942e41c54SMike Frysinger } 182042e41c54SMike Frysinger } 182142e41c54SMike Frysinger 1822b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1823b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 18240a920b5bSAndy Whitcroft 18250a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 18260a920b5bSAndy Whitcroft# more than 8 must use tabs. 1827c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1828c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1829c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1830000d1cc1SJoe Perches ERROR("CODE_INDENT", 1831000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1832d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 18330a920b5bSAndy Whitcroft } 18340a920b5bSAndy Whitcroft 183508e44365SAlberto Panizzo# check for space before tabs. 183608e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 183708e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1838000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1839000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 184008e44365SAlberto Panizzo } 184108e44365SAlberto Panizzo 1842d1fe9c09SJoe Perches# check for && or || at the start of a line 1843d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 1844d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 1845d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 1846d1fe9c09SJoe Perches } 1847d1fe9c09SJoe Perches 1848d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 1849d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 1850d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 1851d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 1852d1fe9c09SJoe Perches my $oldindent = $1; 1853d1fe9c09SJoe Perches my $rest = $2; 1854d1fe9c09SJoe Perches 1855d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 1856d1fe9c09SJoe Perches if ($pos >= 0) { 1857b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 1858b34a26f3SJoe Perches my $newindent = $2; 1859d1fe9c09SJoe Perches 1860d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 1861d1fe9c09SJoe Perches "\t" x ($pos / 8) . 1862d1fe9c09SJoe Perches " " x ($pos % 8); 1863d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 1864d1fe9c09SJoe Perches 1865d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 1866d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 1867d1fe9c09SJoe Perches CHK("PARENTHESIS_ALIGNMENT", 1868d1fe9c09SJoe Perches "Alignment should match open parenthesis\n" . $hereprev); 1869d1fe9c09SJoe Perches } 1870d1fe9c09SJoe Perches } 1871d1fe9c09SJoe Perches } 1872d1fe9c09SJoe Perches 1873aad4f614SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) { 1874aad4f614SJoe Perches CHK("SPACING", 1875aad4f614SJoe Perches "No space is necessary after a cast\n" . $hereprev); 1876aad4f614SJoe Perches } 1877aad4f614SJoe Perches 187805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 187905880600SJoe Perches $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 188005880600SJoe Perches $prevrawline =~ /^\+[ \t]*$/) { 188105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 188205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 188305880600SJoe Perches } 188405880600SJoe Perches 188505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 1886c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 1887c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 1888c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 1889c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 189005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 189105880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 189205880600SJoe Perches } 189305880600SJoe Perches 18945f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 18956b4c5bebSAndy Whitcroft# Exceptions: 18966b4c5bebSAndy Whitcroft# 1) within comments 18976b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 18986b4c5bebSAndy Whitcroft# 3) hanging labels 18996b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 19005f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1901000d1cc1SJoe Perches WARN("LEADING_SPACE", 1902000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 19035f7ddae6SRaffaele Recalcati } 19045f7ddae6SRaffaele Recalcati 1905b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1906b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1907b9ea10d6SAndy Whitcroft 19081ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 19091ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 19101ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 19111ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 19121ba8dfd1SKees Cook } 19131ba8dfd1SKees Cook 1914c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1915cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1916000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1917000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1918c2fdda0dSAndy Whitcroft } 191922f2a2efSAndy Whitcroft 192042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 192142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 192242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1923000d1cc1SJoe Perches ERROR("CSYNC", 1924000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 192542e41c54SMike Frysinger } 192642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 192742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1928000d1cc1SJoe Perches ERROR("SSYNC", 1929000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 193042e41c54SMike Frysinger } 193142e41c54SMike Frysinger 19329c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 19332b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 19342b474a1aSAndy Whitcroft $realline_next); 19353e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 19363e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 19373e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 1938170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1939f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1940171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1941171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1942171ae1a4SAndy Whitcroft 19433e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 19443e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 19453e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 19463e469cdcSAndy Whitcroft # until we hit end of it. 19473e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 19483e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 19493e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 19503e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 19513e469cdcSAndy Whitcroft } 1952f74bd194SAndy Whitcroft 19532b474a1aSAndy Whitcroft # Find the real next line. 19542b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 19552b474a1aSAndy Whitcroft if (defined $realline_next && 19562b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 19572b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 19582b474a1aSAndy Whitcroft $realline_next++; 19592b474a1aSAndy Whitcroft } 19602b474a1aSAndy Whitcroft 1961171ae1a4SAndy Whitcroft my $s = $stat; 1962171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1963cf655043SAndy Whitcroft 1964c2fdda0dSAndy Whitcroft # Ignore goto labels. 1965171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1966c2fdda0dSAndy Whitcroft 1967c2fdda0dSAndy Whitcroft # Ignore functions being called 1968171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1969c2fdda0dSAndy Whitcroft 1970463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1971463f2864SAndy Whitcroft 1972c45dcabdSAndy Whitcroft # declarations always start with types 1973d2506586SAndy 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) { 1974c45dcabdSAndy Whitcroft my $type = $1; 1975c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1976c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1977c45dcabdSAndy Whitcroft 19786c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1979a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1980c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1981c2fdda0dSAndy Whitcroft } 19828905a67cSAndy Whitcroft 19836c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 198465863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1985c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 19869c0ca6f9SAndy Whitcroft } 19878905a67cSAndy Whitcroft 19888905a67cSAndy Whitcroft # Check for any sort of function declaration. 19898905a67cSAndy Whitcroft # int foo(something bar, other baz); 19908905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1991171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 19928905a67cSAndy Whitcroft my ($name_len) = length($1); 19938905a67cSAndy Whitcroft 1994cf655043SAndy Whitcroft my $ctx = $s; 1995773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 19968905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1997cf655043SAndy Whitcroft 19988905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1999c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 20008905a67cSAndy Whitcroft 2001c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 20028905a67cSAndy Whitcroft } 20038905a67cSAndy Whitcroft } 20048905a67cSAndy Whitcroft } 20058905a67cSAndy Whitcroft 20069c0ca6f9SAndy Whitcroft } 20079c0ca6f9SAndy Whitcroft 200800df344fSAndy Whitcroft# 200900df344fSAndy Whitcroft# Checks which may be anchored in the context. 201000df344fSAndy Whitcroft# 201100df344fSAndy Whitcroft 201200df344fSAndy Whitcroft# Check for switch () and associated case and default 201300df344fSAndy Whitcroft# statements should be at the same indent. 201400df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 201500df344fSAndy Whitcroft my $err = ''; 201600df344fSAndy Whitcroft my $sep = ''; 201700df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 201800df344fSAndy Whitcroft shift(@ctx); 201900df344fSAndy Whitcroft for my $ctx (@ctx) { 202000df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 202100df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 202200df344fSAndy Whitcroft $indent != $cindent) { 202300df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 202400df344fSAndy Whitcroft $sep = ''; 202500df344fSAndy Whitcroft } else { 202600df344fSAndy Whitcroft $sep = "[...]\n"; 202700df344fSAndy Whitcroft } 202800df344fSAndy Whitcroft } 202900df344fSAndy Whitcroft if ($err ne '') { 2030000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2031000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2032de7d4f0eSAndy Whitcroft } 2033de7d4f0eSAndy Whitcroft } 2034de7d4f0eSAndy Whitcroft 2035de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2036de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2037c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2038773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2039773647a0SAndy Whitcroft 20409c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 20418eef05ddSJoe Perches 20428eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 20438eef05ddSJoe Perches WARN("DEEP_INDENTATION", 20448eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 20458eef05ddSJoe Perches } 20468eef05ddSJoe Perches 2047de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2048de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2049de7d4f0eSAndy Whitcroft 2050548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2051548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2052de7d4f0eSAndy Whitcroft 2053548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2054548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2055548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2056548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2057548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2058773647a0SAndy Whitcroft $ctx_ln++; 2059773647a0SAndy Whitcroft } 2060548596d5SAndy Whitcroft 206153210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 206253210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2063773647a0SAndy Whitcroft 2064773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2065000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2066000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 206701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 206800df344fSAndy Whitcroft } 2069773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2070773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2071773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2072773647a0SAndy Whitcroft { 20739c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 20749c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2075000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2076000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 207701464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 20789c0ca6f9SAndy Whitcroft } 20799c0ca6f9SAndy Whitcroft } 208000df344fSAndy Whitcroft } 208100df344fSAndy Whitcroft 20824d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 20834d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 20843e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 20853e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 20863e469cdcSAndy Whitcroft if (!defined $stat); 20874d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 20884d001e4dSAndy Whitcroft 20894d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 20904d001e4dSAndy Whitcroft 20914d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 20924d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 20934d001e4dSAndy Whitcroft # where necessary. 20944d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 20954d001e4dSAndy Whitcroft 20964d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 20976f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 20986f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 20994d001e4dSAndy Whitcroft 21004d001e4dSAndy Whitcroft # We want to check the first line inside the block 21014d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 21024d001e4dSAndy Whitcroft # 1) any blank line termination 21034d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 21044d001e4dSAndy Whitcroft # 3) any do (...) { 21054d001e4dSAndy Whitcroft my $continuation = 0; 21064d001e4dSAndy Whitcroft my $check = 0; 21074d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 21084d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 21094d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 21104d001e4dSAndy Whitcroft $continuation = 1; 21114d001e4dSAndy Whitcroft } 21129bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 21134d001e4dSAndy Whitcroft $check = 1; 21144d001e4dSAndy Whitcroft $cond_lines++; 21154d001e4dSAndy Whitcroft } 21164d001e4dSAndy Whitcroft 21174d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 21184d001e4dSAndy Whitcroft # preprocessor statement. 21194d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 21204d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 21214d001e4dSAndy Whitcroft $check = 0; 21224d001e4dSAndy Whitcroft } 21234d001e4dSAndy Whitcroft 21249bd49efeSAndy Whitcroft my $cond_ptr = -1; 2125740504c6SAndy Whitcroft $continuation = 0; 21269bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 21279bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 21284d001e4dSAndy Whitcroft 2129f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2130f16fa28fSAndy Whitcroft # is not linear. 2131f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2132f16fa28fSAndy Whitcroft $check = 0; 2133f16fa28fSAndy Whitcroft } 2134f16fa28fSAndy Whitcroft 21359bd49efeSAndy Whitcroft # Ignore: 21369bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 21379bd49efeSAndy Whitcroft # 2) preprocessor lines, and 21389bd49efeSAndy Whitcroft # 3) labels. 2139740504c6SAndy Whitcroft if ($continuation || 2140740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 21419bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 21429bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2143740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 214430dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 21459bd49efeSAndy Whitcroft $cond_lines++; 21469bd49efeSAndy Whitcroft } 21474d001e4dSAndy Whitcroft } 214830dad6ebSAndy Whitcroft } 21494d001e4dSAndy Whitcroft 21504d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 21514d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 21524d001e4dSAndy Whitcroft 21534d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 21544d001e4dSAndy Whitcroft # this is not this patch's fault. 21554d001e4dSAndy Whitcroft if (!defined($stat_real) || 21564d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 21574d001e4dSAndy Whitcroft $check = 0; 21584d001e4dSAndy Whitcroft } 21594d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 21604d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 21614d001e4dSAndy Whitcroft } 21624d001e4dSAndy Whitcroft 21639bd49efeSAndy 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"; 21644d001e4dSAndy Whitcroft 21654d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 21664d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2167000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2168000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 21694d001e4dSAndy Whitcroft } 21704d001e4dSAndy Whitcroft } 21714d001e4dSAndy Whitcroft 21726c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 21736c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 21741f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 21751f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 21766c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2177c2fdda0dSAndy Whitcroft if ($dbg_values) { 2178c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2179cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2180cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 21811f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2182c2fdda0dSAndy Whitcroft } 21836c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 21846c72ffaaSAndy Whitcroft 218500df344fSAndy Whitcroft#ignore lines not being added 218600df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 218700df344fSAndy Whitcroft 2188653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 21897429c690SAndy Whitcroft if ($dbg_type) { 21907429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2191000d1cc1SJoe Perches ERROR("TEST_TYPE", 2192000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 21937429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2194000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2195000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 21967429c690SAndy Whitcroft } 2197653d4876SAndy Whitcroft next; 2198653d4876SAndy Whitcroft } 2199a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2200a1ef277eSAndy Whitcroft if ($dbg_attr) { 22019360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2202000d1cc1SJoe Perches ERROR("TEST_ATTR", 2203000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 22049360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2205000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2206000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2207a1ef277eSAndy Whitcroft } 2208a1ef277eSAndy Whitcroft next; 2209a1ef277eSAndy Whitcroft } 2210653d4876SAndy Whitcroft 2211f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 221299423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 221399423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2214000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2215000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2216f0a594c1SAndy Whitcroft } 2217f0a594c1SAndy Whitcroft 221800df344fSAndy Whitcroft# 221900df344fSAndy Whitcroft# Checks which are anchored on the added line. 222000df344fSAndy Whitcroft# 222100df344fSAndy Whitcroft 2222653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2223c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2224653d4876SAndy Whitcroft my $path = $1; 2225653d4876SAndy Whitcroft if ($path =~ m{//}) { 2226000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2227000d1cc1SJoe Perches "malformed #include filename\n" . 2228de7d4f0eSAndy Whitcroft $herecurr); 2229653d4876SAndy Whitcroft } 2230653d4876SAndy Whitcroft } 2231653d4876SAndy Whitcroft 223200df344fSAndy Whitcroft# no C99 // comments 223300df344fSAndy Whitcroft if ($line =~ m{//}) { 2234000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2235000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 223600df344fSAndy Whitcroft } 223700df344fSAndy Whitcroft # Remove C99 comments. 22380a920b5bSAndy Whitcroft $line =~ s@//.*@@; 22396c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 22400a920b5bSAndy Whitcroft 22412b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 22422b474a1aSAndy Whitcroft# the whole statement. 22432b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 22442b474a1aSAndy Whitcroft if (defined $realline_next && 22452b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 22462b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 22472b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22482b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22493cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 22503cbf62dfSAndy Whitcroft # a prefix: 22513cbf62dfSAndy Whitcroft # XXX(foo); 22523cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2253653d4876SAndy Whitcroft my $name = $1; 225487a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 22553cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 22563cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 22573cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 22583cbf62dfSAndy Whitcroft 22593cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 22602b474a1aSAndy Whitcroft \n.}\s*$| 226148012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 226248012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 226348012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 22642b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 22652b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 226648012058SAndy Whitcroft )/x) { 22672b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 22682b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 22692b474a1aSAndy Whitcroft } else { 22702b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 22710a920b5bSAndy Whitcroft } 22720a920b5bSAndy Whitcroft } 22732b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 22742b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 22752b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22762b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22772b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 22782b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 22792b474a1aSAndy Whitcroft } 22802b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 22812b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2282000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2283000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 22842b474a1aSAndy Whitcroft } 22850a920b5bSAndy Whitcroft 22865150bda4SJoe Eloff# check for global initialisers. 2287c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2288000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2289000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2290f0a594c1SAndy Whitcroft $herecurr); 2291f0a594c1SAndy Whitcroft } 22920a920b5bSAndy Whitcroft# check for static initialisers. 22932d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2294000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2295000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2296de7d4f0eSAndy Whitcroft $herecurr); 22970a920b5bSAndy Whitcroft } 22980a920b5bSAndy Whitcroft 2299cb710ecaSJoe Perches# check for static const char * arrays. 2300cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2301000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2302000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2303cb710ecaSJoe Perches $herecurr); 2304cb710ecaSJoe Perches } 2305cb710ecaSJoe Perches 2306cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2307cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2308000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2309000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2310cb710ecaSJoe Perches $herecurr); 2311cb710ecaSJoe Perches } 2312cb710ecaSJoe Perches 231393ed0e2dSJoe Perches# check for declarations of struct pci_device_id 231493ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2315000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2316000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 231793ed0e2dSJoe Perches } 231893ed0e2dSJoe Perches 2319653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2320653d4876SAndy Whitcroft# make sense. 2321653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 23228054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2323c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 23248ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2325653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2326000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2327000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 23280a920b5bSAndy Whitcroft } 23290a920b5bSAndy Whitcroft 23300a920b5bSAndy Whitcroft# * goes on variable not on type 233165863862SAndy Whitcroft # (char*[ const]) 2332bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2333bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 2334bfcb2cc7SAndy Whitcroft my ($from, $to) = ($2, $2); 2335d8aaf121SAndy Whitcroft 233665863862SAndy Whitcroft # Should start with a space. 233765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 233865863862SAndy Whitcroft # Should not end with a space. 233965863862SAndy Whitcroft $to =~ s/\s+$//; 234065863862SAndy Whitcroft # '*'s should not have spaces between. 2341f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 234265863862SAndy Whitcroft } 2343d8aaf121SAndy Whitcroft 234465863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 234565863862SAndy Whitcroft if ($from ne $to) { 2346000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2347000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 234865863862SAndy Whitcroft } 2349bfcb2cc7SAndy Whitcroft } 2350bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2351bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 2352bfcb2cc7SAndy Whitcroft my ($from, $to, $ident) = ($2, $2, $3); 2353d8aaf121SAndy Whitcroft 235465863862SAndy Whitcroft # Should start with a space. 235565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 235665863862SAndy Whitcroft # Should not end with a space. 235765863862SAndy Whitcroft $to =~ s/\s+$//; 235865863862SAndy Whitcroft # '*'s should not have spaces between. 2359f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 236065863862SAndy Whitcroft } 236165863862SAndy Whitcroft # Modifiers should have spaces. 236265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 236365863862SAndy Whitcroft 2364667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2365667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2366000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2367000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 236865863862SAndy Whitcroft } 23690a920b5bSAndy Whitcroft } 23700a920b5bSAndy Whitcroft 23710a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 23720a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 23730a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 23740a920b5bSAndy Whitcroft# print "$herecurr"; 23750a920b5bSAndy Whitcroft# $clean = 0; 23760a920b5bSAndy Whitcroft# } 23770a920b5bSAndy Whitcroft 23788905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2379000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2380000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 23818905a67cSAndy Whitcroft } 23828905a67cSAndy Whitcroft 238317441227SJoe Perches# check for uses of printk_ratelimit 238417441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2385000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2386000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 238717441227SJoe Perches } 238817441227SJoe Perches 238900df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 239000df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 239100df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 239225985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 239300df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2394f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 239500df344fSAndy Whitcroft my $ok = 0; 239600df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 239700df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 239825985edcSLucas De Marchi # we have a preceding printk if it ends 239900df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 240000df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 240100df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 240200df344fSAndy Whitcroft $ok = 1; 240300df344fSAndy Whitcroft } 240400df344fSAndy Whitcroft last; 240500df344fSAndy Whitcroft } 240600df344fSAndy Whitcroft } 240700df344fSAndy Whitcroft if ($ok == 0) { 2408000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2409000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 24100a920b5bSAndy Whitcroft } 241100df344fSAndy Whitcroft } 24120a920b5bSAndy Whitcroft 2413243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2414243f3803SJoe Perches my $orig = $1; 2415243f3803SJoe Perches my $level = lc($orig); 2416243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 24178f26b837SJoe Perches my $level2 = $level; 24188f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2419243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 24208f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2421243f3803SJoe Perches } 2422243f3803SJoe Perches 2423243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2424243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2425243f3803SJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); 2426243f3803SJoe Perches } 2427243f3803SJoe Perches 2428653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2429653d4876SAndy Whitcroft# or if closed on same line 2430c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2431c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2432000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2433000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 24340a920b5bSAndy Whitcroft } 2435653d4876SAndy Whitcroft 24368905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 24378905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 24388905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2439000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2440000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 24418905a67cSAndy Whitcroft } 24428905a67cSAndy Whitcroft 24430c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 24440c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2445000d1cc1SJoe Perches WARN("SPACING", 2446000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 24470c73b4ebSAndy Whitcroft } 24480c73b4ebSAndy Whitcroft 24498d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 24508d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2451fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2452fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 24538d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 24548d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 24558d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2456fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2457daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 2458000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2459000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 24608d31cfceSAndy Whitcroft } 24618d31cfceSAndy Whitcroft } 24628d31cfceSAndy Whitcroft 2463f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 24646c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2465c2fdda0dSAndy Whitcroft my $name = $1; 2466773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2467773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2468c2fdda0dSAndy Whitcroft 2469c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2470773647a0SAndy Whitcroft if ($name =~ /^(?: 2471773647a0SAndy Whitcroft if|for|while|switch|return|case| 2472773647a0SAndy Whitcroft volatile|__volatile__| 2473773647a0SAndy Whitcroft __attribute__|format|__extension__| 2474773647a0SAndy Whitcroft asm|__asm__)$/x) 2475773647a0SAndy Whitcroft { 2476c2fdda0dSAndy Whitcroft 2477c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2478c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2479c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2480c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2481773647a0SAndy Whitcroft 2482773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2483c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2484c2fdda0dSAndy Whitcroft 2485c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2486c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2487773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2488c2fdda0dSAndy Whitcroft 2489c2fdda0dSAndy Whitcroft } else { 2490000d1cc1SJoe Perches WARN("SPACING", 2491000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2492f0a594c1SAndy Whitcroft } 24936c72ffaaSAndy Whitcroft } 24949a4cad4eSEric Nelson 24959a4cad4eSEric Nelson# check for whitespace before a non-naked semicolon 24969a4cad4eSEric Nelson if ($line =~ /^\+.*\S\s+;/) { 24979a4cad4eSEric Nelson CHK("SPACING", 24989a4cad4eSEric Nelson "space prohibited before semicolon\n" . $herecurr); 24999a4cad4eSEric Nelson } 25009a4cad4eSEric Nelson 2501653d4876SAndy Whitcroft# Check operator spacing. 25020a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 25039c0ca6f9SAndy Whitcroft my $ops = qr{ 25049c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 25059c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 25069c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 25071f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 25081f65f947SAndy Whitcroft \?|: 25099c0ca6f9SAndy Whitcroft }x; 2510cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 251100df344fSAndy Whitcroft my $off = 0; 25126c72ffaaSAndy Whitcroft 25136c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 25146c72ffaaSAndy Whitcroft 25150a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 25164a0df2efSAndy Whitcroft $off += length($elements[$n]); 25174a0df2efSAndy Whitcroft 251825985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2519773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2520773647a0SAndy Whitcroft my $cc = ''; 2521773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2522773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2523773647a0SAndy Whitcroft } 2524773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2525773647a0SAndy Whitcroft 25264a0df2efSAndy Whitcroft my $a = ''; 25274a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 25284a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2529cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 25304a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 25314a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2532773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 25334a0df2efSAndy Whitcroft 25340a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 25354a0df2efSAndy Whitcroft 25364a0df2efSAndy Whitcroft my $c = ''; 25370a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 25384a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 25394a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2540cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 25414a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 25424a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 25438b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 25444a0df2efSAndy Whitcroft } else { 25454a0df2efSAndy Whitcroft $c = 'E'; 25460a920b5bSAndy Whitcroft } 25470a920b5bSAndy Whitcroft 25484a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 25494a0df2efSAndy Whitcroft 25504a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 25514a0df2efSAndy Whitcroft 25526c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2553de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 25540a920b5bSAndy Whitcroft 255574048ed8SAndy Whitcroft # Pull out the value of this operator. 25566c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 25570a920b5bSAndy Whitcroft 25581f65f947SAndy Whitcroft # Get the full operator variant. 25591f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 25601f65f947SAndy Whitcroft 256113214adfSAndy Whitcroft # Ignore operators passed as parameters. 256213214adfSAndy Whitcroft if ($op_type ne 'V' && 256313214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 256413214adfSAndy Whitcroft 2565cf655043SAndy Whitcroft# # Ignore comments 2566cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 256713214adfSAndy Whitcroft 2568d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 256913214adfSAndy Whitcroft } elsif ($op eq ';') { 2570cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2571cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2572000d1cc1SJoe Perches ERROR("SPACING", 2573000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2574d8aaf121SAndy Whitcroft } 2575d8aaf121SAndy Whitcroft 2576d8aaf121SAndy Whitcroft # // is a comment 2577d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 25780a920b5bSAndy Whitcroft 25791f65f947SAndy Whitcroft # No spaces for: 25801f65f947SAndy Whitcroft # -> 25811f65f947SAndy Whitcroft # : when part of a bitfield 25821f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 25834a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2584000d1cc1SJoe Perches ERROR("SPACING", 2585000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 25860a920b5bSAndy Whitcroft } 25870a920b5bSAndy Whitcroft 25880a920b5bSAndy Whitcroft # , must have a space on the right. 25890a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2590cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2591000d1cc1SJoe Perches ERROR("SPACING", 2592000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 25930a920b5bSAndy Whitcroft } 25940a920b5bSAndy Whitcroft 25959c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 259674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 25979c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 25989c0ca6f9SAndy Whitcroft 25999c0ca6f9SAndy Whitcroft # unary operators should have a space before and 26009c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 26019c0ca6f9SAndy Whitcroft # unary operator, or a cast 26029c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 260374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 26040d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2605cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2606000d1cc1SJoe Perches ERROR("SPACING", 2607000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 26080a920b5bSAndy Whitcroft } 2609a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2610171ae1a4SAndy Whitcroft # A unary '*' may be const 2611171ae1a4SAndy Whitcroft 2612171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2613000d1cc1SJoe Perches ERROR("SPACING", 2614000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 26150a920b5bSAndy Whitcroft } 26160a920b5bSAndy Whitcroft 26170a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 26180a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2619773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2620000d1cc1SJoe Perches ERROR("SPACING", 2621000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 26220a920b5bSAndy Whitcroft } 2623773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2624773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2625000d1cc1SJoe Perches ERROR("SPACING", 2626000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2627653d4876SAndy Whitcroft } 2628773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2629000d1cc1SJoe Perches ERROR("SPACING", 2630000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2631773647a0SAndy Whitcroft } 2632773647a0SAndy Whitcroft 26330a920b5bSAndy Whitcroft 26340a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 26359c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 26369c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 26379c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2638c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2639c2fdda0dSAndy Whitcroft $op eq '%') 26400a920b5bSAndy Whitcroft { 2641773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2642000d1cc1SJoe Perches ERROR("SPACING", 2643000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2644de7d4f0eSAndy Whitcroft $hereptr); 26450a920b5bSAndy Whitcroft } 26460a920b5bSAndy Whitcroft 26471f65f947SAndy Whitcroft # A colon needs no spaces before when it is 26481f65f947SAndy Whitcroft # terminating a case value or a label. 26491f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 26501f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2651000d1cc1SJoe Perches ERROR("SPACING", 2652000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 26531f65f947SAndy Whitcroft } 26541f65f947SAndy Whitcroft 26550a920b5bSAndy Whitcroft # All the others need spaces both sides. 2656cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 26571f65f947SAndy Whitcroft my $ok = 0; 26581f65f947SAndy Whitcroft 265922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 26601f65f947SAndy Whitcroft if (($op eq '<' && 26611f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 26621f65f947SAndy Whitcroft ($op eq '>' && 26631f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 26641f65f947SAndy Whitcroft { 26651f65f947SAndy Whitcroft $ok = 1; 26661f65f947SAndy Whitcroft } 26671f65f947SAndy Whitcroft 26681f65f947SAndy Whitcroft # Ignore ?: 26691f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 26701f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 26711f65f947SAndy Whitcroft $ok = 1; 26721f65f947SAndy Whitcroft } 26731f65f947SAndy Whitcroft 26741f65f947SAndy Whitcroft if ($ok == 0) { 2675000d1cc1SJoe Perches ERROR("SPACING", 2676000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 26770a920b5bSAndy Whitcroft } 267822f2a2efSAndy Whitcroft } 26794a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 26800a920b5bSAndy Whitcroft } 26810a920b5bSAndy Whitcroft } 26820a920b5bSAndy Whitcroft 2683f0a594c1SAndy Whitcroft# check for multiple assignments 2684f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2685000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2686000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2687f0a594c1SAndy Whitcroft } 2688f0a594c1SAndy Whitcroft 268922f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 269022f2a2efSAndy Whitcroft## # continuation. 269122f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 269222f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 269322f2a2efSAndy Whitcroft## 269422f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 269522f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 269622f2a2efSAndy Whitcroft## my $ln = $line; 269722f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 269822f2a2efSAndy Whitcroft## } 269922f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2700000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2701000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 270222f2a2efSAndy Whitcroft## } 270322f2a2efSAndy Whitcroft## } 2704f0a594c1SAndy Whitcroft 27050a920b5bSAndy Whitcroft#need space before brace following if, while, etc 270622f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 270722f2a2efSAndy Whitcroft $line =~ /do{/) { 2708000d1cc1SJoe Perches ERROR("SPACING", 2709000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2710de7d4f0eSAndy Whitcroft } 2711de7d4f0eSAndy Whitcroft 2712de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2713de7d4f0eSAndy Whitcroft# on the line 2714de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2715000d1cc1SJoe Perches ERROR("SPACING", 2716000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 27170a920b5bSAndy Whitcroft } 27180a920b5bSAndy Whitcroft 271922f2a2efSAndy Whitcroft# check spacing on square brackets 272022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2721000d1cc1SJoe Perches ERROR("SPACING", 2722000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 272322f2a2efSAndy Whitcroft } 272422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2725000d1cc1SJoe Perches ERROR("SPACING", 2726000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 272722f2a2efSAndy Whitcroft } 272822f2a2efSAndy Whitcroft 2729c45dcabdSAndy Whitcroft# check spacing on parentheses 27309c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 27319c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2732000d1cc1SJoe Perches ERROR("SPACING", 2733000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 273422f2a2efSAndy Whitcroft } 273513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2736c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2737c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2738000d1cc1SJoe Perches ERROR("SPACING", 2739000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 274022f2a2efSAndy Whitcroft } 274122f2a2efSAndy Whitcroft 27420a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 27434a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 27440a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2745000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2746000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 27470a920b5bSAndy Whitcroft } 27480a920b5bSAndy Whitcroft 2749c45dcabdSAndy Whitcroft# Return is not a function. 2750c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2751c45dcabdSAndy Whitcroft my $spacing = $1; 2752c45dcabdSAndy Whitcroft my $value = $2; 2753c45dcabdSAndy Whitcroft 275486f9d059SAndy Whitcroft # Flatten any parentheses 2755fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2756fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 2757e01886adSAndy Whitcroft while ($value =~ s/\[[^\[\]]*\]/1/ || 275863f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 275963f17f89SAndy Whitcroft $Compare\s* 276063f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 276163f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2762c45dcabdSAndy Whitcroft } 2763fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2764fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2765000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2766000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2767c45dcabdSAndy Whitcroft 2768c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2769000d1cc1SJoe Perches ERROR("SPACING", 2770000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2771c45dcabdSAndy Whitcroft } 2772c45dcabdSAndy Whitcroft } 277353a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 277453a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 277553a3c448SAndy Whitcroft my $name = $1; 277653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2777000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2778000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 277953a3c448SAndy Whitcroft } 278053a3c448SAndy Whitcroft } 2781c45dcabdSAndy Whitcroft 27820a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 27834a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2784000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 27850a920b5bSAndy Whitcroft } 27860a920b5bSAndy Whitcroft 2787f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2788f5fe35ddSAndy Whitcroft# statements after the conditional. 2789170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 27903e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 27913e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 27923e469cdcSAndy Whitcroft if (!defined $stat); 2793170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2794170d3a22SAndy Whitcroft $remain_next, $off_next); 2795170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2796170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2797170d3a22SAndy Whitcroft 2798170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2799170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2800170d3a22SAndy Whitcroft # then count those as offsets. 2801170d3a22SAndy Whitcroft my ($whitespace) = 2802170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2803170d3a22SAndy Whitcroft my $offset = 2804170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2805170d3a22SAndy Whitcroft 2806170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2807170d3a22SAndy Whitcroft $offset} = 1; 2808170d3a22SAndy Whitcroft } 2809170d3a22SAndy Whitcroft } 2810170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2811170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2812171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 28138905a67cSAndy Whitcroft 2814b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2815000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2816000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 28178905a67cSAndy Whitcroft } 28188905a67cSAndy Whitcroft 28198905a67cSAndy Whitcroft # Find out what is on the end of the line after the 28208905a67cSAndy Whitcroft # conditional. 2821773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 28228905a67cSAndy Whitcroft $s =~ s/\n.*//g; 282313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 282453210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 282553210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2826773647a0SAndy Whitcroft { 2827bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2828bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2829bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 283042bdf74cSHidetoshi Seto my $stat_real = ''; 2831bb44ad39SAndy Whitcroft 283242bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 283342bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2834bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2835bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2836bb44ad39SAndy Whitcroft } 2837bb44ad39SAndy Whitcroft 2838000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2839000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 28408905a67cSAndy Whitcroft } 28418905a67cSAndy Whitcroft } 28428905a67cSAndy Whitcroft 284313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 284413214adfSAndy Whitcroft if ($line =~ / 284513214adfSAndy Whitcroft (?: 284613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 284713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 284813214adfSAndy Whitcroft (?:\&\&|\|\|) 284913214adfSAndy Whitcroft | 285013214adfSAndy Whitcroft (?:\&\&|\|\|) 285113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 285213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 285313214adfSAndy Whitcroft )/x) 285413214adfSAndy Whitcroft { 2855000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2856000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 285713214adfSAndy Whitcroft } 285813214adfSAndy Whitcroft 28598905a67cSAndy Whitcroft# if and else should not have general statements after it 286013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 286113214adfSAndy Whitcroft my $s = $1; 286213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 286313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2864000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2865000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 28660a920b5bSAndy Whitcroft } 286713214adfSAndy Whitcroft } 286839667782SAndy Whitcroft# if should not continue a brace 286939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2870000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2871000d1cc1SJoe Perches "trailing statements should be on next line\n" . 287239667782SAndy Whitcroft $herecurr); 287339667782SAndy Whitcroft } 2874a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2875a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2876a1080bf8SAndy Whitcroft $line !~ /\G(?: 28773fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2878a1080bf8SAndy Whitcroft \s*return\s+ 2879a1080bf8SAndy Whitcroft )/xg) 2880a1080bf8SAndy Whitcroft { 2881000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2882000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2883a1080bf8SAndy Whitcroft } 28840a920b5bSAndy Whitcroft 28850a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 28860a920b5bSAndy Whitcroft # indent level to be relevant to each other. 28870a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 28880a920b5bSAndy Whitcroft $previndent == $indent) { 2889000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2890000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 28910a920b5bSAndy Whitcroft } 28920a920b5bSAndy Whitcroft 2893c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2894c2fdda0dSAndy Whitcroft $previndent == $indent) { 2895c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2896c2fdda0dSAndy Whitcroft 2897c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2898c2fdda0dSAndy Whitcroft # conditional. 2899773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2900c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2901c2fdda0dSAndy Whitcroft 2902c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2903000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2904000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2905c2fdda0dSAndy Whitcroft } 2906c2fdda0dSAndy Whitcroft } 2907c2fdda0dSAndy Whitcroft 29080a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 29090a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 29100a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 29110a920b5bSAndy Whitcroft# print "$herecurr"; 29120a920b5bSAndy Whitcroft# $clean = 0; 29130a920b5bSAndy Whitcroft# } 29140a920b5bSAndy Whitcroft 29150a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2916c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2917000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2918000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 29190a920b5bSAndy Whitcroft } 29200a920b5bSAndy Whitcroft 2921653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2922c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2923e09dec48SAndy Whitcroft my $file = "$1.h"; 2924e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2925e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2926e09dec48SAndy Whitcroft $realfile ne $checkfile && 29277840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2928c45dcabdSAndy Whitcroft { 2929e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2930000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2931000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2932e09dec48SAndy Whitcroft } else { 2933000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2934000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2935e09dec48SAndy Whitcroft } 29360a920b5bSAndy Whitcroft } 29370a920b5bSAndy Whitcroft } 29380a920b5bSAndy Whitcroft 2939653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2940653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2941cf655043SAndy Whitcroft# in a known good container 2942b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2943b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2944d8aaf121SAndy Whitcroft my $ln = $linenr; 2945d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2946c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2947c45dcabdSAndy Whitcroft my $ctx = ''; 2948c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2949f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2950f74bd194SAndy Whitcroft $ctx = $dstat; 2951c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2952a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2953c45dcabdSAndy Whitcroft 2954f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2955292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2956c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2957c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2958c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2959c45dcabdSAndy Whitcroft 2960c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2961bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2962bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2963c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 2964bf30d6edSAndy Whitcroft { 2965c45dcabdSAndy Whitcroft } 2966c45dcabdSAndy Whitcroft 2967e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 2968e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 2969e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 2970e45bab8eSAndy Whitcroft { 2971e45bab8eSAndy Whitcroft } 2972e45bab8eSAndy Whitcroft 2973c45dcabdSAndy Whitcroft my $exceptions = qr{ 2974c45dcabdSAndy Whitcroft $Declare| 2975c45dcabdSAndy Whitcroft module_param_named| 2976a0a0a7a9SKees Cook MODULE_PARM_DESC| 2977c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2978c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2979383099fdSAndy Whitcroft __typeof__\(| 298022fd2d3eSStefani Seibold union| 298122fd2d3eSStefani Seibold struct| 2982ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2983ea71a0a0SAndy Whitcroft ^\"|\"$ 2984c45dcabdSAndy Whitcroft }x; 29855eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2986f74bd194SAndy Whitcroft if ($dstat ne '' && 2987f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 2988f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 2989fd1b57acSAndy Whitcroft $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo 2990b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 2991f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 2992f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 299372f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 2994f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 2995f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 2996f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 2997f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 2998c45dcabdSAndy Whitcroft { 2999f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3000f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3001f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3002f74bd194SAndy Whitcroft 3003f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3004f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3005c45dcabdSAndy Whitcroft } 3006c45dcabdSAndy Whitcroft 3007f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3008f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3009f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3010f74bd194SAndy Whitcroft } else { 3011000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3012f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3013d8aaf121SAndy Whitcroft } 30140a920b5bSAndy Whitcroft } 30155023d347SJoe Perches 3016481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 30175023d347SJoe Perches 30185023d347SJoe Perches } else { 30195023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3020481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3021481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 30225023d347SJoe Perches $line =~ /^\+.*\\$/) { 30235023d347SJoe Perches WARN("LINE_CONTINUATIONS", 30245023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 30255023d347SJoe Perches } 3026653d4876SAndy Whitcroft } 30270a920b5bSAndy Whitcroft 3028b13edf7fSJoe Perches# do {} while (0) macro tests: 3029b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3030b13edf7fSJoe Perches# macro should not end with a semicolon 3031b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3032b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3033b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3034b13edf7fSJoe Perches my $ln = $linenr; 3035b13edf7fSJoe Perches my $cnt = $realcnt; 3036b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3037b13edf7fSJoe Perches my $ctx = ''; 3038b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3039b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3040b13edf7fSJoe Perches $ctx = $dstat; 3041b13edf7fSJoe Perches 3042b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3043b13edf7fSJoe Perches 3044b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3045b13edf7fSJoe Perches my $stmts = $2; 3046b13edf7fSJoe Perches my $semis = $3; 3047b13edf7fSJoe Perches 3048b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3049b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3050b13edf7fSJoe Perches my $herectx = $here . "\n"; 3051b13edf7fSJoe Perches 3052b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3053b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3054b13edf7fSJoe Perches } 3055b13edf7fSJoe Perches 3056ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3057ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3058b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3059b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3060b13edf7fSJoe Perches } 3061b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3062b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3063b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3064b13edf7fSJoe Perches } 3065b13edf7fSJoe Perches } 3066b13edf7fSJoe Perches } 3067b13edf7fSJoe Perches 3068080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3069080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3070080ba929SMike Frysinger# . 3071080ba929SMike Frysinger# ALIGN(...) 3072080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3073080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3074000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3075000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3076080ba929SMike Frysinger } 3077080ba929SMike Frysinger 3078f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 307913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 308013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3081cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 308213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3083cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3084cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3085aad4f614SJoe Perches my @allowed = (); 3086aad4f614SJoe Perches my $allow = 0; 308713214adfSAndy Whitcroft my $seen = 0; 3088773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3089cf655043SAndy Whitcroft my $ln = $linenr - 1; 309013214adfSAndy Whitcroft for my $chunk (@chunks) { 309113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 309213214adfSAndy Whitcroft 3093773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3094773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3095773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3096773647a0SAndy Whitcroft 3097aad4f614SJoe Perches $allowed[$allow] = 0; 3098773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3099773647a0SAndy Whitcroft 3100773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3101773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3102773647a0SAndy Whitcroft 3103773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3104cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3105cf655043SAndy Whitcroft 3106773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 310713214adfSAndy Whitcroft 310813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 310913214adfSAndy Whitcroft 3110aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3111cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3112cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3113aad4f614SJoe Perches $allowed[$allow] = 1; 311413214adfSAndy Whitcroft } 311513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3116cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3117aad4f614SJoe Perches $allowed[$allow] = 1; 311813214adfSAndy Whitcroft } 3119cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3120cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3121aad4f614SJoe Perches $allowed[$allow] = 1; 312213214adfSAndy Whitcroft } 3123aad4f614SJoe Perches $allow++; 312413214adfSAndy Whitcroft } 3125aad4f614SJoe Perches if ($seen) { 3126aad4f614SJoe Perches my $sum_allowed = 0; 3127aad4f614SJoe Perches foreach (@allowed) { 3128aad4f614SJoe Perches $sum_allowed += $_; 3129aad4f614SJoe Perches } 3130aad4f614SJoe Perches if ($sum_allowed == 0) { 3131000d1cc1SJoe Perches WARN("BRACES", 3132000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3133aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3134aad4f614SJoe Perches $seen != $allow) { 3135aad4f614SJoe Perches CHK("BRACES", 3136aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3137aad4f614SJoe Perches } 313813214adfSAndy Whitcroft } 313913214adfSAndy Whitcroft } 314013214adfSAndy Whitcroft } 3141773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 314213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3143cf655043SAndy Whitcroft my $allowed = 0; 3144f0a594c1SAndy Whitcroft 3145cf655043SAndy Whitcroft # Check the pre-context. 3146cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3147cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3148cf655043SAndy Whitcroft $allowed = 1; 3149f0a594c1SAndy Whitcroft } 3150773647a0SAndy Whitcroft 3151773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3152773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3153773647a0SAndy Whitcroft 3154cf655043SAndy Whitcroft # Check the condition. 3155cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3156773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3157cf655043SAndy Whitcroft if (defined $cond) { 3158773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3159cf655043SAndy Whitcroft } 3160cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3161cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3162cf655043SAndy Whitcroft $allowed = 1; 3163cf655043SAndy Whitcroft } 3164cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3165cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3166cf655043SAndy Whitcroft $allowed = 1; 3167cf655043SAndy Whitcroft } 3168cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3169cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3170cf655043SAndy Whitcroft $allowed = 1; 3171cf655043SAndy Whitcroft } 3172cf655043SAndy Whitcroft # Check the post-context. 3173cf655043SAndy Whitcroft if (defined $chunks[1]) { 3174cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3175cf655043SAndy Whitcroft if (defined $cond) { 3176773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3177cf655043SAndy Whitcroft } 3178cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3179cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3180cf655043SAndy Whitcroft $allowed = 1; 3181cf655043SAndy Whitcroft } 3182cf655043SAndy Whitcroft } 3183cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 318469932487SJustin P. Mattock my $herectx = $here . "\n"; 3185f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3186cf655043SAndy Whitcroft 3187f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 318869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3189cf655043SAndy Whitcroft } 3190cf655043SAndy Whitcroft 3191000d1cc1SJoe Perches WARN("BRACES", 3192000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3193f0a594c1SAndy Whitcroft } 3194f0a594c1SAndy Whitcroft } 3195f0a594c1SAndy Whitcroft 31960979ae66SJoe Perches# check for unnecessary blank lines around braces 31970979ae66SJoe Perches if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) { 31980979ae66SJoe Perches CHK("BRACES", 31990979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 32000979ae66SJoe Perches } 32010979ae66SJoe Perches if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 32020979ae66SJoe Perches CHK("BRACES", 32030979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 32040979ae66SJoe Perches } 32050979ae66SJoe Perches 32064a0df2efSAndy Whitcroft# no volatiles please 32076c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 32086c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3209000d1cc1SJoe Perches WARN("VOLATILE", 3210000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 32114a0df2efSAndy Whitcroft } 32124a0df2efSAndy Whitcroft 321300df344fSAndy Whitcroft# warn about #if 0 3214c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3215000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3216000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3217de7d4f0eSAndy Whitcroft $herecurr); 32184a0df2efSAndy Whitcroft } 32194a0df2efSAndy Whitcroft 322003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 322103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 322203df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 322303df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 322403df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 322503df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 32264c432a8fSGreg Kroah-Hartman } 32274c432a8fSGreg Kroah-Hartman } 3228f0a594c1SAndy Whitcroft 32291a15a250SPatrick Pannuto# prefer usleep_range over udelay 32301a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 32311a15a250SPatrick Pannuto # ignore udelay's < 10, however 32321a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3233000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3234000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 32351a15a250SPatrick Pannuto } 32361a15a250SPatrick Pannuto } 32371a15a250SPatrick Pannuto 323809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 323909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 324009ef8725SPatrick Pannuto if ($1 < 20) { 3241000d1cc1SJoe Perches WARN("MSLEEP", 3242000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 324309ef8725SPatrick Pannuto } 324409ef8725SPatrick Pannuto } 324509ef8725SPatrick Pannuto 324600df344fSAndy Whitcroft# warn about #ifdefs in C files 3247c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 324800df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 324900df344fSAndy Whitcroft# print "$herecurr"; 325000df344fSAndy Whitcroft# $clean = 0; 325100df344fSAndy Whitcroft# } 325200df344fSAndy Whitcroft 325322f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3254c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3255000d1cc1SJoe Perches ERROR("SPACING", 3256000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 325722f2a2efSAndy Whitcroft } 325822f2a2efSAndy Whitcroft 32594a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3260171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3261171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 32624a0df2efSAndy Whitcroft my $which = $1; 32634a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3264000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3265000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 32664a0df2efSAndy Whitcroft } 32674a0df2efSAndy Whitcroft } 32684a0df2efSAndy Whitcroft# check for memory barriers without a comment. 32694a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 32704a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3271000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3272000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 32734a0df2efSAndy Whitcroft } 32744a0df2efSAndy Whitcroft } 32754a0df2efSAndy Whitcroft# check of hardware specific defines 3276c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3277000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3278000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 32790a920b5bSAndy Whitcroft } 3280653d4876SAndy Whitcroft 3281d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3282d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3283000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3284000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3285d4977c78STobias Klauser } 3286d4977c78STobias Klauser 3287de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3288de7d4f0eSAndy Whitcroft# storage class and type. 32899c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 32909c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3291000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3292000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3293de7d4f0eSAndy Whitcroft } 3294de7d4f0eSAndy Whitcroft 32958905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 32968905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3297000d1cc1SJoe Perches WARN("INLINE", 3298000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 32998905a67cSAndy Whitcroft } 33008905a67cSAndy Whitcroft 33013d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 33023d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3303000d1cc1SJoe Perches WARN("PREFER_PACKED", 3304000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 33053d130fd0SJoe Perches } 33063d130fd0SJoe Perches 330739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 330839b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3309000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3310000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 331139b7e287SJoe Perches } 331239b7e287SJoe Perches 33135f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 33145f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 33155f14d3bdSJoe Perches WARN("PREFER_PRINTF", 33165f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 33175f14d3bdSJoe Perches } 33185f14d3bdSJoe Perches 33196061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 33206061d949SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 33216061d949SJoe Perches WARN("PREFER_SCANF", 33226061d949SJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); 33236061d949SJoe Perches } 33246061d949SJoe Perches 33258f53a9b8SJoe Perches# check for sizeof(&) 33268f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3327000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3328000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 33298f53a9b8SJoe Perches } 33308f53a9b8SJoe Perches 333166c80b60SJoe Perches# check for sizeof without parenthesis 333266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 333366c80b60SJoe Perches WARN("SIZEOF_PARENTHESIS", 333466c80b60SJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr); 333566c80b60SJoe Perches } 333666c80b60SJoe Perches 3337428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3338428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3339000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3340000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3341428e2fdcSJoe Perches } 3342428e2fdcSJoe Perches 334388982feaSJoe Perches# check for struct spinlock declarations 334488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 334588982feaSJoe Perches WARN("USE_SPINLOCK_T", 334688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 334788982feaSJoe Perches } 334888982feaSJoe Perches 3349554e165cSAndy Whitcroft# Check for misused memsets 3350d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3351d1fe9c09SJoe Perches defined $stat && 3352d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3353554e165cSAndy Whitcroft 3354d7c76ba7SJoe Perches my $ms_addr = $2; 3355d1fe9c09SJoe Perches my $ms_val = $7; 3356d1fe9c09SJoe Perches my $ms_size = $12; 3357d7c76ba7SJoe Perches 3358554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3359554e165cSAndy Whitcroft ERROR("MEMSET", 3360d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3361554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3362554e165cSAndy Whitcroft WARN("MEMSET", 3363d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3364d7c76ba7SJoe Perches } 3365d7c76ba7SJoe Perches } 3366d7c76ba7SJoe Perches 3367d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3368d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3369d1fe9c09SJoe Perches defined $stat && 3370d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3371d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3372d7c76ba7SJoe Perches my $call = $1; 3373d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3374d7c76ba7SJoe Perches my $arg1 = $3; 3375d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3376d1fe9c09SJoe Perches my $arg2 = $8; 3377d7c76ba7SJoe Perches my $cast; 3378d7c76ba7SJoe Perches 3379d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3380d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3381d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3382d7c76ba7SJoe Perches $cast = $cast1; 3383d7c76ba7SJoe Perches } else { 3384d7c76ba7SJoe Perches $cast = $cast2; 3385d7c76ba7SJoe Perches } 3386d7c76ba7SJoe Perches WARN("MINMAX", 3387d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3388554e165cSAndy Whitcroft } 3389554e165cSAndy Whitcroft } 3390554e165cSAndy Whitcroft 33914a273195SJoe Perches# check usleep_range arguments 33924a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 33934a273195SJoe Perches defined $stat && 33944a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 33954a273195SJoe Perches my $min = $1; 33964a273195SJoe Perches my $max = $7; 33974a273195SJoe Perches if ($min eq $max) { 33984a273195SJoe Perches WARN("USLEEP_RANGE", 33994a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34004a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 34014a273195SJoe Perches $min > $max) { 34024a273195SJoe Perches WARN("USLEEP_RANGE", 34034a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34044a273195SJoe Perches } 34054a273195SJoe Perches } 34064a273195SJoe Perches 3407de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3408171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3409c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3410171ae1a4SAndy Whitcroft { 3411c45dcabdSAndy Whitcroft my $function_name = $1; 3412c45dcabdSAndy Whitcroft my $paren_space = $2; 3413171ae1a4SAndy Whitcroft 3414171ae1a4SAndy Whitcroft my $s = $stat; 3415171ae1a4SAndy Whitcroft if (defined $cond) { 3416171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3417171ae1a4SAndy Whitcroft } 3418c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3419c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3420c45dcabdSAndy Whitcroft { 3421000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3422000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3423de7d4f0eSAndy Whitcroft } 3424de7d4f0eSAndy Whitcroft 3425171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3426000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3427000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3428171ae1a4SAndy Whitcroft } 34299c9ba34eSAndy Whitcroft 34309c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 34319c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 34329c9ba34eSAndy Whitcroft { 3433000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3434000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3435171ae1a4SAndy Whitcroft } 3436171ae1a4SAndy Whitcroft 3437de7d4f0eSAndy Whitcroft# checks for new __setup's 3438de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3439de7d4f0eSAndy Whitcroft my $name = $1; 3440de7d4f0eSAndy Whitcroft 3441de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3442000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3443000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3444de7d4f0eSAndy Whitcroft } 3445653d4876SAndy Whitcroft } 34469c0ca6f9SAndy Whitcroft 34479c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3448caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3449000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3450000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 34519c0ca6f9SAndy Whitcroft } 345213214adfSAndy Whitcroft 3453caf2a54fSJoe Perches# check for multiple semicolons 3454caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3455000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3456000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3457d1e2ad07SJoe Perches } 3458d1e2ad07SJoe Perches 3459d1e2ad07SJoe Perches# check for switch/default statements without a break; 3460d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 3461d1e2ad07SJoe Perches defined $stat && 3462d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 3463d1e2ad07SJoe Perches my $ctx = ''; 3464d1e2ad07SJoe Perches my $herectx = $here . "\n"; 3465d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 3466d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3467d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3468d1e2ad07SJoe Perches } 3469d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 3470d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 3471caf2a54fSJoe Perches } 3472caf2a54fSJoe Perches 347313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 347413214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3475000d1cc1SJoe Perches WARN("USE_FUNC", 3476000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 347713214adfSAndy Whitcroft } 3478773647a0SAndy Whitcroft 34792c92488aSJoe Perches# check for use of yield() 34802c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 34812c92488aSJoe Perches WARN("YIELD", 34822c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 34832c92488aSJoe Perches } 34842c92488aSJoe Perches 34854882720bSThomas Gleixner# check for semaphores initialized locked 34864882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3487000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3488000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 3489773647a0SAndy Whitcroft } 34906712d858SJoe Perches 349167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 349267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3493000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 349467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3495773647a0SAndy Whitcroft } 34966712d858SJoe Perches 3497f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3498f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3499000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3500000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3501f3db6639SMichael Ellerman } 35026712d858SJoe Perches 350379404849SEmese Revfy# check for various ops structs, ensure they are const. 350479404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 350579404849SEmese Revfy address_space_operations| 350679404849SEmese Revfy backlight_ops| 350779404849SEmese Revfy block_device_operations| 350879404849SEmese Revfy dentry_operations| 350979404849SEmese Revfy dev_pm_ops| 351079404849SEmese Revfy dma_map_ops| 351179404849SEmese Revfy extent_io_ops| 351279404849SEmese Revfy file_lock_operations| 351379404849SEmese Revfy file_operations| 351479404849SEmese Revfy hv_ops| 351579404849SEmese Revfy ide_dma_ops| 351679404849SEmese Revfy intel_dvo_dev_ops| 351779404849SEmese Revfy item_operations| 351879404849SEmese Revfy iwl_ops| 351979404849SEmese Revfy kgdb_arch| 352079404849SEmese Revfy kgdb_io| 352179404849SEmese Revfy kset_uevent_ops| 352279404849SEmese Revfy lock_manager_operations| 352379404849SEmese Revfy microcode_ops| 352479404849SEmese Revfy mtrr_ops| 352579404849SEmese Revfy neigh_ops| 352679404849SEmese Revfy nlmsvc_binding| 352779404849SEmese Revfy pci_raw_ops| 352879404849SEmese Revfy pipe_buf_operations| 352979404849SEmese Revfy platform_hibernation_ops| 353079404849SEmese Revfy platform_suspend_ops| 353179404849SEmese Revfy proto_ops| 353279404849SEmese Revfy rpc_pipe_ops| 353379404849SEmese Revfy seq_operations| 353479404849SEmese Revfy snd_ac97_build_ops| 353579404849SEmese Revfy soc_pcmcia_socket_ops| 353679404849SEmese Revfy stacktrace_ops| 353779404849SEmese Revfy sysfs_ops| 353879404849SEmese Revfy tty_operations| 353979404849SEmese Revfy usb_mon_operations| 354079404849SEmese Revfy wd_ops}x; 35416903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 354279404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3543000d1cc1SJoe Perches WARN("CONST_STRUCT", 3544000d1cc1SJoe Perches "struct $1 should normally be const\n" . 35456903ffb2SAndy Whitcroft $herecurr); 35462b6db5cbSAndy Whitcroft } 3547773647a0SAndy Whitcroft 3548773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3549773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3550773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3551c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3552c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3553171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3554171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3555171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3556773647a0SAndy Whitcroft { 3557000d1cc1SJoe Perches WARN("NR_CPUS", 3558000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3559773647a0SAndy Whitcroft } 35609c9ba34eSAndy Whitcroft 35619c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 35629c9ba34eSAndy Whitcroft my $string; 35639c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 35649c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 35652a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 35669c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3567000d1cc1SJoe Perches WARN("PRINTF_L", 3568000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 35699c9ba34eSAndy Whitcroft last; 35709c9ba34eSAndy Whitcroft } 35719c9ba34eSAndy Whitcroft } 3572691d77b6SAndy Whitcroft 3573691d77b6SAndy Whitcroft# whine mightly about in_atomic 3574691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3575691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3576000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3577000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3578f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3579000d1cc1SJoe Perches WARN("IN_ATOMIC", 3580000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3581691d77b6SAndy Whitcroft } 3582691d77b6SAndy Whitcroft } 35831704f47bSPeter Zijlstra 35841704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 35851704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 35861704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 35871704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 35881704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 35891704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3590000d1cc1SJoe Perches ERROR("LOCKDEP", 3591000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 35921704f47bSPeter Zijlstra } 35931704f47bSPeter Zijlstra } 359488f8831cSDave Jones 359588f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 359688f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3597000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3598000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 359988f8831cSDave Jones } 360013214adfSAndy Whitcroft } 360113214adfSAndy Whitcroft 360213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 360313214adfSAndy Whitcroft # so just keep quiet. 360413214adfSAndy Whitcroft if ($#rawlines == -1) { 360513214adfSAndy Whitcroft exit(0); 36060a920b5bSAndy Whitcroft } 36070a920b5bSAndy Whitcroft 36088905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 36098905a67cSAndy Whitcroft # things that appear to be patches. 36108905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 36118905a67cSAndy Whitcroft exit(0); 36128905a67cSAndy Whitcroft } 36138905a67cSAndy Whitcroft 36148905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 36158905a67cSAndy Whitcroft # just keep quiet. 36168905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 36178905a67cSAndy Whitcroft exit(0); 36188905a67cSAndy Whitcroft } 36198905a67cSAndy Whitcroft 36208905a67cSAndy Whitcroft if (!$is_patch) { 3621000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3622000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 36230a920b5bSAndy Whitcroft } 36240a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3625000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3626000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 36270a920b5bSAndy Whitcroft } 36280a920b5bSAndy Whitcroft 3629f0a594c1SAndy Whitcroft print report_dump(); 363013214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 363113214adfSAndy Whitcroft print "$filename " if ($summary_file); 36326c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 36336c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 36346c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 36358905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 36366c72ffaaSAndy Whitcroft } 36378905a67cSAndy Whitcroft 3638d2c0a235SAndy Whitcroft if ($quiet == 0) { 3639d1fe9c09SJoe Perches 3640d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 3641d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 3642d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 3643d1fe9c09SJoe Perches } 3644d1fe9c09SJoe Perches 3645d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3646d2c0a235SAndy Whitcroft # then suggest that. 3647d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3648d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3649d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3650b0781216SMike Frysinger $rpt_cleaners = 0; 3651d2c0a235SAndy Whitcroft } 3652d2c0a235SAndy Whitcroft } 3653d2c0a235SAndy Whitcroft 365411232688SArtem Bityutskiy if ($quiet == 0 && keys %ignore_type) { 3655000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3656000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3657000d1cc1SJoe Perches print " $ignore"; 3658000d1cc1SJoe Perches } 365911232688SArtem Bityutskiy print "\n\n"; 3660000d1cc1SJoe Perches } 3661000d1cc1SJoe Perches 36620a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3663c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 36640a920b5bSAndy Whitcroft } 36650a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3666000d1cc1SJoe Perches print << "EOM"; 3667000d1cc1SJoe Perches$vname has style problems, please review. 3668000d1cc1SJoe Perches 3669000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3670000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3671000d1cc1SJoe PerchesEOM 36720a920b5bSAndy Whitcroft } 367313214adfSAndy Whitcroft 36740a920b5bSAndy Whitcroft return $clean; 36750a920b5bSAndy Whitcroft} 3676