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 233326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 234326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 235326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 23674349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 237326b1ffcSJoe Perchesour $Constant = qr{$Float|(?i)(?:0x[0-9a-f]+|[0-9]+)[ul]*}; 238326b1ffcSJoe Perchesour $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 631a6962d72SJoe Perchessub get_quoted_string { 632a6962d72SJoe Perches my ($line, $rawline) = @_; 633a6962d72SJoe Perches 634a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 635a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 636a6962d72SJoe Perches} 637a6962d72SJoe Perches 6388905a67cSAndy Whitcroftsub ctx_statement_block { 6398905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6408905a67cSAndy Whitcroft my $line = $linenr - 1; 6418905a67cSAndy Whitcroft my $blk = ''; 6428905a67cSAndy Whitcroft my $soff = $off; 6438905a67cSAndy Whitcroft my $coff = $off - 1; 644773647a0SAndy Whitcroft my $coff_set = 0; 6458905a67cSAndy Whitcroft 64613214adfSAndy Whitcroft my $loff = 0; 64713214adfSAndy Whitcroft 6488905a67cSAndy Whitcroft my $type = ''; 6498905a67cSAndy Whitcroft my $level = 0; 650a2750645SAndy Whitcroft my @stack = (); 651cf655043SAndy Whitcroft my $p; 6528905a67cSAndy Whitcroft my $c; 6538905a67cSAndy Whitcroft my $len = 0; 65413214adfSAndy Whitcroft 65513214adfSAndy Whitcroft my $remainder; 6568905a67cSAndy Whitcroft while (1) { 657a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 658a2750645SAndy Whitcroft 659773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6608905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6618905a67cSAndy Whitcroft # context. 6628905a67cSAndy Whitcroft if ($off >= $len) { 6638905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 664dea33496SAndy Whitcroft last if (!defined $lines[$line]); 665c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6668905a67cSAndy Whitcroft $remain--; 66713214adfSAndy Whitcroft $loff = $len; 668c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6698905a67cSAndy Whitcroft $len = length($blk); 6708905a67cSAndy Whitcroft $line++; 6718905a67cSAndy Whitcroft last; 6728905a67cSAndy Whitcroft } 6738905a67cSAndy Whitcroft # Bail if there is no further context. 6748905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 67513214adfSAndy Whitcroft if ($off >= $len) { 6768905a67cSAndy Whitcroft last; 6778905a67cSAndy Whitcroft } 678f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 679f74bd194SAndy Whitcroft $level++; 680f74bd194SAndy Whitcroft $type = '#'; 681f74bd194SAndy Whitcroft } 6828905a67cSAndy Whitcroft } 683cf655043SAndy Whitcroft $p = $c; 6848905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 68513214adfSAndy Whitcroft $remainder = substr($blk, $off); 6868905a67cSAndy Whitcroft 687773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6884635f4fbSAndy Whitcroft 6894635f4fbSAndy Whitcroft # Handle nested #if/#else. 6904635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6914635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6924635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 6934635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 6944635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 6954635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 6964635f4fbSAndy Whitcroft } 6974635f4fbSAndy Whitcroft 6988905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 6998905a67cSAndy Whitcroft # outermost level. 7008905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 7018905a67cSAndy Whitcroft last; 7028905a67cSAndy Whitcroft } 7038905a67cSAndy Whitcroft 70413214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 705773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 706773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 707773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 708773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 709773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 710773647a0SAndy Whitcroft $coff_set = 1; 711773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 712773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 71313214adfSAndy Whitcroft } 71413214adfSAndy Whitcroft 7158905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7168905a67cSAndy Whitcroft $level++; 7178905a67cSAndy Whitcroft $type = '('; 7188905a67cSAndy Whitcroft } 7198905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7208905a67cSAndy Whitcroft $level--; 7218905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7228905a67cSAndy Whitcroft 7238905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7248905a67cSAndy Whitcroft $coff = $off; 725773647a0SAndy Whitcroft $coff_set = 1; 726773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7278905a67cSAndy Whitcroft } 7288905a67cSAndy Whitcroft } 7298905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7308905a67cSAndy Whitcroft $level++; 7318905a67cSAndy Whitcroft $type = '{'; 7328905a67cSAndy Whitcroft } 7338905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7348905a67cSAndy Whitcroft $level--; 7358905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7368905a67cSAndy Whitcroft 7378905a67cSAndy Whitcroft if ($level == 0) { 738b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 739b998e001SPatrick Pannuto $off++; 740b998e001SPatrick Pannuto } 7418905a67cSAndy Whitcroft last; 7428905a67cSAndy Whitcroft } 7438905a67cSAndy Whitcroft } 744f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 745f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 746f74bd194SAndy Whitcroft $level--; 747f74bd194SAndy Whitcroft $type = ''; 748f74bd194SAndy Whitcroft $off++; 749f74bd194SAndy Whitcroft last; 750f74bd194SAndy Whitcroft } 7518905a67cSAndy Whitcroft $off++; 7528905a67cSAndy Whitcroft } 753a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 75413214adfSAndy Whitcroft if ($off == $len) { 755a3bb97a7SAndy Whitcroft $loff = $len + 1; 75613214adfSAndy Whitcroft $line++; 75713214adfSAndy Whitcroft $remain--; 75813214adfSAndy Whitcroft } 7598905a67cSAndy Whitcroft 7608905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7618905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7628905a67cSAndy Whitcroft 7638905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7648905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7658905a67cSAndy Whitcroft 766773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 76713214adfSAndy Whitcroft 76813214adfSAndy Whitcroft return ($statement, $condition, 76913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 77013214adfSAndy Whitcroft} 77113214adfSAndy Whitcroft 772cf655043SAndy Whitcroftsub statement_lines { 773cf655043SAndy Whitcroft my ($stmt) = @_; 774cf655043SAndy Whitcroft 775cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 776cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 777cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 778cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 779cf655043SAndy Whitcroft 780cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 781cf655043SAndy Whitcroft 782cf655043SAndy Whitcroft return $#stmt_lines + 2; 783cf655043SAndy Whitcroft} 784cf655043SAndy Whitcroft 785cf655043SAndy Whitcroftsub statement_rawlines { 786cf655043SAndy Whitcroft my ($stmt) = @_; 787cf655043SAndy Whitcroft 788cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 789cf655043SAndy Whitcroft 790cf655043SAndy Whitcroft return $#stmt_lines + 2; 791cf655043SAndy Whitcroft} 792cf655043SAndy Whitcroft 793cf655043SAndy Whitcroftsub statement_block_size { 794cf655043SAndy Whitcroft my ($stmt) = @_; 795cf655043SAndy Whitcroft 796cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 797cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 798cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 799cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 800cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 801cf655043SAndy Whitcroft 802cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 803cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 804cf655043SAndy Whitcroft 805cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 806cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 807cf655043SAndy Whitcroft 808cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 809cf655043SAndy Whitcroft return $stmt_lines; 810cf655043SAndy Whitcroft } else { 811cf655043SAndy Whitcroft return $stmt_statements; 812cf655043SAndy Whitcroft } 813cf655043SAndy Whitcroft} 814cf655043SAndy Whitcroft 81513214adfSAndy Whitcroftsub ctx_statement_full { 81613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 81713214adfSAndy Whitcroft my ($statement, $condition, $level); 81813214adfSAndy Whitcroft 81913214adfSAndy Whitcroft my (@chunks); 82013214adfSAndy Whitcroft 821cf655043SAndy Whitcroft # Grab the first conditional/block pair. 82213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 82313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 824773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 82513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 826cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 827cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 828cf655043SAndy Whitcroft } 829cf655043SAndy Whitcroft 830cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 831cf655043SAndy Whitcroft # could continue the statement. 832cf655043SAndy Whitcroft for (;;) { 83313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 83413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 835cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 836773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 837cf655043SAndy Whitcroft #print "C: push\n"; 838cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 83913214adfSAndy Whitcroft } 84013214adfSAndy Whitcroft 84113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8428905a67cSAndy Whitcroft} 8438905a67cSAndy Whitcroft 8444a0df2efSAndy Whitcroftsub ctx_block_get { 845f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8464a0df2efSAndy Whitcroft my $line; 8474a0df2efSAndy Whitcroft my $start = $linenr - 1; 8484a0df2efSAndy Whitcroft my $blk = ''; 8494a0df2efSAndy Whitcroft my @o; 8504a0df2efSAndy Whitcroft my @c; 8514a0df2efSAndy Whitcroft my @res = (); 8524a0df2efSAndy Whitcroft 853f0a594c1SAndy Whitcroft my $level = 0; 8544635f4fbSAndy Whitcroft my @stack = ($level); 85500df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 85600df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 85700df344fSAndy Whitcroft $remain--; 85800df344fSAndy Whitcroft 85900df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8604635f4fbSAndy Whitcroft 8614635f4fbSAndy Whitcroft # Handle nested #if/#else. 86201464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8634635f4fbSAndy Whitcroft push(@stack, $level); 86401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8654635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 86601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8674635f4fbSAndy Whitcroft $level = pop(@stack); 8684635f4fbSAndy Whitcroft } 8694635f4fbSAndy Whitcroft 87001464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 871f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 872f0a594c1SAndy Whitcroft if ($off > 0) { 873f0a594c1SAndy Whitcroft $off--; 874f0a594c1SAndy Whitcroft next; 875f0a594c1SAndy Whitcroft } 8764a0df2efSAndy Whitcroft 877f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 878f0a594c1SAndy Whitcroft $level--; 879f0a594c1SAndy Whitcroft last if ($level == 0); 880f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 881f0a594c1SAndy Whitcroft $level++; 882f0a594c1SAndy Whitcroft } 883f0a594c1SAndy Whitcroft } 8844a0df2efSAndy Whitcroft 885f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 88600df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8874a0df2efSAndy Whitcroft } 8884a0df2efSAndy Whitcroft 889f0a594c1SAndy Whitcroft last if ($level == 0); 8904a0df2efSAndy Whitcroft } 8914a0df2efSAndy Whitcroft 892f0a594c1SAndy Whitcroft return ($level, @res); 8934a0df2efSAndy Whitcroft} 8944a0df2efSAndy Whitcroftsub ctx_block_outer { 8954a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8964a0df2efSAndy Whitcroft 897f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 898f0a594c1SAndy Whitcroft return @r; 8994a0df2efSAndy Whitcroft} 9004a0df2efSAndy Whitcroftsub ctx_block { 9014a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 9024a0df2efSAndy Whitcroft 903f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 904f0a594c1SAndy Whitcroft return @r; 905653d4876SAndy Whitcroft} 906653d4876SAndy Whitcroftsub ctx_statement { 907f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 908f0a594c1SAndy Whitcroft 909f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 910f0a594c1SAndy Whitcroft return @r; 911f0a594c1SAndy Whitcroft} 912f0a594c1SAndy Whitcroftsub ctx_block_level { 913653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 914653d4876SAndy Whitcroft 915f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9164a0df2efSAndy Whitcroft} 9179c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9189c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9199c0ca6f9SAndy Whitcroft 9209c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9219c0ca6f9SAndy Whitcroft} 9224a0df2efSAndy Whitcroft 9234a0df2efSAndy Whitcroftsub ctx_locate_comment { 9244a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9254a0df2efSAndy Whitcroft 9264a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 927beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9284a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9294a0df2efSAndy Whitcroft 9304a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9314a0df2efSAndy Whitcroft # comment. 9324a0df2efSAndy Whitcroft my $in_comment = 0; 9334a0df2efSAndy Whitcroft $current_comment = ''; 9344a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 93500df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 93600df344fSAndy Whitcroft #warn " $line\n"; 9374a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9384a0df2efSAndy Whitcroft $in_comment = 1; 9394a0df2efSAndy Whitcroft } 9404a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9414a0df2efSAndy Whitcroft $in_comment = 1; 9424a0df2efSAndy Whitcroft } 9434a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9444a0df2efSAndy Whitcroft $current_comment = ''; 9454a0df2efSAndy Whitcroft } 9464a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9474a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9484a0df2efSAndy Whitcroft $in_comment = 0; 9494a0df2efSAndy Whitcroft } 9504a0df2efSAndy Whitcroft } 9514a0df2efSAndy Whitcroft 9524a0df2efSAndy Whitcroft chomp($current_comment); 9534a0df2efSAndy Whitcroft return($current_comment); 9544a0df2efSAndy Whitcroft} 9554a0df2efSAndy Whitcroftsub ctx_has_comment { 9564a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9574a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9584a0df2efSAndy Whitcroft 95900df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9604a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9614a0df2efSAndy Whitcroft 9624a0df2efSAndy Whitcroft return ($cmt ne ''); 9634a0df2efSAndy Whitcroft} 9644a0df2efSAndy Whitcroft 9654d001e4dSAndy Whitcroftsub raw_line { 9664d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9674d001e4dSAndy Whitcroft 9684d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9694d001e4dSAndy Whitcroft $cnt++; 9704d001e4dSAndy Whitcroft 9714d001e4dSAndy Whitcroft my $line; 9724d001e4dSAndy Whitcroft while ($cnt) { 9734d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9744d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9754d001e4dSAndy Whitcroft $cnt--; 9764d001e4dSAndy Whitcroft } 9774d001e4dSAndy Whitcroft 9784d001e4dSAndy Whitcroft return $line; 9794d001e4dSAndy Whitcroft} 9804d001e4dSAndy Whitcroft 9810a920b5bSAndy Whitcroftsub cat_vet { 9820a920b5bSAndy Whitcroft my ($vet) = @_; 9839c0ca6f9SAndy Whitcroft my ($res, $coded); 9840a920b5bSAndy Whitcroft 9859c0ca6f9SAndy Whitcroft $res = ''; 9866c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9876c72ffaaSAndy Whitcroft $res .= $1; 9886c72ffaaSAndy Whitcroft if ($2 ne '') { 9899c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9906c72ffaaSAndy Whitcroft $res .= $coded; 9916c72ffaaSAndy Whitcroft } 9929c0ca6f9SAndy Whitcroft } 9939c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 9940a920b5bSAndy Whitcroft 9959c0ca6f9SAndy Whitcroft return $res; 9960a920b5bSAndy Whitcroft} 9970a920b5bSAndy Whitcroft 998c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 999cf655043SAndy Whitcroftmy $av_pending; 1000c2fdda0dSAndy Whitcroftmy @av_paren_type; 10011f65f947SAndy Whitcroftmy $av_pend_colon; 1002c2fdda0dSAndy Whitcroft 1003c2fdda0dSAndy Whitcroftsub annotate_reset { 1004c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1005cf655043SAndy Whitcroft $av_pending = '_'; 1006cf655043SAndy Whitcroft @av_paren_type = ('E'); 10071f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1008c2fdda0dSAndy Whitcroft} 1009c2fdda0dSAndy Whitcroft 10106c72ffaaSAndy Whitcroftsub annotate_values { 10116c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10126c72ffaaSAndy Whitcroft 10136c72ffaaSAndy Whitcroft my $res; 10141f65f947SAndy Whitcroft my $var = '_' x length($stream); 10156c72ffaaSAndy Whitcroft my $cur = $stream; 10166c72ffaaSAndy Whitcroft 1017c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10186c72ffaaSAndy Whitcroft 10196c72ffaaSAndy Whitcroft while (length($cur)) { 1020773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1021cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1022171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10236c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1024c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1025c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1026cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1027c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10286c72ffaaSAndy Whitcroft } 10296c72ffaaSAndy Whitcroft 1030c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10319446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10329446ef56SAndy Whitcroft push(@av_paren_type, $type); 1033addcdceaSAndy Whitcroft $type = 'c'; 10349446ef56SAndy Whitcroft 1035e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1036c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10376c72ffaaSAndy Whitcroft $type = 'T'; 10386c72ffaaSAndy Whitcroft 1039389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1040389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1041389a2fe5SAndy Whitcroft $type = 'T'; 1042389a2fe5SAndy Whitcroft 1043c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1044171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1045c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1046171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1047171ae1a4SAndy Whitcroft if ($2 ne '') { 1048cf655043SAndy Whitcroft $av_pending = 'N'; 1049171ae1a4SAndy Whitcroft } 1050171ae1a4SAndy Whitcroft $type = 'E'; 1051171ae1a4SAndy Whitcroft 1052c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1053171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1054171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1055171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10566c72ffaaSAndy Whitcroft 1057c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1058cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1059c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1060cf655043SAndy Whitcroft 1061cf655043SAndy Whitcroft push(@av_paren_type, $type); 1062cf655043SAndy Whitcroft push(@av_paren_type, $type); 1063171ae1a4SAndy Whitcroft $type = 'E'; 1064cf655043SAndy Whitcroft 1065c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1066cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1067cf655043SAndy Whitcroft $av_preprocessor = 1; 1068cf655043SAndy Whitcroft 1069cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1070cf655043SAndy Whitcroft 1071171ae1a4SAndy Whitcroft $type = 'E'; 1072cf655043SAndy Whitcroft 1073c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1074cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1075cf655043SAndy Whitcroft 1076cf655043SAndy Whitcroft $av_preprocessor = 1; 1077cf655043SAndy Whitcroft 1078cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1079cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1080cf655043SAndy Whitcroft pop(@av_paren_type); 1081cf655043SAndy Whitcroft push(@av_paren_type, $type); 1082171ae1a4SAndy Whitcroft $type = 'E'; 10836c72ffaaSAndy Whitcroft 10846c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1085c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10866c72ffaaSAndy Whitcroft 1087171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1088171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1089171ae1a4SAndy Whitcroft $av_pending = $type; 1090171ae1a4SAndy Whitcroft $type = 'N'; 1091171ae1a4SAndy Whitcroft 10926c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1093c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 10946c72ffaaSAndy Whitcroft if (defined $2) { 1095cf655043SAndy Whitcroft $av_pending = 'V'; 10966c72ffaaSAndy Whitcroft } 10976c72ffaaSAndy Whitcroft $type = 'N'; 10986c72ffaaSAndy Whitcroft 109914b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1100c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 110114b111c1SAndy Whitcroft $av_pending = 'E'; 11026c72ffaaSAndy Whitcroft $type = 'N'; 11036c72ffaaSAndy Whitcroft 11041f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 11051f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 11061f65f947SAndy Whitcroft $av_pend_colon = 'C'; 11071f65f947SAndy Whitcroft $type = 'N'; 11081f65f947SAndy Whitcroft 110914b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1110c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11116c72ffaaSAndy Whitcroft $type = 'N'; 11126c72ffaaSAndy Whitcroft 11136c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1114c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1115cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1116cf655043SAndy Whitcroft $av_pending = '_'; 11176c72ffaaSAndy Whitcroft $type = 'N'; 11186c72ffaaSAndy Whitcroft 11196c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1120cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1121cf655043SAndy Whitcroft if ($new_type ne '_') { 1122cf655043SAndy Whitcroft $type = $new_type; 1123c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1124c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11256c72ffaaSAndy Whitcroft } else { 1126c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11276c72ffaaSAndy Whitcroft } 11286c72ffaaSAndy Whitcroft 1129c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1130c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1131c8cb2ca3SAndy Whitcroft $type = 'V'; 1132cf655043SAndy Whitcroft $av_pending = 'V'; 11336c72ffaaSAndy Whitcroft 11348e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11358e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11361f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11378e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11388e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11391f65f947SAndy Whitcroft } 11401f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11411f65f947SAndy Whitcroft $type = 'V'; 11421f65f947SAndy Whitcroft 11436c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1144c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11456c72ffaaSAndy Whitcroft $type = 'V'; 11466c72ffaaSAndy Whitcroft 11476c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1148c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11496c72ffaaSAndy Whitcroft $type = 'N'; 11506c72ffaaSAndy Whitcroft 1151cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1152c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 115313214adfSAndy Whitcroft $type = 'E'; 11541f65f947SAndy Whitcroft $av_pend_colon = 'O'; 115513214adfSAndy Whitcroft 11568e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11578e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11588e761b04SAndy Whitcroft $type = 'C'; 11598e761b04SAndy Whitcroft 11601f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11611f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11621f65f947SAndy Whitcroft $type = 'N'; 11631f65f947SAndy Whitcroft 11641f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11651f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11661f65f947SAndy Whitcroft 11671f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11681f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11691f65f947SAndy Whitcroft $type = 'E'; 11701f65f947SAndy Whitcroft } else { 11711f65f947SAndy Whitcroft $type = 'N'; 11721f65f947SAndy Whitcroft } 11731f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11741f65f947SAndy Whitcroft 11758e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 117613214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11776c72ffaaSAndy Whitcroft $type = 'N'; 11786c72ffaaSAndy Whitcroft 11790d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 118074048ed8SAndy Whitcroft my $variant; 118174048ed8SAndy Whitcroft 118274048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 118374048ed8SAndy Whitcroft if ($type eq 'V') { 118474048ed8SAndy Whitcroft $variant = 'B'; 118574048ed8SAndy Whitcroft } else { 118674048ed8SAndy Whitcroft $variant = 'U'; 118774048ed8SAndy Whitcroft } 118874048ed8SAndy Whitcroft 118974048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 119074048ed8SAndy Whitcroft $type = 'N'; 119174048ed8SAndy Whitcroft 11926c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1193c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 11946c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 11956c72ffaaSAndy Whitcroft $type = 'N'; 11966c72ffaaSAndy Whitcroft } 11976c72ffaaSAndy Whitcroft 11986c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1199c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 12006c72ffaaSAndy Whitcroft } 12016c72ffaaSAndy Whitcroft if (defined $1) { 12026c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 12036c72ffaaSAndy Whitcroft $res .= $type x length($1); 12046c72ffaaSAndy Whitcroft } 12056c72ffaaSAndy Whitcroft } 12066c72ffaaSAndy Whitcroft 12071f65f947SAndy Whitcroft return ($res, $var); 12086c72ffaaSAndy Whitcroft} 12096c72ffaaSAndy Whitcroft 12108905a67cSAndy Whitcroftsub possible { 121113214adfSAndy Whitcroft my ($possible, $line) = @_; 12129a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12130776e594SAndy Whitcroft ^(?: 12140776e594SAndy Whitcroft $Modifier| 12150776e594SAndy Whitcroft $Storage| 12160776e594SAndy Whitcroft $Type| 12179a974fdbSAndy Whitcroft DEFINE_\S+ 12189a974fdbSAndy Whitcroft )$| 12199a974fdbSAndy Whitcroft ^(?: 12200776e594SAndy Whitcroft goto| 12210776e594SAndy Whitcroft return| 12220776e594SAndy Whitcroft case| 12230776e594SAndy Whitcroft else| 12240776e594SAndy Whitcroft asm|__asm__| 122589a88353SAndy Whitcroft do| 122689a88353SAndy Whitcroft \#| 122789a88353SAndy Whitcroft \#\#| 12289a974fdbSAndy Whitcroft )(?:\s|$)| 12290776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12309a974fdbSAndy Whitcroft )}x; 12319a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12329a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1233c45dcabdSAndy Whitcroft # Check for modifiers. 1234c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1235c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1236c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1237c45dcabdSAndy Whitcroft 1238c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1239c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1240d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12419a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1242d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1243d2506586SAndy Whitcroft push(@modifierList, $modifier); 1244d2506586SAndy Whitcroft } 12459a974fdbSAndy Whitcroft } 1246c45dcabdSAndy Whitcroft 1247c45dcabdSAndy Whitcroft } else { 124813214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12498905a67cSAndy Whitcroft push(@typeList, $possible); 1250c45dcabdSAndy Whitcroft } 12518905a67cSAndy Whitcroft build_types(); 12520776e594SAndy Whitcroft } else { 12530776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12548905a67cSAndy Whitcroft } 12558905a67cSAndy Whitcroft} 12568905a67cSAndy Whitcroft 12576c72ffaaSAndy Whitcroftmy $prefix = ''; 12586c72ffaaSAndy Whitcroft 1259000d1cc1SJoe Perchessub show_type { 1260000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1261000d1cc1SJoe Perches} 1262000d1cc1SJoe Perches 1263f0a594c1SAndy Whitcroftsub report { 1264000d1cc1SJoe Perches if (!show_type($_[1]) || 1265000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1266773647a0SAndy Whitcroft return 0; 1267773647a0SAndy Whitcroft } 1268000d1cc1SJoe Perches my $line; 1269000d1cc1SJoe Perches if ($show_types) { 1270000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1271000d1cc1SJoe Perches } else { 1272000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1273000d1cc1SJoe Perches } 12748905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12758905a67cSAndy Whitcroft 127613214adfSAndy Whitcroft push(our @report, $line); 1277773647a0SAndy Whitcroft 1278773647a0SAndy Whitcroft return 1; 1279f0a594c1SAndy Whitcroft} 1280f0a594c1SAndy Whitcroftsub report_dump { 128113214adfSAndy Whitcroft our @report; 1282f0a594c1SAndy Whitcroft} 1283000d1cc1SJoe Perches 1284de7d4f0eSAndy Whitcroftsub ERROR { 1285000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1286de7d4f0eSAndy Whitcroft our $clean = 0; 12876c72ffaaSAndy Whitcroft our $cnt_error++; 1288de7d4f0eSAndy Whitcroft } 1289773647a0SAndy Whitcroft} 1290de7d4f0eSAndy Whitcroftsub WARN { 1291000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1292de7d4f0eSAndy Whitcroft our $clean = 0; 12936c72ffaaSAndy Whitcroft our $cnt_warn++; 1294de7d4f0eSAndy Whitcroft } 1295773647a0SAndy Whitcroft} 1296de7d4f0eSAndy Whitcroftsub CHK { 1297000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1298de7d4f0eSAndy Whitcroft our $clean = 0; 12996c72ffaaSAndy Whitcroft our $cnt_chk++; 13006c72ffaaSAndy Whitcroft } 1301de7d4f0eSAndy Whitcroft} 1302de7d4f0eSAndy Whitcroft 13036ecd9674SAndy Whitcroftsub check_absolute_file { 13046ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 13056ecd9674SAndy Whitcroft my $file = $absolute; 13066ecd9674SAndy Whitcroft 13076ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 13086ecd9674SAndy Whitcroft 13096ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 13106ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 13116ecd9674SAndy Whitcroft if (-f "$root/$file") { 13126ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13136ecd9674SAndy Whitcroft last; 13146ecd9674SAndy Whitcroft } 13156ecd9674SAndy Whitcroft } 13166ecd9674SAndy Whitcroft if (! -f _) { 13176ecd9674SAndy Whitcroft return 0; 13186ecd9674SAndy Whitcroft } 13196ecd9674SAndy Whitcroft 13206ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13216ecd9674SAndy Whitcroft my $prefix = $absolute; 13226ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13236ecd9674SAndy Whitcroft 13246ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13256ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1326000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1327000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13286ecd9674SAndy Whitcroft } 13296ecd9674SAndy Whitcroft} 13306ecd9674SAndy Whitcroft 1331d1fe9c09SJoe Perchessub pos_last_openparen { 1332d1fe9c09SJoe Perches my ($line) = @_; 1333d1fe9c09SJoe Perches 1334d1fe9c09SJoe Perches my $pos = 0; 1335d1fe9c09SJoe Perches 1336d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1337d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1338d1fe9c09SJoe Perches 1339d1fe9c09SJoe Perches my $last_openparen = 0; 1340d1fe9c09SJoe Perches 1341d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1342d1fe9c09SJoe Perches return -1; 1343d1fe9c09SJoe Perches } 1344d1fe9c09SJoe Perches 1345d1fe9c09SJoe Perches my $len = length($line); 1346d1fe9c09SJoe Perches 1347d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1348d1fe9c09SJoe Perches my $string = substr($line, $pos); 1349d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1350d1fe9c09SJoe Perches $pos += length($1) - 1; 1351d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1352d1fe9c09SJoe Perches $last_openparen = $pos; 1353d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1354d1fe9c09SJoe Perches last; 1355d1fe9c09SJoe Perches } 1356d1fe9c09SJoe Perches } 1357d1fe9c09SJoe Perches 1358d1fe9c09SJoe Perches return $last_openparen + 1; 1359d1fe9c09SJoe Perches} 1360d1fe9c09SJoe Perches 13610a920b5bSAndy Whitcroftsub process { 13620a920b5bSAndy Whitcroft my $filename = shift; 13630a920b5bSAndy Whitcroft 13640a920b5bSAndy Whitcroft my $linenr=0; 13650a920b5bSAndy Whitcroft my $prevline=""; 1366c2fdda0dSAndy Whitcroft my $prevrawline=""; 13670a920b5bSAndy Whitcroft my $stashline=""; 1368c2fdda0dSAndy Whitcroft my $stashrawline=""; 13690a920b5bSAndy Whitcroft 13704a0df2efSAndy Whitcroft my $length; 13710a920b5bSAndy Whitcroft my $indent; 13720a920b5bSAndy Whitcroft my $previndent=0; 13730a920b5bSAndy Whitcroft my $stashindent=0; 13740a920b5bSAndy Whitcroft 1375de7d4f0eSAndy Whitcroft our $clean = 1; 13760a920b5bSAndy Whitcroft my $signoff = 0; 13770a920b5bSAndy Whitcroft my $is_patch = 0; 13780a920b5bSAndy Whitcroft 137915662b3eSJoe Perches my $in_header_lines = 1; 138015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 138115662b3eSJoe Perches 1382fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1383fa64205dSPasi Savanainen 138413214adfSAndy Whitcroft our @report = (); 13856c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13866c72ffaaSAndy Whitcroft our $cnt_error = 0; 13876c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13886c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13896c72ffaaSAndy Whitcroft 13900a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13910a920b5bSAndy Whitcroft my $realfile = ''; 13920a920b5bSAndy Whitcroft my $realline = 0; 13930a920b5bSAndy Whitcroft my $realcnt = 0; 13940a920b5bSAndy Whitcroft my $here = ''; 13950a920b5bSAndy Whitcroft my $in_comment = 0; 1396c2fdda0dSAndy Whitcroft my $comment_edge = 0; 13970a920b5bSAndy Whitcroft my $first_line = 0; 13981e855726SWolfram Sang my $p1_prefix = ''; 13990a920b5bSAndy Whitcroft 140013214adfSAndy Whitcroft my $prev_values = 'E'; 140113214adfSAndy Whitcroft 140213214adfSAndy Whitcroft # suppression flags 1403773647a0SAndy Whitcroft my %suppress_ifbraces; 1404170d3a22SAndy Whitcroft my %suppress_whiletrailers; 14052b474a1aSAndy Whitcroft my %suppress_export; 14063e469cdcSAndy Whitcroft my $suppress_statement = 0; 1407653d4876SAndy Whitcroft 1408323c1260SJoe Perches my %camelcase = (); 1409323c1260SJoe Perches 1410c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1411de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1412c2fdda0dSAndy Whitcroft # 1413de7d4f0eSAndy Whitcroft my @setup_docs = (); 1414de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1415773647a0SAndy Whitcroft 1416773647a0SAndy Whitcroft sanitise_line_reset(); 1417c2fdda0dSAndy Whitcroft my $line; 1418c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1419773647a0SAndy Whitcroft $linenr++; 1420773647a0SAndy Whitcroft $line = $rawline; 1421c2fdda0dSAndy Whitcroft 1422773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1423de7d4f0eSAndy Whitcroft $setup_docs = 0; 1424de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1425de7d4f0eSAndy Whitcroft $setup_docs = 1; 1426de7d4f0eSAndy Whitcroft } 1427773647a0SAndy Whitcroft #next; 1428de7d4f0eSAndy Whitcroft } 1429773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1430773647a0SAndy Whitcroft $realline=$1-1; 1431773647a0SAndy Whitcroft if (defined $2) { 1432773647a0SAndy Whitcroft $realcnt=$3+1; 1433773647a0SAndy Whitcroft } else { 1434773647a0SAndy Whitcroft $realcnt=1+1; 1435773647a0SAndy Whitcroft } 1436c45dcabdSAndy Whitcroft $in_comment = 0; 1437773647a0SAndy Whitcroft 1438773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1439773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1440773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1441773647a0SAndy Whitcroft # at context start. 1442773647a0SAndy Whitcroft my $edge; 144301fa9147SAndy Whitcroft my $cnt = $realcnt; 144401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 144501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 144601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 144701fa9147SAndy Whitcroft $cnt--; 144801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1449721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1450fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1451fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1452fae17daeSAndy Whitcroft ($edge) = $1; 1453fae17daeSAndy Whitcroft last; 1454fae17daeSAndy Whitcroft } 1455773647a0SAndy Whitcroft } 1456773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1457773647a0SAndy Whitcroft $in_comment = 1; 1458773647a0SAndy Whitcroft } 1459773647a0SAndy Whitcroft 1460773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1461773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1462773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1463773647a0SAndy Whitcroft if (!defined $edge && 146483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1465773647a0SAndy Whitcroft { 1466773647a0SAndy Whitcroft $in_comment = 1; 1467773647a0SAndy Whitcroft } 1468773647a0SAndy Whitcroft 1469773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1470773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1471773647a0SAndy Whitcroft 1472171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1473773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1474171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1475773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1476773647a0SAndy Whitcroft } 1477773647a0SAndy Whitcroft push(@lines, $line); 1478773647a0SAndy Whitcroft 1479773647a0SAndy Whitcroft if ($realcnt > 1) { 1480773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1481773647a0SAndy Whitcroft } else { 1482773647a0SAndy Whitcroft $realcnt = 0; 1483773647a0SAndy Whitcroft } 1484773647a0SAndy Whitcroft 1485773647a0SAndy Whitcroft #print "==>$rawline\n"; 1486773647a0SAndy Whitcroft #print "-->$line\n"; 1487de7d4f0eSAndy Whitcroft 1488de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1489de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1490de7d4f0eSAndy Whitcroft } 1491de7d4f0eSAndy Whitcroft } 1492de7d4f0eSAndy Whitcroft 14936c72ffaaSAndy Whitcroft $prefix = ''; 14946c72ffaaSAndy Whitcroft 1495773647a0SAndy Whitcroft $realcnt = 0; 1496773647a0SAndy Whitcroft $linenr = 0; 14970a920b5bSAndy Whitcroft foreach my $line (@lines) { 14980a920b5bSAndy Whitcroft $linenr++; 14990a920b5bSAndy Whitcroft 1500c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 15016c72ffaaSAndy Whitcroft 15020a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 15036c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 15040a920b5bSAndy Whitcroft $is_patch = 1; 15054a0df2efSAndy Whitcroft $first_line = $linenr + 1; 15060a920b5bSAndy Whitcroft $realline=$1-1; 15070a920b5bSAndy Whitcroft if (defined $2) { 15080a920b5bSAndy Whitcroft $realcnt=$3+1; 15090a920b5bSAndy Whitcroft } else { 15100a920b5bSAndy Whitcroft $realcnt=1+1; 15110a920b5bSAndy Whitcroft } 1512c2fdda0dSAndy Whitcroft annotate_reset(); 151313214adfSAndy Whitcroft $prev_values = 'E'; 151413214adfSAndy Whitcroft 1515773647a0SAndy Whitcroft %suppress_ifbraces = (); 1516170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 15172b474a1aSAndy Whitcroft %suppress_export = (); 15183e469cdcSAndy Whitcroft $suppress_statement = 0; 15190a920b5bSAndy Whitcroft next; 15200a920b5bSAndy Whitcroft 15214a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 15224a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 15234a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1524773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 15250a920b5bSAndy Whitcroft $realline++; 1526d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 15270a920b5bSAndy Whitcroft 15284a0df2efSAndy Whitcroft # Measure the line length and indent. 1529c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 15300a920b5bSAndy Whitcroft 15310a920b5bSAndy Whitcroft # Track the previous line. 15320a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 15330a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1534c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1535c2fdda0dSAndy Whitcroft 1536773647a0SAndy Whitcroft #warn "line<$line>\n"; 15376c72ffaaSAndy Whitcroft 1538d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1539d8aaf121SAndy Whitcroft $realcnt--; 15400a920b5bSAndy Whitcroft } 15410a920b5bSAndy Whitcroft 1542cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1543cc77cdcaSAndy Whitcroft 15440a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1545773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1546773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1547773647a0SAndy Whitcroft 15486c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15496c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1550773647a0SAndy Whitcroft 1551773647a0SAndy Whitcroft # extract the filename as it passes 15523bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15533bf9a009SRabin Vincent $realfile = $1; 15543bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1555270c49a0SJoe Perches $in_commit_log = 0; 15563bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1557773647a0SAndy Whitcroft $realfile = $1; 15581e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1559270c49a0SJoe Perches $in_commit_log = 0; 15601e855726SWolfram Sang 15611e855726SWolfram Sang $p1_prefix = $1; 1562e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1563e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1564000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1565000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15661e855726SWolfram Sang } 1567773647a0SAndy Whitcroft 1568c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1569000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1570000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1571773647a0SAndy Whitcroft } 1572773647a0SAndy Whitcroft next; 1573773647a0SAndy Whitcroft } 1574773647a0SAndy Whitcroft 1575389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15760a920b5bSAndy Whitcroft 1577c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1578c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1579c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15800a920b5bSAndy Whitcroft 15816c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15826c72ffaaSAndy Whitcroft 15833bf9a009SRabin Vincent# Check for incorrect file permissions 15843bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15853bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 158604db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 158704db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1588000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1589000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15903bf9a009SRabin Vincent } 15913bf9a009SRabin Vincent } 15923bf9a009SRabin Vincent 159320112475SJoe Perches# Check the patch for a signoff: 1594d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15954a0df2efSAndy Whitcroft $signoff++; 159615662b3eSJoe Perches $in_commit_log = 0; 15970a920b5bSAndy Whitcroft } 159820112475SJoe Perches 159920112475SJoe Perches# Check signature styles 1600270c49a0SJoe Perches if (!$in_header_lines && 1601ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 160220112475SJoe Perches my $space_before = $1; 160320112475SJoe Perches my $sign_off = $2; 160420112475SJoe Perches my $space_after = $3; 160520112475SJoe Perches my $email = $4; 160620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 160720112475SJoe Perches 1608ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1609ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1610ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1611ce0338dfSJoe Perches } 161220112475SJoe Perches if (defined $space_before && $space_before ne "") { 1613000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1614000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 161520112475SJoe Perches } 161620112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1617000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1618000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 161920112475SJoe Perches } 162020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1621000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1622000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 162320112475SJoe Perches } 162420112475SJoe Perches 162520112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 162620112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 162720112475SJoe Perches if ($suggested_email eq "") { 1628000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1629000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 163020112475SJoe Perches } else { 163120112475SJoe Perches my $dequoted = $suggested_email; 163220112475SJoe Perches $dequoted =~ s/^"//; 163320112475SJoe Perches $dequoted =~ s/" </ </; 163420112475SJoe Perches # Don't force email to have quotes 163520112475SJoe Perches # Allow just an angle bracketed address 163620112475SJoe Perches if ("$dequoted$comment" ne $email && 163720112475SJoe Perches "<$email_address>$comment" ne $email && 163820112475SJoe Perches "$suggested_email$comment" ne $email) { 1639000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1640000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 164120112475SJoe Perches } 16420a920b5bSAndy Whitcroft } 16430a920b5bSAndy Whitcroft } 16440a920b5bSAndy Whitcroft 164500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 16468905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1647000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1648000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 16496c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1650de7d4f0eSAndy Whitcroft } 1651de7d4f0eSAndy Whitcroft 16526ecd9674SAndy Whitcroft# Check for absolute kernel paths. 16536ecd9674SAndy Whitcroft if ($tree) { 16546ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 16556ecd9674SAndy Whitcroft my $file = $1; 16566ecd9674SAndy Whitcroft 16576ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16586ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16596ecd9674SAndy Whitcroft # 16606ecd9674SAndy Whitcroft } else { 16616ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16626ecd9674SAndy Whitcroft } 16636ecd9674SAndy Whitcroft } 16646ecd9674SAndy Whitcroft } 16656ecd9674SAndy Whitcroft 1666de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1667de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1668171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1669171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1670171ae1a4SAndy Whitcroft 1671171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1672171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1673171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1674171ae1a4SAndy Whitcroft 167534d99219SJoe Perches CHK("INVALID_UTF8", 1676000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 167700df344fSAndy Whitcroft } 16780a920b5bSAndy Whitcroft 167915662b3eSJoe Perches# Check if it's the start of a commit log 168015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 168115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1682270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 168315662b3eSJoe Perches $in_header_lines = 0; 168415662b3eSJoe Perches $in_commit_log = 1; 168515662b3eSJoe Perches } 168615662b3eSJoe Perches 1687fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1688fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1689fa64205dSPasi Savanainen if ($in_header_lines && 1690fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1691fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1692fa64205dSPasi Savanainen $non_utf8_charset = 1; 1693fa64205dSPasi Savanainen } 1694fa64205dSPasi Savanainen 1695fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 169615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1697fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 169815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 169915662b3eSJoe Perches } 170015662b3eSJoe Perches 170130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 170230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 170300df344fSAndy Whitcroft 17040a920b5bSAndy Whitcroft#trailing whitespace 17059c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1706c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1707000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1708000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 17099c0ca6f9SAndy Whitcroft 1710c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1711c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1712000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1713000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1714d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17150a920b5bSAndy Whitcroft } 17165368df20SAndy Whitcroft 17173354957aSAndi Kleen# check for Kconfig help text having a real description 17189fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 17199fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 17203354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1721a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 17223354957aSAndi Kleen my $length = 0; 17239fe287d7SAndy Whitcroft my $cnt = $realcnt; 17249fe287d7SAndy Whitcroft my $ln = $linenr + 1; 17259fe287d7SAndy Whitcroft my $f; 1726a1385803SAndy Whitcroft my $is_start = 0; 17279fe287d7SAndy Whitcroft my $is_end = 0; 1728a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 17299fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 17309fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 17319fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 17329fe287d7SAndy Whitcroft 17339fe287d7SAndy Whitcroft next if ($f =~ /^-/); 1734a1385803SAndy Whitcroft 1735a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1736a1385803SAndy Whitcroft $is_start = 1; 1737a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1738a1385803SAndy Whitcroft $length = -1; 1739a1385803SAndy Whitcroft } 1740a1385803SAndy Whitcroft 17419fe287d7SAndy Whitcroft $f =~ s/^.//; 17423354957aSAndi Kleen $f =~ s/#.*//; 17433354957aSAndi Kleen $f =~ s/^\s+//; 17443354957aSAndi Kleen next if ($f =~ /^$/); 17459fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 17469fe287d7SAndy Whitcroft $is_end = 1; 17479fe287d7SAndy Whitcroft last; 17489fe287d7SAndy Whitcroft } 17493354957aSAndi Kleen $length++; 17503354957aSAndi Kleen } 1751000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1752a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 1753a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 17543354957aSAndi Kleen } 17553354957aSAndi Kleen 17561ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 17571ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 17581ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 17591ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 17601ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 17611ba8dfd1SKees Cook } 17621ba8dfd1SKees Cook 1763c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1764c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1765c68e5878SArnaud Lacombe my $flag = $1; 1766c68e5878SArnaud Lacombe my $replacement = { 1767c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1768c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1769c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1770c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1771c68e5878SArnaud Lacombe }; 1772c68e5878SArnaud Lacombe 1773c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1774c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1775c68e5878SArnaud Lacombe } 1776c68e5878SArnaud Lacombe 17775368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 17785368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 17795368df20SAndy Whitcroft 17806cd7f386SJoe Perches#line length limit 1781c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1782f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 17830fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 17848bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 17856cd7f386SJoe Perches $length > $max_line_length) 1786c45dcabdSAndy Whitcroft { 1787000d1cc1SJoe Perches WARN("LONG_LINE", 17886cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 17890a920b5bSAndy Whitcroft } 17900a920b5bSAndy Whitcroft 1791ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 1792ca56dc09SJosh Triplett# to grep for the string. Limited to strings used as parameters (those 1793ca56dc09SJosh Triplett# following an open parenthesis), which almost completely eliminates false 1794ca56dc09SJosh Triplett# positives, as well as warning only once per parameter rather than once per 1795ca56dc09SJosh Triplett# line of the string. Make an exception when the previous string ends in a 1796ca56dc09SJosh Triplett# newline (multiple lines in one string constant) or \n\t (common in inline 1797ca56dc09SJosh Triplett# assembly to indent the instruction on the following line). 1798ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 1799ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 1800ca56dc09SJosh Triplett $prevline =~ /\(/ && 1801ca56dc09SJosh Triplett $prevrawline !~ /\\n(?:\\t)*"\s*$/) { 1802ca56dc09SJosh Triplett WARN("SPLIT_STRING", 1803ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 1804ca56dc09SJosh Triplett } 1805ca56dc09SJosh Triplett 18065e79d96eSJoe Perches# check for spaces before a quoted newline 18075e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1808000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1809000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 18105e79d96eSJoe Perches } 18115e79d96eSJoe Perches 18128905a67cSAndy Whitcroft# check for adding lines without a newline. 18138905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1814000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1815000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 18168905a67cSAndy Whitcroft } 18178905a67cSAndy Whitcroft 181842e41c54SMike Frysinger# Blackfin: use hi/lo macros 181942e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 182042e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 182142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1822000d1cc1SJoe Perches ERROR("LO_MACRO", 1823000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 182442e41c54SMike Frysinger } 182542e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 182642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1827000d1cc1SJoe Perches ERROR("HI_MACRO", 1828000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 182942e41c54SMike Frysinger } 183042e41c54SMike Frysinger } 183142e41c54SMike Frysinger 1832b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1833b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 18340a920b5bSAndy Whitcroft 18350a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 18360a920b5bSAndy Whitcroft# more than 8 must use tabs. 1837c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1838c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1839c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1840000d1cc1SJoe Perches ERROR("CODE_INDENT", 1841000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1842d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 18430a920b5bSAndy Whitcroft } 18440a920b5bSAndy Whitcroft 184508e44365SAlberto Panizzo# check for space before tabs. 184608e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 184708e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1848000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1849000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 185008e44365SAlberto Panizzo } 185108e44365SAlberto Panizzo 1852d1fe9c09SJoe Perches# check for && or || at the start of a line 1853d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 1854d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 1855d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 1856d1fe9c09SJoe Perches } 1857d1fe9c09SJoe Perches 1858d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 1859d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 1860d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 1861d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 1862d1fe9c09SJoe Perches my $oldindent = $1; 1863d1fe9c09SJoe Perches my $rest = $2; 1864d1fe9c09SJoe Perches 1865d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 1866d1fe9c09SJoe Perches if ($pos >= 0) { 1867b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 1868b34a26f3SJoe Perches my $newindent = $2; 1869d1fe9c09SJoe Perches 1870d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 1871d1fe9c09SJoe Perches "\t" x ($pos / 8) . 1872d1fe9c09SJoe Perches " " x ($pos % 8); 1873d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 1874d1fe9c09SJoe Perches 1875d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 1876d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 1877d1fe9c09SJoe Perches CHK("PARENTHESIS_ALIGNMENT", 1878d1fe9c09SJoe Perches "Alignment should match open parenthesis\n" . $hereprev); 1879d1fe9c09SJoe Perches } 1880d1fe9c09SJoe Perches } 1881d1fe9c09SJoe Perches } 1882d1fe9c09SJoe Perches 1883aad4f614SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) { 1884aad4f614SJoe Perches CHK("SPACING", 1885aad4f614SJoe Perches "No space is necessary after a cast\n" . $hereprev); 1886aad4f614SJoe Perches } 1887aad4f614SJoe Perches 188805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 188905880600SJoe Perches $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 189005880600SJoe Perches $prevrawline =~ /^\+[ \t]*$/) { 189105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 189205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 189305880600SJoe Perches } 189405880600SJoe Perches 189505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 1896c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 1897c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 1898c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 1899c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 190005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 190105880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 190205880600SJoe Perches } 190305880600SJoe Perches 19045f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 19056b4c5bebSAndy Whitcroft# Exceptions: 19066b4c5bebSAndy Whitcroft# 1) within comments 19076b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 19086b4c5bebSAndy Whitcroft# 3) hanging labels 19096b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 19105f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1911000d1cc1SJoe Perches WARN("LEADING_SPACE", 1912000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 19135f7ddae6SRaffaele Recalcati } 19145f7ddae6SRaffaele Recalcati 1915b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1916b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1917b9ea10d6SAndy Whitcroft 19181ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 19191ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 19201ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 19211ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 19221ba8dfd1SKees Cook } 19231ba8dfd1SKees Cook 1924c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1925cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1926000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1927000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1928c2fdda0dSAndy Whitcroft } 192922f2a2efSAndy Whitcroft 193042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 193142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 193242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1933000d1cc1SJoe Perches ERROR("CSYNC", 1934000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 193542e41c54SMike Frysinger } 193642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 193742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1938000d1cc1SJoe Perches ERROR("SSYNC", 1939000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 194042e41c54SMike Frysinger } 194142e41c54SMike Frysinger 194256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 194356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 194456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 194556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 194656e77d70SJoe Perches } 194756e77d70SJoe Perches 19489c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 19492b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 19502b474a1aSAndy Whitcroft $realline_next); 19513e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 19523e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 19533e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 1954170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1955f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1956171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1957171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1958171ae1a4SAndy Whitcroft 19593e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 19603e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 19613e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 19623e469cdcSAndy Whitcroft # until we hit end of it. 19633e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 19643e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 19653e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 19663e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 19673e469cdcSAndy Whitcroft } 1968f74bd194SAndy Whitcroft 19692b474a1aSAndy Whitcroft # Find the real next line. 19702b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 19712b474a1aSAndy Whitcroft if (defined $realline_next && 19722b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 19732b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 19742b474a1aSAndy Whitcroft $realline_next++; 19752b474a1aSAndy Whitcroft } 19762b474a1aSAndy Whitcroft 1977171ae1a4SAndy Whitcroft my $s = $stat; 1978171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1979cf655043SAndy Whitcroft 1980c2fdda0dSAndy Whitcroft # Ignore goto labels. 1981171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1982c2fdda0dSAndy Whitcroft 1983c2fdda0dSAndy Whitcroft # Ignore functions being called 1984171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1985c2fdda0dSAndy Whitcroft 1986463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1987463f2864SAndy Whitcroft 1988c45dcabdSAndy Whitcroft # declarations always start with types 1989d2506586SAndy 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) { 1990c45dcabdSAndy Whitcroft my $type = $1; 1991c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1992c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1993c45dcabdSAndy Whitcroft 19946c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1995a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1996c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1997c2fdda0dSAndy Whitcroft } 19988905a67cSAndy Whitcroft 19996c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 200065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2001c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 20029c0ca6f9SAndy Whitcroft } 20038905a67cSAndy Whitcroft 20048905a67cSAndy Whitcroft # Check for any sort of function declaration. 20058905a67cSAndy Whitcroft # int foo(something bar, other baz); 20068905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2007171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 20088905a67cSAndy Whitcroft my ($name_len) = length($1); 20098905a67cSAndy Whitcroft 2010cf655043SAndy Whitcroft my $ctx = $s; 2011773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 20128905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2013cf655043SAndy Whitcroft 20148905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2015c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 20168905a67cSAndy Whitcroft 2017c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 20188905a67cSAndy Whitcroft } 20198905a67cSAndy Whitcroft } 20208905a67cSAndy Whitcroft } 20218905a67cSAndy Whitcroft 20229c0ca6f9SAndy Whitcroft } 20239c0ca6f9SAndy Whitcroft 202400df344fSAndy Whitcroft# 202500df344fSAndy Whitcroft# Checks which may be anchored in the context. 202600df344fSAndy Whitcroft# 202700df344fSAndy Whitcroft 202800df344fSAndy Whitcroft# Check for switch () and associated case and default 202900df344fSAndy Whitcroft# statements should be at the same indent. 203000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 203100df344fSAndy Whitcroft my $err = ''; 203200df344fSAndy Whitcroft my $sep = ''; 203300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 203400df344fSAndy Whitcroft shift(@ctx); 203500df344fSAndy Whitcroft for my $ctx (@ctx) { 203600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 203700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 203800df344fSAndy Whitcroft $indent != $cindent) { 203900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 204000df344fSAndy Whitcroft $sep = ''; 204100df344fSAndy Whitcroft } else { 204200df344fSAndy Whitcroft $sep = "[...]\n"; 204300df344fSAndy Whitcroft } 204400df344fSAndy Whitcroft } 204500df344fSAndy Whitcroft if ($err ne '') { 2046000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2047000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2048de7d4f0eSAndy Whitcroft } 2049de7d4f0eSAndy Whitcroft } 2050de7d4f0eSAndy Whitcroft 2051de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2052de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2053c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2054773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2055773647a0SAndy Whitcroft 20569c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 20578eef05ddSJoe Perches 20588eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 20598eef05ddSJoe Perches WARN("DEEP_INDENTATION", 20608eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 20618eef05ddSJoe Perches } 20628eef05ddSJoe Perches 2063de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2064de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2065de7d4f0eSAndy Whitcroft 2066548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2067548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2068de7d4f0eSAndy Whitcroft 2069548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2070548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2071548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2072548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2073548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2074773647a0SAndy Whitcroft $ctx_ln++; 2075773647a0SAndy Whitcroft } 2076548596d5SAndy Whitcroft 207753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 207853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2079773647a0SAndy Whitcroft 2080773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2081000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2082000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 208301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 208400df344fSAndy Whitcroft } 2085773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2086773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2087773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2088773647a0SAndy Whitcroft { 20899c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 20909c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2091000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2092000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 209301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 20949c0ca6f9SAndy Whitcroft } 20959c0ca6f9SAndy Whitcroft } 209600df344fSAndy Whitcroft } 209700df344fSAndy Whitcroft 20984d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 20994d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 21003e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 21013e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 21023e469cdcSAndy Whitcroft if (!defined $stat); 21034d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 21044d001e4dSAndy Whitcroft 21054d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 21064d001e4dSAndy Whitcroft 21074d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 21084d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 21094d001e4dSAndy Whitcroft # where necessary. 21104d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 21114d001e4dSAndy Whitcroft 21124d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 21136f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 21146f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 21154d001e4dSAndy Whitcroft 21164d001e4dSAndy Whitcroft # We want to check the first line inside the block 21174d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 21184d001e4dSAndy Whitcroft # 1) any blank line termination 21194d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 21204d001e4dSAndy Whitcroft # 3) any do (...) { 21214d001e4dSAndy Whitcroft my $continuation = 0; 21224d001e4dSAndy Whitcroft my $check = 0; 21234d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 21244d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 21254d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 21264d001e4dSAndy Whitcroft $continuation = 1; 21274d001e4dSAndy Whitcroft } 21289bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 21294d001e4dSAndy Whitcroft $check = 1; 21304d001e4dSAndy Whitcroft $cond_lines++; 21314d001e4dSAndy Whitcroft } 21324d001e4dSAndy Whitcroft 21334d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 21344d001e4dSAndy Whitcroft # preprocessor statement. 21354d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 21364d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 21374d001e4dSAndy Whitcroft $check = 0; 21384d001e4dSAndy Whitcroft } 21394d001e4dSAndy Whitcroft 21409bd49efeSAndy Whitcroft my $cond_ptr = -1; 2141740504c6SAndy Whitcroft $continuation = 0; 21429bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 21439bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 21444d001e4dSAndy Whitcroft 2145f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2146f16fa28fSAndy Whitcroft # is not linear. 2147f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2148f16fa28fSAndy Whitcroft $check = 0; 2149f16fa28fSAndy Whitcroft } 2150f16fa28fSAndy Whitcroft 21519bd49efeSAndy Whitcroft # Ignore: 21529bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 21539bd49efeSAndy Whitcroft # 2) preprocessor lines, and 21549bd49efeSAndy Whitcroft # 3) labels. 2155740504c6SAndy Whitcroft if ($continuation || 2156740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 21579bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 21589bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2159740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 216030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 21619bd49efeSAndy Whitcroft $cond_lines++; 21629bd49efeSAndy Whitcroft } 21634d001e4dSAndy Whitcroft } 216430dad6ebSAndy Whitcroft } 21654d001e4dSAndy Whitcroft 21664d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 21674d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 21684d001e4dSAndy Whitcroft 21694d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 21704d001e4dSAndy Whitcroft # this is not this patch's fault. 21714d001e4dSAndy Whitcroft if (!defined($stat_real) || 21724d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 21734d001e4dSAndy Whitcroft $check = 0; 21744d001e4dSAndy Whitcroft } 21754d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 21764d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 21774d001e4dSAndy Whitcroft } 21784d001e4dSAndy Whitcroft 21799bd49efeSAndy 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"; 21804d001e4dSAndy Whitcroft 21814d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 21824d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2183000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2184000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 21854d001e4dSAndy Whitcroft } 21864d001e4dSAndy Whitcroft } 21874d001e4dSAndy Whitcroft 21886c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 21896c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 21901f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 21911f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 21926c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2193c2fdda0dSAndy Whitcroft if ($dbg_values) { 2194c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2195cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2196cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 21971f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2198c2fdda0dSAndy Whitcroft } 21996c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 22006c72ffaaSAndy Whitcroft 220100df344fSAndy Whitcroft#ignore lines not being added 220200df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 220300df344fSAndy Whitcroft 2204653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 22057429c690SAndy Whitcroft if ($dbg_type) { 22067429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2207000d1cc1SJoe Perches ERROR("TEST_TYPE", 2208000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 22097429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2210000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2211000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 22127429c690SAndy Whitcroft } 2213653d4876SAndy Whitcroft next; 2214653d4876SAndy Whitcroft } 2215a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2216a1ef277eSAndy Whitcroft if ($dbg_attr) { 22179360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2218000d1cc1SJoe Perches ERROR("TEST_ATTR", 2219000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 22209360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2221000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2222000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2223a1ef277eSAndy Whitcroft } 2224a1ef277eSAndy Whitcroft next; 2225a1ef277eSAndy Whitcroft } 2226653d4876SAndy Whitcroft 2227f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 222899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 222999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2230000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2231000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2232f0a594c1SAndy Whitcroft } 2233f0a594c1SAndy Whitcroft 223400df344fSAndy Whitcroft# 223500df344fSAndy Whitcroft# Checks which are anchored on the added line. 223600df344fSAndy Whitcroft# 223700df344fSAndy Whitcroft 2238653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2239c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2240653d4876SAndy Whitcroft my $path = $1; 2241653d4876SAndy Whitcroft if ($path =~ m{//}) { 2242000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2243495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2244495e9d84SJoe Perches } 2245495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2246495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2247495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2248653d4876SAndy Whitcroft } 2249653d4876SAndy Whitcroft } 2250653d4876SAndy Whitcroft 225100df344fSAndy Whitcroft# no C99 // comments 225200df344fSAndy Whitcroft if ($line =~ m{//}) { 2253000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2254000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 225500df344fSAndy Whitcroft } 225600df344fSAndy Whitcroft # Remove C99 comments. 22570a920b5bSAndy Whitcroft $line =~ s@//.*@@; 22586c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 22590a920b5bSAndy Whitcroft 22602b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 22612b474a1aSAndy Whitcroft# the whole statement. 22622b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 22632b474a1aSAndy Whitcroft if (defined $realline_next && 22642b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 22652b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 22662b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22672b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22683cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 22693cbf62dfSAndy Whitcroft # a prefix: 22703cbf62dfSAndy Whitcroft # XXX(foo); 22713cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2272653d4876SAndy Whitcroft my $name = $1; 227387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 22743cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 22753cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 22763cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 22773cbf62dfSAndy Whitcroft 22783cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 22792b474a1aSAndy Whitcroft \n.}\s*$| 228048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 228148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 228248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 22832b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 22842b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 228548012058SAndy Whitcroft )/x) { 22862b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 22872b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 22882b474a1aSAndy Whitcroft } else { 22892b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 22900a920b5bSAndy Whitcroft } 22910a920b5bSAndy Whitcroft } 22922b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 22932b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 22942b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22952b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22962b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 22972b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 22982b474a1aSAndy Whitcroft } 22992b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 23002b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2301000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2302000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 23032b474a1aSAndy Whitcroft } 23040a920b5bSAndy Whitcroft 23055150bda4SJoe Eloff# check for global initialisers. 2306c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2307000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2308000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2309f0a594c1SAndy Whitcroft $herecurr); 2310f0a594c1SAndy Whitcroft } 23110a920b5bSAndy Whitcroft# check for static initialisers. 23122d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2313000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2314000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2315de7d4f0eSAndy Whitcroft $herecurr); 23160a920b5bSAndy Whitcroft } 23170a920b5bSAndy Whitcroft 2318cb710ecaSJoe Perches# check for static const char * arrays. 2319cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2320000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2321000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2322cb710ecaSJoe Perches $herecurr); 2323cb710ecaSJoe Perches } 2324cb710ecaSJoe Perches 2325cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2326cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2327000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2328000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2329cb710ecaSJoe Perches $herecurr); 2330cb710ecaSJoe Perches } 2331cb710ecaSJoe Perches 233293ed0e2dSJoe Perches# check for declarations of struct pci_device_id 233393ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2334000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2335000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 233693ed0e2dSJoe Perches } 233793ed0e2dSJoe Perches 2338653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2339653d4876SAndy Whitcroft# make sense. 2340653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 23418054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2342c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 23438ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2344653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2345000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2346000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 23470a920b5bSAndy Whitcroft } 23480a920b5bSAndy Whitcroft 23490a920b5bSAndy Whitcroft# * goes on variable not on type 235065863862SAndy Whitcroft # (char*[ const]) 2351bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2352bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 2353bfcb2cc7SAndy Whitcroft my ($from, $to) = ($2, $2); 2354d8aaf121SAndy Whitcroft 235565863862SAndy Whitcroft # Should start with a space. 235665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 235765863862SAndy Whitcroft # Should not end with a space. 235865863862SAndy Whitcroft $to =~ s/\s+$//; 235965863862SAndy Whitcroft # '*'s should not have spaces between. 2360f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 236165863862SAndy Whitcroft } 2362d8aaf121SAndy Whitcroft 236365863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 236465863862SAndy Whitcroft if ($from ne $to) { 2365000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2366000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 236765863862SAndy Whitcroft } 2368bfcb2cc7SAndy Whitcroft } 2369bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2370bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 2371bfcb2cc7SAndy Whitcroft my ($from, $to, $ident) = ($2, $2, $3); 2372d8aaf121SAndy Whitcroft 237365863862SAndy Whitcroft # Should start with a space. 237465863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 237565863862SAndy Whitcroft # Should not end with a space. 237665863862SAndy Whitcroft $to =~ s/\s+$//; 237765863862SAndy Whitcroft # '*'s should not have spaces between. 2378f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 237965863862SAndy Whitcroft } 238065863862SAndy Whitcroft # Modifiers should have spaces. 238165863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 238265863862SAndy Whitcroft 2383667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2384667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2385000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2386000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 238765863862SAndy Whitcroft } 23880a920b5bSAndy Whitcroft } 23890a920b5bSAndy Whitcroft 23900a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 23910a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 23920a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 23930a920b5bSAndy Whitcroft# print "$herecurr"; 23940a920b5bSAndy Whitcroft# $clean = 0; 23950a920b5bSAndy Whitcroft# } 23960a920b5bSAndy Whitcroft 23978905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2398000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2399000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 24008905a67cSAndy Whitcroft } 24018905a67cSAndy Whitcroft 240217441227SJoe Perches# check for uses of printk_ratelimit 240317441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2404000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2405000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 240617441227SJoe Perches } 240717441227SJoe Perches 240800df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 240900df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 241000df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 241125985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 241200df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2413f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 241400df344fSAndy Whitcroft my $ok = 0; 241500df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 241600df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 241725985edcSLucas De Marchi # we have a preceding printk if it ends 241800df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 241900df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 242000df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 242100df344fSAndy Whitcroft $ok = 1; 242200df344fSAndy Whitcroft } 242300df344fSAndy Whitcroft last; 242400df344fSAndy Whitcroft } 242500df344fSAndy Whitcroft } 242600df344fSAndy Whitcroft if ($ok == 0) { 2427000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2428000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 24290a920b5bSAndy Whitcroft } 243000df344fSAndy Whitcroft } 24310a920b5bSAndy Whitcroft 2432243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2433243f3803SJoe Perches my $orig = $1; 2434243f3803SJoe Perches my $level = lc($orig); 2435243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 24368f26b837SJoe Perches my $level2 = $level; 24378f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2438243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 24398f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2440243f3803SJoe Perches } 2441243f3803SJoe Perches 2442243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2443243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2444243f3803SJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); 2445243f3803SJoe Perches } 2446243f3803SJoe Perches 2447dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2448dc139313SJoe Perches my $orig = $1; 2449dc139313SJoe Perches my $level = lc($orig); 2450dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2451dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2452dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2453dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2454dc139313SJoe Perches } 2455dc139313SJoe Perches 2456653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2457653d4876SAndy Whitcroft# or if closed on same line 2458c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2459c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2460000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2461000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 24620a920b5bSAndy Whitcroft } 2463653d4876SAndy Whitcroft 24648905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 24658905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 24668905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2467000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2468000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 24698905a67cSAndy Whitcroft } 24708905a67cSAndy Whitcroft 24710c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 24720c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2473000d1cc1SJoe Perches WARN("SPACING", 2474000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 24750c73b4ebSAndy Whitcroft } 24760c73b4ebSAndy Whitcroft 24778d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 24788d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2479fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2480fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 24818d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 24828d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 24838d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2484fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2485daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 2486000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2487000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 24888d31cfceSAndy Whitcroft } 24898d31cfceSAndy Whitcroft } 24908d31cfceSAndy Whitcroft 2491f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 24926c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2493c2fdda0dSAndy Whitcroft my $name = $1; 2494773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2495773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2496c2fdda0dSAndy Whitcroft 2497c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2498773647a0SAndy Whitcroft if ($name =~ /^(?: 2499773647a0SAndy Whitcroft if|for|while|switch|return|case| 2500773647a0SAndy Whitcroft volatile|__volatile__| 2501773647a0SAndy Whitcroft __attribute__|format|__extension__| 2502773647a0SAndy Whitcroft asm|__asm__)$/x) 2503773647a0SAndy Whitcroft { 2504c2fdda0dSAndy Whitcroft 2505c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2506c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2507c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2508c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2509773647a0SAndy Whitcroft 2510773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2511c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2512c2fdda0dSAndy Whitcroft 2513c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2514c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2515773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2516c2fdda0dSAndy Whitcroft 2517c2fdda0dSAndy Whitcroft } else { 2518000d1cc1SJoe Perches WARN("SPACING", 2519000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2520f0a594c1SAndy Whitcroft } 25216c72ffaaSAndy Whitcroft } 25229a4cad4eSEric Nelson 25239a4cad4eSEric Nelson# check for whitespace before a non-naked semicolon 25249a4cad4eSEric Nelson if ($line =~ /^\+.*\S\s+;/) { 25255646bc71SJoe Perches WARN("SPACING", 25269a4cad4eSEric Nelson "space prohibited before semicolon\n" . $herecurr); 25279a4cad4eSEric Nelson } 25289a4cad4eSEric Nelson 2529653d4876SAndy Whitcroft# Check operator spacing. 25300a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 25319c0ca6f9SAndy Whitcroft my $ops = qr{ 25329c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 25339c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 25349c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 25351f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 25361f65f947SAndy Whitcroft \?|: 25379c0ca6f9SAndy Whitcroft }x; 2538cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 253900df344fSAndy Whitcroft my $off = 0; 25406c72ffaaSAndy Whitcroft 25416c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 25426c72ffaaSAndy Whitcroft 25430a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 25444a0df2efSAndy Whitcroft $off += length($elements[$n]); 25454a0df2efSAndy Whitcroft 254625985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2547773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2548773647a0SAndy Whitcroft my $cc = ''; 2549773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2550773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2551773647a0SAndy Whitcroft } 2552773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2553773647a0SAndy Whitcroft 25544a0df2efSAndy Whitcroft my $a = ''; 25554a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 25564a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2557cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 25584a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 25594a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2560773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 25614a0df2efSAndy Whitcroft 25620a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 25634a0df2efSAndy Whitcroft 25644a0df2efSAndy Whitcroft my $c = ''; 25650a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 25664a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 25674a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2568cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 25694a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 25704a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 25718b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 25724a0df2efSAndy Whitcroft } else { 25734a0df2efSAndy Whitcroft $c = 'E'; 25740a920b5bSAndy Whitcroft } 25750a920b5bSAndy Whitcroft 25764a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 25774a0df2efSAndy Whitcroft 25784a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 25794a0df2efSAndy Whitcroft 25806c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2581de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 25820a920b5bSAndy Whitcroft 258374048ed8SAndy Whitcroft # Pull out the value of this operator. 25846c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 25850a920b5bSAndy Whitcroft 25861f65f947SAndy Whitcroft # Get the full operator variant. 25871f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 25881f65f947SAndy Whitcroft 258913214adfSAndy Whitcroft # Ignore operators passed as parameters. 259013214adfSAndy Whitcroft if ($op_type ne 'V' && 259113214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 259213214adfSAndy Whitcroft 2593cf655043SAndy Whitcroft# # Ignore comments 2594cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 259513214adfSAndy Whitcroft 2596d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 259713214adfSAndy Whitcroft } elsif ($op eq ';') { 2598cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2599cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2600000d1cc1SJoe Perches ERROR("SPACING", 2601000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2602d8aaf121SAndy Whitcroft } 2603d8aaf121SAndy Whitcroft 2604d8aaf121SAndy Whitcroft # // is a comment 2605d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 26060a920b5bSAndy Whitcroft 26071f65f947SAndy Whitcroft # No spaces for: 26081f65f947SAndy Whitcroft # -> 26091f65f947SAndy Whitcroft # : when part of a bitfield 26101f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 26114a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2612000d1cc1SJoe Perches ERROR("SPACING", 2613000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 26140a920b5bSAndy Whitcroft } 26150a920b5bSAndy Whitcroft 26160a920b5bSAndy Whitcroft # , must have a space on the right. 26170a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2618cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2619000d1cc1SJoe Perches ERROR("SPACING", 2620000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 26210a920b5bSAndy Whitcroft } 26220a920b5bSAndy Whitcroft 26239c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 262474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 26259c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 26269c0ca6f9SAndy Whitcroft 26279c0ca6f9SAndy Whitcroft # unary operators should have a space before and 26289c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 26299c0ca6f9SAndy Whitcroft # unary operator, or a cast 26309c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 263174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 26320d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2633cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2634000d1cc1SJoe Perches ERROR("SPACING", 2635000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 26360a920b5bSAndy Whitcroft } 2637a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2638171ae1a4SAndy Whitcroft # A unary '*' may be const 2639171ae1a4SAndy Whitcroft 2640171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2641000d1cc1SJoe Perches ERROR("SPACING", 2642000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 26430a920b5bSAndy Whitcroft } 26440a920b5bSAndy Whitcroft 26450a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 26460a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2647773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2648000d1cc1SJoe Perches ERROR("SPACING", 2649000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 26500a920b5bSAndy Whitcroft } 2651773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2652773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2653000d1cc1SJoe Perches ERROR("SPACING", 2654000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2655653d4876SAndy Whitcroft } 2656773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2657000d1cc1SJoe Perches ERROR("SPACING", 2658000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2659773647a0SAndy Whitcroft } 2660773647a0SAndy Whitcroft 26610a920b5bSAndy Whitcroft 26620a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 26639c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 26649c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 26659c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2666c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2667c2fdda0dSAndy Whitcroft $op eq '%') 26680a920b5bSAndy Whitcroft { 2669773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2670000d1cc1SJoe Perches ERROR("SPACING", 2671000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2672de7d4f0eSAndy Whitcroft $hereptr); 26730a920b5bSAndy Whitcroft } 26740a920b5bSAndy Whitcroft 26751f65f947SAndy Whitcroft # A colon needs no spaces before when it is 26761f65f947SAndy Whitcroft # terminating a case value or a label. 26771f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 26781f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2679000d1cc1SJoe Perches ERROR("SPACING", 2680000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 26811f65f947SAndy Whitcroft } 26821f65f947SAndy Whitcroft 26830a920b5bSAndy Whitcroft # All the others need spaces both sides. 2684cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 26851f65f947SAndy Whitcroft my $ok = 0; 26861f65f947SAndy Whitcroft 268722f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 26881f65f947SAndy Whitcroft if (($op eq '<' && 26891f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 26901f65f947SAndy Whitcroft ($op eq '>' && 26911f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 26921f65f947SAndy Whitcroft { 26931f65f947SAndy Whitcroft $ok = 1; 26941f65f947SAndy Whitcroft } 26951f65f947SAndy Whitcroft 26961f65f947SAndy Whitcroft # Ignore ?: 26971f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 26981f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 26991f65f947SAndy Whitcroft $ok = 1; 27001f65f947SAndy Whitcroft } 27011f65f947SAndy Whitcroft 27021f65f947SAndy Whitcroft if ($ok == 0) { 2703000d1cc1SJoe Perches ERROR("SPACING", 2704000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 27050a920b5bSAndy Whitcroft } 270622f2a2efSAndy Whitcroft } 27074a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 27080a920b5bSAndy Whitcroft } 27090a920b5bSAndy Whitcroft } 27100a920b5bSAndy Whitcroft 2711f0a594c1SAndy Whitcroft# check for multiple assignments 2712f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2713000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2714000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2715f0a594c1SAndy Whitcroft } 2716f0a594c1SAndy Whitcroft 271722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 271822f2a2efSAndy Whitcroft## # continuation. 271922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 272022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 272122f2a2efSAndy Whitcroft## 272222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 272322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 272422f2a2efSAndy Whitcroft## my $ln = $line; 272522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 272622f2a2efSAndy Whitcroft## } 272722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2728000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2729000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 273022f2a2efSAndy Whitcroft## } 273122f2a2efSAndy Whitcroft## } 2732f0a594c1SAndy Whitcroft 27330a920b5bSAndy Whitcroft#need space before brace following if, while, etc 273422f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 273522f2a2efSAndy Whitcroft $line =~ /do{/) { 2736000d1cc1SJoe Perches ERROR("SPACING", 2737000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2738de7d4f0eSAndy Whitcroft } 2739de7d4f0eSAndy Whitcroft 2740de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2741de7d4f0eSAndy Whitcroft# on the line 2742de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2743000d1cc1SJoe Perches ERROR("SPACING", 2744000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 27450a920b5bSAndy Whitcroft } 27460a920b5bSAndy Whitcroft 274722f2a2efSAndy Whitcroft# check spacing on square brackets 274822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2749000d1cc1SJoe Perches ERROR("SPACING", 2750000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 275122f2a2efSAndy Whitcroft } 275222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2753000d1cc1SJoe Perches ERROR("SPACING", 2754000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 275522f2a2efSAndy Whitcroft } 275622f2a2efSAndy Whitcroft 2757c45dcabdSAndy Whitcroft# check spacing on parentheses 27589c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 27599c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2760000d1cc1SJoe Perches ERROR("SPACING", 2761000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 276222f2a2efSAndy Whitcroft } 276313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2764c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2765c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2766000d1cc1SJoe Perches ERROR("SPACING", 2767000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 276822f2a2efSAndy Whitcroft } 276922f2a2efSAndy Whitcroft 27700a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 27714a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 27720a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2773000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2774000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 27750a920b5bSAndy Whitcroft } 27760a920b5bSAndy Whitcroft 2777c45dcabdSAndy Whitcroft# Return is not a function. 2778c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2779c45dcabdSAndy Whitcroft my $spacing = $1; 2780c45dcabdSAndy Whitcroft my $value = $2; 2781c45dcabdSAndy Whitcroft 278286f9d059SAndy Whitcroft # Flatten any parentheses 2783fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2784fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 2785e01886adSAndy Whitcroft while ($value =~ s/\[[^\[\]]*\]/1/ || 278663f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 278763f17f89SAndy Whitcroft $Compare\s* 278863f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 278963f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2790c45dcabdSAndy Whitcroft } 2791fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2792fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2793000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2794000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2795c45dcabdSAndy Whitcroft 2796c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2797000d1cc1SJoe Perches ERROR("SPACING", 2798000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2799c45dcabdSAndy Whitcroft } 2800c45dcabdSAndy Whitcroft } 280153a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 280253a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 280353a3c448SAndy Whitcroft my $name = $1; 280453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2805000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2806000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 280753a3c448SAndy Whitcroft } 280853a3c448SAndy Whitcroft } 2809c45dcabdSAndy Whitcroft 28100a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 28114a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2812000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 28130a920b5bSAndy Whitcroft } 28140a920b5bSAndy Whitcroft 2815f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2816f5fe35ddSAndy Whitcroft# statements after the conditional. 2817170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 28183e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 28193e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 28203e469cdcSAndy Whitcroft if (!defined $stat); 2821170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2822170d3a22SAndy Whitcroft $remain_next, $off_next); 2823170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2824170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2825170d3a22SAndy Whitcroft 2826170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2827170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2828170d3a22SAndy Whitcroft # then count those as offsets. 2829170d3a22SAndy Whitcroft my ($whitespace) = 2830170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2831170d3a22SAndy Whitcroft my $offset = 2832170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2833170d3a22SAndy Whitcroft 2834170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2835170d3a22SAndy Whitcroft $offset} = 1; 2836170d3a22SAndy Whitcroft } 2837170d3a22SAndy Whitcroft } 2838170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2839170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2840171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 28418905a67cSAndy Whitcroft 2842b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2843000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2844000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 28458905a67cSAndy Whitcroft } 28468905a67cSAndy Whitcroft 28478905a67cSAndy Whitcroft # Find out what is on the end of the line after the 28488905a67cSAndy Whitcroft # conditional. 2849773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 28508905a67cSAndy Whitcroft $s =~ s/\n.*//g; 285113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 285253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 285353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2854773647a0SAndy Whitcroft { 2855bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2856bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2857bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 285842bdf74cSHidetoshi Seto my $stat_real = ''; 2859bb44ad39SAndy Whitcroft 286042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 286142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2862bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2863bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2864bb44ad39SAndy Whitcroft } 2865bb44ad39SAndy Whitcroft 2866000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2867000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 28688905a67cSAndy Whitcroft } 28698905a67cSAndy Whitcroft } 28708905a67cSAndy Whitcroft 287113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 287213214adfSAndy Whitcroft if ($line =~ / 287313214adfSAndy Whitcroft (?: 287413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 287513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 287613214adfSAndy Whitcroft (?:\&\&|\|\|) 287713214adfSAndy Whitcroft | 287813214adfSAndy Whitcroft (?:\&\&|\|\|) 287913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 288013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 288113214adfSAndy Whitcroft )/x) 288213214adfSAndy Whitcroft { 2883000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2884000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 288513214adfSAndy Whitcroft } 288613214adfSAndy Whitcroft 28878905a67cSAndy Whitcroft# if and else should not have general statements after it 288813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 288913214adfSAndy Whitcroft my $s = $1; 289013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 289113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2892000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2893000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 28940a920b5bSAndy Whitcroft } 289513214adfSAndy Whitcroft } 289639667782SAndy Whitcroft# if should not continue a brace 289739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2898000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2899000d1cc1SJoe Perches "trailing statements should be on next line\n" . 290039667782SAndy Whitcroft $herecurr); 290139667782SAndy Whitcroft } 2902a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2903a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2904a1080bf8SAndy Whitcroft $line !~ /\G(?: 29053fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2906a1080bf8SAndy Whitcroft \s*return\s+ 2907a1080bf8SAndy Whitcroft )/xg) 2908a1080bf8SAndy Whitcroft { 2909000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2910000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2911a1080bf8SAndy Whitcroft } 29120a920b5bSAndy Whitcroft 29130a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 29140a920b5bSAndy Whitcroft # indent level to be relevant to each other. 29150a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 29160a920b5bSAndy Whitcroft $previndent == $indent) { 2917000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2918000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 29190a920b5bSAndy Whitcroft } 29200a920b5bSAndy Whitcroft 2921c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2922c2fdda0dSAndy Whitcroft $previndent == $indent) { 2923c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2924c2fdda0dSAndy Whitcroft 2925c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2926c2fdda0dSAndy Whitcroft # conditional. 2927773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2928c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2929c2fdda0dSAndy Whitcroft 2930c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2931000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2932000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2933c2fdda0dSAndy Whitcroft } 2934c2fdda0dSAndy Whitcroft } 2935c2fdda0dSAndy Whitcroft 2936323c1260SJoe Perches#CamelCase 2937323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 2938323c1260SJoe Perches my $var = $1; 2939323c1260SJoe Perches if ($var !~ /$Constant/ && 2940323c1260SJoe Perches $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ && 2941be987d9fSJoe Perches $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 2942323c1260SJoe Perches !defined $camelcase{$var}) { 2943323c1260SJoe Perches $camelcase{$var} = 1; 2944323c1260SJoe Perches WARN("CAMELCASE", 2945323c1260SJoe Perches "Avoid CamelCase: <$var>\n" . $herecurr); 2946323c1260SJoe Perches } 2947323c1260SJoe Perches } 29480a920b5bSAndy Whitcroft 29490a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2950c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2951000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2952000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 29530a920b5bSAndy Whitcroft } 29540a920b5bSAndy Whitcroft 2955653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2956c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2957e09dec48SAndy Whitcroft my $file = "$1.h"; 2958e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2959e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2960e09dec48SAndy Whitcroft $realfile ne $checkfile && 29617840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2962c45dcabdSAndy Whitcroft { 2963e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2964000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2965000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2966e09dec48SAndy Whitcroft } else { 2967000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2968000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2969e09dec48SAndy Whitcroft } 29700a920b5bSAndy Whitcroft } 29710a920b5bSAndy Whitcroft } 29720a920b5bSAndy Whitcroft 2973653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2974653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2975cf655043SAndy Whitcroft# in a known good container 2976b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2977b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2978d8aaf121SAndy Whitcroft my $ln = $linenr; 2979d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2980c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2981c45dcabdSAndy Whitcroft my $ctx = ''; 2982c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2983f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2984f74bd194SAndy Whitcroft $ctx = $dstat; 2985c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2986a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2987c45dcabdSAndy Whitcroft 2988f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2989292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2990c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2991c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2992c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2993c45dcabdSAndy Whitcroft 2994c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2995bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2996bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2997c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 2998bf30d6edSAndy Whitcroft { 2999c45dcabdSAndy Whitcroft } 3000c45dcabdSAndy Whitcroft 3001e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3002e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3003e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3004e45bab8eSAndy Whitcroft { 3005e45bab8eSAndy Whitcroft } 3006e45bab8eSAndy Whitcroft 3007c45dcabdSAndy Whitcroft my $exceptions = qr{ 3008c45dcabdSAndy Whitcroft $Declare| 3009c45dcabdSAndy Whitcroft module_param_named| 3010a0a0a7a9SKees Cook MODULE_PARM_DESC| 3011c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3012c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3013383099fdSAndy Whitcroft __typeof__\(| 301422fd2d3eSStefani Seibold union| 301522fd2d3eSStefani Seibold struct| 3016ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3017ea71a0a0SAndy Whitcroft ^\"|\"$ 3018c45dcabdSAndy Whitcroft }x; 30195eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3020f74bd194SAndy Whitcroft if ($dstat ne '' && 3021f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3022f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 3023fd1b57acSAndy Whitcroft $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo 3024b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3025f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3026f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3027e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 302872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3029f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3030f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3031f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3032f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 3033c45dcabdSAndy Whitcroft { 3034f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3035f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3036f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3037f74bd194SAndy Whitcroft 3038f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3039f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3040c45dcabdSAndy Whitcroft } 3041c45dcabdSAndy Whitcroft 3042f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3043f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3044f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3045f74bd194SAndy Whitcroft } else { 3046000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3047f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3048d8aaf121SAndy Whitcroft } 30490a920b5bSAndy Whitcroft } 30505023d347SJoe Perches 3051481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 30525023d347SJoe Perches 30535023d347SJoe Perches } else { 30545023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3055481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3056481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 30575023d347SJoe Perches $line =~ /^\+.*\\$/) { 30585023d347SJoe Perches WARN("LINE_CONTINUATIONS", 30595023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 30605023d347SJoe Perches } 3061653d4876SAndy Whitcroft } 30620a920b5bSAndy Whitcroft 3063b13edf7fSJoe Perches# do {} while (0) macro tests: 3064b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3065b13edf7fSJoe Perches# macro should not end with a semicolon 3066b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3067b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3068b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3069b13edf7fSJoe Perches my $ln = $linenr; 3070b13edf7fSJoe Perches my $cnt = $realcnt; 3071b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3072b13edf7fSJoe Perches my $ctx = ''; 3073b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3074b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3075b13edf7fSJoe Perches $ctx = $dstat; 3076b13edf7fSJoe Perches 3077b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3078b13edf7fSJoe Perches 3079b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3080b13edf7fSJoe Perches my $stmts = $2; 3081b13edf7fSJoe Perches my $semis = $3; 3082b13edf7fSJoe Perches 3083b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3084b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3085b13edf7fSJoe Perches my $herectx = $here . "\n"; 3086b13edf7fSJoe Perches 3087b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3088b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3089b13edf7fSJoe Perches } 3090b13edf7fSJoe Perches 3091ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3092ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3093b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3094b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3095b13edf7fSJoe Perches } 3096b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3097b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3098b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3099b13edf7fSJoe Perches } 3100b13edf7fSJoe Perches } 3101b13edf7fSJoe Perches } 3102b13edf7fSJoe Perches 3103080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3104080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3105080ba929SMike Frysinger# . 3106080ba929SMike Frysinger# ALIGN(...) 3107080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3108080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3109000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3110000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3111080ba929SMike Frysinger } 3112080ba929SMike Frysinger 3113f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 311413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 311513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3116cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 311713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3118cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3119cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3120aad4f614SJoe Perches my @allowed = (); 3121aad4f614SJoe Perches my $allow = 0; 312213214adfSAndy Whitcroft my $seen = 0; 3123773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3124cf655043SAndy Whitcroft my $ln = $linenr - 1; 312513214adfSAndy Whitcroft for my $chunk (@chunks) { 312613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 312713214adfSAndy Whitcroft 3128773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3129773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3130773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3131773647a0SAndy Whitcroft 3132aad4f614SJoe Perches $allowed[$allow] = 0; 3133773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3134773647a0SAndy Whitcroft 3135773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3136773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3137773647a0SAndy Whitcroft 3138773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3139cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3140cf655043SAndy Whitcroft 3141773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 314213214adfSAndy Whitcroft 314313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 314413214adfSAndy Whitcroft 3145aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3146cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3147cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3148aad4f614SJoe Perches $allowed[$allow] = 1; 314913214adfSAndy Whitcroft } 315013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3151cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3152aad4f614SJoe Perches $allowed[$allow] = 1; 315313214adfSAndy Whitcroft } 3154cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3155cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3156aad4f614SJoe Perches $allowed[$allow] = 1; 315713214adfSAndy Whitcroft } 3158aad4f614SJoe Perches $allow++; 315913214adfSAndy Whitcroft } 3160aad4f614SJoe Perches if ($seen) { 3161aad4f614SJoe Perches my $sum_allowed = 0; 3162aad4f614SJoe Perches foreach (@allowed) { 3163aad4f614SJoe Perches $sum_allowed += $_; 3164aad4f614SJoe Perches } 3165aad4f614SJoe Perches if ($sum_allowed == 0) { 3166000d1cc1SJoe Perches WARN("BRACES", 3167000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3168aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3169aad4f614SJoe Perches $seen != $allow) { 3170aad4f614SJoe Perches CHK("BRACES", 3171aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3172aad4f614SJoe Perches } 317313214adfSAndy Whitcroft } 317413214adfSAndy Whitcroft } 317513214adfSAndy Whitcroft } 3176773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 317713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3178cf655043SAndy Whitcroft my $allowed = 0; 3179f0a594c1SAndy Whitcroft 3180cf655043SAndy Whitcroft # Check the pre-context. 3181cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3182cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3183cf655043SAndy Whitcroft $allowed = 1; 3184f0a594c1SAndy Whitcroft } 3185773647a0SAndy Whitcroft 3186773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3187773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3188773647a0SAndy Whitcroft 3189cf655043SAndy Whitcroft # Check the condition. 3190cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3191773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3192cf655043SAndy Whitcroft if (defined $cond) { 3193773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3194cf655043SAndy Whitcroft } 3195cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3196cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3197cf655043SAndy Whitcroft $allowed = 1; 3198cf655043SAndy Whitcroft } 3199cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3200cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3201cf655043SAndy Whitcroft $allowed = 1; 3202cf655043SAndy Whitcroft } 3203cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3204cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3205cf655043SAndy Whitcroft $allowed = 1; 3206cf655043SAndy Whitcroft } 3207cf655043SAndy Whitcroft # Check the post-context. 3208cf655043SAndy Whitcroft if (defined $chunks[1]) { 3209cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3210cf655043SAndy Whitcroft if (defined $cond) { 3211773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3212cf655043SAndy Whitcroft } 3213cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3214cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3215cf655043SAndy Whitcroft $allowed = 1; 3216cf655043SAndy Whitcroft } 3217cf655043SAndy Whitcroft } 3218cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 321969932487SJustin P. Mattock my $herectx = $here . "\n"; 3220f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3221cf655043SAndy Whitcroft 3222f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 322369932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3224cf655043SAndy Whitcroft } 3225cf655043SAndy Whitcroft 3226000d1cc1SJoe Perches WARN("BRACES", 3227000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3228f0a594c1SAndy Whitcroft } 3229f0a594c1SAndy Whitcroft } 3230f0a594c1SAndy Whitcroft 32310979ae66SJoe Perches# check for unnecessary blank lines around braces 3232*74c8f433SMatthijs Kooijman if (($line =~ /^.\s*}\s*$/ && $prevline =~ /^.\s*$/)) { 32330979ae66SJoe Perches CHK("BRACES", 32340979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 32350979ae66SJoe Perches } 32360979ae66SJoe Perches if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 32370979ae66SJoe Perches CHK("BRACES", 32380979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 32390979ae66SJoe Perches } 32400979ae66SJoe Perches 32414a0df2efSAndy Whitcroft# no volatiles please 32426c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 32436c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3244000d1cc1SJoe Perches WARN("VOLATILE", 3245000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 32464a0df2efSAndy Whitcroft } 32474a0df2efSAndy Whitcroft 324800df344fSAndy Whitcroft# warn about #if 0 3249c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3250000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3251000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3252de7d4f0eSAndy Whitcroft $herecurr); 32534a0df2efSAndy Whitcroft } 32544a0df2efSAndy Whitcroft 325503df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 325603df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 325703df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 325803df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 325903df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 326003df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 32614c432a8fSGreg Kroah-Hartman } 32624c432a8fSGreg Kroah-Hartman } 3263f0a594c1SAndy Whitcroft 32641a15a250SPatrick Pannuto# prefer usleep_range over udelay 326537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 32661a15a250SPatrick Pannuto # ignore udelay's < 10, however 326737581c28SBruce Allan if (! ($1 < 10) ) { 3268000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3269000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 32701a15a250SPatrick Pannuto } 32711a15a250SPatrick Pannuto } 32721a15a250SPatrick Pannuto 327309ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 327409ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 327509ef8725SPatrick Pannuto if ($1 < 20) { 3276000d1cc1SJoe Perches WARN("MSLEEP", 3277000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 327809ef8725SPatrick Pannuto } 327909ef8725SPatrick Pannuto } 328009ef8725SPatrick Pannuto 328100df344fSAndy Whitcroft# warn about #ifdefs in C files 3282c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 328300df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 328400df344fSAndy Whitcroft# print "$herecurr"; 328500df344fSAndy Whitcroft# $clean = 0; 328600df344fSAndy Whitcroft# } 328700df344fSAndy Whitcroft 328822f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3289c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3290000d1cc1SJoe Perches ERROR("SPACING", 3291000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 329222f2a2efSAndy Whitcroft } 329322f2a2efSAndy Whitcroft 32944a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3295171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3296171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 32974a0df2efSAndy Whitcroft my $which = $1; 32984a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3299000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3300000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 33014a0df2efSAndy Whitcroft } 33024a0df2efSAndy Whitcroft } 33034a0df2efSAndy Whitcroft# check for memory barriers without a comment. 33044a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 33054a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3306000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3307000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 33084a0df2efSAndy Whitcroft } 33094a0df2efSAndy Whitcroft } 33104a0df2efSAndy Whitcroft# check of hardware specific defines 3311c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3312000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3313000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 33140a920b5bSAndy Whitcroft } 3315653d4876SAndy Whitcroft 3316d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3317d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3318000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3319000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3320d4977c78STobias Klauser } 3321d4977c78STobias Klauser 3322de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3323de7d4f0eSAndy Whitcroft# storage class and type. 33249c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 33259c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3326000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3327000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3328de7d4f0eSAndy Whitcroft } 3329de7d4f0eSAndy Whitcroft 33308905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 33318905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3332000d1cc1SJoe Perches WARN("INLINE", 3333000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 33348905a67cSAndy Whitcroft } 33358905a67cSAndy Whitcroft 33363d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 33373d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3338000d1cc1SJoe Perches WARN("PREFER_PACKED", 3339000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 33403d130fd0SJoe Perches } 33413d130fd0SJoe Perches 334239b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 334339b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3344000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3345000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 334639b7e287SJoe Perches } 334739b7e287SJoe Perches 33485f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 33495f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 33505f14d3bdSJoe Perches WARN("PREFER_PRINTF", 33515f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 33525f14d3bdSJoe Perches } 33535f14d3bdSJoe Perches 33546061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 33556061d949SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 33566061d949SJoe Perches WARN("PREFER_SCANF", 33576061d949SJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); 33586061d949SJoe Perches } 33596061d949SJoe Perches 33608f53a9b8SJoe Perches# check for sizeof(&) 33618f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3362000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3363000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 33648f53a9b8SJoe Perches } 33658f53a9b8SJoe Perches 336666c80b60SJoe Perches# check for sizeof without parenthesis 336766c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 336866c80b60SJoe Perches WARN("SIZEOF_PARENTHESIS", 336966c80b60SJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr); 337066c80b60SJoe Perches } 337166c80b60SJoe Perches 3372428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3373428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3374000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3375000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3376428e2fdcSJoe Perches } 3377428e2fdcSJoe Perches 337888982feaSJoe Perches# check for struct spinlock declarations 337988982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 338088982feaSJoe Perches WARN("USE_SPINLOCK_T", 338188982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 338288982feaSJoe Perches } 338388982feaSJoe Perches 3384a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 3385a6962d72SJoe Perches if ($line =~ /\bseq_printf\s*\(/) { 3386a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 3387a6962d72SJoe Perches if ($fmt !~ /[^\\]\%/) { 3388a6962d72SJoe Perches WARN("PREFER_SEQ_PUTS", 3389a6962d72SJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr); 3390a6962d72SJoe Perches } 3391a6962d72SJoe Perches } 3392a6962d72SJoe Perches 3393554e165cSAndy Whitcroft# Check for misused memsets 3394d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3395d1fe9c09SJoe Perches defined $stat && 3396d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3397554e165cSAndy Whitcroft 3398d7c76ba7SJoe Perches my $ms_addr = $2; 3399d1fe9c09SJoe Perches my $ms_val = $7; 3400d1fe9c09SJoe Perches my $ms_size = $12; 3401d7c76ba7SJoe Perches 3402554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3403554e165cSAndy Whitcroft ERROR("MEMSET", 3404d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3405554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3406554e165cSAndy Whitcroft WARN("MEMSET", 3407d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3408d7c76ba7SJoe Perches } 3409d7c76ba7SJoe Perches } 3410d7c76ba7SJoe Perches 3411d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3412d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3413d1fe9c09SJoe Perches defined $stat && 3414d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3415d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3416d7c76ba7SJoe Perches my $call = $1; 3417d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3418d7c76ba7SJoe Perches my $arg1 = $3; 3419d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3420d1fe9c09SJoe Perches my $arg2 = $8; 3421d7c76ba7SJoe Perches my $cast; 3422d7c76ba7SJoe Perches 3423d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3424d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3425d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3426d7c76ba7SJoe Perches $cast = $cast1; 3427d7c76ba7SJoe Perches } else { 3428d7c76ba7SJoe Perches $cast = $cast2; 3429d7c76ba7SJoe Perches } 3430d7c76ba7SJoe Perches WARN("MINMAX", 3431d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3432554e165cSAndy Whitcroft } 3433554e165cSAndy Whitcroft } 3434554e165cSAndy Whitcroft 34354a273195SJoe Perches# check usleep_range arguments 34364a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 34374a273195SJoe Perches defined $stat && 34384a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 34394a273195SJoe Perches my $min = $1; 34404a273195SJoe Perches my $max = $7; 34414a273195SJoe Perches if ($min eq $max) { 34424a273195SJoe Perches WARN("USLEEP_RANGE", 34434a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34444a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 34454a273195SJoe Perches $min > $max) { 34464a273195SJoe Perches WARN("USLEEP_RANGE", 34474a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34484a273195SJoe Perches } 34494a273195SJoe Perches } 34504a273195SJoe Perches 3451de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3452171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3453c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3454171ae1a4SAndy Whitcroft { 3455c45dcabdSAndy Whitcroft my $function_name = $1; 3456c45dcabdSAndy Whitcroft my $paren_space = $2; 3457171ae1a4SAndy Whitcroft 3458171ae1a4SAndy Whitcroft my $s = $stat; 3459171ae1a4SAndy Whitcroft if (defined $cond) { 3460171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3461171ae1a4SAndy Whitcroft } 3462c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3463c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3464c45dcabdSAndy Whitcroft { 3465000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3466000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3467de7d4f0eSAndy Whitcroft } 3468de7d4f0eSAndy Whitcroft 3469171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3470000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3471000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3472171ae1a4SAndy Whitcroft } 34739c9ba34eSAndy Whitcroft 34749c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 34759c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 34769c9ba34eSAndy Whitcroft { 3477000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3478000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3479171ae1a4SAndy Whitcroft } 3480171ae1a4SAndy Whitcroft 3481de7d4f0eSAndy Whitcroft# checks for new __setup's 3482de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3483de7d4f0eSAndy Whitcroft my $name = $1; 3484de7d4f0eSAndy Whitcroft 3485de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3486000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3487000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3488de7d4f0eSAndy Whitcroft } 3489653d4876SAndy Whitcroft } 34909c0ca6f9SAndy Whitcroft 34919c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3492caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3493000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3494000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 34959c0ca6f9SAndy Whitcroft } 349613214adfSAndy Whitcroft 3497972fdea2SJoe Perches# check for krealloc arg reuse 3498972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 3499972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 3500972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 3501972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 3502972fdea2SJoe Perches } 3503972fdea2SJoe Perches 35045ce59ae0SJoe Perches# check for alloc argument mismatch 35055ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 35065ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 35075ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 35085ce59ae0SJoe Perches } 35095ce59ae0SJoe Perches 3510caf2a54fSJoe Perches# check for multiple semicolons 3511caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3512000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3513000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3514d1e2ad07SJoe Perches } 3515d1e2ad07SJoe Perches 3516d1e2ad07SJoe Perches# check for switch/default statements without a break; 3517d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 3518d1e2ad07SJoe Perches defined $stat && 3519d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 3520d1e2ad07SJoe Perches my $ctx = ''; 3521d1e2ad07SJoe Perches my $herectx = $here . "\n"; 3522d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 3523d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3524d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3525d1e2ad07SJoe Perches } 3526d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 3527d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 3528caf2a54fSJoe Perches } 3529caf2a54fSJoe Perches 353013214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 353113214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3532000d1cc1SJoe Perches WARN("USE_FUNC", 3533000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 353413214adfSAndy Whitcroft } 3535773647a0SAndy Whitcroft 35362c92488aSJoe Perches# check for use of yield() 35372c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 35382c92488aSJoe Perches WARN("YIELD", 35392c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 35402c92488aSJoe Perches } 35412c92488aSJoe Perches 35424882720bSThomas Gleixner# check for semaphores initialized locked 35434882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3544000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3545000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 3546773647a0SAndy Whitcroft } 35476712d858SJoe Perches 354867d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 354967d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3550000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 355167d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3552773647a0SAndy Whitcroft } 35536712d858SJoe Perches 3554f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3555f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3556000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3557000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3558f3db6639SMichael Ellerman } 35596712d858SJoe Perches 356079404849SEmese Revfy# check for various ops structs, ensure they are const. 356179404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 356279404849SEmese Revfy address_space_operations| 356379404849SEmese Revfy backlight_ops| 356479404849SEmese Revfy block_device_operations| 356579404849SEmese Revfy dentry_operations| 356679404849SEmese Revfy dev_pm_ops| 356779404849SEmese Revfy dma_map_ops| 356879404849SEmese Revfy extent_io_ops| 356979404849SEmese Revfy file_lock_operations| 357079404849SEmese Revfy file_operations| 357179404849SEmese Revfy hv_ops| 357279404849SEmese Revfy ide_dma_ops| 357379404849SEmese Revfy intel_dvo_dev_ops| 357479404849SEmese Revfy item_operations| 357579404849SEmese Revfy iwl_ops| 357679404849SEmese Revfy kgdb_arch| 357779404849SEmese Revfy kgdb_io| 357879404849SEmese Revfy kset_uevent_ops| 357979404849SEmese Revfy lock_manager_operations| 358079404849SEmese Revfy microcode_ops| 358179404849SEmese Revfy mtrr_ops| 358279404849SEmese Revfy neigh_ops| 358379404849SEmese Revfy nlmsvc_binding| 358479404849SEmese Revfy pci_raw_ops| 358579404849SEmese Revfy pipe_buf_operations| 358679404849SEmese Revfy platform_hibernation_ops| 358779404849SEmese Revfy platform_suspend_ops| 358879404849SEmese Revfy proto_ops| 358979404849SEmese Revfy rpc_pipe_ops| 359079404849SEmese Revfy seq_operations| 359179404849SEmese Revfy snd_ac97_build_ops| 359279404849SEmese Revfy soc_pcmcia_socket_ops| 359379404849SEmese Revfy stacktrace_ops| 359479404849SEmese Revfy sysfs_ops| 359579404849SEmese Revfy tty_operations| 359679404849SEmese Revfy usb_mon_operations| 359779404849SEmese Revfy wd_ops}x; 35986903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 359979404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3600000d1cc1SJoe Perches WARN("CONST_STRUCT", 3601000d1cc1SJoe Perches "struct $1 should normally be const\n" . 36026903ffb2SAndy Whitcroft $herecurr); 36032b6db5cbSAndy Whitcroft } 3604773647a0SAndy Whitcroft 3605773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3606773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3607773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3608c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3609c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3610171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3611171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3612171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3613773647a0SAndy Whitcroft { 3614000d1cc1SJoe Perches WARN("NR_CPUS", 3615000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3616773647a0SAndy Whitcroft } 36179c9ba34eSAndy Whitcroft 36189c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 36199c9ba34eSAndy Whitcroft my $string; 36209c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 36219c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 36222a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 36239c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3624000d1cc1SJoe Perches WARN("PRINTF_L", 3625000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 36269c9ba34eSAndy Whitcroft last; 36279c9ba34eSAndy Whitcroft } 36289c9ba34eSAndy Whitcroft } 3629691d77b6SAndy Whitcroft 3630691d77b6SAndy Whitcroft# whine mightly about in_atomic 3631691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3632691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3633000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3634000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3635f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3636000d1cc1SJoe Perches WARN("IN_ATOMIC", 3637000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3638691d77b6SAndy Whitcroft } 3639691d77b6SAndy Whitcroft } 36401704f47bSPeter Zijlstra 36411704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 36421704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 36431704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 36441704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 36451704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 36461704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3647000d1cc1SJoe Perches ERROR("LOCKDEP", 3648000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 36491704f47bSPeter Zijlstra } 36501704f47bSPeter Zijlstra } 365188f8831cSDave Jones 365288f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 365388f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3654000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3655000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 365688f8831cSDave Jones } 365713214adfSAndy Whitcroft } 365813214adfSAndy Whitcroft 365913214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 366013214adfSAndy Whitcroft # so just keep quiet. 366113214adfSAndy Whitcroft if ($#rawlines == -1) { 366213214adfSAndy Whitcroft exit(0); 36630a920b5bSAndy Whitcroft } 36640a920b5bSAndy Whitcroft 36658905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 36668905a67cSAndy Whitcroft # things that appear to be patches. 36678905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 36688905a67cSAndy Whitcroft exit(0); 36698905a67cSAndy Whitcroft } 36708905a67cSAndy Whitcroft 36718905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 36728905a67cSAndy Whitcroft # just keep quiet. 36738905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 36748905a67cSAndy Whitcroft exit(0); 36758905a67cSAndy Whitcroft } 36768905a67cSAndy Whitcroft 36778905a67cSAndy Whitcroft if (!$is_patch) { 3678000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3679000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 36800a920b5bSAndy Whitcroft } 36810a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3682000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3683000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 36840a920b5bSAndy Whitcroft } 36850a920b5bSAndy Whitcroft 3686f0a594c1SAndy Whitcroft print report_dump(); 368713214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 368813214adfSAndy Whitcroft print "$filename " if ($summary_file); 36896c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 36906c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 36916c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 36928905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 36936c72ffaaSAndy Whitcroft } 36948905a67cSAndy Whitcroft 3695d2c0a235SAndy Whitcroft if ($quiet == 0) { 3696d1fe9c09SJoe Perches 3697d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 3698d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 3699d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 3700d1fe9c09SJoe Perches } 3701d1fe9c09SJoe Perches 3702d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3703d2c0a235SAndy Whitcroft # then suggest that. 3704d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3705d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3706d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3707b0781216SMike Frysinger $rpt_cleaners = 0; 3708d2c0a235SAndy Whitcroft } 3709d2c0a235SAndy Whitcroft } 3710d2c0a235SAndy Whitcroft 371111232688SArtem Bityutskiy if ($quiet == 0 && keys %ignore_type) { 3712000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3713000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3714000d1cc1SJoe Perches print " $ignore"; 3715000d1cc1SJoe Perches } 371611232688SArtem Bityutskiy print "\n\n"; 3717000d1cc1SJoe Perches } 3718000d1cc1SJoe Perches 37190a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3720c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 37210a920b5bSAndy Whitcroft } 37220a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3723000d1cc1SJoe Perches print << "EOM"; 3724000d1cc1SJoe Perches$vname has style problems, please review. 3725000d1cc1SJoe Perches 3726000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3727000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3728000d1cc1SJoe PerchesEOM 37290a920b5bSAndy Whitcroft } 373013214adfSAndy Whitcroft 37310a920b5bSAndy Whitcroft return $clean; 37320a920b5bSAndy Whitcroft} 3733