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; 9c707a81dSJoe Perchesuse POSIX; 100a920b5bSAndy Whitcroft 110a920b5bSAndy Whitcroftmy $P = $0; 1200df344fSAndy Whitcroft$P =~ s@.*/@@g; 130a920b5bSAndy Whitcroft 14000d1cc1SJoe Perchesmy $V = '0.32'; 150a920b5bSAndy Whitcroft 160a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $quiet = 0; 190a920b5bSAndy Whitcroftmy $tree = 1; 200a920b5bSAndy Whitcroftmy $chk_signoff = 1; 210a920b5bSAndy Whitcroftmy $chk_patch = 1; 22773647a0SAndy Whitcroftmy $tst_only; 236c72ffaaSAndy Whitcroftmy $emacs = 0; 248905a67cSAndy Whitcroftmy $terse = 0; 256c72ffaaSAndy Whitcroftmy $file = 0; 266c72ffaaSAndy Whitcroftmy $check = 0; 27*2ac73b4fSJoe Perchesmy $check_orig = 0; 288905a67cSAndy Whitcroftmy $summary = 1; 298905a67cSAndy Whitcroftmy $mailback = 0; 3013214adfSAndy Whitcroftmy $summary_file = 0; 31000d1cc1SJoe Perchesmy $show_types = 0; 323705ce5bSJoe Perchesmy $fix = 0; 339624b8d6SJoe Perchesmy $fix_inplace = 0; 346c72ffaaSAndy Whitcroftmy $root; 35c2fdda0dSAndy Whitcroftmy %debug; 363445686aSJoe Perchesmy %camelcase = (); 3791bfe484SJoe Perchesmy %use_type = (); 3891bfe484SJoe Perchesmy @use = (); 3991bfe484SJoe Perchesmy %ignore_type = (); 40000d1cc1SJoe Perchesmy @ignore = (); 4177f5b10aSHannes Edermy $help = 0; 42000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 436cd7f386SJoe Perchesmy $max_line_length = 80; 44d62a201fSDave Hansenmy $ignore_perl_version = 0; 45d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4677f5b10aSHannes Eder 4777f5b10aSHannes Edersub help { 4877f5b10aSHannes Eder my ($exitcode) = @_; 4977f5b10aSHannes Eder 5077f5b10aSHannes Eder print << "EOM"; 5177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5277f5b10aSHannes EderVersion: $V 5377f5b10aSHannes Eder 5477f5b10aSHannes EderOptions: 5577f5b10aSHannes Eder -q, --quiet quiet 5677f5b10aSHannes Eder --no-tree run without a kernel tree 5777f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5877f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5977f5b10aSHannes Eder --emacs emacs compile window format 6077f5b10aSHannes Eder --terse one line per report 6177f5b10aSHannes Eder -f, --file treat FILE as regular source file 6277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6391bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 64000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 656cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 66000d1cc1SJoe Perches --show-types show the message "types" in the output 6777f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6877f5b10aSHannes Eder --no-summary suppress the per-file summary 6977f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 7077f5b10aSHannes Eder --summary-file include the filename in summary 7177f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7277f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7377f5b10aSHannes Eder is all off) 7477f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7577f5b10aSHannes Eder literally 763705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 773705ce5bSJoe Perches If correctable single-line errors exist, create 783705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 793705ce5bSJoe Perches with potential errors corrected to the preferred 803705ce5bSJoe Perches checkpatch style 819624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 829624b8d6SJoe Perches Is the same as --fix, but overwrites the input 839624b8d6SJoe Perches file. It's your fault if there's no backup or git 84d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 85d62a201fSDave Hansen runtime errors. 8677f5b10aSHannes Eder -h, --help, --version display this help and exit 8777f5b10aSHannes Eder 8877f5b10aSHannes EderWhen FILE is - read standard input. 8977f5b10aSHannes EderEOM 9077f5b10aSHannes Eder 9177f5b10aSHannes Eder exit($exitcode); 9277f5b10aSHannes Eder} 9377f5b10aSHannes Eder 94000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 95000d1cc1SJoe Perchesif (-f $conf) { 96000d1cc1SJoe Perches my @conf_args; 97000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 98000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 99000d1cc1SJoe Perches 100000d1cc1SJoe Perches while (<$conffile>) { 101000d1cc1SJoe Perches my $line = $_; 102000d1cc1SJoe Perches 103000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 104000d1cc1SJoe Perches $line =~ s/^\s*//g; 105000d1cc1SJoe Perches $line =~ s/\s+/ /g; 106000d1cc1SJoe Perches 107000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 108000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 109000d1cc1SJoe Perches 110000d1cc1SJoe Perches my @words = split(" ", $line); 111000d1cc1SJoe Perches foreach my $word (@words) { 112000d1cc1SJoe Perches last if ($word =~ m/^#/); 113000d1cc1SJoe Perches push (@conf_args, $word); 114000d1cc1SJoe Perches } 115000d1cc1SJoe Perches } 116000d1cc1SJoe Perches close($conffile); 117000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 118000d1cc1SJoe Perches} 119000d1cc1SJoe Perches 1200a920b5bSAndy WhitcroftGetOptions( 1216c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1220a920b5bSAndy Whitcroft 'tree!' => \$tree, 1230a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1240a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1256c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1268905a67cSAndy Whitcroft 'terse!' => \$terse, 12777f5b10aSHannes Eder 'f|file!' => \$file, 1286c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1296c72ffaaSAndy Whitcroft 'strict!' => \$check, 130000d1cc1SJoe Perches 'ignore=s' => \@ignore, 13191bfe484SJoe Perches 'types=s' => \@use, 132000d1cc1SJoe Perches 'show-types!' => \$show_types, 1336cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1346c72ffaaSAndy Whitcroft 'root=s' => \$root, 1358905a67cSAndy Whitcroft 'summary!' => \$summary, 1368905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13713214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1383705ce5bSJoe Perches 'fix!' => \$fix, 1399624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 140d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 141c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 142773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 14377f5b10aSHannes Eder 'h|help' => \$help, 14477f5b10aSHannes Eder 'version' => \$help 14577f5b10aSHannes Eder) or help(1); 14677f5b10aSHannes Eder 14777f5b10aSHannes Ederhelp(0) if ($help); 1480a920b5bSAndy Whitcroft 1499624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 150*2ac73b4fSJoe Perches$check_orig = $check; 1519624b8d6SJoe Perches 1520a920b5bSAndy Whitcroftmy $exit = 0; 1530a920b5bSAndy Whitcroft 154d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 155d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 156d62a201fSDave Hansen if (!$ignore_perl_version) { 157d62a201fSDave Hansen exit(1); 158d62a201fSDave Hansen } 159d62a201fSDave Hansen} 160d62a201fSDave Hansen 1610a920b5bSAndy Whitcroftif ($#ARGV < 0) { 16277f5b10aSHannes Eder print "$P: no input files\n"; 1630a920b5bSAndy Whitcroft exit(1); 1640a920b5bSAndy Whitcroft} 1650a920b5bSAndy Whitcroft 16691bfe484SJoe Perchessub hash_save_array_words { 16791bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 16891bfe484SJoe Perches 16991bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 17091bfe484SJoe Perches foreach my $word (@array) { 171000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 172000d1cc1SJoe Perches $word =~ s/^\s*//g; 173000d1cc1SJoe Perches $word =~ s/\s+/ /g; 174000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 175000d1cc1SJoe Perches 176000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 177000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 178000d1cc1SJoe Perches 17991bfe484SJoe Perches $hashRef->{$word}++; 180000d1cc1SJoe Perches } 18191bfe484SJoe Perches} 18291bfe484SJoe Perches 18391bfe484SJoe Perchessub hash_show_words { 18491bfe484SJoe Perches my ($hashRef, $prefix) = @_; 18591bfe484SJoe Perches 18658cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 18791bfe484SJoe Perches print "NOTE: $prefix message types:"; 18858cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 18991bfe484SJoe Perches print " $word"; 19091bfe484SJoe Perches } 19191bfe484SJoe Perches print "\n\n"; 19291bfe484SJoe Perches } 19391bfe484SJoe Perches} 19491bfe484SJoe Perches 19591bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 19691bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 197000d1cc1SJoe Perches 198c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 199c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2007429c690SAndy Whitcroftmy $dbg_type = 0; 201a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 202c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 20321caa13cSAndy Whitcroft ## no critic 20421caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 20521caa13cSAndy Whitcroft die "$@" if ($@); 206c2fdda0dSAndy Whitcroft} 207c2fdda0dSAndy Whitcroft 208d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 209d2c0a235SAndy Whitcroft 2108905a67cSAndy Whitcroftif ($terse) { 2118905a67cSAndy Whitcroft $emacs = 1; 2128905a67cSAndy Whitcroft $quiet++; 2138905a67cSAndy Whitcroft} 2148905a67cSAndy Whitcroft 2156c72ffaaSAndy Whitcroftif ($tree) { 2166c72ffaaSAndy Whitcroft if (defined $root) { 2176c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2186c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2196c72ffaaSAndy Whitcroft } 2206c72ffaaSAndy Whitcroft } else { 2216c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2226c72ffaaSAndy Whitcroft $root = '.'; 2236c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2246c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2256c72ffaaSAndy Whitcroft $root = $1; 2266c72ffaaSAndy Whitcroft } 2276c72ffaaSAndy Whitcroft } 2286c72ffaaSAndy Whitcroft 2296c72ffaaSAndy Whitcroft if (!defined $root) { 2300a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2310a920b5bSAndy Whitcroft exit(2); 2320a920b5bSAndy Whitcroft } 2336c72ffaaSAndy Whitcroft} 2346c72ffaaSAndy Whitcroft 2356c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2366c72ffaaSAndy Whitcroft 2372ceb532bSAndy Whitcroftour $Ident = qr{ 2382ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2392ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2402ceb532bSAndy Whitcroft }x; 2416c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2426c72ffaaSAndy Whitcroftour $Sparse = qr{ 2436c72ffaaSAndy Whitcroft __user| 2446c72ffaaSAndy Whitcroft __kernel| 2456c72ffaaSAndy Whitcroft __force| 2466c72ffaaSAndy Whitcroft __iomem| 2476c72ffaaSAndy Whitcroft __must_check| 2486c72ffaaSAndy Whitcroft __init_refok| 249417495edSAndy Whitcroft __kprobes| 250165e72a6SSven Eckelmann __ref| 251165e72a6SSven Eckelmann __rcu 2526c72ffaaSAndy Whitcroft }x; 253e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 254e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 255e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 256e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 257e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2588716de38SJoe Perches 25952131292SWolfram Sang# Notes to $Attribute: 26052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2616c72ffaaSAndy Whitcroftour $Attribute = qr{ 2626c72ffaaSAndy Whitcroft const| 26303f1df7dSJoe Perches __percpu| 26403f1df7dSJoe Perches __nocast| 26503f1df7dSJoe Perches __safe| 26603f1df7dSJoe Perches __bitwise__| 26703f1df7dSJoe Perches __packed__| 26803f1df7dSJoe Perches __packed2__| 26903f1df7dSJoe Perches __naked| 27003f1df7dSJoe Perches __maybe_unused| 27103f1df7dSJoe Perches __always_unused| 27203f1df7dSJoe Perches __noreturn| 27303f1df7dSJoe Perches __used| 27403f1df7dSJoe Perches __cold| 27503f1df7dSJoe Perches __noclone| 27603f1df7dSJoe Perches __deprecated| 2776c72ffaaSAndy Whitcroft __read_mostly| 2786c72ffaaSAndy Whitcroft __kprobes| 2798716de38SJoe Perches $InitAttribute| 28024e1d81aSAndy Whitcroft ____cacheline_aligned| 28124e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2825fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2835fe3af11SAndy Whitcroft __weak 2846c72ffaaSAndy Whitcroft }x; 285c45dcabdSAndy Whitcroftour $Modifier; 28691cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 2876c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2886c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2896c72ffaaSAndy Whitcroft 29095e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 29195e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 29295e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 29395e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 2942435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 295326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 296326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 297326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 29874349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 2992435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 300326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 301447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 30223f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3036c72ffaaSAndy Whitcroftour $Operators = qr{ 3046c72ffaaSAndy Whitcroft <=|>=|==|!=| 3056c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 30623f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3076c72ffaaSAndy Whitcroft }x; 3086c72ffaaSAndy Whitcroft 30991cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 31091cb5195SJoe Perches 3118905a67cSAndy Whitcroftour $NonptrType; 3128716de38SJoe Perchesour $NonptrTypeWithAttr; 3138905a67cSAndy Whitcroftour $Type; 3148905a67cSAndy Whitcroftour $Declare; 3158905a67cSAndy Whitcroft 31615662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 31715662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 318171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 319171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 320171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 321171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 322171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 323171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 324171ae1a4SAndy Whitcroft}x; 325171ae1a4SAndy Whitcroft 32615662b3eSJoe Perchesour $UTF8 = qr{ 32715662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 32815662b3eSJoe Perches | $NON_ASCII_UTF8 32915662b3eSJoe Perches}x; 33015662b3eSJoe Perches 3318ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 332fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3338ed22cadSAndy Whitcroft atomic_t 3348ed22cadSAndy Whitcroft)}; 3358ed22cadSAndy Whitcroft 336691e669bSJoe Perchesour $logFunctions = qr{(?x: 3376e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3387d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3396e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 340b0531722SJoe Perches panic| 34106668727SJoe Perches MODULE_[A-Z_]+| 34206668727SJoe Perches seq_vprintf|seq_printf|seq_puts 343691e669bSJoe Perches)}; 344691e669bSJoe Perches 34520112475SJoe Perchesour $signature_tags = qr{(?xi: 34620112475SJoe Perches Signed-off-by:| 34720112475SJoe Perches Acked-by:| 34820112475SJoe Perches Tested-by:| 34920112475SJoe Perches Reviewed-by:| 35020112475SJoe Perches Reported-by:| 3518543ae12SMugunthan V N Suggested-by:| 35220112475SJoe Perches To:| 35320112475SJoe Perches Cc: 35420112475SJoe Perches)}; 35520112475SJoe Perches 3568905a67cSAndy Whitcroftour @typeList = ( 3578905a67cSAndy Whitcroft qr{void}, 358c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 359c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 360c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 361c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 362c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 363c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 364c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3658905a67cSAndy Whitcroft qr{unsigned}, 3668905a67cSAndy Whitcroft qr{float}, 3678905a67cSAndy Whitcroft qr{double}, 3688905a67cSAndy Whitcroft qr{bool}, 3698905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3708905a67cSAndy Whitcroft qr{union\s+$Ident}, 3718905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3728905a67cSAndy Whitcroft qr{${Ident}_t}, 3738905a67cSAndy Whitcroft qr{${Ident}_handler}, 3748905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3758905a67cSAndy Whitcroft); 3768716de38SJoe Perchesour @typeListWithAttr = ( 3778716de38SJoe Perches @typeList, 3788716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 3798716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 3808716de38SJoe Perches); 3818716de38SJoe Perches 382c45dcabdSAndy Whitcroftour @modifierList = ( 383c45dcabdSAndy Whitcroft qr{fastcall}, 384c45dcabdSAndy Whitcroft); 3858905a67cSAndy Whitcroft 3862435880fSJoe Perchesour @mode_permission_funcs = ( 3872435880fSJoe Perches ["module_param", 3], 3882435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 3892435880fSJoe Perches ["module_param_array_named", 5], 3902435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 3912435880fSJoe Perches ["proc_create(?:_data|)", 2], 3922435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 3932435880fSJoe Perches); 3942435880fSJoe Perches 395515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 396515a235eSJoe Perchesour $mode_perms_search = ""; 397515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 398515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 399515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 400515a235eSJoe Perches} 401515a235eSJoe Perches 4023f7bac03SJoe Perchesour $declaration_macros = qr{(?x: 4033f7bac03SJoe Perches (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(| 4043f7bac03SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\( 4053f7bac03SJoe Perches)}; 4063f7bac03SJoe Perches 4077840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4087840a94cSWolfram Sang irq| 4097840a94cSWolfram Sang memory 4107840a94cSWolfram Sang)}; 4117840a94cSWolfram Sang# memory.h: ARM has a custom one 4127840a94cSWolfram Sang 4138905a67cSAndy Whitcroftsub build_types { 414d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 415d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 4168716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 417c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 4188905a67cSAndy Whitcroft $NonptrType = qr{ 419d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 420cf655043SAndy Whitcroft (?: 4216b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 4228ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 423c45dcabdSAndy Whitcroft (?:${all}\b) 424cf655043SAndy Whitcroft ) 425c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 4268905a67cSAndy Whitcroft }x; 4278716de38SJoe Perches $NonptrTypeWithAttr = qr{ 4288716de38SJoe Perches (?:$Modifier\s+|const\s+)* 4298716de38SJoe Perches (?: 4308716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 4318716de38SJoe Perches (?:$typeTypedefs\b)| 4328716de38SJoe Perches (?:${allWithAttr}\b) 4338716de38SJoe Perches ) 4348716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4358716de38SJoe Perches }x; 4368905a67cSAndy Whitcroft $Type = qr{ 437c45dcabdSAndy Whitcroft $NonptrType 438b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 439c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 4408905a67cSAndy Whitcroft }x; 44191cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 4428905a67cSAndy Whitcroft} 4438905a67cSAndy Whitcroftbuild_types(); 4446c72ffaaSAndy Whitcroft 4457d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 446d1fe9c09SJoe Perches 447d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 448d1fe9c09SJoe Perches# requires at least perl version v5.10.0 449d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 450d1fe9c09SJoe Perches 451d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 4522435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 453d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 4547d2367afSJoe Perches 4557d2367afSJoe Perchessub deparenthesize { 4567d2367afSJoe Perches my ($string) = @_; 4577d2367afSJoe Perches return "" if (!defined($string)); 4585b9553abSJoe Perches 4595b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 4605b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 4615b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 4625b9553abSJoe Perches } 4635b9553abSJoe Perches 4647d2367afSJoe Perches $string =~ s@\s+@ @g; 4655b9553abSJoe Perches 4667d2367afSJoe Perches return $string; 4677d2367afSJoe Perches} 4687d2367afSJoe Perches 4693445686aSJoe Perchessub seed_camelcase_file { 4703445686aSJoe Perches my ($file) = @_; 4713445686aSJoe Perches 4723445686aSJoe Perches return if (!(-f $file)); 4733445686aSJoe Perches 4743445686aSJoe Perches local $/; 4753445686aSJoe Perches 4763445686aSJoe Perches open(my $include_file, '<', "$file") 4773445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4783445686aSJoe Perches my $text = <$include_file>; 4793445686aSJoe Perches close($include_file); 4803445686aSJoe Perches 4813445686aSJoe Perches my @lines = split('\n', $text); 4823445686aSJoe Perches 4833445686aSJoe Perches foreach my $line (@lines) { 4843445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4853445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4863445686aSJoe Perches $camelcase{$1} = 1; 48711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 48811ea516aSJoe Perches $camelcase{$1} = 1; 48911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 4903445686aSJoe Perches $camelcase{$1} = 1; 4913445686aSJoe Perches } 4923445686aSJoe Perches } 4933445686aSJoe Perches} 4943445686aSJoe Perches 4953445686aSJoe Perchesmy $camelcase_seeded = 0; 4963445686aSJoe Perchessub seed_camelcase_includes { 4973445686aSJoe Perches return if ($camelcase_seeded); 4983445686aSJoe Perches 4993445686aSJoe Perches my $files; 500c707a81dSJoe Perches my $camelcase_cache = ""; 501c707a81dSJoe Perches my @include_files = (); 502c707a81dSJoe Perches 503c707a81dSJoe Perches $camelcase_seeded = 1; 504351b2a1fSJoe Perches 5053645e328SRichard Genoud if (-e ".git") { 506351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 507351b2a1fSJoe Perches chomp $git_last_include_commit; 508c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 509c707a81dSJoe Perches } else { 510c707a81dSJoe Perches my $last_mod_date = 0; 511c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 512c707a81dSJoe Perches @include_files = split('\n', $files); 513c707a81dSJoe Perches foreach my $file (@include_files) { 514c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 515c707a81dSJoe Perches localtime((stat $file)[9])); 516c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 517c707a81dSJoe Perches } 518c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 519c707a81dSJoe Perches } 520c707a81dSJoe Perches 521c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 522c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 523c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 524351b2a1fSJoe Perches while (<$camelcase_file>) { 525351b2a1fSJoe Perches chomp; 526351b2a1fSJoe Perches $camelcase{$_} = 1; 527351b2a1fSJoe Perches } 528351b2a1fSJoe Perches close($camelcase_file); 529351b2a1fSJoe Perches 530351b2a1fSJoe Perches return; 531351b2a1fSJoe Perches } 532c707a81dSJoe Perches 5333645e328SRichard Genoud if (-e ".git") { 534c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 535c707a81dSJoe Perches @include_files = split('\n', $files); 5363445686aSJoe Perches } 537c707a81dSJoe Perches 5383445686aSJoe Perches foreach my $file (@include_files) { 5393445686aSJoe Perches seed_camelcase_file($file); 5403445686aSJoe Perches } 541351b2a1fSJoe Perches 542c707a81dSJoe Perches if ($camelcase_cache ne "") { 543351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 544c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 545c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 546351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 547351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 548351b2a1fSJoe Perches } 549351b2a1fSJoe Perches close($camelcase_file); 550351b2a1fSJoe Perches } 5513445686aSJoe Perches} 5523445686aSJoe Perches 5536c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5540a920b5bSAndy Whitcroft 55500df344fSAndy Whitcroftmy @rawlines = (); 556c2fdda0dSAndy Whitcroftmy @lines = (); 5573705ce5bSJoe Perchesmy @fixed = (); 558c2fdda0dSAndy Whitcroftmy $vname; 5596c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 56021caa13cSAndy Whitcroft my $FILE; 5616c72ffaaSAndy Whitcroft if ($file) { 56221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5636c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 56421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 56521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5666c72ffaaSAndy Whitcroft } else { 56721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5686c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5696c72ffaaSAndy Whitcroft } 570c2fdda0dSAndy Whitcroft if ($filename eq '-') { 571c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 572c2fdda0dSAndy Whitcroft } else { 573c2fdda0dSAndy Whitcroft $vname = $filename; 574c2fdda0dSAndy Whitcroft } 57521caa13cSAndy Whitcroft while (<$FILE>) { 5760a920b5bSAndy Whitcroft chomp; 57700df344fSAndy Whitcroft push(@rawlines, $_); 5786c72ffaaSAndy Whitcroft } 57921caa13cSAndy Whitcroft close($FILE); 580c2fdda0dSAndy Whitcroft if (!process($filename)) { 5810a920b5bSAndy Whitcroft $exit = 1; 5820a920b5bSAndy Whitcroft } 58300df344fSAndy Whitcroft @rawlines = (); 58413214adfSAndy Whitcroft @lines = (); 5853705ce5bSJoe Perches @fixed = (); 5860a920b5bSAndy Whitcroft} 5870a920b5bSAndy Whitcroft 5880a920b5bSAndy Whitcroftexit($exit); 5890a920b5bSAndy Whitcroft 5900a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5916c72ffaaSAndy Whitcroft my ($root) = @_; 5926c72ffaaSAndy Whitcroft 5936c72ffaaSAndy Whitcroft my @tree_check = ( 5946c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5956c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5966c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5976c72ffaaSAndy Whitcroft ); 5986c72ffaaSAndy Whitcroft 5996c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 6006c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 6010a920b5bSAndy Whitcroft return 0; 6020a920b5bSAndy Whitcroft } 6036c72ffaaSAndy Whitcroft } 6046c72ffaaSAndy Whitcroft return 1; 6056c72ffaaSAndy Whitcroft} 6060a920b5bSAndy Whitcroft 60720112475SJoe Perchessub parse_email { 60820112475SJoe Perches my ($formatted_email) = @_; 60920112475SJoe Perches 61020112475SJoe Perches my $name = ""; 61120112475SJoe Perches my $address = ""; 61220112475SJoe Perches my $comment = ""; 61320112475SJoe Perches 61420112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 61520112475SJoe Perches $name = $1; 61620112475SJoe Perches $address = $2; 61720112475SJoe Perches $comment = $3 if defined $3; 61820112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 61920112475SJoe Perches $address = $1; 62020112475SJoe Perches $comment = $2 if defined $2; 62120112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 62220112475SJoe Perches $address = $1; 62320112475SJoe Perches $comment = $2 if defined $2; 62420112475SJoe Perches $formatted_email =~ s/$address.*$//; 62520112475SJoe Perches $name = $formatted_email; 6263705ce5bSJoe Perches $name = trim($name); 62720112475SJoe Perches $name =~ s/^\"|\"$//g; 62820112475SJoe Perches # If there's a name left after stripping spaces and 62920112475SJoe Perches # leading quotes, and the address doesn't have both 63020112475SJoe Perches # leading and trailing angle brackets, the address 63120112475SJoe Perches # is invalid. ie: 63220112475SJoe Perches # "joe smith [email protected]" bad 63320112475SJoe Perches # "joe smith <[email protected]" bad 63420112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 63520112475SJoe Perches $name = ""; 63620112475SJoe Perches $address = ""; 63720112475SJoe Perches $comment = ""; 63820112475SJoe Perches } 63920112475SJoe Perches } 64020112475SJoe Perches 6413705ce5bSJoe Perches $name = trim($name); 64220112475SJoe Perches $name =~ s/^\"|\"$//g; 6433705ce5bSJoe Perches $address = trim($address); 64420112475SJoe Perches $address =~ s/^\<|\>$//g; 64520112475SJoe Perches 64620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 64720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 64820112475SJoe Perches $name = "\"$name\""; 64920112475SJoe Perches } 65020112475SJoe Perches 65120112475SJoe Perches return ($name, $address, $comment); 65220112475SJoe Perches} 65320112475SJoe Perches 65420112475SJoe Perchessub format_email { 65520112475SJoe Perches my ($name, $address) = @_; 65620112475SJoe Perches 65720112475SJoe Perches my $formatted_email; 65820112475SJoe Perches 6593705ce5bSJoe Perches $name = trim($name); 66020112475SJoe Perches $name =~ s/^\"|\"$//g; 6613705ce5bSJoe Perches $address = trim($address); 66220112475SJoe Perches 66320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 66420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 66520112475SJoe Perches $name = "\"$name\""; 66620112475SJoe Perches } 66720112475SJoe Perches 66820112475SJoe Perches if ("$name" eq "") { 66920112475SJoe Perches $formatted_email = "$address"; 67020112475SJoe Perches } else { 67120112475SJoe Perches $formatted_email = "$name <$address>"; 67220112475SJoe Perches } 67320112475SJoe Perches 67420112475SJoe Perches return $formatted_email; 67520112475SJoe Perches} 67620112475SJoe Perches 677000d1cc1SJoe Perchessub which_conf { 678000d1cc1SJoe Perches my ($conf) = @_; 679000d1cc1SJoe Perches 680000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 681000d1cc1SJoe Perches if (-e "$path/$conf") { 682000d1cc1SJoe Perches return "$path/$conf"; 683000d1cc1SJoe Perches } 684000d1cc1SJoe Perches } 685000d1cc1SJoe Perches 686000d1cc1SJoe Perches return ""; 687000d1cc1SJoe Perches} 688000d1cc1SJoe Perches 6890a920b5bSAndy Whitcroftsub expand_tabs { 6900a920b5bSAndy Whitcroft my ($str) = @_; 6910a920b5bSAndy Whitcroft 6920a920b5bSAndy Whitcroft my $res = ''; 6930a920b5bSAndy Whitcroft my $n = 0; 6940a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6950a920b5bSAndy Whitcroft if ($c eq "\t") { 6960a920b5bSAndy Whitcroft $res .= ' '; 6970a920b5bSAndy Whitcroft $n++; 6980a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6990a920b5bSAndy Whitcroft $res .= ' '; 7000a920b5bSAndy Whitcroft } 7010a920b5bSAndy Whitcroft next; 7020a920b5bSAndy Whitcroft } 7030a920b5bSAndy Whitcroft $res .= $c; 7040a920b5bSAndy Whitcroft $n++; 7050a920b5bSAndy Whitcroft } 7060a920b5bSAndy Whitcroft 7070a920b5bSAndy Whitcroft return $res; 7080a920b5bSAndy Whitcroft} 7096c72ffaaSAndy Whitcroftsub copy_spacing { 710773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 7116c72ffaaSAndy Whitcroft return $res; 7126c72ffaaSAndy Whitcroft} 7130a920b5bSAndy Whitcroft 7144a0df2efSAndy Whitcroftsub line_stats { 7154a0df2efSAndy Whitcroft my ($line) = @_; 7164a0df2efSAndy Whitcroft 7174a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 7184a0df2efSAndy Whitcroft $line =~ s/^.//; 7194a0df2efSAndy Whitcroft $line = expand_tabs($line); 7204a0df2efSAndy Whitcroft 7214a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 7224a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 7234a0df2efSAndy Whitcroft 7244a0df2efSAndy Whitcroft return (length($line), length($white)); 7254a0df2efSAndy Whitcroft} 7264a0df2efSAndy Whitcroft 727773647a0SAndy Whitcroftmy $sanitise_quote = ''; 728773647a0SAndy Whitcroft 729773647a0SAndy Whitcroftsub sanitise_line_reset { 730773647a0SAndy Whitcroft my ($in_comment) = @_; 731773647a0SAndy Whitcroft 732773647a0SAndy Whitcroft if ($in_comment) { 733773647a0SAndy Whitcroft $sanitise_quote = '*/'; 734773647a0SAndy Whitcroft } else { 735773647a0SAndy Whitcroft $sanitise_quote = ''; 736773647a0SAndy Whitcroft } 737773647a0SAndy Whitcroft} 73800df344fSAndy Whitcroftsub sanitise_line { 73900df344fSAndy Whitcroft my ($line) = @_; 74000df344fSAndy Whitcroft 74100df344fSAndy Whitcroft my $res = ''; 74200df344fSAndy Whitcroft my $l = ''; 74300df344fSAndy Whitcroft 744c2fdda0dSAndy Whitcroft my $qlen = 0; 745773647a0SAndy Whitcroft my $off = 0; 746773647a0SAndy Whitcroft my $c; 74700df344fSAndy Whitcroft 748773647a0SAndy Whitcroft # Always copy over the diff marker. 749773647a0SAndy Whitcroft $res = substr($line, 0, 1); 750773647a0SAndy Whitcroft 751773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 752773647a0SAndy Whitcroft $c = substr($line, $off, 1); 753773647a0SAndy Whitcroft 754773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 755773647a0SAndy Whitcroft # and end, all to $;. 756773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 757773647a0SAndy Whitcroft $sanitise_quote = '*/'; 758773647a0SAndy Whitcroft 759773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 760773647a0SAndy Whitcroft $off++; 76100df344fSAndy Whitcroft next; 762773647a0SAndy Whitcroft } 76381bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 764773647a0SAndy Whitcroft $sanitise_quote = ''; 765773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 766773647a0SAndy Whitcroft $off++; 767773647a0SAndy Whitcroft next; 768773647a0SAndy Whitcroft } 769113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 770113f04a8SDaniel Walker $sanitise_quote = '//'; 771113f04a8SDaniel Walker 772113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 773113f04a8SDaniel Walker $off++; 774113f04a8SDaniel Walker next; 775113f04a8SDaniel Walker } 776773647a0SAndy Whitcroft 777773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 778773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 779773647a0SAndy Whitcroft $c eq "\\") { 780773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 781773647a0SAndy Whitcroft $off++; 782773647a0SAndy Whitcroft next; 783773647a0SAndy Whitcroft } 784773647a0SAndy Whitcroft # Regular quotes. 785773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 786773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 787773647a0SAndy Whitcroft $sanitise_quote = $c; 788773647a0SAndy Whitcroft 789773647a0SAndy Whitcroft substr($res, $off, 1, $c); 790773647a0SAndy Whitcroft next; 791773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 792773647a0SAndy Whitcroft $sanitise_quote = ''; 79300df344fSAndy Whitcroft } 79400df344fSAndy Whitcroft } 795773647a0SAndy Whitcroft 796fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 797773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 798773647a0SAndy Whitcroft substr($res, $off, 1, $;); 799113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 800113f04a8SDaniel Walker substr($res, $off, 1, $;); 801773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 802773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 80300df344fSAndy Whitcroft } else { 804773647a0SAndy Whitcroft substr($res, $off, 1, $c); 80500df344fSAndy Whitcroft } 806c2fdda0dSAndy Whitcroft } 807c2fdda0dSAndy Whitcroft 808113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 809113f04a8SDaniel Walker $sanitise_quote = ''; 810113f04a8SDaniel Walker } 811113f04a8SDaniel Walker 812c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 813c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 814c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 815c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 816c2fdda0dSAndy Whitcroft 817c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 818c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 819c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 820c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 821c2fdda0dSAndy Whitcroft } 822c2fdda0dSAndy Whitcroft 82300df344fSAndy Whitcroft return $res; 82400df344fSAndy Whitcroft} 82500df344fSAndy Whitcroft 826a6962d72SJoe Perchessub get_quoted_string { 827a6962d72SJoe Perches my ($line, $rawline) = @_; 828a6962d72SJoe Perches 829a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 830a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 831a6962d72SJoe Perches} 832a6962d72SJoe Perches 8338905a67cSAndy Whitcroftsub ctx_statement_block { 8348905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8358905a67cSAndy Whitcroft my $line = $linenr - 1; 8368905a67cSAndy Whitcroft my $blk = ''; 8378905a67cSAndy Whitcroft my $soff = $off; 8388905a67cSAndy Whitcroft my $coff = $off - 1; 839773647a0SAndy Whitcroft my $coff_set = 0; 8408905a67cSAndy Whitcroft 84113214adfSAndy Whitcroft my $loff = 0; 84213214adfSAndy Whitcroft 8438905a67cSAndy Whitcroft my $type = ''; 8448905a67cSAndy Whitcroft my $level = 0; 845a2750645SAndy Whitcroft my @stack = (); 846cf655043SAndy Whitcroft my $p; 8478905a67cSAndy Whitcroft my $c; 8488905a67cSAndy Whitcroft my $len = 0; 84913214adfSAndy Whitcroft 85013214adfSAndy Whitcroft my $remainder; 8518905a67cSAndy Whitcroft while (1) { 852a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 853a2750645SAndy Whitcroft 854773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8558905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8568905a67cSAndy Whitcroft # context. 8578905a67cSAndy Whitcroft if ($off >= $len) { 8588905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 859dea33496SAndy Whitcroft last if (!defined $lines[$line]); 860c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 8618905a67cSAndy Whitcroft $remain--; 86213214adfSAndy Whitcroft $loff = $len; 863c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8648905a67cSAndy Whitcroft $len = length($blk); 8658905a67cSAndy Whitcroft $line++; 8668905a67cSAndy Whitcroft last; 8678905a67cSAndy Whitcroft } 8688905a67cSAndy Whitcroft # Bail if there is no further context. 8698905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 87013214adfSAndy Whitcroft if ($off >= $len) { 8718905a67cSAndy Whitcroft last; 8728905a67cSAndy Whitcroft } 873f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 874f74bd194SAndy Whitcroft $level++; 875f74bd194SAndy Whitcroft $type = '#'; 876f74bd194SAndy Whitcroft } 8778905a67cSAndy Whitcroft } 878cf655043SAndy Whitcroft $p = $c; 8798905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 88013214adfSAndy Whitcroft $remainder = substr($blk, $off); 8818905a67cSAndy Whitcroft 882773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8834635f4fbSAndy Whitcroft 8844635f4fbSAndy Whitcroft # Handle nested #if/#else. 8854635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8864635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8874635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8884635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8894635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8904635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8914635f4fbSAndy Whitcroft } 8924635f4fbSAndy Whitcroft 8938905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8948905a67cSAndy Whitcroft # outermost level. 8958905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8968905a67cSAndy Whitcroft last; 8978905a67cSAndy Whitcroft } 8988905a67cSAndy Whitcroft 89913214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 900773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 901773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 902773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 903773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 904773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 905773647a0SAndy Whitcroft $coff_set = 1; 906773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 907773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 90813214adfSAndy Whitcroft } 90913214adfSAndy Whitcroft 9108905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 9118905a67cSAndy Whitcroft $level++; 9128905a67cSAndy Whitcroft $type = '('; 9138905a67cSAndy Whitcroft } 9148905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 9158905a67cSAndy Whitcroft $level--; 9168905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 9178905a67cSAndy Whitcroft 9188905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 9198905a67cSAndy Whitcroft $coff = $off; 920773647a0SAndy Whitcroft $coff_set = 1; 921773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 9228905a67cSAndy Whitcroft } 9238905a67cSAndy Whitcroft } 9248905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 9258905a67cSAndy Whitcroft $level++; 9268905a67cSAndy Whitcroft $type = '{'; 9278905a67cSAndy Whitcroft } 9288905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 9298905a67cSAndy Whitcroft $level--; 9308905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9318905a67cSAndy Whitcroft 9328905a67cSAndy Whitcroft if ($level == 0) { 933b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 934b998e001SPatrick Pannuto $off++; 935b998e001SPatrick Pannuto } 9368905a67cSAndy Whitcroft last; 9378905a67cSAndy Whitcroft } 9388905a67cSAndy Whitcroft } 939f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 940f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 941f74bd194SAndy Whitcroft $level--; 942f74bd194SAndy Whitcroft $type = ''; 943f74bd194SAndy Whitcroft $off++; 944f74bd194SAndy Whitcroft last; 945f74bd194SAndy Whitcroft } 9468905a67cSAndy Whitcroft $off++; 9478905a67cSAndy Whitcroft } 948a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 94913214adfSAndy Whitcroft if ($off == $len) { 950a3bb97a7SAndy Whitcroft $loff = $len + 1; 95113214adfSAndy Whitcroft $line++; 95213214adfSAndy Whitcroft $remain--; 95313214adfSAndy Whitcroft } 9548905a67cSAndy Whitcroft 9558905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9568905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 9578905a67cSAndy Whitcroft 9588905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 9598905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 9608905a67cSAndy Whitcroft 961773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 96213214adfSAndy Whitcroft 96313214adfSAndy Whitcroft return ($statement, $condition, 96413214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 96513214adfSAndy Whitcroft} 96613214adfSAndy Whitcroft 967cf655043SAndy Whitcroftsub statement_lines { 968cf655043SAndy Whitcroft my ($stmt) = @_; 969cf655043SAndy Whitcroft 970cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 971cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 972cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 973cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 974cf655043SAndy Whitcroft 975cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 976cf655043SAndy Whitcroft 977cf655043SAndy Whitcroft return $#stmt_lines + 2; 978cf655043SAndy Whitcroft} 979cf655043SAndy Whitcroft 980cf655043SAndy Whitcroftsub statement_rawlines { 981cf655043SAndy Whitcroft my ($stmt) = @_; 982cf655043SAndy Whitcroft 983cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 984cf655043SAndy Whitcroft 985cf655043SAndy Whitcroft return $#stmt_lines + 2; 986cf655043SAndy Whitcroft} 987cf655043SAndy Whitcroft 988cf655043SAndy Whitcroftsub statement_block_size { 989cf655043SAndy Whitcroft my ($stmt) = @_; 990cf655043SAndy Whitcroft 991cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 992cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 993cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 994cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 995cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 996cf655043SAndy Whitcroft 997cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 998cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 999cf655043SAndy Whitcroft 1000cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1001cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1002cf655043SAndy Whitcroft 1003cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1004cf655043SAndy Whitcroft return $stmt_lines; 1005cf655043SAndy Whitcroft } else { 1006cf655043SAndy Whitcroft return $stmt_statements; 1007cf655043SAndy Whitcroft } 1008cf655043SAndy Whitcroft} 1009cf655043SAndy Whitcroft 101013214adfSAndy Whitcroftsub ctx_statement_full { 101113214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 101213214adfSAndy Whitcroft my ($statement, $condition, $level); 101313214adfSAndy Whitcroft 101413214adfSAndy Whitcroft my (@chunks); 101513214adfSAndy Whitcroft 1016cf655043SAndy Whitcroft # Grab the first conditional/block pair. 101713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 101813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1019773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 102013214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1021cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1022cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1023cf655043SAndy Whitcroft } 1024cf655043SAndy Whitcroft 1025cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1026cf655043SAndy Whitcroft # could continue the statement. 1027cf655043SAndy Whitcroft for (;;) { 102813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 102913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1030cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1031773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1032cf655043SAndy Whitcroft #print "C: push\n"; 1033cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 103413214adfSAndy Whitcroft } 103513214adfSAndy Whitcroft 103613214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10378905a67cSAndy Whitcroft} 10388905a67cSAndy Whitcroft 10394a0df2efSAndy Whitcroftsub ctx_block_get { 1040f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10414a0df2efSAndy Whitcroft my $line; 10424a0df2efSAndy Whitcroft my $start = $linenr - 1; 10434a0df2efSAndy Whitcroft my $blk = ''; 10444a0df2efSAndy Whitcroft my @o; 10454a0df2efSAndy Whitcroft my @c; 10464a0df2efSAndy Whitcroft my @res = (); 10474a0df2efSAndy Whitcroft 1048f0a594c1SAndy Whitcroft my $level = 0; 10494635f4fbSAndy Whitcroft my @stack = ($level); 105000df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 105100df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 105200df344fSAndy Whitcroft $remain--; 105300df344fSAndy Whitcroft 105400df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10554635f4fbSAndy Whitcroft 10564635f4fbSAndy Whitcroft # Handle nested #if/#else. 105701464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 10584635f4fbSAndy Whitcroft push(@stack, $level); 105901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 10604635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 106101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10624635f4fbSAndy Whitcroft $level = pop(@stack); 10634635f4fbSAndy Whitcroft } 10644635f4fbSAndy Whitcroft 106501464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1066f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1067f0a594c1SAndy Whitcroft if ($off > 0) { 1068f0a594c1SAndy Whitcroft $off--; 1069f0a594c1SAndy Whitcroft next; 1070f0a594c1SAndy Whitcroft } 10714a0df2efSAndy Whitcroft 1072f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1073f0a594c1SAndy Whitcroft $level--; 1074f0a594c1SAndy Whitcroft last if ($level == 0); 1075f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1076f0a594c1SAndy Whitcroft $level++; 1077f0a594c1SAndy Whitcroft } 1078f0a594c1SAndy Whitcroft } 10794a0df2efSAndy Whitcroft 1080f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 108100df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10824a0df2efSAndy Whitcroft } 10834a0df2efSAndy Whitcroft 1084f0a594c1SAndy Whitcroft last if ($level == 0); 10854a0df2efSAndy Whitcroft } 10864a0df2efSAndy Whitcroft 1087f0a594c1SAndy Whitcroft return ($level, @res); 10884a0df2efSAndy Whitcroft} 10894a0df2efSAndy Whitcroftsub ctx_block_outer { 10904a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10914a0df2efSAndy Whitcroft 1092f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1093f0a594c1SAndy Whitcroft return @r; 10944a0df2efSAndy Whitcroft} 10954a0df2efSAndy Whitcroftsub ctx_block { 10964a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10974a0df2efSAndy Whitcroft 1098f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1099f0a594c1SAndy Whitcroft return @r; 1100653d4876SAndy Whitcroft} 1101653d4876SAndy Whitcroftsub ctx_statement { 1102f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1103f0a594c1SAndy Whitcroft 1104f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1105f0a594c1SAndy Whitcroft return @r; 1106f0a594c1SAndy Whitcroft} 1107f0a594c1SAndy Whitcroftsub ctx_block_level { 1108653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1109653d4876SAndy Whitcroft 1110f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 11114a0df2efSAndy Whitcroft} 11129c0ca6f9SAndy Whitcroftsub ctx_statement_level { 11139c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 11149c0ca6f9SAndy Whitcroft 11159c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 11169c0ca6f9SAndy Whitcroft} 11174a0df2efSAndy Whitcroft 11184a0df2efSAndy Whitcroftsub ctx_locate_comment { 11194a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11204a0df2efSAndy Whitcroft 11214a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1122beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 11234a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 11244a0df2efSAndy Whitcroft 11254a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 11264a0df2efSAndy Whitcroft # comment. 11274a0df2efSAndy Whitcroft my $in_comment = 0; 11284a0df2efSAndy Whitcroft $current_comment = ''; 11294a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 113000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 113100df344fSAndy Whitcroft #warn " $line\n"; 11324a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11334a0df2efSAndy Whitcroft $in_comment = 1; 11344a0df2efSAndy Whitcroft } 11354a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11364a0df2efSAndy Whitcroft $in_comment = 1; 11374a0df2efSAndy Whitcroft } 11384a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11394a0df2efSAndy Whitcroft $current_comment = ''; 11404a0df2efSAndy Whitcroft } 11414a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11424a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11434a0df2efSAndy Whitcroft $in_comment = 0; 11444a0df2efSAndy Whitcroft } 11454a0df2efSAndy Whitcroft } 11464a0df2efSAndy Whitcroft 11474a0df2efSAndy Whitcroft chomp($current_comment); 11484a0df2efSAndy Whitcroft return($current_comment); 11494a0df2efSAndy Whitcroft} 11504a0df2efSAndy Whitcroftsub ctx_has_comment { 11514a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11524a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11534a0df2efSAndy Whitcroft 115400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11554a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11564a0df2efSAndy Whitcroft 11574a0df2efSAndy Whitcroft return ($cmt ne ''); 11584a0df2efSAndy Whitcroft} 11594a0df2efSAndy Whitcroft 11604d001e4dSAndy Whitcroftsub raw_line { 11614d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11624d001e4dSAndy Whitcroft 11634d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11644d001e4dSAndy Whitcroft $cnt++; 11654d001e4dSAndy Whitcroft 11664d001e4dSAndy Whitcroft my $line; 11674d001e4dSAndy Whitcroft while ($cnt) { 11684d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11694d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11704d001e4dSAndy Whitcroft $cnt--; 11714d001e4dSAndy Whitcroft } 11724d001e4dSAndy Whitcroft 11734d001e4dSAndy Whitcroft return $line; 11744d001e4dSAndy Whitcroft} 11754d001e4dSAndy Whitcroft 11760a920b5bSAndy Whitcroftsub cat_vet { 11770a920b5bSAndy Whitcroft my ($vet) = @_; 11789c0ca6f9SAndy Whitcroft my ($res, $coded); 11790a920b5bSAndy Whitcroft 11809c0ca6f9SAndy Whitcroft $res = ''; 11816c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11826c72ffaaSAndy Whitcroft $res .= $1; 11836c72ffaaSAndy Whitcroft if ($2 ne '') { 11849c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11856c72ffaaSAndy Whitcroft $res .= $coded; 11866c72ffaaSAndy Whitcroft } 11879c0ca6f9SAndy Whitcroft } 11889c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11890a920b5bSAndy Whitcroft 11909c0ca6f9SAndy Whitcroft return $res; 11910a920b5bSAndy Whitcroft} 11920a920b5bSAndy Whitcroft 1193c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1194cf655043SAndy Whitcroftmy $av_pending; 1195c2fdda0dSAndy Whitcroftmy @av_paren_type; 11961f65f947SAndy Whitcroftmy $av_pend_colon; 1197c2fdda0dSAndy Whitcroft 1198c2fdda0dSAndy Whitcroftsub annotate_reset { 1199c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1200cf655043SAndy Whitcroft $av_pending = '_'; 1201cf655043SAndy Whitcroft @av_paren_type = ('E'); 12021f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1203c2fdda0dSAndy Whitcroft} 1204c2fdda0dSAndy Whitcroft 12056c72ffaaSAndy Whitcroftsub annotate_values { 12066c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 12076c72ffaaSAndy Whitcroft 12086c72ffaaSAndy Whitcroft my $res; 12091f65f947SAndy Whitcroft my $var = '_' x length($stream); 12106c72ffaaSAndy Whitcroft my $cur = $stream; 12116c72ffaaSAndy Whitcroft 1212c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 12136c72ffaaSAndy Whitcroft 12146c72ffaaSAndy Whitcroft while (length($cur)) { 1215773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1216cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1217171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 12186c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1219c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1220c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1221cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1222c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 12236c72ffaaSAndy Whitcroft } 12246c72ffaaSAndy Whitcroft 1225c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 12269446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 12279446ef56SAndy Whitcroft push(@av_paren_type, $type); 1228addcdceaSAndy Whitcroft $type = 'c'; 12299446ef56SAndy Whitcroft 1230e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1231c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12326c72ffaaSAndy Whitcroft $type = 'T'; 12336c72ffaaSAndy Whitcroft 1234389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1235389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1236389a2fe5SAndy Whitcroft $type = 'T'; 1237389a2fe5SAndy Whitcroft 1238c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1239171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1240c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1241171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1242171ae1a4SAndy Whitcroft if ($2 ne '') { 1243cf655043SAndy Whitcroft $av_pending = 'N'; 1244171ae1a4SAndy Whitcroft } 1245171ae1a4SAndy Whitcroft $type = 'E'; 1246171ae1a4SAndy Whitcroft 1247c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1248171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1249171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1250171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12516c72ffaaSAndy Whitcroft 1252c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1253cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1254c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1255cf655043SAndy Whitcroft 1256cf655043SAndy Whitcroft push(@av_paren_type, $type); 1257cf655043SAndy Whitcroft push(@av_paren_type, $type); 1258171ae1a4SAndy Whitcroft $type = 'E'; 1259cf655043SAndy Whitcroft 1260c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1261cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1262cf655043SAndy Whitcroft $av_preprocessor = 1; 1263cf655043SAndy Whitcroft 1264cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1265cf655043SAndy Whitcroft 1266171ae1a4SAndy Whitcroft $type = 'E'; 1267cf655043SAndy Whitcroft 1268c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1269cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1270cf655043SAndy Whitcroft 1271cf655043SAndy Whitcroft $av_preprocessor = 1; 1272cf655043SAndy Whitcroft 1273cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1274cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1275cf655043SAndy Whitcroft pop(@av_paren_type); 1276cf655043SAndy Whitcroft push(@av_paren_type, $type); 1277171ae1a4SAndy Whitcroft $type = 'E'; 12786c72ffaaSAndy Whitcroft 12796c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1280c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12816c72ffaaSAndy Whitcroft 1282171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1283171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1284171ae1a4SAndy Whitcroft $av_pending = $type; 1285171ae1a4SAndy Whitcroft $type = 'N'; 1286171ae1a4SAndy Whitcroft 12876c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1288c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12896c72ffaaSAndy Whitcroft if (defined $2) { 1290cf655043SAndy Whitcroft $av_pending = 'V'; 12916c72ffaaSAndy Whitcroft } 12926c72ffaaSAndy Whitcroft $type = 'N'; 12936c72ffaaSAndy Whitcroft 129414b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1295c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 129614b111c1SAndy Whitcroft $av_pending = 'E'; 12976c72ffaaSAndy Whitcroft $type = 'N'; 12986c72ffaaSAndy Whitcroft 12991f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 13001f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 13011f65f947SAndy Whitcroft $av_pend_colon = 'C'; 13021f65f947SAndy Whitcroft $type = 'N'; 13031f65f947SAndy Whitcroft 130414b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1305c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 13066c72ffaaSAndy Whitcroft $type = 'N'; 13076c72ffaaSAndy Whitcroft 13086c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1309c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1310cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1311cf655043SAndy Whitcroft $av_pending = '_'; 13126c72ffaaSAndy Whitcroft $type = 'N'; 13136c72ffaaSAndy Whitcroft 13146c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1315cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1316cf655043SAndy Whitcroft if ($new_type ne '_') { 1317cf655043SAndy Whitcroft $type = $new_type; 1318c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1319c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 13206c72ffaaSAndy Whitcroft } else { 1321c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 13226c72ffaaSAndy Whitcroft } 13236c72ffaaSAndy Whitcroft 1324c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1325c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1326c8cb2ca3SAndy Whitcroft $type = 'V'; 1327cf655043SAndy Whitcroft $av_pending = 'V'; 13286c72ffaaSAndy Whitcroft 13298e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 13308e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13311f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13328e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13338e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13341f65f947SAndy Whitcroft } 13351f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13361f65f947SAndy Whitcroft $type = 'V'; 13371f65f947SAndy Whitcroft 13386c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1339c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13406c72ffaaSAndy Whitcroft $type = 'V'; 13416c72ffaaSAndy Whitcroft 13426c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1343c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13446c72ffaaSAndy Whitcroft $type = 'N'; 13456c72ffaaSAndy Whitcroft 1346cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1347c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 134813214adfSAndy Whitcroft $type = 'E'; 13491f65f947SAndy Whitcroft $av_pend_colon = 'O'; 135013214adfSAndy Whitcroft 13518e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13528e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13538e761b04SAndy Whitcroft $type = 'C'; 13548e761b04SAndy Whitcroft 13551f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13561f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 13571f65f947SAndy Whitcroft $type = 'N'; 13581f65f947SAndy Whitcroft 13591f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 13601f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 13611f65f947SAndy Whitcroft 13621f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13631f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13641f65f947SAndy Whitcroft $type = 'E'; 13651f65f947SAndy Whitcroft } else { 13661f65f947SAndy Whitcroft $type = 'N'; 13671f65f947SAndy Whitcroft } 13681f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13691f65f947SAndy Whitcroft 13708e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 137113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13726c72ffaaSAndy Whitcroft $type = 'N'; 13736c72ffaaSAndy Whitcroft 13740d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 137574048ed8SAndy Whitcroft my $variant; 137674048ed8SAndy Whitcroft 137774048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 137874048ed8SAndy Whitcroft if ($type eq 'V') { 137974048ed8SAndy Whitcroft $variant = 'B'; 138074048ed8SAndy Whitcroft } else { 138174048ed8SAndy Whitcroft $variant = 'U'; 138274048ed8SAndy Whitcroft } 138374048ed8SAndy Whitcroft 138474048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 138574048ed8SAndy Whitcroft $type = 'N'; 138674048ed8SAndy Whitcroft 13876c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1388c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13896c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13906c72ffaaSAndy Whitcroft $type = 'N'; 13916c72ffaaSAndy Whitcroft } 13926c72ffaaSAndy Whitcroft 13936c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1394c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13956c72ffaaSAndy Whitcroft } 13966c72ffaaSAndy Whitcroft if (defined $1) { 13976c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13986c72ffaaSAndy Whitcroft $res .= $type x length($1); 13996c72ffaaSAndy Whitcroft } 14006c72ffaaSAndy Whitcroft } 14016c72ffaaSAndy Whitcroft 14021f65f947SAndy Whitcroft return ($res, $var); 14036c72ffaaSAndy Whitcroft} 14046c72ffaaSAndy Whitcroft 14058905a67cSAndy Whitcroftsub possible { 140613214adfSAndy Whitcroft my ($possible, $line) = @_; 14079a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 14080776e594SAndy Whitcroft ^(?: 14090776e594SAndy Whitcroft $Modifier| 14100776e594SAndy Whitcroft $Storage| 14110776e594SAndy Whitcroft $Type| 14129a974fdbSAndy Whitcroft DEFINE_\S+ 14139a974fdbSAndy Whitcroft )$| 14149a974fdbSAndy Whitcroft ^(?: 14150776e594SAndy Whitcroft goto| 14160776e594SAndy Whitcroft return| 14170776e594SAndy Whitcroft case| 14180776e594SAndy Whitcroft else| 14190776e594SAndy Whitcroft asm|__asm__| 142089a88353SAndy Whitcroft do| 142189a88353SAndy Whitcroft \#| 142289a88353SAndy Whitcroft \#\#| 14239a974fdbSAndy Whitcroft )(?:\s|$)| 14240776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 14259a974fdbSAndy Whitcroft )}x; 14269a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 14279a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1428c45dcabdSAndy Whitcroft # Check for modifiers. 1429c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1430c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1431c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1432c45dcabdSAndy Whitcroft 1433c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1434c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1435d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14369a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1437d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1438d2506586SAndy Whitcroft push(@modifierList, $modifier); 1439d2506586SAndy Whitcroft } 14409a974fdbSAndy Whitcroft } 1441c45dcabdSAndy Whitcroft 1442c45dcabdSAndy Whitcroft } else { 144313214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14448905a67cSAndy Whitcroft push(@typeList, $possible); 1445c45dcabdSAndy Whitcroft } 14468905a67cSAndy Whitcroft build_types(); 14470776e594SAndy Whitcroft } else { 14480776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14498905a67cSAndy Whitcroft } 14508905a67cSAndy Whitcroft} 14518905a67cSAndy Whitcroft 14526c72ffaaSAndy Whitcroftmy $prefix = ''; 14536c72ffaaSAndy Whitcroft 1454000d1cc1SJoe Perchessub show_type { 1455cbec18afSJoe Perches my ($type) = @_; 145691bfe484SJoe Perches 1457cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1458cbec18afSJoe Perches 1459cbec18afSJoe Perches return !defined $ignore_type{$type}; 1460000d1cc1SJoe Perches} 1461000d1cc1SJoe Perches 1462f0a594c1SAndy Whitcroftsub report { 1463cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1464cbec18afSJoe Perches 1465cbec18afSJoe Perches if (!show_type($type) || 1466cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1467773647a0SAndy Whitcroft return 0; 1468773647a0SAndy Whitcroft } 1469000d1cc1SJoe Perches my $line; 1470000d1cc1SJoe Perches if ($show_types) { 1471cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1472000d1cc1SJoe Perches } else { 1473cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1474000d1cc1SJoe Perches } 14758905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14768905a67cSAndy Whitcroft 147713214adfSAndy Whitcroft push(our @report, $line); 1478773647a0SAndy Whitcroft 1479773647a0SAndy Whitcroft return 1; 1480f0a594c1SAndy Whitcroft} 1481cbec18afSJoe Perches 1482f0a594c1SAndy Whitcroftsub report_dump { 148313214adfSAndy Whitcroft our @report; 1484f0a594c1SAndy Whitcroft} 1485000d1cc1SJoe Perches 1486de7d4f0eSAndy Whitcroftsub ERROR { 1487cbec18afSJoe Perches my ($type, $msg) = @_; 1488cbec18afSJoe Perches 1489cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1490de7d4f0eSAndy Whitcroft our $clean = 0; 14916c72ffaaSAndy Whitcroft our $cnt_error++; 14923705ce5bSJoe Perches return 1; 1493de7d4f0eSAndy Whitcroft } 14943705ce5bSJoe Perches return 0; 1495773647a0SAndy Whitcroft} 1496de7d4f0eSAndy Whitcroftsub WARN { 1497cbec18afSJoe Perches my ($type, $msg) = @_; 1498cbec18afSJoe Perches 1499cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1500de7d4f0eSAndy Whitcroft our $clean = 0; 15016c72ffaaSAndy Whitcroft our $cnt_warn++; 15023705ce5bSJoe Perches return 1; 1503de7d4f0eSAndy Whitcroft } 15043705ce5bSJoe Perches return 0; 1505773647a0SAndy Whitcroft} 1506de7d4f0eSAndy Whitcroftsub CHK { 1507cbec18afSJoe Perches my ($type, $msg) = @_; 1508cbec18afSJoe Perches 1509cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1510de7d4f0eSAndy Whitcroft our $clean = 0; 15116c72ffaaSAndy Whitcroft our $cnt_chk++; 15123705ce5bSJoe Perches return 1; 15136c72ffaaSAndy Whitcroft } 15143705ce5bSJoe Perches return 0; 1515de7d4f0eSAndy Whitcroft} 1516de7d4f0eSAndy Whitcroft 15176ecd9674SAndy Whitcroftsub check_absolute_file { 15186ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 15196ecd9674SAndy Whitcroft my $file = $absolute; 15206ecd9674SAndy Whitcroft 15216ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 15226ecd9674SAndy Whitcroft 15236ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 15246ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 15256ecd9674SAndy Whitcroft if (-f "$root/$file") { 15266ecd9674SAndy Whitcroft ##print "file<$file>\n"; 15276ecd9674SAndy Whitcroft last; 15286ecd9674SAndy Whitcroft } 15296ecd9674SAndy Whitcroft } 15306ecd9674SAndy Whitcroft if (! -f _) { 15316ecd9674SAndy Whitcroft return 0; 15326ecd9674SAndy Whitcroft } 15336ecd9674SAndy Whitcroft 15346ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 15356ecd9674SAndy Whitcroft my $prefix = $absolute; 15366ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 15376ecd9674SAndy Whitcroft 15386ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 15396ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1540000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1541000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 15426ecd9674SAndy Whitcroft } 15436ecd9674SAndy Whitcroft} 15446ecd9674SAndy Whitcroft 15453705ce5bSJoe Perchessub trim { 15463705ce5bSJoe Perches my ($string) = @_; 15473705ce5bSJoe Perches 1548b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1549b34c648bSJoe Perches 1550b34c648bSJoe Perches return $string; 1551b34c648bSJoe Perches} 1552b34c648bSJoe Perches 1553b34c648bSJoe Perchessub ltrim { 1554b34c648bSJoe Perches my ($string) = @_; 1555b34c648bSJoe Perches 1556b34c648bSJoe Perches $string =~ s/^\s+//; 1557b34c648bSJoe Perches 1558b34c648bSJoe Perches return $string; 1559b34c648bSJoe Perches} 1560b34c648bSJoe Perches 1561b34c648bSJoe Perchessub rtrim { 1562b34c648bSJoe Perches my ($string) = @_; 1563b34c648bSJoe Perches 1564b34c648bSJoe Perches $string =~ s/\s+$//; 15653705ce5bSJoe Perches 15663705ce5bSJoe Perches return $string; 15673705ce5bSJoe Perches} 15683705ce5bSJoe Perches 156952ea8506SJoe Perchessub string_find_replace { 157052ea8506SJoe Perches my ($string, $find, $replace) = @_; 157152ea8506SJoe Perches 157252ea8506SJoe Perches $string =~ s/$find/$replace/g; 157352ea8506SJoe Perches 157452ea8506SJoe Perches return $string; 157552ea8506SJoe Perches} 157652ea8506SJoe Perches 15773705ce5bSJoe Perchessub tabify { 15783705ce5bSJoe Perches my ($leading) = @_; 15793705ce5bSJoe Perches 15803705ce5bSJoe Perches my $source_indent = 8; 15813705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 15823705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 15833705ce5bSJoe Perches 15843705ce5bSJoe Perches #convert leading spaces to tabs 15853705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 15863705ce5bSJoe Perches #Remove spaces before a tab 15873705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 15883705ce5bSJoe Perches 15893705ce5bSJoe Perches return "$leading"; 15903705ce5bSJoe Perches} 15913705ce5bSJoe Perches 1592d1fe9c09SJoe Perchessub pos_last_openparen { 1593d1fe9c09SJoe Perches my ($line) = @_; 1594d1fe9c09SJoe Perches 1595d1fe9c09SJoe Perches my $pos = 0; 1596d1fe9c09SJoe Perches 1597d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1598d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1599d1fe9c09SJoe Perches 1600d1fe9c09SJoe Perches my $last_openparen = 0; 1601d1fe9c09SJoe Perches 1602d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1603d1fe9c09SJoe Perches return -1; 1604d1fe9c09SJoe Perches } 1605d1fe9c09SJoe Perches 1606d1fe9c09SJoe Perches my $len = length($line); 1607d1fe9c09SJoe Perches 1608d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1609d1fe9c09SJoe Perches my $string = substr($line, $pos); 1610d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1611d1fe9c09SJoe Perches $pos += length($1) - 1; 1612d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1613d1fe9c09SJoe Perches $last_openparen = $pos; 1614d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1615d1fe9c09SJoe Perches last; 1616d1fe9c09SJoe Perches } 1617d1fe9c09SJoe Perches } 1618d1fe9c09SJoe Perches 161991cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1620d1fe9c09SJoe Perches} 1621d1fe9c09SJoe Perches 16220a920b5bSAndy Whitcroftsub process { 16230a920b5bSAndy Whitcroft my $filename = shift; 16240a920b5bSAndy Whitcroft 16250a920b5bSAndy Whitcroft my $linenr=0; 16260a920b5bSAndy Whitcroft my $prevline=""; 1627c2fdda0dSAndy Whitcroft my $prevrawline=""; 16280a920b5bSAndy Whitcroft my $stashline=""; 1629c2fdda0dSAndy Whitcroft my $stashrawline=""; 16300a920b5bSAndy Whitcroft 16314a0df2efSAndy Whitcroft my $length; 16320a920b5bSAndy Whitcroft my $indent; 16330a920b5bSAndy Whitcroft my $previndent=0; 16340a920b5bSAndy Whitcroft my $stashindent=0; 16350a920b5bSAndy Whitcroft 1636de7d4f0eSAndy Whitcroft our $clean = 1; 16370a920b5bSAndy Whitcroft my $signoff = 0; 16380a920b5bSAndy Whitcroft my $is_patch = 0; 16390a920b5bSAndy Whitcroft 164015662b3eSJoe Perches my $in_header_lines = 1; 164115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 164215662b3eSJoe Perches 1643fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1644fa64205dSPasi Savanainen 164513214adfSAndy Whitcroft our @report = (); 16466c72ffaaSAndy Whitcroft our $cnt_lines = 0; 16476c72ffaaSAndy Whitcroft our $cnt_error = 0; 16486c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16496c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16506c72ffaaSAndy Whitcroft 16510a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16520a920b5bSAndy Whitcroft my $realfile = ''; 16530a920b5bSAndy Whitcroft my $realline = 0; 16540a920b5bSAndy Whitcroft my $realcnt = 0; 16550a920b5bSAndy Whitcroft my $here = ''; 16560a920b5bSAndy Whitcroft my $in_comment = 0; 1657c2fdda0dSAndy Whitcroft my $comment_edge = 0; 16580a920b5bSAndy Whitcroft my $first_line = 0; 16591e855726SWolfram Sang my $p1_prefix = ''; 16600a920b5bSAndy Whitcroft 166113214adfSAndy Whitcroft my $prev_values = 'E'; 166213214adfSAndy Whitcroft 166313214adfSAndy Whitcroft # suppression flags 1664773647a0SAndy Whitcroft my %suppress_ifbraces; 1665170d3a22SAndy Whitcroft my %suppress_whiletrailers; 16662b474a1aSAndy Whitcroft my %suppress_export; 16673e469cdcSAndy Whitcroft my $suppress_statement = 0; 1668653d4876SAndy Whitcroft 16697e51f197SJoe Perches my %signatures = (); 1670323c1260SJoe Perches 1671c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1672de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1673c2fdda0dSAndy Whitcroft # 1674de7d4f0eSAndy Whitcroft my @setup_docs = (); 1675de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1676773647a0SAndy Whitcroft 1677d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1678d8b07710SJoe Perches 1679773647a0SAndy Whitcroft sanitise_line_reset(); 1680c2fdda0dSAndy Whitcroft my $line; 1681c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1682773647a0SAndy Whitcroft $linenr++; 1683773647a0SAndy Whitcroft $line = $rawline; 1684c2fdda0dSAndy Whitcroft 16853705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 16863705ce5bSJoe Perches 1687773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1688de7d4f0eSAndy Whitcroft $setup_docs = 0; 1689de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1690de7d4f0eSAndy Whitcroft $setup_docs = 1; 1691de7d4f0eSAndy Whitcroft } 1692773647a0SAndy Whitcroft #next; 1693de7d4f0eSAndy Whitcroft } 1694773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1695773647a0SAndy Whitcroft $realline=$1-1; 1696773647a0SAndy Whitcroft if (defined $2) { 1697773647a0SAndy Whitcroft $realcnt=$3+1; 1698773647a0SAndy Whitcroft } else { 1699773647a0SAndy Whitcroft $realcnt=1+1; 1700773647a0SAndy Whitcroft } 1701c45dcabdSAndy Whitcroft $in_comment = 0; 1702773647a0SAndy Whitcroft 1703773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1704773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1705773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1706773647a0SAndy Whitcroft # at context start. 1707773647a0SAndy Whitcroft my $edge; 170801fa9147SAndy Whitcroft my $cnt = $realcnt; 170901fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 171001fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 171101fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 171201fa9147SAndy Whitcroft $cnt--; 171301fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1714721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1715fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1716fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1717fae17daeSAndy Whitcroft ($edge) = $1; 1718fae17daeSAndy Whitcroft last; 1719fae17daeSAndy Whitcroft } 1720773647a0SAndy Whitcroft } 1721773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1722773647a0SAndy Whitcroft $in_comment = 1; 1723773647a0SAndy Whitcroft } 1724773647a0SAndy Whitcroft 1725773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1726773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1727773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1728773647a0SAndy Whitcroft if (!defined $edge && 172983242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1730773647a0SAndy Whitcroft { 1731773647a0SAndy Whitcroft $in_comment = 1; 1732773647a0SAndy Whitcroft } 1733773647a0SAndy Whitcroft 1734773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1735773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1736773647a0SAndy Whitcroft 1737171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1738773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1739171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1740773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1741773647a0SAndy Whitcroft } 1742773647a0SAndy Whitcroft push(@lines, $line); 1743773647a0SAndy Whitcroft 1744773647a0SAndy Whitcroft if ($realcnt > 1) { 1745773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1746773647a0SAndy Whitcroft } else { 1747773647a0SAndy Whitcroft $realcnt = 0; 1748773647a0SAndy Whitcroft } 1749773647a0SAndy Whitcroft 1750773647a0SAndy Whitcroft #print "==>$rawline\n"; 1751773647a0SAndy Whitcroft #print "-->$line\n"; 1752de7d4f0eSAndy Whitcroft 1753de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1754de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1755de7d4f0eSAndy Whitcroft } 1756de7d4f0eSAndy Whitcroft } 1757de7d4f0eSAndy Whitcroft 17586c72ffaaSAndy Whitcroft $prefix = ''; 17596c72ffaaSAndy Whitcroft 1760773647a0SAndy Whitcroft $realcnt = 0; 1761773647a0SAndy Whitcroft $linenr = 0; 17620a920b5bSAndy Whitcroft foreach my $line (@lines) { 17630a920b5bSAndy Whitcroft $linenr++; 17641b5539b1SJoe Perches my $sline = $line; #copy of $line 17651b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 17660a920b5bSAndy Whitcroft 1767c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 17686c72ffaaSAndy Whitcroft 17690a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 17706c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 17710a920b5bSAndy Whitcroft $is_patch = 1; 17724a0df2efSAndy Whitcroft $first_line = $linenr + 1; 17730a920b5bSAndy Whitcroft $realline=$1-1; 17740a920b5bSAndy Whitcroft if (defined $2) { 17750a920b5bSAndy Whitcroft $realcnt=$3+1; 17760a920b5bSAndy Whitcroft } else { 17770a920b5bSAndy Whitcroft $realcnt=1+1; 17780a920b5bSAndy Whitcroft } 1779c2fdda0dSAndy Whitcroft annotate_reset(); 178013214adfSAndy Whitcroft $prev_values = 'E'; 178113214adfSAndy Whitcroft 1782773647a0SAndy Whitcroft %suppress_ifbraces = (); 1783170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 17842b474a1aSAndy Whitcroft %suppress_export = (); 17853e469cdcSAndy Whitcroft $suppress_statement = 0; 17860a920b5bSAndy Whitcroft next; 17870a920b5bSAndy Whitcroft 17884a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 17894a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 17904a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1791773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 17920a920b5bSAndy Whitcroft $realline++; 1793d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 17940a920b5bSAndy Whitcroft 17954a0df2efSAndy Whitcroft # Measure the line length and indent. 1796c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 17970a920b5bSAndy Whitcroft 17980a920b5bSAndy Whitcroft # Track the previous line. 17990a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 18000a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1801c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1802c2fdda0dSAndy Whitcroft 1803773647a0SAndy Whitcroft #warn "line<$line>\n"; 18046c72ffaaSAndy Whitcroft 1805d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1806d8aaf121SAndy Whitcroft $realcnt--; 18070a920b5bSAndy Whitcroft } 18080a920b5bSAndy Whitcroft 1809cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1810cc77cdcaSAndy Whitcroft 18110a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1812773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1813773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1814773647a0SAndy Whitcroft 18156c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 18166c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1817773647a0SAndy Whitcroft 1818*2ac73b4fSJoe Perches my $found_file = 0; 1819773647a0SAndy Whitcroft # extract the filename as it passes 18203bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 18213bf9a009SRabin Vincent $realfile = $1; 18222b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1823270c49a0SJoe Perches $in_commit_log = 0; 1824*2ac73b4fSJoe Perches $found_file = 1; 18253bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1826773647a0SAndy Whitcroft $realfile = $1; 18272b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1828270c49a0SJoe Perches $in_commit_log = 0; 18291e855726SWolfram Sang 18301e855726SWolfram Sang $p1_prefix = $1; 1831e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1832e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1833000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1834000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 18351e855726SWolfram Sang } 1836773647a0SAndy Whitcroft 1837c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1838000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1839000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1840773647a0SAndy Whitcroft } 1841*2ac73b4fSJoe Perches $found_file = 1; 1842*2ac73b4fSJoe Perches } 1843*2ac73b4fSJoe Perches 1844*2ac73b4fSJoe Perches if ($found_file) { 1845*2ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 1846*2ac73b4fSJoe Perches $check = 1; 1847*2ac73b4fSJoe Perches } else { 1848*2ac73b4fSJoe Perches $check = $check_orig; 1849*2ac73b4fSJoe Perches } 1850773647a0SAndy Whitcroft next; 1851773647a0SAndy Whitcroft } 1852773647a0SAndy Whitcroft 1853389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 18540a920b5bSAndy Whitcroft 1855c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1856c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1857c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 18580a920b5bSAndy Whitcroft 18596c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 18606c72ffaaSAndy Whitcroft 18613bf9a009SRabin Vincent# Check for incorrect file permissions 18623bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 18633bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 186404db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 186504db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1866000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1867000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 18683bf9a009SRabin Vincent } 18693bf9a009SRabin Vincent } 18703bf9a009SRabin Vincent 187120112475SJoe Perches# Check the patch for a signoff: 1872d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 18734a0df2efSAndy Whitcroft $signoff++; 187415662b3eSJoe Perches $in_commit_log = 0; 18750a920b5bSAndy Whitcroft } 187620112475SJoe Perches 187720112475SJoe Perches# Check signature styles 1878270c49a0SJoe Perches if (!$in_header_lines && 1879ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 188020112475SJoe Perches my $space_before = $1; 188120112475SJoe Perches my $sign_off = $2; 188220112475SJoe Perches my $space_after = $3; 188320112475SJoe Perches my $email = $4; 188420112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 188520112475SJoe Perches 1886ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1887ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1888ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1889ce0338dfSJoe Perches } 189020112475SJoe Perches if (defined $space_before && $space_before ne "") { 18913705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18923705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 18933705ce5bSJoe Perches $fix) { 18943705ce5bSJoe Perches $fixed[$linenr - 1] = 18953705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18963705ce5bSJoe Perches } 189720112475SJoe Perches } 189820112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 18993705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 19003705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 19013705ce5bSJoe Perches $fix) { 19023705ce5bSJoe Perches $fixed[$linenr - 1] = 19033705ce5bSJoe Perches "$ucfirst_sign_off $email"; 19043705ce5bSJoe Perches } 19053705ce5bSJoe Perches 190620112475SJoe Perches } 190720112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 19083705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 19093705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 19103705ce5bSJoe Perches $fix) { 19113705ce5bSJoe Perches $fixed[$linenr - 1] = 19123705ce5bSJoe Perches "$ucfirst_sign_off $email"; 19133705ce5bSJoe Perches } 191420112475SJoe Perches } 191520112475SJoe Perches 191620112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 191720112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 191820112475SJoe Perches if ($suggested_email eq "") { 1919000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1920000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 192120112475SJoe Perches } else { 192220112475SJoe Perches my $dequoted = $suggested_email; 192320112475SJoe Perches $dequoted =~ s/^"//; 192420112475SJoe Perches $dequoted =~ s/" </ </; 192520112475SJoe Perches # Don't force email to have quotes 192620112475SJoe Perches # Allow just an angle bracketed address 192720112475SJoe Perches if ("$dequoted$comment" ne $email && 192820112475SJoe Perches "<$email_address>$comment" ne $email && 192920112475SJoe Perches "$suggested_email$comment" ne $email) { 1930000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1931000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 193220112475SJoe Perches } 19330a920b5bSAndy Whitcroft } 19347e51f197SJoe Perches 19357e51f197SJoe Perches# Check for duplicate signatures 19367e51f197SJoe Perches my $sig_nospace = $line; 19377e51f197SJoe Perches $sig_nospace =~ s/\s//g; 19387e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 19397e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 19407e51f197SJoe Perches WARN("BAD_SIGN_OFF", 19417e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 19427e51f197SJoe Perches } else { 19437e51f197SJoe Perches $signatures{$sig_nospace} = 1; 19447e51f197SJoe Perches } 19450a920b5bSAndy Whitcroft } 19460a920b5bSAndy Whitcroft 19477ebd05efSChristopher Covington# Check for unwanted Gerrit info 19487ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 19497ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 19507ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 19517ebd05efSChristopher Covington } 19527ebd05efSChristopher Covington 195300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 19548905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1955000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1956000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 19576c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1958de7d4f0eSAndy Whitcroft } 1959de7d4f0eSAndy Whitcroft 19606ecd9674SAndy Whitcroft# Check for absolute kernel paths. 19616ecd9674SAndy Whitcroft if ($tree) { 19626ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 19636ecd9674SAndy Whitcroft my $file = $1; 19646ecd9674SAndy Whitcroft 19656ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19666ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19676ecd9674SAndy Whitcroft # 19686ecd9674SAndy Whitcroft } else { 19696ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19706ecd9674SAndy Whitcroft } 19716ecd9674SAndy Whitcroft } 19726ecd9674SAndy Whitcroft } 19736ecd9674SAndy Whitcroft 1974de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1975de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1976171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1977171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1978171ae1a4SAndy Whitcroft 1979171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1980171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1981171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1982171ae1a4SAndy Whitcroft 198334d99219SJoe Perches CHK("INVALID_UTF8", 1984000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 198500df344fSAndy Whitcroft } 19860a920b5bSAndy Whitcroft 198715662b3eSJoe Perches# Check if it's the start of a commit log 198815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 198915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1990270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 199115662b3eSJoe Perches $in_header_lines = 0; 199215662b3eSJoe Perches $in_commit_log = 1; 199315662b3eSJoe Perches } 199415662b3eSJoe Perches 1995fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1996fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1997fa64205dSPasi Savanainen if ($in_header_lines && 1998fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1999fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2000fa64205dSPasi Savanainen $non_utf8_charset = 1; 2001fa64205dSPasi Savanainen } 2002fa64205dSPasi Savanainen 2003fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 200415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2005fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 200615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 200715662b3eSJoe Perches } 200815662b3eSJoe Perches 200930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 201030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 201100df344fSAndy Whitcroft 20120a920b5bSAndy Whitcroft#trailing whitespace 20139c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2014c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2015d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2016d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2017d5e616fcSJoe Perches $fix) { 2018d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 2019d5e616fcSJoe Perches } 2020c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2021c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20223705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 20233705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 20243705ce5bSJoe Perches $fix) { 2025d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 20263705ce5bSJoe Perches } 20273705ce5bSJoe Perches 2028d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 20290a920b5bSAndy Whitcroft } 20305368df20SAndy Whitcroft 20314783f894SJosh Triplett# Check for FSF mailing addresses. 2032109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 20333e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 20343e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 20354783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20364783f894SJosh Triplett my $msg_type = \&ERROR; 20374783f894SJosh Triplett $msg_type = \&CHK if ($file); 20384783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 20394783f894SJosh Triplett "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet) 20404783f894SJosh Triplett } 20414783f894SJosh Triplett 20423354957aSAndi Kleen# check for Kconfig help text having a real description 20439fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 20449fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 20453354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2046a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 20473354957aSAndi Kleen my $length = 0; 20489fe287d7SAndy Whitcroft my $cnt = $realcnt; 20499fe287d7SAndy Whitcroft my $ln = $linenr + 1; 20509fe287d7SAndy Whitcroft my $f; 2051a1385803SAndy Whitcroft my $is_start = 0; 20529fe287d7SAndy Whitcroft my $is_end = 0; 2053a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 20549fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 20559fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 20569fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 20579fe287d7SAndy Whitcroft 20589fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2059a1385803SAndy Whitcroft 2060a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2061a1385803SAndy Whitcroft $is_start = 1; 2062a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2063a1385803SAndy Whitcroft $length = -1; 2064a1385803SAndy Whitcroft } 2065a1385803SAndy Whitcroft 20669fe287d7SAndy Whitcroft $f =~ s/^.//; 20673354957aSAndi Kleen $f =~ s/#.*//; 20683354957aSAndi Kleen $f =~ s/^\s+//; 20693354957aSAndi Kleen next if ($f =~ /^$/); 20709fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20719fe287d7SAndy Whitcroft $is_end = 1; 20729fe287d7SAndy Whitcroft last; 20739fe287d7SAndy Whitcroft } 20743354957aSAndi Kleen $length++; 20753354957aSAndi Kleen } 2076000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2077a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2078a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20793354957aSAndi Kleen } 20803354957aSAndi Kleen 20811ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20821ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20831ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20841ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20851ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20861ba8dfd1SKees Cook } 20871ba8dfd1SKees Cook 2088c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2089c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2090c68e5878SArnaud Lacombe my $flag = $1; 2091c68e5878SArnaud Lacombe my $replacement = { 2092c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2093c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2094c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2095c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2096c68e5878SArnaud Lacombe }; 2097c68e5878SArnaud Lacombe 2098c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2099c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2100c68e5878SArnaud Lacombe } 2101c68e5878SArnaud Lacombe 2102bff5da43SRob Herring# check for DT compatible documentation 21037dd05b38SFlorian Vaussard if (defined $root && 21047dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 21057dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 21067dd05b38SFlorian Vaussard 2107bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2108bff5da43SRob Herring 2109cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2110cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2111cc93319bSFlorian Vaussard 2112bff5da43SRob Herring foreach my $compat (@compats) { 2113bff5da43SRob Herring my $compat2 = $compat; 2114185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2115185d566bSRob Herring my $compat3 = $compat; 2116185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2117185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2118bff5da43SRob Herring if ( $? >> 8 ) { 2119bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2120bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2121bff5da43SRob Herring } 2122bff5da43SRob Herring 21234fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 21244fbf32a6SFlorian Vaussard my $vendor = $1; 2125cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2126bff5da43SRob Herring if ( $? >> 8 ) { 2127bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2128cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2129bff5da43SRob Herring } 2130bff5da43SRob Herring } 2131bff5da43SRob Herring } 2132bff5da43SRob Herring 21335368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 21345368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 21355368df20SAndy Whitcroft 21366cd7f386SJoe Perches#line length limit 2137c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2138f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 21390fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 21408bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 21416cd7f386SJoe Perches $length > $max_line_length) 2142c45dcabdSAndy Whitcroft { 2143000d1cc1SJoe Perches WARN("LONG_LINE", 21446cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 21450a920b5bSAndy Whitcroft } 21460a920b5bSAndy Whitcroft 2147ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 21488c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 21498c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 21508c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2151ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2152ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 21538c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2154ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2155ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2156ca56dc09SJosh Triplett } 2157ca56dc09SJosh Triplett 21585e79d96eSJoe Perches# check for spaces before a quoted newline 21595e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 21603705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 21613705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 21623705ce5bSJoe Perches $fix) { 21633705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 21643705ce5bSJoe Perches } 21653705ce5bSJoe Perches 21665e79d96eSJoe Perches } 21675e79d96eSJoe Perches 21688905a67cSAndy Whitcroft# check for adding lines without a newline. 21698905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2170000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2171000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 21728905a67cSAndy Whitcroft } 21738905a67cSAndy Whitcroft 217442e41c54SMike Frysinger# Blackfin: use hi/lo macros 217542e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 217642e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 217742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2178000d1cc1SJoe Perches ERROR("LO_MACRO", 2179000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 218042e41c54SMike Frysinger } 218142e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 218242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2183000d1cc1SJoe Perches ERROR("HI_MACRO", 2184000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 218542e41c54SMike Frysinger } 218642e41c54SMike Frysinger } 218742e41c54SMike Frysinger 2188b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2189b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21900a920b5bSAndy Whitcroft 21910a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21920a920b5bSAndy Whitcroft# more than 8 must use tabs. 2193c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2194c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2195c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2196d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21973705ce5bSJoe Perches if (ERROR("CODE_INDENT", 21983705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 21993705ce5bSJoe Perches $fix) { 22003705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22013705ce5bSJoe Perches } 22020a920b5bSAndy Whitcroft } 22030a920b5bSAndy Whitcroft 220408e44365SAlberto Panizzo# check for space before tabs. 220508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 220608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22073705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 22083705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 22093705ce5bSJoe Perches $fix) { 2210c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2211c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2212c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2213c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 22143705ce5bSJoe Perches } 221508e44365SAlberto Panizzo } 221608e44365SAlberto Panizzo 2217d1fe9c09SJoe Perches# check for && or || at the start of a line 2218d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2219d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2220d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2221d1fe9c09SJoe Perches } 2222d1fe9c09SJoe Perches 2223d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2224d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 222591cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2226d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2227d1fe9c09SJoe Perches my $oldindent = $1; 2228d1fe9c09SJoe Perches my $rest = $2; 2229d1fe9c09SJoe Perches 2230d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2231d1fe9c09SJoe Perches if ($pos >= 0) { 2232b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2233b34a26f3SJoe Perches my $newindent = $2; 2234d1fe9c09SJoe Perches 2235d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2236d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2237d1fe9c09SJoe Perches " " x ($pos % 8); 2238d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2239d1fe9c09SJoe Perches 2240d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2241d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 22423705ce5bSJoe Perches 22433705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 22443705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 22453705ce5bSJoe Perches $fix && $line =~ /^\+/) { 22463705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22473705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 22483705ce5bSJoe Perches } 2249d1fe9c09SJoe Perches } 2250d1fe9c09SJoe Perches } 2251d1fe9c09SJoe Perches } 2252d1fe9c09SJoe Perches 225323f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 22543705ce5bSJoe Perches if (CHK("SPACING", 22553705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 22563705ce5bSJoe Perches $fix) { 22573705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22583705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 22593705ce5bSJoe Perches } 2260aad4f614SJoe Perches } 2261aad4f614SJoe Perches 226205880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2263fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 226485ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 226585ad978cSJoe Perches $realline > 2) { 226605880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 226705880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 226805880600SJoe Perches } 226905880600SJoe Perches 227005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2271a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2272a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 227361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2274a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2275a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2276a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2277a605e32eSJoe Perches } 2278a605e32eSJoe Perches 2279a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2280c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2281c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2282c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2283c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 228405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 228505880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 228605880600SJoe Perches } 228705880600SJoe Perches 22883b617e3bSJoe Perches# check for missing blank lines after declarations 22893f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 22903f7bac03SJoe Perches # actual declarations 22913f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 22923f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 22933f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 22943f7bac03SJoe Perches # known declaration macros 22953f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 22963f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 22973f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 22983f7bac03SJoe Perches # other possible extensions of declaration lines 22993f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 23003f7bac03SJoe Perches # not starting a section or a macro "\" extended line 23013f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 23023f7bac03SJoe Perches # looks like a declaration 23033f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 23043f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 23053f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 23063f7bac03SJoe Perches # known declaration macros 23073f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 23083f7bac03SJoe Perches # start of struct or union or enum 23093b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 23103f7bac03SJoe Perches # start or end of block or continuation of declaration 23113f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 23123f7bac03SJoe Perches # bitfield continuation 23133f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 23143f7bac03SJoe Perches # other possible extensions of declaration lines 23153f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 23163f7bac03SJoe Perches # indentation of previous and current line are the same 23173f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 23183b617e3bSJoe Perches WARN("SPACING", 23193f7bac03SJoe Perches "Missing a blank line after declarations\n" . $hereprev); 23203b617e3bSJoe Perches } 23213b617e3bSJoe Perches 23225f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 23236b4c5bebSAndy Whitcroft# Exceptions: 23246b4c5bebSAndy Whitcroft# 1) within comments 23256b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 23266b4c5bebSAndy Whitcroft# 3) hanging labels 23273705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 23285f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23293705ce5bSJoe Perches if (WARN("LEADING_SPACE", 23303705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 23313705ce5bSJoe Perches $fix) { 23323705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 23333705ce5bSJoe Perches } 23345f7ddae6SRaffaele Recalcati } 23355f7ddae6SRaffaele Recalcati 2336b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2337b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2338b9ea10d6SAndy Whitcroft 23391ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 23401ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 23411ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 23421ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 23431ba8dfd1SKees Cook } 23441ba8dfd1SKees Cook 2345c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2346cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2347000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2348000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2349c2fdda0dSAndy Whitcroft } 235022f2a2efSAndy Whitcroft 235142e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 235242e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 235342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2354000d1cc1SJoe Perches ERROR("CSYNC", 2355000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 235642e41c54SMike Frysinger } 235742e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 235842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2359000d1cc1SJoe Perches ERROR("SSYNC", 2360000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 236142e41c54SMike Frysinger } 236242e41c54SMike Frysinger 236356e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 236456e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 236556e77d70SJoe Perches WARN("HOTPLUG_SECTION", 236656e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 236756e77d70SJoe Perches } 236856e77d70SJoe Perches 23699c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 23702b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 23712b474a1aSAndy Whitcroft $realline_next); 23723e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 23733e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 23741b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2375170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2376f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2377171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2378171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2379171ae1a4SAndy Whitcroft 23803e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 23813e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 23823e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 23833e469cdcSAndy Whitcroft # until we hit end of it. 23843e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 23853e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 23863e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 23873e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 23883e469cdcSAndy Whitcroft } 2389f74bd194SAndy Whitcroft 23902b474a1aSAndy Whitcroft # Find the real next line. 23912b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 23922b474a1aSAndy Whitcroft if (defined $realline_next && 23932b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 23942b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 23952b474a1aSAndy Whitcroft $realline_next++; 23962b474a1aSAndy Whitcroft } 23972b474a1aSAndy Whitcroft 2398171ae1a4SAndy Whitcroft my $s = $stat; 2399171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2400cf655043SAndy Whitcroft 2401c2fdda0dSAndy Whitcroft # Ignore goto labels. 2402171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2403c2fdda0dSAndy Whitcroft 2404c2fdda0dSAndy Whitcroft # Ignore functions being called 2405171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2406c2fdda0dSAndy Whitcroft 2407463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2408463f2864SAndy Whitcroft 2409c45dcabdSAndy Whitcroft # declarations always start with types 2410d2506586SAndy 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) { 2411c45dcabdSAndy Whitcroft my $type = $1; 2412c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2413c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2414c45dcabdSAndy Whitcroft 24156c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2416a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2417c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2418c2fdda0dSAndy Whitcroft } 24198905a67cSAndy Whitcroft 24206c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 242165863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2422c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 24239c0ca6f9SAndy Whitcroft } 24248905a67cSAndy Whitcroft 24258905a67cSAndy Whitcroft # Check for any sort of function declaration. 24268905a67cSAndy Whitcroft # int foo(something bar, other baz); 24278905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2428171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 24298905a67cSAndy Whitcroft my ($name_len) = length($1); 24308905a67cSAndy Whitcroft 2431cf655043SAndy Whitcroft my $ctx = $s; 2432773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 24338905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2434cf655043SAndy Whitcroft 24358905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2436c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 24378905a67cSAndy Whitcroft 2438c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 24398905a67cSAndy Whitcroft } 24408905a67cSAndy Whitcroft } 24418905a67cSAndy Whitcroft } 24428905a67cSAndy Whitcroft 24439c0ca6f9SAndy Whitcroft } 24449c0ca6f9SAndy Whitcroft 244500df344fSAndy Whitcroft# 244600df344fSAndy Whitcroft# Checks which may be anchored in the context. 244700df344fSAndy Whitcroft# 244800df344fSAndy Whitcroft 244900df344fSAndy Whitcroft# Check for switch () and associated case and default 245000df344fSAndy Whitcroft# statements should be at the same indent. 245100df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 245200df344fSAndy Whitcroft my $err = ''; 245300df344fSAndy Whitcroft my $sep = ''; 245400df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 245500df344fSAndy Whitcroft shift(@ctx); 245600df344fSAndy Whitcroft for my $ctx (@ctx) { 245700df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 245800df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 245900df344fSAndy Whitcroft $indent != $cindent) { 246000df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 246100df344fSAndy Whitcroft $sep = ''; 246200df344fSAndy Whitcroft } else { 246300df344fSAndy Whitcroft $sep = "[...]\n"; 246400df344fSAndy Whitcroft } 246500df344fSAndy Whitcroft } 246600df344fSAndy Whitcroft if ($err ne '') { 2467000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2468000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2469de7d4f0eSAndy Whitcroft } 2470de7d4f0eSAndy Whitcroft } 2471de7d4f0eSAndy Whitcroft 2472de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2473de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2474c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2475773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2476773647a0SAndy Whitcroft 24779c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 24788eef05ddSJoe Perches 24798eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 24808eef05ddSJoe Perches WARN("DEEP_INDENTATION", 24818eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 24828eef05ddSJoe Perches } 24838eef05ddSJoe Perches 2484de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2485de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2486de7d4f0eSAndy Whitcroft 2487548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2488548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2489de7d4f0eSAndy Whitcroft 2490548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2491548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2492548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2493548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2494548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2495773647a0SAndy Whitcroft $ctx_ln++; 2496773647a0SAndy Whitcroft } 2497548596d5SAndy Whitcroft 249853210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 249953210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2500773647a0SAndy Whitcroft 2501773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2502000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2503000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 250401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 250500df344fSAndy Whitcroft } 2506773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2507773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2508773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2509773647a0SAndy Whitcroft { 25109c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 25119c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2512000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2513000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 251401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 25159c0ca6f9SAndy Whitcroft } 25169c0ca6f9SAndy Whitcroft } 251700df344fSAndy Whitcroft } 251800df344fSAndy Whitcroft 25194d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 25204d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 25213e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 25223e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 25233e469cdcSAndy Whitcroft if (!defined $stat); 25244d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 25254d001e4dSAndy Whitcroft 25264d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 25274d001e4dSAndy Whitcroft 25284d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 25294d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 25304d001e4dSAndy Whitcroft # where necessary. 25314d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 25324d001e4dSAndy Whitcroft 25334d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 25346f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 25356f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 25364d001e4dSAndy Whitcroft 25374d001e4dSAndy Whitcroft # We want to check the first line inside the block 25384d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 25394d001e4dSAndy Whitcroft # 1) any blank line termination 25404d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 25414d001e4dSAndy Whitcroft # 3) any do (...) { 25424d001e4dSAndy Whitcroft my $continuation = 0; 25434d001e4dSAndy Whitcroft my $check = 0; 25444d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 25454d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 25464d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 25474d001e4dSAndy Whitcroft $continuation = 1; 25484d001e4dSAndy Whitcroft } 25499bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 25504d001e4dSAndy Whitcroft $check = 1; 25514d001e4dSAndy Whitcroft $cond_lines++; 25524d001e4dSAndy Whitcroft } 25534d001e4dSAndy Whitcroft 25544d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 25554d001e4dSAndy Whitcroft # preprocessor statement. 25564d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 25574d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 25584d001e4dSAndy Whitcroft $check = 0; 25594d001e4dSAndy Whitcroft } 25604d001e4dSAndy Whitcroft 25619bd49efeSAndy Whitcroft my $cond_ptr = -1; 2562740504c6SAndy Whitcroft $continuation = 0; 25639bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 25649bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 25654d001e4dSAndy Whitcroft 2566f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2567f16fa28fSAndy Whitcroft # is not linear. 2568f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2569f16fa28fSAndy Whitcroft $check = 0; 2570f16fa28fSAndy Whitcroft } 2571f16fa28fSAndy Whitcroft 25729bd49efeSAndy Whitcroft # Ignore: 25739bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 25749bd49efeSAndy Whitcroft # 2) preprocessor lines, and 25759bd49efeSAndy Whitcroft # 3) labels. 2576740504c6SAndy Whitcroft if ($continuation || 2577740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 25789bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 25799bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2580740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 258130dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 25829bd49efeSAndy Whitcroft $cond_lines++; 25839bd49efeSAndy Whitcroft } 25844d001e4dSAndy Whitcroft } 258530dad6ebSAndy Whitcroft } 25864d001e4dSAndy Whitcroft 25874d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 25884d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 25894d001e4dSAndy Whitcroft 25904d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 25914d001e4dSAndy Whitcroft # this is not this patch's fault. 25924d001e4dSAndy Whitcroft if (!defined($stat_real) || 25934d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 25944d001e4dSAndy Whitcroft $check = 0; 25954d001e4dSAndy Whitcroft } 25964d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 25974d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 25984d001e4dSAndy Whitcroft } 25994d001e4dSAndy Whitcroft 26009bd49efeSAndy 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"; 26014d001e4dSAndy Whitcroft 26024d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 26034d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2604000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2605000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 26064d001e4dSAndy Whitcroft } 26074d001e4dSAndy Whitcroft } 26084d001e4dSAndy Whitcroft 26096c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 26106c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 26111f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 26121f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 26136c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2614c2fdda0dSAndy Whitcroft if ($dbg_values) { 2615c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2616cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2617cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 26181f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2619c2fdda0dSAndy Whitcroft } 26206c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 26216c72ffaaSAndy Whitcroft 262200df344fSAndy Whitcroft#ignore lines not being added 26233705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 262400df344fSAndy Whitcroft 2625653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 26267429c690SAndy Whitcroft if ($dbg_type) { 26277429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2628000d1cc1SJoe Perches ERROR("TEST_TYPE", 2629000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 26307429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2631000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2632000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 26337429c690SAndy Whitcroft } 2634653d4876SAndy Whitcroft next; 2635653d4876SAndy Whitcroft } 2636a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2637a1ef277eSAndy Whitcroft if ($dbg_attr) { 26389360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2639000d1cc1SJoe Perches ERROR("TEST_ATTR", 2640000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 26419360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2642000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2643000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2644a1ef277eSAndy Whitcroft } 2645a1ef277eSAndy Whitcroft next; 2646a1ef277eSAndy Whitcroft } 2647653d4876SAndy Whitcroft 2648f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 264999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 265099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2651000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2652000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2653f0a594c1SAndy Whitcroft } 2654f0a594c1SAndy Whitcroft 265500df344fSAndy Whitcroft# 265600df344fSAndy Whitcroft# Checks which are anchored on the added line. 265700df344fSAndy Whitcroft# 265800df344fSAndy Whitcroft 2659653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2660c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2661653d4876SAndy Whitcroft my $path = $1; 2662653d4876SAndy Whitcroft if ($path =~ m{//}) { 2663000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2664495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2665495e9d84SJoe Perches } 2666495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2667495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2668495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2669653d4876SAndy Whitcroft } 2670653d4876SAndy Whitcroft } 2671653d4876SAndy Whitcroft 267200df344fSAndy Whitcroft# no C99 // comments 267300df344fSAndy Whitcroft if ($line =~ m{//}) { 26743705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 26753705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 26763705ce5bSJoe Perches $fix) { 26773705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 26783705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 26793705ce5bSJoe Perches my $comment = trim($1); 26803705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 26813705ce5bSJoe Perches } 26823705ce5bSJoe Perches } 268300df344fSAndy Whitcroft } 268400df344fSAndy Whitcroft # Remove C99 comments. 26850a920b5bSAndy Whitcroft $line =~ s@//.*@@; 26866c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 26870a920b5bSAndy Whitcroft 26882b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 26892b474a1aSAndy Whitcroft# the whole statement. 26902b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 26912b474a1aSAndy Whitcroft if (defined $realline_next && 26922b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 26932b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 26942b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 26952b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 26963cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 26973cbf62dfSAndy Whitcroft # a prefix: 26983cbf62dfSAndy Whitcroft # XXX(foo); 26993cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2700653d4876SAndy Whitcroft my $name = $1; 270187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 27023cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 27033cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 27043cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 27053cbf62dfSAndy Whitcroft 27063cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 27072b474a1aSAndy Whitcroft \n.}\s*$| 270848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 270948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 271048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 27112b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 27122b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 271348012058SAndy Whitcroft )/x) { 27142b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 27152b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 27162b474a1aSAndy Whitcroft } else { 27172b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 27180a920b5bSAndy Whitcroft } 27190a920b5bSAndy Whitcroft } 27202b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 27212b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 27222b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 27232b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 27242b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 27252b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 27262b474a1aSAndy Whitcroft } 27272b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 27282b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2729000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2730000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 27312b474a1aSAndy Whitcroft } 27320a920b5bSAndy Whitcroft 27335150bda4SJoe Eloff# check for global initialisers. 2734d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2735d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2736000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2737d5e616fcSJoe Perches $herecurr) && 2738d5e616fcSJoe Perches $fix) { 2739d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2740d5e616fcSJoe Perches } 2741f0a594c1SAndy Whitcroft } 27420a920b5bSAndy Whitcroft# check for static initialisers. 2743d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2744d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2745000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2746d5e616fcSJoe Perches $herecurr) && 2747d5e616fcSJoe Perches $fix) { 2748d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2749d5e616fcSJoe Perches } 27500a920b5bSAndy Whitcroft } 27510a920b5bSAndy Whitcroft 2752cb710ecaSJoe Perches# check for static const char * arrays. 2753cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2754000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2755000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2756cb710ecaSJoe Perches $herecurr); 2757cb710ecaSJoe Perches } 2758cb710ecaSJoe Perches 2759cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2760cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2761000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2762000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2763cb710ecaSJoe Perches $herecurr); 2764cb710ecaSJoe Perches } 2765cb710ecaSJoe Perches 27669b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 27679b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 27689b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 27699b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 27709b0fa60dSJoe Perches $herecurr); 27719b0fa60dSJoe Perches } 27729b0fa60dSJoe Perches 2773b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 2774b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 2775b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 2776b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 2777b36190c5SJoe Perches $fix) { 2778b36190c5SJoe Perches $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 2779b36190c5SJoe Perches } 2780b36190c5SJoe Perches } 2781b36190c5SJoe Perches 278292e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 278392e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 278492e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 278592e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 278692e112fdSJoe Perches $fix) { 278792e112fdSJoe Perches $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 278892e112fdSJoe Perches } 278993ed0e2dSJoe Perches } 279093ed0e2dSJoe Perches 2791653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2792653d4876SAndy Whitcroft# make sense. 2793653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 27948054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2795c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 27968ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2797653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2798000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2799000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 28000a920b5bSAndy Whitcroft } 28010a920b5bSAndy Whitcroft 28020a920b5bSAndy Whitcroft# * goes on variable not on type 280365863862SAndy Whitcroft # (char*[ const]) 2804bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2805bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 28063705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2807d8aaf121SAndy Whitcroft 280865863862SAndy Whitcroft # Should start with a space. 280965863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 281065863862SAndy Whitcroft # Should not end with a space. 281165863862SAndy Whitcroft $to =~ s/\s+$//; 281265863862SAndy Whitcroft # '*'s should not have spaces between. 2813f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 281465863862SAndy Whitcroft } 2815d8aaf121SAndy Whitcroft 28163705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 281765863862SAndy Whitcroft if ($from ne $to) { 28183705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28193705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 28203705ce5bSJoe Perches $fix) { 28213705ce5bSJoe Perches my $sub_from = $ident; 28223705ce5bSJoe Perches my $sub_to = $ident; 28233705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28243705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28253705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28263705ce5bSJoe Perches } 282765863862SAndy Whitcroft } 2828bfcb2cc7SAndy Whitcroft } 2829bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2830bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 28313705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2832d8aaf121SAndy Whitcroft 283365863862SAndy Whitcroft # Should start with a space. 283465863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 283565863862SAndy Whitcroft # Should not end with a space. 283665863862SAndy Whitcroft $to =~ s/\s+$//; 283765863862SAndy Whitcroft # '*'s should not have spaces between. 2838f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 283965863862SAndy Whitcroft } 284065863862SAndy Whitcroft # Modifiers should have spaces. 284165863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 284265863862SAndy Whitcroft 28433705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2844667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 28453705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28463705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 28473705ce5bSJoe Perches $fix) { 28483705ce5bSJoe Perches 28493705ce5bSJoe Perches my $sub_from = $match; 28503705ce5bSJoe Perches my $sub_to = $match; 28513705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28523705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28533705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28543705ce5bSJoe Perches } 285565863862SAndy Whitcroft } 28560a920b5bSAndy Whitcroft } 28570a920b5bSAndy Whitcroft 28580a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 28590a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 28600a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 28610a920b5bSAndy Whitcroft# print "$herecurr"; 28620a920b5bSAndy Whitcroft# $clean = 0; 28630a920b5bSAndy Whitcroft# } 28640a920b5bSAndy Whitcroft 28658905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2866000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2867000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 28688905a67cSAndy Whitcroft } 28698905a67cSAndy Whitcroft 287017441227SJoe Perches# check for uses of printk_ratelimit 287117441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2872000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2873000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 287417441227SJoe Perches } 287517441227SJoe Perches 287600df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 287700df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 287800df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 287925985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 288000df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2881f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 288200df344fSAndy Whitcroft my $ok = 0; 288300df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 288400df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 288525985edcSLucas De Marchi # we have a preceding printk if it ends 288600df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 288700df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 288800df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 288900df344fSAndy Whitcroft $ok = 1; 289000df344fSAndy Whitcroft } 289100df344fSAndy Whitcroft last; 289200df344fSAndy Whitcroft } 289300df344fSAndy Whitcroft } 289400df344fSAndy Whitcroft if ($ok == 0) { 2895000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2896000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 28970a920b5bSAndy Whitcroft } 289800df344fSAndy Whitcroft } 28990a920b5bSAndy Whitcroft 2900243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2901243f3803SJoe Perches my $orig = $1; 2902243f3803SJoe Perches my $level = lc($orig); 2903243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 29048f26b837SJoe Perches my $level2 = $level; 29058f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2906243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2907daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2908243f3803SJoe Perches } 2909243f3803SJoe Perches 2910243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2911d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2912d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2913d5e616fcSJoe Perches $fix) { 2914d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2915d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2916d5e616fcSJoe Perches } 2917243f3803SJoe Perches } 2918243f3803SJoe Perches 2919dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2920dc139313SJoe Perches my $orig = $1; 2921dc139313SJoe Perches my $level = lc($orig); 2922dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2923dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2924dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2925dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2926dc139313SJoe Perches } 2927dc139313SJoe Perches 2928653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2929653d4876SAndy Whitcroft# or if closed on same line 2930c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2931c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2932000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2933000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 29340a920b5bSAndy Whitcroft } 2935653d4876SAndy Whitcroft 29368905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 29378905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 29388905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2939000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2940000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 29418905a67cSAndy Whitcroft } 29428905a67cSAndy Whitcroft 29430c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 29443705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 29453705ce5bSJoe Perches if (WARN("SPACING", 29463705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 29473705ce5bSJoe Perches $fix) { 29483705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29493705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 29503705ce5bSJoe Perches } 29510c73b4ebSAndy Whitcroft } 29520c73b4ebSAndy Whitcroft 295331070b5dSJoe Perches# Function pointer declarations 295431070b5dSJoe Perches# check spacing between type, funcptr, and args 295531070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 295691f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 295731070b5dSJoe Perches my $declare = $1; 295831070b5dSJoe Perches my $pre_pointer_space = $2; 295931070b5dSJoe Perches my $post_pointer_space = $3; 296031070b5dSJoe Perches my $funcname = $4; 296131070b5dSJoe Perches my $post_funcname_space = $5; 296231070b5dSJoe Perches my $pre_args_space = $6; 296331070b5dSJoe Perches 296491f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 296591f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 296691f72e9cSJoe Perches# don't need a space so don't warn for those. 296791f72e9cSJoe Perches my $post_declare_space = ""; 296891f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 296991f72e9cSJoe Perches $post_declare_space = $1; 297091f72e9cSJoe Perches $declare = rtrim($declare); 297191f72e9cSJoe Perches } 297291f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 297331070b5dSJoe Perches WARN("SPACING", 297431070b5dSJoe Perches "missing space after return type\n" . $herecurr); 297591f72e9cSJoe Perches $post_declare_space = " "; 297631070b5dSJoe Perches } 297731070b5dSJoe Perches 297831070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 297991f72e9cSJoe Perches# This test is not currently implemented because these declarations are 298091f72e9cSJoe Perches# equivalent to 298191f72e9cSJoe Perches# int foo(int bar, ...) 298291f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 298391f72e9cSJoe Perches# 298491f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 298591f72e9cSJoe Perches# WARN("SPACING", 298691f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 298791f72e9cSJoe Perches# } 298831070b5dSJoe Perches 298931070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 299031070b5dSJoe Perches if (defined $pre_pointer_space && 299131070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 299231070b5dSJoe Perches WARN("SPACING", 299331070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 299431070b5dSJoe Perches } 299531070b5dSJoe Perches 299631070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 299731070b5dSJoe Perches if (defined $post_pointer_space && 299831070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 299931070b5dSJoe Perches WARN("SPACING", 300031070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 300131070b5dSJoe Perches } 300231070b5dSJoe Perches 300331070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 300431070b5dSJoe Perches if (defined $post_funcname_space && 300531070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 300631070b5dSJoe Perches WARN("SPACING", 300731070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 300831070b5dSJoe Perches } 300931070b5dSJoe Perches 301031070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 301131070b5dSJoe Perches if (defined $pre_args_space && 301231070b5dSJoe Perches $pre_args_space =~ /^\s/) { 301331070b5dSJoe Perches WARN("SPACING", 301431070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 301531070b5dSJoe Perches } 301631070b5dSJoe Perches 301731070b5dSJoe Perches if (show_type("SPACING") && $fix) { 301831070b5dSJoe Perches $fixed[$linenr - 1] =~ 301991f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 302031070b5dSJoe Perches } 302131070b5dSJoe Perches } 302231070b5dSJoe Perches 30238d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 30248d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3025fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3026fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 30278d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 30288d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 30298d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3030fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3031daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 30323705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 30333705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 30343705ce5bSJoe Perches $fix) { 30353705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30363705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 30373705ce5bSJoe Perches } 30388d31cfceSAndy Whitcroft } 30398d31cfceSAndy Whitcroft } 30408d31cfceSAndy Whitcroft 3041f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 30426c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3043c2fdda0dSAndy Whitcroft my $name = $1; 3044773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3045773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3046c2fdda0dSAndy Whitcroft 3047c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3048773647a0SAndy Whitcroft if ($name =~ /^(?: 3049773647a0SAndy Whitcroft if|for|while|switch|return|case| 3050773647a0SAndy Whitcroft volatile|__volatile__| 3051773647a0SAndy Whitcroft __attribute__|format|__extension__| 3052773647a0SAndy Whitcroft asm|__asm__)$/x) 3053773647a0SAndy Whitcroft { 3054c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3055c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3056c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3057c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3058773647a0SAndy Whitcroft 3059773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3060c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3061c2fdda0dSAndy Whitcroft 3062c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3063c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3064773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3065c2fdda0dSAndy Whitcroft 3066c2fdda0dSAndy Whitcroft } else { 30673705ce5bSJoe Perches if (WARN("SPACING", 30683705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 30693705ce5bSJoe Perches $fix) { 30703705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30713705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 30723705ce5bSJoe Perches } 3073f0a594c1SAndy Whitcroft } 30746c72ffaaSAndy Whitcroft } 30759a4cad4eSEric Nelson 3076653d4876SAndy Whitcroft# Check operator spacing. 30770a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 30783705ce5bSJoe Perches my $fixed_line = ""; 30793705ce5bSJoe Perches my $line_fixed = 0; 30803705ce5bSJoe Perches 30819c0ca6f9SAndy Whitcroft my $ops = qr{ 30829c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 30839c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 30849c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 30851f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 308684731623SJoe Perches \?:|\?|: 30879c0ca6f9SAndy Whitcroft }x; 3088cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 30893705ce5bSJoe Perches 30903705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 30913705ce5bSJoe Perches## foreach my $el (@elements) { 30923705ce5bSJoe Perches## print("el: <$el>\n"); 30933705ce5bSJoe Perches## } 30943705ce5bSJoe Perches 30953705ce5bSJoe Perches my @fix_elements = (); 309600df344fSAndy Whitcroft my $off = 0; 30976c72ffaaSAndy Whitcroft 30983705ce5bSJoe Perches foreach my $el (@elements) { 30993705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 31003705ce5bSJoe Perches $off += length($el); 31013705ce5bSJoe Perches } 31023705ce5bSJoe Perches 31033705ce5bSJoe Perches $off = 0; 31043705ce5bSJoe Perches 31056c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3106b34c648bSJoe Perches my $last_after = -1; 31076c72ffaaSAndy Whitcroft 31080a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 31093705ce5bSJoe Perches 31103705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 31113705ce5bSJoe Perches 31123705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 31133705ce5bSJoe Perches 31144a0df2efSAndy Whitcroft $off += length($elements[$n]); 31154a0df2efSAndy Whitcroft 311625985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3117773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3118773647a0SAndy Whitcroft my $cc = ''; 3119773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3120773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3121773647a0SAndy Whitcroft } 3122773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3123773647a0SAndy Whitcroft 31244a0df2efSAndy Whitcroft my $a = ''; 31254a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 31264a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3127cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 31284a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 31294a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3130773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 31314a0df2efSAndy Whitcroft 31320a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 31334a0df2efSAndy Whitcroft 31344a0df2efSAndy Whitcroft my $c = ''; 31350a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 31364a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 31374a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3138cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 31394a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 31404a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 31418b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 31424a0df2efSAndy Whitcroft } else { 31434a0df2efSAndy Whitcroft $c = 'E'; 31440a920b5bSAndy Whitcroft } 31450a920b5bSAndy Whitcroft 31464a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 31474a0df2efSAndy Whitcroft 31484a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 31494a0df2efSAndy Whitcroft 31506c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3151de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 31520a920b5bSAndy Whitcroft 315374048ed8SAndy Whitcroft # Pull out the value of this operator. 31546c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 31550a920b5bSAndy Whitcroft 31561f65f947SAndy Whitcroft # Get the full operator variant. 31571f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 31581f65f947SAndy Whitcroft 315913214adfSAndy Whitcroft # Ignore operators passed as parameters. 316013214adfSAndy Whitcroft if ($op_type ne 'V' && 316113214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 316213214adfSAndy Whitcroft 3163cf655043SAndy Whitcroft# # Ignore comments 3164cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 316513214adfSAndy Whitcroft 3166d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 316713214adfSAndy Whitcroft } elsif ($op eq ';') { 3168cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3169cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 31703705ce5bSJoe Perches if (ERROR("SPACING", 31713705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3172b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31733705ce5bSJoe Perches $line_fixed = 1; 31743705ce5bSJoe Perches } 3175d8aaf121SAndy Whitcroft } 3176d8aaf121SAndy Whitcroft 3177d8aaf121SAndy Whitcroft # // is a comment 3178d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 31790a920b5bSAndy Whitcroft 3180b00e4814SJoe Perches # : when part of a bitfield 3181b00e4814SJoe Perches } elsif ($opv eq ':B') { 3182b00e4814SJoe Perches # skip the bitfield test for now 3183b00e4814SJoe Perches 31841f65f947SAndy Whitcroft # No spaces for: 31851f65f947SAndy Whitcroft # -> 3186b00e4814SJoe Perches } elsif ($op eq '->') { 31874a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 31883705ce5bSJoe Perches if (ERROR("SPACING", 31893705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3190b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 31913705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31923705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 31933705ce5bSJoe Perches } 3194b34c648bSJoe Perches $line_fixed = 1; 31953705ce5bSJoe Perches } 31960a920b5bSAndy Whitcroft } 31970a920b5bSAndy Whitcroft 31980a920b5bSAndy Whitcroft # , must have a space on the right. 31990a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3200cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 32013705ce5bSJoe Perches if (ERROR("SPACING", 32023705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3203b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32043705ce5bSJoe Perches $line_fixed = 1; 3205b34c648bSJoe Perches $last_after = $n; 32063705ce5bSJoe Perches } 32070a920b5bSAndy Whitcroft } 32080a920b5bSAndy Whitcroft 32099c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 321074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 32119c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 32129c0ca6f9SAndy Whitcroft 32139c0ca6f9SAndy Whitcroft # unary operators should have a space before and 32149c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 32159c0ca6f9SAndy Whitcroft # unary operator, or a cast 32169c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 321774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 32180d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3219cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 32203705ce5bSJoe Perches if (ERROR("SPACING", 32213705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3222b34c648bSJoe Perches if ($n != $last_after + 2) { 3223b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 32243705ce5bSJoe Perches $line_fixed = 1; 32253705ce5bSJoe Perches } 32260a920b5bSAndy Whitcroft } 3227b34c648bSJoe Perches } 3228a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3229171ae1a4SAndy Whitcroft # A unary '*' may be const 3230171ae1a4SAndy Whitcroft 3231171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 32323705ce5bSJoe Perches if (ERROR("SPACING", 32333705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3234b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 32353705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32363705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 32373705ce5bSJoe Perches } 3238b34c648bSJoe Perches $line_fixed = 1; 32393705ce5bSJoe Perches } 32400a920b5bSAndy Whitcroft } 32410a920b5bSAndy Whitcroft 32420a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 32430a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3244773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 32453705ce5bSJoe Perches if (ERROR("SPACING", 32463705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3247b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32483705ce5bSJoe Perches $line_fixed = 1; 32493705ce5bSJoe Perches } 32500a920b5bSAndy Whitcroft } 3251773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3252773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 32533705ce5bSJoe Perches if (ERROR("SPACING", 32543705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3255b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32563705ce5bSJoe Perches $line_fixed = 1; 32573705ce5bSJoe Perches } 3258653d4876SAndy Whitcroft } 3259773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 32603705ce5bSJoe Perches if (ERROR("SPACING", 32613705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3262b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 32633705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32643705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3265773647a0SAndy Whitcroft } 3266b34c648bSJoe Perches $line_fixed = 1; 32673705ce5bSJoe Perches } 32683705ce5bSJoe Perches } 32690a920b5bSAndy Whitcroft 32700a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 32719c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 32729c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 32739c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3274c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3275c2fdda0dSAndy Whitcroft $op eq '%') 32760a920b5bSAndy Whitcroft { 3277773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 32783705ce5bSJoe Perches if (ERROR("SPACING", 32793705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3280b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3281b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3282b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3283b34c648bSJoe Perches } 32843705ce5bSJoe Perches $line_fixed = 1; 32853705ce5bSJoe Perches } 32860a920b5bSAndy Whitcroft } 32870a920b5bSAndy Whitcroft 32881f65f947SAndy Whitcroft # A colon needs no spaces before when it is 32891f65f947SAndy Whitcroft # terminating a case value or a label. 32901f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 32911f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 32923705ce5bSJoe Perches if (ERROR("SPACING", 32933705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3294b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32953705ce5bSJoe Perches $line_fixed = 1; 32963705ce5bSJoe Perches } 32971f65f947SAndy Whitcroft } 32981f65f947SAndy Whitcroft 32990a920b5bSAndy Whitcroft # All the others need spaces both sides. 3300cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 33011f65f947SAndy Whitcroft my $ok = 0; 33021f65f947SAndy Whitcroft 330322f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 33041f65f947SAndy Whitcroft if (($op eq '<' && 33051f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 33061f65f947SAndy Whitcroft ($op eq '>' && 33071f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 33081f65f947SAndy Whitcroft { 33091f65f947SAndy Whitcroft $ok = 1; 33101f65f947SAndy Whitcroft } 33111f65f947SAndy Whitcroft 331284731623SJoe Perches # messages are ERROR, but ?: are CHK 33131f65f947SAndy Whitcroft if ($ok == 0) { 331484731623SJoe Perches my $msg_type = \&ERROR; 331584731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 331684731623SJoe Perches 331784731623SJoe Perches if (&{$msg_type}("SPACING", 33183705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3319b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3320b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3321b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3322b34c648bSJoe Perches } 33233705ce5bSJoe Perches $line_fixed = 1; 33243705ce5bSJoe Perches } 33250a920b5bSAndy Whitcroft } 332622f2a2efSAndy Whitcroft } 33274a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 33283705ce5bSJoe Perches 33293705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 33303705ce5bSJoe Perches 33313705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 33320a920b5bSAndy Whitcroft } 33333705ce5bSJoe Perches 33343705ce5bSJoe Perches if (($#elements % 2) == 0) { 33353705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 33363705ce5bSJoe Perches } 33373705ce5bSJoe Perches 33383705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 33393705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 33403705ce5bSJoe Perches } 33413705ce5bSJoe Perches 33423705ce5bSJoe Perches 33430a920b5bSAndy Whitcroft } 33440a920b5bSAndy Whitcroft 3345786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3346d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3347786b6326SJoe Perches if (WARN("SPACING", 3348786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3349786b6326SJoe Perches $fix) { 3350786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3351786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3352786b6326SJoe Perches } 3353786b6326SJoe Perches } 3354786b6326SJoe Perches 3355f0a594c1SAndy Whitcroft# check for multiple assignments 3356f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3357000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3358000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3359f0a594c1SAndy Whitcroft } 3360f0a594c1SAndy Whitcroft 336122f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 336222f2a2efSAndy Whitcroft## # continuation. 336322f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 336422f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 336522f2a2efSAndy Whitcroft## 336622f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 336722f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 336822f2a2efSAndy Whitcroft## my $ln = $line; 336922f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 337022f2a2efSAndy Whitcroft## } 337122f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3372000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3373000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 337422f2a2efSAndy Whitcroft## } 337522f2a2efSAndy Whitcroft## } 3376f0a594c1SAndy Whitcroft 33770a920b5bSAndy Whitcroft#need space before brace following if, while, etc 337822f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 337922f2a2efSAndy Whitcroft $line =~ /do{/) { 33803705ce5bSJoe Perches if (ERROR("SPACING", 33813705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 33823705ce5bSJoe Perches $fix) { 3383d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 33843705ce5bSJoe Perches } 3385de7d4f0eSAndy Whitcroft } 3386de7d4f0eSAndy Whitcroft 3387c4a62ef9SJoe Perches## # check for blank lines before declarations 3388c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3389c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3390c4a62ef9SJoe Perches## WARN("SPACING", 3391c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3392c4a62ef9SJoe Perches## } 3393c4a62ef9SJoe Perches## 3394c4a62ef9SJoe Perches 3395de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3396de7d4f0eSAndy Whitcroft# on the line 3397de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3398d5e616fcSJoe Perches if (ERROR("SPACING", 3399d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3400d5e616fcSJoe Perches $fix) { 3401d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3402d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3403d5e616fcSJoe Perches } 34040a920b5bSAndy Whitcroft } 34050a920b5bSAndy Whitcroft 340622f2a2efSAndy Whitcroft# check spacing on square brackets 340722f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 34083705ce5bSJoe Perches if (ERROR("SPACING", 34093705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 34103705ce5bSJoe Perches $fix) { 34113705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34123705ce5bSJoe Perches s/\[\s+/\[/; 34133705ce5bSJoe Perches } 341422f2a2efSAndy Whitcroft } 341522f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 34163705ce5bSJoe Perches if (ERROR("SPACING", 34173705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 34183705ce5bSJoe Perches $fix) { 34193705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34203705ce5bSJoe Perches s/\s+\]/\]/; 34213705ce5bSJoe Perches } 342222f2a2efSAndy Whitcroft } 342322f2a2efSAndy Whitcroft 3424c45dcabdSAndy Whitcroft# check spacing on parentheses 34259c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 34269c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 34273705ce5bSJoe Perches if (ERROR("SPACING", 34283705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 34293705ce5bSJoe Perches $fix) { 34303705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34313705ce5bSJoe Perches s/\(\s+/\(/; 34323705ce5bSJoe Perches } 343322f2a2efSAndy Whitcroft } 343413214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3435c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3436c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 34373705ce5bSJoe Perches if (ERROR("SPACING", 34383705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 34393705ce5bSJoe Perches $fix) { 34403705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34413705ce5bSJoe Perches s/\s+\)/\)/; 34423705ce5bSJoe Perches } 344322f2a2efSAndy Whitcroft } 344422f2a2efSAndy Whitcroft 34450a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 34464a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 34470a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 34483705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 34493705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 34503705ce5bSJoe Perches $fix) { 34513705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34523705ce5bSJoe Perches s/^(.)\s+/$1/; 34533705ce5bSJoe Perches } 34540a920b5bSAndy Whitcroft } 34550a920b5bSAndy Whitcroft 34565b9553abSJoe Perches# return is not a function 3457507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3458c45dcabdSAndy Whitcroft my $spacing = $1; 3459507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 34605b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 34615b9553abSJoe Perches my $value = $1; 34625b9553abSJoe Perches $value = deparenthesize($value); 34635b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3464000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3465000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 34665b9553abSJoe Perches } 3467c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3468000d1cc1SJoe Perches ERROR("SPACING", 3469000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3470c45dcabdSAndy Whitcroft } 3471c45dcabdSAndy Whitcroft } 3472507e5141SJoe Perches 3473189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3474189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3475189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3476189248d8SJoe Perches my $openparens = $1; 3477189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3478189248d8SJoe Perches my $msg = ""; 3479189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3480189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3481189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3482189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3483189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3484189248d8SJoe Perches } 3485189248d8SJoe Perches } 3486189248d8SJoe Perches 348753a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 348853a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 348953a3c448SAndy Whitcroft my $name = $1; 349053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3491000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3492000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 349353a3c448SAndy Whitcroft } 349453a3c448SAndy Whitcroft } 3495c45dcabdSAndy Whitcroft 34960a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 34974a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 34983705ce5bSJoe Perches if (ERROR("SPACING", 34993705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 35003705ce5bSJoe Perches $fix) { 35013705ce5bSJoe Perches $fixed[$linenr - 1] =~ 35023705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 35033705ce5bSJoe Perches } 35040a920b5bSAndy Whitcroft } 35050a920b5bSAndy Whitcroft 3506f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3507f5fe35ddSAndy Whitcroft# statements after the conditional. 3508170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 35093e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35103e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35113e469cdcSAndy Whitcroft if (!defined $stat); 3512170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3513170d3a22SAndy Whitcroft $remain_next, $off_next); 3514170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3515170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3516170d3a22SAndy Whitcroft 3517170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3518170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3519170d3a22SAndy Whitcroft # then count those as offsets. 3520170d3a22SAndy Whitcroft my ($whitespace) = 3521170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3522170d3a22SAndy Whitcroft my $offset = 3523170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3524170d3a22SAndy Whitcroft 3525170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3526170d3a22SAndy Whitcroft $offset} = 1; 3527170d3a22SAndy Whitcroft } 3528170d3a22SAndy Whitcroft } 3529170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3530c11230f4SJoe Perches defined($stat) && defined($cond) && 3531170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3532171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 35338905a67cSAndy Whitcroft 3534b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3535000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3536000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 35378905a67cSAndy Whitcroft } 35388905a67cSAndy Whitcroft 35398905a67cSAndy Whitcroft # Find out what is on the end of the line after the 35408905a67cSAndy Whitcroft # conditional. 3541773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 35428905a67cSAndy Whitcroft $s =~ s/\n.*//g; 354313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 354453210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 354553210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3546773647a0SAndy Whitcroft { 3547bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3548bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3549bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 355042bdf74cSHidetoshi Seto my $stat_real = ''; 3551bb44ad39SAndy Whitcroft 355242bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 355342bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3554bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3555bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3556bb44ad39SAndy Whitcroft } 3557bb44ad39SAndy Whitcroft 3558000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3559000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 35608905a67cSAndy Whitcroft } 35618905a67cSAndy Whitcroft } 35628905a67cSAndy Whitcroft 356313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 356413214adfSAndy Whitcroft if ($line =~ / 356513214adfSAndy Whitcroft (?: 356613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 356713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 356813214adfSAndy Whitcroft (?:\&\&|\|\|) 356913214adfSAndy Whitcroft | 357013214adfSAndy Whitcroft (?:\&\&|\|\|) 357113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 357213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 357313214adfSAndy Whitcroft )/x) 357413214adfSAndy Whitcroft { 3575000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3576000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 357713214adfSAndy Whitcroft } 357813214adfSAndy Whitcroft 35798905a67cSAndy Whitcroft# if and else should not have general statements after it 358013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 358113214adfSAndy Whitcroft my $s = $1; 358213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 358313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3584000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3585000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 35860a920b5bSAndy Whitcroft } 358713214adfSAndy Whitcroft } 358839667782SAndy Whitcroft# if should not continue a brace 358939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3590000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3591000d1cc1SJoe Perches "trailing statements should be on next line\n" . 359239667782SAndy Whitcroft $herecurr); 359339667782SAndy Whitcroft } 3594a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3595a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3596a1080bf8SAndy Whitcroft $line !~ /\G(?: 35973fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3598a1080bf8SAndy Whitcroft \s*return\s+ 3599a1080bf8SAndy Whitcroft )/xg) 3600a1080bf8SAndy Whitcroft { 3601000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3602000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3603a1080bf8SAndy Whitcroft } 36040a920b5bSAndy Whitcroft 36050a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 36060a920b5bSAndy Whitcroft # indent level to be relevant to each other. 36070a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 36080a920b5bSAndy Whitcroft $previndent == $indent) { 3609000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3610000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 36110a920b5bSAndy Whitcroft } 36120a920b5bSAndy Whitcroft 3613c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3614c2fdda0dSAndy Whitcroft $previndent == $indent) { 3615c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3616c2fdda0dSAndy Whitcroft 3617c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3618c2fdda0dSAndy Whitcroft # conditional. 3619773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3620c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3621c2fdda0dSAndy Whitcroft 3622c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3623000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3624000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3625c2fdda0dSAndy Whitcroft } 3626c2fdda0dSAndy Whitcroft } 3627c2fdda0dSAndy Whitcroft 362895e2c602SJoe Perches#Specific variable tests 3629323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3630323c1260SJoe Perches my $var = $1; 363195e2c602SJoe Perches 363295e2c602SJoe Perches#gcc binary extension 363395e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3634d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3635d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3636d5e616fcSJoe Perches $fix) { 3637d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3638d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3639d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3640d5e616fcSJoe Perches } 364195e2c602SJoe Perches } 364295e2c602SJoe Perches 364395e2c602SJoe Perches#CamelCase 3644807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3645be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 364622735ce8SJoe Perches#Ignore Page<foo> variants 3647807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 364822735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 36493445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 36507e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 36517e781f67SJoe Perches my $word = $1; 36527e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3653d8b07710SJoe Perches if ($check) { 3654d8b07710SJoe Perches seed_camelcase_includes(); 3655d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3656d8b07710SJoe Perches seed_camelcase_file($realfile); 3657d8b07710SJoe Perches $camelcase_file_seeded = 1; 3658d8b07710SJoe Perches } 3659d8b07710SJoe Perches } 36607e781f67SJoe Perches if (!defined $camelcase{$word}) { 36617e781f67SJoe Perches $camelcase{$word} = 1; 3662be79794bSJoe Perches CHK("CAMELCASE", 36637e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 36647e781f67SJoe Perches } 3665323c1260SJoe Perches } 3666323c1260SJoe Perches } 36673445686aSJoe Perches } 36680a920b5bSAndy Whitcroft 36690a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3670d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3671d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3672d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3673d5e616fcSJoe Perches $fix) { 3674d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3675d5e616fcSJoe Perches } 36760a920b5bSAndy Whitcroft } 36770a920b5bSAndy Whitcroft 3678653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3679c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3680e09dec48SAndy Whitcroft my $file = "$1.h"; 3681e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3682e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3683e09dec48SAndy Whitcroft $realfile ne $checkfile && 36847840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3685c45dcabdSAndy Whitcroft { 3686e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3687000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3688000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3689e09dec48SAndy Whitcroft } else { 3690000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3691000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3692e09dec48SAndy Whitcroft } 36930a920b5bSAndy Whitcroft } 36940a920b5bSAndy Whitcroft } 36950a920b5bSAndy Whitcroft 3696653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3697653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3698cf655043SAndy Whitcroft# in a known good container 3699b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3700b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3701d8aaf121SAndy Whitcroft my $ln = $linenr; 3702d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3703c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3704c45dcabdSAndy Whitcroft my $ctx = ''; 3705c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3706f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3707f74bd194SAndy Whitcroft $ctx = $dstat; 3708c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3709a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3710c45dcabdSAndy Whitcroft 3711f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3712292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3713c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3714c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3715c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3716c45dcabdSAndy Whitcroft 3717c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3718bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3719bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3720c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3721bf30d6edSAndy Whitcroft { 3722c45dcabdSAndy Whitcroft } 3723c45dcabdSAndy Whitcroft 3724e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3725e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3726e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3727e45bab8eSAndy Whitcroft { 3728e45bab8eSAndy Whitcroft } 3729e45bab8eSAndy Whitcroft 3730c45dcabdSAndy Whitcroft my $exceptions = qr{ 3731c45dcabdSAndy Whitcroft $Declare| 3732c45dcabdSAndy Whitcroft module_param_named| 3733a0a0a7a9SKees Cook MODULE_PARM_DESC| 3734c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3735c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3736383099fdSAndy Whitcroft __typeof__\(| 373722fd2d3eSStefani Seibold union| 373822fd2d3eSStefani Seibold struct| 3739ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3740ea71a0a0SAndy Whitcroft ^\"|\"$ 3741c45dcabdSAndy Whitcroft }x; 37425eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3743f74bd194SAndy Whitcroft if ($dstat ne '' && 3744f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3745f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 37463cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3747b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3748f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3749f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3750e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 375172f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3752f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3753f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3754f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3755f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3756f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3757c45dcabdSAndy Whitcroft { 3758f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3759f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3760f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3761f74bd194SAndy Whitcroft 3762f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3763f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3764c45dcabdSAndy Whitcroft } 3765c45dcabdSAndy Whitcroft 3766f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3767f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3768f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3769f74bd194SAndy Whitcroft } else { 3770000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3771f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3772d8aaf121SAndy Whitcroft } 37730a920b5bSAndy Whitcroft } 37745023d347SJoe Perches 3775481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 37765023d347SJoe Perches 37775023d347SJoe Perches } else { 37785023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3779481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3780481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 37815023d347SJoe Perches $line =~ /^\+.*\\$/) { 37825023d347SJoe Perches WARN("LINE_CONTINUATIONS", 37835023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 37845023d347SJoe Perches } 3785653d4876SAndy Whitcroft } 37860a920b5bSAndy Whitcroft 3787b13edf7fSJoe Perches# do {} while (0) macro tests: 3788b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3789b13edf7fSJoe Perches# macro should not end with a semicolon 3790b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3791b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3792b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3793b13edf7fSJoe Perches my $ln = $linenr; 3794b13edf7fSJoe Perches my $cnt = $realcnt; 3795b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3796b13edf7fSJoe Perches my $ctx = ''; 3797b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3798b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3799b13edf7fSJoe Perches $ctx = $dstat; 3800b13edf7fSJoe Perches 3801b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3802b13edf7fSJoe Perches 3803b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3804b13edf7fSJoe Perches my $stmts = $2; 3805b13edf7fSJoe Perches my $semis = $3; 3806b13edf7fSJoe Perches 3807b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3808b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3809b13edf7fSJoe Perches my $herectx = $here . "\n"; 3810b13edf7fSJoe Perches 3811b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3812b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3813b13edf7fSJoe Perches } 3814b13edf7fSJoe Perches 3815ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3816ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3817b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3818b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3819b13edf7fSJoe Perches } 3820b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3821b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3822b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3823b13edf7fSJoe Perches } 3824b13edf7fSJoe Perches } 3825b13edf7fSJoe Perches } 3826b13edf7fSJoe Perches 3827080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3828080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3829080ba929SMike Frysinger# . 3830080ba929SMike Frysinger# ALIGN(...) 3831080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3832080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3833000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3834000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3835080ba929SMike Frysinger } 3836080ba929SMike Frysinger 3837f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 383813214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 383913214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3840cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 384113214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3842cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3843cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3844aad4f614SJoe Perches my @allowed = (); 3845aad4f614SJoe Perches my $allow = 0; 384613214adfSAndy Whitcroft my $seen = 0; 3847773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3848cf655043SAndy Whitcroft my $ln = $linenr - 1; 384913214adfSAndy Whitcroft for my $chunk (@chunks) { 385013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 385113214adfSAndy Whitcroft 3852773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3853773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3854773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3855773647a0SAndy Whitcroft 3856aad4f614SJoe Perches $allowed[$allow] = 0; 3857773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3858773647a0SAndy Whitcroft 3859773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3860773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3861773647a0SAndy Whitcroft 3862773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3863cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3864cf655043SAndy Whitcroft 3865773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 386613214adfSAndy Whitcroft 386713214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 386813214adfSAndy Whitcroft 3869aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3870cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3871cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3872aad4f614SJoe Perches $allowed[$allow] = 1; 387313214adfSAndy Whitcroft } 387413214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3875cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3876aad4f614SJoe Perches $allowed[$allow] = 1; 387713214adfSAndy Whitcroft } 3878cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3879cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3880aad4f614SJoe Perches $allowed[$allow] = 1; 388113214adfSAndy Whitcroft } 3882aad4f614SJoe Perches $allow++; 388313214adfSAndy Whitcroft } 3884aad4f614SJoe Perches if ($seen) { 3885aad4f614SJoe Perches my $sum_allowed = 0; 3886aad4f614SJoe Perches foreach (@allowed) { 3887aad4f614SJoe Perches $sum_allowed += $_; 3888aad4f614SJoe Perches } 3889aad4f614SJoe Perches if ($sum_allowed == 0) { 3890000d1cc1SJoe Perches WARN("BRACES", 3891000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3892aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3893aad4f614SJoe Perches $seen != $allow) { 3894aad4f614SJoe Perches CHK("BRACES", 3895aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3896aad4f614SJoe Perches } 389713214adfSAndy Whitcroft } 389813214adfSAndy Whitcroft } 389913214adfSAndy Whitcroft } 3900773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 390113214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3902cf655043SAndy Whitcroft my $allowed = 0; 3903f0a594c1SAndy Whitcroft 3904cf655043SAndy Whitcroft # Check the pre-context. 3905cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3906cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3907cf655043SAndy Whitcroft $allowed = 1; 3908f0a594c1SAndy Whitcroft } 3909773647a0SAndy Whitcroft 3910773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3911773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3912773647a0SAndy Whitcroft 3913cf655043SAndy Whitcroft # Check the condition. 3914cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3915773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3916cf655043SAndy Whitcroft if (defined $cond) { 3917773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3918cf655043SAndy Whitcroft } 3919cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3920cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3921cf655043SAndy Whitcroft $allowed = 1; 3922cf655043SAndy Whitcroft } 3923cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3924cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3925cf655043SAndy Whitcroft $allowed = 1; 3926cf655043SAndy Whitcroft } 3927cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3928cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3929cf655043SAndy Whitcroft $allowed = 1; 3930cf655043SAndy Whitcroft } 3931cf655043SAndy Whitcroft # Check the post-context. 3932cf655043SAndy Whitcroft if (defined $chunks[1]) { 3933cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3934cf655043SAndy Whitcroft if (defined $cond) { 3935773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3936cf655043SAndy Whitcroft } 3937cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3938cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3939cf655043SAndy Whitcroft $allowed = 1; 3940cf655043SAndy Whitcroft } 3941cf655043SAndy Whitcroft } 3942cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 394369932487SJustin P. Mattock my $herectx = $here . "\n"; 3944f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3945cf655043SAndy Whitcroft 3946f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 394769932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3948cf655043SAndy Whitcroft } 3949cf655043SAndy Whitcroft 3950000d1cc1SJoe Perches WARN("BRACES", 3951000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3952f0a594c1SAndy Whitcroft } 3953f0a594c1SAndy Whitcroft } 3954f0a594c1SAndy Whitcroft 39550979ae66SJoe Perches# check for unnecessary blank lines around braces 395677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 39570979ae66SJoe Perches CHK("BRACES", 39580979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 39590979ae66SJoe Perches } 396077b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 39610979ae66SJoe Perches CHK("BRACES", 39620979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 39630979ae66SJoe Perches } 39640979ae66SJoe Perches 39654a0df2efSAndy Whitcroft# no volatiles please 39666c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 39676c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3968000d1cc1SJoe Perches WARN("VOLATILE", 3969000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 39704a0df2efSAndy Whitcroft } 39714a0df2efSAndy Whitcroft 397200df344fSAndy Whitcroft# warn about #if 0 3973c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3974000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3975000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3976de7d4f0eSAndy Whitcroft $herecurr); 39774a0df2efSAndy Whitcroft } 39784a0df2efSAndy Whitcroft 397903df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 398003df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 398103df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 398203df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 398303df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 398403df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 39854c432a8fSGreg Kroah-Hartman } 39864c432a8fSGreg Kroah-Hartman } 3987f0a594c1SAndy Whitcroft 39888716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 39898716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 39908716de38SJoe Perches my $attr = $1; 39918716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 39928716de38SJoe Perches my $ptr = $1; 39938716de38SJoe Perches my $var = $2; 39948716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 39958716de38SJoe Perches ERROR("MISPLACED_INIT", 39968716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 39978716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 39988716de38SJoe Perches WARN("MISPLACED_INIT", 39998716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 40008716de38SJoe Perches $fix) { 40018716de38SJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e; 40028716de38SJoe Perches } 40038716de38SJoe Perches } 40048716de38SJoe Perches } 40058716de38SJoe Perches 4006e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4007e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4008e970b884SJoe Perches my $attr = $1; 4009e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4010e970b884SJoe Perches my $attr_prefix = $1; 4011e970b884SJoe Perches my $attr_type = $2; 4012e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4013e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4014e970b884SJoe Perches $fix) { 4015e970b884SJoe Perches $fixed[$linenr - 1] =~ 4016e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4017e970b884SJoe Perches } 4018e970b884SJoe Perches } 4019e970b884SJoe Perches 4020e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4021e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4022e970b884SJoe Perches my $attr = $1; 4023e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4024e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4025e970b884SJoe Perches $fix) { 4026e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 4027e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4028e970b884SJoe Perches $lead = rtrim($1); 4029e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4030e970b884SJoe Perches $lead = "${lead}const "; 4031e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 4032e970b884SJoe Perches } 4033e970b884SJoe Perches } 4034e970b884SJoe Perches 4035fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4036fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4037fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4038fbdb8138SJoe Perches my $constant_func = $1; 4039fbdb8138SJoe Perches my $func = $constant_func; 4040fbdb8138SJoe Perches $func =~ s/^__constant_//; 4041fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4042fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4043fbdb8138SJoe Perches $fix) { 4044fbdb8138SJoe Perches $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g; 4045fbdb8138SJoe Perches } 4046fbdb8138SJoe Perches } 4047fbdb8138SJoe Perches 40481a15a250SPatrick Pannuto# prefer usleep_range over udelay 404937581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 405043c1d77cSJoe Perches my $delay = $1; 40511a15a250SPatrick Pannuto # ignore udelay's < 10, however 405243c1d77cSJoe Perches if (! ($delay < 10) ) { 4053000d1cc1SJoe Perches CHK("USLEEP_RANGE", 405443c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 405543c1d77cSJoe Perches } 405643c1d77cSJoe Perches if ($delay > 2000) { 405743c1d77cSJoe Perches WARN("LONG_UDELAY", 405843c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 40591a15a250SPatrick Pannuto } 40601a15a250SPatrick Pannuto } 40611a15a250SPatrick Pannuto 406209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 406309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 406409ef8725SPatrick Pannuto if ($1 < 20) { 4065000d1cc1SJoe Perches WARN("MSLEEP", 406643c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 406709ef8725SPatrick Pannuto } 406809ef8725SPatrick Pannuto } 406909ef8725SPatrick Pannuto 407036ec1939SJoe Perches# check for comparisons of jiffies 407136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 407236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 407336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 407436ec1939SJoe Perches } 407536ec1939SJoe Perches 40769d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 40779d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 40789d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 40799d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 40809d7a34a5SJoe Perches } 40819d7a34a5SJoe Perches 408200df344fSAndy Whitcroft# warn about #ifdefs in C files 4083c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 408400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 408500df344fSAndy Whitcroft# print "$herecurr"; 408600df344fSAndy Whitcroft# $clean = 0; 408700df344fSAndy Whitcroft# } 408800df344fSAndy Whitcroft 408922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4090c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 40913705ce5bSJoe Perches if (ERROR("SPACING", 40923705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 40933705ce5bSJoe Perches $fix) { 40943705ce5bSJoe Perches $fixed[$linenr - 1] =~ 40953705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 40963705ce5bSJoe Perches } 40973705ce5bSJoe Perches 409822f2a2efSAndy Whitcroft } 409922f2a2efSAndy Whitcroft 41004a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4101171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4102171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 41034a0df2efSAndy Whitcroft my $which = $1; 41044a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4105000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4106000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 41074a0df2efSAndy Whitcroft } 41084a0df2efSAndy Whitcroft } 41094a0df2efSAndy Whitcroft# check for memory barriers without a comment. 41104a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 41114a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4112c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4113000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 41144a0df2efSAndy Whitcroft } 41154a0df2efSAndy Whitcroft } 41164a0df2efSAndy Whitcroft# check of hardware specific defines 4117c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4118000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4119000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 41200a920b5bSAndy Whitcroft } 4121653d4876SAndy Whitcroft 4122d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4123d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4124000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4125000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4126d4977c78STobias Klauser } 4127d4977c78STobias Klauser 4128de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4129de7d4f0eSAndy Whitcroft# storage class and type. 41309c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 41319c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4132000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4133000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4134de7d4f0eSAndy Whitcroft } 4135de7d4f0eSAndy Whitcroft 41368905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 41372b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41382b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4139d5e616fcSJoe Perches if (WARN("INLINE", 4140d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4141d5e616fcSJoe Perches $fix) { 4142d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 4143d5e616fcSJoe Perches 4144d5e616fcSJoe Perches } 41458905a67cSAndy Whitcroft } 41468905a67cSAndy Whitcroft 41473d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 41482b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41492b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4150000d1cc1SJoe Perches WARN("PREFER_PACKED", 4151000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 41523d130fd0SJoe Perches } 41533d130fd0SJoe Perches 415439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 41552b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41562b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4157000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4158000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 415939b7e287SJoe Perches } 416039b7e287SJoe Perches 41615f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 41622b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41632b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4164d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4165d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4166d5e616fcSJoe Perches $fix) { 4167d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4168d5e616fcSJoe Perches 4169d5e616fcSJoe Perches } 41705f14d3bdSJoe Perches } 41715f14d3bdSJoe Perches 41726061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 41732b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41742b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4175d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4176d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4177d5e616fcSJoe Perches $fix) { 4178d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4179d5e616fcSJoe Perches } 41806061d949SJoe Perches } 41816061d949SJoe Perches 41828f53a9b8SJoe Perches# check for sizeof(&) 41838f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4184000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4185000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 41868f53a9b8SJoe Perches } 41878f53a9b8SJoe Perches 418866c80b60SJoe Perches# check for sizeof without parenthesis 418966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4190d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4191d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4192d5e616fcSJoe Perches $fix) { 4193d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4194d5e616fcSJoe Perches } 419566c80b60SJoe Perches } 419666c80b60SJoe Perches 4197428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4198428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4199000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4200000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4201428e2fdcSJoe Perches } 4202428e2fdcSJoe Perches 420388982feaSJoe Perches# check for struct spinlock declarations 420488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 420588982feaSJoe Perches WARN("USE_SPINLOCK_T", 420688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 420788982feaSJoe Perches } 420888982feaSJoe Perches 4209a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 421006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4211a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 421206668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4213d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4214d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4215d5e616fcSJoe Perches $fix) { 4216d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 4217d5e616fcSJoe Perches } 4218a6962d72SJoe Perches } 4219a6962d72SJoe Perches } 4220a6962d72SJoe Perches 4221554e165cSAndy Whitcroft# Check for misused memsets 4222d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4223d1fe9c09SJoe Perches defined $stat && 4224d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4225554e165cSAndy Whitcroft 4226d7c76ba7SJoe Perches my $ms_addr = $2; 4227d1fe9c09SJoe Perches my $ms_val = $7; 4228d1fe9c09SJoe Perches my $ms_size = $12; 4229d7c76ba7SJoe Perches 4230554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4231554e165cSAndy Whitcroft ERROR("MEMSET", 4232d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4233554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4234554e165cSAndy Whitcroft WARN("MEMSET", 4235d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4236d7c76ba7SJoe Perches } 4237d7c76ba7SJoe Perches } 4238d7c76ba7SJoe Perches 423998a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 424098a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 424198a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 424298a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 424398a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 424498a9bba5SJoe Perches $fix) { 424598a9bba5SJoe Perches $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 424698a9bba5SJoe Perches } 424798a9bba5SJoe Perches } 424898a9bba5SJoe Perches 4249d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4250d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4251d1fe9c09SJoe Perches defined $stat && 4252d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4253d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4254d7c76ba7SJoe Perches my $call = $1; 4255d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4256d7c76ba7SJoe Perches my $arg1 = $3; 4257d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4258d1fe9c09SJoe Perches my $arg2 = $8; 4259d7c76ba7SJoe Perches my $cast; 4260d7c76ba7SJoe Perches 4261d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4262d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4263d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4264d7c76ba7SJoe Perches $cast = $cast1; 4265d7c76ba7SJoe Perches } else { 4266d7c76ba7SJoe Perches $cast = $cast2; 4267d7c76ba7SJoe Perches } 4268d7c76ba7SJoe Perches WARN("MINMAX", 4269d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4270554e165cSAndy Whitcroft } 4271554e165cSAndy Whitcroft } 4272554e165cSAndy Whitcroft 42734a273195SJoe Perches# check usleep_range arguments 42744a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 42754a273195SJoe Perches defined $stat && 42764a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 42774a273195SJoe Perches my $min = $1; 42784a273195SJoe Perches my $max = $7; 42794a273195SJoe Perches if ($min eq $max) { 42804a273195SJoe Perches WARN("USLEEP_RANGE", 42814a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 42824a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 42834a273195SJoe Perches $min > $max) { 42844a273195SJoe Perches WARN("USLEEP_RANGE", 42854a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 42864a273195SJoe Perches } 42874a273195SJoe Perches } 42884a273195SJoe Perches 4289823b794cSJoe Perches# check for naked sscanf 4290823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4291823b794cSJoe Perches defined $stat && 42926c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4293823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4294823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4295823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4296823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4297823b794cSJoe Perches $lc = $lc + $linenr; 4298823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4299823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4300823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4301823b794cSJoe Perches } 4302823b794cSJoe Perches WARN("NAKED_SSCANF", 4303823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4304823b794cSJoe Perches } 4305823b794cSJoe Perches 430670dc8a48SJoe Perches# check for new externs in .h files. 430770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 430870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4309d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 431070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 431170dc8a48SJoe Perches $fix) { 431270dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 431370dc8a48SJoe Perches } 431470dc8a48SJoe Perches } 431570dc8a48SJoe Perches 4316de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4317171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4318c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4319171ae1a4SAndy Whitcroft { 4320c45dcabdSAndy Whitcroft my $function_name = $1; 4321c45dcabdSAndy Whitcroft my $paren_space = $2; 4322171ae1a4SAndy Whitcroft 4323171ae1a4SAndy Whitcroft my $s = $stat; 4324171ae1a4SAndy Whitcroft if (defined $cond) { 4325171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4326171ae1a4SAndy Whitcroft } 4327c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4328c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4329c45dcabdSAndy Whitcroft { 4330000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4331000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4332de7d4f0eSAndy Whitcroft } 4333de7d4f0eSAndy Whitcroft 4334171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4335000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4336000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4337171ae1a4SAndy Whitcroft } 43389c9ba34eSAndy Whitcroft 43399c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 43409c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 43419c9ba34eSAndy Whitcroft { 4342000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4343000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4344171ae1a4SAndy Whitcroft } 4345171ae1a4SAndy Whitcroft 4346de7d4f0eSAndy Whitcroft# checks for new __setup's 4347de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4348de7d4f0eSAndy Whitcroft my $name = $1; 4349de7d4f0eSAndy Whitcroft 4350de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4351000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4352000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4353de7d4f0eSAndy Whitcroft } 4354653d4876SAndy Whitcroft } 43559c0ca6f9SAndy Whitcroft 43569c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4357caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4358000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4359000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 43609c0ca6f9SAndy Whitcroft } 436113214adfSAndy Whitcroft 4362a640d25cSJoe Perches# alloc style 4363a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4364a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4365a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4366a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4367a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4368a640d25cSJoe Perches } 4369a640d25cSJoe Perches 4370972fdea2SJoe Perches# check for krealloc arg reuse 4371972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4372972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4373972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4374972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4375972fdea2SJoe Perches } 4376972fdea2SJoe Perches 43775ce59ae0SJoe Perches# check for alloc argument mismatch 43785ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 43795ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 43805ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 43815ce59ae0SJoe Perches } 43825ce59ae0SJoe Perches 4383caf2a54fSJoe Perches# check for multiple semicolons 4384caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4385d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4386d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4387d5e616fcSJoe Perches $fix) { 4388d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4389d5e616fcSJoe Perches } 4390d1e2ad07SJoe Perches } 4391d1e2ad07SJoe Perches 4392c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4393c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4394c34c09a8SJoe Perches my $has_break = 0; 4395c34c09a8SJoe Perches my $has_statement = 0; 4396c34c09a8SJoe Perches my $count = 0; 4397c34c09a8SJoe Perches my $prevline = $linenr; 4398c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4399c34c09a8SJoe Perches $prevline--; 4400c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4401c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4402c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4403c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4404c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4405c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4406c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4407c34c09a8SJoe Perches $has_statement = 1; 4408c34c09a8SJoe Perches $count++; 4409c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4410c34c09a8SJoe Perches } 4411c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4412c34c09a8SJoe Perches WARN("MISSING_BREAK", 4413c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4414c34c09a8SJoe Perches } 4415c34c09a8SJoe Perches } 4416c34c09a8SJoe Perches 4417d1e2ad07SJoe Perches# check for switch/default statements without a break; 4418d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4419d1e2ad07SJoe Perches defined $stat && 4420d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4421d1e2ad07SJoe Perches my $ctx = ''; 4422d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4423d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4424d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4425d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4426d1e2ad07SJoe Perches } 4427d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4428d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4429caf2a54fSJoe Perches } 4430caf2a54fSJoe Perches 443113214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4432d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4433d5e616fcSJoe Perches if (WARN("USE_FUNC", 4434d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4435d5e616fcSJoe Perches $fix) { 4436d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4437d5e616fcSJoe Perches } 443813214adfSAndy Whitcroft } 4439773647a0SAndy Whitcroft 44402c92488aSJoe Perches# check for use of yield() 44412c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 44422c92488aSJoe Perches WARN("YIELD", 44432c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 44442c92488aSJoe Perches } 44452c92488aSJoe Perches 4446179f8f40SJoe Perches# check for comparisons against true and false 4447179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4448179f8f40SJoe Perches my $lead = $1; 4449179f8f40SJoe Perches my $arg = $2; 4450179f8f40SJoe Perches my $test = $3; 4451179f8f40SJoe Perches my $otype = $4; 4452179f8f40SJoe Perches my $trail = $5; 4453179f8f40SJoe Perches my $op = "!"; 4454179f8f40SJoe Perches 4455179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4456179f8f40SJoe Perches 4457179f8f40SJoe Perches my $type = lc($otype); 4458179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4459179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4460179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4461179f8f40SJoe Perches $op = ""; 4462179f8f40SJoe Perches } 4463179f8f40SJoe Perches 4464179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4465179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4466179f8f40SJoe Perches 4467179f8f40SJoe Perches## maybe suggesting a correct construct would better 4468179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4469179f8f40SJoe Perches 4470179f8f40SJoe Perches } 4471179f8f40SJoe Perches } 4472179f8f40SJoe Perches 44734882720bSThomas Gleixner# check for semaphores initialized locked 44744882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4475000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4476000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4477773647a0SAndy Whitcroft } 44786712d858SJoe Perches 447967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 448067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4481000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 448267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4483773647a0SAndy Whitcroft } 44846712d858SJoe Perches 4485f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4486f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4487000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4488000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4489f3db6639SMichael Ellerman } 44906712d858SJoe Perches 449179404849SEmese Revfy# check for various ops structs, ensure they are const. 449279404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 449379404849SEmese Revfy address_space_operations| 449479404849SEmese Revfy backlight_ops| 449579404849SEmese Revfy block_device_operations| 449679404849SEmese Revfy dentry_operations| 449779404849SEmese Revfy dev_pm_ops| 449879404849SEmese Revfy dma_map_ops| 449979404849SEmese Revfy extent_io_ops| 450079404849SEmese Revfy file_lock_operations| 450179404849SEmese Revfy file_operations| 450279404849SEmese Revfy hv_ops| 450379404849SEmese Revfy ide_dma_ops| 450479404849SEmese Revfy intel_dvo_dev_ops| 450579404849SEmese Revfy item_operations| 450679404849SEmese Revfy iwl_ops| 450779404849SEmese Revfy kgdb_arch| 450879404849SEmese Revfy kgdb_io| 450979404849SEmese Revfy kset_uevent_ops| 451079404849SEmese Revfy lock_manager_operations| 451179404849SEmese Revfy microcode_ops| 451279404849SEmese Revfy mtrr_ops| 451379404849SEmese Revfy neigh_ops| 451479404849SEmese Revfy nlmsvc_binding| 451579404849SEmese Revfy pci_raw_ops| 451679404849SEmese Revfy pipe_buf_operations| 451779404849SEmese Revfy platform_hibernation_ops| 451879404849SEmese Revfy platform_suspend_ops| 451979404849SEmese Revfy proto_ops| 452079404849SEmese Revfy rpc_pipe_ops| 452179404849SEmese Revfy seq_operations| 452279404849SEmese Revfy snd_ac97_build_ops| 452379404849SEmese Revfy soc_pcmcia_socket_ops| 452479404849SEmese Revfy stacktrace_ops| 452579404849SEmese Revfy sysfs_ops| 452679404849SEmese Revfy tty_operations| 452779404849SEmese Revfy usb_mon_operations| 452879404849SEmese Revfy wd_ops}x; 45296903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 453079404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4531000d1cc1SJoe Perches WARN("CONST_STRUCT", 4532000d1cc1SJoe Perches "struct $1 should normally be const\n" . 45336903ffb2SAndy Whitcroft $herecurr); 45342b6db5cbSAndy Whitcroft } 4535773647a0SAndy Whitcroft 4536773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4537773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4538773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4539c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4540c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4541171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4542171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4543171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4544773647a0SAndy Whitcroft { 4545000d1cc1SJoe Perches WARN("NR_CPUS", 4546000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4547773647a0SAndy Whitcroft } 45489c9ba34eSAndy Whitcroft 454952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 455052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 455152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 455252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 455352ea8506SJoe Perches } 455452ea8506SJoe Perches 45559c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 45569c9ba34eSAndy Whitcroft my $string; 45579c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 45589c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 45592a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 45609c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4561000d1cc1SJoe Perches WARN("PRINTF_L", 4562000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 45639c9ba34eSAndy Whitcroft last; 45649c9ba34eSAndy Whitcroft } 45659c9ba34eSAndy Whitcroft } 4566691d77b6SAndy Whitcroft 4567691d77b6SAndy Whitcroft# whine mightly about in_atomic 4568691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4569691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4570000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4571000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4572f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4573000d1cc1SJoe Perches WARN("IN_ATOMIC", 4574000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4575691d77b6SAndy Whitcroft } 4576691d77b6SAndy Whitcroft } 45771704f47bSPeter Zijlstra 45781704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 45791704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 45801704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 45811704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 45821704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 45831704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4584000d1cc1SJoe Perches ERROR("LOCKDEP", 4585000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 45861704f47bSPeter Zijlstra } 45871704f47bSPeter Zijlstra } 458888f8831cSDave Jones 458988f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 459088f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4591000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4592000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 459388f8831cSDave Jones } 45942435880fSJoe Perches 4595515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 4596515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 4597515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 4598515a235eSJoe Perches $line =~ /$mode_perms_search/) { 45992435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 46002435880fSJoe Perches my $func = $entry->[0]; 46012435880fSJoe Perches my $arg_pos = $entry->[1]; 46022435880fSJoe Perches 46032435880fSJoe Perches my $skip_args = ""; 46042435880fSJoe Perches if ($arg_pos > 1) { 46052435880fSJoe Perches $arg_pos--; 46062435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 46072435880fSJoe Perches } 46082435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 4609515a235eSJoe Perches if ($line =~ /$test/) { 46102435880fSJoe Perches my $val = $1; 46112435880fSJoe Perches $val = $6 if ($skip_args ne ""); 46122435880fSJoe Perches 46131727cc70SJoe Perches if ($val !~ /^0$/ && 46141727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 46151727cc70SJoe Perches length($val) ne 4)) { 46162435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 46171727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 46182435880fSJoe Perches } 46192435880fSJoe Perches } 46202435880fSJoe Perches } 462113214adfSAndy Whitcroft } 4622515a235eSJoe Perches } 462313214adfSAndy Whitcroft 462413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 462513214adfSAndy Whitcroft # so just keep quiet. 462613214adfSAndy Whitcroft if ($#rawlines == -1) { 462713214adfSAndy Whitcroft exit(0); 46280a920b5bSAndy Whitcroft } 46290a920b5bSAndy Whitcroft 46308905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 46318905a67cSAndy Whitcroft # things that appear to be patches. 46328905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 46338905a67cSAndy Whitcroft exit(0); 46348905a67cSAndy Whitcroft } 46358905a67cSAndy Whitcroft 46368905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 46378905a67cSAndy Whitcroft # just keep quiet. 46388905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 46398905a67cSAndy Whitcroft exit(0); 46408905a67cSAndy Whitcroft } 46418905a67cSAndy Whitcroft 46428905a67cSAndy Whitcroft if (!$is_patch) { 4643000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4644000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 46450a920b5bSAndy Whitcroft } 46460a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4647000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4648000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 46490a920b5bSAndy Whitcroft } 46500a920b5bSAndy Whitcroft 4651f0a594c1SAndy Whitcroft print report_dump(); 465213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 465313214adfSAndy Whitcroft print "$filename " if ($summary_file); 46546c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 46556c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 46566c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 46578905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 46586c72ffaaSAndy Whitcroft } 46598905a67cSAndy Whitcroft 4660d2c0a235SAndy Whitcroft if ($quiet == 0) { 4661d1fe9c09SJoe Perches 4662d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4663d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4664d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4665d1fe9c09SJoe Perches } 4666d1fe9c09SJoe Perches 4667d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4668d2c0a235SAndy Whitcroft # then suggest that. 4669d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4670d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4671d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4672b0781216SMike Frysinger $rpt_cleaners = 0; 4673d2c0a235SAndy Whitcroft } 4674d2c0a235SAndy Whitcroft } 4675d2c0a235SAndy Whitcroft 467691bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 467791bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4678000d1cc1SJoe Perches 46793705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 46809624b8d6SJoe Perches my $newfile = $filename; 46819624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 46823705ce5bSJoe Perches my $linecount = 0; 46833705ce5bSJoe Perches my $f; 46843705ce5bSJoe Perches 46853705ce5bSJoe Perches open($f, '>', $newfile) 46863705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 46873705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 46883705ce5bSJoe Perches $linecount++; 46893705ce5bSJoe Perches if ($file) { 46903705ce5bSJoe Perches if ($linecount > 3) { 46913705ce5bSJoe Perches $fixed_line =~ s/^\+//; 46923705ce5bSJoe Perches print $f $fixed_line. "\n"; 46933705ce5bSJoe Perches } 46943705ce5bSJoe Perches } else { 46953705ce5bSJoe Perches print $f $fixed_line . "\n"; 46963705ce5bSJoe Perches } 46973705ce5bSJoe Perches } 46983705ce5bSJoe Perches close($f); 46993705ce5bSJoe Perches 47003705ce5bSJoe Perches if (!$quiet) { 47013705ce5bSJoe Perches print << "EOM"; 47023705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 47033705ce5bSJoe Perches 47043705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 47053705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 47063705ce5bSJoe Perches 47073705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 47083705ce5bSJoe PerchesNo warranties, expressed or implied... 47093705ce5bSJoe Perches 47103705ce5bSJoe PerchesEOM 47113705ce5bSJoe Perches } 47123705ce5bSJoe Perches } 47133705ce5bSJoe Perches 47140a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4715c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 47160a920b5bSAndy Whitcroft } 47170a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4718000d1cc1SJoe Perches print << "EOM"; 4719000d1cc1SJoe Perches$vname has style problems, please review. 4720000d1cc1SJoe Perches 4721000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4722000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4723000d1cc1SJoe PerchesEOM 47240a920b5bSAndy Whitcroft } 472513214adfSAndy Whitcroft 47260a920b5bSAndy Whitcroft return $clean; 47270a920b5bSAndy Whitcroft} 4728