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 164029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 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 =~ /^$/ && 199629ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 199729ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 199815662b3eSJoe Perches $in_header_lines = 0; 199915662b3eSJoe Perches $in_commit_log = 1; 200015662b3eSJoe Perches } 200115662b3eSJoe Perches 2002fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2003fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2004fa64205dSPasi Savanainen if ($in_header_lines && 2005fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2006fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2007fa64205dSPasi Savanainen $non_utf8_charset = 1; 2008fa64205dSPasi Savanainen } 2009fa64205dSPasi Savanainen 2010fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 201115662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2012fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 201315662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 201415662b3eSJoe Perches } 201515662b3eSJoe Perches 201630670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 201730670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 201800df344fSAndy Whitcroft 20190a920b5bSAndy Whitcroft#trailing whitespace 20209c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2021c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2022d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2023d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2024d5e616fcSJoe Perches $fix) { 2025d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 2026d5e616fcSJoe Perches } 2027c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2028c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20293705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 20303705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 20313705ce5bSJoe Perches $fix) { 2032d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 20333705ce5bSJoe Perches } 20343705ce5bSJoe Perches 2035d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 20360a920b5bSAndy Whitcroft } 20375368df20SAndy Whitcroft 20384783f894SJosh Triplett# Check for FSF mailing addresses. 2039109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 20403e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 20413e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 20424783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20434783f894SJosh Triplett my $msg_type = \&ERROR; 20444783f894SJosh Triplett $msg_type = \&CHK if ($file); 20454783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 20464783f894SJosh 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) 20474783f894SJosh Triplett } 20484783f894SJosh Triplett 20493354957aSAndi Kleen# check for Kconfig help text having a real description 20509fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 20519fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 20523354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2053a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 20543354957aSAndi Kleen my $length = 0; 20559fe287d7SAndy Whitcroft my $cnt = $realcnt; 20569fe287d7SAndy Whitcroft my $ln = $linenr + 1; 20579fe287d7SAndy Whitcroft my $f; 2058a1385803SAndy Whitcroft my $is_start = 0; 20599fe287d7SAndy Whitcroft my $is_end = 0; 2060a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 20619fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 20629fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 20639fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 20649fe287d7SAndy Whitcroft 20659fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2066a1385803SAndy Whitcroft 2067a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2068a1385803SAndy Whitcroft $is_start = 1; 2069a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2070a1385803SAndy Whitcroft $length = -1; 2071a1385803SAndy Whitcroft } 2072a1385803SAndy Whitcroft 20739fe287d7SAndy Whitcroft $f =~ s/^.//; 20743354957aSAndi Kleen $f =~ s/#.*//; 20753354957aSAndi Kleen $f =~ s/^\s+//; 20763354957aSAndi Kleen next if ($f =~ /^$/); 20779fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20789fe287d7SAndy Whitcroft $is_end = 1; 20799fe287d7SAndy Whitcroft last; 20809fe287d7SAndy Whitcroft } 20813354957aSAndi Kleen $length++; 20823354957aSAndi Kleen } 2083000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2084a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2085a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20863354957aSAndi Kleen } 20873354957aSAndi Kleen 20881ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20891ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20901ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20911ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20921ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20931ba8dfd1SKees Cook } 20941ba8dfd1SKees Cook 2095c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2096c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2097c68e5878SArnaud Lacombe my $flag = $1; 2098c68e5878SArnaud Lacombe my $replacement = { 2099c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2100c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2101c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2102c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2103c68e5878SArnaud Lacombe }; 2104c68e5878SArnaud Lacombe 2105c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2106c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2107c68e5878SArnaud Lacombe } 2108c68e5878SArnaud Lacombe 2109bff5da43SRob Herring# check for DT compatible documentation 21107dd05b38SFlorian Vaussard if (defined $root && 21117dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 21127dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 21137dd05b38SFlorian Vaussard 2114bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2115bff5da43SRob Herring 2116cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2117cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2118cc93319bSFlorian Vaussard 2119bff5da43SRob Herring foreach my $compat (@compats) { 2120bff5da43SRob Herring my $compat2 = $compat; 2121185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2122185d566bSRob Herring my $compat3 = $compat; 2123185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2124185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2125bff5da43SRob Herring if ( $? >> 8 ) { 2126bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2127bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2128bff5da43SRob Herring } 2129bff5da43SRob Herring 21304fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 21314fbf32a6SFlorian Vaussard my $vendor = $1; 2132cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2133bff5da43SRob Herring if ( $? >> 8 ) { 2134bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2135cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2136bff5da43SRob Herring } 2137bff5da43SRob Herring } 2138bff5da43SRob Herring } 2139bff5da43SRob Herring 21405368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 21415368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 21425368df20SAndy Whitcroft 21436cd7f386SJoe Perches#line length limit 2144c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2145f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 21460fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 21478bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 21486cd7f386SJoe Perches $length > $max_line_length) 2149c45dcabdSAndy Whitcroft { 2150000d1cc1SJoe Perches WARN("LONG_LINE", 21516cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 21520a920b5bSAndy Whitcroft } 21530a920b5bSAndy Whitcroft 2154ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 21558c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 21568c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 21578c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2158ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2159ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 21608c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2161ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2162ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2163ca56dc09SJosh Triplett } 2164ca56dc09SJosh Triplett 21655e79d96eSJoe Perches# check for spaces before a quoted newline 21665e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 21673705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 21683705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 21693705ce5bSJoe Perches $fix) { 21703705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 21713705ce5bSJoe Perches } 21723705ce5bSJoe Perches 21735e79d96eSJoe Perches } 21745e79d96eSJoe Perches 21758905a67cSAndy Whitcroft# check for adding lines without a newline. 21768905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2177000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2178000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 21798905a67cSAndy Whitcroft } 21808905a67cSAndy Whitcroft 218142e41c54SMike Frysinger# Blackfin: use hi/lo macros 218242e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 218342e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 218442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2185000d1cc1SJoe Perches ERROR("LO_MACRO", 2186000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 218742e41c54SMike Frysinger } 218842e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 218942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2190000d1cc1SJoe Perches ERROR("HI_MACRO", 2191000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 219242e41c54SMike Frysinger } 219342e41c54SMike Frysinger } 219442e41c54SMike Frysinger 2195b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2196b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21970a920b5bSAndy Whitcroft 21980a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21990a920b5bSAndy Whitcroft# more than 8 must use tabs. 2200c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2201c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2202c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2203d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 22043705ce5bSJoe Perches if (ERROR("CODE_INDENT", 22053705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 22063705ce5bSJoe Perches $fix) { 22073705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22083705ce5bSJoe Perches } 22090a920b5bSAndy Whitcroft } 22100a920b5bSAndy Whitcroft 221108e44365SAlberto Panizzo# check for space before tabs. 221208e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 221308e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22143705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 22153705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 22163705ce5bSJoe Perches $fix) { 2217c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2218c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2219c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2220c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 22213705ce5bSJoe Perches } 222208e44365SAlberto Panizzo } 222308e44365SAlberto Panizzo 2224d1fe9c09SJoe Perches# check for && or || at the start of a line 2225d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2226d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2227d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2228d1fe9c09SJoe Perches } 2229d1fe9c09SJoe Perches 2230d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2231d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 223291cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2233d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2234d1fe9c09SJoe Perches my $oldindent = $1; 2235d1fe9c09SJoe Perches my $rest = $2; 2236d1fe9c09SJoe Perches 2237d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2238d1fe9c09SJoe Perches if ($pos >= 0) { 2239b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2240b34a26f3SJoe Perches my $newindent = $2; 2241d1fe9c09SJoe Perches 2242d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2243d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2244d1fe9c09SJoe Perches " " x ($pos % 8); 2245d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2246d1fe9c09SJoe Perches 2247d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2248d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 22493705ce5bSJoe Perches 22503705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 22513705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 22523705ce5bSJoe Perches $fix && $line =~ /^\+/) { 22533705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22543705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 22553705ce5bSJoe Perches } 2256d1fe9c09SJoe Perches } 2257d1fe9c09SJoe Perches } 2258d1fe9c09SJoe Perches } 2259d1fe9c09SJoe Perches 226023f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 22613705ce5bSJoe Perches if (CHK("SPACING", 22623705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 22633705ce5bSJoe Perches $fix) { 22643705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22653705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 22663705ce5bSJoe Perches } 2267aad4f614SJoe Perches } 2268aad4f614SJoe Perches 226905880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2270fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 227185ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 227285ad978cSJoe Perches $realline > 2) { 227305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 227405880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 227505880600SJoe Perches } 227605880600SJoe Perches 227705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2278a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2279a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 228061135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2281a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2282a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2283a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2284a605e32eSJoe Perches } 2285a605e32eSJoe Perches 2286a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2287c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2288c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2289c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2290c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 229105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 229205880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 229305880600SJoe Perches } 229405880600SJoe Perches 2295*7f619191SJoe Perches# check for missing blank lines after struct/union declarations 2296*7f619191SJoe Perches# with exceptions for various attributes and macros 2297*7f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 2298*7f619191SJoe Perches $line =~ /^\+/ && 2299*7f619191SJoe Perches !($line =~ /^\+\s*$/ || 2300*7f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 2301*7f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 2302*7f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 2303*7f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 2304*7f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 2305*7f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 2306*7f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2307*7f619191SJoe Perches CHK("LINE_SPACING", 2308*7f619191SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev); 2309*7f619191SJoe Perches } 2310*7f619191SJoe Perches 23113b617e3bSJoe Perches# check for missing blank lines after declarations 23123f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 23133f7bac03SJoe Perches # actual declarations 23143f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 23155a4e1fd3SJoe Perches # function pointer declarations 23165a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 23173f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 23183f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 23193f7bac03SJoe Perches # known declaration macros 23203f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 23213f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 23223f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 23233f7bac03SJoe Perches # other possible extensions of declaration lines 23243f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 23253f7bac03SJoe Perches # not starting a section or a macro "\" extended line 23263f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 23273f7bac03SJoe Perches # looks like a declaration 23283f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 23295a4e1fd3SJoe Perches # function pointer declarations 23305a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 23313f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 23323f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 23333f7bac03SJoe Perches # known declaration macros 23343f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 23353f7bac03SJoe Perches # start of struct or union or enum 23363b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 23373f7bac03SJoe Perches # start or end of block or continuation of declaration 23383f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 23393f7bac03SJoe Perches # bitfield continuation 23403f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 23413f7bac03SJoe Perches # other possible extensions of declaration lines 23423f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 23433f7bac03SJoe Perches # indentation of previous and current line are the same 23443f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 23453b617e3bSJoe Perches WARN("SPACING", 23463f7bac03SJoe Perches "Missing a blank line after declarations\n" . $hereprev); 23473b617e3bSJoe Perches } 23483b617e3bSJoe Perches 23495f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 23506b4c5bebSAndy Whitcroft# Exceptions: 23516b4c5bebSAndy Whitcroft# 1) within comments 23526b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 23536b4c5bebSAndy Whitcroft# 3) hanging labels 23543705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 23555f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23563705ce5bSJoe Perches if (WARN("LEADING_SPACE", 23573705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 23583705ce5bSJoe Perches $fix) { 23593705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 23603705ce5bSJoe Perches } 23615f7ddae6SRaffaele Recalcati } 23625f7ddae6SRaffaele Recalcati 2363b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2364b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2365b9ea10d6SAndy Whitcroft 2366032a4c0fSJoe Perches# check indentation of any line with a bare else 2367032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2368032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2369032a4c0fSJoe Perches my $tabs = length($1) + 1; 2370032a4c0fSJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) { 2371032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2372032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2373032a4c0fSJoe Perches } 2374032a4c0fSJoe Perches } 2375032a4c0fSJoe Perches 23761ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 23771ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 23781ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 23791ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 23801ba8dfd1SKees Cook } 23811ba8dfd1SKees Cook 2382c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2383cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2384000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2385000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2386c2fdda0dSAndy Whitcroft } 238722f2a2efSAndy Whitcroft 238842e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 238942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 239042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2391000d1cc1SJoe Perches ERROR("CSYNC", 2392000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 239342e41c54SMike Frysinger } 239442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 239542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2396000d1cc1SJoe Perches ERROR("SSYNC", 2397000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 239842e41c54SMike Frysinger } 239942e41c54SMike Frysinger 240056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 240156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 240256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 240356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 240456e77d70SJoe Perches } 240556e77d70SJoe Perches 24069c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 24072b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 24082b474a1aSAndy Whitcroft $realline_next); 24093e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 24103e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 24111b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2412170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2413f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2414171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2415171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2416171ae1a4SAndy Whitcroft 24173e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 24183e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 24193e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 24203e469cdcSAndy Whitcroft # until we hit end of it. 24213e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 24223e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 24233e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 24243e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 24253e469cdcSAndy Whitcroft } 2426f74bd194SAndy Whitcroft 24272b474a1aSAndy Whitcroft # Find the real next line. 24282b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 24292b474a1aSAndy Whitcroft if (defined $realline_next && 24302b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 24312b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 24322b474a1aSAndy Whitcroft $realline_next++; 24332b474a1aSAndy Whitcroft } 24342b474a1aSAndy Whitcroft 2435171ae1a4SAndy Whitcroft my $s = $stat; 2436171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2437cf655043SAndy Whitcroft 2438c2fdda0dSAndy Whitcroft # Ignore goto labels. 2439171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2440c2fdda0dSAndy Whitcroft 2441c2fdda0dSAndy Whitcroft # Ignore functions being called 2442171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2443c2fdda0dSAndy Whitcroft 2444463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2445463f2864SAndy Whitcroft 2446c45dcabdSAndy Whitcroft # declarations always start with types 2447d2506586SAndy 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) { 2448c45dcabdSAndy Whitcroft my $type = $1; 2449c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2450c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2451c45dcabdSAndy Whitcroft 24526c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2453a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2454c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2455c2fdda0dSAndy Whitcroft } 24568905a67cSAndy Whitcroft 24576c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 245865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2459c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 24609c0ca6f9SAndy Whitcroft } 24618905a67cSAndy Whitcroft 24628905a67cSAndy Whitcroft # Check for any sort of function declaration. 24638905a67cSAndy Whitcroft # int foo(something bar, other baz); 24648905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2465171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 24668905a67cSAndy Whitcroft my ($name_len) = length($1); 24678905a67cSAndy Whitcroft 2468cf655043SAndy Whitcroft my $ctx = $s; 2469773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 24708905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2471cf655043SAndy Whitcroft 24728905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2473c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 24748905a67cSAndy Whitcroft 2475c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 24768905a67cSAndy Whitcroft } 24778905a67cSAndy Whitcroft } 24788905a67cSAndy Whitcroft } 24798905a67cSAndy Whitcroft 24809c0ca6f9SAndy Whitcroft } 24819c0ca6f9SAndy Whitcroft 248200df344fSAndy Whitcroft# 248300df344fSAndy Whitcroft# Checks which may be anchored in the context. 248400df344fSAndy Whitcroft# 248500df344fSAndy Whitcroft 248600df344fSAndy Whitcroft# Check for switch () and associated case and default 248700df344fSAndy Whitcroft# statements should be at the same indent. 248800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 248900df344fSAndy Whitcroft my $err = ''; 249000df344fSAndy Whitcroft my $sep = ''; 249100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 249200df344fSAndy Whitcroft shift(@ctx); 249300df344fSAndy Whitcroft for my $ctx (@ctx) { 249400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 249500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 249600df344fSAndy Whitcroft $indent != $cindent) { 249700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 249800df344fSAndy Whitcroft $sep = ''; 249900df344fSAndy Whitcroft } else { 250000df344fSAndy Whitcroft $sep = "[...]\n"; 250100df344fSAndy Whitcroft } 250200df344fSAndy Whitcroft } 250300df344fSAndy Whitcroft if ($err ne '') { 2504000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2505000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2506de7d4f0eSAndy Whitcroft } 2507de7d4f0eSAndy Whitcroft } 2508de7d4f0eSAndy Whitcroft 2509de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2510de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2511c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2512773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2513773647a0SAndy Whitcroft 25149c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 25158eef05ddSJoe Perches 25168eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 25178eef05ddSJoe Perches WARN("DEEP_INDENTATION", 25188eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 25198eef05ddSJoe Perches } 25208eef05ddSJoe Perches 2521de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2522de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2523de7d4f0eSAndy Whitcroft 2524548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2525548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2526de7d4f0eSAndy Whitcroft 2527548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2528548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2529548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2530548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2531548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2532773647a0SAndy Whitcroft $ctx_ln++; 2533773647a0SAndy Whitcroft } 2534548596d5SAndy Whitcroft 253553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 253653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2537773647a0SAndy Whitcroft 2538773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2539000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2540000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 254101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 254200df344fSAndy Whitcroft } 2543773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2544773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2545773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2546773647a0SAndy Whitcroft { 25479c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 25489c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2549000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2550000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 255101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 25529c0ca6f9SAndy Whitcroft } 25539c0ca6f9SAndy Whitcroft } 255400df344fSAndy Whitcroft } 255500df344fSAndy Whitcroft 25564d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 25574d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 25583e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 25593e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 25603e469cdcSAndy Whitcroft if (!defined $stat); 25614d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 25624d001e4dSAndy Whitcroft 25634d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 25644d001e4dSAndy Whitcroft 25654d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 25664d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 25674d001e4dSAndy Whitcroft # where necessary. 25684d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 25694d001e4dSAndy Whitcroft 25704d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 25716f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 25726f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 25734d001e4dSAndy Whitcroft 25744d001e4dSAndy Whitcroft # We want to check the first line inside the block 25754d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 25764d001e4dSAndy Whitcroft # 1) any blank line termination 25774d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 25784d001e4dSAndy Whitcroft # 3) any do (...) { 25794d001e4dSAndy Whitcroft my $continuation = 0; 25804d001e4dSAndy Whitcroft my $check = 0; 25814d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 25824d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 25834d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 25844d001e4dSAndy Whitcroft $continuation = 1; 25854d001e4dSAndy Whitcroft } 25869bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 25874d001e4dSAndy Whitcroft $check = 1; 25884d001e4dSAndy Whitcroft $cond_lines++; 25894d001e4dSAndy Whitcroft } 25904d001e4dSAndy Whitcroft 25914d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 25924d001e4dSAndy Whitcroft # preprocessor statement. 25934d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 25944d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 25954d001e4dSAndy Whitcroft $check = 0; 25964d001e4dSAndy Whitcroft } 25974d001e4dSAndy Whitcroft 25989bd49efeSAndy Whitcroft my $cond_ptr = -1; 2599740504c6SAndy Whitcroft $continuation = 0; 26009bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 26019bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 26024d001e4dSAndy Whitcroft 2603f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2604f16fa28fSAndy Whitcroft # is not linear. 2605f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2606f16fa28fSAndy Whitcroft $check = 0; 2607f16fa28fSAndy Whitcroft } 2608f16fa28fSAndy Whitcroft 26099bd49efeSAndy Whitcroft # Ignore: 26109bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 26119bd49efeSAndy Whitcroft # 2) preprocessor lines, and 26129bd49efeSAndy Whitcroft # 3) labels. 2613740504c6SAndy Whitcroft if ($continuation || 2614740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 26159bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 26169bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2617740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 261830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 26199bd49efeSAndy Whitcroft $cond_lines++; 26209bd49efeSAndy Whitcroft } 26214d001e4dSAndy Whitcroft } 262230dad6ebSAndy Whitcroft } 26234d001e4dSAndy Whitcroft 26244d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 26254d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 26264d001e4dSAndy Whitcroft 26274d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 26284d001e4dSAndy Whitcroft # this is not this patch's fault. 26294d001e4dSAndy Whitcroft if (!defined($stat_real) || 26304d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 26314d001e4dSAndy Whitcroft $check = 0; 26324d001e4dSAndy Whitcroft } 26334d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 26344d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 26354d001e4dSAndy Whitcroft } 26364d001e4dSAndy Whitcroft 26379bd49efeSAndy 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"; 26384d001e4dSAndy Whitcroft 26394d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 26404d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2641000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2642000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 26434d001e4dSAndy Whitcroft } 26444d001e4dSAndy Whitcroft } 26454d001e4dSAndy Whitcroft 26466c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 26476c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 26481f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 26491f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 26506c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2651c2fdda0dSAndy Whitcroft if ($dbg_values) { 2652c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2653cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2654cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 26551f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2656c2fdda0dSAndy Whitcroft } 26576c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 26586c72ffaaSAndy Whitcroft 265900df344fSAndy Whitcroft#ignore lines not being added 26603705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 266100df344fSAndy Whitcroft 2662653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 26637429c690SAndy Whitcroft if ($dbg_type) { 26647429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2665000d1cc1SJoe Perches ERROR("TEST_TYPE", 2666000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 26677429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2668000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2669000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 26707429c690SAndy Whitcroft } 2671653d4876SAndy Whitcroft next; 2672653d4876SAndy Whitcroft } 2673a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2674a1ef277eSAndy Whitcroft if ($dbg_attr) { 26759360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2676000d1cc1SJoe Perches ERROR("TEST_ATTR", 2677000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 26789360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2679000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2680000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2681a1ef277eSAndy Whitcroft } 2682a1ef277eSAndy Whitcroft next; 2683a1ef277eSAndy Whitcroft } 2684653d4876SAndy Whitcroft 2685f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 268699423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 268799423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2688000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2689000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2690f0a594c1SAndy Whitcroft } 2691f0a594c1SAndy Whitcroft 269200df344fSAndy Whitcroft# 269300df344fSAndy Whitcroft# Checks which are anchored on the added line. 269400df344fSAndy Whitcroft# 269500df344fSAndy Whitcroft 2696653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2697c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2698653d4876SAndy Whitcroft my $path = $1; 2699653d4876SAndy Whitcroft if ($path =~ m{//}) { 2700000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2701495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2702495e9d84SJoe Perches } 2703495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2704495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2705495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2706653d4876SAndy Whitcroft } 2707653d4876SAndy Whitcroft } 2708653d4876SAndy Whitcroft 270900df344fSAndy Whitcroft# no C99 // comments 271000df344fSAndy Whitcroft if ($line =~ m{//}) { 27113705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 27123705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 27133705ce5bSJoe Perches $fix) { 27143705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 27153705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 27163705ce5bSJoe Perches my $comment = trim($1); 27173705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 27183705ce5bSJoe Perches } 27193705ce5bSJoe Perches } 272000df344fSAndy Whitcroft } 272100df344fSAndy Whitcroft # Remove C99 comments. 27220a920b5bSAndy Whitcroft $line =~ s@//.*@@; 27236c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 27240a920b5bSAndy Whitcroft 27252b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 27262b474a1aSAndy Whitcroft# the whole statement. 27272b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 27282b474a1aSAndy Whitcroft if (defined $realline_next && 27292b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 27302b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 27312b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 27322b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 27333cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 27343cbf62dfSAndy Whitcroft # a prefix: 27353cbf62dfSAndy Whitcroft # XXX(foo); 27363cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2737653d4876SAndy Whitcroft my $name = $1; 273887a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 27393cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 27403cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 27413cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 27423cbf62dfSAndy Whitcroft 27433cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 27442b474a1aSAndy Whitcroft \n.}\s*$| 274548012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 274648012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 274748012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 27482b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 27492b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 275048012058SAndy Whitcroft )/x) { 27512b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 27522b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 27532b474a1aSAndy Whitcroft } else { 27542b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 27550a920b5bSAndy Whitcroft } 27560a920b5bSAndy Whitcroft } 27572b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 27582b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 27592b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 27602b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 27612b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 27622b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 27632b474a1aSAndy Whitcroft } 27642b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 27652b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2766000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2767000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 27682b474a1aSAndy Whitcroft } 27690a920b5bSAndy Whitcroft 27705150bda4SJoe Eloff# check for global initialisers. 2771d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2772d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2773000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2774d5e616fcSJoe Perches $herecurr) && 2775d5e616fcSJoe Perches $fix) { 2776d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2777d5e616fcSJoe Perches } 2778f0a594c1SAndy Whitcroft } 27790a920b5bSAndy Whitcroft# check for static initialisers. 2780d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2781d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2782000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2783d5e616fcSJoe Perches $herecurr) && 2784d5e616fcSJoe Perches $fix) { 2785d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2786d5e616fcSJoe Perches } 27870a920b5bSAndy Whitcroft } 27880a920b5bSAndy Whitcroft 2789cb710ecaSJoe Perches# check for static const char * arrays. 2790cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2791000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2792000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2793cb710ecaSJoe Perches $herecurr); 2794cb710ecaSJoe Perches } 2795cb710ecaSJoe Perches 2796cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2797cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2798000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2799000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2800cb710ecaSJoe Perches $herecurr); 2801cb710ecaSJoe Perches } 2802cb710ecaSJoe Perches 28039b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 28049b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 28059b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 28069b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 28079b0fa60dSJoe Perches $herecurr); 28089b0fa60dSJoe Perches } 28099b0fa60dSJoe Perches 2810b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 2811b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 2812b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 2813b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 2814b36190c5SJoe Perches $fix) { 2815b36190c5SJoe Perches $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 2816b36190c5SJoe Perches } 2817b36190c5SJoe Perches } 2818b36190c5SJoe Perches 281992e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 282092e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 282192e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 282292e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 282392e112fdSJoe Perches $fix) { 282492e112fdSJoe 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\[\] = /; 282592e112fdSJoe Perches } 282693ed0e2dSJoe Perches } 282793ed0e2dSJoe Perches 2828653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2829653d4876SAndy Whitcroft# make sense. 2830653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 28318054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2832c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 28338ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2834653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2835000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2836000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 28370a920b5bSAndy Whitcroft } 28380a920b5bSAndy Whitcroft 28390a920b5bSAndy Whitcroft# * goes on variable not on type 284065863862SAndy Whitcroft # (char*[ const]) 2841bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2842bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 28433705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2844d8aaf121SAndy Whitcroft 284565863862SAndy Whitcroft # Should start with a space. 284665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 284765863862SAndy Whitcroft # Should not end with a space. 284865863862SAndy Whitcroft $to =~ s/\s+$//; 284965863862SAndy Whitcroft # '*'s should not have spaces between. 2850f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 285165863862SAndy Whitcroft } 2852d8aaf121SAndy Whitcroft 28533705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 285465863862SAndy Whitcroft if ($from ne $to) { 28553705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28563705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 28573705ce5bSJoe Perches $fix) { 28583705ce5bSJoe Perches my $sub_from = $ident; 28593705ce5bSJoe Perches my $sub_to = $ident; 28603705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28613705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28623705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28633705ce5bSJoe Perches } 286465863862SAndy Whitcroft } 2865bfcb2cc7SAndy Whitcroft } 2866bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2867bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 28683705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2869d8aaf121SAndy Whitcroft 287065863862SAndy Whitcroft # Should start with a space. 287165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 287265863862SAndy Whitcroft # Should not end with a space. 287365863862SAndy Whitcroft $to =~ s/\s+$//; 287465863862SAndy Whitcroft # '*'s should not have spaces between. 2875f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 287665863862SAndy Whitcroft } 287765863862SAndy Whitcroft # Modifiers should have spaces. 287865863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 287965863862SAndy Whitcroft 28803705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2881667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 28823705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 28833705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 28843705ce5bSJoe Perches $fix) { 28853705ce5bSJoe Perches 28863705ce5bSJoe Perches my $sub_from = $match; 28873705ce5bSJoe Perches my $sub_to = $match; 28883705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 28893705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28903705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 28913705ce5bSJoe Perches } 289265863862SAndy Whitcroft } 28930a920b5bSAndy Whitcroft } 28940a920b5bSAndy Whitcroft 28950a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 28960a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 28970a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 28980a920b5bSAndy Whitcroft# print "$herecurr"; 28990a920b5bSAndy Whitcroft# $clean = 0; 29000a920b5bSAndy Whitcroft# } 29010a920b5bSAndy Whitcroft 29028905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2903000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2904000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 29058905a67cSAndy Whitcroft } 29068905a67cSAndy Whitcroft 290717441227SJoe Perches# check for uses of printk_ratelimit 290817441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2909000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2910000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 291117441227SJoe Perches } 291217441227SJoe Perches 291300df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 291400df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 291500df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 291625985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 291700df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2918f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 291900df344fSAndy Whitcroft my $ok = 0; 292000df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 292100df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 292225985edcSLucas De Marchi # we have a preceding printk if it ends 292300df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 292400df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 292500df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 292600df344fSAndy Whitcroft $ok = 1; 292700df344fSAndy Whitcroft } 292800df344fSAndy Whitcroft last; 292900df344fSAndy Whitcroft } 293000df344fSAndy Whitcroft } 293100df344fSAndy Whitcroft if ($ok == 0) { 2932000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2933000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 29340a920b5bSAndy Whitcroft } 293500df344fSAndy Whitcroft } 29360a920b5bSAndy Whitcroft 2937243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2938243f3803SJoe Perches my $orig = $1; 2939243f3803SJoe Perches my $level = lc($orig); 2940243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 29418f26b837SJoe Perches my $level2 = $level; 29428f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2943243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2944daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2945243f3803SJoe Perches } 2946243f3803SJoe Perches 2947243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2948d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2949d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2950d5e616fcSJoe Perches $fix) { 2951d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2952d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2953d5e616fcSJoe Perches } 2954243f3803SJoe Perches } 2955243f3803SJoe Perches 2956dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2957dc139313SJoe Perches my $orig = $1; 2958dc139313SJoe Perches my $level = lc($orig); 2959dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2960dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2961dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2962dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2963dc139313SJoe Perches } 2964dc139313SJoe Perches 2965653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2966653d4876SAndy Whitcroft# or if closed on same line 2967c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2968c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2969000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2970000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 29710a920b5bSAndy Whitcroft } 2972653d4876SAndy Whitcroft 29738905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 29748905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 29758905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2976000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2977000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 29788905a67cSAndy Whitcroft } 29798905a67cSAndy Whitcroft 29800c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 29813705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 29823705ce5bSJoe Perches if (WARN("SPACING", 29833705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 29843705ce5bSJoe Perches $fix) { 29853705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29863705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 29873705ce5bSJoe Perches } 29880c73b4ebSAndy Whitcroft } 29890c73b4ebSAndy Whitcroft 299031070b5dSJoe Perches# Function pointer declarations 299131070b5dSJoe Perches# check spacing between type, funcptr, and args 299231070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 299391f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 299431070b5dSJoe Perches my $declare = $1; 299531070b5dSJoe Perches my $pre_pointer_space = $2; 299631070b5dSJoe Perches my $post_pointer_space = $3; 299731070b5dSJoe Perches my $funcname = $4; 299831070b5dSJoe Perches my $post_funcname_space = $5; 299931070b5dSJoe Perches my $pre_args_space = $6; 300031070b5dSJoe Perches 300191f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 300291f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 300391f72e9cSJoe Perches# don't need a space so don't warn for those. 300491f72e9cSJoe Perches my $post_declare_space = ""; 300591f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 300691f72e9cSJoe Perches $post_declare_space = $1; 300791f72e9cSJoe Perches $declare = rtrim($declare); 300891f72e9cSJoe Perches } 300991f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 301031070b5dSJoe Perches WARN("SPACING", 301131070b5dSJoe Perches "missing space after return type\n" . $herecurr); 301291f72e9cSJoe Perches $post_declare_space = " "; 301331070b5dSJoe Perches } 301431070b5dSJoe Perches 301531070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 301691f72e9cSJoe Perches# This test is not currently implemented because these declarations are 301791f72e9cSJoe Perches# equivalent to 301891f72e9cSJoe Perches# int foo(int bar, ...) 301991f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 302091f72e9cSJoe Perches# 302191f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 302291f72e9cSJoe Perches# WARN("SPACING", 302391f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 302491f72e9cSJoe Perches# } 302531070b5dSJoe Perches 302631070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 302731070b5dSJoe Perches if (defined $pre_pointer_space && 302831070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 302931070b5dSJoe Perches WARN("SPACING", 303031070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 303131070b5dSJoe Perches } 303231070b5dSJoe Perches 303331070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 303431070b5dSJoe Perches if (defined $post_pointer_space && 303531070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 303631070b5dSJoe Perches WARN("SPACING", 303731070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 303831070b5dSJoe Perches } 303931070b5dSJoe Perches 304031070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 304131070b5dSJoe Perches if (defined $post_funcname_space && 304231070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 304331070b5dSJoe Perches WARN("SPACING", 304431070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 304531070b5dSJoe Perches } 304631070b5dSJoe Perches 304731070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 304831070b5dSJoe Perches if (defined $pre_args_space && 304931070b5dSJoe Perches $pre_args_space =~ /^\s/) { 305031070b5dSJoe Perches WARN("SPACING", 305131070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 305231070b5dSJoe Perches } 305331070b5dSJoe Perches 305431070b5dSJoe Perches if (show_type("SPACING") && $fix) { 305531070b5dSJoe Perches $fixed[$linenr - 1] =~ 305691f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 305731070b5dSJoe Perches } 305831070b5dSJoe Perches } 305931070b5dSJoe Perches 30608d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 30618d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3062fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3063fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 30648d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 30658d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 30668d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3067fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3068daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 30693705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 30703705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 30713705ce5bSJoe Perches $fix) { 30723705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30733705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 30743705ce5bSJoe Perches } 30758d31cfceSAndy Whitcroft } 30768d31cfceSAndy Whitcroft } 30778d31cfceSAndy Whitcroft 3078f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 30796c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3080c2fdda0dSAndy Whitcroft my $name = $1; 3081773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3082773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3083c2fdda0dSAndy Whitcroft 3084c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3085773647a0SAndy Whitcroft if ($name =~ /^(?: 3086773647a0SAndy Whitcroft if|for|while|switch|return|case| 3087773647a0SAndy Whitcroft volatile|__volatile__| 3088773647a0SAndy Whitcroft __attribute__|format|__extension__| 3089773647a0SAndy Whitcroft asm|__asm__)$/x) 3090773647a0SAndy Whitcroft { 3091c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3092c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3093c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3094c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3095773647a0SAndy Whitcroft 3096773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3097c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3098c2fdda0dSAndy Whitcroft 3099c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3100c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3101773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3102c2fdda0dSAndy Whitcroft 3103c2fdda0dSAndy Whitcroft } else { 31043705ce5bSJoe Perches if (WARN("SPACING", 31053705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 31063705ce5bSJoe Perches $fix) { 31073705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31083705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 31093705ce5bSJoe Perches } 3110f0a594c1SAndy Whitcroft } 31116c72ffaaSAndy Whitcroft } 31129a4cad4eSEric Nelson 3113653d4876SAndy Whitcroft# Check operator spacing. 31140a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 31153705ce5bSJoe Perches my $fixed_line = ""; 31163705ce5bSJoe Perches my $line_fixed = 0; 31173705ce5bSJoe Perches 31189c0ca6f9SAndy Whitcroft my $ops = qr{ 31199c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 31209c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 31219c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 31221f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 312384731623SJoe Perches \?:|\?|: 31249c0ca6f9SAndy Whitcroft }x; 3125cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 31263705ce5bSJoe Perches 31273705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 31283705ce5bSJoe Perches## foreach my $el (@elements) { 31293705ce5bSJoe Perches## print("el: <$el>\n"); 31303705ce5bSJoe Perches## } 31313705ce5bSJoe Perches 31323705ce5bSJoe Perches my @fix_elements = (); 313300df344fSAndy Whitcroft my $off = 0; 31346c72ffaaSAndy Whitcroft 31353705ce5bSJoe Perches foreach my $el (@elements) { 31363705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 31373705ce5bSJoe Perches $off += length($el); 31383705ce5bSJoe Perches } 31393705ce5bSJoe Perches 31403705ce5bSJoe Perches $off = 0; 31413705ce5bSJoe Perches 31426c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3143b34c648bSJoe Perches my $last_after = -1; 31446c72ffaaSAndy Whitcroft 31450a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 31463705ce5bSJoe Perches 31473705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 31483705ce5bSJoe Perches 31493705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 31503705ce5bSJoe Perches 31514a0df2efSAndy Whitcroft $off += length($elements[$n]); 31524a0df2efSAndy Whitcroft 315325985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3154773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3155773647a0SAndy Whitcroft my $cc = ''; 3156773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3157773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3158773647a0SAndy Whitcroft } 3159773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3160773647a0SAndy Whitcroft 31614a0df2efSAndy Whitcroft my $a = ''; 31624a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 31634a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3164cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 31654a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 31664a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3167773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 31684a0df2efSAndy Whitcroft 31690a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 31704a0df2efSAndy Whitcroft 31714a0df2efSAndy Whitcroft my $c = ''; 31720a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 31734a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 31744a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3175cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 31764a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 31774a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 31788b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 31794a0df2efSAndy Whitcroft } else { 31804a0df2efSAndy Whitcroft $c = 'E'; 31810a920b5bSAndy Whitcroft } 31820a920b5bSAndy Whitcroft 31834a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 31844a0df2efSAndy Whitcroft 31854a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 31864a0df2efSAndy Whitcroft 31876c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3188de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 31890a920b5bSAndy Whitcroft 319074048ed8SAndy Whitcroft # Pull out the value of this operator. 31916c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 31920a920b5bSAndy Whitcroft 31931f65f947SAndy Whitcroft # Get the full operator variant. 31941f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 31951f65f947SAndy Whitcroft 319613214adfSAndy Whitcroft # Ignore operators passed as parameters. 319713214adfSAndy Whitcroft if ($op_type ne 'V' && 319813214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 319913214adfSAndy Whitcroft 3200cf655043SAndy Whitcroft# # Ignore comments 3201cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 320213214adfSAndy Whitcroft 3203d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 320413214adfSAndy Whitcroft } elsif ($op eq ';') { 3205cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3206cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 32073705ce5bSJoe Perches if (ERROR("SPACING", 32083705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3209b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32103705ce5bSJoe Perches $line_fixed = 1; 32113705ce5bSJoe Perches } 3212d8aaf121SAndy Whitcroft } 3213d8aaf121SAndy Whitcroft 3214d8aaf121SAndy Whitcroft # // is a comment 3215d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 32160a920b5bSAndy Whitcroft 3217b00e4814SJoe Perches # : when part of a bitfield 3218b00e4814SJoe Perches } elsif ($opv eq ':B') { 3219b00e4814SJoe Perches # skip the bitfield test for now 3220b00e4814SJoe Perches 32211f65f947SAndy Whitcroft # No spaces for: 32221f65f947SAndy Whitcroft # -> 3223b00e4814SJoe Perches } elsif ($op eq '->') { 32244a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 32253705ce5bSJoe Perches if (ERROR("SPACING", 32263705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3227b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32283705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32293705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 32303705ce5bSJoe Perches } 3231b34c648bSJoe Perches $line_fixed = 1; 32323705ce5bSJoe Perches } 32330a920b5bSAndy Whitcroft } 32340a920b5bSAndy Whitcroft 32350a920b5bSAndy Whitcroft # , must have a space on the right. 32360a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3237cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 32383705ce5bSJoe Perches if (ERROR("SPACING", 32393705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3240b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32413705ce5bSJoe Perches $line_fixed = 1; 3242b34c648bSJoe Perches $last_after = $n; 32433705ce5bSJoe Perches } 32440a920b5bSAndy Whitcroft } 32450a920b5bSAndy Whitcroft 32469c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 324774048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 32489c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 32499c0ca6f9SAndy Whitcroft 32509c0ca6f9SAndy Whitcroft # unary operators should have a space before and 32519c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 32529c0ca6f9SAndy Whitcroft # unary operator, or a cast 32539c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 325474048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 32550d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3256cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 32573705ce5bSJoe Perches if (ERROR("SPACING", 32583705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3259b34c648bSJoe Perches if ($n != $last_after + 2) { 3260b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 32613705ce5bSJoe Perches $line_fixed = 1; 32623705ce5bSJoe Perches } 32630a920b5bSAndy Whitcroft } 3264b34c648bSJoe Perches } 3265a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3266171ae1a4SAndy Whitcroft # A unary '*' may be const 3267171ae1a4SAndy Whitcroft 3268171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 32693705ce5bSJoe Perches if (ERROR("SPACING", 32703705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3271b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 32723705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 32733705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 32743705ce5bSJoe Perches } 3275b34c648bSJoe Perches $line_fixed = 1; 32763705ce5bSJoe Perches } 32770a920b5bSAndy Whitcroft } 32780a920b5bSAndy Whitcroft 32790a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 32800a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3281773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 32823705ce5bSJoe Perches if (ERROR("SPACING", 32833705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3284b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 32853705ce5bSJoe Perches $line_fixed = 1; 32863705ce5bSJoe Perches } 32870a920b5bSAndy Whitcroft } 3288773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3289773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 32903705ce5bSJoe Perches if (ERROR("SPACING", 32913705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3292b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32933705ce5bSJoe Perches $line_fixed = 1; 32943705ce5bSJoe Perches } 3295653d4876SAndy Whitcroft } 3296773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 32973705ce5bSJoe Perches if (ERROR("SPACING", 32983705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3299b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 33003705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 33013705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3302773647a0SAndy Whitcroft } 3303b34c648bSJoe Perches $line_fixed = 1; 33043705ce5bSJoe Perches } 33053705ce5bSJoe Perches } 33060a920b5bSAndy Whitcroft 33070a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 33089c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 33099c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 33109c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3311c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3312c2fdda0dSAndy Whitcroft $op eq '%') 33130a920b5bSAndy Whitcroft { 3314773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 33153705ce5bSJoe Perches if (ERROR("SPACING", 33163705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3317b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3318b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3319b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3320b34c648bSJoe Perches } 33213705ce5bSJoe Perches $line_fixed = 1; 33223705ce5bSJoe Perches } 33230a920b5bSAndy Whitcroft } 33240a920b5bSAndy Whitcroft 33251f65f947SAndy Whitcroft # A colon needs no spaces before when it is 33261f65f947SAndy Whitcroft # terminating a case value or a label. 33271f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 33281f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 33293705ce5bSJoe Perches if (ERROR("SPACING", 33303705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3331b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 33323705ce5bSJoe Perches $line_fixed = 1; 33333705ce5bSJoe Perches } 33341f65f947SAndy Whitcroft } 33351f65f947SAndy Whitcroft 33360a920b5bSAndy Whitcroft # All the others need spaces both sides. 3337cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 33381f65f947SAndy Whitcroft my $ok = 0; 33391f65f947SAndy Whitcroft 334022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 33411f65f947SAndy Whitcroft if (($op eq '<' && 33421f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 33431f65f947SAndy Whitcroft ($op eq '>' && 33441f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 33451f65f947SAndy Whitcroft { 33461f65f947SAndy Whitcroft $ok = 1; 33471f65f947SAndy Whitcroft } 33481f65f947SAndy Whitcroft 334984731623SJoe Perches # messages are ERROR, but ?: are CHK 33501f65f947SAndy Whitcroft if ($ok == 0) { 335184731623SJoe Perches my $msg_type = \&ERROR; 335284731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 335384731623SJoe Perches 335484731623SJoe Perches if (&{$msg_type}("SPACING", 33553705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3356b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3357b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3358b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3359b34c648bSJoe Perches } 33603705ce5bSJoe Perches $line_fixed = 1; 33613705ce5bSJoe Perches } 33620a920b5bSAndy Whitcroft } 336322f2a2efSAndy Whitcroft } 33644a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 33653705ce5bSJoe Perches 33663705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 33673705ce5bSJoe Perches 33683705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 33690a920b5bSAndy Whitcroft } 33703705ce5bSJoe Perches 33713705ce5bSJoe Perches if (($#elements % 2) == 0) { 33723705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 33733705ce5bSJoe Perches } 33743705ce5bSJoe Perches 33753705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 33763705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 33773705ce5bSJoe Perches } 33783705ce5bSJoe Perches 33793705ce5bSJoe Perches 33800a920b5bSAndy Whitcroft } 33810a920b5bSAndy Whitcroft 3382786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3383d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3384786b6326SJoe Perches if (WARN("SPACING", 3385786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3386786b6326SJoe Perches $fix) { 3387786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3388786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3389786b6326SJoe Perches } 3390786b6326SJoe Perches } 3391786b6326SJoe Perches 3392f0a594c1SAndy Whitcroft# check for multiple assignments 3393f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3394000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3395000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3396f0a594c1SAndy Whitcroft } 3397f0a594c1SAndy Whitcroft 339822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 339922f2a2efSAndy Whitcroft## # continuation. 340022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 340122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 340222f2a2efSAndy Whitcroft## 340322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 340422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 340522f2a2efSAndy Whitcroft## my $ln = $line; 340622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 340722f2a2efSAndy Whitcroft## } 340822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3409000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3410000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 341122f2a2efSAndy Whitcroft## } 341222f2a2efSAndy Whitcroft## } 3413f0a594c1SAndy Whitcroft 34140a920b5bSAndy Whitcroft#need space before brace following if, while, etc 341522f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 341622f2a2efSAndy Whitcroft $line =~ /do{/) { 34173705ce5bSJoe Perches if (ERROR("SPACING", 34183705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 34193705ce5bSJoe Perches $fix) { 3420d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 34213705ce5bSJoe Perches } 3422de7d4f0eSAndy Whitcroft } 3423de7d4f0eSAndy Whitcroft 3424c4a62ef9SJoe Perches## # check for blank lines before declarations 3425c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3426c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3427c4a62ef9SJoe Perches## WARN("SPACING", 3428c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3429c4a62ef9SJoe Perches## } 3430c4a62ef9SJoe Perches## 3431c4a62ef9SJoe Perches 3432de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3433de7d4f0eSAndy Whitcroft# on the line 3434de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3435d5e616fcSJoe Perches if (ERROR("SPACING", 3436d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3437d5e616fcSJoe Perches $fix) { 3438d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3439d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3440d5e616fcSJoe Perches } 34410a920b5bSAndy Whitcroft } 34420a920b5bSAndy Whitcroft 344322f2a2efSAndy Whitcroft# check spacing on square brackets 344422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 34453705ce5bSJoe Perches if (ERROR("SPACING", 34463705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 34473705ce5bSJoe Perches $fix) { 34483705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34493705ce5bSJoe Perches s/\[\s+/\[/; 34503705ce5bSJoe Perches } 345122f2a2efSAndy Whitcroft } 345222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 34533705ce5bSJoe Perches if (ERROR("SPACING", 34543705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 34553705ce5bSJoe Perches $fix) { 34563705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34573705ce5bSJoe Perches s/\s+\]/\]/; 34583705ce5bSJoe Perches } 345922f2a2efSAndy Whitcroft } 346022f2a2efSAndy Whitcroft 3461c45dcabdSAndy Whitcroft# check spacing on parentheses 34629c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 34639c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 34643705ce5bSJoe Perches if (ERROR("SPACING", 34653705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 34663705ce5bSJoe Perches $fix) { 34673705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34683705ce5bSJoe Perches s/\(\s+/\(/; 34693705ce5bSJoe Perches } 347022f2a2efSAndy Whitcroft } 347113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3472c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3473c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 34743705ce5bSJoe Perches if (ERROR("SPACING", 34753705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 34763705ce5bSJoe Perches $fix) { 34773705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34783705ce5bSJoe Perches s/\s+\)/\)/; 34793705ce5bSJoe Perches } 348022f2a2efSAndy Whitcroft } 348122f2a2efSAndy Whitcroft 34820a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 34834a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 34840a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 34853705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 34863705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 34873705ce5bSJoe Perches $fix) { 34883705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34893705ce5bSJoe Perches s/^(.)\s+/$1/; 34903705ce5bSJoe Perches } 34910a920b5bSAndy Whitcroft } 34920a920b5bSAndy Whitcroft 34935b9553abSJoe Perches# return is not a function 3494507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3495c45dcabdSAndy Whitcroft my $spacing = $1; 3496507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 34975b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 34985b9553abSJoe Perches my $value = $1; 34995b9553abSJoe Perches $value = deparenthesize($value); 35005b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3501000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3502000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 35035b9553abSJoe Perches } 3504c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3505000d1cc1SJoe Perches ERROR("SPACING", 3506000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3507c45dcabdSAndy Whitcroft } 3508c45dcabdSAndy Whitcroft } 3509507e5141SJoe Perches 3510b43ae21bSJoe Perches# unnecessary return in a void function 3511b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 3512b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 3513b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 3514b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 3515b43ae21bSJoe Perches $linenr >= 3 && 3516b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 3517b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 35189819cf25SJoe Perches WARN("RETURN_VOID", 3519b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 35209819cf25SJoe Perches } 35219819cf25SJoe Perches 3522189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3523189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3524189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3525189248d8SJoe Perches my $openparens = $1; 3526189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3527189248d8SJoe Perches my $msg = ""; 3528189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3529189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3530189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3531189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3532189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3533189248d8SJoe Perches } 3534189248d8SJoe Perches } 3535189248d8SJoe Perches 353653a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 353753a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 353853a3c448SAndy Whitcroft my $name = $1; 353953a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3540000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3541000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 354253a3c448SAndy Whitcroft } 354353a3c448SAndy Whitcroft } 3544c45dcabdSAndy Whitcroft 35450a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 35464a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 35473705ce5bSJoe Perches if (ERROR("SPACING", 35483705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 35493705ce5bSJoe Perches $fix) { 35503705ce5bSJoe Perches $fixed[$linenr - 1] =~ 35513705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 35523705ce5bSJoe Perches } 35530a920b5bSAndy Whitcroft } 35540a920b5bSAndy Whitcroft 3555f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3556f5fe35ddSAndy Whitcroft# statements after the conditional. 3557170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 35583e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 35593e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 35603e469cdcSAndy Whitcroft if (!defined $stat); 3561170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3562170d3a22SAndy Whitcroft $remain_next, $off_next); 3563170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3564170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3565170d3a22SAndy Whitcroft 3566170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3567170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3568170d3a22SAndy Whitcroft # then count those as offsets. 3569170d3a22SAndy Whitcroft my ($whitespace) = 3570170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3571170d3a22SAndy Whitcroft my $offset = 3572170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3573170d3a22SAndy Whitcroft 3574170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3575170d3a22SAndy Whitcroft $offset} = 1; 3576170d3a22SAndy Whitcroft } 3577170d3a22SAndy Whitcroft } 3578170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3579c11230f4SJoe Perches defined($stat) && defined($cond) && 3580170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3581171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 35828905a67cSAndy Whitcroft 3583b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3584000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3585000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 35868905a67cSAndy Whitcroft } 35878905a67cSAndy Whitcroft 35888905a67cSAndy Whitcroft # Find out what is on the end of the line after the 35898905a67cSAndy Whitcroft # conditional. 3590773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 35918905a67cSAndy Whitcroft $s =~ s/\n.*//g; 359213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 359353210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 359453210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3595773647a0SAndy Whitcroft { 3596bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3597bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3598bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 359942bdf74cSHidetoshi Seto my $stat_real = ''; 3600bb44ad39SAndy Whitcroft 360142bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 360242bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3603bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3604bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3605bb44ad39SAndy Whitcroft } 3606bb44ad39SAndy Whitcroft 3607000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3608000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 36098905a67cSAndy Whitcroft } 36108905a67cSAndy Whitcroft } 36118905a67cSAndy Whitcroft 361213214adfSAndy Whitcroft# Check for bitwise tests written as boolean 361313214adfSAndy Whitcroft if ($line =~ / 361413214adfSAndy Whitcroft (?: 361513214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 361613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 361713214adfSAndy Whitcroft (?:\&\&|\|\|) 361813214adfSAndy Whitcroft | 361913214adfSAndy Whitcroft (?:\&\&|\|\|) 362013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 362113214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 362213214adfSAndy Whitcroft )/x) 362313214adfSAndy Whitcroft { 3624000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3625000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 362613214adfSAndy Whitcroft } 362713214adfSAndy Whitcroft 36288905a67cSAndy Whitcroft# if and else should not have general statements after it 362913214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 363013214adfSAndy Whitcroft my $s = $1; 363113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 363213214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3633000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3634000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 36350a920b5bSAndy Whitcroft } 363613214adfSAndy Whitcroft } 363739667782SAndy Whitcroft# if should not continue a brace 363839667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3639000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3640048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 364139667782SAndy Whitcroft $herecurr); 364239667782SAndy Whitcroft } 3643a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3644a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3645a1080bf8SAndy Whitcroft $line !~ /\G(?: 36463fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3647a1080bf8SAndy Whitcroft \s*return\s+ 3648a1080bf8SAndy Whitcroft )/xg) 3649a1080bf8SAndy Whitcroft { 3650000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3651000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3652a1080bf8SAndy Whitcroft } 36530a920b5bSAndy Whitcroft 36540a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 36550a920b5bSAndy Whitcroft # indent level to be relevant to each other. 36560a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 36570a920b5bSAndy Whitcroft $previndent == $indent) { 3658000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3659000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 36600a920b5bSAndy Whitcroft } 36610a920b5bSAndy Whitcroft 3662c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3663c2fdda0dSAndy Whitcroft $previndent == $indent) { 3664c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3665c2fdda0dSAndy Whitcroft 3666c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3667c2fdda0dSAndy Whitcroft # conditional. 3668773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3669c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3670c2fdda0dSAndy Whitcroft 3671c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3672000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3673000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3674c2fdda0dSAndy Whitcroft } 3675c2fdda0dSAndy Whitcroft } 3676c2fdda0dSAndy Whitcroft 367795e2c602SJoe Perches#Specific variable tests 3678323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3679323c1260SJoe Perches my $var = $1; 368095e2c602SJoe Perches 368195e2c602SJoe Perches#gcc binary extension 368295e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3683d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3684d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3685d5e616fcSJoe Perches $fix) { 3686d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3687d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3688d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3689d5e616fcSJoe Perches } 369095e2c602SJoe Perches } 369195e2c602SJoe Perches 369295e2c602SJoe Perches#CamelCase 3693807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3694be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 369522735ce8SJoe Perches#Ignore Page<foo> variants 3696807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 369722735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 36983445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 36997e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 37007e781f67SJoe Perches my $word = $1; 37017e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3702d8b07710SJoe Perches if ($check) { 3703d8b07710SJoe Perches seed_camelcase_includes(); 3704d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3705d8b07710SJoe Perches seed_camelcase_file($realfile); 3706d8b07710SJoe Perches $camelcase_file_seeded = 1; 3707d8b07710SJoe Perches } 3708d8b07710SJoe Perches } 37097e781f67SJoe Perches if (!defined $camelcase{$word}) { 37107e781f67SJoe Perches $camelcase{$word} = 1; 3711be79794bSJoe Perches CHK("CAMELCASE", 37127e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 37137e781f67SJoe Perches } 3714323c1260SJoe Perches } 3715323c1260SJoe Perches } 37163445686aSJoe Perches } 37170a920b5bSAndy Whitcroft 37180a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3719d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3720d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3721d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3722d5e616fcSJoe Perches $fix) { 3723d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3724d5e616fcSJoe Perches } 37250a920b5bSAndy Whitcroft } 37260a920b5bSAndy Whitcroft 3727653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3728c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3729e09dec48SAndy Whitcroft my $file = "$1.h"; 3730e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3731e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3732e09dec48SAndy Whitcroft $realfile ne $checkfile && 37337840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3734c45dcabdSAndy Whitcroft { 3735e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3736000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3737000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3738e09dec48SAndy Whitcroft } else { 3739000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3740000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3741e09dec48SAndy Whitcroft } 37420a920b5bSAndy Whitcroft } 37430a920b5bSAndy Whitcroft } 37440a920b5bSAndy Whitcroft 3745653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3746653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3747cf655043SAndy Whitcroft# in a known good container 3748b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3749b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3750d8aaf121SAndy Whitcroft my $ln = $linenr; 3751d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3752c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3753c45dcabdSAndy Whitcroft my $ctx = ''; 3754c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3755f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3756f74bd194SAndy Whitcroft $ctx = $dstat; 3757c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3758a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3759c45dcabdSAndy Whitcroft 3760f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3761292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3762c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3763c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3764c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3765c45dcabdSAndy Whitcroft 3766c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3767bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3768bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3769c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3770bf30d6edSAndy Whitcroft { 3771c45dcabdSAndy Whitcroft } 3772c45dcabdSAndy Whitcroft 3773e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3774e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3775e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3776e45bab8eSAndy Whitcroft { 3777e45bab8eSAndy Whitcroft } 3778e45bab8eSAndy Whitcroft 3779c45dcabdSAndy Whitcroft my $exceptions = qr{ 3780c45dcabdSAndy Whitcroft $Declare| 3781c45dcabdSAndy Whitcroft module_param_named| 3782a0a0a7a9SKees Cook MODULE_PARM_DESC| 3783c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3784c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3785383099fdSAndy Whitcroft __typeof__\(| 378622fd2d3eSStefani Seibold union| 378722fd2d3eSStefani Seibold struct| 3788ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3789ea71a0a0SAndy Whitcroft ^\"|\"$ 3790c45dcabdSAndy Whitcroft }x; 37915eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3792f74bd194SAndy Whitcroft if ($dstat ne '' && 3793f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3794f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 37953cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3796356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 3797f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3798f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3799e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 380072f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3801f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3802f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3803f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3804f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3805f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3806c45dcabdSAndy Whitcroft { 3807f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3808f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3809f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3810f74bd194SAndy Whitcroft 3811f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3812f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3813c45dcabdSAndy Whitcroft } 3814c45dcabdSAndy Whitcroft 3815f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3816f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3817f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3818f74bd194SAndy Whitcroft } else { 3819000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3820f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3821d8aaf121SAndy Whitcroft } 38220a920b5bSAndy Whitcroft } 38235023d347SJoe Perches 3824481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 38255023d347SJoe Perches 38265023d347SJoe Perches } else { 38275023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3828481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3829481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 38305023d347SJoe Perches $line =~ /^\+.*\\$/) { 38315023d347SJoe Perches WARN("LINE_CONTINUATIONS", 38325023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 38335023d347SJoe Perches } 3834653d4876SAndy Whitcroft } 38350a920b5bSAndy Whitcroft 3836b13edf7fSJoe Perches# do {} while (0) macro tests: 3837b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3838b13edf7fSJoe Perches# macro should not end with a semicolon 3839b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3840b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3841b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3842b13edf7fSJoe Perches my $ln = $linenr; 3843b13edf7fSJoe Perches my $cnt = $realcnt; 3844b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3845b13edf7fSJoe Perches my $ctx = ''; 3846b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3847b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3848b13edf7fSJoe Perches $ctx = $dstat; 3849b13edf7fSJoe Perches 3850b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3851b13edf7fSJoe Perches 3852b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3853b13edf7fSJoe Perches my $stmts = $2; 3854b13edf7fSJoe Perches my $semis = $3; 3855b13edf7fSJoe Perches 3856b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3857b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3858b13edf7fSJoe Perches my $herectx = $here . "\n"; 3859b13edf7fSJoe Perches 3860b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3861b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3862b13edf7fSJoe Perches } 3863b13edf7fSJoe Perches 3864ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3865ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3866b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3867b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3868b13edf7fSJoe Perches } 3869b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3870b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3871b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3872b13edf7fSJoe Perches } 3873f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 3874f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 3875f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 3876f5ef95b1SJoe Perches my $herectx = $here . "\n"; 3877f5ef95b1SJoe Perches 3878f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3879f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3880f5ef95b1SJoe Perches } 3881f5ef95b1SJoe Perches 3882f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 3883f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 3884b13edf7fSJoe Perches } 3885b13edf7fSJoe Perches } 3886b13edf7fSJoe Perches 3887080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3888080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3889080ba929SMike Frysinger# . 3890080ba929SMike Frysinger# ALIGN(...) 3891080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3892080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3893000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3894000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3895080ba929SMike Frysinger } 3896080ba929SMike Frysinger 3897f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 389813214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 389913214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3900cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 390113214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3902cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3903cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3904aad4f614SJoe Perches my @allowed = (); 3905aad4f614SJoe Perches my $allow = 0; 390613214adfSAndy Whitcroft my $seen = 0; 3907773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3908cf655043SAndy Whitcroft my $ln = $linenr - 1; 390913214adfSAndy Whitcroft for my $chunk (@chunks) { 391013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 391113214adfSAndy Whitcroft 3912773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3913773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3914773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3915773647a0SAndy Whitcroft 3916aad4f614SJoe Perches $allowed[$allow] = 0; 3917773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3918773647a0SAndy Whitcroft 3919773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3920773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3921773647a0SAndy Whitcroft 3922773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3923cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3924cf655043SAndy Whitcroft 3925773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 392613214adfSAndy Whitcroft 392713214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 392813214adfSAndy Whitcroft 3929aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3930cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3931cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3932aad4f614SJoe Perches $allowed[$allow] = 1; 393313214adfSAndy Whitcroft } 393413214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3935cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3936aad4f614SJoe Perches $allowed[$allow] = 1; 393713214adfSAndy Whitcroft } 3938cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3939cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3940aad4f614SJoe Perches $allowed[$allow] = 1; 394113214adfSAndy Whitcroft } 3942aad4f614SJoe Perches $allow++; 394313214adfSAndy Whitcroft } 3944aad4f614SJoe Perches if ($seen) { 3945aad4f614SJoe Perches my $sum_allowed = 0; 3946aad4f614SJoe Perches foreach (@allowed) { 3947aad4f614SJoe Perches $sum_allowed += $_; 3948aad4f614SJoe Perches } 3949aad4f614SJoe Perches if ($sum_allowed == 0) { 3950000d1cc1SJoe Perches WARN("BRACES", 3951000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3952aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3953aad4f614SJoe Perches $seen != $allow) { 3954aad4f614SJoe Perches CHK("BRACES", 3955aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3956aad4f614SJoe Perches } 395713214adfSAndy Whitcroft } 395813214adfSAndy Whitcroft } 395913214adfSAndy Whitcroft } 3960773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 396113214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3962cf655043SAndy Whitcroft my $allowed = 0; 3963f0a594c1SAndy Whitcroft 3964cf655043SAndy Whitcroft # Check the pre-context. 3965cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3966cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3967cf655043SAndy Whitcroft $allowed = 1; 3968f0a594c1SAndy Whitcroft } 3969773647a0SAndy Whitcroft 3970773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3971773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3972773647a0SAndy Whitcroft 3973cf655043SAndy Whitcroft # Check the condition. 3974cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3975773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3976cf655043SAndy Whitcroft if (defined $cond) { 3977773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3978cf655043SAndy Whitcroft } 3979cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3980cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3981cf655043SAndy Whitcroft $allowed = 1; 3982cf655043SAndy Whitcroft } 3983cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3984cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3985cf655043SAndy Whitcroft $allowed = 1; 3986cf655043SAndy Whitcroft } 3987cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3988cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3989cf655043SAndy Whitcroft $allowed = 1; 3990cf655043SAndy Whitcroft } 3991cf655043SAndy Whitcroft # Check the post-context. 3992cf655043SAndy Whitcroft if (defined $chunks[1]) { 3993cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3994cf655043SAndy Whitcroft if (defined $cond) { 3995773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3996cf655043SAndy Whitcroft } 3997cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3998cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3999cf655043SAndy Whitcroft $allowed = 1; 4000cf655043SAndy Whitcroft } 4001cf655043SAndy Whitcroft } 4002cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 400369932487SJustin P. Mattock my $herectx = $here . "\n"; 4004f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4005cf655043SAndy Whitcroft 4006f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 400769932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4008cf655043SAndy Whitcroft } 4009cf655043SAndy Whitcroft 4010000d1cc1SJoe Perches WARN("BRACES", 4011000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4012f0a594c1SAndy Whitcroft } 4013f0a594c1SAndy Whitcroft } 4014f0a594c1SAndy Whitcroft 40150979ae66SJoe Perches# check for unnecessary blank lines around braces 401677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 40170979ae66SJoe Perches CHK("BRACES", 40180979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 40190979ae66SJoe Perches } 402077b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 40210979ae66SJoe Perches CHK("BRACES", 40220979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 40230979ae66SJoe Perches } 40240979ae66SJoe Perches 40254a0df2efSAndy Whitcroft# no volatiles please 40266c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 40276c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4028000d1cc1SJoe Perches WARN("VOLATILE", 4029000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 40304a0df2efSAndy Whitcroft } 40314a0df2efSAndy Whitcroft 403200df344fSAndy Whitcroft# warn about #if 0 4033c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4034000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4035000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4036de7d4f0eSAndy Whitcroft $herecurr); 40374a0df2efSAndy Whitcroft } 40384a0df2efSAndy Whitcroft 403903df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 404003df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 404103df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 404203df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 404303df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 404403df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 40454c432a8fSGreg Kroah-Hartman } 40464c432a8fSGreg Kroah-Hartman } 4047f0a594c1SAndy Whitcroft 4048ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4049ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4050ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4051ebfdc409SJoe Perches (defined $1 || defined $3) && 4052ebfdc409SJoe Perches $linenr > 3) { 4053ebfdc409SJoe Perches my $testval = $2; 4054ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4055ebfdc409SJoe Perches 4056ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4057ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4058ebfdc409SJoe Perches 4059ebfdc409SJoe 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)/) { 4060ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4061ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4062ebfdc409SJoe Perches } 4063ebfdc409SJoe Perches } 4064ebfdc409SJoe Perches 40658716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 40668716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 40678716de38SJoe Perches my $attr = $1; 40688716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 40698716de38SJoe Perches my $ptr = $1; 40708716de38SJoe Perches my $var = $2; 40718716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 40728716de38SJoe Perches ERROR("MISPLACED_INIT", 40738716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 40748716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 40758716de38SJoe Perches WARN("MISPLACED_INIT", 40768716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 40778716de38SJoe Perches $fix) { 40788716de38SJoe 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; 40798716de38SJoe Perches } 40808716de38SJoe Perches } 40818716de38SJoe Perches } 40828716de38SJoe Perches 4083e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4084e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4085e970b884SJoe Perches my $attr = $1; 4086e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4087e970b884SJoe Perches my $attr_prefix = $1; 4088e970b884SJoe Perches my $attr_type = $2; 4089e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4090e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4091e970b884SJoe Perches $fix) { 4092e970b884SJoe Perches $fixed[$linenr - 1] =~ 4093e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4094e970b884SJoe Perches } 4095e970b884SJoe Perches } 4096e970b884SJoe Perches 4097e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4098e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4099e970b884SJoe Perches my $attr = $1; 4100e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4101e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4102e970b884SJoe Perches $fix) { 4103e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 4104e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4105e970b884SJoe Perches $lead = rtrim($1); 4106e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4107e970b884SJoe Perches $lead = "${lead}const "; 4108e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 4109e970b884SJoe Perches } 4110e970b884SJoe Perches } 4111e970b884SJoe Perches 4112fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4113fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4114fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4115fbdb8138SJoe Perches my $constant_func = $1; 4116fbdb8138SJoe Perches my $func = $constant_func; 4117fbdb8138SJoe Perches $func =~ s/^__constant_//; 4118fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4119fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4120fbdb8138SJoe Perches $fix) { 4121fbdb8138SJoe Perches $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g; 4122fbdb8138SJoe Perches } 4123fbdb8138SJoe Perches } 4124fbdb8138SJoe Perches 41251a15a250SPatrick Pannuto# prefer usleep_range over udelay 412637581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 412743c1d77cSJoe Perches my $delay = $1; 41281a15a250SPatrick Pannuto # ignore udelay's < 10, however 412943c1d77cSJoe Perches if (! ($delay < 10) ) { 4130000d1cc1SJoe Perches CHK("USLEEP_RANGE", 413143c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 413243c1d77cSJoe Perches } 413343c1d77cSJoe Perches if ($delay > 2000) { 413443c1d77cSJoe Perches WARN("LONG_UDELAY", 413543c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 41361a15a250SPatrick Pannuto } 41371a15a250SPatrick Pannuto } 41381a15a250SPatrick Pannuto 413909ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 414009ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 414109ef8725SPatrick Pannuto if ($1 < 20) { 4142000d1cc1SJoe Perches WARN("MSLEEP", 414343c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 414409ef8725SPatrick Pannuto } 414509ef8725SPatrick Pannuto } 414609ef8725SPatrick Pannuto 414736ec1939SJoe Perches# check for comparisons of jiffies 414836ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 414936ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 415036ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 415136ec1939SJoe Perches } 415236ec1939SJoe Perches 41539d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 41549d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 41559d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 41569d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 41579d7a34a5SJoe Perches } 41589d7a34a5SJoe Perches 415900df344fSAndy Whitcroft# warn about #ifdefs in C files 4160c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 416100df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 416200df344fSAndy Whitcroft# print "$herecurr"; 416300df344fSAndy Whitcroft# $clean = 0; 416400df344fSAndy Whitcroft# } 416500df344fSAndy Whitcroft 416622f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4167c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 41683705ce5bSJoe Perches if (ERROR("SPACING", 41693705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 41703705ce5bSJoe Perches $fix) { 41713705ce5bSJoe Perches $fixed[$linenr - 1] =~ 41723705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 41733705ce5bSJoe Perches } 41743705ce5bSJoe Perches 417522f2a2efSAndy Whitcroft } 417622f2a2efSAndy Whitcroft 41774a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4178171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4179171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 41804a0df2efSAndy Whitcroft my $which = $1; 41814a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4182000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4183000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 41844a0df2efSAndy Whitcroft } 41854a0df2efSAndy Whitcroft } 41864a0df2efSAndy Whitcroft# check for memory barriers without a comment. 41874a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 41884a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4189c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4190000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 41914a0df2efSAndy Whitcroft } 41924a0df2efSAndy Whitcroft } 41934a0df2efSAndy Whitcroft# check of hardware specific defines 4194c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4195000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4196000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 41970a920b5bSAndy Whitcroft } 4198653d4876SAndy Whitcroft 4199d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4200d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4201000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4202000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4203d4977c78STobias Klauser } 4204d4977c78STobias Klauser 4205de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4206de7d4f0eSAndy Whitcroft# storage class and type. 42079c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 42089c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4209000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4210000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4211de7d4f0eSAndy Whitcroft } 4212de7d4f0eSAndy Whitcroft 42138905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 42142b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42152b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4216d5e616fcSJoe Perches if (WARN("INLINE", 4217d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4218d5e616fcSJoe Perches $fix) { 4219d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 4220d5e616fcSJoe Perches 4221d5e616fcSJoe Perches } 42228905a67cSAndy Whitcroft } 42238905a67cSAndy Whitcroft 42243d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 42252b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42262b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4227000d1cc1SJoe Perches WARN("PREFER_PACKED", 4228000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 42293d130fd0SJoe Perches } 42303d130fd0SJoe Perches 423139b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 42322b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42332b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4234000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4235000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 423639b7e287SJoe Perches } 423739b7e287SJoe Perches 42385f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 42392b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42402b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4241d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4242d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4243d5e616fcSJoe Perches $fix) { 4244d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4245d5e616fcSJoe Perches 4246d5e616fcSJoe Perches } 42475f14d3bdSJoe Perches } 42485f14d3bdSJoe Perches 42496061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 42502b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 42512b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4252d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4253d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4254d5e616fcSJoe Perches $fix) { 4255d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4256d5e616fcSJoe Perches } 42576061d949SJoe Perches } 42586061d949SJoe Perches 42598f53a9b8SJoe Perches# check for sizeof(&) 42608f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4261000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4262000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 42638f53a9b8SJoe Perches } 42648f53a9b8SJoe Perches 426566c80b60SJoe Perches# check for sizeof without parenthesis 426666c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4267d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4268d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4269d5e616fcSJoe Perches $fix) { 4270d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4271d5e616fcSJoe Perches } 427266c80b60SJoe Perches } 427366c80b60SJoe Perches 4274428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4275428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4276000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4277000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4278428e2fdcSJoe Perches } 4279428e2fdcSJoe Perches 428088982feaSJoe Perches# check for struct spinlock declarations 428188982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 428288982feaSJoe Perches WARN("USE_SPINLOCK_T", 428388982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 428488982feaSJoe Perches } 428588982feaSJoe Perches 4286a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 428706668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4288a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 428906668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4290d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4291d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4292d5e616fcSJoe Perches $fix) { 4293d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 4294d5e616fcSJoe Perches } 4295a6962d72SJoe Perches } 4296a6962d72SJoe Perches } 4297a6962d72SJoe Perches 4298554e165cSAndy Whitcroft# Check for misused memsets 4299d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4300d1fe9c09SJoe Perches defined $stat && 4301d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4302554e165cSAndy Whitcroft 4303d7c76ba7SJoe Perches my $ms_addr = $2; 4304d1fe9c09SJoe Perches my $ms_val = $7; 4305d1fe9c09SJoe Perches my $ms_size = $12; 4306d7c76ba7SJoe Perches 4307554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4308554e165cSAndy Whitcroft ERROR("MEMSET", 4309d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4310554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4311554e165cSAndy Whitcroft WARN("MEMSET", 4312d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4313d7c76ba7SJoe Perches } 4314d7c76ba7SJoe Perches } 4315d7c76ba7SJoe Perches 431698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 431798a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 431898a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 431998a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 432098a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 432198a9bba5SJoe Perches $fix) { 432298a9bba5SJoe Perches $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 432398a9bba5SJoe Perches } 432498a9bba5SJoe Perches } 432598a9bba5SJoe Perches 4326d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4327d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4328d1fe9c09SJoe Perches defined $stat && 4329d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4330d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4331d7c76ba7SJoe Perches my $call = $1; 4332d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4333d7c76ba7SJoe Perches my $arg1 = $3; 4334d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4335d1fe9c09SJoe Perches my $arg2 = $8; 4336d7c76ba7SJoe Perches my $cast; 4337d7c76ba7SJoe Perches 4338d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4339d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4340d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4341d7c76ba7SJoe Perches $cast = $cast1; 4342d7c76ba7SJoe Perches } else { 4343d7c76ba7SJoe Perches $cast = $cast2; 4344d7c76ba7SJoe Perches } 4345d7c76ba7SJoe Perches WARN("MINMAX", 4346d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4347554e165cSAndy Whitcroft } 4348554e165cSAndy Whitcroft } 4349554e165cSAndy Whitcroft 43504a273195SJoe Perches# check usleep_range arguments 43514a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 43524a273195SJoe Perches defined $stat && 43534a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 43544a273195SJoe Perches my $min = $1; 43554a273195SJoe Perches my $max = $7; 43564a273195SJoe Perches if ($min eq $max) { 43574a273195SJoe Perches WARN("USLEEP_RANGE", 43584a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 43594a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 43604a273195SJoe Perches $min > $max) { 43614a273195SJoe Perches WARN("USLEEP_RANGE", 43624a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 43634a273195SJoe Perches } 43644a273195SJoe Perches } 43654a273195SJoe Perches 4366823b794cSJoe Perches# check for naked sscanf 4367823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4368823b794cSJoe Perches defined $stat && 43696c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4370823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4371823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4372823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4373823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4374823b794cSJoe Perches $lc = $lc + $linenr; 4375823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4376823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4377823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4378823b794cSJoe Perches } 4379823b794cSJoe Perches WARN("NAKED_SSCANF", 4380823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4381823b794cSJoe Perches } 4382823b794cSJoe Perches 4383afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 4384afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 4385afc819abSJoe Perches defined $stat && 4386afc819abSJoe Perches $line =~ /\bsscanf\b/) { 4387afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 4388afc819abSJoe Perches $lc = $lc + $linenr; 4389afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 4390afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4391afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4392afc819abSJoe Perches } 4393afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 4394afc819abSJoe Perches my $format = $6; 4395afc819abSJoe Perches my $count = $format =~ tr@%@%@; 4396afc819abSJoe Perches if ($count == 1 && 4397afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 4398afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 4399afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 4400afc819abSJoe Perches } 4401afc819abSJoe Perches } 4402afc819abSJoe Perches } 4403afc819abSJoe Perches 440470dc8a48SJoe Perches# check for new externs in .h files. 440570dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 440670dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4407d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 440870dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 440970dc8a48SJoe Perches $fix) { 441070dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 441170dc8a48SJoe Perches } 441270dc8a48SJoe Perches } 441370dc8a48SJoe Perches 4414de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4415171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4416c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4417171ae1a4SAndy Whitcroft { 4418c45dcabdSAndy Whitcroft my $function_name = $1; 4419c45dcabdSAndy Whitcroft my $paren_space = $2; 4420171ae1a4SAndy Whitcroft 4421171ae1a4SAndy Whitcroft my $s = $stat; 4422171ae1a4SAndy Whitcroft if (defined $cond) { 4423171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4424171ae1a4SAndy Whitcroft } 4425c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4426c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4427c45dcabdSAndy Whitcroft { 4428000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4429000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4430de7d4f0eSAndy Whitcroft } 4431de7d4f0eSAndy Whitcroft 4432171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4433000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4434000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4435171ae1a4SAndy Whitcroft } 44369c9ba34eSAndy Whitcroft 44379c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 44389c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 44399c9ba34eSAndy Whitcroft { 4440000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4441000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4442171ae1a4SAndy Whitcroft } 4443171ae1a4SAndy Whitcroft 4444de7d4f0eSAndy Whitcroft# checks for new __setup's 4445de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4446de7d4f0eSAndy Whitcroft my $name = $1; 4447de7d4f0eSAndy Whitcroft 4448de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4449000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4450000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4451de7d4f0eSAndy Whitcroft } 4452653d4876SAndy Whitcroft } 44539c0ca6f9SAndy Whitcroft 44549c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4455caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4456000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4457000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 44589c0ca6f9SAndy Whitcroft } 445913214adfSAndy Whitcroft 4460a640d25cSJoe Perches# alloc style 4461a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4462a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4463a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4464a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4465a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4466a640d25cSJoe Perches } 4467a640d25cSJoe Perches 446860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 446960a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 447060a55369SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) { 447160a55369SJoe Perches my $oldfunc = $3; 447260a55369SJoe Perches my $a1 = $4; 447360a55369SJoe Perches my $a2 = $10; 447460a55369SJoe Perches my $newfunc = "kmalloc_array"; 447560a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 447660a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) { 447760a55369SJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 447860a55369SJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 447960a55369SJoe Perches $fix) { 448060a55369SJoe Perches my $r1 = $a1; 448160a55369SJoe Perches my $r2 = $a2; 448260a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 448360a55369SJoe Perches $r1 = $a2; 448460a55369SJoe Perches $r2 = $a1; 448560a55369SJoe Perches } 448660a55369SJoe 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; 448760a55369SJoe Perches 448860a55369SJoe Perches } 448960a55369SJoe Perches } 449060a55369SJoe Perches } 449160a55369SJoe Perches 4492972fdea2SJoe Perches# check for krealloc arg reuse 4493972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4494972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4495972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4496972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4497972fdea2SJoe Perches } 4498972fdea2SJoe Perches 44995ce59ae0SJoe Perches# check for alloc argument mismatch 45005ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 45015ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 45025ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 45035ce59ae0SJoe Perches } 45045ce59ae0SJoe Perches 4505caf2a54fSJoe Perches# check for multiple semicolons 4506caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4507d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4508d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4509d5e616fcSJoe Perches $fix) { 4510d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4511d5e616fcSJoe Perches } 4512d1e2ad07SJoe Perches } 4513d1e2ad07SJoe Perches 4514c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4515c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4516c34c09a8SJoe Perches my $has_break = 0; 4517c34c09a8SJoe Perches my $has_statement = 0; 4518c34c09a8SJoe Perches my $count = 0; 4519c34c09a8SJoe Perches my $prevline = $linenr; 4520c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4521c34c09a8SJoe Perches $prevline--; 4522c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4523c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4524c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4525c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4526c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4527c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4528c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4529c34c09a8SJoe Perches $has_statement = 1; 4530c34c09a8SJoe Perches $count++; 4531c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4532c34c09a8SJoe Perches } 4533c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4534c34c09a8SJoe Perches WARN("MISSING_BREAK", 4535c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4536c34c09a8SJoe Perches } 4537c34c09a8SJoe Perches } 4538c34c09a8SJoe Perches 4539d1e2ad07SJoe Perches# check for switch/default statements without a break; 4540d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4541d1e2ad07SJoe Perches defined $stat && 4542d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4543d1e2ad07SJoe Perches my $ctx = ''; 4544d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4545d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4546d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4547d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4548d1e2ad07SJoe Perches } 4549d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4550d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4551caf2a54fSJoe Perches } 4552caf2a54fSJoe Perches 455313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4554d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4555d5e616fcSJoe Perches if (WARN("USE_FUNC", 4556d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4557d5e616fcSJoe Perches $fix) { 4558d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4559d5e616fcSJoe Perches } 456013214adfSAndy Whitcroft } 4561773647a0SAndy Whitcroft 45622c92488aSJoe Perches# check for use of yield() 45632c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 45642c92488aSJoe Perches WARN("YIELD", 45652c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 45662c92488aSJoe Perches } 45672c92488aSJoe Perches 4568179f8f40SJoe Perches# check for comparisons against true and false 4569179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4570179f8f40SJoe Perches my $lead = $1; 4571179f8f40SJoe Perches my $arg = $2; 4572179f8f40SJoe Perches my $test = $3; 4573179f8f40SJoe Perches my $otype = $4; 4574179f8f40SJoe Perches my $trail = $5; 4575179f8f40SJoe Perches my $op = "!"; 4576179f8f40SJoe Perches 4577179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4578179f8f40SJoe Perches 4579179f8f40SJoe Perches my $type = lc($otype); 4580179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4581179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4582179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4583179f8f40SJoe Perches $op = ""; 4584179f8f40SJoe Perches } 4585179f8f40SJoe Perches 4586179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4587179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4588179f8f40SJoe Perches 4589179f8f40SJoe Perches## maybe suggesting a correct construct would better 4590179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4591179f8f40SJoe Perches 4592179f8f40SJoe Perches } 4593179f8f40SJoe Perches } 4594179f8f40SJoe Perches 45954882720bSThomas Gleixner# check for semaphores initialized locked 45964882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4597000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4598000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4599773647a0SAndy Whitcroft } 46006712d858SJoe Perches 460167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 460267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4603000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 460467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4605773647a0SAndy Whitcroft } 46066712d858SJoe Perches 4607ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 4608f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4609000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4610ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 4611f3db6639SMichael Ellerman } 46126712d858SJoe Perches 461379404849SEmese Revfy# check for various ops structs, ensure they are const. 461479404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 461579404849SEmese Revfy address_space_operations| 461679404849SEmese Revfy backlight_ops| 461779404849SEmese Revfy block_device_operations| 461879404849SEmese Revfy dentry_operations| 461979404849SEmese Revfy dev_pm_ops| 462079404849SEmese Revfy dma_map_ops| 462179404849SEmese Revfy extent_io_ops| 462279404849SEmese Revfy file_lock_operations| 462379404849SEmese Revfy file_operations| 462479404849SEmese Revfy hv_ops| 462579404849SEmese Revfy ide_dma_ops| 462679404849SEmese Revfy intel_dvo_dev_ops| 462779404849SEmese Revfy item_operations| 462879404849SEmese Revfy iwl_ops| 462979404849SEmese Revfy kgdb_arch| 463079404849SEmese Revfy kgdb_io| 463179404849SEmese Revfy kset_uevent_ops| 463279404849SEmese Revfy lock_manager_operations| 463379404849SEmese Revfy microcode_ops| 463479404849SEmese Revfy mtrr_ops| 463579404849SEmese Revfy neigh_ops| 463679404849SEmese Revfy nlmsvc_binding| 463779404849SEmese Revfy pci_raw_ops| 463879404849SEmese Revfy pipe_buf_operations| 463979404849SEmese Revfy platform_hibernation_ops| 464079404849SEmese Revfy platform_suspend_ops| 464179404849SEmese Revfy proto_ops| 464279404849SEmese Revfy rpc_pipe_ops| 464379404849SEmese Revfy seq_operations| 464479404849SEmese Revfy snd_ac97_build_ops| 464579404849SEmese Revfy soc_pcmcia_socket_ops| 464679404849SEmese Revfy stacktrace_ops| 464779404849SEmese Revfy sysfs_ops| 464879404849SEmese Revfy tty_operations| 464979404849SEmese Revfy usb_mon_operations| 465079404849SEmese Revfy wd_ops}x; 46516903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 465279404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4653000d1cc1SJoe Perches WARN("CONST_STRUCT", 4654000d1cc1SJoe Perches "struct $1 should normally be const\n" . 46556903ffb2SAndy Whitcroft $herecurr); 46562b6db5cbSAndy Whitcroft } 4657773647a0SAndy Whitcroft 4658773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4659773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4660773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4661c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4662c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4663171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4664171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4665171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4666773647a0SAndy Whitcroft { 4667000d1cc1SJoe Perches WARN("NR_CPUS", 4668000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4669773647a0SAndy Whitcroft } 46709c9ba34eSAndy Whitcroft 467152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 467252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 467352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 467452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 467552ea8506SJoe Perches } 467652ea8506SJoe Perches 46779c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 46789c9ba34eSAndy Whitcroft my $string; 46799c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 46809c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 46812a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 46829c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4683000d1cc1SJoe Perches WARN("PRINTF_L", 4684000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 46859c9ba34eSAndy Whitcroft last; 46869c9ba34eSAndy Whitcroft } 46879c9ba34eSAndy Whitcroft } 4688691d77b6SAndy Whitcroft 4689691d77b6SAndy Whitcroft# whine mightly about in_atomic 4690691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4691691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4692000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4693000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4694f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4695000d1cc1SJoe Perches WARN("IN_ATOMIC", 4696000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4697691d77b6SAndy Whitcroft } 4698691d77b6SAndy Whitcroft } 46991704f47bSPeter Zijlstra 47001704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 47011704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 47021704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 47031704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 47041704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 47051704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4706000d1cc1SJoe Perches ERROR("LOCKDEP", 4707000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 47081704f47bSPeter Zijlstra } 47091704f47bSPeter Zijlstra } 471088f8831cSDave Jones 471188f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 471288f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4713000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4714000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 471588f8831cSDave Jones } 47162435880fSJoe Perches 4717515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 4718515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 4719515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 4720515a235eSJoe Perches $line =~ /$mode_perms_search/) { 47212435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 47222435880fSJoe Perches my $func = $entry->[0]; 47232435880fSJoe Perches my $arg_pos = $entry->[1]; 47242435880fSJoe Perches 47252435880fSJoe Perches my $skip_args = ""; 47262435880fSJoe Perches if ($arg_pos > 1) { 47272435880fSJoe Perches $arg_pos--; 47282435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 47292435880fSJoe Perches } 47302435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 4731515a235eSJoe Perches if ($line =~ /$test/) { 47322435880fSJoe Perches my $val = $1; 47332435880fSJoe Perches $val = $6 if ($skip_args ne ""); 47342435880fSJoe Perches 47351727cc70SJoe Perches if ($val !~ /^0$/ && 47361727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 47371727cc70SJoe Perches length($val) ne 4)) { 47382435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 47391727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 47402435880fSJoe Perches } 47412435880fSJoe Perches } 47422435880fSJoe Perches } 474313214adfSAndy Whitcroft } 4744515a235eSJoe Perches } 474513214adfSAndy Whitcroft 474613214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 474713214adfSAndy Whitcroft # so just keep quiet. 474813214adfSAndy Whitcroft if ($#rawlines == -1) { 474913214adfSAndy Whitcroft exit(0); 47500a920b5bSAndy Whitcroft } 47510a920b5bSAndy Whitcroft 47528905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 47538905a67cSAndy Whitcroft # things that appear to be patches. 47548905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 47558905a67cSAndy Whitcroft exit(0); 47568905a67cSAndy Whitcroft } 47578905a67cSAndy Whitcroft 47588905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 47598905a67cSAndy Whitcroft # just keep quiet. 47608905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 47618905a67cSAndy Whitcroft exit(0); 47628905a67cSAndy Whitcroft } 47638905a67cSAndy Whitcroft 47648905a67cSAndy Whitcroft if (!$is_patch) { 4765000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4766000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 47670a920b5bSAndy Whitcroft } 47680a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4769000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4770000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 47710a920b5bSAndy Whitcroft } 47720a920b5bSAndy Whitcroft 4773f0a594c1SAndy Whitcroft print report_dump(); 477413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 477513214adfSAndy Whitcroft print "$filename " if ($summary_file); 47766c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 47776c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 47786c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 47798905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 47806c72ffaaSAndy Whitcroft } 47818905a67cSAndy Whitcroft 4782d2c0a235SAndy Whitcroft if ($quiet == 0) { 4783d1fe9c09SJoe Perches 4784d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4785d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4786d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4787d1fe9c09SJoe Perches } 4788d1fe9c09SJoe Perches 4789d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4790d2c0a235SAndy Whitcroft # then suggest that. 4791d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4792d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4793d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4794b0781216SMike Frysinger $rpt_cleaners = 0; 4795d2c0a235SAndy Whitcroft } 4796d2c0a235SAndy Whitcroft } 4797d2c0a235SAndy Whitcroft 479891bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 479991bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4800000d1cc1SJoe Perches 48013705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 48029624b8d6SJoe Perches my $newfile = $filename; 48039624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 48043705ce5bSJoe Perches my $linecount = 0; 48053705ce5bSJoe Perches my $f; 48063705ce5bSJoe Perches 48073705ce5bSJoe Perches open($f, '>', $newfile) 48083705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 48093705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 48103705ce5bSJoe Perches $linecount++; 48113705ce5bSJoe Perches if ($file) { 48123705ce5bSJoe Perches if ($linecount > 3) { 48133705ce5bSJoe Perches $fixed_line =~ s/^\+//; 48143705ce5bSJoe Perches print $f $fixed_line. "\n"; 48153705ce5bSJoe Perches } 48163705ce5bSJoe Perches } else { 48173705ce5bSJoe Perches print $f $fixed_line . "\n"; 48183705ce5bSJoe Perches } 48193705ce5bSJoe Perches } 48203705ce5bSJoe Perches close($f); 48213705ce5bSJoe Perches 48223705ce5bSJoe Perches if (!$quiet) { 48233705ce5bSJoe Perches print << "EOM"; 48243705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 48253705ce5bSJoe Perches 48263705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 48273705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 48283705ce5bSJoe Perches 48293705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 48303705ce5bSJoe PerchesNo warranties, expressed or implied... 48313705ce5bSJoe Perches 48323705ce5bSJoe PerchesEOM 48333705ce5bSJoe Perches } 48343705ce5bSJoe Perches } 48353705ce5bSJoe Perches 48360a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4837c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 48380a920b5bSAndy Whitcroft } 48390a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4840000d1cc1SJoe Perches print << "EOM"; 4841000d1cc1SJoe Perches$vname has style problems, please review. 4842000d1cc1SJoe Perches 4843000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4844000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4845000d1cc1SJoe PerchesEOM 48460a920b5bSAndy Whitcroft } 484713214adfSAndy Whitcroft 48480a920b5bSAndy Whitcroft return $clean; 48490a920b5bSAndy Whitcroft} 4850