10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftmy $P = $0; 1100df344fSAndy Whitcroft$P =~ s@.*/@@g; 120a920b5bSAndy Whitcroft 13000d1cc1SJoe Perchesmy $V = '0.32'; 140a920b5bSAndy Whitcroft 150a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 160a920b5bSAndy Whitcroft 170a920b5bSAndy Whitcroftmy $quiet = 0; 180a920b5bSAndy Whitcroftmy $tree = 1; 190a920b5bSAndy Whitcroftmy $chk_signoff = 1; 200a920b5bSAndy Whitcroftmy $chk_patch = 1; 21773647a0SAndy Whitcroftmy $tst_only; 226c72ffaaSAndy Whitcroftmy $emacs = 0; 238905a67cSAndy Whitcroftmy $terse = 0; 246c72ffaaSAndy Whitcroftmy $file = 0; 256c72ffaaSAndy Whitcroftmy $check = 0; 268905a67cSAndy Whitcroftmy $summary = 1; 278905a67cSAndy Whitcroftmy $mailback = 0; 2813214adfSAndy Whitcroftmy $summary_file = 0; 29000d1cc1SJoe Perchesmy $show_types = 0; 306c72ffaaSAndy Whitcroftmy $root; 31c2fdda0dSAndy Whitcroftmy %debug; 32000d1cc1SJoe Perchesmy %ignore_type = (); 33000d1cc1SJoe Perchesmy @ignore = (); 3477f5b10aSHannes Edermy $help = 0; 35000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 366cd7f386SJoe Perchesmy $max_line_length = 80; 3777f5b10aSHannes Eder 3877f5b10aSHannes Edersub help { 3977f5b10aSHannes Eder my ($exitcode) = @_; 4077f5b10aSHannes Eder 4177f5b10aSHannes Eder print << "EOM"; 4277f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 4377f5b10aSHannes EderVersion: $V 4477f5b10aSHannes Eder 4577f5b10aSHannes EderOptions: 4677f5b10aSHannes Eder -q, --quiet quiet 4777f5b10aSHannes Eder --no-tree run without a kernel tree 4877f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 4977f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5077f5b10aSHannes Eder --emacs emacs compile window format 5177f5b10aSHannes Eder --terse one line per report 5277f5b10aSHannes Eder -f, --file treat FILE as regular source file 5377f5b10aSHannes Eder --subjective, --strict enable more subjective tests 54000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 556cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 56000d1cc1SJoe Perches --show-types show the message "types" in the output 5777f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 5877f5b10aSHannes Eder --no-summary suppress the per-file summary 5977f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6077f5b10aSHannes Eder --summary-file include the filename in summary 6177f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 6277f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 6377f5b10aSHannes Eder is all off) 6477f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 6577f5b10aSHannes Eder literally 6677f5b10aSHannes Eder -h, --help, --version display this help and exit 6777f5b10aSHannes Eder 6877f5b10aSHannes EderWhen FILE is - read standard input. 6977f5b10aSHannes EderEOM 7077f5b10aSHannes Eder 7177f5b10aSHannes Eder exit($exitcode); 7277f5b10aSHannes Eder} 7377f5b10aSHannes Eder 74000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 75000d1cc1SJoe Perchesif (-f $conf) { 76000d1cc1SJoe Perches my @conf_args; 77000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 78000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 79000d1cc1SJoe Perches 80000d1cc1SJoe Perches while (<$conffile>) { 81000d1cc1SJoe Perches my $line = $_; 82000d1cc1SJoe Perches 83000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 84000d1cc1SJoe Perches $line =~ s/^\s*//g; 85000d1cc1SJoe Perches $line =~ s/\s+/ /g; 86000d1cc1SJoe Perches 87000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 88000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 89000d1cc1SJoe Perches 90000d1cc1SJoe Perches my @words = split(" ", $line); 91000d1cc1SJoe Perches foreach my $word (@words) { 92000d1cc1SJoe Perches last if ($word =~ m/^#/); 93000d1cc1SJoe Perches push (@conf_args, $word); 94000d1cc1SJoe Perches } 95000d1cc1SJoe Perches } 96000d1cc1SJoe Perches close($conffile); 97000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 98000d1cc1SJoe Perches} 99000d1cc1SJoe Perches 1000a920b5bSAndy WhitcroftGetOptions( 1016c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1020a920b5bSAndy Whitcroft 'tree!' => \$tree, 1030a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1040a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1056c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1068905a67cSAndy Whitcroft 'terse!' => \$terse, 10777f5b10aSHannes Eder 'f|file!' => \$file, 1086c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1096c72ffaaSAndy Whitcroft 'strict!' => \$check, 110000d1cc1SJoe Perches 'ignore=s' => \@ignore, 111000d1cc1SJoe Perches 'show-types!' => \$show_types, 1126cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1136c72ffaaSAndy Whitcroft 'root=s' => \$root, 1148905a67cSAndy Whitcroft 'summary!' => \$summary, 1158905a67cSAndy Whitcroft 'mailback!' => \$mailback, 11613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 11713214adfSAndy Whitcroft 118c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 119773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 12077f5b10aSHannes Eder 'h|help' => \$help, 12177f5b10aSHannes Eder 'version' => \$help 12277f5b10aSHannes Eder) or help(1); 12377f5b10aSHannes Eder 12477f5b10aSHannes Ederhelp(0) if ($help); 1250a920b5bSAndy Whitcroft 1260a920b5bSAndy Whitcroftmy $exit = 0; 1270a920b5bSAndy Whitcroft 1280a920b5bSAndy Whitcroftif ($#ARGV < 0) { 12977f5b10aSHannes Eder print "$P: no input files\n"; 1300a920b5bSAndy Whitcroft exit(1); 1310a920b5bSAndy Whitcroft} 1320a920b5bSAndy Whitcroft 133000d1cc1SJoe Perches@ignore = split(/,/, join(',',@ignore)); 134000d1cc1SJoe Perchesforeach my $word (@ignore) { 135000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 136000d1cc1SJoe Perches $word =~ s/^\s*//g; 137000d1cc1SJoe Perches $word =~ s/\s+/ /g; 138000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 139000d1cc1SJoe Perches 140000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 141000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 142000d1cc1SJoe Perches 143000d1cc1SJoe Perches $ignore_type{$word}++; 144000d1cc1SJoe Perches} 145000d1cc1SJoe Perches 146c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 147c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1487429c690SAndy Whitcroftmy $dbg_type = 0; 149a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 150c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 15121caa13cSAndy Whitcroft ## no critic 15221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 15321caa13cSAndy Whitcroft die "$@" if ($@); 154c2fdda0dSAndy Whitcroft} 155c2fdda0dSAndy Whitcroft 156d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 157d2c0a235SAndy Whitcroft 1588905a67cSAndy Whitcroftif ($terse) { 1598905a67cSAndy Whitcroft $emacs = 1; 1608905a67cSAndy Whitcroft $quiet++; 1618905a67cSAndy Whitcroft} 1628905a67cSAndy Whitcroft 1636c72ffaaSAndy Whitcroftif ($tree) { 1646c72ffaaSAndy Whitcroft if (defined $root) { 1656c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 1666c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 1676c72ffaaSAndy Whitcroft } 1686c72ffaaSAndy Whitcroft } else { 1696c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 1706c72ffaaSAndy Whitcroft $root = '.'; 1716c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 1726c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 1736c72ffaaSAndy Whitcroft $root = $1; 1746c72ffaaSAndy Whitcroft } 1756c72ffaaSAndy Whitcroft } 1766c72ffaaSAndy Whitcroft 1776c72ffaaSAndy Whitcroft if (!defined $root) { 1780a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 1790a920b5bSAndy Whitcroft exit(2); 1800a920b5bSAndy Whitcroft } 1816c72ffaaSAndy Whitcroft} 1826c72ffaaSAndy Whitcroft 1836c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1846c72ffaaSAndy Whitcroft 1852ceb532bSAndy Whitcroftour $Ident = qr{ 1862ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 1872ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 1882ceb532bSAndy Whitcroft }x; 1896c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1906c72ffaaSAndy Whitcroftour $Sparse = qr{ 1916c72ffaaSAndy Whitcroft __user| 1926c72ffaaSAndy Whitcroft __kernel| 1936c72ffaaSAndy Whitcroft __force| 1946c72ffaaSAndy Whitcroft __iomem| 1956c72ffaaSAndy Whitcroft __must_check| 1966c72ffaaSAndy Whitcroft __init_refok| 197417495edSAndy Whitcroft __kprobes| 198165e72a6SSven Eckelmann __ref| 199165e72a6SSven Eckelmann __rcu 2006c72ffaaSAndy Whitcroft }x; 20152131292SWolfram Sang 20252131292SWolfram Sang# Notes to $Attribute: 20352131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2046c72ffaaSAndy Whitcroftour $Attribute = qr{ 2056c72ffaaSAndy Whitcroft const| 20603f1df7dSJoe Perches __percpu| 20703f1df7dSJoe Perches __nocast| 20803f1df7dSJoe Perches __safe| 20903f1df7dSJoe Perches __bitwise__| 21003f1df7dSJoe Perches __packed__| 21103f1df7dSJoe Perches __packed2__| 21203f1df7dSJoe Perches __naked| 21303f1df7dSJoe Perches __maybe_unused| 21403f1df7dSJoe Perches __always_unused| 21503f1df7dSJoe Perches __noreturn| 21603f1df7dSJoe Perches __used| 21703f1df7dSJoe Perches __cold| 21803f1df7dSJoe Perches __noclone| 21903f1df7dSJoe Perches __deprecated| 2206c72ffaaSAndy Whitcroft __read_mostly| 2216c72ffaaSAndy Whitcroft __kprobes| 22252131292SWolfram Sang __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| 22324e1d81aSAndy Whitcroft ____cacheline_aligned| 22424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2255fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2265fe3af11SAndy Whitcroft __weak 2276c72ffaaSAndy Whitcroft }x; 228c45dcabdSAndy Whitcroftour $Modifier; 2296c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2306c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2316c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2326c72ffaaSAndy Whitcroft 233*326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 234*326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 235*326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 23674349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 237*326b1ffcSJoe Perchesour $Constant = qr{$Float|(?i)(?:0x[0-9a-f]+|[0-9]+)[ul]*}; 238*326b1ffcSJoe 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 6318905a67cSAndy Whitcroftsub ctx_statement_block { 6328905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6338905a67cSAndy Whitcroft my $line = $linenr - 1; 6348905a67cSAndy Whitcroft my $blk = ''; 6358905a67cSAndy Whitcroft my $soff = $off; 6368905a67cSAndy Whitcroft my $coff = $off - 1; 637773647a0SAndy Whitcroft my $coff_set = 0; 6388905a67cSAndy Whitcroft 63913214adfSAndy Whitcroft my $loff = 0; 64013214adfSAndy Whitcroft 6418905a67cSAndy Whitcroft my $type = ''; 6428905a67cSAndy Whitcroft my $level = 0; 643a2750645SAndy Whitcroft my @stack = (); 644cf655043SAndy Whitcroft my $p; 6458905a67cSAndy Whitcroft my $c; 6468905a67cSAndy Whitcroft my $len = 0; 64713214adfSAndy Whitcroft 64813214adfSAndy Whitcroft my $remainder; 6498905a67cSAndy Whitcroft while (1) { 650a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 651a2750645SAndy Whitcroft 652773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6538905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6548905a67cSAndy Whitcroft # context. 6558905a67cSAndy Whitcroft if ($off >= $len) { 6568905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 657dea33496SAndy Whitcroft last if (!defined $lines[$line]); 658c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6598905a67cSAndy Whitcroft $remain--; 66013214adfSAndy Whitcroft $loff = $len; 661c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6628905a67cSAndy Whitcroft $len = length($blk); 6638905a67cSAndy Whitcroft $line++; 6648905a67cSAndy Whitcroft last; 6658905a67cSAndy Whitcroft } 6668905a67cSAndy Whitcroft # Bail if there is no further context. 6678905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 66813214adfSAndy Whitcroft if ($off >= $len) { 6698905a67cSAndy Whitcroft last; 6708905a67cSAndy Whitcroft } 671f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 672f74bd194SAndy Whitcroft $level++; 673f74bd194SAndy Whitcroft $type = '#'; 674f74bd194SAndy Whitcroft } 6758905a67cSAndy Whitcroft } 676cf655043SAndy Whitcroft $p = $c; 6778905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 67813214adfSAndy Whitcroft $remainder = substr($blk, $off); 6798905a67cSAndy Whitcroft 680773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6814635f4fbSAndy Whitcroft 6824635f4fbSAndy Whitcroft # Handle nested #if/#else. 6834635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6844635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6854635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 6864635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 6874635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 6884635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 6894635f4fbSAndy Whitcroft } 6904635f4fbSAndy Whitcroft 6918905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 6928905a67cSAndy Whitcroft # outermost level. 6938905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 6948905a67cSAndy Whitcroft last; 6958905a67cSAndy Whitcroft } 6968905a67cSAndy Whitcroft 69713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 698773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 699773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 700773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 701773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 702773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 703773647a0SAndy Whitcroft $coff_set = 1; 704773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 705773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 70613214adfSAndy Whitcroft } 70713214adfSAndy Whitcroft 7088905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7098905a67cSAndy Whitcroft $level++; 7108905a67cSAndy Whitcroft $type = '('; 7118905a67cSAndy Whitcroft } 7128905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7138905a67cSAndy Whitcroft $level--; 7148905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7158905a67cSAndy Whitcroft 7168905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7178905a67cSAndy Whitcroft $coff = $off; 718773647a0SAndy Whitcroft $coff_set = 1; 719773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7208905a67cSAndy Whitcroft } 7218905a67cSAndy Whitcroft } 7228905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7238905a67cSAndy Whitcroft $level++; 7248905a67cSAndy Whitcroft $type = '{'; 7258905a67cSAndy Whitcroft } 7268905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7278905a67cSAndy Whitcroft $level--; 7288905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7298905a67cSAndy Whitcroft 7308905a67cSAndy Whitcroft if ($level == 0) { 731b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 732b998e001SPatrick Pannuto $off++; 733b998e001SPatrick Pannuto } 7348905a67cSAndy Whitcroft last; 7358905a67cSAndy Whitcroft } 7368905a67cSAndy Whitcroft } 737f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 738f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 739f74bd194SAndy Whitcroft $level--; 740f74bd194SAndy Whitcroft $type = ''; 741f74bd194SAndy Whitcroft $off++; 742f74bd194SAndy Whitcroft last; 743f74bd194SAndy Whitcroft } 7448905a67cSAndy Whitcroft $off++; 7458905a67cSAndy Whitcroft } 746a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 74713214adfSAndy Whitcroft if ($off == $len) { 748a3bb97a7SAndy Whitcroft $loff = $len + 1; 74913214adfSAndy Whitcroft $line++; 75013214adfSAndy Whitcroft $remain--; 75113214adfSAndy Whitcroft } 7528905a67cSAndy Whitcroft 7538905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7548905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7558905a67cSAndy Whitcroft 7568905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7578905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7588905a67cSAndy Whitcroft 759773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 76013214adfSAndy Whitcroft 76113214adfSAndy Whitcroft return ($statement, $condition, 76213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 76313214adfSAndy Whitcroft} 76413214adfSAndy Whitcroft 765cf655043SAndy Whitcroftsub statement_lines { 766cf655043SAndy Whitcroft my ($stmt) = @_; 767cf655043SAndy Whitcroft 768cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 769cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 770cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 771cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 772cf655043SAndy Whitcroft 773cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 774cf655043SAndy Whitcroft 775cf655043SAndy Whitcroft return $#stmt_lines + 2; 776cf655043SAndy Whitcroft} 777cf655043SAndy Whitcroft 778cf655043SAndy Whitcroftsub statement_rawlines { 779cf655043SAndy Whitcroft my ($stmt) = @_; 780cf655043SAndy Whitcroft 781cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 782cf655043SAndy Whitcroft 783cf655043SAndy Whitcroft return $#stmt_lines + 2; 784cf655043SAndy Whitcroft} 785cf655043SAndy Whitcroft 786cf655043SAndy Whitcroftsub statement_block_size { 787cf655043SAndy Whitcroft my ($stmt) = @_; 788cf655043SAndy Whitcroft 789cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 790cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 791cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 792cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 793cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 794cf655043SAndy Whitcroft 795cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 796cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 797cf655043SAndy Whitcroft 798cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 799cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 800cf655043SAndy Whitcroft 801cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 802cf655043SAndy Whitcroft return $stmt_lines; 803cf655043SAndy Whitcroft } else { 804cf655043SAndy Whitcroft return $stmt_statements; 805cf655043SAndy Whitcroft } 806cf655043SAndy Whitcroft} 807cf655043SAndy Whitcroft 80813214adfSAndy Whitcroftsub ctx_statement_full { 80913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 81013214adfSAndy Whitcroft my ($statement, $condition, $level); 81113214adfSAndy Whitcroft 81213214adfSAndy Whitcroft my (@chunks); 81313214adfSAndy Whitcroft 814cf655043SAndy Whitcroft # Grab the first conditional/block pair. 81513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 81613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 817773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 81813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 819cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 820cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 821cf655043SAndy Whitcroft } 822cf655043SAndy Whitcroft 823cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 824cf655043SAndy Whitcroft # could continue the statement. 825cf655043SAndy Whitcroft for (;;) { 82613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 82713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 828cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 829773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 830cf655043SAndy Whitcroft #print "C: push\n"; 831cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 83213214adfSAndy Whitcroft } 83313214adfSAndy Whitcroft 83413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8358905a67cSAndy Whitcroft} 8368905a67cSAndy Whitcroft 8374a0df2efSAndy Whitcroftsub ctx_block_get { 838f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8394a0df2efSAndy Whitcroft my $line; 8404a0df2efSAndy Whitcroft my $start = $linenr - 1; 8414a0df2efSAndy Whitcroft my $blk = ''; 8424a0df2efSAndy Whitcroft my @o; 8434a0df2efSAndy Whitcroft my @c; 8444a0df2efSAndy Whitcroft my @res = (); 8454a0df2efSAndy Whitcroft 846f0a594c1SAndy Whitcroft my $level = 0; 8474635f4fbSAndy Whitcroft my @stack = ($level); 84800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 84900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 85000df344fSAndy Whitcroft $remain--; 85100df344fSAndy Whitcroft 85200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8534635f4fbSAndy Whitcroft 8544635f4fbSAndy Whitcroft # Handle nested #if/#else. 85501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8564635f4fbSAndy Whitcroft push(@stack, $level); 85701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8584635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 85901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8604635f4fbSAndy Whitcroft $level = pop(@stack); 8614635f4fbSAndy Whitcroft } 8624635f4fbSAndy Whitcroft 86301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 864f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 865f0a594c1SAndy Whitcroft if ($off > 0) { 866f0a594c1SAndy Whitcroft $off--; 867f0a594c1SAndy Whitcroft next; 868f0a594c1SAndy Whitcroft } 8694a0df2efSAndy Whitcroft 870f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 871f0a594c1SAndy Whitcroft $level--; 872f0a594c1SAndy Whitcroft last if ($level == 0); 873f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 874f0a594c1SAndy Whitcroft $level++; 875f0a594c1SAndy Whitcroft } 876f0a594c1SAndy Whitcroft } 8774a0df2efSAndy Whitcroft 878f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 87900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8804a0df2efSAndy Whitcroft } 8814a0df2efSAndy Whitcroft 882f0a594c1SAndy Whitcroft last if ($level == 0); 8834a0df2efSAndy Whitcroft } 8844a0df2efSAndy Whitcroft 885f0a594c1SAndy Whitcroft return ($level, @res); 8864a0df2efSAndy Whitcroft} 8874a0df2efSAndy Whitcroftsub ctx_block_outer { 8884a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8894a0df2efSAndy Whitcroft 890f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 891f0a594c1SAndy Whitcroft return @r; 8924a0df2efSAndy Whitcroft} 8934a0df2efSAndy Whitcroftsub ctx_block { 8944a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8954a0df2efSAndy Whitcroft 896f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 897f0a594c1SAndy Whitcroft return @r; 898653d4876SAndy Whitcroft} 899653d4876SAndy Whitcroftsub ctx_statement { 900f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 901f0a594c1SAndy Whitcroft 902f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 903f0a594c1SAndy Whitcroft return @r; 904f0a594c1SAndy Whitcroft} 905f0a594c1SAndy Whitcroftsub ctx_block_level { 906653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 907653d4876SAndy Whitcroft 908f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9094a0df2efSAndy Whitcroft} 9109c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9119c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9129c0ca6f9SAndy Whitcroft 9139c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9149c0ca6f9SAndy Whitcroft} 9154a0df2efSAndy Whitcroft 9164a0df2efSAndy Whitcroftsub ctx_locate_comment { 9174a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9184a0df2efSAndy Whitcroft 9194a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 920beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9214a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9224a0df2efSAndy Whitcroft 9234a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9244a0df2efSAndy Whitcroft # comment. 9254a0df2efSAndy Whitcroft my $in_comment = 0; 9264a0df2efSAndy Whitcroft $current_comment = ''; 9274a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 92800df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 92900df344fSAndy Whitcroft #warn " $line\n"; 9304a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9314a0df2efSAndy Whitcroft $in_comment = 1; 9324a0df2efSAndy Whitcroft } 9334a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9344a0df2efSAndy Whitcroft $in_comment = 1; 9354a0df2efSAndy Whitcroft } 9364a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9374a0df2efSAndy Whitcroft $current_comment = ''; 9384a0df2efSAndy Whitcroft } 9394a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9404a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9414a0df2efSAndy Whitcroft $in_comment = 0; 9424a0df2efSAndy Whitcroft } 9434a0df2efSAndy Whitcroft } 9444a0df2efSAndy Whitcroft 9454a0df2efSAndy Whitcroft chomp($current_comment); 9464a0df2efSAndy Whitcroft return($current_comment); 9474a0df2efSAndy Whitcroft} 9484a0df2efSAndy Whitcroftsub ctx_has_comment { 9494a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9504a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9514a0df2efSAndy Whitcroft 95200df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9534a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9544a0df2efSAndy Whitcroft 9554a0df2efSAndy Whitcroft return ($cmt ne ''); 9564a0df2efSAndy Whitcroft} 9574a0df2efSAndy Whitcroft 9584d001e4dSAndy Whitcroftsub raw_line { 9594d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9604d001e4dSAndy Whitcroft 9614d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9624d001e4dSAndy Whitcroft $cnt++; 9634d001e4dSAndy Whitcroft 9644d001e4dSAndy Whitcroft my $line; 9654d001e4dSAndy Whitcroft while ($cnt) { 9664d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9674d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9684d001e4dSAndy Whitcroft $cnt--; 9694d001e4dSAndy Whitcroft } 9704d001e4dSAndy Whitcroft 9714d001e4dSAndy Whitcroft return $line; 9724d001e4dSAndy Whitcroft} 9734d001e4dSAndy Whitcroft 9740a920b5bSAndy Whitcroftsub cat_vet { 9750a920b5bSAndy Whitcroft my ($vet) = @_; 9769c0ca6f9SAndy Whitcroft my ($res, $coded); 9770a920b5bSAndy Whitcroft 9789c0ca6f9SAndy Whitcroft $res = ''; 9796c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9806c72ffaaSAndy Whitcroft $res .= $1; 9816c72ffaaSAndy Whitcroft if ($2 ne '') { 9829c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9836c72ffaaSAndy Whitcroft $res .= $coded; 9846c72ffaaSAndy Whitcroft } 9859c0ca6f9SAndy Whitcroft } 9869c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 9870a920b5bSAndy Whitcroft 9889c0ca6f9SAndy Whitcroft return $res; 9890a920b5bSAndy Whitcroft} 9900a920b5bSAndy Whitcroft 991c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 992cf655043SAndy Whitcroftmy $av_pending; 993c2fdda0dSAndy Whitcroftmy @av_paren_type; 9941f65f947SAndy Whitcroftmy $av_pend_colon; 995c2fdda0dSAndy Whitcroft 996c2fdda0dSAndy Whitcroftsub annotate_reset { 997c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 998cf655043SAndy Whitcroft $av_pending = '_'; 999cf655043SAndy Whitcroft @av_paren_type = ('E'); 10001f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1001c2fdda0dSAndy Whitcroft} 1002c2fdda0dSAndy Whitcroft 10036c72ffaaSAndy Whitcroftsub annotate_values { 10046c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10056c72ffaaSAndy Whitcroft 10066c72ffaaSAndy Whitcroft my $res; 10071f65f947SAndy Whitcroft my $var = '_' x length($stream); 10086c72ffaaSAndy Whitcroft my $cur = $stream; 10096c72ffaaSAndy Whitcroft 1010c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10116c72ffaaSAndy Whitcroft 10126c72ffaaSAndy Whitcroft while (length($cur)) { 1013773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1014cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1015171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10166c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1017c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1018c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1019cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1020c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10216c72ffaaSAndy Whitcroft } 10226c72ffaaSAndy Whitcroft 1023c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10249446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10259446ef56SAndy Whitcroft push(@av_paren_type, $type); 1026addcdceaSAndy Whitcroft $type = 'c'; 10279446ef56SAndy Whitcroft 1028e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1029c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10306c72ffaaSAndy Whitcroft $type = 'T'; 10316c72ffaaSAndy Whitcroft 1032389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1033389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1034389a2fe5SAndy Whitcroft $type = 'T'; 1035389a2fe5SAndy Whitcroft 1036c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1037171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1038c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1039171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1040171ae1a4SAndy Whitcroft if ($2 ne '') { 1041cf655043SAndy Whitcroft $av_pending = 'N'; 1042171ae1a4SAndy Whitcroft } 1043171ae1a4SAndy Whitcroft $type = 'E'; 1044171ae1a4SAndy Whitcroft 1045c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1046171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1047171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1048171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10496c72ffaaSAndy Whitcroft 1050c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1051cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1052c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1053cf655043SAndy Whitcroft 1054cf655043SAndy Whitcroft push(@av_paren_type, $type); 1055cf655043SAndy Whitcroft push(@av_paren_type, $type); 1056171ae1a4SAndy Whitcroft $type = 'E'; 1057cf655043SAndy Whitcroft 1058c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1059cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1060cf655043SAndy Whitcroft $av_preprocessor = 1; 1061cf655043SAndy Whitcroft 1062cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1063cf655043SAndy Whitcroft 1064171ae1a4SAndy Whitcroft $type = 'E'; 1065cf655043SAndy Whitcroft 1066c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1067cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1068cf655043SAndy Whitcroft 1069cf655043SAndy Whitcroft $av_preprocessor = 1; 1070cf655043SAndy Whitcroft 1071cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1072cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1073cf655043SAndy Whitcroft pop(@av_paren_type); 1074cf655043SAndy Whitcroft push(@av_paren_type, $type); 1075171ae1a4SAndy Whitcroft $type = 'E'; 10766c72ffaaSAndy Whitcroft 10776c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1078c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10796c72ffaaSAndy Whitcroft 1080171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1081171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1082171ae1a4SAndy Whitcroft $av_pending = $type; 1083171ae1a4SAndy Whitcroft $type = 'N'; 1084171ae1a4SAndy Whitcroft 10856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1086c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 10876c72ffaaSAndy Whitcroft if (defined $2) { 1088cf655043SAndy Whitcroft $av_pending = 'V'; 10896c72ffaaSAndy Whitcroft } 10906c72ffaaSAndy Whitcroft $type = 'N'; 10916c72ffaaSAndy Whitcroft 109214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1093c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 109414b111c1SAndy Whitcroft $av_pending = 'E'; 10956c72ffaaSAndy Whitcroft $type = 'N'; 10966c72ffaaSAndy Whitcroft 10971f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 10981f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 10991f65f947SAndy Whitcroft $av_pend_colon = 'C'; 11001f65f947SAndy Whitcroft $type = 'N'; 11011f65f947SAndy Whitcroft 110214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1103c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11046c72ffaaSAndy Whitcroft $type = 'N'; 11056c72ffaaSAndy Whitcroft 11066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1107c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1108cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1109cf655043SAndy Whitcroft $av_pending = '_'; 11106c72ffaaSAndy Whitcroft $type = 'N'; 11116c72ffaaSAndy Whitcroft 11126c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1113cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1114cf655043SAndy Whitcroft if ($new_type ne '_') { 1115cf655043SAndy Whitcroft $type = $new_type; 1116c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1117c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11186c72ffaaSAndy Whitcroft } else { 1119c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11206c72ffaaSAndy Whitcroft } 11216c72ffaaSAndy Whitcroft 1122c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1123c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1124c8cb2ca3SAndy Whitcroft $type = 'V'; 1125cf655043SAndy Whitcroft $av_pending = 'V'; 11266c72ffaaSAndy Whitcroft 11278e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11288e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11291f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11308e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11318e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11321f65f947SAndy Whitcroft } 11331f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11341f65f947SAndy Whitcroft $type = 'V'; 11351f65f947SAndy Whitcroft 11366c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1137c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11386c72ffaaSAndy Whitcroft $type = 'V'; 11396c72ffaaSAndy Whitcroft 11406c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1141c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11426c72ffaaSAndy Whitcroft $type = 'N'; 11436c72ffaaSAndy Whitcroft 1144cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1145c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 114613214adfSAndy Whitcroft $type = 'E'; 11471f65f947SAndy Whitcroft $av_pend_colon = 'O'; 114813214adfSAndy Whitcroft 11498e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11508e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11518e761b04SAndy Whitcroft $type = 'C'; 11528e761b04SAndy Whitcroft 11531f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11541f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11551f65f947SAndy Whitcroft $type = 'N'; 11561f65f947SAndy Whitcroft 11571f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11581f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11591f65f947SAndy Whitcroft 11601f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11611f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11621f65f947SAndy Whitcroft $type = 'E'; 11631f65f947SAndy Whitcroft } else { 11641f65f947SAndy Whitcroft $type = 'N'; 11651f65f947SAndy Whitcroft } 11661f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11671f65f947SAndy Whitcroft 11688e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 116913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11706c72ffaaSAndy Whitcroft $type = 'N'; 11716c72ffaaSAndy Whitcroft 11720d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 117374048ed8SAndy Whitcroft my $variant; 117474048ed8SAndy Whitcroft 117574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 117674048ed8SAndy Whitcroft if ($type eq 'V') { 117774048ed8SAndy Whitcroft $variant = 'B'; 117874048ed8SAndy Whitcroft } else { 117974048ed8SAndy Whitcroft $variant = 'U'; 118074048ed8SAndy Whitcroft } 118174048ed8SAndy Whitcroft 118274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 118374048ed8SAndy Whitcroft $type = 'N'; 118474048ed8SAndy Whitcroft 11856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1186c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 11876c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 11886c72ffaaSAndy Whitcroft $type = 'N'; 11896c72ffaaSAndy Whitcroft } 11906c72ffaaSAndy Whitcroft 11916c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1192c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 11936c72ffaaSAndy Whitcroft } 11946c72ffaaSAndy Whitcroft if (defined $1) { 11956c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 11966c72ffaaSAndy Whitcroft $res .= $type x length($1); 11976c72ffaaSAndy Whitcroft } 11986c72ffaaSAndy Whitcroft } 11996c72ffaaSAndy Whitcroft 12001f65f947SAndy Whitcroft return ($res, $var); 12016c72ffaaSAndy Whitcroft} 12026c72ffaaSAndy Whitcroft 12038905a67cSAndy Whitcroftsub possible { 120413214adfSAndy Whitcroft my ($possible, $line) = @_; 12059a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12060776e594SAndy Whitcroft ^(?: 12070776e594SAndy Whitcroft $Modifier| 12080776e594SAndy Whitcroft $Storage| 12090776e594SAndy Whitcroft $Type| 12109a974fdbSAndy Whitcroft DEFINE_\S+ 12119a974fdbSAndy Whitcroft )$| 12129a974fdbSAndy Whitcroft ^(?: 12130776e594SAndy Whitcroft goto| 12140776e594SAndy Whitcroft return| 12150776e594SAndy Whitcroft case| 12160776e594SAndy Whitcroft else| 12170776e594SAndy Whitcroft asm|__asm__| 121889a88353SAndy Whitcroft do| 121989a88353SAndy Whitcroft \#| 122089a88353SAndy Whitcroft \#\#| 12219a974fdbSAndy Whitcroft )(?:\s|$)| 12220776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12239a974fdbSAndy Whitcroft )}x; 12249a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12259a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1226c45dcabdSAndy Whitcroft # Check for modifiers. 1227c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1228c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1229c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1230c45dcabdSAndy Whitcroft 1231c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1232c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1233d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12349a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1235d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1236d2506586SAndy Whitcroft push(@modifierList, $modifier); 1237d2506586SAndy Whitcroft } 12389a974fdbSAndy Whitcroft } 1239c45dcabdSAndy Whitcroft 1240c45dcabdSAndy Whitcroft } else { 124113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12428905a67cSAndy Whitcroft push(@typeList, $possible); 1243c45dcabdSAndy Whitcroft } 12448905a67cSAndy Whitcroft build_types(); 12450776e594SAndy Whitcroft } else { 12460776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12478905a67cSAndy Whitcroft } 12488905a67cSAndy Whitcroft} 12498905a67cSAndy Whitcroft 12506c72ffaaSAndy Whitcroftmy $prefix = ''; 12516c72ffaaSAndy Whitcroft 1252000d1cc1SJoe Perchessub show_type { 1253000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1254000d1cc1SJoe Perches} 1255000d1cc1SJoe Perches 1256f0a594c1SAndy Whitcroftsub report { 1257000d1cc1SJoe Perches if (!show_type($_[1]) || 1258000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1259773647a0SAndy Whitcroft return 0; 1260773647a0SAndy Whitcroft } 1261000d1cc1SJoe Perches my $line; 1262000d1cc1SJoe Perches if ($show_types) { 1263000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1264000d1cc1SJoe Perches } else { 1265000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1266000d1cc1SJoe Perches } 12678905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12688905a67cSAndy Whitcroft 126913214adfSAndy Whitcroft push(our @report, $line); 1270773647a0SAndy Whitcroft 1271773647a0SAndy Whitcroft return 1; 1272f0a594c1SAndy Whitcroft} 1273f0a594c1SAndy Whitcroftsub report_dump { 127413214adfSAndy Whitcroft our @report; 1275f0a594c1SAndy Whitcroft} 1276000d1cc1SJoe Perches 1277de7d4f0eSAndy Whitcroftsub ERROR { 1278000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1279de7d4f0eSAndy Whitcroft our $clean = 0; 12806c72ffaaSAndy Whitcroft our $cnt_error++; 1281de7d4f0eSAndy Whitcroft } 1282773647a0SAndy Whitcroft} 1283de7d4f0eSAndy Whitcroftsub WARN { 1284000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1285de7d4f0eSAndy Whitcroft our $clean = 0; 12866c72ffaaSAndy Whitcroft our $cnt_warn++; 1287de7d4f0eSAndy Whitcroft } 1288773647a0SAndy Whitcroft} 1289de7d4f0eSAndy Whitcroftsub CHK { 1290000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1291de7d4f0eSAndy Whitcroft our $clean = 0; 12926c72ffaaSAndy Whitcroft our $cnt_chk++; 12936c72ffaaSAndy Whitcroft } 1294de7d4f0eSAndy Whitcroft} 1295de7d4f0eSAndy Whitcroft 12966ecd9674SAndy Whitcroftsub check_absolute_file { 12976ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 12986ecd9674SAndy Whitcroft my $file = $absolute; 12996ecd9674SAndy Whitcroft 13006ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 13016ecd9674SAndy Whitcroft 13026ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 13036ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 13046ecd9674SAndy Whitcroft if (-f "$root/$file") { 13056ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13066ecd9674SAndy Whitcroft last; 13076ecd9674SAndy Whitcroft } 13086ecd9674SAndy Whitcroft } 13096ecd9674SAndy Whitcroft if (! -f _) { 13106ecd9674SAndy Whitcroft return 0; 13116ecd9674SAndy Whitcroft } 13126ecd9674SAndy Whitcroft 13136ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13146ecd9674SAndy Whitcroft my $prefix = $absolute; 13156ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13166ecd9674SAndy Whitcroft 13176ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13186ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1319000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1320000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13216ecd9674SAndy Whitcroft } 13226ecd9674SAndy Whitcroft} 13236ecd9674SAndy Whitcroft 1324d1fe9c09SJoe Perchessub pos_last_openparen { 1325d1fe9c09SJoe Perches my ($line) = @_; 1326d1fe9c09SJoe Perches 1327d1fe9c09SJoe Perches my $pos = 0; 1328d1fe9c09SJoe Perches 1329d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1330d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1331d1fe9c09SJoe Perches 1332d1fe9c09SJoe Perches my $last_openparen = 0; 1333d1fe9c09SJoe Perches 1334d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1335d1fe9c09SJoe Perches return -1; 1336d1fe9c09SJoe Perches } 1337d1fe9c09SJoe Perches 1338d1fe9c09SJoe Perches my $len = length($line); 1339d1fe9c09SJoe Perches 1340d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1341d1fe9c09SJoe Perches my $string = substr($line, $pos); 1342d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1343d1fe9c09SJoe Perches $pos += length($1) - 1; 1344d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1345d1fe9c09SJoe Perches $last_openparen = $pos; 1346d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1347d1fe9c09SJoe Perches last; 1348d1fe9c09SJoe Perches } 1349d1fe9c09SJoe Perches } 1350d1fe9c09SJoe Perches 1351d1fe9c09SJoe Perches return $last_openparen + 1; 1352d1fe9c09SJoe Perches} 1353d1fe9c09SJoe Perches 13540a920b5bSAndy Whitcroftsub process { 13550a920b5bSAndy Whitcroft my $filename = shift; 13560a920b5bSAndy Whitcroft 13570a920b5bSAndy Whitcroft my $linenr=0; 13580a920b5bSAndy Whitcroft my $prevline=""; 1359c2fdda0dSAndy Whitcroft my $prevrawline=""; 13600a920b5bSAndy Whitcroft my $stashline=""; 1361c2fdda0dSAndy Whitcroft my $stashrawline=""; 13620a920b5bSAndy Whitcroft 13634a0df2efSAndy Whitcroft my $length; 13640a920b5bSAndy Whitcroft my $indent; 13650a920b5bSAndy Whitcroft my $previndent=0; 13660a920b5bSAndy Whitcroft my $stashindent=0; 13670a920b5bSAndy Whitcroft 1368de7d4f0eSAndy Whitcroft our $clean = 1; 13690a920b5bSAndy Whitcroft my $signoff = 0; 13700a920b5bSAndy Whitcroft my $is_patch = 0; 13710a920b5bSAndy Whitcroft 137215662b3eSJoe Perches my $in_header_lines = 1; 137315662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 137415662b3eSJoe Perches 1375fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1376fa64205dSPasi Savanainen 137713214adfSAndy Whitcroft our @report = (); 13786c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13796c72ffaaSAndy Whitcroft our $cnt_error = 0; 13806c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13816c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13826c72ffaaSAndy Whitcroft 13830a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13840a920b5bSAndy Whitcroft my $realfile = ''; 13850a920b5bSAndy Whitcroft my $realline = 0; 13860a920b5bSAndy Whitcroft my $realcnt = 0; 13870a920b5bSAndy Whitcroft my $here = ''; 13880a920b5bSAndy Whitcroft my $in_comment = 0; 1389c2fdda0dSAndy Whitcroft my $comment_edge = 0; 13900a920b5bSAndy Whitcroft my $first_line = 0; 13911e855726SWolfram Sang my $p1_prefix = ''; 13920a920b5bSAndy Whitcroft 139313214adfSAndy Whitcroft my $prev_values = 'E'; 139413214adfSAndy Whitcroft 139513214adfSAndy Whitcroft # suppression flags 1396773647a0SAndy Whitcroft my %suppress_ifbraces; 1397170d3a22SAndy Whitcroft my %suppress_whiletrailers; 13982b474a1aSAndy Whitcroft my %suppress_export; 13993e469cdcSAndy Whitcroft my $suppress_statement = 0; 1400653d4876SAndy Whitcroft 1401323c1260SJoe Perches my %camelcase = (); 1402323c1260SJoe Perches 1403c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1404de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1405c2fdda0dSAndy Whitcroft # 1406de7d4f0eSAndy Whitcroft my @setup_docs = (); 1407de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1408773647a0SAndy Whitcroft 1409773647a0SAndy Whitcroft sanitise_line_reset(); 1410c2fdda0dSAndy Whitcroft my $line; 1411c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1412773647a0SAndy Whitcroft $linenr++; 1413773647a0SAndy Whitcroft $line = $rawline; 1414c2fdda0dSAndy Whitcroft 1415773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1416de7d4f0eSAndy Whitcroft $setup_docs = 0; 1417de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1418de7d4f0eSAndy Whitcroft $setup_docs = 1; 1419de7d4f0eSAndy Whitcroft } 1420773647a0SAndy Whitcroft #next; 1421de7d4f0eSAndy Whitcroft } 1422773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1423773647a0SAndy Whitcroft $realline=$1-1; 1424773647a0SAndy Whitcroft if (defined $2) { 1425773647a0SAndy Whitcroft $realcnt=$3+1; 1426773647a0SAndy Whitcroft } else { 1427773647a0SAndy Whitcroft $realcnt=1+1; 1428773647a0SAndy Whitcroft } 1429c45dcabdSAndy Whitcroft $in_comment = 0; 1430773647a0SAndy Whitcroft 1431773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1432773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1433773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1434773647a0SAndy Whitcroft # at context start. 1435773647a0SAndy Whitcroft my $edge; 143601fa9147SAndy Whitcroft my $cnt = $realcnt; 143701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 143801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 143901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 144001fa9147SAndy Whitcroft $cnt--; 144101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1442721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1443fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1444fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1445fae17daeSAndy Whitcroft ($edge) = $1; 1446fae17daeSAndy Whitcroft last; 1447fae17daeSAndy Whitcroft } 1448773647a0SAndy Whitcroft } 1449773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1450773647a0SAndy Whitcroft $in_comment = 1; 1451773647a0SAndy Whitcroft } 1452773647a0SAndy Whitcroft 1453773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1454773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1455773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1456773647a0SAndy Whitcroft if (!defined $edge && 145783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1458773647a0SAndy Whitcroft { 1459773647a0SAndy Whitcroft $in_comment = 1; 1460773647a0SAndy Whitcroft } 1461773647a0SAndy Whitcroft 1462773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1463773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1464773647a0SAndy Whitcroft 1465171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1466773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1467171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1468773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1469773647a0SAndy Whitcroft } 1470773647a0SAndy Whitcroft push(@lines, $line); 1471773647a0SAndy Whitcroft 1472773647a0SAndy Whitcroft if ($realcnt > 1) { 1473773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1474773647a0SAndy Whitcroft } else { 1475773647a0SAndy Whitcroft $realcnt = 0; 1476773647a0SAndy Whitcroft } 1477773647a0SAndy Whitcroft 1478773647a0SAndy Whitcroft #print "==>$rawline\n"; 1479773647a0SAndy Whitcroft #print "-->$line\n"; 1480de7d4f0eSAndy Whitcroft 1481de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1482de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1483de7d4f0eSAndy Whitcroft } 1484de7d4f0eSAndy Whitcroft } 1485de7d4f0eSAndy Whitcroft 14866c72ffaaSAndy Whitcroft $prefix = ''; 14876c72ffaaSAndy Whitcroft 1488773647a0SAndy Whitcroft $realcnt = 0; 1489773647a0SAndy Whitcroft $linenr = 0; 14900a920b5bSAndy Whitcroft foreach my $line (@lines) { 14910a920b5bSAndy Whitcroft $linenr++; 14920a920b5bSAndy Whitcroft 1493c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 14946c72ffaaSAndy Whitcroft 14950a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 14966c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14970a920b5bSAndy Whitcroft $is_patch = 1; 14984a0df2efSAndy Whitcroft $first_line = $linenr + 1; 14990a920b5bSAndy Whitcroft $realline=$1-1; 15000a920b5bSAndy Whitcroft if (defined $2) { 15010a920b5bSAndy Whitcroft $realcnt=$3+1; 15020a920b5bSAndy Whitcroft } else { 15030a920b5bSAndy Whitcroft $realcnt=1+1; 15040a920b5bSAndy Whitcroft } 1505c2fdda0dSAndy Whitcroft annotate_reset(); 150613214adfSAndy Whitcroft $prev_values = 'E'; 150713214adfSAndy Whitcroft 1508773647a0SAndy Whitcroft %suppress_ifbraces = (); 1509170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 15102b474a1aSAndy Whitcroft %suppress_export = (); 15113e469cdcSAndy Whitcroft $suppress_statement = 0; 15120a920b5bSAndy Whitcroft next; 15130a920b5bSAndy Whitcroft 15144a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 15154a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 15164a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1517773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 15180a920b5bSAndy Whitcroft $realline++; 1519d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 15200a920b5bSAndy Whitcroft 15214a0df2efSAndy Whitcroft # Measure the line length and indent. 1522c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 15230a920b5bSAndy Whitcroft 15240a920b5bSAndy Whitcroft # Track the previous line. 15250a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 15260a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1527c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1528c2fdda0dSAndy Whitcroft 1529773647a0SAndy Whitcroft #warn "line<$line>\n"; 15306c72ffaaSAndy Whitcroft 1531d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1532d8aaf121SAndy Whitcroft $realcnt--; 15330a920b5bSAndy Whitcroft } 15340a920b5bSAndy Whitcroft 1535cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1536cc77cdcaSAndy Whitcroft 15370a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1538773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1539773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1540773647a0SAndy Whitcroft 15416c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15426c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1543773647a0SAndy Whitcroft 1544773647a0SAndy Whitcroft # extract the filename as it passes 15453bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15463bf9a009SRabin Vincent $realfile = $1; 15473bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1548270c49a0SJoe Perches $in_commit_log = 0; 15493bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1550773647a0SAndy Whitcroft $realfile = $1; 15511e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1552270c49a0SJoe Perches $in_commit_log = 0; 15531e855726SWolfram Sang 15541e855726SWolfram Sang $p1_prefix = $1; 1555e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1556e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1557000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1558000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15591e855726SWolfram Sang } 1560773647a0SAndy Whitcroft 1561c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1562000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1563000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1564773647a0SAndy Whitcroft } 1565773647a0SAndy Whitcroft next; 1566773647a0SAndy Whitcroft } 1567773647a0SAndy Whitcroft 1568389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15690a920b5bSAndy Whitcroft 1570c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1571c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1572c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15730a920b5bSAndy Whitcroft 15746c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15756c72ffaaSAndy Whitcroft 15763bf9a009SRabin Vincent# Check for incorrect file permissions 15773bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15783bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 15793bf9a009SRabin Vincent if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1580000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1581000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15823bf9a009SRabin Vincent } 15833bf9a009SRabin Vincent } 15843bf9a009SRabin Vincent 158520112475SJoe Perches# Check the patch for a signoff: 1586d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15874a0df2efSAndy Whitcroft $signoff++; 158815662b3eSJoe Perches $in_commit_log = 0; 15890a920b5bSAndy Whitcroft } 159020112475SJoe Perches 159120112475SJoe Perches# Check signature styles 1592270c49a0SJoe Perches if (!$in_header_lines && 1593ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 159420112475SJoe Perches my $space_before = $1; 159520112475SJoe Perches my $sign_off = $2; 159620112475SJoe Perches my $space_after = $3; 159720112475SJoe Perches my $email = $4; 159820112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 159920112475SJoe Perches 1600ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1601ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1602ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1603ce0338dfSJoe Perches } 160420112475SJoe Perches if (defined $space_before && $space_before ne "") { 1605000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1606000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 160720112475SJoe Perches } 160820112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1609000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1610000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 161120112475SJoe Perches } 161220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1613000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1614000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 161520112475SJoe Perches } 161620112475SJoe Perches 161720112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 161820112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 161920112475SJoe Perches if ($suggested_email eq "") { 1620000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1621000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 162220112475SJoe Perches } else { 162320112475SJoe Perches my $dequoted = $suggested_email; 162420112475SJoe Perches $dequoted =~ s/^"//; 162520112475SJoe Perches $dequoted =~ s/" </ </; 162620112475SJoe Perches # Don't force email to have quotes 162720112475SJoe Perches # Allow just an angle bracketed address 162820112475SJoe Perches if ("$dequoted$comment" ne $email && 162920112475SJoe Perches "<$email_address>$comment" ne $email && 163020112475SJoe Perches "$suggested_email$comment" ne $email) { 1631000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1632000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 163320112475SJoe Perches } 16340a920b5bSAndy Whitcroft } 16350a920b5bSAndy Whitcroft } 16360a920b5bSAndy Whitcroft 163700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 16388905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1639000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1640000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 16416c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1642de7d4f0eSAndy Whitcroft } 1643de7d4f0eSAndy Whitcroft 16446ecd9674SAndy Whitcroft# Check for absolute kernel paths. 16456ecd9674SAndy Whitcroft if ($tree) { 16466ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 16476ecd9674SAndy Whitcroft my $file = $1; 16486ecd9674SAndy Whitcroft 16496ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16506ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16516ecd9674SAndy Whitcroft # 16526ecd9674SAndy Whitcroft } else { 16536ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16546ecd9674SAndy Whitcroft } 16556ecd9674SAndy Whitcroft } 16566ecd9674SAndy Whitcroft } 16576ecd9674SAndy Whitcroft 1658de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1659de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1660171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1661171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1662171ae1a4SAndy Whitcroft 1663171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1664171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1665171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1666171ae1a4SAndy Whitcroft 166734d99219SJoe Perches CHK("INVALID_UTF8", 1668000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 166900df344fSAndy Whitcroft } 16700a920b5bSAndy Whitcroft 167115662b3eSJoe Perches# Check if it's the start of a commit log 167215662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 167315662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1674270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 167515662b3eSJoe Perches $in_header_lines = 0; 167615662b3eSJoe Perches $in_commit_log = 1; 167715662b3eSJoe Perches } 167815662b3eSJoe Perches 1679fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1680fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1681fa64205dSPasi Savanainen if ($in_header_lines && 1682fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1683fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1684fa64205dSPasi Savanainen $non_utf8_charset = 1; 1685fa64205dSPasi Savanainen } 1686fa64205dSPasi Savanainen 1687fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 168815662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1689fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 169015662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 169115662b3eSJoe Perches } 169215662b3eSJoe Perches 169330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 169430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 169500df344fSAndy Whitcroft 16960a920b5bSAndy Whitcroft#trailing whitespace 16979c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1698c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1699000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1700000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 17019c0ca6f9SAndy Whitcroft 1702c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1703c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1704000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1705000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1706d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17070a920b5bSAndy Whitcroft } 17085368df20SAndy Whitcroft 17093354957aSAndi Kleen# check for Kconfig help text having a real description 17109fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 17119fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 17123354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1713a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 17143354957aSAndi Kleen my $length = 0; 17159fe287d7SAndy Whitcroft my $cnt = $realcnt; 17169fe287d7SAndy Whitcroft my $ln = $linenr + 1; 17179fe287d7SAndy Whitcroft my $f; 1718a1385803SAndy Whitcroft my $is_start = 0; 17199fe287d7SAndy Whitcroft my $is_end = 0; 1720a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 17219fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 17229fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 17239fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 17249fe287d7SAndy Whitcroft 17259fe287d7SAndy Whitcroft next if ($f =~ /^-/); 1726a1385803SAndy Whitcroft 1727a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1728a1385803SAndy Whitcroft $is_start = 1; 1729a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1730a1385803SAndy Whitcroft $length = -1; 1731a1385803SAndy Whitcroft } 1732a1385803SAndy Whitcroft 17339fe287d7SAndy Whitcroft $f =~ s/^.//; 17343354957aSAndi Kleen $f =~ s/#.*//; 17353354957aSAndi Kleen $f =~ s/^\s+//; 17363354957aSAndi Kleen next if ($f =~ /^$/); 17379fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 17389fe287d7SAndy Whitcroft $is_end = 1; 17399fe287d7SAndy Whitcroft last; 17409fe287d7SAndy Whitcroft } 17413354957aSAndi Kleen $length++; 17423354957aSAndi Kleen } 1743000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1744a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 1745a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 17463354957aSAndi Kleen } 17473354957aSAndi Kleen 17481ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 17491ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 17501ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 17511ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 17521ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 17531ba8dfd1SKees Cook } 17541ba8dfd1SKees Cook 1755c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1756c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1757c68e5878SArnaud Lacombe my $flag = $1; 1758c68e5878SArnaud Lacombe my $replacement = { 1759c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1760c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1761c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1762c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1763c68e5878SArnaud Lacombe }; 1764c68e5878SArnaud Lacombe 1765c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1766c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1767c68e5878SArnaud Lacombe } 1768c68e5878SArnaud Lacombe 17695368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 17705368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 17715368df20SAndy Whitcroft 17726cd7f386SJoe Perches#line length limit 1773c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1774f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 17750fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 17768bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 17776cd7f386SJoe Perches $length > $max_line_length) 1778c45dcabdSAndy Whitcroft { 1779000d1cc1SJoe Perches WARN("LONG_LINE", 17806cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 17810a920b5bSAndy Whitcroft } 17820a920b5bSAndy Whitcroft 1783ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 1784ca56dc09SJosh Triplett# to grep for the string. Limited to strings used as parameters (those 1785ca56dc09SJosh Triplett# following an open parenthesis), which almost completely eliminates false 1786ca56dc09SJosh Triplett# positives, as well as warning only once per parameter rather than once per 1787ca56dc09SJosh Triplett# line of the string. Make an exception when the previous string ends in a 1788ca56dc09SJosh Triplett# newline (multiple lines in one string constant) or \n\t (common in inline 1789ca56dc09SJosh Triplett# assembly to indent the instruction on the following line). 1790ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 1791ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 1792ca56dc09SJosh Triplett $prevline =~ /\(/ && 1793ca56dc09SJosh Triplett $prevrawline !~ /\\n(?:\\t)*"\s*$/) { 1794ca56dc09SJosh Triplett WARN("SPLIT_STRING", 1795ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 1796ca56dc09SJosh Triplett } 1797ca56dc09SJosh Triplett 17985e79d96eSJoe Perches# check for spaces before a quoted newline 17995e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1800000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1801000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 18025e79d96eSJoe Perches } 18035e79d96eSJoe Perches 18048905a67cSAndy Whitcroft# check for adding lines without a newline. 18058905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1806000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1807000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 18088905a67cSAndy Whitcroft } 18098905a67cSAndy Whitcroft 181042e41c54SMike Frysinger# Blackfin: use hi/lo macros 181142e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 181242e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 181342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1814000d1cc1SJoe Perches ERROR("LO_MACRO", 1815000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 181642e41c54SMike Frysinger } 181742e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 181842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1819000d1cc1SJoe Perches ERROR("HI_MACRO", 1820000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 182142e41c54SMike Frysinger } 182242e41c54SMike Frysinger } 182342e41c54SMike Frysinger 1824b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1825b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 18260a920b5bSAndy Whitcroft 18270a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 18280a920b5bSAndy Whitcroft# more than 8 must use tabs. 1829c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1830c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1831c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1832000d1cc1SJoe Perches ERROR("CODE_INDENT", 1833000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1834d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 18350a920b5bSAndy Whitcroft } 18360a920b5bSAndy Whitcroft 183708e44365SAlberto Panizzo# check for space before tabs. 183808e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 183908e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1840000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1841000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 184208e44365SAlberto Panizzo } 184308e44365SAlberto Panizzo 1844d1fe9c09SJoe Perches# check for && or || at the start of a line 1845d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 1846d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 1847d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 1848d1fe9c09SJoe Perches } 1849d1fe9c09SJoe Perches 1850d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 1851d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 1852d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 1853d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 1854d1fe9c09SJoe Perches my $oldindent = $1; 1855d1fe9c09SJoe Perches my $rest = $2; 1856d1fe9c09SJoe Perches 1857d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 1858d1fe9c09SJoe Perches if ($pos >= 0) { 1859b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 1860b34a26f3SJoe Perches my $newindent = $2; 1861d1fe9c09SJoe Perches 1862d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 1863d1fe9c09SJoe Perches "\t" x ($pos / 8) . 1864d1fe9c09SJoe Perches " " x ($pos % 8); 1865d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 1866d1fe9c09SJoe Perches 1867d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 1868d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 1869d1fe9c09SJoe Perches CHK("PARENTHESIS_ALIGNMENT", 1870d1fe9c09SJoe Perches "Alignment should match open parenthesis\n" . $hereprev); 1871d1fe9c09SJoe Perches } 1872d1fe9c09SJoe Perches } 1873d1fe9c09SJoe Perches } 1874d1fe9c09SJoe Perches 1875aad4f614SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) { 1876aad4f614SJoe Perches CHK("SPACING", 1877aad4f614SJoe Perches "No space is necessary after a cast\n" . $hereprev); 1878aad4f614SJoe Perches } 1879aad4f614SJoe Perches 188005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 188105880600SJoe Perches $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 188205880600SJoe Perches $prevrawline =~ /^\+[ \t]*$/) { 188305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 188405880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 188505880600SJoe Perches } 188605880600SJoe Perches 188705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 1888c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 1889c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 1890c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 1891c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 189205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 189305880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 189405880600SJoe Perches } 189505880600SJoe Perches 18965f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 18976b4c5bebSAndy Whitcroft# Exceptions: 18986b4c5bebSAndy Whitcroft# 1) within comments 18996b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 19006b4c5bebSAndy Whitcroft# 3) hanging labels 19016b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 19025f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1903000d1cc1SJoe Perches WARN("LEADING_SPACE", 1904000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 19055f7ddae6SRaffaele Recalcati } 19065f7ddae6SRaffaele Recalcati 1907b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1908b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1909b9ea10d6SAndy Whitcroft 19101ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 19111ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 19121ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 19131ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 19141ba8dfd1SKees Cook } 19151ba8dfd1SKees Cook 1916c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1917cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1918000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1919000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1920c2fdda0dSAndy Whitcroft } 192122f2a2efSAndy Whitcroft 192242e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 192342e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 192442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1925000d1cc1SJoe Perches ERROR("CSYNC", 1926000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 192742e41c54SMike Frysinger } 192842e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 192942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1930000d1cc1SJoe Perches ERROR("SSYNC", 1931000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 193242e41c54SMike Frysinger } 193342e41c54SMike Frysinger 19349c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 19352b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 19362b474a1aSAndy Whitcroft $realline_next); 19373e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 19383e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 19393e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 1940170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1941f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1942171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1943171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1944171ae1a4SAndy Whitcroft 19453e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 19463e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 19473e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 19483e469cdcSAndy Whitcroft # until we hit end of it. 19493e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 19503e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 19513e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 19523e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 19533e469cdcSAndy Whitcroft } 1954f74bd194SAndy Whitcroft 19552b474a1aSAndy Whitcroft # Find the real next line. 19562b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 19572b474a1aSAndy Whitcroft if (defined $realline_next && 19582b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 19592b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 19602b474a1aSAndy Whitcroft $realline_next++; 19612b474a1aSAndy Whitcroft } 19622b474a1aSAndy Whitcroft 1963171ae1a4SAndy Whitcroft my $s = $stat; 1964171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1965cf655043SAndy Whitcroft 1966c2fdda0dSAndy Whitcroft # Ignore goto labels. 1967171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1968c2fdda0dSAndy Whitcroft 1969c2fdda0dSAndy Whitcroft # Ignore functions being called 1970171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1971c2fdda0dSAndy Whitcroft 1972463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1973463f2864SAndy Whitcroft 1974c45dcabdSAndy Whitcroft # declarations always start with types 1975d2506586SAndy 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) { 1976c45dcabdSAndy Whitcroft my $type = $1; 1977c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1978c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1979c45dcabdSAndy Whitcroft 19806c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1981a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1982c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1983c2fdda0dSAndy Whitcroft } 19848905a67cSAndy Whitcroft 19856c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 198665863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1987c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 19889c0ca6f9SAndy Whitcroft } 19898905a67cSAndy Whitcroft 19908905a67cSAndy Whitcroft # Check for any sort of function declaration. 19918905a67cSAndy Whitcroft # int foo(something bar, other baz); 19928905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1993171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 19948905a67cSAndy Whitcroft my ($name_len) = length($1); 19958905a67cSAndy Whitcroft 1996cf655043SAndy Whitcroft my $ctx = $s; 1997773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 19988905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1999cf655043SAndy Whitcroft 20008905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2001c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 20028905a67cSAndy Whitcroft 2003c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 20048905a67cSAndy Whitcroft } 20058905a67cSAndy Whitcroft } 20068905a67cSAndy Whitcroft } 20078905a67cSAndy Whitcroft 20089c0ca6f9SAndy Whitcroft } 20099c0ca6f9SAndy Whitcroft 201000df344fSAndy Whitcroft# 201100df344fSAndy Whitcroft# Checks which may be anchored in the context. 201200df344fSAndy Whitcroft# 201300df344fSAndy Whitcroft 201400df344fSAndy Whitcroft# Check for switch () and associated case and default 201500df344fSAndy Whitcroft# statements should be at the same indent. 201600df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 201700df344fSAndy Whitcroft my $err = ''; 201800df344fSAndy Whitcroft my $sep = ''; 201900df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 202000df344fSAndy Whitcroft shift(@ctx); 202100df344fSAndy Whitcroft for my $ctx (@ctx) { 202200df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 202300df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 202400df344fSAndy Whitcroft $indent != $cindent) { 202500df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 202600df344fSAndy Whitcroft $sep = ''; 202700df344fSAndy Whitcroft } else { 202800df344fSAndy Whitcroft $sep = "[...]\n"; 202900df344fSAndy Whitcroft } 203000df344fSAndy Whitcroft } 203100df344fSAndy Whitcroft if ($err ne '') { 2032000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2033000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2034de7d4f0eSAndy Whitcroft } 2035de7d4f0eSAndy Whitcroft } 2036de7d4f0eSAndy Whitcroft 2037de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2038de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2039c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2040773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2041773647a0SAndy Whitcroft 20429c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 20438eef05ddSJoe Perches 20448eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 20458eef05ddSJoe Perches WARN("DEEP_INDENTATION", 20468eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 20478eef05ddSJoe Perches } 20488eef05ddSJoe Perches 2049de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2050de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2051de7d4f0eSAndy Whitcroft 2052548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2053548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2054de7d4f0eSAndy Whitcroft 2055548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2056548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2057548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2058548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2059548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2060773647a0SAndy Whitcroft $ctx_ln++; 2061773647a0SAndy Whitcroft } 2062548596d5SAndy Whitcroft 206353210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 206453210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2065773647a0SAndy Whitcroft 2066773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2067000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2068000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 206901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 207000df344fSAndy Whitcroft } 2071773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2072773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2073773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2074773647a0SAndy Whitcroft { 20759c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 20769c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2077000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2078000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 207901464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 20809c0ca6f9SAndy Whitcroft } 20819c0ca6f9SAndy Whitcroft } 208200df344fSAndy Whitcroft } 208300df344fSAndy Whitcroft 20844d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 20854d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 20863e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 20873e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 20883e469cdcSAndy Whitcroft if (!defined $stat); 20894d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 20904d001e4dSAndy Whitcroft 20914d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 20924d001e4dSAndy Whitcroft 20934d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 20944d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 20954d001e4dSAndy Whitcroft # where necessary. 20964d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 20974d001e4dSAndy Whitcroft 20984d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 20996f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 21006f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 21014d001e4dSAndy Whitcroft 21024d001e4dSAndy Whitcroft # We want to check the first line inside the block 21034d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 21044d001e4dSAndy Whitcroft # 1) any blank line termination 21054d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 21064d001e4dSAndy Whitcroft # 3) any do (...) { 21074d001e4dSAndy Whitcroft my $continuation = 0; 21084d001e4dSAndy Whitcroft my $check = 0; 21094d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 21104d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 21114d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 21124d001e4dSAndy Whitcroft $continuation = 1; 21134d001e4dSAndy Whitcroft } 21149bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 21154d001e4dSAndy Whitcroft $check = 1; 21164d001e4dSAndy Whitcroft $cond_lines++; 21174d001e4dSAndy Whitcroft } 21184d001e4dSAndy Whitcroft 21194d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 21204d001e4dSAndy Whitcroft # preprocessor statement. 21214d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 21224d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 21234d001e4dSAndy Whitcroft $check = 0; 21244d001e4dSAndy Whitcroft } 21254d001e4dSAndy Whitcroft 21269bd49efeSAndy Whitcroft my $cond_ptr = -1; 2127740504c6SAndy Whitcroft $continuation = 0; 21289bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 21299bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 21304d001e4dSAndy Whitcroft 2131f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2132f16fa28fSAndy Whitcroft # is not linear. 2133f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2134f16fa28fSAndy Whitcroft $check = 0; 2135f16fa28fSAndy Whitcroft } 2136f16fa28fSAndy Whitcroft 21379bd49efeSAndy Whitcroft # Ignore: 21389bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 21399bd49efeSAndy Whitcroft # 2) preprocessor lines, and 21409bd49efeSAndy Whitcroft # 3) labels. 2141740504c6SAndy Whitcroft if ($continuation || 2142740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 21439bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 21449bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2145740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 214630dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 21479bd49efeSAndy Whitcroft $cond_lines++; 21489bd49efeSAndy Whitcroft } 21494d001e4dSAndy Whitcroft } 215030dad6ebSAndy Whitcroft } 21514d001e4dSAndy Whitcroft 21524d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 21534d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 21544d001e4dSAndy Whitcroft 21554d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 21564d001e4dSAndy Whitcroft # this is not this patch's fault. 21574d001e4dSAndy Whitcroft if (!defined($stat_real) || 21584d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 21594d001e4dSAndy Whitcroft $check = 0; 21604d001e4dSAndy Whitcroft } 21614d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 21624d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 21634d001e4dSAndy Whitcroft } 21644d001e4dSAndy Whitcroft 21659bd49efeSAndy 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"; 21664d001e4dSAndy Whitcroft 21674d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 21684d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2169000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2170000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 21714d001e4dSAndy Whitcroft } 21724d001e4dSAndy Whitcroft } 21734d001e4dSAndy Whitcroft 21746c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 21756c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 21761f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 21771f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 21786c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2179c2fdda0dSAndy Whitcroft if ($dbg_values) { 2180c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2181cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2182cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 21831f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2184c2fdda0dSAndy Whitcroft } 21856c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 21866c72ffaaSAndy Whitcroft 218700df344fSAndy Whitcroft#ignore lines not being added 218800df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 218900df344fSAndy Whitcroft 2190653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 21917429c690SAndy Whitcroft if ($dbg_type) { 21927429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2193000d1cc1SJoe Perches ERROR("TEST_TYPE", 2194000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 21957429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2196000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2197000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 21987429c690SAndy Whitcroft } 2199653d4876SAndy Whitcroft next; 2200653d4876SAndy Whitcroft } 2201a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2202a1ef277eSAndy Whitcroft if ($dbg_attr) { 22039360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2204000d1cc1SJoe Perches ERROR("TEST_ATTR", 2205000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 22069360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2207000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2208000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2209a1ef277eSAndy Whitcroft } 2210a1ef277eSAndy Whitcroft next; 2211a1ef277eSAndy Whitcroft } 2212653d4876SAndy Whitcroft 2213f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 221499423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 221599423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2216000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2217000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2218f0a594c1SAndy Whitcroft } 2219f0a594c1SAndy Whitcroft 222000df344fSAndy Whitcroft# 222100df344fSAndy Whitcroft# Checks which are anchored on the added line. 222200df344fSAndy Whitcroft# 222300df344fSAndy Whitcroft 2224653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2225c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2226653d4876SAndy Whitcroft my $path = $1; 2227653d4876SAndy Whitcroft if ($path =~ m{//}) { 2228000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2229495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2230495e9d84SJoe Perches } 2231495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2232495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2233495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2234653d4876SAndy Whitcroft } 2235653d4876SAndy Whitcroft } 2236653d4876SAndy Whitcroft 223700df344fSAndy Whitcroft# no C99 // comments 223800df344fSAndy Whitcroft if ($line =~ m{//}) { 2239000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2240000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 224100df344fSAndy Whitcroft } 224200df344fSAndy Whitcroft # Remove C99 comments. 22430a920b5bSAndy Whitcroft $line =~ s@//.*@@; 22446c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 22450a920b5bSAndy Whitcroft 22462b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 22472b474a1aSAndy Whitcroft# the whole statement. 22482b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 22492b474a1aSAndy Whitcroft if (defined $realline_next && 22502b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 22512b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 22522b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22532b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22543cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 22553cbf62dfSAndy Whitcroft # a prefix: 22563cbf62dfSAndy Whitcroft # XXX(foo); 22573cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2258653d4876SAndy Whitcroft my $name = $1; 225987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 22603cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 22613cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 22623cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 22633cbf62dfSAndy Whitcroft 22643cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 22652b474a1aSAndy Whitcroft \n.}\s*$| 226648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 226748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 226848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 22692b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 22702b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 227148012058SAndy Whitcroft )/x) { 22722b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 22732b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 22742b474a1aSAndy Whitcroft } else { 22752b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 22760a920b5bSAndy Whitcroft } 22770a920b5bSAndy Whitcroft } 22782b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 22792b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 22802b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 22812b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 22822b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 22832b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 22842b474a1aSAndy Whitcroft } 22852b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 22862b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2287000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2288000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 22892b474a1aSAndy Whitcroft } 22900a920b5bSAndy Whitcroft 22915150bda4SJoe Eloff# check for global initialisers. 2292c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2293000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2294000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2295f0a594c1SAndy Whitcroft $herecurr); 2296f0a594c1SAndy Whitcroft } 22970a920b5bSAndy Whitcroft# check for static initialisers. 22982d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2299000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2300000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2301de7d4f0eSAndy Whitcroft $herecurr); 23020a920b5bSAndy Whitcroft } 23030a920b5bSAndy Whitcroft 2304cb710ecaSJoe Perches# check for static const char * arrays. 2305cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2306000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2307000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2308cb710ecaSJoe Perches $herecurr); 2309cb710ecaSJoe Perches } 2310cb710ecaSJoe Perches 2311cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2312cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2313000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2314000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2315cb710ecaSJoe Perches $herecurr); 2316cb710ecaSJoe Perches } 2317cb710ecaSJoe Perches 231893ed0e2dSJoe Perches# check for declarations of struct pci_device_id 231993ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2320000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2321000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 232293ed0e2dSJoe Perches } 232393ed0e2dSJoe Perches 2324653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2325653d4876SAndy Whitcroft# make sense. 2326653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 23278054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2328c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 23298ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2330653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2331000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2332000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 23330a920b5bSAndy Whitcroft } 23340a920b5bSAndy Whitcroft 23350a920b5bSAndy Whitcroft# * goes on variable not on type 233665863862SAndy Whitcroft # (char*[ const]) 2337bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2338bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 2339bfcb2cc7SAndy Whitcroft my ($from, $to) = ($2, $2); 2340d8aaf121SAndy Whitcroft 234165863862SAndy Whitcroft # Should start with a space. 234265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 234365863862SAndy Whitcroft # Should not end with a space. 234465863862SAndy Whitcroft $to =~ s/\s+$//; 234565863862SAndy Whitcroft # '*'s should not have spaces between. 2346f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 234765863862SAndy Whitcroft } 2348d8aaf121SAndy Whitcroft 234965863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 235065863862SAndy Whitcroft if ($from ne $to) { 2351000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2352000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 235365863862SAndy Whitcroft } 2354bfcb2cc7SAndy Whitcroft } 2355bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2356bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 2357bfcb2cc7SAndy Whitcroft my ($from, $to, $ident) = ($2, $2, $3); 2358d8aaf121SAndy Whitcroft 235965863862SAndy Whitcroft # Should start with a space. 236065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 236165863862SAndy Whitcroft # Should not end with a space. 236265863862SAndy Whitcroft $to =~ s/\s+$//; 236365863862SAndy Whitcroft # '*'s should not have spaces between. 2364f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 236565863862SAndy Whitcroft } 236665863862SAndy Whitcroft # Modifiers should have spaces. 236765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 236865863862SAndy Whitcroft 2369667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2370667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2371000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2372000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 237365863862SAndy Whitcroft } 23740a920b5bSAndy Whitcroft } 23750a920b5bSAndy Whitcroft 23760a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 23770a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 23780a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 23790a920b5bSAndy Whitcroft# print "$herecurr"; 23800a920b5bSAndy Whitcroft# $clean = 0; 23810a920b5bSAndy Whitcroft# } 23820a920b5bSAndy Whitcroft 23838905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2384000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2385000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 23868905a67cSAndy Whitcroft } 23878905a67cSAndy Whitcroft 238817441227SJoe Perches# check for uses of printk_ratelimit 238917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2390000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2391000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 239217441227SJoe Perches } 239317441227SJoe Perches 239400df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 239500df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 239600df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 239725985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 239800df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2399f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 240000df344fSAndy Whitcroft my $ok = 0; 240100df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 240200df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 240325985edcSLucas De Marchi # we have a preceding printk if it ends 240400df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 240500df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 240600df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 240700df344fSAndy Whitcroft $ok = 1; 240800df344fSAndy Whitcroft } 240900df344fSAndy Whitcroft last; 241000df344fSAndy Whitcroft } 241100df344fSAndy Whitcroft } 241200df344fSAndy Whitcroft if ($ok == 0) { 2413000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2414000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 24150a920b5bSAndy Whitcroft } 241600df344fSAndy Whitcroft } 24170a920b5bSAndy Whitcroft 2418243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2419243f3803SJoe Perches my $orig = $1; 2420243f3803SJoe Perches my $level = lc($orig); 2421243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 24228f26b837SJoe Perches my $level2 = $level; 24238f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2424243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 24258f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2426243f3803SJoe Perches } 2427243f3803SJoe Perches 2428243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2429243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2430243f3803SJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); 2431243f3803SJoe Perches } 2432243f3803SJoe Perches 2433653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2434653d4876SAndy Whitcroft# or if closed on same line 2435c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2436c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2437000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2438000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 24390a920b5bSAndy Whitcroft } 2440653d4876SAndy Whitcroft 24418905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 24428905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 24438905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2444000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2445000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 24468905a67cSAndy Whitcroft } 24478905a67cSAndy Whitcroft 24480c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 24490c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2450000d1cc1SJoe Perches WARN("SPACING", 2451000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 24520c73b4ebSAndy Whitcroft } 24530c73b4ebSAndy Whitcroft 24548d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 24558d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2456fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2457fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 24588d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 24598d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 24608d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2461fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2462daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 2463000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2464000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 24658d31cfceSAndy Whitcroft } 24668d31cfceSAndy Whitcroft } 24678d31cfceSAndy Whitcroft 2468f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 24696c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2470c2fdda0dSAndy Whitcroft my $name = $1; 2471773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2472773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2473c2fdda0dSAndy Whitcroft 2474c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2475773647a0SAndy Whitcroft if ($name =~ /^(?: 2476773647a0SAndy Whitcroft if|for|while|switch|return|case| 2477773647a0SAndy Whitcroft volatile|__volatile__| 2478773647a0SAndy Whitcroft __attribute__|format|__extension__| 2479773647a0SAndy Whitcroft asm|__asm__)$/x) 2480773647a0SAndy Whitcroft { 2481c2fdda0dSAndy Whitcroft 2482c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2483c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2484c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2485c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2486773647a0SAndy Whitcroft 2487773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2488c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2489c2fdda0dSAndy Whitcroft 2490c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2491c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2492773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2493c2fdda0dSAndy Whitcroft 2494c2fdda0dSAndy Whitcroft } else { 2495000d1cc1SJoe Perches WARN("SPACING", 2496000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2497f0a594c1SAndy Whitcroft } 24986c72ffaaSAndy Whitcroft } 24999a4cad4eSEric Nelson 25009a4cad4eSEric Nelson# check for whitespace before a non-naked semicolon 25019a4cad4eSEric Nelson if ($line =~ /^\+.*\S\s+;/) { 25029a4cad4eSEric Nelson CHK("SPACING", 25039a4cad4eSEric Nelson "space prohibited before semicolon\n" . $herecurr); 25049a4cad4eSEric Nelson } 25059a4cad4eSEric Nelson 2506653d4876SAndy Whitcroft# Check operator spacing. 25070a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 25089c0ca6f9SAndy Whitcroft my $ops = qr{ 25099c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 25109c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 25119c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 25121f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 25131f65f947SAndy Whitcroft \?|: 25149c0ca6f9SAndy Whitcroft }x; 2515cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 251600df344fSAndy Whitcroft my $off = 0; 25176c72ffaaSAndy Whitcroft 25186c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 25196c72ffaaSAndy Whitcroft 25200a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 25214a0df2efSAndy Whitcroft $off += length($elements[$n]); 25224a0df2efSAndy Whitcroft 252325985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2524773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2525773647a0SAndy Whitcroft my $cc = ''; 2526773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2527773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2528773647a0SAndy Whitcroft } 2529773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2530773647a0SAndy Whitcroft 25314a0df2efSAndy Whitcroft my $a = ''; 25324a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 25334a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2534cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 25354a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 25364a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2537773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 25384a0df2efSAndy Whitcroft 25390a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 25404a0df2efSAndy Whitcroft 25414a0df2efSAndy Whitcroft my $c = ''; 25420a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 25434a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 25444a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2545cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 25464a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 25474a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 25488b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 25494a0df2efSAndy Whitcroft } else { 25504a0df2efSAndy Whitcroft $c = 'E'; 25510a920b5bSAndy Whitcroft } 25520a920b5bSAndy Whitcroft 25534a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 25544a0df2efSAndy Whitcroft 25554a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 25564a0df2efSAndy Whitcroft 25576c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2558de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 25590a920b5bSAndy Whitcroft 256074048ed8SAndy Whitcroft # Pull out the value of this operator. 25616c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 25620a920b5bSAndy Whitcroft 25631f65f947SAndy Whitcroft # Get the full operator variant. 25641f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 25651f65f947SAndy Whitcroft 256613214adfSAndy Whitcroft # Ignore operators passed as parameters. 256713214adfSAndy Whitcroft if ($op_type ne 'V' && 256813214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 256913214adfSAndy Whitcroft 2570cf655043SAndy Whitcroft# # Ignore comments 2571cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 257213214adfSAndy Whitcroft 2573d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 257413214adfSAndy Whitcroft } elsif ($op eq ';') { 2575cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2576cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2577000d1cc1SJoe Perches ERROR("SPACING", 2578000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2579d8aaf121SAndy Whitcroft } 2580d8aaf121SAndy Whitcroft 2581d8aaf121SAndy Whitcroft # // is a comment 2582d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 25830a920b5bSAndy Whitcroft 25841f65f947SAndy Whitcroft # No spaces for: 25851f65f947SAndy Whitcroft # -> 25861f65f947SAndy Whitcroft # : when part of a bitfield 25871f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 25884a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2589000d1cc1SJoe Perches ERROR("SPACING", 2590000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 25910a920b5bSAndy Whitcroft } 25920a920b5bSAndy Whitcroft 25930a920b5bSAndy Whitcroft # , must have a space on the right. 25940a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2595cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2596000d1cc1SJoe Perches ERROR("SPACING", 2597000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 25980a920b5bSAndy Whitcroft } 25990a920b5bSAndy Whitcroft 26009c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 260174048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 26029c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 26039c0ca6f9SAndy Whitcroft 26049c0ca6f9SAndy Whitcroft # unary operators should have a space before and 26059c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 26069c0ca6f9SAndy Whitcroft # unary operator, or a cast 26079c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 260874048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 26090d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2610cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2611000d1cc1SJoe Perches ERROR("SPACING", 2612000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 26130a920b5bSAndy Whitcroft } 2614a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2615171ae1a4SAndy Whitcroft # A unary '*' may be const 2616171ae1a4SAndy Whitcroft 2617171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2618000d1cc1SJoe Perches ERROR("SPACING", 2619000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 26200a920b5bSAndy Whitcroft } 26210a920b5bSAndy Whitcroft 26220a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 26230a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2624773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2625000d1cc1SJoe Perches ERROR("SPACING", 2626000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 26270a920b5bSAndy Whitcroft } 2628773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2629773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2630000d1cc1SJoe Perches ERROR("SPACING", 2631000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2632653d4876SAndy Whitcroft } 2633773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2634000d1cc1SJoe Perches ERROR("SPACING", 2635000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2636773647a0SAndy Whitcroft } 2637773647a0SAndy Whitcroft 26380a920b5bSAndy Whitcroft 26390a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 26409c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 26419c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 26429c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2643c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2644c2fdda0dSAndy Whitcroft $op eq '%') 26450a920b5bSAndy Whitcroft { 2646773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2647000d1cc1SJoe Perches ERROR("SPACING", 2648000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2649de7d4f0eSAndy Whitcroft $hereptr); 26500a920b5bSAndy Whitcroft } 26510a920b5bSAndy Whitcroft 26521f65f947SAndy Whitcroft # A colon needs no spaces before when it is 26531f65f947SAndy Whitcroft # terminating a case value or a label. 26541f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 26551f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2656000d1cc1SJoe Perches ERROR("SPACING", 2657000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 26581f65f947SAndy Whitcroft } 26591f65f947SAndy Whitcroft 26600a920b5bSAndy Whitcroft # All the others need spaces both sides. 2661cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 26621f65f947SAndy Whitcroft my $ok = 0; 26631f65f947SAndy Whitcroft 266422f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 26651f65f947SAndy Whitcroft if (($op eq '<' && 26661f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 26671f65f947SAndy Whitcroft ($op eq '>' && 26681f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 26691f65f947SAndy Whitcroft { 26701f65f947SAndy Whitcroft $ok = 1; 26711f65f947SAndy Whitcroft } 26721f65f947SAndy Whitcroft 26731f65f947SAndy Whitcroft # Ignore ?: 26741f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 26751f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 26761f65f947SAndy Whitcroft $ok = 1; 26771f65f947SAndy Whitcroft } 26781f65f947SAndy Whitcroft 26791f65f947SAndy Whitcroft if ($ok == 0) { 2680000d1cc1SJoe Perches ERROR("SPACING", 2681000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 26820a920b5bSAndy Whitcroft } 268322f2a2efSAndy Whitcroft } 26844a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 26850a920b5bSAndy Whitcroft } 26860a920b5bSAndy Whitcroft } 26870a920b5bSAndy Whitcroft 2688f0a594c1SAndy Whitcroft# check for multiple assignments 2689f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2690000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2691000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2692f0a594c1SAndy Whitcroft } 2693f0a594c1SAndy Whitcroft 269422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 269522f2a2efSAndy Whitcroft## # continuation. 269622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 269722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 269822f2a2efSAndy Whitcroft## 269922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 270022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 270122f2a2efSAndy Whitcroft## my $ln = $line; 270222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 270322f2a2efSAndy Whitcroft## } 270422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2705000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2706000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 270722f2a2efSAndy Whitcroft## } 270822f2a2efSAndy Whitcroft## } 2709f0a594c1SAndy Whitcroft 27100a920b5bSAndy Whitcroft#need space before brace following if, while, etc 271122f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 271222f2a2efSAndy Whitcroft $line =~ /do{/) { 2713000d1cc1SJoe Perches ERROR("SPACING", 2714000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2715de7d4f0eSAndy Whitcroft } 2716de7d4f0eSAndy Whitcroft 2717de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2718de7d4f0eSAndy Whitcroft# on the line 2719de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2720000d1cc1SJoe Perches ERROR("SPACING", 2721000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 27220a920b5bSAndy Whitcroft } 27230a920b5bSAndy Whitcroft 272422f2a2efSAndy Whitcroft# check spacing on square brackets 272522f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2726000d1cc1SJoe Perches ERROR("SPACING", 2727000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 272822f2a2efSAndy Whitcroft } 272922f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2730000d1cc1SJoe Perches ERROR("SPACING", 2731000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 273222f2a2efSAndy Whitcroft } 273322f2a2efSAndy Whitcroft 2734c45dcabdSAndy Whitcroft# check spacing on parentheses 27359c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 27369c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2737000d1cc1SJoe Perches ERROR("SPACING", 2738000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 273922f2a2efSAndy Whitcroft } 274013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2741c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2742c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2743000d1cc1SJoe Perches ERROR("SPACING", 2744000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 274522f2a2efSAndy Whitcroft } 274622f2a2efSAndy Whitcroft 27470a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 27484a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 27490a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2750000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2751000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 27520a920b5bSAndy Whitcroft } 27530a920b5bSAndy Whitcroft 2754c45dcabdSAndy Whitcroft# Return is not a function. 2755c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2756c45dcabdSAndy Whitcroft my $spacing = $1; 2757c45dcabdSAndy Whitcroft my $value = $2; 2758c45dcabdSAndy Whitcroft 275986f9d059SAndy Whitcroft # Flatten any parentheses 2760fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2761fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 2762e01886adSAndy Whitcroft while ($value =~ s/\[[^\[\]]*\]/1/ || 276363f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 276463f17f89SAndy Whitcroft $Compare\s* 276563f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 276663f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2767c45dcabdSAndy Whitcroft } 2768fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2769fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2770000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2771000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2772c45dcabdSAndy Whitcroft 2773c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2774000d1cc1SJoe Perches ERROR("SPACING", 2775000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2776c45dcabdSAndy Whitcroft } 2777c45dcabdSAndy Whitcroft } 277853a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 277953a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 278053a3c448SAndy Whitcroft my $name = $1; 278153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2782000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2783000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 278453a3c448SAndy Whitcroft } 278553a3c448SAndy Whitcroft } 2786c45dcabdSAndy Whitcroft 27870a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 27884a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2789000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 27900a920b5bSAndy Whitcroft } 27910a920b5bSAndy Whitcroft 2792f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2793f5fe35ddSAndy Whitcroft# statements after the conditional. 2794170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 27953e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 27963e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 27973e469cdcSAndy Whitcroft if (!defined $stat); 2798170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2799170d3a22SAndy Whitcroft $remain_next, $off_next); 2800170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2801170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2802170d3a22SAndy Whitcroft 2803170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2804170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2805170d3a22SAndy Whitcroft # then count those as offsets. 2806170d3a22SAndy Whitcroft my ($whitespace) = 2807170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2808170d3a22SAndy Whitcroft my $offset = 2809170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2810170d3a22SAndy Whitcroft 2811170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2812170d3a22SAndy Whitcroft $offset} = 1; 2813170d3a22SAndy Whitcroft } 2814170d3a22SAndy Whitcroft } 2815170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2816170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2817171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 28188905a67cSAndy Whitcroft 2819b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2820000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2821000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 28228905a67cSAndy Whitcroft } 28238905a67cSAndy Whitcroft 28248905a67cSAndy Whitcroft # Find out what is on the end of the line after the 28258905a67cSAndy Whitcroft # conditional. 2826773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 28278905a67cSAndy Whitcroft $s =~ s/\n.*//g; 282813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 282953210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 283053210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2831773647a0SAndy Whitcroft { 2832bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2833bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2834bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 283542bdf74cSHidetoshi Seto my $stat_real = ''; 2836bb44ad39SAndy Whitcroft 283742bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 283842bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2839bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2840bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2841bb44ad39SAndy Whitcroft } 2842bb44ad39SAndy Whitcroft 2843000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2844000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 28458905a67cSAndy Whitcroft } 28468905a67cSAndy Whitcroft } 28478905a67cSAndy Whitcroft 284813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 284913214adfSAndy Whitcroft if ($line =~ / 285013214adfSAndy Whitcroft (?: 285113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 285213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 285313214adfSAndy Whitcroft (?:\&\&|\|\|) 285413214adfSAndy Whitcroft | 285513214adfSAndy Whitcroft (?:\&\&|\|\|) 285613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 285713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 285813214adfSAndy Whitcroft )/x) 285913214adfSAndy Whitcroft { 2860000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2861000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 286213214adfSAndy Whitcroft } 286313214adfSAndy Whitcroft 28648905a67cSAndy Whitcroft# if and else should not have general statements after it 286513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 286613214adfSAndy Whitcroft my $s = $1; 286713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 286813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2869000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2870000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 28710a920b5bSAndy Whitcroft } 287213214adfSAndy Whitcroft } 287339667782SAndy Whitcroft# if should not continue a brace 287439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2875000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2876000d1cc1SJoe Perches "trailing statements should be on next line\n" . 287739667782SAndy Whitcroft $herecurr); 287839667782SAndy Whitcroft } 2879a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2880a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2881a1080bf8SAndy Whitcroft $line !~ /\G(?: 28823fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2883a1080bf8SAndy Whitcroft \s*return\s+ 2884a1080bf8SAndy Whitcroft )/xg) 2885a1080bf8SAndy Whitcroft { 2886000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2887000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2888a1080bf8SAndy Whitcroft } 28890a920b5bSAndy Whitcroft 28900a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 28910a920b5bSAndy Whitcroft # indent level to be relevant to each other. 28920a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 28930a920b5bSAndy Whitcroft $previndent == $indent) { 2894000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2895000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 28960a920b5bSAndy Whitcroft } 28970a920b5bSAndy Whitcroft 2898c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2899c2fdda0dSAndy Whitcroft $previndent == $indent) { 2900c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2901c2fdda0dSAndy Whitcroft 2902c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2903c2fdda0dSAndy Whitcroft # conditional. 2904773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2905c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2906c2fdda0dSAndy Whitcroft 2907c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2908000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2909000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2910c2fdda0dSAndy Whitcroft } 2911c2fdda0dSAndy Whitcroft } 2912c2fdda0dSAndy Whitcroft 2913323c1260SJoe Perches#CamelCase 2914323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 2915323c1260SJoe Perches my $var = $1; 2916323c1260SJoe Perches if ($var !~ /$Constant/ && 2917323c1260SJoe Perches $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ && 2918323c1260SJoe Perches !defined $camelcase{$var}) { 2919323c1260SJoe Perches $camelcase{$var} = 1; 2920323c1260SJoe Perches WARN("CAMELCASE", 2921323c1260SJoe Perches "Avoid CamelCase: <$var>\n" . $herecurr); 2922323c1260SJoe Perches } 2923323c1260SJoe Perches } 29240a920b5bSAndy Whitcroft 29250a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2926c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2927000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2928000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 29290a920b5bSAndy Whitcroft } 29300a920b5bSAndy Whitcroft 2931653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2932c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2933e09dec48SAndy Whitcroft my $file = "$1.h"; 2934e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2935e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2936e09dec48SAndy Whitcroft $realfile ne $checkfile && 29377840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2938c45dcabdSAndy Whitcroft { 2939e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2940000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2941000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2942e09dec48SAndy Whitcroft } else { 2943000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2944000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2945e09dec48SAndy Whitcroft } 29460a920b5bSAndy Whitcroft } 29470a920b5bSAndy Whitcroft } 29480a920b5bSAndy Whitcroft 2949653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2950653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2951cf655043SAndy Whitcroft# in a known good container 2952b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2953b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2954d8aaf121SAndy Whitcroft my $ln = $linenr; 2955d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2956c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2957c45dcabdSAndy Whitcroft my $ctx = ''; 2958c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2959f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2960f74bd194SAndy Whitcroft $ctx = $dstat; 2961c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2962a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2963c45dcabdSAndy Whitcroft 2964f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2965292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2966c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2967c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2968c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2969c45dcabdSAndy Whitcroft 2970c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2971bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2972bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2973c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 2974bf30d6edSAndy Whitcroft { 2975c45dcabdSAndy Whitcroft } 2976c45dcabdSAndy Whitcroft 2977e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 2978e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 2979e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 2980e45bab8eSAndy Whitcroft { 2981e45bab8eSAndy Whitcroft } 2982e45bab8eSAndy Whitcroft 2983c45dcabdSAndy Whitcroft my $exceptions = qr{ 2984c45dcabdSAndy Whitcroft $Declare| 2985c45dcabdSAndy Whitcroft module_param_named| 2986a0a0a7a9SKees Cook MODULE_PARM_DESC| 2987c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2988c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2989383099fdSAndy Whitcroft __typeof__\(| 299022fd2d3eSStefani Seibold union| 299122fd2d3eSStefani Seibold struct| 2992ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2993ea71a0a0SAndy Whitcroft ^\"|\"$ 2994c45dcabdSAndy Whitcroft }x; 29955eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2996f74bd194SAndy Whitcroft if ($dstat ne '' && 2997f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 2998f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 2999fd1b57acSAndy Whitcroft $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo 3000b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3001f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3002f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 300372f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3004f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3005f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3006f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3007f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 3008c45dcabdSAndy Whitcroft { 3009f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3010f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3011f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3012f74bd194SAndy Whitcroft 3013f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3014f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3015c45dcabdSAndy Whitcroft } 3016c45dcabdSAndy Whitcroft 3017f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3018f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3019f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3020f74bd194SAndy Whitcroft } else { 3021000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3022f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3023d8aaf121SAndy Whitcroft } 30240a920b5bSAndy Whitcroft } 30255023d347SJoe Perches 3026481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 30275023d347SJoe Perches 30285023d347SJoe Perches } else { 30295023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3030481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3031481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 30325023d347SJoe Perches $line =~ /^\+.*\\$/) { 30335023d347SJoe Perches WARN("LINE_CONTINUATIONS", 30345023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 30355023d347SJoe Perches } 3036653d4876SAndy Whitcroft } 30370a920b5bSAndy Whitcroft 3038b13edf7fSJoe Perches# do {} while (0) macro tests: 3039b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3040b13edf7fSJoe Perches# macro should not end with a semicolon 3041b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3042b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3043b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3044b13edf7fSJoe Perches my $ln = $linenr; 3045b13edf7fSJoe Perches my $cnt = $realcnt; 3046b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3047b13edf7fSJoe Perches my $ctx = ''; 3048b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3049b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3050b13edf7fSJoe Perches $ctx = $dstat; 3051b13edf7fSJoe Perches 3052b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3053b13edf7fSJoe Perches 3054b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3055b13edf7fSJoe Perches my $stmts = $2; 3056b13edf7fSJoe Perches my $semis = $3; 3057b13edf7fSJoe Perches 3058b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3059b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3060b13edf7fSJoe Perches my $herectx = $here . "\n"; 3061b13edf7fSJoe Perches 3062b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3063b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3064b13edf7fSJoe Perches } 3065b13edf7fSJoe Perches 3066ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3067ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3068b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3069b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3070b13edf7fSJoe Perches } 3071b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3072b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3073b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3074b13edf7fSJoe Perches } 3075b13edf7fSJoe Perches } 3076b13edf7fSJoe Perches } 3077b13edf7fSJoe Perches 3078080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3079080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3080080ba929SMike Frysinger# . 3081080ba929SMike Frysinger# ALIGN(...) 3082080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3083080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3084000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3085000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3086080ba929SMike Frysinger } 3087080ba929SMike Frysinger 3088f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 308913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 309013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3091cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 309213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3093cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3094cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3095aad4f614SJoe Perches my @allowed = (); 3096aad4f614SJoe Perches my $allow = 0; 309713214adfSAndy Whitcroft my $seen = 0; 3098773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3099cf655043SAndy Whitcroft my $ln = $linenr - 1; 310013214adfSAndy Whitcroft for my $chunk (@chunks) { 310113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 310213214adfSAndy Whitcroft 3103773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3104773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3105773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3106773647a0SAndy Whitcroft 3107aad4f614SJoe Perches $allowed[$allow] = 0; 3108773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3109773647a0SAndy Whitcroft 3110773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3111773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3112773647a0SAndy Whitcroft 3113773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3114cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3115cf655043SAndy Whitcroft 3116773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 311713214adfSAndy Whitcroft 311813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 311913214adfSAndy Whitcroft 3120aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3121cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3122cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3123aad4f614SJoe Perches $allowed[$allow] = 1; 312413214adfSAndy Whitcroft } 312513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3126cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3127aad4f614SJoe Perches $allowed[$allow] = 1; 312813214adfSAndy Whitcroft } 3129cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3130cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3131aad4f614SJoe Perches $allowed[$allow] = 1; 313213214adfSAndy Whitcroft } 3133aad4f614SJoe Perches $allow++; 313413214adfSAndy Whitcroft } 3135aad4f614SJoe Perches if ($seen) { 3136aad4f614SJoe Perches my $sum_allowed = 0; 3137aad4f614SJoe Perches foreach (@allowed) { 3138aad4f614SJoe Perches $sum_allowed += $_; 3139aad4f614SJoe Perches } 3140aad4f614SJoe Perches if ($sum_allowed == 0) { 3141000d1cc1SJoe Perches WARN("BRACES", 3142000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3143aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3144aad4f614SJoe Perches $seen != $allow) { 3145aad4f614SJoe Perches CHK("BRACES", 3146aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3147aad4f614SJoe Perches } 314813214adfSAndy Whitcroft } 314913214adfSAndy Whitcroft } 315013214adfSAndy Whitcroft } 3151773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 315213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3153cf655043SAndy Whitcroft my $allowed = 0; 3154f0a594c1SAndy Whitcroft 3155cf655043SAndy Whitcroft # Check the pre-context. 3156cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3157cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3158cf655043SAndy Whitcroft $allowed = 1; 3159f0a594c1SAndy Whitcroft } 3160773647a0SAndy Whitcroft 3161773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3162773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3163773647a0SAndy Whitcroft 3164cf655043SAndy Whitcroft # Check the condition. 3165cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3166773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3167cf655043SAndy Whitcroft if (defined $cond) { 3168773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3169cf655043SAndy Whitcroft } 3170cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3171cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3172cf655043SAndy Whitcroft $allowed = 1; 3173cf655043SAndy Whitcroft } 3174cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3175cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3176cf655043SAndy Whitcroft $allowed = 1; 3177cf655043SAndy Whitcroft } 3178cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3179cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3180cf655043SAndy Whitcroft $allowed = 1; 3181cf655043SAndy Whitcroft } 3182cf655043SAndy Whitcroft # Check the post-context. 3183cf655043SAndy Whitcroft if (defined $chunks[1]) { 3184cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3185cf655043SAndy Whitcroft if (defined $cond) { 3186773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3187cf655043SAndy Whitcroft } 3188cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3189cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3190cf655043SAndy Whitcroft $allowed = 1; 3191cf655043SAndy Whitcroft } 3192cf655043SAndy Whitcroft } 3193cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 319469932487SJustin P. Mattock my $herectx = $here . "\n"; 3195f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3196cf655043SAndy Whitcroft 3197f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 319869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3199cf655043SAndy Whitcroft } 3200cf655043SAndy Whitcroft 3201000d1cc1SJoe Perches WARN("BRACES", 3202000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3203f0a594c1SAndy Whitcroft } 3204f0a594c1SAndy Whitcroft } 3205f0a594c1SAndy Whitcroft 32060979ae66SJoe Perches# check for unnecessary blank lines around braces 32070979ae66SJoe Perches if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) { 32080979ae66SJoe Perches CHK("BRACES", 32090979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 32100979ae66SJoe Perches } 32110979ae66SJoe Perches if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 32120979ae66SJoe Perches CHK("BRACES", 32130979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 32140979ae66SJoe Perches } 32150979ae66SJoe Perches 32164a0df2efSAndy Whitcroft# no volatiles please 32176c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 32186c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3219000d1cc1SJoe Perches WARN("VOLATILE", 3220000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 32214a0df2efSAndy Whitcroft } 32224a0df2efSAndy Whitcroft 322300df344fSAndy Whitcroft# warn about #if 0 3224c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3225000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3226000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3227de7d4f0eSAndy Whitcroft $herecurr); 32284a0df2efSAndy Whitcroft } 32294a0df2efSAndy Whitcroft 323003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 323103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 323203df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 323303df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 323403df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 323503df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 32364c432a8fSGreg Kroah-Hartman } 32374c432a8fSGreg Kroah-Hartman } 3238f0a594c1SAndy Whitcroft 32391a15a250SPatrick Pannuto# prefer usleep_range over udelay 32401a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 32411a15a250SPatrick Pannuto # ignore udelay's < 10, however 32421a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3243000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3244000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 32451a15a250SPatrick Pannuto } 32461a15a250SPatrick Pannuto } 32471a15a250SPatrick Pannuto 324809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 324909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 325009ef8725SPatrick Pannuto if ($1 < 20) { 3251000d1cc1SJoe Perches WARN("MSLEEP", 3252000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 325309ef8725SPatrick Pannuto } 325409ef8725SPatrick Pannuto } 325509ef8725SPatrick Pannuto 325600df344fSAndy Whitcroft# warn about #ifdefs in C files 3257c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 325800df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 325900df344fSAndy Whitcroft# print "$herecurr"; 326000df344fSAndy Whitcroft# $clean = 0; 326100df344fSAndy Whitcroft# } 326200df344fSAndy Whitcroft 326322f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3264c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3265000d1cc1SJoe Perches ERROR("SPACING", 3266000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 326722f2a2efSAndy Whitcroft } 326822f2a2efSAndy Whitcroft 32694a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3270171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3271171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 32724a0df2efSAndy Whitcroft my $which = $1; 32734a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3274000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3275000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 32764a0df2efSAndy Whitcroft } 32774a0df2efSAndy Whitcroft } 32784a0df2efSAndy Whitcroft# check for memory barriers without a comment. 32794a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 32804a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3281000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3282000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 32834a0df2efSAndy Whitcroft } 32844a0df2efSAndy Whitcroft } 32854a0df2efSAndy Whitcroft# check of hardware specific defines 3286c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3287000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3288000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 32890a920b5bSAndy Whitcroft } 3290653d4876SAndy Whitcroft 3291d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3292d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3293000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3294000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3295d4977c78STobias Klauser } 3296d4977c78STobias Klauser 3297de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3298de7d4f0eSAndy Whitcroft# storage class and type. 32999c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 33009c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3301000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3302000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3303de7d4f0eSAndy Whitcroft } 3304de7d4f0eSAndy Whitcroft 33058905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 33068905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3307000d1cc1SJoe Perches WARN("INLINE", 3308000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 33098905a67cSAndy Whitcroft } 33108905a67cSAndy Whitcroft 33113d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 33123d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3313000d1cc1SJoe Perches WARN("PREFER_PACKED", 3314000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 33153d130fd0SJoe Perches } 33163d130fd0SJoe Perches 331739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 331839b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3319000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3320000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 332139b7e287SJoe Perches } 332239b7e287SJoe Perches 33235f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 33245f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 33255f14d3bdSJoe Perches WARN("PREFER_PRINTF", 33265f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 33275f14d3bdSJoe Perches } 33285f14d3bdSJoe Perches 33296061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 33306061d949SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 33316061d949SJoe Perches WARN("PREFER_SCANF", 33326061d949SJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); 33336061d949SJoe Perches } 33346061d949SJoe Perches 33358f53a9b8SJoe Perches# check for sizeof(&) 33368f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3337000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3338000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 33398f53a9b8SJoe Perches } 33408f53a9b8SJoe Perches 334166c80b60SJoe Perches# check for sizeof without parenthesis 334266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 334366c80b60SJoe Perches WARN("SIZEOF_PARENTHESIS", 334466c80b60SJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr); 334566c80b60SJoe Perches } 334666c80b60SJoe Perches 3347428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3348428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3349000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3350000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3351428e2fdcSJoe Perches } 3352428e2fdcSJoe Perches 335388982feaSJoe Perches# check for struct spinlock declarations 335488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 335588982feaSJoe Perches WARN("USE_SPINLOCK_T", 335688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 335788982feaSJoe Perches } 335888982feaSJoe Perches 3359554e165cSAndy Whitcroft# Check for misused memsets 3360d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3361d1fe9c09SJoe Perches defined $stat && 3362d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3363554e165cSAndy Whitcroft 3364d7c76ba7SJoe Perches my $ms_addr = $2; 3365d1fe9c09SJoe Perches my $ms_val = $7; 3366d1fe9c09SJoe Perches my $ms_size = $12; 3367d7c76ba7SJoe Perches 3368554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3369554e165cSAndy Whitcroft ERROR("MEMSET", 3370d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3371554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3372554e165cSAndy Whitcroft WARN("MEMSET", 3373d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3374d7c76ba7SJoe Perches } 3375d7c76ba7SJoe Perches } 3376d7c76ba7SJoe Perches 3377d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3378d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3379d1fe9c09SJoe Perches defined $stat && 3380d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3381d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3382d7c76ba7SJoe Perches my $call = $1; 3383d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3384d7c76ba7SJoe Perches my $arg1 = $3; 3385d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3386d1fe9c09SJoe Perches my $arg2 = $8; 3387d7c76ba7SJoe Perches my $cast; 3388d7c76ba7SJoe Perches 3389d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3390d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3391d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3392d7c76ba7SJoe Perches $cast = $cast1; 3393d7c76ba7SJoe Perches } else { 3394d7c76ba7SJoe Perches $cast = $cast2; 3395d7c76ba7SJoe Perches } 3396d7c76ba7SJoe Perches WARN("MINMAX", 3397d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3398554e165cSAndy Whitcroft } 3399554e165cSAndy Whitcroft } 3400554e165cSAndy Whitcroft 34014a273195SJoe Perches# check usleep_range arguments 34024a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 34034a273195SJoe Perches defined $stat && 34044a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 34054a273195SJoe Perches my $min = $1; 34064a273195SJoe Perches my $max = $7; 34074a273195SJoe Perches if ($min eq $max) { 34084a273195SJoe Perches WARN("USLEEP_RANGE", 34094a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34104a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 34114a273195SJoe Perches $min > $max) { 34124a273195SJoe Perches WARN("USLEEP_RANGE", 34134a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 34144a273195SJoe Perches } 34154a273195SJoe Perches } 34164a273195SJoe Perches 3417de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3418171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3419c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3420171ae1a4SAndy Whitcroft { 3421c45dcabdSAndy Whitcroft my $function_name = $1; 3422c45dcabdSAndy Whitcroft my $paren_space = $2; 3423171ae1a4SAndy Whitcroft 3424171ae1a4SAndy Whitcroft my $s = $stat; 3425171ae1a4SAndy Whitcroft if (defined $cond) { 3426171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3427171ae1a4SAndy Whitcroft } 3428c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3429c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3430c45dcabdSAndy Whitcroft { 3431000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3432000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3433de7d4f0eSAndy Whitcroft } 3434de7d4f0eSAndy Whitcroft 3435171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3436000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3437000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3438171ae1a4SAndy Whitcroft } 34399c9ba34eSAndy Whitcroft 34409c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 34419c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 34429c9ba34eSAndy Whitcroft { 3443000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3444000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3445171ae1a4SAndy Whitcroft } 3446171ae1a4SAndy Whitcroft 3447de7d4f0eSAndy Whitcroft# checks for new __setup's 3448de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3449de7d4f0eSAndy Whitcroft my $name = $1; 3450de7d4f0eSAndy Whitcroft 3451de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3452000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3453000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3454de7d4f0eSAndy Whitcroft } 3455653d4876SAndy Whitcroft } 34569c0ca6f9SAndy Whitcroft 34579c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3458caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3459000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3460000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 34619c0ca6f9SAndy Whitcroft } 346213214adfSAndy Whitcroft 3463caf2a54fSJoe Perches# check for multiple semicolons 3464caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3465000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3466000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3467d1e2ad07SJoe Perches } 3468d1e2ad07SJoe Perches 3469d1e2ad07SJoe Perches# check for switch/default statements without a break; 3470d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 3471d1e2ad07SJoe Perches defined $stat && 3472d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 3473d1e2ad07SJoe Perches my $ctx = ''; 3474d1e2ad07SJoe Perches my $herectx = $here . "\n"; 3475d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 3476d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3477d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3478d1e2ad07SJoe Perches } 3479d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 3480d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 3481caf2a54fSJoe Perches } 3482caf2a54fSJoe Perches 348313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 348413214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3485000d1cc1SJoe Perches WARN("USE_FUNC", 3486000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 348713214adfSAndy Whitcroft } 3488773647a0SAndy Whitcroft 34892c92488aSJoe Perches# check for use of yield() 34902c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 34912c92488aSJoe Perches WARN("YIELD", 34922c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 34932c92488aSJoe Perches } 34942c92488aSJoe Perches 34954882720bSThomas Gleixner# check for semaphores initialized locked 34964882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3497000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3498000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 3499773647a0SAndy Whitcroft } 35006712d858SJoe Perches 350167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 350267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3503000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 350467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3505773647a0SAndy Whitcroft } 35066712d858SJoe Perches 3507f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3508f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3509000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3510000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3511f3db6639SMichael Ellerman } 35126712d858SJoe Perches 351379404849SEmese Revfy# check for various ops structs, ensure they are const. 351479404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 351579404849SEmese Revfy address_space_operations| 351679404849SEmese Revfy backlight_ops| 351779404849SEmese Revfy block_device_operations| 351879404849SEmese Revfy dentry_operations| 351979404849SEmese Revfy dev_pm_ops| 352079404849SEmese Revfy dma_map_ops| 352179404849SEmese Revfy extent_io_ops| 352279404849SEmese Revfy file_lock_operations| 352379404849SEmese Revfy file_operations| 352479404849SEmese Revfy hv_ops| 352579404849SEmese Revfy ide_dma_ops| 352679404849SEmese Revfy intel_dvo_dev_ops| 352779404849SEmese Revfy item_operations| 352879404849SEmese Revfy iwl_ops| 352979404849SEmese Revfy kgdb_arch| 353079404849SEmese Revfy kgdb_io| 353179404849SEmese Revfy kset_uevent_ops| 353279404849SEmese Revfy lock_manager_operations| 353379404849SEmese Revfy microcode_ops| 353479404849SEmese Revfy mtrr_ops| 353579404849SEmese Revfy neigh_ops| 353679404849SEmese Revfy nlmsvc_binding| 353779404849SEmese Revfy pci_raw_ops| 353879404849SEmese Revfy pipe_buf_operations| 353979404849SEmese Revfy platform_hibernation_ops| 354079404849SEmese Revfy platform_suspend_ops| 354179404849SEmese Revfy proto_ops| 354279404849SEmese Revfy rpc_pipe_ops| 354379404849SEmese Revfy seq_operations| 354479404849SEmese Revfy snd_ac97_build_ops| 354579404849SEmese Revfy soc_pcmcia_socket_ops| 354679404849SEmese Revfy stacktrace_ops| 354779404849SEmese Revfy sysfs_ops| 354879404849SEmese Revfy tty_operations| 354979404849SEmese Revfy usb_mon_operations| 355079404849SEmese Revfy wd_ops}x; 35516903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 355279404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3553000d1cc1SJoe Perches WARN("CONST_STRUCT", 3554000d1cc1SJoe Perches "struct $1 should normally be const\n" . 35556903ffb2SAndy Whitcroft $herecurr); 35562b6db5cbSAndy Whitcroft } 3557773647a0SAndy Whitcroft 3558773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3559773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3560773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3561c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3562c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3563171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3564171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3565171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3566773647a0SAndy Whitcroft { 3567000d1cc1SJoe Perches WARN("NR_CPUS", 3568000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3569773647a0SAndy Whitcroft } 35709c9ba34eSAndy Whitcroft 35719c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 35729c9ba34eSAndy Whitcroft my $string; 35739c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 35749c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 35752a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 35769c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3577000d1cc1SJoe Perches WARN("PRINTF_L", 3578000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 35799c9ba34eSAndy Whitcroft last; 35809c9ba34eSAndy Whitcroft } 35819c9ba34eSAndy Whitcroft } 3582691d77b6SAndy Whitcroft 3583691d77b6SAndy Whitcroft# whine mightly about in_atomic 3584691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3585691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3586000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3587000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3588f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3589000d1cc1SJoe Perches WARN("IN_ATOMIC", 3590000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3591691d77b6SAndy Whitcroft } 3592691d77b6SAndy Whitcroft } 35931704f47bSPeter Zijlstra 35941704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 35951704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 35961704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 35971704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 35981704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 35991704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3600000d1cc1SJoe Perches ERROR("LOCKDEP", 3601000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 36021704f47bSPeter Zijlstra } 36031704f47bSPeter Zijlstra } 360488f8831cSDave Jones 360588f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 360688f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3607000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3608000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 360988f8831cSDave Jones } 361013214adfSAndy Whitcroft } 361113214adfSAndy Whitcroft 361213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 361313214adfSAndy Whitcroft # so just keep quiet. 361413214adfSAndy Whitcroft if ($#rawlines == -1) { 361513214adfSAndy Whitcroft exit(0); 36160a920b5bSAndy Whitcroft } 36170a920b5bSAndy Whitcroft 36188905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 36198905a67cSAndy Whitcroft # things that appear to be patches. 36208905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 36218905a67cSAndy Whitcroft exit(0); 36228905a67cSAndy Whitcroft } 36238905a67cSAndy Whitcroft 36248905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 36258905a67cSAndy Whitcroft # just keep quiet. 36268905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 36278905a67cSAndy Whitcroft exit(0); 36288905a67cSAndy Whitcroft } 36298905a67cSAndy Whitcroft 36308905a67cSAndy Whitcroft if (!$is_patch) { 3631000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3632000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 36330a920b5bSAndy Whitcroft } 36340a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3635000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3636000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 36370a920b5bSAndy Whitcroft } 36380a920b5bSAndy Whitcroft 3639f0a594c1SAndy Whitcroft print report_dump(); 364013214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 364113214adfSAndy Whitcroft print "$filename " if ($summary_file); 36426c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 36436c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 36446c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 36458905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 36466c72ffaaSAndy Whitcroft } 36478905a67cSAndy Whitcroft 3648d2c0a235SAndy Whitcroft if ($quiet == 0) { 3649d1fe9c09SJoe Perches 3650d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 3651d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 3652d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 3653d1fe9c09SJoe Perches } 3654d1fe9c09SJoe Perches 3655d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3656d2c0a235SAndy Whitcroft # then suggest that. 3657d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3658d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3659d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3660b0781216SMike Frysinger $rpt_cleaners = 0; 3661d2c0a235SAndy Whitcroft } 3662d2c0a235SAndy Whitcroft } 3663d2c0a235SAndy Whitcroft 366411232688SArtem Bityutskiy if ($quiet == 0 && keys %ignore_type) { 3665000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3666000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3667000d1cc1SJoe Perches print " $ignore"; 3668000d1cc1SJoe Perches } 366911232688SArtem Bityutskiy print "\n\n"; 3670000d1cc1SJoe Perches } 3671000d1cc1SJoe Perches 36720a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3673c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 36740a920b5bSAndy Whitcroft } 36750a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3676000d1cc1SJoe Perches print << "EOM"; 3677000d1cc1SJoe Perches$vname has style problems, please review. 3678000d1cc1SJoe Perches 3679000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3680000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3681000d1cc1SJoe PerchesEOM 36820a920b5bSAndy Whitcroft } 368313214adfSAndy Whitcroft 36840a920b5bSAndy Whitcroft return $clean; 36850a920b5bSAndy Whitcroft} 3686