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; 272ac73b4fSJoe 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); 1502ac73b4fSJoe 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 18182ac73b4fSJoe 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; 18242ac73b4fSJoe 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 } 18412ac73b4fSJoe Perches $found_file = 1; 18422ac73b4fSJoe Perches } 18432ac73b4fSJoe Perches 18442ac73b4fSJoe Perches if ($found_file) { 18452ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 18462ac73b4fSJoe Perches $check = 1; 18472ac73b4fSJoe Perches } else { 18482ac73b4fSJoe Perches $check = $check_orig; 18492ac73b4fSJoe 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 19479b3189ebSJoe Perches# Check for old stable address 19489b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 19499b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 19509b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 19519b3189ebSJoe Perches } 19529b3189ebSJoe Perches 19537ebd05efSChristopher Covington# Check for unwanted Gerrit info 19547ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 19557ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 19567ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 19577ebd05efSChristopher Covington } 19587ebd05efSChristopher Covington 195900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 19608905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1961000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1962000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 19636c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1964de7d4f0eSAndy Whitcroft } 1965de7d4f0eSAndy Whitcroft 19666ecd9674SAndy Whitcroft# Check for absolute kernel paths. 19676ecd9674SAndy Whitcroft if ($tree) { 19686ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 19696ecd9674SAndy Whitcroft my $file = $1; 19706ecd9674SAndy Whitcroft 19716ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19726ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19736ecd9674SAndy Whitcroft # 19746ecd9674SAndy Whitcroft } else { 19756ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19766ecd9674SAndy Whitcroft } 19776ecd9674SAndy Whitcroft } 19786ecd9674SAndy Whitcroft } 19796ecd9674SAndy Whitcroft 1980de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1981de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1982171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1983171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1984171ae1a4SAndy Whitcroft 1985171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1986171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1987171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1988171ae1a4SAndy Whitcroft 198934d99219SJoe Perches CHK("INVALID_UTF8", 1990000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 199100df344fSAndy Whitcroft } 19920a920b5bSAndy Whitcroft 199315662b3eSJoe Perches# Check if it's the start of a commit log 199415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 199515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1996270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 199715662b3eSJoe Perches $in_header_lines = 0; 199815662b3eSJoe Perches $in_commit_log = 1; 199915662b3eSJoe Perches } 200015662b3eSJoe Perches 2001fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2002fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2003fa64205dSPasi Savanainen if ($in_header_lines && 2004fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2005fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2006fa64205dSPasi Savanainen $non_utf8_charset = 1; 2007fa64205dSPasi Savanainen } 2008fa64205dSPasi Savanainen 2009fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 201015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2011fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 201215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 201315662b3eSJoe Perches } 201415662b3eSJoe Perches 201530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 201630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 201700df344fSAndy Whitcroft 20180a920b5bSAndy Whitcroft#trailing whitespace 20199c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2020c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2021d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2022d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2023d5e616fcSJoe Perches $fix) { 2024d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 2025d5e616fcSJoe Perches } 2026c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2027c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20283705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 20293705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 20303705ce5bSJoe Perches $fix) { 2031d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 20323705ce5bSJoe Perches } 20333705ce5bSJoe Perches 2034d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 20350a920b5bSAndy Whitcroft } 20365368df20SAndy Whitcroft 20374783f894SJosh Triplett# Check for FSF mailing addresses. 2038109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 20393e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 20403e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 20414783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20424783f894SJosh Triplett my $msg_type = \&ERROR; 20434783f894SJosh Triplett $msg_type = \&CHK if ($file); 20444783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 20454783f894SJosh 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) 20464783f894SJosh Triplett } 20474783f894SJosh Triplett 20483354957aSAndi Kleen# check for Kconfig help text having a real description 20499fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 20509fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 20513354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2052a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 20533354957aSAndi Kleen my $length = 0; 20549fe287d7SAndy Whitcroft my $cnt = $realcnt; 20559fe287d7SAndy Whitcroft my $ln = $linenr + 1; 20569fe287d7SAndy Whitcroft my $f; 2057a1385803SAndy Whitcroft my $is_start = 0; 20589fe287d7SAndy Whitcroft my $is_end = 0; 2059a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 20609fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 20619fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 20629fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 20639fe287d7SAndy Whitcroft 20649fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2065a1385803SAndy Whitcroft 2066a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2067a1385803SAndy Whitcroft $is_start = 1; 2068a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2069a1385803SAndy Whitcroft $length = -1; 2070a1385803SAndy Whitcroft } 2071a1385803SAndy Whitcroft 20729fe287d7SAndy Whitcroft $f =~ s/^.//; 20733354957aSAndi Kleen $f =~ s/#.*//; 20743354957aSAndi Kleen $f =~ s/^\s+//; 20753354957aSAndi Kleen next if ($f =~ /^$/); 20769fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20779fe287d7SAndy Whitcroft $is_end = 1; 20789fe287d7SAndy Whitcroft last; 20799fe287d7SAndy Whitcroft } 20803354957aSAndi Kleen $length++; 20813354957aSAndi Kleen } 2082000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2083a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2084a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20853354957aSAndi Kleen } 20863354957aSAndi Kleen 20871ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20881ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20891ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20901ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20911ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20921ba8dfd1SKees Cook } 20931ba8dfd1SKees Cook 2094c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2095c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2096c68e5878SArnaud Lacombe my $flag = $1; 2097c68e5878SArnaud Lacombe my $replacement = { 2098c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2099c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2100c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2101c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2102c68e5878SArnaud Lacombe }; 2103c68e5878SArnaud Lacombe 2104c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2105c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2106c68e5878SArnaud Lacombe } 2107c68e5878SArnaud Lacombe 2108bff5da43SRob Herring# check for DT compatible documentation 21097dd05b38SFlorian Vaussard if (defined $root && 21107dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 21117dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 21127dd05b38SFlorian Vaussard 2113bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2114bff5da43SRob Herring 2115cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2116cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2117cc93319bSFlorian Vaussard 2118bff5da43SRob Herring foreach my $compat (@compats) { 2119bff5da43SRob Herring my $compat2 = $compat; 2120185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2121185d566bSRob Herring my $compat3 = $compat; 2122185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2123185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2124bff5da43SRob Herring if ( $? >> 8 ) { 2125bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2126bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2127bff5da43SRob Herring } 2128bff5da43SRob Herring 21294fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 21304fbf32a6SFlorian Vaussard my $vendor = $1; 2131cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2132bff5da43SRob Herring if ( $? >> 8 ) { 2133bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2134cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2135bff5da43SRob Herring } 2136bff5da43SRob Herring } 2137bff5da43SRob Herring } 2138bff5da43SRob Herring 21395368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 21405368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 21415368df20SAndy Whitcroft 21426cd7f386SJoe Perches#line length limit 2143c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2144f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 21450fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 21468bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 21476cd7f386SJoe Perches $length > $max_line_length) 2148c45dcabdSAndy Whitcroft { 2149000d1cc1SJoe Perches WARN("LONG_LINE", 21506cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 21510a920b5bSAndy Whitcroft } 21520a920b5bSAndy Whitcroft 2153ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 21548c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 21558c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 21568c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2157ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2158ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 21598c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2160ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2161ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2162ca56dc09SJosh Triplett } 2163ca56dc09SJosh Triplett 21645e79d96eSJoe Perches# check for spaces before a quoted newline 21655e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 21663705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 21673705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 21683705ce5bSJoe Perches $fix) { 21693705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 21703705ce5bSJoe Perches } 21713705ce5bSJoe Perches 21725e79d96eSJoe Perches } 21735e79d96eSJoe Perches 21748905a67cSAndy Whitcroft# check for adding lines without a newline. 21758905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2176000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2177000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 21788905a67cSAndy Whitcroft } 21798905a67cSAndy Whitcroft 218042e41c54SMike Frysinger# Blackfin: use hi/lo macros 218142e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 218242e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 218342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2184000d1cc1SJoe Perches ERROR("LO_MACRO", 2185000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 218642e41c54SMike Frysinger } 218742e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 218842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2189000d1cc1SJoe Perches ERROR("HI_MACRO", 2190000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 219142e41c54SMike Frysinger } 219242e41c54SMike Frysinger } 219342e41c54SMike Frysinger 2194b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2195b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21960a920b5bSAndy Whitcroft 21970a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21980a920b5bSAndy Whitcroft# more than 8 must use tabs. 2199c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2200c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2201c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2202d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 22033705ce5bSJoe Perches if (ERROR("CODE_INDENT", 22043705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 22053705ce5bSJoe Perches $fix) { 22063705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22073705ce5bSJoe Perches } 22080a920b5bSAndy Whitcroft } 22090a920b5bSAndy Whitcroft 221008e44365SAlberto Panizzo# check for space before tabs. 221108e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 221208e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22133705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 22143705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 22153705ce5bSJoe Perches $fix) { 2216c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2217c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2218c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2219c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 22203705ce5bSJoe Perches } 222108e44365SAlberto Panizzo } 222208e44365SAlberto Panizzo 2223d1fe9c09SJoe Perches# check for && or || at the start of a line 2224d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2225d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2226d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2227d1fe9c09SJoe Perches } 2228d1fe9c09SJoe Perches 2229d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2230d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 223191cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2232d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2233d1fe9c09SJoe Perches my $oldindent = $1; 2234d1fe9c09SJoe Perches my $rest = $2; 2235d1fe9c09SJoe Perches 2236d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2237d1fe9c09SJoe Perches if ($pos >= 0) { 2238b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2239b34a26f3SJoe Perches my $newindent = $2; 2240d1fe9c09SJoe Perches 2241d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2242d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2243d1fe9c09SJoe Perches " " x ($pos % 8); 2244d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2245d1fe9c09SJoe Perches 2246d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2247d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 22483705ce5bSJoe Perches 22493705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 22503705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 22513705ce5bSJoe Perches $fix && $line =~ /^\+/) { 22523705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22533705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 22543705ce5bSJoe Perches } 2255d1fe9c09SJoe Perches } 2256d1fe9c09SJoe Perches } 2257d1fe9c09SJoe Perches } 2258d1fe9c09SJoe Perches 225923f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 22603705ce5bSJoe Perches if (CHK("SPACING", 22613705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 22623705ce5bSJoe Perches $fix) { 22633705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22643705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 22653705ce5bSJoe Perches } 2266aad4f614SJoe Perches } 2267aad4f614SJoe Perches 226805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2269fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 227085ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 227185ad978cSJoe Perches $realline > 2) { 227205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 227305880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 227405880600SJoe Perches } 227505880600SJoe Perches 227605880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2277a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2278a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 227961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2280a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2281a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2282a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2283a605e32eSJoe Perches } 2284a605e32eSJoe Perches 2285a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2286c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2287c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2288c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2289c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 229005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 229105880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 229205880600SJoe Perches } 229305880600SJoe Perches 22943b617e3bSJoe Perches# check for missing blank lines after declarations 22953f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 22963f7bac03SJoe Perches # actual declarations 22973f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 22983f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 22993f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 23003f7bac03SJoe Perches # known declaration macros 23013f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 23023f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 23033f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 23043f7bac03SJoe Perches # other possible extensions of declaration lines 23053f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 23063f7bac03SJoe Perches # not starting a section or a macro "\" extended line 23073f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 23083f7bac03SJoe Perches # looks like a declaration 23093f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 23103f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 23113f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 23123f7bac03SJoe Perches # known declaration macros 23133f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 23143f7bac03SJoe Perches # start of struct or union or enum 23153b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 23163f7bac03SJoe Perches # start or end of block or continuation of declaration 23173f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 23183f7bac03SJoe Perches # bitfield continuation 23193f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 23203f7bac03SJoe Perches # other possible extensions of declaration lines 23213f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 23223f7bac03SJoe Perches # indentation of previous and current line are the same 23233f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 23243b617e3bSJoe Perches WARN("SPACING", 23253f7bac03SJoe Perches "Missing a blank line after declarations\n" . $hereprev); 23263b617e3bSJoe Perches } 23273b617e3bSJoe Perches 23285f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 23296b4c5bebSAndy Whitcroft# Exceptions: 23306b4c5bebSAndy Whitcroft# 1) within comments 23316b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 23326b4c5bebSAndy Whitcroft# 3) hanging labels 23333705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 23345f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23353705ce5bSJoe Perches if (WARN("LEADING_SPACE", 23363705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 23373705ce5bSJoe Perches $fix) { 23383705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 23393705ce5bSJoe Perches } 23405f7ddae6SRaffaele Recalcati } 23415f7ddae6SRaffaele Recalcati 2342b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2343b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2344b9ea10d6SAndy Whitcroft 2345*032a4c0fSJoe Perches# check indentation of any line with a bare else 2346*032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2347*032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2348*032a4c0fSJoe Perches my $tabs = length($1) + 1; 2349*032a4c0fSJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) { 2350*032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2351*032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2352*032a4c0fSJoe Perches } 2353*032a4c0fSJoe Perches } 2354*032a4c0fSJoe Perches 23551ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 23561ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 23571ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 23581ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 23591ba8dfd1SKees Cook } 23601ba8dfd1SKees Cook 2361c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2362cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2363000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2364000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2365c2fdda0dSAndy Whitcroft } 236622f2a2efSAndy Whitcroft 236742e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 236842e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 236942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2370000d1cc1SJoe Perches ERROR("CSYNC", 2371000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 237242e41c54SMike Frysinger } 237342e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 237442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2375000d1cc1SJoe Perches ERROR("SSYNC", 2376000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 237742e41c54SMike Frysinger } 237842e41c54SMike Frysinger 237956e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 238056e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 238156e77d70SJoe Perches WARN("HOTPLUG_SECTION", 238256e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 238356e77d70SJoe Perches } 238456e77d70SJoe Perches 23859c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 23862b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 23872b474a1aSAndy Whitcroft $realline_next); 23883e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 23893e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 23901b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2391170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2392f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2393171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2394171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2395171ae1a4SAndy Whitcroft 23963e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 23973e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 23983e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 23993e469cdcSAndy Whitcroft # until we hit end of it. 24003e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 24013e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 24023e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 24033e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 24043e469cdcSAndy Whitcroft } 2405f74bd194SAndy Whitcroft 24062b474a1aSAndy Whitcroft # Find the real next line. 24072b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 24082b474a1aSAndy Whitcroft if (defined $realline_next && 24092b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 24102b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 24112b474a1aSAndy Whitcroft $realline_next++; 24122b474a1aSAndy Whitcroft } 24132b474a1aSAndy Whitcroft 2414171ae1a4SAndy Whitcroft my $s = $stat; 2415171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2416cf655043SAndy Whitcroft 2417c2fdda0dSAndy Whitcroft # Ignore goto labels. 2418171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2419c2fdda0dSAndy Whitcroft 2420c2fdda0dSAndy Whitcroft # Ignore functions being called 2421171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2422c2fdda0dSAndy Whitcroft 2423463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2424463f2864SAndy Whitcroft 2425c45dcabdSAndy Whitcroft # declarations always start with types 2426d2506586SAndy 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) { 2427c45dcabdSAndy Whitcroft my $type = $1; 2428c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2429c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2430c45dcabdSAndy Whitcroft 24316c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2432a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2433c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2434c2fdda0dSAndy Whitcroft } 24358905a67cSAndy Whitcroft 24366c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 243765863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2438c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 24399c0ca6f9SAndy Whitcroft } 24408905a67cSAndy Whitcroft 24418905a67cSAndy Whitcroft # Check for any sort of function declaration. 24428905a67cSAndy Whitcroft # int foo(something bar, other baz); 24438905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2444171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 24458905a67cSAndy Whitcroft my ($name_len) = length($1); 24468905a67cSAndy Whitcroft 2447cf655043SAndy Whitcroft my $ctx = $s; 2448773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 24498905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2450cf655043SAndy Whitcroft 24518905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2452c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 24538905a67cSAndy Whitcroft 2454c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 24558905a67cSAndy Whitcroft } 24568905a67cSAndy Whitcroft } 24578905a67cSAndy Whitcroft } 24588905a67cSAndy Whitcroft 24599c0ca6f9SAndy Whitcroft } 24609c0ca6f9SAndy Whitcroft 246100df344fSAndy Whitcroft# 246200df344fSAndy Whitcroft# Checks which may be anchored in the context. 246300df344fSAndy Whitcroft# 246400df344fSAndy Whitcroft 246500df344fSAndy Whitcroft# Check for switch () and associated case and default 246600df344fSAndy Whitcroft# statements should be at the same indent. 246700df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 246800df344fSAndy Whitcroft my $err = ''; 246900df344fSAndy Whitcroft my $sep = ''; 247000df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 247100df344fSAndy Whitcroft shift(@ctx); 247200df344fSAndy Whitcroft for my $ctx (@ctx) { 247300df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 247400df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 247500df344fSAndy Whitcroft $indent != $cindent) { 247600df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 247700df344fSAndy Whitcroft $sep = ''; 247800df344fSAndy Whitcroft } else { 247900df344fSAndy Whitcroft $sep = "[...]\n"; 248000df344fSAndy Whitcroft } 248100df344fSAndy Whitcroft } 248200df344fSAndy Whitcroft if ($err ne '') { 2483000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2484000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2485de7d4f0eSAndy Whitcroft } 2486de7d4f0eSAndy Whitcroft } 2487de7d4f0eSAndy Whitcroft 2488de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2489de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2490c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2491773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2492773647a0SAndy Whitcroft 24939c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 24948eef05ddSJoe Perches 24958eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 24968eef05ddSJoe Perches WARN("DEEP_INDENTATION", 24978eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 24988eef05ddSJoe Perches } 24998eef05ddSJoe Perches 2500de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2501de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2502de7d4f0eSAndy Whitcroft 2503548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2504548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2505de7d4f0eSAndy Whitcroft 2506548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2507548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2508548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2509548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2510548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2511773647a0SAndy Whitcroft $ctx_ln++; 2512773647a0SAndy Whitcroft } 2513548596d5SAndy Whitcroft 251453210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 251553210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2516773647a0SAndy Whitcroft 2517773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2518000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2519000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 252001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 252100df344fSAndy Whitcroft } 2522773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2523773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2524773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2525773647a0SAndy Whitcroft { 25269c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 25279c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2528000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2529000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 253001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 25319c0ca6f9SAndy Whitcroft } 25329c0ca6f9SAndy Whitcroft } 253300df344fSAndy Whitcroft } 253400df344fSAndy Whitcroft 25354d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 25364d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 25373e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 25383e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 25393e469cdcSAndy Whitcroft if (!defined $stat); 25404d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 25414d001e4dSAndy Whitcroft 25424d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 25434d001e4dSAndy Whitcroft 25444d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 25454d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 25464d001e4dSAndy Whitcroft # where necessary. 25474d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 25484d001e4dSAndy Whitcroft 25494d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 25506f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 25516f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 25524d001e4dSAndy Whitcroft 25534d001e4dSAndy Whitcroft # We want to check the first line inside the block 25544d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 25554d001e4dSAndy Whitcroft # 1) any blank line termination 25564d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 25574d001e4dSAndy Whitcroft # 3) any do (...) { 25584d001e4dSAndy Whitcroft my $continuation = 0; 25594d001e4dSAndy Whitcroft my $check = 0; 25604d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 25614d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 25624d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 25634d001e4dSAndy Whitcroft $continuation = 1; 25644d001e4dSAndy Whitcroft } 25659bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 25664d001e4dSAndy Whitcroft $check = 1; 25674d001e4dSAndy Whitcroft $cond_lines++; 25684d001e4dSAndy Whitcroft } 25694d001e4dSAndy Whitcroft 25704d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 25714d001e4dSAndy Whitcroft # preprocessor statement. 25724d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 25734d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 25744d001e4dSAndy Whitcroft $check = 0; 25754d001e4dSAndy Whitcroft } 25764d001e4dSAndy Whitcroft 25779bd49efeSAndy Whitcroft my $cond_ptr = -1; 2578740504c6SAndy Whitcroft $continuation = 0; 25799bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 25809bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 25814d001e4dSAndy Whitcroft 2582f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2583f16fa28fSAndy Whitcroft # is not linear. 2584f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2585f16fa28fSAndy Whitcroft $check = 0; 2586f16fa28fSAndy Whitcroft } 2587f16fa28fSAndy Whitcroft 25889bd49efeSAndy Whitcroft # Ignore: 25899bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 25909bd49efeSAndy Whitcroft # 2) preprocessor lines, and 25919bd49efeSAndy Whitcroft # 3) labels. 2592740504c6SAndy Whitcroft if ($continuation || 2593740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 25949bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 25959bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2596740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 259730dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 25989bd49efeSAndy Whitcroft $cond_lines++; 25999bd49efeSAndy Whitcroft } 26004d001e4dSAndy Whitcroft } 260130dad6ebSAndy Whitcroft } 26024d001e4dSAndy Whitcroft 26034d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 26044d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 26054d001e4dSAndy Whitcroft 26064d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 26074d001e4dSAndy Whitcroft # this is not this patch's fault. 26084d001e4dSAndy Whitcroft if (!defined($stat_real) || 26094d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 26104d001e4dSAndy Whitcroft $check = 0; 26114d001e4dSAndy Whitcroft } 26124d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 26134d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 26144d001e4dSAndy Whitcroft } 26154d001e4dSAndy Whitcroft 26169bd49efeSAndy 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"; 26174d001e4dSAndy Whitcroft 26184d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 26194d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2620000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2621000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 26224d001e4dSAndy Whitcroft } 26234d001e4dSAndy Whitcroft } 26244d001e4dSAndy Whitcroft 26256c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 26266c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 26271f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 26281f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 26296c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2630c2fdda0dSAndy Whitcroft if ($dbg_values) { 2631c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2632cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2633cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 26341f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2635c2fdda0dSAndy Whitcroft } 26366c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 26376c72ffaaSAndy Whitcroft 263800df344fSAndy Whitcroft#ignore lines not being added 26393705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 264000df344fSAndy Whitcroft 2641653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 26427429c690SAndy Whitcroft if ($dbg_type) { 26437429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2644000d1cc1SJoe Perches ERROR("TEST_TYPE", 2645000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 26467429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2647000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2648000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 26497429c690SAndy Whitcroft } 2650653d4876SAndy Whitcroft next; 2651653d4876SAndy Whitcroft } 2652a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2653a1ef277eSAndy Whitcroft if ($dbg_attr) { 26549360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2655000d1cc1SJoe Perches ERROR("TEST_ATTR", 2656000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 26579360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2658000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2659000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2660a1ef277eSAndy Whitcroft } 2661a1ef277eSAndy Whitcroft next; 2662a1ef277eSAndy Whitcroft } 2663653d4876SAndy Whitcroft 2664f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 266599423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 266699423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2667000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2668000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2669f0a594c1SAndy Whitcroft } 2670f0a594c1SAndy Whitcroft 267100df344fSAndy Whitcroft# 267200df344fSAndy Whitcroft# Checks which are anchored on the added line. 267300df344fSAndy Whitcroft# 267400df344fSAndy Whitcroft 2675653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2676c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2677653d4876SAndy Whitcroft my $path = $1; 2678653d4876SAndy Whitcroft if ($path =~ m{//}) { 2679000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2680495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2681495e9d84SJoe Perches } 2682495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2683495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2684495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2685653d4876SAndy Whitcroft } 2686653d4876SAndy Whitcroft } 2687653d4876SAndy Whitcroft 268800df344fSAndy Whitcroft# no C99 // comments 268900df344fSAndy Whitcroft if ($line =~ m{//}) { 26903705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 26913705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 26923705ce5bSJoe Perches $fix) { 26933705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 26943705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 26953705ce5bSJoe Perches my $comment = trim($1); 26963705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 26973705ce5bSJoe Perches } 26983705ce5bSJoe Perches } 269900df344fSAndy Whitcroft } 270000df344fSAndy Whitcroft # Remove C99 comments. 27010a920b5bSAndy Whitcroft $line =~ s@//.*@@; 27026c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 27030a920b5bSAndy Whitcroft 27042b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 27052b474a1aSAndy Whitcroft# the whole statement. 27062b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 27072b474a1aSAndy Whitcroft if (defined $realline_next && 27082b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 27092b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 27102b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 27112b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 27123cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 27133cbf62dfSAndy Whitcroft # a prefix: 27143cbf62dfSAndy Whitcroft # XXX(foo); 27153cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2716653d4876SAndy Whitcroft my $name = $1; 271787a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 27183cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 27193cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 27203cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 27213cbf62dfSAndy Whitcroft 27223cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 27232b474a1aSAndy Whitcroft \n.}\s*$| 272448012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 272548012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 272648012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 27272b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 27282b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 272948012058SAndy Whitcroft )/x) { 27302b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 27312b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 27322b474a1aSAndy Whitcroft } else { 27332b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 27340a920b5bSAndy Whitcroft } 27350a920b5bSAndy Whitcroft } 27362b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 27372b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 27382b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 27392b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 27402b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 27412b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 27422b474a1aSAndy Whitcroft } 27432b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 27442b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2745000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2746000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 27472b474a1aSAndy Whitcroft } 27480a920b5bSAndy Whitcroft 27495150bda4SJoe Eloff# check for global initialisers. 2750d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2751d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2752000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2753d5e616fcSJoe Perches $herecurr) && 2754d5e616fcSJoe Perches $fix) { 2755d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2756d5e616fcSJoe Perches } 2757f0a594c1SAndy Whitcroft } 27580a920b5bSAndy Whitcroft# check for static initialisers. 2759d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2760d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2761000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2762d5e616fcSJoe Perches $herecurr) && 2763d5e616fcSJoe Perches $fix) { 2764d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2765d5e616fcSJoe Perches } 27660a920b5bSAndy Whitcroft } 27670a920b5bSAndy Whitcroft 2768cb710ecaSJoe Perches# check for static const char * arrays. 2769cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2770000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2771000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2772cb710ecaSJoe Perches $herecurr); 2773cb710ecaSJoe Perches } 2774cb710ecaSJoe Perches 2775cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2776cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2777000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2778000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2779cb710ecaSJoe Perches $herecurr); 2780cb710ecaSJoe Perches } 2781cb710ecaSJoe Perches 27829b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 27839b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 27849b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 27859b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 27869b0fa60dSJoe Perches $herecurr); 27879b0fa60dSJoe Perches } 27889b0fa60dSJoe Perches 2789b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 2790b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 2791b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 2792b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 2793b36190c5SJoe Perches $fix) { 2794b36190c5SJoe Perches $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 2795b36190c5SJoe Perches } 2796b36190c5SJoe Perches } 2797b36190c5SJoe Perches 279892e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 279992e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 280092e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 280192e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 280292e112fdSJoe Perches $fix) { 280392e112fdSJoe 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\[\] = /; 280492e112fdSJoe Perches } 280593ed0e2dSJoe Perches } 280693ed0e2dSJoe Perches 2807653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2808653d4876SAndy Whitcroft# make sense. 2809653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 28108054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2811c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 28128ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2813653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2814000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2815000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 28160a920b5bSAndy Whitcroft } 28170a920b5bSAndy Whitcroft 28180a920b5bSAndy Whitcroft# * goes on variable not on type 281965863862SAndy Whitcroft # (char*[ const]) 2820bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2821bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 28223705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2823d8aaf121SAndy Whitcroft 282465863862SAndy Whitcroft # Should start with a space. 282565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 282665863862SAndy Whitcroft # Should not end with a space. 282765863862SAndy Whitcroft $to =~ s/\s+$//; 282865863862SAndy Whitcroft # '*'s should not have spaces between. 2829f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 283065863862SAndy Whitcroft } 2831d8aaf121SAndy Whitcroft 28323705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 283365863862SAndy Whitcroft if ($from ne $to) { 28343705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28353705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 28363705ce5bSJoe Perches $fix) { 28373705ce5bSJoe Perches my $sub_from = $ident; 28383705ce5bSJoe Perches my $sub_to = $ident; 28393705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28403705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28413705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28423705ce5bSJoe Perches } 284365863862SAndy Whitcroft } 2844bfcb2cc7SAndy Whitcroft } 2845bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2846bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 28473705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2848d8aaf121SAndy Whitcroft 284965863862SAndy Whitcroft # Should start with a space. 285065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 285165863862SAndy Whitcroft # Should not end with a space. 285265863862SAndy Whitcroft $to =~ s/\s+$//; 285365863862SAndy Whitcroft # '*'s should not have spaces between. 2854f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 285565863862SAndy Whitcroft } 285665863862SAndy Whitcroft # Modifiers should have spaces. 285765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 285865863862SAndy Whitcroft 28593705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2860667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 28613705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28623705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 28633705ce5bSJoe Perches $fix) { 28643705ce5bSJoe Perches 28653705ce5bSJoe Perches my $sub_from = $match; 28663705ce5bSJoe Perches my $sub_to = $match; 28673705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28683705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28693705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28703705ce5bSJoe Perches } 287165863862SAndy Whitcroft } 28720a920b5bSAndy Whitcroft } 28730a920b5bSAndy Whitcroft 28740a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 28750a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 28760a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 28770a920b5bSAndy Whitcroft# print "$herecurr"; 28780a920b5bSAndy Whitcroft# $clean = 0; 28790a920b5bSAndy Whitcroft# } 28800a920b5bSAndy Whitcroft 28818905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2882000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2883000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 28848905a67cSAndy Whitcroft } 28858905a67cSAndy Whitcroft 288617441227SJoe Perches# check for uses of printk_ratelimit 288717441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2888000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2889000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 289017441227SJoe Perches } 289117441227SJoe Perches 289200df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 289300df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 289400df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 289525985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 289600df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2897f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 289800df344fSAndy Whitcroft my $ok = 0; 289900df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 290000df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 290125985edcSLucas De Marchi # we have a preceding printk if it ends 290200df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 290300df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 290400df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 290500df344fSAndy Whitcroft $ok = 1; 290600df344fSAndy Whitcroft } 290700df344fSAndy Whitcroft last; 290800df344fSAndy Whitcroft } 290900df344fSAndy Whitcroft } 291000df344fSAndy Whitcroft if ($ok == 0) { 2911000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2912000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 29130a920b5bSAndy Whitcroft } 291400df344fSAndy Whitcroft } 29150a920b5bSAndy Whitcroft 2916243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2917243f3803SJoe Perches my $orig = $1; 2918243f3803SJoe Perches my $level = lc($orig); 2919243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 29208f26b837SJoe Perches my $level2 = $level; 29218f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2922243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2923daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2924243f3803SJoe Perches } 2925243f3803SJoe Perches 2926243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2927d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2928d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2929d5e616fcSJoe Perches $fix) { 2930d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2931d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2932d5e616fcSJoe Perches } 2933243f3803SJoe Perches } 2934243f3803SJoe Perches 2935dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2936dc139313SJoe Perches my $orig = $1; 2937dc139313SJoe Perches my $level = lc($orig); 2938dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2939dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2940dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2941dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2942dc139313SJoe Perches } 2943dc139313SJoe Perches 2944653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2945653d4876SAndy Whitcroft# or if closed on same line 2946c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2947c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2948000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2949000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 29500a920b5bSAndy Whitcroft } 2951653d4876SAndy Whitcroft 29528905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 29538905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 29548905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2955000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2956000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 29578905a67cSAndy Whitcroft } 29588905a67cSAndy Whitcroft 29590c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 29603705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 29613705ce5bSJoe Perches if (WARN("SPACING", 29623705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 29633705ce5bSJoe Perches $fix) { 29643705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29653705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 29663705ce5bSJoe Perches } 29670c73b4ebSAndy Whitcroft } 29680c73b4ebSAndy Whitcroft 296931070b5dSJoe Perches# Function pointer declarations 297031070b5dSJoe Perches# check spacing between type, funcptr, and args 297131070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 297291f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 297331070b5dSJoe Perches my $declare = $1; 297431070b5dSJoe Perches my $pre_pointer_space = $2; 297531070b5dSJoe Perches my $post_pointer_space = $3; 297631070b5dSJoe Perches my $funcname = $4; 297731070b5dSJoe Perches my $post_funcname_space = $5; 297831070b5dSJoe Perches my $pre_args_space = $6; 297931070b5dSJoe Perches 298091f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 298191f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 298291f72e9cSJoe Perches# don't need a space so don't warn for those. 298391f72e9cSJoe Perches my $post_declare_space = ""; 298491f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 298591f72e9cSJoe Perches $post_declare_space = $1; 298691f72e9cSJoe Perches $declare = rtrim($declare); 298791f72e9cSJoe Perches } 298891f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 298931070b5dSJoe Perches WARN("SPACING", 299031070b5dSJoe Perches "missing space after return type\n" . $herecurr); 299191f72e9cSJoe Perches $post_declare_space = " "; 299231070b5dSJoe Perches } 299331070b5dSJoe Perches 299431070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 299591f72e9cSJoe Perches# This test is not currently implemented because these declarations are 299691f72e9cSJoe Perches# equivalent to 299791f72e9cSJoe Perches# int foo(int bar, ...) 299891f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 299991f72e9cSJoe Perches# 300091f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 300191f72e9cSJoe Perches# WARN("SPACING", 300291f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 300391f72e9cSJoe Perches# } 300431070b5dSJoe Perches 300531070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 300631070b5dSJoe Perches if (defined $pre_pointer_space && 300731070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 300831070b5dSJoe Perches WARN("SPACING", 300931070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 301031070b5dSJoe Perches } 301131070b5dSJoe Perches 301231070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 301331070b5dSJoe Perches if (defined $post_pointer_space && 301431070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 301531070b5dSJoe Perches WARN("SPACING", 301631070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 301731070b5dSJoe Perches } 301831070b5dSJoe Perches 301931070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 302031070b5dSJoe Perches if (defined $post_funcname_space && 302131070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 302231070b5dSJoe Perches WARN("SPACING", 302331070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 302431070b5dSJoe Perches } 302531070b5dSJoe Perches 302631070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 302731070b5dSJoe Perches if (defined $pre_args_space && 302831070b5dSJoe Perches $pre_args_space =~ /^\s/) { 302931070b5dSJoe Perches WARN("SPACING", 303031070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 303131070b5dSJoe Perches } 303231070b5dSJoe Perches 303331070b5dSJoe Perches if (show_type("SPACING") && $fix) { 303431070b5dSJoe Perches $fixed[$linenr - 1] =~ 303591f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 303631070b5dSJoe Perches } 303731070b5dSJoe Perches } 303831070b5dSJoe Perches 30398d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 30408d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3041fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3042fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 30438d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 30448d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 30458d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3046fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3047daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 30483705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 30493705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 30503705ce5bSJoe Perches $fix) { 30513705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30523705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 30533705ce5bSJoe Perches } 30548d31cfceSAndy Whitcroft } 30558d31cfceSAndy Whitcroft } 30568d31cfceSAndy Whitcroft 3057f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 30586c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3059c2fdda0dSAndy Whitcroft my $name = $1; 3060773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3061773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3062c2fdda0dSAndy Whitcroft 3063c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3064773647a0SAndy Whitcroft if ($name =~ /^(?: 3065773647a0SAndy Whitcroft if|for|while|switch|return|case| 3066773647a0SAndy Whitcroft volatile|__volatile__| 3067773647a0SAndy Whitcroft __attribute__|format|__extension__| 3068773647a0SAndy Whitcroft asm|__asm__)$/x) 3069773647a0SAndy Whitcroft { 3070c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3071c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3072c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3073c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3074773647a0SAndy Whitcroft 3075773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3076c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3077c2fdda0dSAndy Whitcroft 3078c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3079c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3080773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3081c2fdda0dSAndy Whitcroft 3082c2fdda0dSAndy Whitcroft } else { 30833705ce5bSJoe Perches if (WARN("SPACING", 30843705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 30853705ce5bSJoe Perches $fix) { 30863705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30873705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 30883705ce5bSJoe Perches } 3089f0a594c1SAndy Whitcroft } 30906c72ffaaSAndy Whitcroft } 30919a4cad4eSEric Nelson 3092653d4876SAndy Whitcroft# Check operator spacing. 30930a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 30943705ce5bSJoe Perches my $fixed_line = ""; 30953705ce5bSJoe Perches my $line_fixed = 0; 30963705ce5bSJoe Perches 30979c0ca6f9SAndy Whitcroft my $ops = qr{ 30989c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 30999c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 31009c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 31011f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 310284731623SJoe Perches \?:|\?|: 31039c0ca6f9SAndy Whitcroft }x; 3104cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 31053705ce5bSJoe Perches 31063705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 31073705ce5bSJoe Perches## foreach my $el (@elements) { 31083705ce5bSJoe Perches## print("el: <$el>\n"); 31093705ce5bSJoe Perches## } 31103705ce5bSJoe Perches 31113705ce5bSJoe Perches my @fix_elements = (); 311200df344fSAndy Whitcroft my $off = 0; 31136c72ffaaSAndy Whitcroft 31143705ce5bSJoe Perches foreach my $el (@elements) { 31153705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 31163705ce5bSJoe Perches $off += length($el); 31173705ce5bSJoe Perches } 31183705ce5bSJoe Perches 31193705ce5bSJoe Perches $off = 0; 31203705ce5bSJoe Perches 31216c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3122b34c648bSJoe Perches my $last_after = -1; 31236c72ffaaSAndy Whitcroft 31240a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 31253705ce5bSJoe Perches 31263705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 31273705ce5bSJoe Perches 31283705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 31293705ce5bSJoe Perches 31304a0df2efSAndy Whitcroft $off += length($elements[$n]); 31314a0df2efSAndy Whitcroft 313225985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3133773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3134773647a0SAndy Whitcroft my $cc = ''; 3135773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3136773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3137773647a0SAndy Whitcroft } 3138773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3139773647a0SAndy Whitcroft 31404a0df2efSAndy Whitcroft my $a = ''; 31414a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 31424a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3143cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 31444a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 31454a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3146773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 31474a0df2efSAndy Whitcroft 31480a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 31494a0df2efSAndy Whitcroft 31504a0df2efSAndy Whitcroft my $c = ''; 31510a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 31524a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 31534a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3154cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 31554a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 31564a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 31578b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 31584a0df2efSAndy Whitcroft } else { 31594a0df2efSAndy Whitcroft $c = 'E'; 31600a920b5bSAndy Whitcroft } 31610a920b5bSAndy Whitcroft 31624a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 31634a0df2efSAndy Whitcroft 31644a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 31654a0df2efSAndy Whitcroft 31666c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3167de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 31680a920b5bSAndy Whitcroft 316974048ed8SAndy Whitcroft # Pull out the value of this operator. 31706c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 31710a920b5bSAndy Whitcroft 31721f65f947SAndy Whitcroft # Get the full operator variant. 31731f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 31741f65f947SAndy Whitcroft 317513214adfSAndy Whitcroft # Ignore operators passed as parameters. 317613214adfSAndy Whitcroft if ($op_type ne 'V' && 317713214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 317813214adfSAndy Whitcroft 3179cf655043SAndy Whitcroft# # Ignore comments 3180cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 318113214adfSAndy Whitcroft 3182d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 318313214adfSAndy Whitcroft } elsif ($op eq ';') { 3184cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3185cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 31863705ce5bSJoe Perches if (ERROR("SPACING", 31873705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3188b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31893705ce5bSJoe Perches $line_fixed = 1; 31903705ce5bSJoe Perches } 3191d8aaf121SAndy Whitcroft } 3192d8aaf121SAndy Whitcroft 3193d8aaf121SAndy Whitcroft # // is a comment 3194d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 31950a920b5bSAndy Whitcroft 3196b00e4814SJoe Perches # : when part of a bitfield 3197b00e4814SJoe Perches } elsif ($opv eq ':B') { 3198b00e4814SJoe Perches # skip the bitfield test for now 3199b00e4814SJoe Perches 32001f65f947SAndy Whitcroft # No spaces for: 32011f65f947SAndy Whitcroft # -> 3202b00e4814SJoe Perches } elsif ($op eq '->') { 32034a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 32043705ce5bSJoe Perches if (ERROR("SPACING", 32053705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3206b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32073705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32083705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 32093705ce5bSJoe Perches } 3210b34c648bSJoe Perches $line_fixed = 1; 32113705ce5bSJoe Perches } 32120a920b5bSAndy Whitcroft } 32130a920b5bSAndy Whitcroft 32140a920b5bSAndy Whitcroft # , must have a space on the right. 32150a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3216cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 32173705ce5bSJoe Perches if (ERROR("SPACING", 32183705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3219b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32203705ce5bSJoe Perches $line_fixed = 1; 3221b34c648bSJoe Perches $last_after = $n; 32223705ce5bSJoe Perches } 32230a920b5bSAndy Whitcroft } 32240a920b5bSAndy Whitcroft 32259c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 322674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 32279c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 32289c0ca6f9SAndy Whitcroft 32299c0ca6f9SAndy Whitcroft # unary operators should have a space before and 32309c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 32319c0ca6f9SAndy Whitcroft # unary operator, or a cast 32329c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 323374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 32340d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3235cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 32363705ce5bSJoe Perches if (ERROR("SPACING", 32373705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3238b34c648bSJoe Perches if ($n != $last_after + 2) { 3239b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 32403705ce5bSJoe Perches $line_fixed = 1; 32413705ce5bSJoe Perches } 32420a920b5bSAndy Whitcroft } 3243b34c648bSJoe Perches } 3244a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3245171ae1a4SAndy Whitcroft # A unary '*' may be const 3246171ae1a4SAndy Whitcroft 3247171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 32483705ce5bSJoe Perches if (ERROR("SPACING", 32493705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3250b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 32513705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32523705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 32533705ce5bSJoe Perches } 3254b34c648bSJoe Perches $line_fixed = 1; 32553705ce5bSJoe Perches } 32560a920b5bSAndy Whitcroft } 32570a920b5bSAndy Whitcroft 32580a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 32590a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3260773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 32613705ce5bSJoe Perches if (ERROR("SPACING", 32623705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3263b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32643705ce5bSJoe Perches $line_fixed = 1; 32653705ce5bSJoe Perches } 32660a920b5bSAndy Whitcroft } 3267773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3268773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 32693705ce5bSJoe Perches if (ERROR("SPACING", 32703705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3271b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32723705ce5bSJoe Perches $line_fixed = 1; 32733705ce5bSJoe Perches } 3274653d4876SAndy Whitcroft } 3275773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 32763705ce5bSJoe Perches if (ERROR("SPACING", 32773705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3278b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 32793705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32803705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3281773647a0SAndy Whitcroft } 3282b34c648bSJoe Perches $line_fixed = 1; 32833705ce5bSJoe Perches } 32843705ce5bSJoe Perches } 32850a920b5bSAndy Whitcroft 32860a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 32879c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 32889c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 32899c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3290c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3291c2fdda0dSAndy Whitcroft $op eq '%') 32920a920b5bSAndy Whitcroft { 3293773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 32943705ce5bSJoe Perches if (ERROR("SPACING", 32953705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3296b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3297b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3298b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3299b34c648bSJoe Perches } 33003705ce5bSJoe Perches $line_fixed = 1; 33013705ce5bSJoe Perches } 33020a920b5bSAndy Whitcroft } 33030a920b5bSAndy Whitcroft 33041f65f947SAndy Whitcroft # A colon needs no spaces before when it is 33051f65f947SAndy Whitcroft # terminating a case value or a label. 33061f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 33071f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 33083705ce5bSJoe Perches if (ERROR("SPACING", 33093705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3310b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 33113705ce5bSJoe Perches $line_fixed = 1; 33123705ce5bSJoe Perches } 33131f65f947SAndy Whitcroft } 33141f65f947SAndy Whitcroft 33150a920b5bSAndy Whitcroft # All the others need spaces both sides. 3316cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 33171f65f947SAndy Whitcroft my $ok = 0; 33181f65f947SAndy Whitcroft 331922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 33201f65f947SAndy Whitcroft if (($op eq '<' && 33211f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 33221f65f947SAndy Whitcroft ($op eq '>' && 33231f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 33241f65f947SAndy Whitcroft { 33251f65f947SAndy Whitcroft $ok = 1; 33261f65f947SAndy Whitcroft } 33271f65f947SAndy Whitcroft 332884731623SJoe Perches # messages are ERROR, but ?: are CHK 33291f65f947SAndy Whitcroft if ($ok == 0) { 333084731623SJoe Perches my $msg_type = \&ERROR; 333184731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 333284731623SJoe Perches 333384731623SJoe Perches if (&{$msg_type}("SPACING", 33343705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3335b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3336b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3337b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3338b34c648bSJoe Perches } 33393705ce5bSJoe Perches $line_fixed = 1; 33403705ce5bSJoe Perches } 33410a920b5bSAndy Whitcroft } 334222f2a2efSAndy Whitcroft } 33434a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 33443705ce5bSJoe Perches 33453705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 33463705ce5bSJoe Perches 33473705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 33480a920b5bSAndy Whitcroft } 33493705ce5bSJoe Perches 33503705ce5bSJoe Perches if (($#elements % 2) == 0) { 33513705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 33523705ce5bSJoe Perches } 33533705ce5bSJoe Perches 33543705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 33553705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 33563705ce5bSJoe Perches } 33573705ce5bSJoe Perches 33583705ce5bSJoe Perches 33590a920b5bSAndy Whitcroft } 33600a920b5bSAndy Whitcroft 3361786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3362d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3363786b6326SJoe Perches if (WARN("SPACING", 3364786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3365786b6326SJoe Perches $fix) { 3366786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3367786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3368786b6326SJoe Perches } 3369786b6326SJoe Perches } 3370786b6326SJoe Perches 3371f0a594c1SAndy Whitcroft# check for multiple assignments 3372f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3373000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3374000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3375f0a594c1SAndy Whitcroft } 3376f0a594c1SAndy Whitcroft 337722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 337822f2a2efSAndy Whitcroft## # continuation. 337922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 338022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 338122f2a2efSAndy Whitcroft## 338222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 338322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 338422f2a2efSAndy Whitcroft## my $ln = $line; 338522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 338622f2a2efSAndy Whitcroft## } 338722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3388000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3389000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 339022f2a2efSAndy Whitcroft## } 339122f2a2efSAndy Whitcroft## } 3392f0a594c1SAndy Whitcroft 33930a920b5bSAndy Whitcroft#need space before brace following if, while, etc 339422f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 339522f2a2efSAndy Whitcroft $line =~ /do{/) { 33963705ce5bSJoe Perches if (ERROR("SPACING", 33973705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 33983705ce5bSJoe Perches $fix) { 3399d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 34003705ce5bSJoe Perches } 3401de7d4f0eSAndy Whitcroft } 3402de7d4f0eSAndy Whitcroft 3403c4a62ef9SJoe Perches## # check for blank lines before declarations 3404c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3405c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3406c4a62ef9SJoe Perches## WARN("SPACING", 3407c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3408c4a62ef9SJoe Perches## } 3409c4a62ef9SJoe Perches## 3410c4a62ef9SJoe Perches 3411de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3412de7d4f0eSAndy Whitcroft# on the line 3413de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3414d5e616fcSJoe Perches if (ERROR("SPACING", 3415d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3416d5e616fcSJoe Perches $fix) { 3417d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3418d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3419d5e616fcSJoe Perches } 34200a920b5bSAndy Whitcroft } 34210a920b5bSAndy Whitcroft 342222f2a2efSAndy Whitcroft# check spacing on square brackets 342322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 34243705ce5bSJoe Perches if (ERROR("SPACING", 34253705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 34263705ce5bSJoe Perches $fix) { 34273705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34283705ce5bSJoe Perches s/\[\s+/\[/; 34293705ce5bSJoe Perches } 343022f2a2efSAndy Whitcroft } 343122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 34323705ce5bSJoe Perches if (ERROR("SPACING", 34333705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 34343705ce5bSJoe Perches $fix) { 34353705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34363705ce5bSJoe Perches s/\s+\]/\]/; 34373705ce5bSJoe Perches } 343822f2a2efSAndy Whitcroft } 343922f2a2efSAndy Whitcroft 3440c45dcabdSAndy Whitcroft# check spacing on parentheses 34419c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 34429c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 34433705ce5bSJoe Perches if (ERROR("SPACING", 34443705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 34453705ce5bSJoe Perches $fix) { 34463705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34473705ce5bSJoe Perches s/\(\s+/\(/; 34483705ce5bSJoe Perches } 344922f2a2efSAndy Whitcroft } 345013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3451c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3452c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 34533705ce5bSJoe Perches if (ERROR("SPACING", 34543705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 34553705ce5bSJoe Perches $fix) { 34563705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34573705ce5bSJoe Perches s/\s+\)/\)/; 34583705ce5bSJoe Perches } 345922f2a2efSAndy Whitcroft } 346022f2a2efSAndy Whitcroft 34610a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 34624a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 34630a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 34643705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 34653705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 34663705ce5bSJoe Perches $fix) { 34673705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34683705ce5bSJoe Perches s/^(.)\s+/$1/; 34693705ce5bSJoe Perches } 34700a920b5bSAndy Whitcroft } 34710a920b5bSAndy Whitcroft 34725b9553abSJoe Perches# return is not a function 3473507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3474c45dcabdSAndy Whitcroft my $spacing = $1; 3475507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 34765b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 34775b9553abSJoe Perches my $value = $1; 34785b9553abSJoe Perches $value = deparenthesize($value); 34795b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3480000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3481000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 34825b9553abSJoe Perches } 3483c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3484000d1cc1SJoe Perches ERROR("SPACING", 3485000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3486c45dcabdSAndy Whitcroft } 3487c45dcabdSAndy Whitcroft } 3488507e5141SJoe Perches 3489b43ae21bSJoe Perches# unnecessary return in a void function 3490b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 3491b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 3492b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 3493b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 3494b43ae21bSJoe Perches $linenr >= 3 && 3495b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 3496b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 34979819cf25SJoe Perches WARN("RETURN_VOID", 3498b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 34999819cf25SJoe Perches } 35009819cf25SJoe Perches 3501189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3502189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3503189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3504189248d8SJoe Perches my $openparens = $1; 3505189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3506189248d8SJoe Perches my $msg = ""; 3507189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3508189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3509189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3510189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3511189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3512189248d8SJoe Perches } 3513189248d8SJoe Perches } 3514189248d8SJoe Perches 351553a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 351653a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 351753a3c448SAndy Whitcroft my $name = $1; 351853a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3519000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3520000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 352153a3c448SAndy Whitcroft } 352253a3c448SAndy Whitcroft } 3523c45dcabdSAndy Whitcroft 35240a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 35254a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 35263705ce5bSJoe Perches if (ERROR("SPACING", 35273705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 35283705ce5bSJoe Perches $fix) { 35293705ce5bSJoe Perches $fixed[$linenr - 1] =~ 35303705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 35313705ce5bSJoe Perches } 35320a920b5bSAndy Whitcroft } 35330a920b5bSAndy Whitcroft 3534f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3535f5fe35ddSAndy Whitcroft# statements after the conditional. 3536170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 35373e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35383e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35393e469cdcSAndy Whitcroft if (!defined $stat); 3540170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3541170d3a22SAndy Whitcroft $remain_next, $off_next); 3542170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3543170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3544170d3a22SAndy Whitcroft 3545170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3546170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3547170d3a22SAndy Whitcroft # then count those as offsets. 3548170d3a22SAndy Whitcroft my ($whitespace) = 3549170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3550170d3a22SAndy Whitcroft my $offset = 3551170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3552170d3a22SAndy Whitcroft 3553170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3554170d3a22SAndy Whitcroft $offset} = 1; 3555170d3a22SAndy Whitcroft } 3556170d3a22SAndy Whitcroft } 3557170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3558c11230f4SJoe Perches defined($stat) && defined($cond) && 3559170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3560171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 35618905a67cSAndy Whitcroft 3562b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3563000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3564000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 35658905a67cSAndy Whitcroft } 35668905a67cSAndy Whitcroft 35678905a67cSAndy Whitcroft # Find out what is on the end of the line after the 35688905a67cSAndy Whitcroft # conditional. 3569773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 35708905a67cSAndy Whitcroft $s =~ s/\n.*//g; 357113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 357253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 357353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3574773647a0SAndy Whitcroft { 3575bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3576bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3577bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 357842bdf74cSHidetoshi Seto my $stat_real = ''; 3579bb44ad39SAndy Whitcroft 358042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 358142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3582bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3583bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3584bb44ad39SAndy Whitcroft } 3585bb44ad39SAndy Whitcroft 3586000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3587000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 35888905a67cSAndy Whitcroft } 35898905a67cSAndy Whitcroft } 35908905a67cSAndy Whitcroft 359113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 359213214adfSAndy Whitcroft if ($line =~ / 359313214adfSAndy Whitcroft (?: 359413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 359513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 359613214adfSAndy Whitcroft (?:\&\&|\|\|) 359713214adfSAndy Whitcroft | 359813214adfSAndy Whitcroft (?:\&\&|\|\|) 359913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 360013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 360113214adfSAndy Whitcroft )/x) 360213214adfSAndy Whitcroft { 3603000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3604000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 360513214adfSAndy Whitcroft } 360613214adfSAndy Whitcroft 36078905a67cSAndy Whitcroft# if and else should not have general statements after it 360813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 360913214adfSAndy Whitcroft my $s = $1; 361013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 361113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3612000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3613000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 36140a920b5bSAndy Whitcroft } 361513214adfSAndy Whitcroft } 361639667782SAndy Whitcroft# if should not continue a brace 361739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3618000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3619000d1cc1SJoe Perches "trailing statements should be on next line\n" . 362039667782SAndy Whitcroft $herecurr); 362139667782SAndy Whitcroft } 3622a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3623a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3624a1080bf8SAndy Whitcroft $line !~ /\G(?: 36253fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3626a1080bf8SAndy Whitcroft \s*return\s+ 3627a1080bf8SAndy Whitcroft )/xg) 3628a1080bf8SAndy Whitcroft { 3629000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3630000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3631a1080bf8SAndy Whitcroft } 36320a920b5bSAndy Whitcroft 36330a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 36340a920b5bSAndy Whitcroft # indent level to be relevant to each other. 36350a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 36360a920b5bSAndy Whitcroft $previndent == $indent) { 3637000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3638000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 36390a920b5bSAndy Whitcroft } 36400a920b5bSAndy Whitcroft 3641c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3642c2fdda0dSAndy Whitcroft $previndent == $indent) { 3643c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3644c2fdda0dSAndy Whitcroft 3645c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3646c2fdda0dSAndy Whitcroft # conditional. 3647773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3648c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3649c2fdda0dSAndy Whitcroft 3650c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3651000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3652000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3653c2fdda0dSAndy Whitcroft } 3654c2fdda0dSAndy Whitcroft } 3655c2fdda0dSAndy Whitcroft 365695e2c602SJoe Perches#Specific variable tests 3657323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3658323c1260SJoe Perches my $var = $1; 365995e2c602SJoe Perches 366095e2c602SJoe Perches#gcc binary extension 366195e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3662d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3663d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3664d5e616fcSJoe Perches $fix) { 3665d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3666d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3667d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3668d5e616fcSJoe Perches } 366995e2c602SJoe Perches } 367095e2c602SJoe Perches 367195e2c602SJoe Perches#CamelCase 3672807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3673be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 367422735ce8SJoe Perches#Ignore Page<foo> variants 3675807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 367622735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 36773445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 36787e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 36797e781f67SJoe Perches my $word = $1; 36807e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3681d8b07710SJoe Perches if ($check) { 3682d8b07710SJoe Perches seed_camelcase_includes(); 3683d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3684d8b07710SJoe Perches seed_camelcase_file($realfile); 3685d8b07710SJoe Perches $camelcase_file_seeded = 1; 3686d8b07710SJoe Perches } 3687d8b07710SJoe Perches } 36887e781f67SJoe Perches if (!defined $camelcase{$word}) { 36897e781f67SJoe Perches $camelcase{$word} = 1; 3690be79794bSJoe Perches CHK("CAMELCASE", 36917e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 36927e781f67SJoe Perches } 3693323c1260SJoe Perches } 3694323c1260SJoe Perches } 36953445686aSJoe Perches } 36960a920b5bSAndy Whitcroft 36970a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3698d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3699d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3700d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3701d5e616fcSJoe Perches $fix) { 3702d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3703d5e616fcSJoe Perches } 37040a920b5bSAndy Whitcroft } 37050a920b5bSAndy Whitcroft 3706653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3707c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3708e09dec48SAndy Whitcroft my $file = "$1.h"; 3709e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3710e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3711e09dec48SAndy Whitcroft $realfile ne $checkfile && 37127840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3713c45dcabdSAndy Whitcroft { 3714e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3715000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3716000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3717e09dec48SAndy Whitcroft } else { 3718000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3719000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3720e09dec48SAndy Whitcroft } 37210a920b5bSAndy Whitcroft } 37220a920b5bSAndy Whitcroft } 37230a920b5bSAndy Whitcroft 3724653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3725653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3726cf655043SAndy Whitcroft# in a known good container 3727b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3728b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3729d8aaf121SAndy Whitcroft my $ln = $linenr; 3730d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3731c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3732c45dcabdSAndy Whitcroft my $ctx = ''; 3733c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3734f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3735f74bd194SAndy Whitcroft $ctx = $dstat; 3736c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3737a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3738c45dcabdSAndy Whitcroft 3739f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3740292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3741c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3742c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3743c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3744c45dcabdSAndy Whitcroft 3745c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3746bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3747bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3748c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3749bf30d6edSAndy Whitcroft { 3750c45dcabdSAndy Whitcroft } 3751c45dcabdSAndy Whitcroft 3752e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3753e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3754e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3755e45bab8eSAndy Whitcroft { 3756e45bab8eSAndy Whitcroft } 3757e45bab8eSAndy Whitcroft 3758c45dcabdSAndy Whitcroft my $exceptions = qr{ 3759c45dcabdSAndy Whitcroft $Declare| 3760c45dcabdSAndy Whitcroft module_param_named| 3761a0a0a7a9SKees Cook MODULE_PARM_DESC| 3762c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3763c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3764383099fdSAndy Whitcroft __typeof__\(| 376522fd2d3eSStefani Seibold union| 376622fd2d3eSStefani Seibold struct| 3767ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3768ea71a0a0SAndy Whitcroft ^\"|\"$ 3769c45dcabdSAndy Whitcroft }x; 37705eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3771f74bd194SAndy Whitcroft if ($dstat ne '' && 3772f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3773f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 37743cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3775b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3776f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3777f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3778e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 377972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3780f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3781f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3782f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3783f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3784f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3785c45dcabdSAndy Whitcroft { 3786f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3787f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3788f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3789f74bd194SAndy Whitcroft 3790f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3791f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3792c45dcabdSAndy Whitcroft } 3793c45dcabdSAndy Whitcroft 3794f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3795f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3796f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3797f74bd194SAndy Whitcroft } else { 3798000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3799f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3800d8aaf121SAndy Whitcroft } 38010a920b5bSAndy Whitcroft } 38025023d347SJoe Perches 3803481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 38045023d347SJoe Perches 38055023d347SJoe Perches } else { 38065023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3807481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3808481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 38095023d347SJoe Perches $line =~ /^\+.*\\$/) { 38105023d347SJoe Perches WARN("LINE_CONTINUATIONS", 38115023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 38125023d347SJoe Perches } 3813653d4876SAndy Whitcroft } 38140a920b5bSAndy Whitcroft 3815b13edf7fSJoe Perches# do {} while (0) macro tests: 3816b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3817b13edf7fSJoe Perches# macro should not end with a semicolon 3818b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3819b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3820b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3821b13edf7fSJoe Perches my $ln = $linenr; 3822b13edf7fSJoe Perches my $cnt = $realcnt; 3823b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3824b13edf7fSJoe Perches my $ctx = ''; 3825b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3826b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3827b13edf7fSJoe Perches $ctx = $dstat; 3828b13edf7fSJoe Perches 3829b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3830b13edf7fSJoe Perches 3831b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3832b13edf7fSJoe Perches my $stmts = $2; 3833b13edf7fSJoe Perches my $semis = $3; 3834b13edf7fSJoe Perches 3835b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3836b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3837b13edf7fSJoe Perches my $herectx = $here . "\n"; 3838b13edf7fSJoe Perches 3839b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3840b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3841b13edf7fSJoe Perches } 3842b13edf7fSJoe Perches 3843ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3844ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3845b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3846b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3847b13edf7fSJoe Perches } 3848b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3849b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3850b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3851b13edf7fSJoe Perches } 3852f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 3853f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 3854f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 3855f5ef95b1SJoe Perches my $herectx = $here . "\n"; 3856f5ef95b1SJoe Perches 3857f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3858f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3859f5ef95b1SJoe Perches } 3860f5ef95b1SJoe Perches 3861f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 3862f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 3863b13edf7fSJoe Perches } 3864b13edf7fSJoe Perches } 3865b13edf7fSJoe Perches 3866080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3867080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3868080ba929SMike Frysinger# . 3869080ba929SMike Frysinger# ALIGN(...) 3870080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3871080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3872000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3873000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3874080ba929SMike Frysinger } 3875080ba929SMike Frysinger 3876f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 387713214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 387813214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3879cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 388013214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3881cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3882cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3883aad4f614SJoe Perches my @allowed = (); 3884aad4f614SJoe Perches my $allow = 0; 388513214adfSAndy Whitcroft my $seen = 0; 3886773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3887cf655043SAndy Whitcroft my $ln = $linenr - 1; 388813214adfSAndy Whitcroft for my $chunk (@chunks) { 388913214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 389013214adfSAndy Whitcroft 3891773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3892773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3893773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3894773647a0SAndy Whitcroft 3895aad4f614SJoe Perches $allowed[$allow] = 0; 3896773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3897773647a0SAndy Whitcroft 3898773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3899773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3900773647a0SAndy Whitcroft 3901773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3902cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3903cf655043SAndy Whitcroft 3904773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 390513214adfSAndy Whitcroft 390613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 390713214adfSAndy Whitcroft 3908aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3909cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3910cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3911aad4f614SJoe Perches $allowed[$allow] = 1; 391213214adfSAndy Whitcroft } 391313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3914cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3915aad4f614SJoe Perches $allowed[$allow] = 1; 391613214adfSAndy Whitcroft } 3917cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3918cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3919aad4f614SJoe Perches $allowed[$allow] = 1; 392013214adfSAndy Whitcroft } 3921aad4f614SJoe Perches $allow++; 392213214adfSAndy Whitcroft } 3923aad4f614SJoe Perches if ($seen) { 3924aad4f614SJoe Perches my $sum_allowed = 0; 3925aad4f614SJoe Perches foreach (@allowed) { 3926aad4f614SJoe Perches $sum_allowed += $_; 3927aad4f614SJoe Perches } 3928aad4f614SJoe Perches if ($sum_allowed == 0) { 3929000d1cc1SJoe Perches WARN("BRACES", 3930000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3931aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3932aad4f614SJoe Perches $seen != $allow) { 3933aad4f614SJoe Perches CHK("BRACES", 3934aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3935aad4f614SJoe Perches } 393613214adfSAndy Whitcroft } 393713214adfSAndy Whitcroft } 393813214adfSAndy Whitcroft } 3939773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 394013214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3941cf655043SAndy Whitcroft my $allowed = 0; 3942f0a594c1SAndy Whitcroft 3943cf655043SAndy Whitcroft # Check the pre-context. 3944cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3945cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3946cf655043SAndy Whitcroft $allowed = 1; 3947f0a594c1SAndy Whitcroft } 3948773647a0SAndy Whitcroft 3949773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3950773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3951773647a0SAndy Whitcroft 3952cf655043SAndy Whitcroft # Check the condition. 3953cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3954773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3955cf655043SAndy Whitcroft if (defined $cond) { 3956773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3957cf655043SAndy Whitcroft } 3958cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3959cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3960cf655043SAndy Whitcroft $allowed = 1; 3961cf655043SAndy Whitcroft } 3962cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3963cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3964cf655043SAndy Whitcroft $allowed = 1; 3965cf655043SAndy Whitcroft } 3966cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3967cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3968cf655043SAndy Whitcroft $allowed = 1; 3969cf655043SAndy Whitcroft } 3970cf655043SAndy Whitcroft # Check the post-context. 3971cf655043SAndy Whitcroft if (defined $chunks[1]) { 3972cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3973cf655043SAndy Whitcroft if (defined $cond) { 3974773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3975cf655043SAndy Whitcroft } 3976cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3977cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3978cf655043SAndy Whitcroft $allowed = 1; 3979cf655043SAndy Whitcroft } 3980cf655043SAndy Whitcroft } 3981cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 398269932487SJustin P. Mattock my $herectx = $here . "\n"; 3983f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3984cf655043SAndy Whitcroft 3985f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 398669932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3987cf655043SAndy Whitcroft } 3988cf655043SAndy Whitcroft 3989000d1cc1SJoe Perches WARN("BRACES", 3990000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3991f0a594c1SAndy Whitcroft } 3992f0a594c1SAndy Whitcroft } 3993f0a594c1SAndy Whitcroft 39940979ae66SJoe Perches# check for unnecessary blank lines around braces 399577b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 39960979ae66SJoe Perches CHK("BRACES", 39970979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 39980979ae66SJoe Perches } 399977b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 40000979ae66SJoe Perches CHK("BRACES", 40010979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 40020979ae66SJoe Perches } 40030979ae66SJoe Perches 40044a0df2efSAndy Whitcroft# no volatiles please 40056c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 40066c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4007000d1cc1SJoe Perches WARN("VOLATILE", 4008000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 40094a0df2efSAndy Whitcroft } 40104a0df2efSAndy Whitcroft 401100df344fSAndy Whitcroft# warn about #if 0 4012c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4013000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4014000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4015de7d4f0eSAndy Whitcroft $herecurr); 40164a0df2efSAndy Whitcroft } 40174a0df2efSAndy Whitcroft 401803df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 401903df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 402003df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 402103df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 402203df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 402303df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 40244c432a8fSGreg Kroah-Hartman } 40254c432a8fSGreg Kroah-Hartman } 4026f0a594c1SAndy Whitcroft 4027ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4028ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4029ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4030ebfdc409SJoe Perches (defined $1 || defined $3) && 4031ebfdc409SJoe Perches $linenr > 3) { 4032ebfdc409SJoe Perches my $testval = $2; 4033ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4034ebfdc409SJoe Perches 4035ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4036ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4037ebfdc409SJoe Perches 4038ebfdc409SJoe Perches if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) { 4039ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4040ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4041ebfdc409SJoe Perches } 4042ebfdc409SJoe Perches } 4043ebfdc409SJoe Perches 40448716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 40458716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 40468716de38SJoe Perches my $attr = $1; 40478716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 40488716de38SJoe Perches my $ptr = $1; 40498716de38SJoe Perches my $var = $2; 40508716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 40518716de38SJoe Perches ERROR("MISPLACED_INIT", 40528716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 40538716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 40548716de38SJoe Perches WARN("MISPLACED_INIT", 40558716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 40568716de38SJoe Perches $fix) { 40578716de38SJoe 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; 40588716de38SJoe Perches } 40598716de38SJoe Perches } 40608716de38SJoe Perches } 40618716de38SJoe Perches 4062e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4063e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4064e970b884SJoe Perches my $attr = $1; 4065e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4066e970b884SJoe Perches my $attr_prefix = $1; 4067e970b884SJoe Perches my $attr_type = $2; 4068e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4069e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4070e970b884SJoe Perches $fix) { 4071e970b884SJoe Perches $fixed[$linenr - 1] =~ 4072e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4073e970b884SJoe Perches } 4074e970b884SJoe Perches } 4075e970b884SJoe Perches 4076e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4077e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4078e970b884SJoe Perches my $attr = $1; 4079e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4080e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4081e970b884SJoe Perches $fix) { 4082e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 4083e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4084e970b884SJoe Perches $lead = rtrim($1); 4085e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4086e970b884SJoe Perches $lead = "${lead}const "; 4087e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 4088e970b884SJoe Perches } 4089e970b884SJoe Perches } 4090e970b884SJoe Perches 4091fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4092fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4093fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4094fbdb8138SJoe Perches my $constant_func = $1; 4095fbdb8138SJoe Perches my $func = $constant_func; 4096fbdb8138SJoe Perches $func =~ s/^__constant_//; 4097fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4098fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4099fbdb8138SJoe Perches $fix) { 4100fbdb8138SJoe Perches $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g; 4101fbdb8138SJoe Perches } 4102fbdb8138SJoe Perches } 4103fbdb8138SJoe Perches 41041a15a250SPatrick Pannuto# prefer usleep_range over udelay 410537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 410643c1d77cSJoe Perches my $delay = $1; 41071a15a250SPatrick Pannuto # ignore udelay's < 10, however 410843c1d77cSJoe Perches if (! ($delay < 10) ) { 4109000d1cc1SJoe Perches CHK("USLEEP_RANGE", 411043c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 411143c1d77cSJoe Perches } 411243c1d77cSJoe Perches if ($delay > 2000) { 411343c1d77cSJoe Perches WARN("LONG_UDELAY", 411443c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 41151a15a250SPatrick Pannuto } 41161a15a250SPatrick Pannuto } 41171a15a250SPatrick Pannuto 411809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 411909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 412009ef8725SPatrick Pannuto if ($1 < 20) { 4121000d1cc1SJoe Perches WARN("MSLEEP", 412243c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 412309ef8725SPatrick Pannuto } 412409ef8725SPatrick Pannuto } 412509ef8725SPatrick Pannuto 412636ec1939SJoe Perches# check for comparisons of jiffies 412736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 412836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 412936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 413036ec1939SJoe Perches } 413136ec1939SJoe Perches 41329d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 41339d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 41349d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 41359d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 41369d7a34a5SJoe Perches } 41379d7a34a5SJoe Perches 413800df344fSAndy Whitcroft# warn about #ifdefs in C files 4139c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 414000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 414100df344fSAndy Whitcroft# print "$herecurr"; 414200df344fSAndy Whitcroft# $clean = 0; 414300df344fSAndy Whitcroft# } 414400df344fSAndy Whitcroft 414522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4146c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 41473705ce5bSJoe Perches if (ERROR("SPACING", 41483705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 41493705ce5bSJoe Perches $fix) { 41503705ce5bSJoe Perches $fixed[$linenr - 1] =~ 41513705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 41523705ce5bSJoe Perches } 41533705ce5bSJoe Perches 415422f2a2efSAndy Whitcroft } 415522f2a2efSAndy Whitcroft 41564a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4157171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4158171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 41594a0df2efSAndy Whitcroft my $which = $1; 41604a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4161000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4162000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 41634a0df2efSAndy Whitcroft } 41644a0df2efSAndy Whitcroft } 41654a0df2efSAndy Whitcroft# check for memory barriers without a comment. 41664a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 41674a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4168c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4169000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 41704a0df2efSAndy Whitcroft } 41714a0df2efSAndy Whitcroft } 41724a0df2efSAndy Whitcroft# check of hardware specific defines 4173c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4174000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4175000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 41760a920b5bSAndy Whitcroft } 4177653d4876SAndy Whitcroft 4178d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4179d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4180000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4181000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4182d4977c78STobias Klauser } 4183d4977c78STobias Klauser 4184de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4185de7d4f0eSAndy Whitcroft# storage class and type. 41869c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 41879c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4188000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4189000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4190de7d4f0eSAndy Whitcroft } 4191de7d4f0eSAndy Whitcroft 41928905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 41932b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41942b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4195d5e616fcSJoe Perches if (WARN("INLINE", 4196d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4197d5e616fcSJoe Perches $fix) { 4198d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 4199d5e616fcSJoe Perches 4200d5e616fcSJoe Perches } 42018905a67cSAndy Whitcroft } 42028905a67cSAndy Whitcroft 42033d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 42042b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42052b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4206000d1cc1SJoe Perches WARN("PREFER_PACKED", 4207000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 42083d130fd0SJoe Perches } 42093d130fd0SJoe Perches 421039b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 42112b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42122b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4213000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4214000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 421539b7e287SJoe Perches } 421639b7e287SJoe Perches 42175f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 42182b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42192b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4220d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4221d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4222d5e616fcSJoe Perches $fix) { 4223d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4224d5e616fcSJoe Perches 4225d5e616fcSJoe Perches } 42265f14d3bdSJoe Perches } 42275f14d3bdSJoe Perches 42286061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 42292b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42302b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4231d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4232d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4233d5e616fcSJoe Perches $fix) { 4234d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4235d5e616fcSJoe Perches } 42366061d949SJoe Perches } 42376061d949SJoe Perches 42388f53a9b8SJoe Perches# check for sizeof(&) 42398f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4240000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4241000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 42428f53a9b8SJoe Perches } 42438f53a9b8SJoe Perches 424466c80b60SJoe Perches# check for sizeof without parenthesis 424566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4246d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4247d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4248d5e616fcSJoe Perches $fix) { 4249d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4250d5e616fcSJoe Perches } 425166c80b60SJoe Perches } 425266c80b60SJoe Perches 4253428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4254428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4255000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4256000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4257428e2fdcSJoe Perches } 4258428e2fdcSJoe Perches 425988982feaSJoe Perches# check for struct spinlock declarations 426088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 426188982feaSJoe Perches WARN("USE_SPINLOCK_T", 426288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 426388982feaSJoe Perches } 426488982feaSJoe Perches 4265a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 426606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4267a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 426806668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4269d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4270d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4271d5e616fcSJoe Perches $fix) { 4272d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 4273d5e616fcSJoe Perches } 4274a6962d72SJoe Perches } 4275a6962d72SJoe Perches } 4276a6962d72SJoe Perches 4277554e165cSAndy Whitcroft# Check for misused memsets 4278d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4279d1fe9c09SJoe Perches defined $stat && 4280d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4281554e165cSAndy Whitcroft 4282d7c76ba7SJoe Perches my $ms_addr = $2; 4283d1fe9c09SJoe Perches my $ms_val = $7; 4284d1fe9c09SJoe Perches my $ms_size = $12; 4285d7c76ba7SJoe Perches 4286554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4287554e165cSAndy Whitcroft ERROR("MEMSET", 4288d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4289554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4290554e165cSAndy Whitcroft WARN("MEMSET", 4291d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4292d7c76ba7SJoe Perches } 4293d7c76ba7SJoe Perches } 4294d7c76ba7SJoe Perches 429598a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 429698a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 429798a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 429898a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 429998a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 430098a9bba5SJoe Perches $fix) { 430198a9bba5SJoe Perches $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 430298a9bba5SJoe Perches } 430398a9bba5SJoe Perches } 430498a9bba5SJoe Perches 4305d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4306d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4307d1fe9c09SJoe Perches defined $stat && 4308d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4309d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4310d7c76ba7SJoe Perches my $call = $1; 4311d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4312d7c76ba7SJoe Perches my $arg1 = $3; 4313d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4314d1fe9c09SJoe Perches my $arg2 = $8; 4315d7c76ba7SJoe Perches my $cast; 4316d7c76ba7SJoe Perches 4317d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4318d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4319d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4320d7c76ba7SJoe Perches $cast = $cast1; 4321d7c76ba7SJoe Perches } else { 4322d7c76ba7SJoe Perches $cast = $cast2; 4323d7c76ba7SJoe Perches } 4324d7c76ba7SJoe Perches WARN("MINMAX", 4325d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4326554e165cSAndy Whitcroft } 4327554e165cSAndy Whitcroft } 4328554e165cSAndy Whitcroft 43294a273195SJoe Perches# check usleep_range arguments 43304a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 43314a273195SJoe Perches defined $stat && 43324a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 43334a273195SJoe Perches my $min = $1; 43344a273195SJoe Perches my $max = $7; 43354a273195SJoe Perches if ($min eq $max) { 43364a273195SJoe Perches WARN("USLEEP_RANGE", 43374a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 43384a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 43394a273195SJoe Perches $min > $max) { 43404a273195SJoe Perches WARN("USLEEP_RANGE", 43414a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 43424a273195SJoe Perches } 43434a273195SJoe Perches } 43444a273195SJoe Perches 4345823b794cSJoe Perches# check for naked sscanf 4346823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4347823b794cSJoe Perches defined $stat && 43486c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4349823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4350823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4351823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4352823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4353823b794cSJoe Perches $lc = $lc + $linenr; 4354823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4355823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4356823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4357823b794cSJoe Perches } 4358823b794cSJoe Perches WARN("NAKED_SSCANF", 4359823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4360823b794cSJoe Perches } 4361823b794cSJoe Perches 4362afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 4363afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 4364afc819abSJoe Perches defined $stat && 4365afc819abSJoe Perches $line =~ /\bsscanf\b/) { 4366afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 4367afc819abSJoe Perches $lc = $lc + $linenr; 4368afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 4369afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4370afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4371afc819abSJoe Perches } 4372afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 4373afc819abSJoe Perches my $format = $6; 4374afc819abSJoe Perches my $count = $format =~ tr@%@%@; 4375afc819abSJoe Perches if ($count == 1 && 4376afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 4377afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 4378afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 4379afc819abSJoe Perches } 4380afc819abSJoe Perches } 4381afc819abSJoe Perches } 4382afc819abSJoe Perches 438370dc8a48SJoe Perches# check for new externs in .h files. 438470dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 438570dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4386d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 438770dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 438870dc8a48SJoe Perches $fix) { 438970dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 439070dc8a48SJoe Perches } 439170dc8a48SJoe Perches } 439270dc8a48SJoe Perches 4393de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4394171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4395c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4396171ae1a4SAndy Whitcroft { 4397c45dcabdSAndy Whitcroft my $function_name = $1; 4398c45dcabdSAndy Whitcroft my $paren_space = $2; 4399171ae1a4SAndy Whitcroft 4400171ae1a4SAndy Whitcroft my $s = $stat; 4401171ae1a4SAndy Whitcroft if (defined $cond) { 4402171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4403171ae1a4SAndy Whitcroft } 4404c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4405c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4406c45dcabdSAndy Whitcroft { 4407000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4408000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4409de7d4f0eSAndy Whitcroft } 4410de7d4f0eSAndy Whitcroft 4411171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4412000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4413000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4414171ae1a4SAndy Whitcroft } 44159c9ba34eSAndy Whitcroft 44169c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 44179c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 44189c9ba34eSAndy Whitcroft { 4419000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4420000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4421171ae1a4SAndy Whitcroft } 4422171ae1a4SAndy Whitcroft 4423de7d4f0eSAndy Whitcroft# checks for new __setup's 4424de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4425de7d4f0eSAndy Whitcroft my $name = $1; 4426de7d4f0eSAndy Whitcroft 4427de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4428000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4429000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4430de7d4f0eSAndy Whitcroft } 4431653d4876SAndy Whitcroft } 44329c0ca6f9SAndy Whitcroft 44339c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4434caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4435000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4436000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 44379c0ca6f9SAndy Whitcroft } 443813214adfSAndy Whitcroft 4439a640d25cSJoe Perches# alloc style 4440a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4441a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4442a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4443a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4444a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4445a640d25cSJoe Perches } 4446a640d25cSJoe Perches 444760a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 444860a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 444960a55369SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) { 445060a55369SJoe Perches my $oldfunc = $3; 445160a55369SJoe Perches my $a1 = $4; 445260a55369SJoe Perches my $a2 = $10; 445360a55369SJoe Perches my $newfunc = "kmalloc_array"; 445460a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 445560a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) { 445660a55369SJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 445760a55369SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 445860a55369SJoe Perches $fix) { 445960a55369SJoe Perches my $r1 = $a1; 446060a55369SJoe Perches my $r2 = $a2; 446160a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 446260a55369SJoe Perches $r1 = $a2; 446360a55369SJoe Perches $r2 = $a1; 446460a55369SJoe Perches } 446560a55369SJoe Perches $fixed[$linenr - 1] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 446660a55369SJoe Perches 446760a55369SJoe Perches } 446860a55369SJoe Perches } 446960a55369SJoe Perches } 447060a55369SJoe Perches 4471972fdea2SJoe Perches# check for krealloc arg reuse 4472972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4473972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4474972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4475972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4476972fdea2SJoe Perches } 4477972fdea2SJoe Perches 44785ce59ae0SJoe Perches# check for alloc argument mismatch 44795ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 44805ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 44815ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 44825ce59ae0SJoe Perches } 44835ce59ae0SJoe Perches 4484caf2a54fSJoe Perches# check for multiple semicolons 4485caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4486d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4487d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4488d5e616fcSJoe Perches $fix) { 4489d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4490d5e616fcSJoe Perches } 4491d1e2ad07SJoe Perches } 4492d1e2ad07SJoe Perches 4493c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4494c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4495c34c09a8SJoe Perches my $has_break = 0; 4496c34c09a8SJoe Perches my $has_statement = 0; 4497c34c09a8SJoe Perches my $count = 0; 4498c34c09a8SJoe Perches my $prevline = $linenr; 4499c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4500c34c09a8SJoe Perches $prevline--; 4501c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4502c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4503c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4504c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4505c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4506c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4507c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4508c34c09a8SJoe Perches $has_statement = 1; 4509c34c09a8SJoe Perches $count++; 4510c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4511c34c09a8SJoe Perches } 4512c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4513c34c09a8SJoe Perches WARN("MISSING_BREAK", 4514c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4515c34c09a8SJoe Perches } 4516c34c09a8SJoe Perches } 4517c34c09a8SJoe Perches 4518d1e2ad07SJoe Perches# check for switch/default statements without a break; 4519d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4520d1e2ad07SJoe Perches defined $stat && 4521d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4522d1e2ad07SJoe Perches my $ctx = ''; 4523d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4524d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4525d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4526d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4527d1e2ad07SJoe Perches } 4528d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4529d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4530caf2a54fSJoe Perches } 4531caf2a54fSJoe Perches 453213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4533d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4534d5e616fcSJoe Perches if (WARN("USE_FUNC", 4535d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4536d5e616fcSJoe Perches $fix) { 4537d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4538d5e616fcSJoe Perches } 453913214adfSAndy Whitcroft } 4540773647a0SAndy Whitcroft 45412c92488aSJoe Perches# check for use of yield() 45422c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 45432c92488aSJoe Perches WARN("YIELD", 45442c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 45452c92488aSJoe Perches } 45462c92488aSJoe Perches 4547179f8f40SJoe Perches# check for comparisons against true and false 4548179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4549179f8f40SJoe Perches my $lead = $1; 4550179f8f40SJoe Perches my $arg = $2; 4551179f8f40SJoe Perches my $test = $3; 4552179f8f40SJoe Perches my $otype = $4; 4553179f8f40SJoe Perches my $trail = $5; 4554179f8f40SJoe Perches my $op = "!"; 4555179f8f40SJoe Perches 4556179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4557179f8f40SJoe Perches 4558179f8f40SJoe Perches my $type = lc($otype); 4559179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4560179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4561179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4562179f8f40SJoe Perches $op = ""; 4563179f8f40SJoe Perches } 4564179f8f40SJoe Perches 4565179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4566179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4567179f8f40SJoe Perches 4568179f8f40SJoe Perches## maybe suggesting a correct construct would better 4569179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4570179f8f40SJoe Perches 4571179f8f40SJoe Perches } 4572179f8f40SJoe Perches } 4573179f8f40SJoe Perches 45744882720bSThomas Gleixner# check for semaphores initialized locked 45754882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4576000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4577000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4578773647a0SAndy Whitcroft } 45796712d858SJoe Perches 458067d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 458167d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4582000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 458367d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4584773647a0SAndy Whitcroft } 45856712d858SJoe Perches 4586ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 4587f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4588000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4589ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 4590f3db6639SMichael Ellerman } 45916712d858SJoe Perches 459279404849SEmese Revfy# check for various ops structs, ensure they are const. 459379404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 459479404849SEmese Revfy address_space_operations| 459579404849SEmese Revfy backlight_ops| 459679404849SEmese Revfy block_device_operations| 459779404849SEmese Revfy dentry_operations| 459879404849SEmese Revfy dev_pm_ops| 459979404849SEmese Revfy dma_map_ops| 460079404849SEmese Revfy extent_io_ops| 460179404849SEmese Revfy file_lock_operations| 460279404849SEmese Revfy file_operations| 460379404849SEmese Revfy hv_ops| 460479404849SEmese Revfy ide_dma_ops| 460579404849SEmese Revfy intel_dvo_dev_ops| 460679404849SEmese Revfy item_operations| 460779404849SEmese Revfy iwl_ops| 460879404849SEmese Revfy kgdb_arch| 460979404849SEmese Revfy kgdb_io| 461079404849SEmese Revfy kset_uevent_ops| 461179404849SEmese Revfy lock_manager_operations| 461279404849SEmese Revfy microcode_ops| 461379404849SEmese Revfy mtrr_ops| 461479404849SEmese Revfy neigh_ops| 461579404849SEmese Revfy nlmsvc_binding| 461679404849SEmese Revfy pci_raw_ops| 461779404849SEmese Revfy pipe_buf_operations| 461879404849SEmese Revfy platform_hibernation_ops| 461979404849SEmese Revfy platform_suspend_ops| 462079404849SEmese Revfy proto_ops| 462179404849SEmese Revfy rpc_pipe_ops| 462279404849SEmese Revfy seq_operations| 462379404849SEmese Revfy snd_ac97_build_ops| 462479404849SEmese Revfy soc_pcmcia_socket_ops| 462579404849SEmese Revfy stacktrace_ops| 462679404849SEmese Revfy sysfs_ops| 462779404849SEmese Revfy tty_operations| 462879404849SEmese Revfy usb_mon_operations| 462979404849SEmese Revfy wd_ops}x; 46306903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 463179404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4632000d1cc1SJoe Perches WARN("CONST_STRUCT", 4633000d1cc1SJoe Perches "struct $1 should normally be const\n" . 46346903ffb2SAndy Whitcroft $herecurr); 46352b6db5cbSAndy Whitcroft } 4636773647a0SAndy Whitcroft 4637773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4638773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4639773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4640c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4641c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4642171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4643171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4644171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4645773647a0SAndy Whitcroft { 4646000d1cc1SJoe Perches WARN("NR_CPUS", 4647000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4648773647a0SAndy Whitcroft } 46499c9ba34eSAndy Whitcroft 465052ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 465152ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 465252ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 465352ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 465452ea8506SJoe Perches } 465552ea8506SJoe Perches 46569c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 46579c9ba34eSAndy Whitcroft my $string; 46589c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 46599c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 46602a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 46619c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4662000d1cc1SJoe Perches WARN("PRINTF_L", 4663000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 46649c9ba34eSAndy Whitcroft last; 46659c9ba34eSAndy Whitcroft } 46669c9ba34eSAndy Whitcroft } 4667691d77b6SAndy Whitcroft 4668691d77b6SAndy Whitcroft# whine mightly about in_atomic 4669691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4670691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4671000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4672000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4673f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4674000d1cc1SJoe Perches WARN("IN_ATOMIC", 4675000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4676691d77b6SAndy Whitcroft } 4677691d77b6SAndy Whitcroft } 46781704f47bSPeter Zijlstra 46791704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 46801704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 46811704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 46821704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 46831704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 46841704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4685000d1cc1SJoe Perches ERROR("LOCKDEP", 4686000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 46871704f47bSPeter Zijlstra } 46881704f47bSPeter Zijlstra } 468988f8831cSDave Jones 469088f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 469188f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4692000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4693000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 469488f8831cSDave Jones } 46952435880fSJoe Perches 4696515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 4697515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 4698515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 4699515a235eSJoe Perches $line =~ /$mode_perms_search/) { 47002435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 47012435880fSJoe Perches my $func = $entry->[0]; 47022435880fSJoe Perches my $arg_pos = $entry->[1]; 47032435880fSJoe Perches 47042435880fSJoe Perches my $skip_args = ""; 47052435880fSJoe Perches if ($arg_pos > 1) { 47062435880fSJoe Perches $arg_pos--; 47072435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 47082435880fSJoe Perches } 47092435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 4710515a235eSJoe Perches if ($line =~ /$test/) { 47112435880fSJoe Perches my $val = $1; 47122435880fSJoe Perches $val = $6 if ($skip_args ne ""); 47132435880fSJoe Perches 47141727cc70SJoe Perches if ($val !~ /^0$/ && 47151727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 47161727cc70SJoe Perches length($val) ne 4)) { 47172435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 47181727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 47192435880fSJoe Perches } 47202435880fSJoe Perches } 47212435880fSJoe Perches } 472213214adfSAndy Whitcroft } 4723515a235eSJoe Perches } 472413214adfSAndy Whitcroft 472513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 472613214adfSAndy Whitcroft # so just keep quiet. 472713214adfSAndy Whitcroft if ($#rawlines == -1) { 472813214adfSAndy Whitcroft exit(0); 47290a920b5bSAndy Whitcroft } 47300a920b5bSAndy Whitcroft 47318905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 47328905a67cSAndy Whitcroft # things that appear to be patches. 47338905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 47348905a67cSAndy Whitcroft exit(0); 47358905a67cSAndy Whitcroft } 47368905a67cSAndy Whitcroft 47378905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 47388905a67cSAndy Whitcroft # just keep quiet. 47398905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 47408905a67cSAndy Whitcroft exit(0); 47418905a67cSAndy Whitcroft } 47428905a67cSAndy Whitcroft 47438905a67cSAndy Whitcroft if (!$is_patch) { 4744000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4745000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 47460a920b5bSAndy Whitcroft } 47470a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4748000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4749000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 47500a920b5bSAndy Whitcroft } 47510a920b5bSAndy Whitcroft 4752f0a594c1SAndy Whitcroft print report_dump(); 475313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 475413214adfSAndy Whitcroft print "$filename " if ($summary_file); 47556c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 47566c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 47576c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 47588905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 47596c72ffaaSAndy Whitcroft } 47608905a67cSAndy Whitcroft 4761d2c0a235SAndy Whitcroft if ($quiet == 0) { 4762d1fe9c09SJoe Perches 4763d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4764d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4765d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4766d1fe9c09SJoe Perches } 4767d1fe9c09SJoe Perches 4768d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4769d2c0a235SAndy Whitcroft # then suggest that. 4770d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4771d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4772d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4773b0781216SMike Frysinger $rpt_cleaners = 0; 4774d2c0a235SAndy Whitcroft } 4775d2c0a235SAndy Whitcroft } 4776d2c0a235SAndy Whitcroft 477791bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 477891bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4779000d1cc1SJoe Perches 47803705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 47819624b8d6SJoe Perches my $newfile = $filename; 47829624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 47833705ce5bSJoe Perches my $linecount = 0; 47843705ce5bSJoe Perches my $f; 47853705ce5bSJoe Perches 47863705ce5bSJoe Perches open($f, '>', $newfile) 47873705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 47883705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 47893705ce5bSJoe Perches $linecount++; 47903705ce5bSJoe Perches if ($file) { 47913705ce5bSJoe Perches if ($linecount > 3) { 47923705ce5bSJoe Perches $fixed_line =~ s/^\+//; 47933705ce5bSJoe Perches print $f $fixed_line. "\n"; 47943705ce5bSJoe Perches } 47953705ce5bSJoe Perches } else { 47963705ce5bSJoe Perches print $f $fixed_line . "\n"; 47973705ce5bSJoe Perches } 47983705ce5bSJoe Perches } 47993705ce5bSJoe Perches close($f); 48003705ce5bSJoe Perches 48013705ce5bSJoe Perches if (!$quiet) { 48023705ce5bSJoe Perches print << "EOM"; 48033705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 48043705ce5bSJoe Perches 48053705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 48063705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 48073705ce5bSJoe Perches 48083705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 48093705ce5bSJoe PerchesNo warranties, expressed or implied... 48103705ce5bSJoe Perches 48113705ce5bSJoe PerchesEOM 48123705ce5bSJoe Perches } 48133705ce5bSJoe Perches } 48143705ce5bSJoe Perches 48150a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4816c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 48170a920b5bSAndy Whitcroft } 48180a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4819000d1cc1SJoe Perches print << "EOM"; 4820000d1cc1SJoe Perches$vname has style problems, please review. 4821000d1cc1SJoe Perches 4822000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4823000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4824000d1cc1SJoe PerchesEOM 48250a920b5bSAndy Whitcroft } 482613214adfSAndy Whitcroft 48270a920b5bSAndy Whitcroft return $clean; 48280a920b5bSAndy Whitcroft} 4829