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 4381574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\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 553d311cd44SJoe Perchessub git_commit_info { 554d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 555d311cd44SJoe Perches 556d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 557d311cd44SJoe Perches 558d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 559d311cd44SJoe Perches $output =~ s/^\s*//gm; 560d311cd44SJoe Perches my @lines = split("\n", $output); 561d311cd44SJoe Perches 562d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 563d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 564d311cd44SJoe Perches# all matching commit ids, but it's very slow... 565d311cd44SJoe Perches# 566d311cd44SJoe Perches# echo "checking commits $1..." 567d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 568d311cd44SJoe Perches# while read line ; do 569d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 570d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 571d311cd44SJoe Perches# done 572d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 573d311cd44SJoe Perches } else { 574d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 575d311cd44SJoe Perches $desc = substr($lines[0], 41); 576d311cd44SJoe Perches } 577d311cd44SJoe Perches 578d311cd44SJoe Perches return ($id, $desc); 579d311cd44SJoe Perches} 580d311cd44SJoe Perches 5816c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5820a920b5bSAndy Whitcroft 58300df344fSAndy Whitcroftmy @rawlines = (); 584c2fdda0dSAndy Whitcroftmy @lines = (); 5853705ce5bSJoe Perchesmy @fixed = (); 586d752fcc8SJoe Perchesmy @fixed_inserted = (); 587d752fcc8SJoe Perchesmy @fixed_deleted = (); 588194f66fcSJoe Perchesmy $fixlinenr = -1; 589194f66fcSJoe Perches 590c2fdda0dSAndy Whitcroftmy $vname; 5916c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 59221caa13cSAndy Whitcroft my $FILE; 5936c72ffaaSAndy Whitcroft if ($file) { 59421caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5956c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 59621caa13cSAndy Whitcroft } elsif ($filename eq '-') { 59721caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5986c72ffaaSAndy Whitcroft } else { 59921caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 6006c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 6016c72ffaaSAndy Whitcroft } 602c2fdda0dSAndy Whitcroft if ($filename eq '-') { 603c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 604c2fdda0dSAndy Whitcroft } else { 605c2fdda0dSAndy Whitcroft $vname = $filename; 606c2fdda0dSAndy Whitcroft } 60721caa13cSAndy Whitcroft while (<$FILE>) { 6080a920b5bSAndy Whitcroft chomp; 60900df344fSAndy Whitcroft push(@rawlines, $_); 6106c72ffaaSAndy Whitcroft } 61121caa13cSAndy Whitcroft close($FILE); 612c2fdda0dSAndy Whitcroft if (!process($filename)) { 6130a920b5bSAndy Whitcroft $exit = 1; 6140a920b5bSAndy Whitcroft } 61500df344fSAndy Whitcroft @rawlines = (); 61613214adfSAndy Whitcroft @lines = (); 6173705ce5bSJoe Perches @fixed = (); 618d752fcc8SJoe Perches @fixed_inserted = (); 619d752fcc8SJoe Perches @fixed_deleted = (); 620194f66fcSJoe Perches $fixlinenr = -1; 6210a920b5bSAndy Whitcroft} 6220a920b5bSAndy Whitcroft 6230a920b5bSAndy Whitcroftexit($exit); 6240a920b5bSAndy Whitcroft 6250a920b5bSAndy Whitcroftsub top_of_kernel_tree { 6266c72ffaaSAndy Whitcroft my ($root) = @_; 6276c72ffaaSAndy Whitcroft 6286c72ffaaSAndy Whitcroft my @tree_check = ( 6296c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 6306c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 6316c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 6326c72ffaaSAndy Whitcroft ); 6336c72ffaaSAndy Whitcroft 6346c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 6356c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 6360a920b5bSAndy Whitcroft return 0; 6370a920b5bSAndy Whitcroft } 6386c72ffaaSAndy Whitcroft } 6396c72ffaaSAndy Whitcroft return 1; 6406c72ffaaSAndy Whitcroft} 6410a920b5bSAndy Whitcroft 64220112475SJoe Perchessub parse_email { 64320112475SJoe Perches my ($formatted_email) = @_; 64420112475SJoe Perches 64520112475SJoe Perches my $name = ""; 64620112475SJoe Perches my $address = ""; 64720112475SJoe Perches my $comment = ""; 64820112475SJoe Perches 64920112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 65020112475SJoe Perches $name = $1; 65120112475SJoe Perches $address = $2; 65220112475SJoe Perches $comment = $3 if defined $3; 65320112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 65420112475SJoe Perches $address = $1; 65520112475SJoe Perches $comment = $2 if defined $2; 65620112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 65720112475SJoe Perches $address = $1; 65820112475SJoe Perches $comment = $2 if defined $2; 65920112475SJoe Perches $formatted_email =~ s/$address.*$//; 66020112475SJoe Perches $name = $formatted_email; 6613705ce5bSJoe Perches $name = trim($name); 66220112475SJoe Perches $name =~ s/^\"|\"$//g; 66320112475SJoe Perches # If there's a name left after stripping spaces and 66420112475SJoe Perches # leading quotes, and the address doesn't have both 66520112475SJoe Perches # leading and trailing angle brackets, the address 66620112475SJoe Perches # is invalid. ie: 66720112475SJoe Perches # "joe smith [email protected]" bad 66820112475SJoe Perches # "joe smith <[email protected]" bad 66920112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 67020112475SJoe Perches $name = ""; 67120112475SJoe Perches $address = ""; 67220112475SJoe Perches $comment = ""; 67320112475SJoe Perches } 67420112475SJoe Perches } 67520112475SJoe Perches 6763705ce5bSJoe Perches $name = trim($name); 67720112475SJoe Perches $name =~ s/^\"|\"$//g; 6783705ce5bSJoe Perches $address = trim($address); 67920112475SJoe Perches $address =~ s/^\<|\>$//g; 68020112475SJoe Perches 68120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 68220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 68320112475SJoe Perches $name = "\"$name\""; 68420112475SJoe Perches } 68520112475SJoe Perches 68620112475SJoe Perches return ($name, $address, $comment); 68720112475SJoe Perches} 68820112475SJoe Perches 68920112475SJoe Perchessub format_email { 69020112475SJoe Perches my ($name, $address) = @_; 69120112475SJoe Perches 69220112475SJoe Perches my $formatted_email; 69320112475SJoe Perches 6943705ce5bSJoe Perches $name = trim($name); 69520112475SJoe Perches $name =~ s/^\"|\"$//g; 6963705ce5bSJoe Perches $address = trim($address); 69720112475SJoe Perches 69820112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 69920112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 70020112475SJoe Perches $name = "\"$name\""; 70120112475SJoe Perches } 70220112475SJoe Perches 70320112475SJoe Perches if ("$name" eq "") { 70420112475SJoe Perches $formatted_email = "$address"; 70520112475SJoe Perches } else { 70620112475SJoe Perches $formatted_email = "$name <$address>"; 70720112475SJoe Perches } 70820112475SJoe Perches 70920112475SJoe Perches return $formatted_email; 71020112475SJoe Perches} 71120112475SJoe Perches 712d311cd44SJoe Perchessub which { 713d311cd44SJoe Perches my ($bin) = @_; 714d311cd44SJoe Perches 715d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 716d311cd44SJoe Perches if (-e "$path/$bin") { 717d311cd44SJoe Perches return "$path/$bin"; 718d311cd44SJoe Perches } 719d311cd44SJoe Perches } 720d311cd44SJoe Perches 721d311cd44SJoe Perches return ""; 722d311cd44SJoe Perches} 723d311cd44SJoe Perches 724000d1cc1SJoe Perchessub which_conf { 725000d1cc1SJoe Perches my ($conf) = @_; 726000d1cc1SJoe Perches 727000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 728000d1cc1SJoe Perches if (-e "$path/$conf") { 729000d1cc1SJoe Perches return "$path/$conf"; 730000d1cc1SJoe Perches } 731000d1cc1SJoe Perches } 732000d1cc1SJoe Perches 733000d1cc1SJoe Perches return ""; 734000d1cc1SJoe Perches} 735000d1cc1SJoe Perches 7360a920b5bSAndy Whitcroftsub expand_tabs { 7370a920b5bSAndy Whitcroft my ($str) = @_; 7380a920b5bSAndy Whitcroft 7390a920b5bSAndy Whitcroft my $res = ''; 7400a920b5bSAndy Whitcroft my $n = 0; 7410a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 7420a920b5bSAndy Whitcroft if ($c eq "\t") { 7430a920b5bSAndy Whitcroft $res .= ' '; 7440a920b5bSAndy Whitcroft $n++; 7450a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 7460a920b5bSAndy Whitcroft $res .= ' '; 7470a920b5bSAndy Whitcroft } 7480a920b5bSAndy Whitcroft next; 7490a920b5bSAndy Whitcroft } 7500a920b5bSAndy Whitcroft $res .= $c; 7510a920b5bSAndy Whitcroft $n++; 7520a920b5bSAndy Whitcroft } 7530a920b5bSAndy Whitcroft 7540a920b5bSAndy Whitcroft return $res; 7550a920b5bSAndy Whitcroft} 7566c72ffaaSAndy Whitcroftsub copy_spacing { 757773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 7586c72ffaaSAndy Whitcroft return $res; 7596c72ffaaSAndy Whitcroft} 7600a920b5bSAndy Whitcroft 7614a0df2efSAndy Whitcroftsub line_stats { 7624a0df2efSAndy Whitcroft my ($line) = @_; 7634a0df2efSAndy Whitcroft 7644a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 7654a0df2efSAndy Whitcroft $line =~ s/^.//; 7664a0df2efSAndy Whitcroft $line = expand_tabs($line); 7674a0df2efSAndy Whitcroft 7684a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 7694a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 7704a0df2efSAndy Whitcroft 7714a0df2efSAndy Whitcroft return (length($line), length($white)); 7724a0df2efSAndy Whitcroft} 7734a0df2efSAndy Whitcroft 774773647a0SAndy Whitcroftmy $sanitise_quote = ''; 775773647a0SAndy Whitcroft 776773647a0SAndy Whitcroftsub sanitise_line_reset { 777773647a0SAndy Whitcroft my ($in_comment) = @_; 778773647a0SAndy Whitcroft 779773647a0SAndy Whitcroft if ($in_comment) { 780773647a0SAndy Whitcroft $sanitise_quote = '*/'; 781773647a0SAndy Whitcroft } else { 782773647a0SAndy Whitcroft $sanitise_quote = ''; 783773647a0SAndy Whitcroft } 784773647a0SAndy Whitcroft} 78500df344fSAndy Whitcroftsub sanitise_line { 78600df344fSAndy Whitcroft my ($line) = @_; 78700df344fSAndy Whitcroft 78800df344fSAndy Whitcroft my $res = ''; 78900df344fSAndy Whitcroft my $l = ''; 79000df344fSAndy Whitcroft 791c2fdda0dSAndy Whitcroft my $qlen = 0; 792773647a0SAndy Whitcroft my $off = 0; 793773647a0SAndy Whitcroft my $c; 79400df344fSAndy Whitcroft 795773647a0SAndy Whitcroft # Always copy over the diff marker. 796773647a0SAndy Whitcroft $res = substr($line, 0, 1); 797773647a0SAndy Whitcroft 798773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 799773647a0SAndy Whitcroft $c = substr($line, $off, 1); 800773647a0SAndy Whitcroft 801773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 802773647a0SAndy Whitcroft # and end, all to $;. 803773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 804773647a0SAndy Whitcroft $sanitise_quote = '*/'; 805773647a0SAndy Whitcroft 806773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 807773647a0SAndy Whitcroft $off++; 80800df344fSAndy Whitcroft next; 809773647a0SAndy Whitcroft } 81081bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 811773647a0SAndy Whitcroft $sanitise_quote = ''; 812773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 813773647a0SAndy Whitcroft $off++; 814773647a0SAndy Whitcroft next; 815773647a0SAndy Whitcroft } 816113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 817113f04a8SDaniel Walker $sanitise_quote = '//'; 818113f04a8SDaniel Walker 819113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 820113f04a8SDaniel Walker $off++; 821113f04a8SDaniel Walker next; 822113f04a8SDaniel Walker } 823773647a0SAndy Whitcroft 824773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 825773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 826773647a0SAndy Whitcroft $c eq "\\") { 827773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 828773647a0SAndy Whitcroft $off++; 829773647a0SAndy Whitcroft next; 830773647a0SAndy Whitcroft } 831773647a0SAndy Whitcroft # Regular quotes. 832773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 833773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 834773647a0SAndy Whitcroft $sanitise_quote = $c; 835773647a0SAndy Whitcroft 836773647a0SAndy Whitcroft substr($res, $off, 1, $c); 837773647a0SAndy Whitcroft next; 838773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 839773647a0SAndy Whitcroft $sanitise_quote = ''; 84000df344fSAndy Whitcroft } 84100df344fSAndy Whitcroft } 842773647a0SAndy Whitcroft 843fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 844773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 845773647a0SAndy Whitcroft substr($res, $off, 1, $;); 846113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 847113f04a8SDaniel Walker substr($res, $off, 1, $;); 848773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 849773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 85000df344fSAndy Whitcroft } else { 851773647a0SAndy Whitcroft substr($res, $off, 1, $c); 85200df344fSAndy Whitcroft } 853c2fdda0dSAndy Whitcroft } 854c2fdda0dSAndy Whitcroft 855113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 856113f04a8SDaniel Walker $sanitise_quote = ''; 857113f04a8SDaniel Walker } 858113f04a8SDaniel Walker 859c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 860c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 861c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 862c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 863c2fdda0dSAndy Whitcroft 864c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 865c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 866c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 867c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 868c2fdda0dSAndy Whitcroft } 869c2fdda0dSAndy Whitcroft 87000df344fSAndy Whitcroft return $res; 87100df344fSAndy Whitcroft} 87200df344fSAndy Whitcroft 873a6962d72SJoe Perchessub get_quoted_string { 874a6962d72SJoe Perches my ($line, $rawline) = @_; 875a6962d72SJoe Perches 876a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 877a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 878a6962d72SJoe Perches} 879a6962d72SJoe Perches 8808905a67cSAndy Whitcroftsub ctx_statement_block { 8818905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8828905a67cSAndy Whitcroft my $line = $linenr - 1; 8838905a67cSAndy Whitcroft my $blk = ''; 8848905a67cSAndy Whitcroft my $soff = $off; 8858905a67cSAndy Whitcroft my $coff = $off - 1; 886773647a0SAndy Whitcroft my $coff_set = 0; 8878905a67cSAndy Whitcroft 88813214adfSAndy Whitcroft my $loff = 0; 88913214adfSAndy Whitcroft 8908905a67cSAndy Whitcroft my $type = ''; 8918905a67cSAndy Whitcroft my $level = 0; 892a2750645SAndy Whitcroft my @stack = (); 893cf655043SAndy Whitcroft my $p; 8948905a67cSAndy Whitcroft my $c; 8958905a67cSAndy Whitcroft my $len = 0; 89613214adfSAndy Whitcroft 89713214adfSAndy Whitcroft my $remainder; 8988905a67cSAndy Whitcroft while (1) { 899a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 900a2750645SAndy Whitcroft 901773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 9028905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 9038905a67cSAndy Whitcroft # context. 9048905a67cSAndy Whitcroft if ($off >= $len) { 9058905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 906dea33496SAndy Whitcroft last if (!defined $lines[$line]); 907c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 9088905a67cSAndy Whitcroft $remain--; 90913214adfSAndy Whitcroft $loff = $len; 910c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 9118905a67cSAndy Whitcroft $len = length($blk); 9128905a67cSAndy Whitcroft $line++; 9138905a67cSAndy Whitcroft last; 9148905a67cSAndy Whitcroft } 9158905a67cSAndy Whitcroft # Bail if there is no further context. 9168905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 91713214adfSAndy Whitcroft if ($off >= $len) { 9188905a67cSAndy Whitcroft last; 9198905a67cSAndy Whitcroft } 920f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 921f74bd194SAndy Whitcroft $level++; 922f74bd194SAndy Whitcroft $type = '#'; 923f74bd194SAndy Whitcroft } 9248905a67cSAndy Whitcroft } 925cf655043SAndy Whitcroft $p = $c; 9268905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 92713214adfSAndy Whitcroft $remainder = substr($blk, $off); 9288905a67cSAndy Whitcroft 929773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 9304635f4fbSAndy Whitcroft 9314635f4fbSAndy Whitcroft # Handle nested #if/#else. 9324635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 9334635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 9344635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 9354635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 9364635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 9374635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 9384635f4fbSAndy Whitcroft } 9394635f4fbSAndy Whitcroft 9408905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 9418905a67cSAndy Whitcroft # outermost level. 9428905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 9438905a67cSAndy Whitcroft last; 9448905a67cSAndy Whitcroft } 9458905a67cSAndy Whitcroft 94613214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 947773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 948773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 949773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 950773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 951773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 952773647a0SAndy Whitcroft $coff_set = 1; 953773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 954773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 95513214adfSAndy Whitcroft } 95613214adfSAndy Whitcroft 9578905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 9588905a67cSAndy Whitcroft $level++; 9598905a67cSAndy Whitcroft $type = '('; 9608905a67cSAndy Whitcroft } 9618905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 9628905a67cSAndy Whitcroft $level--; 9638905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 9648905a67cSAndy Whitcroft 9658905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 9668905a67cSAndy Whitcroft $coff = $off; 967773647a0SAndy Whitcroft $coff_set = 1; 968773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 9698905a67cSAndy Whitcroft } 9708905a67cSAndy Whitcroft } 9718905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 9728905a67cSAndy Whitcroft $level++; 9738905a67cSAndy Whitcroft $type = '{'; 9748905a67cSAndy Whitcroft } 9758905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 9768905a67cSAndy Whitcroft $level--; 9778905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9788905a67cSAndy Whitcroft 9798905a67cSAndy Whitcroft if ($level == 0) { 980b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 981b998e001SPatrick Pannuto $off++; 982b998e001SPatrick Pannuto } 9838905a67cSAndy Whitcroft last; 9848905a67cSAndy Whitcroft } 9858905a67cSAndy Whitcroft } 986f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 987f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 988f74bd194SAndy Whitcroft $level--; 989f74bd194SAndy Whitcroft $type = ''; 990f74bd194SAndy Whitcroft $off++; 991f74bd194SAndy Whitcroft last; 992f74bd194SAndy Whitcroft } 9938905a67cSAndy Whitcroft $off++; 9948905a67cSAndy Whitcroft } 995a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 99613214adfSAndy Whitcroft if ($off == $len) { 997a3bb97a7SAndy Whitcroft $loff = $len + 1; 99813214adfSAndy Whitcroft $line++; 99913214adfSAndy Whitcroft $remain--; 100013214adfSAndy Whitcroft } 10018905a67cSAndy Whitcroft 10028905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 10038905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 10048905a67cSAndy Whitcroft 10058905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 10068905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 10078905a67cSAndy Whitcroft 1008773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 100913214adfSAndy Whitcroft 101013214adfSAndy Whitcroft return ($statement, $condition, 101113214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 101213214adfSAndy Whitcroft} 101313214adfSAndy Whitcroft 1014cf655043SAndy Whitcroftsub statement_lines { 1015cf655043SAndy Whitcroft my ($stmt) = @_; 1016cf655043SAndy Whitcroft 1017cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1018cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1019cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1020cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1021cf655043SAndy Whitcroft 1022cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1023cf655043SAndy Whitcroft 1024cf655043SAndy Whitcroft return $#stmt_lines + 2; 1025cf655043SAndy Whitcroft} 1026cf655043SAndy Whitcroft 1027cf655043SAndy Whitcroftsub statement_rawlines { 1028cf655043SAndy Whitcroft my ($stmt) = @_; 1029cf655043SAndy Whitcroft 1030cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1031cf655043SAndy Whitcroft 1032cf655043SAndy Whitcroft return $#stmt_lines + 2; 1033cf655043SAndy Whitcroft} 1034cf655043SAndy Whitcroft 1035cf655043SAndy Whitcroftsub statement_block_size { 1036cf655043SAndy Whitcroft my ($stmt) = @_; 1037cf655043SAndy Whitcroft 1038cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1039cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1040cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1041cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1042cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1043cf655043SAndy Whitcroft 1044cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1045cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1046cf655043SAndy Whitcroft 1047cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1048cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1049cf655043SAndy Whitcroft 1050cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1051cf655043SAndy Whitcroft return $stmt_lines; 1052cf655043SAndy Whitcroft } else { 1053cf655043SAndy Whitcroft return $stmt_statements; 1054cf655043SAndy Whitcroft } 1055cf655043SAndy Whitcroft} 1056cf655043SAndy Whitcroft 105713214adfSAndy Whitcroftsub ctx_statement_full { 105813214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 105913214adfSAndy Whitcroft my ($statement, $condition, $level); 106013214adfSAndy Whitcroft 106113214adfSAndy Whitcroft my (@chunks); 106213214adfSAndy Whitcroft 1063cf655043SAndy Whitcroft # Grab the first conditional/block pair. 106413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 106513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1066773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 106713214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1068cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1069cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1070cf655043SAndy Whitcroft } 1071cf655043SAndy Whitcroft 1072cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1073cf655043SAndy Whitcroft # could continue the statement. 1074cf655043SAndy Whitcroft for (;;) { 107513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 107613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1077cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1078773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1079cf655043SAndy Whitcroft #print "C: push\n"; 1080cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 108113214adfSAndy Whitcroft } 108213214adfSAndy Whitcroft 108313214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10848905a67cSAndy Whitcroft} 10858905a67cSAndy Whitcroft 10864a0df2efSAndy Whitcroftsub ctx_block_get { 1087f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10884a0df2efSAndy Whitcroft my $line; 10894a0df2efSAndy Whitcroft my $start = $linenr - 1; 10904a0df2efSAndy Whitcroft my $blk = ''; 10914a0df2efSAndy Whitcroft my @o; 10924a0df2efSAndy Whitcroft my @c; 10934a0df2efSAndy Whitcroft my @res = (); 10944a0df2efSAndy Whitcroft 1095f0a594c1SAndy Whitcroft my $level = 0; 10964635f4fbSAndy Whitcroft my @stack = ($level); 109700df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 109800df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 109900df344fSAndy Whitcroft $remain--; 110000df344fSAndy Whitcroft 110100df344fSAndy Whitcroft $blk .= $rawlines[$line]; 11024635f4fbSAndy Whitcroft 11034635f4fbSAndy Whitcroft # Handle nested #if/#else. 110401464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 11054635f4fbSAndy Whitcroft push(@stack, $level); 110601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 11074635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 110801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 11094635f4fbSAndy Whitcroft $level = pop(@stack); 11104635f4fbSAndy Whitcroft } 11114635f4fbSAndy Whitcroft 111201464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1113f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1114f0a594c1SAndy Whitcroft if ($off > 0) { 1115f0a594c1SAndy Whitcroft $off--; 1116f0a594c1SAndy Whitcroft next; 1117f0a594c1SAndy Whitcroft } 11184a0df2efSAndy Whitcroft 1119f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1120f0a594c1SAndy Whitcroft $level--; 1121f0a594c1SAndy Whitcroft last if ($level == 0); 1122f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1123f0a594c1SAndy Whitcroft $level++; 1124f0a594c1SAndy Whitcroft } 1125f0a594c1SAndy Whitcroft } 11264a0df2efSAndy Whitcroft 1127f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 112800df344fSAndy Whitcroft push(@res, $rawlines[$line]); 11294a0df2efSAndy Whitcroft } 11304a0df2efSAndy Whitcroft 1131f0a594c1SAndy Whitcroft last if ($level == 0); 11324a0df2efSAndy Whitcroft } 11334a0df2efSAndy Whitcroft 1134f0a594c1SAndy Whitcroft return ($level, @res); 11354a0df2efSAndy Whitcroft} 11364a0df2efSAndy Whitcroftsub ctx_block_outer { 11374a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 11384a0df2efSAndy Whitcroft 1139f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1140f0a594c1SAndy Whitcroft return @r; 11414a0df2efSAndy Whitcroft} 11424a0df2efSAndy Whitcroftsub ctx_block { 11434a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 11444a0df2efSAndy Whitcroft 1145f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1146f0a594c1SAndy Whitcroft return @r; 1147653d4876SAndy Whitcroft} 1148653d4876SAndy Whitcroftsub ctx_statement { 1149f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1150f0a594c1SAndy Whitcroft 1151f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1152f0a594c1SAndy Whitcroft return @r; 1153f0a594c1SAndy Whitcroft} 1154f0a594c1SAndy Whitcroftsub ctx_block_level { 1155653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1156653d4876SAndy Whitcroft 1157f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 11584a0df2efSAndy Whitcroft} 11599c0ca6f9SAndy Whitcroftsub ctx_statement_level { 11609c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 11619c0ca6f9SAndy Whitcroft 11629c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 11639c0ca6f9SAndy Whitcroft} 11644a0df2efSAndy Whitcroft 11654a0df2efSAndy Whitcroftsub ctx_locate_comment { 11664a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11674a0df2efSAndy Whitcroft 11684a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1169beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 11704a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 11714a0df2efSAndy Whitcroft 11724a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 11734a0df2efSAndy Whitcroft # comment. 11744a0df2efSAndy Whitcroft my $in_comment = 0; 11754a0df2efSAndy Whitcroft $current_comment = ''; 11764a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 117700df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 117800df344fSAndy Whitcroft #warn " $line\n"; 11794a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11804a0df2efSAndy Whitcroft $in_comment = 1; 11814a0df2efSAndy Whitcroft } 11824a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11834a0df2efSAndy Whitcroft $in_comment = 1; 11844a0df2efSAndy Whitcroft } 11854a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11864a0df2efSAndy Whitcroft $current_comment = ''; 11874a0df2efSAndy Whitcroft } 11884a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11894a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11904a0df2efSAndy Whitcroft $in_comment = 0; 11914a0df2efSAndy Whitcroft } 11924a0df2efSAndy Whitcroft } 11934a0df2efSAndy Whitcroft 11944a0df2efSAndy Whitcroft chomp($current_comment); 11954a0df2efSAndy Whitcroft return($current_comment); 11964a0df2efSAndy Whitcroft} 11974a0df2efSAndy Whitcroftsub ctx_has_comment { 11984a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11994a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 12004a0df2efSAndy Whitcroft 120100df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 12024a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 12034a0df2efSAndy Whitcroft 12044a0df2efSAndy Whitcroft return ($cmt ne ''); 12054a0df2efSAndy Whitcroft} 12064a0df2efSAndy Whitcroft 12074d001e4dSAndy Whitcroftsub raw_line { 12084d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 12094d001e4dSAndy Whitcroft 12104d001e4dSAndy Whitcroft my $offset = $linenr - 1; 12114d001e4dSAndy Whitcroft $cnt++; 12124d001e4dSAndy Whitcroft 12134d001e4dSAndy Whitcroft my $line; 12144d001e4dSAndy Whitcroft while ($cnt) { 12154d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 12164d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 12174d001e4dSAndy Whitcroft $cnt--; 12184d001e4dSAndy Whitcroft } 12194d001e4dSAndy Whitcroft 12204d001e4dSAndy Whitcroft return $line; 12214d001e4dSAndy Whitcroft} 12224d001e4dSAndy Whitcroft 12230a920b5bSAndy Whitcroftsub cat_vet { 12240a920b5bSAndy Whitcroft my ($vet) = @_; 12259c0ca6f9SAndy Whitcroft my ($res, $coded); 12260a920b5bSAndy Whitcroft 12279c0ca6f9SAndy Whitcroft $res = ''; 12286c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 12296c72ffaaSAndy Whitcroft $res .= $1; 12306c72ffaaSAndy Whitcroft if ($2 ne '') { 12319c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 12326c72ffaaSAndy Whitcroft $res .= $coded; 12336c72ffaaSAndy Whitcroft } 12349c0ca6f9SAndy Whitcroft } 12359c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 12360a920b5bSAndy Whitcroft 12379c0ca6f9SAndy Whitcroft return $res; 12380a920b5bSAndy Whitcroft} 12390a920b5bSAndy Whitcroft 1240c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1241cf655043SAndy Whitcroftmy $av_pending; 1242c2fdda0dSAndy Whitcroftmy @av_paren_type; 12431f65f947SAndy Whitcroftmy $av_pend_colon; 1244c2fdda0dSAndy Whitcroft 1245c2fdda0dSAndy Whitcroftsub annotate_reset { 1246c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1247cf655043SAndy Whitcroft $av_pending = '_'; 1248cf655043SAndy Whitcroft @av_paren_type = ('E'); 12491f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1250c2fdda0dSAndy Whitcroft} 1251c2fdda0dSAndy Whitcroft 12526c72ffaaSAndy Whitcroftsub annotate_values { 12536c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 12546c72ffaaSAndy Whitcroft 12556c72ffaaSAndy Whitcroft my $res; 12561f65f947SAndy Whitcroft my $var = '_' x length($stream); 12576c72ffaaSAndy Whitcroft my $cur = $stream; 12586c72ffaaSAndy Whitcroft 1259c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 12606c72ffaaSAndy Whitcroft 12616c72ffaaSAndy Whitcroft while (length($cur)) { 1262773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1263cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1264171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 12656c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1266c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1267c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1268cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1269c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 12706c72ffaaSAndy Whitcroft } 12716c72ffaaSAndy Whitcroft 1272c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 12739446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 12749446ef56SAndy Whitcroft push(@av_paren_type, $type); 1275addcdceaSAndy Whitcroft $type = 'c'; 12769446ef56SAndy Whitcroft 1277e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1278c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12796c72ffaaSAndy Whitcroft $type = 'T'; 12806c72ffaaSAndy Whitcroft 1281389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1282389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1283389a2fe5SAndy Whitcroft $type = 'T'; 1284389a2fe5SAndy Whitcroft 1285c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1286171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1287c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1288171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1289171ae1a4SAndy Whitcroft if ($2 ne '') { 1290cf655043SAndy Whitcroft $av_pending = 'N'; 1291171ae1a4SAndy Whitcroft } 1292171ae1a4SAndy Whitcroft $type = 'E'; 1293171ae1a4SAndy Whitcroft 1294c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1295171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1296171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1297171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12986c72ffaaSAndy Whitcroft 1299c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1300cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1301c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1302cf655043SAndy Whitcroft 1303cf655043SAndy Whitcroft push(@av_paren_type, $type); 1304cf655043SAndy Whitcroft push(@av_paren_type, $type); 1305171ae1a4SAndy Whitcroft $type = 'E'; 1306cf655043SAndy Whitcroft 1307c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1308cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1309cf655043SAndy Whitcroft $av_preprocessor = 1; 1310cf655043SAndy Whitcroft 1311cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1312cf655043SAndy Whitcroft 1313171ae1a4SAndy Whitcroft $type = 'E'; 1314cf655043SAndy Whitcroft 1315c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1316cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1317cf655043SAndy Whitcroft 1318cf655043SAndy Whitcroft $av_preprocessor = 1; 1319cf655043SAndy Whitcroft 1320cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1321cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1322cf655043SAndy Whitcroft pop(@av_paren_type); 1323cf655043SAndy Whitcroft push(@av_paren_type, $type); 1324171ae1a4SAndy Whitcroft $type = 'E'; 13256c72ffaaSAndy Whitcroft 13266c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1327c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 13286c72ffaaSAndy Whitcroft 1329171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1330171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1331171ae1a4SAndy Whitcroft $av_pending = $type; 1332171ae1a4SAndy Whitcroft $type = 'N'; 1333171ae1a4SAndy Whitcroft 13346c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1335c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 13366c72ffaaSAndy Whitcroft if (defined $2) { 1337cf655043SAndy Whitcroft $av_pending = 'V'; 13386c72ffaaSAndy Whitcroft } 13396c72ffaaSAndy Whitcroft $type = 'N'; 13406c72ffaaSAndy Whitcroft 134114b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1342c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 134314b111c1SAndy Whitcroft $av_pending = 'E'; 13446c72ffaaSAndy Whitcroft $type = 'N'; 13456c72ffaaSAndy Whitcroft 13461f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 13471f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 13481f65f947SAndy Whitcroft $av_pend_colon = 'C'; 13491f65f947SAndy Whitcroft $type = 'N'; 13501f65f947SAndy Whitcroft 135114b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1352c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 13536c72ffaaSAndy Whitcroft $type = 'N'; 13546c72ffaaSAndy Whitcroft 13556c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1356c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1357cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1358cf655043SAndy Whitcroft $av_pending = '_'; 13596c72ffaaSAndy Whitcroft $type = 'N'; 13606c72ffaaSAndy Whitcroft 13616c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1362cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1363cf655043SAndy Whitcroft if ($new_type ne '_') { 1364cf655043SAndy Whitcroft $type = $new_type; 1365c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1366c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 13676c72ffaaSAndy Whitcroft } else { 1368c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 13696c72ffaaSAndy Whitcroft } 13706c72ffaaSAndy Whitcroft 1371c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1372c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1373c8cb2ca3SAndy Whitcroft $type = 'V'; 1374cf655043SAndy Whitcroft $av_pending = 'V'; 13756c72ffaaSAndy Whitcroft 13768e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 13778e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13781f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13798e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13808e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13811f65f947SAndy Whitcroft } 13821f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13831f65f947SAndy Whitcroft $type = 'V'; 13841f65f947SAndy Whitcroft 13856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1386c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13876c72ffaaSAndy Whitcroft $type = 'V'; 13886c72ffaaSAndy Whitcroft 13896c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1390c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13916c72ffaaSAndy Whitcroft $type = 'N'; 13926c72ffaaSAndy Whitcroft 1393cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1394c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 139513214adfSAndy Whitcroft $type = 'E'; 13961f65f947SAndy Whitcroft $av_pend_colon = 'O'; 139713214adfSAndy Whitcroft 13988e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13998e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 14008e761b04SAndy Whitcroft $type = 'C'; 14018e761b04SAndy Whitcroft 14021f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 14031f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 14041f65f947SAndy Whitcroft $type = 'N'; 14051f65f947SAndy Whitcroft 14061f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 14071f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 14081f65f947SAndy Whitcroft 14091f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 14101f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 14111f65f947SAndy Whitcroft $type = 'E'; 14121f65f947SAndy Whitcroft } else { 14131f65f947SAndy Whitcroft $type = 'N'; 14141f65f947SAndy Whitcroft } 14151f65f947SAndy Whitcroft $av_pend_colon = 'O'; 14161f65f947SAndy Whitcroft 14178e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 141813214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 14196c72ffaaSAndy Whitcroft $type = 'N'; 14206c72ffaaSAndy Whitcroft 14210d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 142274048ed8SAndy Whitcroft my $variant; 142374048ed8SAndy Whitcroft 142474048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 142574048ed8SAndy Whitcroft if ($type eq 'V') { 142674048ed8SAndy Whitcroft $variant = 'B'; 142774048ed8SAndy Whitcroft } else { 142874048ed8SAndy Whitcroft $variant = 'U'; 142974048ed8SAndy Whitcroft } 143074048ed8SAndy Whitcroft 143174048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 143274048ed8SAndy Whitcroft $type = 'N'; 143374048ed8SAndy Whitcroft 14346c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1435c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 14366c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 14376c72ffaaSAndy Whitcroft $type = 'N'; 14386c72ffaaSAndy Whitcroft } 14396c72ffaaSAndy Whitcroft 14406c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1441c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 14426c72ffaaSAndy Whitcroft } 14436c72ffaaSAndy Whitcroft if (defined $1) { 14446c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 14456c72ffaaSAndy Whitcroft $res .= $type x length($1); 14466c72ffaaSAndy Whitcroft } 14476c72ffaaSAndy Whitcroft } 14486c72ffaaSAndy Whitcroft 14491f65f947SAndy Whitcroft return ($res, $var); 14506c72ffaaSAndy Whitcroft} 14516c72ffaaSAndy Whitcroft 14528905a67cSAndy Whitcroftsub possible { 145313214adfSAndy Whitcroft my ($possible, $line) = @_; 14549a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 14550776e594SAndy Whitcroft ^(?: 14560776e594SAndy Whitcroft $Modifier| 14570776e594SAndy Whitcroft $Storage| 14580776e594SAndy Whitcroft $Type| 14599a974fdbSAndy Whitcroft DEFINE_\S+ 14609a974fdbSAndy Whitcroft )$| 14619a974fdbSAndy Whitcroft ^(?: 14620776e594SAndy Whitcroft goto| 14630776e594SAndy Whitcroft return| 14640776e594SAndy Whitcroft case| 14650776e594SAndy Whitcroft else| 14660776e594SAndy Whitcroft asm|__asm__| 146789a88353SAndy Whitcroft do| 146889a88353SAndy Whitcroft \#| 146989a88353SAndy Whitcroft \#\#| 14709a974fdbSAndy Whitcroft )(?:\s|$)| 14710776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 14729a974fdbSAndy Whitcroft )}x; 14739a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 14749a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1475c45dcabdSAndy Whitcroft # Check for modifiers. 1476c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1477c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1478c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1479c45dcabdSAndy Whitcroft 1480c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1481c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1482d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14839a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1484d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1485d2506586SAndy Whitcroft push(@modifierList, $modifier); 1486d2506586SAndy Whitcroft } 14879a974fdbSAndy Whitcroft } 1488c45dcabdSAndy Whitcroft 1489c45dcabdSAndy Whitcroft } else { 149013214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14918905a67cSAndy Whitcroft push(@typeList, $possible); 1492c45dcabdSAndy Whitcroft } 14938905a67cSAndy Whitcroft build_types(); 14940776e594SAndy Whitcroft } else { 14950776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14968905a67cSAndy Whitcroft } 14978905a67cSAndy Whitcroft} 14988905a67cSAndy Whitcroft 14996c72ffaaSAndy Whitcroftmy $prefix = ''; 15006c72ffaaSAndy Whitcroft 1501000d1cc1SJoe Perchessub show_type { 1502cbec18afSJoe Perches my ($type) = @_; 150391bfe484SJoe Perches 1504cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1505cbec18afSJoe Perches 1506cbec18afSJoe Perches return !defined $ignore_type{$type}; 1507000d1cc1SJoe Perches} 1508000d1cc1SJoe Perches 1509f0a594c1SAndy Whitcroftsub report { 1510cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1511cbec18afSJoe Perches 1512cbec18afSJoe Perches if (!show_type($type) || 1513cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1514773647a0SAndy Whitcroft return 0; 1515773647a0SAndy Whitcroft } 1516000d1cc1SJoe Perches my $line; 1517000d1cc1SJoe Perches if ($show_types) { 1518cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1519000d1cc1SJoe Perches } else { 1520cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1521000d1cc1SJoe Perches } 15228905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 15238905a67cSAndy Whitcroft 152413214adfSAndy Whitcroft push(our @report, $line); 1525773647a0SAndy Whitcroft 1526773647a0SAndy Whitcroft return 1; 1527f0a594c1SAndy Whitcroft} 1528cbec18afSJoe Perches 1529f0a594c1SAndy Whitcroftsub report_dump { 153013214adfSAndy Whitcroft our @report; 1531f0a594c1SAndy Whitcroft} 1532000d1cc1SJoe Perches 1533d752fcc8SJoe Perchessub fixup_current_range { 1534d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1535d752fcc8SJoe Perches 1536d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1537d752fcc8SJoe Perches my $o = $1; 1538d752fcc8SJoe Perches my $l = $2; 1539d752fcc8SJoe Perches my $no = $o + $offset; 1540d752fcc8SJoe Perches my $nl = $l + $length; 1541d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1542d752fcc8SJoe Perches } 1543d752fcc8SJoe Perches} 1544d752fcc8SJoe Perches 1545d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1546d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1547d752fcc8SJoe Perches 1548d752fcc8SJoe Perches my $range_last_linenr = 0; 1549d752fcc8SJoe Perches my $delta_offset = 0; 1550d752fcc8SJoe Perches 1551d752fcc8SJoe Perches my $old_linenr = 0; 1552d752fcc8SJoe Perches my $new_linenr = 0; 1553d752fcc8SJoe Perches 1554d752fcc8SJoe Perches my $next_insert = 0; 1555d752fcc8SJoe Perches my $next_delete = 0; 1556d752fcc8SJoe Perches 1557d752fcc8SJoe Perches my @lines = (); 1558d752fcc8SJoe Perches 1559d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1560d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1561d752fcc8SJoe Perches 1562d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1563d752fcc8SJoe Perches my $save_line = 1; 1564d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1565d752fcc8SJoe Perches if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename 1566d752fcc8SJoe Perches $delta_offset = 0; 1567d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1568d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1569d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1570d752fcc8SJoe Perches } 1571d752fcc8SJoe Perches 1572d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1573d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1574d752fcc8SJoe Perches $save_line = 0; 1575d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1576d752fcc8SJoe Perches } 1577d752fcc8SJoe Perches 1578d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1579d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1580d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1581d752fcc8SJoe Perches $new_linenr++; 1582d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1583d752fcc8SJoe Perches } 1584d752fcc8SJoe Perches 1585d752fcc8SJoe Perches if ($save_line) { 1586d752fcc8SJoe Perches push(@lines, $line); 1587d752fcc8SJoe Perches $new_linenr++; 1588d752fcc8SJoe Perches } 1589d752fcc8SJoe Perches 1590d752fcc8SJoe Perches $old_linenr++; 1591d752fcc8SJoe Perches } 1592d752fcc8SJoe Perches 1593d752fcc8SJoe Perches return @lines; 1594d752fcc8SJoe Perches} 1595d752fcc8SJoe Perches 1596f2d7e4d4SJoe Perchessub fix_insert_line { 1597f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1598f2d7e4d4SJoe Perches 1599f2d7e4d4SJoe Perches my $inserted = { 1600f2d7e4d4SJoe Perches LINENR => $linenr, 1601f2d7e4d4SJoe Perches LINE => $line, 1602f2d7e4d4SJoe Perches }; 1603f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1604f2d7e4d4SJoe Perches} 1605f2d7e4d4SJoe Perches 1606f2d7e4d4SJoe Perchessub fix_delete_line { 1607f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1608f2d7e4d4SJoe Perches 1609f2d7e4d4SJoe Perches my $deleted = { 1610f2d7e4d4SJoe Perches LINENR => $linenr, 1611f2d7e4d4SJoe Perches LINE => $line, 1612f2d7e4d4SJoe Perches }; 1613f2d7e4d4SJoe Perches 1614f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1615f2d7e4d4SJoe Perches} 1616f2d7e4d4SJoe Perches 1617de7d4f0eSAndy Whitcroftsub ERROR { 1618cbec18afSJoe Perches my ($type, $msg) = @_; 1619cbec18afSJoe Perches 1620cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1621de7d4f0eSAndy Whitcroft our $clean = 0; 16226c72ffaaSAndy Whitcroft our $cnt_error++; 16233705ce5bSJoe Perches return 1; 1624de7d4f0eSAndy Whitcroft } 16253705ce5bSJoe Perches return 0; 1626773647a0SAndy Whitcroft} 1627de7d4f0eSAndy Whitcroftsub WARN { 1628cbec18afSJoe Perches my ($type, $msg) = @_; 1629cbec18afSJoe Perches 1630cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1631de7d4f0eSAndy Whitcroft our $clean = 0; 16326c72ffaaSAndy Whitcroft our $cnt_warn++; 16333705ce5bSJoe Perches return 1; 1634de7d4f0eSAndy Whitcroft } 16353705ce5bSJoe Perches return 0; 1636773647a0SAndy Whitcroft} 1637de7d4f0eSAndy Whitcroftsub CHK { 1638cbec18afSJoe Perches my ($type, $msg) = @_; 1639cbec18afSJoe Perches 1640cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1641de7d4f0eSAndy Whitcroft our $clean = 0; 16426c72ffaaSAndy Whitcroft our $cnt_chk++; 16433705ce5bSJoe Perches return 1; 16446c72ffaaSAndy Whitcroft } 16453705ce5bSJoe Perches return 0; 1646de7d4f0eSAndy Whitcroft} 1647de7d4f0eSAndy Whitcroft 16486ecd9674SAndy Whitcroftsub check_absolute_file { 16496ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 16506ecd9674SAndy Whitcroft my $file = $absolute; 16516ecd9674SAndy Whitcroft 16526ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 16536ecd9674SAndy Whitcroft 16546ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 16556ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 16566ecd9674SAndy Whitcroft if (-f "$root/$file") { 16576ecd9674SAndy Whitcroft ##print "file<$file>\n"; 16586ecd9674SAndy Whitcroft last; 16596ecd9674SAndy Whitcroft } 16606ecd9674SAndy Whitcroft } 16616ecd9674SAndy Whitcroft if (! -f _) { 16626ecd9674SAndy Whitcroft return 0; 16636ecd9674SAndy Whitcroft } 16646ecd9674SAndy Whitcroft 16656ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 16666ecd9674SAndy Whitcroft my $prefix = $absolute; 16676ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 16686ecd9674SAndy Whitcroft 16696ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 16706ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1671000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1672000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 16736ecd9674SAndy Whitcroft } 16746ecd9674SAndy Whitcroft} 16756ecd9674SAndy Whitcroft 16763705ce5bSJoe Perchessub trim { 16773705ce5bSJoe Perches my ($string) = @_; 16783705ce5bSJoe Perches 1679b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1680b34c648bSJoe Perches 1681b34c648bSJoe Perches return $string; 1682b34c648bSJoe Perches} 1683b34c648bSJoe Perches 1684b34c648bSJoe Perchessub ltrim { 1685b34c648bSJoe Perches my ($string) = @_; 1686b34c648bSJoe Perches 1687b34c648bSJoe Perches $string =~ s/^\s+//; 1688b34c648bSJoe Perches 1689b34c648bSJoe Perches return $string; 1690b34c648bSJoe Perches} 1691b34c648bSJoe Perches 1692b34c648bSJoe Perchessub rtrim { 1693b34c648bSJoe Perches my ($string) = @_; 1694b34c648bSJoe Perches 1695b34c648bSJoe Perches $string =~ s/\s+$//; 16963705ce5bSJoe Perches 16973705ce5bSJoe Perches return $string; 16983705ce5bSJoe Perches} 16993705ce5bSJoe Perches 170052ea8506SJoe Perchessub string_find_replace { 170152ea8506SJoe Perches my ($string, $find, $replace) = @_; 170252ea8506SJoe Perches 170352ea8506SJoe Perches $string =~ s/$find/$replace/g; 170452ea8506SJoe Perches 170552ea8506SJoe Perches return $string; 170652ea8506SJoe Perches} 170752ea8506SJoe Perches 17083705ce5bSJoe Perchessub tabify { 17093705ce5bSJoe Perches my ($leading) = @_; 17103705ce5bSJoe Perches 17113705ce5bSJoe Perches my $source_indent = 8; 17123705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 17133705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 17143705ce5bSJoe Perches 17153705ce5bSJoe Perches #convert leading spaces to tabs 17163705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 17173705ce5bSJoe Perches #Remove spaces before a tab 17183705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 17193705ce5bSJoe Perches 17203705ce5bSJoe Perches return "$leading"; 17213705ce5bSJoe Perches} 17223705ce5bSJoe Perches 1723d1fe9c09SJoe Perchessub pos_last_openparen { 1724d1fe9c09SJoe Perches my ($line) = @_; 1725d1fe9c09SJoe Perches 1726d1fe9c09SJoe Perches my $pos = 0; 1727d1fe9c09SJoe Perches 1728d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1729d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1730d1fe9c09SJoe Perches 1731d1fe9c09SJoe Perches my $last_openparen = 0; 1732d1fe9c09SJoe Perches 1733d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1734d1fe9c09SJoe Perches return -1; 1735d1fe9c09SJoe Perches } 1736d1fe9c09SJoe Perches 1737d1fe9c09SJoe Perches my $len = length($line); 1738d1fe9c09SJoe Perches 1739d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1740d1fe9c09SJoe Perches my $string = substr($line, $pos); 1741d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1742d1fe9c09SJoe Perches $pos += length($1) - 1; 1743d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1744d1fe9c09SJoe Perches $last_openparen = $pos; 1745d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1746d1fe9c09SJoe Perches last; 1747d1fe9c09SJoe Perches } 1748d1fe9c09SJoe Perches } 1749d1fe9c09SJoe Perches 175091cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1751d1fe9c09SJoe Perches} 1752d1fe9c09SJoe Perches 17530a920b5bSAndy Whitcroftsub process { 17540a920b5bSAndy Whitcroft my $filename = shift; 17550a920b5bSAndy Whitcroft 17560a920b5bSAndy Whitcroft my $linenr=0; 17570a920b5bSAndy Whitcroft my $prevline=""; 1758c2fdda0dSAndy Whitcroft my $prevrawline=""; 17590a920b5bSAndy Whitcroft my $stashline=""; 1760c2fdda0dSAndy Whitcroft my $stashrawline=""; 17610a920b5bSAndy Whitcroft 17624a0df2efSAndy Whitcroft my $length; 17630a920b5bSAndy Whitcroft my $indent; 17640a920b5bSAndy Whitcroft my $previndent=0; 17650a920b5bSAndy Whitcroft my $stashindent=0; 17660a920b5bSAndy Whitcroft 1767de7d4f0eSAndy Whitcroft our $clean = 1; 17680a920b5bSAndy Whitcroft my $signoff = 0; 17690a920b5bSAndy Whitcroft my $is_patch = 0; 17700a920b5bSAndy Whitcroft 177129ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 177215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 177313f1937eSJoe Perches my $reported_maintainer_file = 0; 1774fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1775fa64205dSPasi Savanainen 1776365dd4eaSJoe Perches my $last_blank_line = 0; 1777365dd4eaSJoe Perches 177813214adfSAndy Whitcroft our @report = (); 17796c72ffaaSAndy Whitcroft our $cnt_lines = 0; 17806c72ffaaSAndy Whitcroft our $cnt_error = 0; 17816c72ffaaSAndy Whitcroft our $cnt_warn = 0; 17826c72ffaaSAndy Whitcroft our $cnt_chk = 0; 17836c72ffaaSAndy Whitcroft 17840a920b5bSAndy Whitcroft # Trace the real file/line as we go. 17850a920b5bSAndy Whitcroft my $realfile = ''; 17860a920b5bSAndy Whitcroft my $realline = 0; 17870a920b5bSAndy Whitcroft my $realcnt = 0; 17880a920b5bSAndy Whitcroft my $here = ''; 17890a920b5bSAndy Whitcroft my $in_comment = 0; 1790c2fdda0dSAndy Whitcroft my $comment_edge = 0; 17910a920b5bSAndy Whitcroft my $first_line = 0; 17921e855726SWolfram Sang my $p1_prefix = ''; 17930a920b5bSAndy Whitcroft 179413214adfSAndy Whitcroft my $prev_values = 'E'; 179513214adfSAndy Whitcroft 179613214adfSAndy Whitcroft # suppression flags 1797773647a0SAndy Whitcroft my %suppress_ifbraces; 1798170d3a22SAndy Whitcroft my %suppress_whiletrailers; 17992b474a1aSAndy Whitcroft my %suppress_export; 18003e469cdcSAndy Whitcroft my $suppress_statement = 0; 1801653d4876SAndy Whitcroft 18027e51f197SJoe Perches my %signatures = (); 1803323c1260SJoe Perches 1804c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1805de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1806c2fdda0dSAndy Whitcroft # 1807de7d4f0eSAndy Whitcroft my @setup_docs = (); 1808de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1809773647a0SAndy Whitcroft 1810d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1811d8b07710SJoe Perches 1812773647a0SAndy Whitcroft sanitise_line_reset(); 1813c2fdda0dSAndy Whitcroft my $line; 1814c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1815773647a0SAndy Whitcroft $linenr++; 1816773647a0SAndy Whitcroft $line = $rawline; 1817c2fdda0dSAndy Whitcroft 18183705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 18193705ce5bSJoe Perches 1820773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1821de7d4f0eSAndy Whitcroft $setup_docs = 0; 1822de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1823de7d4f0eSAndy Whitcroft $setup_docs = 1; 1824de7d4f0eSAndy Whitcroft } 1825773647a0SAndy Whitcroft #next; 1826de7d4f0eSAndy Whitcroft } 1827773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1828773647a0SAndy Whitcroft $realline=$1-1; 1829773647a0SAndy Whitcroft if (defined $2) { 1830773647a0SAndy Whitcroft $realcnt=$3+1; 1831773647a0SAndy Whitcroft } else { 1832773647a0SAndy Whitcroft $realcnt=1+1; 1833773647a0SAndy Whitcroft } 1834c45dcabdSAndy Whitcroft $in_comment = 0; 1835773647a0SAndy Whitcroft 1836773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1837773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1838773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1839773647a0SAndy Whitcroft # at context start. 1840773647a0SAndy Whitcroft my $edge; 184101fa9147SAndy Whitcroft my $cnt = $realcnt; 184201fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 184301fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 184401fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 184501fa9147SAndy Whitcroft $cnt--; 184601fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1847721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1848fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1849fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1850fae17daeSAndy Whitcroft ($edge) = $1; 1851fae17daeSAndy Whitcroft last; 1852fae17daeSAndy Whitcroft } 1853773647a0SAndy Whitcroft } 1854773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1855773647a0SAndy Whitcroft $in_comment = 1; 1856773647a0SAndy Whitcroft } 1857773647a0SAndy Whitcroft 1858773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1859773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1860773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1861773647a0SAndy Whitcroft if (!defined $edge && 186283242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1863773647a0SAndy Whitcroft { 1864773647a0SAndy Whitcroft $in_comment = 1; 1865773647a0SAndy Whitcroft } 1866773647a0SAndy Whitcroft 1867773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1868773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1869773647a0SAndy Whitcroft 1870171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1871773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1872171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1873773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1874773647a0SAndy Whitcroft } 1875773647a0SAndy Whitcroft push(@lines, $line); 1876773647a0SAndy Whitcroft 1877773647a0SAndy Whitcroft if ($realcnt > 1) { 1878773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1879773647a0SAndy Whitcroft } else { 1880773647a0SAndy Whitcroft $realcnt = 0; 1881773647a0SAndy Whitcroft } 1882773647a0SAndy Whitcroft 1883773647a0SAndy Whitcroft #print "==>$rawline\n"; 1884773647a0SAndy Whitcroft #print "-->$line\n"; 1885de7d4f0eSAndy Whitcroft 1886de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1887de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1888de7d4f0eSAndy Whitcroft } 1889de7d4f0eSAndy Whitcroft } 1890de7d4f0eSAndy Whitcroft 18916c72ffaaSAndy Whitcroft $prefix = ''; 18926c72ffaaSAndy Whitcroft 1893773647a0SAndy Whitcroft $realcnt = 0; 1894773647a0SAndy Whitcroft $linenr = 0; 1895194f66fcSJoe Perches $fixlinenr = -1; 18960a920b5bSAndy Whitcroft foreach my $line (@lines) { 18970a920b5bSAndy Whitcroft $linenr++; 1898194f66fcSJoe Perches $fixlinenr++; 18991b5539b1SJoe Perches my $sline = $line; #copy of $line 19001b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 19010a920b5bSAndy Whitcroft 1902c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 19036c72ffaaSAndy Whitcroft 19040a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 19056c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 19060a920b5bSAndy Whitcroft $is_patch = 1; 19074a0df2efSAndy Whitcroft $first_line = $linenr + 1; 19080a920b5bSAndy Whitcroft $realline=$1-1; 19090a920b5bSAndy Whitcroft if (defined $2) { 19100a920b5bSAndy Whitcroft $realcnt=$3+1; 19110a920b5bSAndy Whitcroft } else { 19120a920b5bSAndy Whitcroft $realcnt=1+1; 19130a920b5bSAndy Whitcroft } 1914c2fdda0dSAndy Whitcroft annotate_reset(); 191513214adfSAndy Whitcroft $prev_values = 'E'; 191613214adfSAndy Whitcroft 1917773647a0SAndy Whitcroft %suppress_ifbraces = (); 1918170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 19192b474a1aSAndy Whitcroft %suppress_export = (); 19203e469cdcSAndy Whitcroft $suppress_statement = 0; 19210a920b5bSAndy Whitcroft next; 19220a920b5bSAndy Whitcroft 19234a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 19244a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 19254a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1926773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 19270a920b5bSAndy Whitcroft $realline++; 1928d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 19290a920b5bSAndy Whitcroft 19304a0df2efSAndy Whitcroft # Measure the line length and indent. 1931c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 19320a920b5bSAndy Whitcroft 19330a920b5bSAndy Whitcroft # Track the previous line. 19340a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 19350a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1936c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1937c2fdda0dSAndy Whitcroft 1938773647a0SAndy Whitcroft #warn "line<$line>\n"; 19396c72ffaaSAndy Whitcroft 1940d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1941d8aaf121SAndy Whitcroft $realcnt--; 19420a920b5bSAndy Whitcroft } 19430a920b5bSAndy Whitcroft 1944cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1945cc77cdcaSAndy Whitcroft 19460a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1947773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1948773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1949773647a0SAndy Whitcroft 19506c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 19516c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1952773647a0SAndy Whitcroft 19532ac73b4fSJoe Perches my $found_file = 0; 1954773647a0SAndy Whitcroft # extract the filename as it passes 19553bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 19563bf9a009SRabin Vincent $realfile = $1; 19572b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1958270c49a0SJoe Perches $in_commit_log = 0; 19592ac73b4fSJoe Perches $found_file = 1; 19603bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1961773647a0SAndy Whitcroft $realfile = $1; 19622b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1963270c49a0SJoe Perches $in_commit_log = 0; 19641e855726SWolfram Sang 19651e855726SWolfram Sang $p1_prefix = $1; 1966e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1967e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1968000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1969000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 19701e855726SWolfram Sang } 1971773647a0SAndy Whitcroft 1972c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1973000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1974000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1975773647a0SAndy Whitcroft } 19762ac73b4fSJoe Perches $found_file = 1; 19772ac73b4fSJoe Perches } 19782ac73b4fSJoe Perches 19792ac73b4fSJoe Perches if ($found_file) { 19802ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 19812ac73b4fSJoe Perches $check = 1; 19822ac73b4fSJoe Perches } else { 19832ac73b4fSJoe Perches $check = $check_orig; 19842ac73b4fSJoe Perches } 1985773647a0SAndy Whitcroft next; 1986773647a0SAndy Whitcroft } 1987773647a0SAndy Whitcroft 1988389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 19890a920b5bSAndy Whitcroft 1990c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1991c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1992c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 19930a920b5bSAndy Whitcroft 19946c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 19956c72ffaaSAndy Whitcroft 19963bf9a009SRabin Vincent# Check for incorrect file permissions 19973bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 19983bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 199904db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 200004db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2001000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2002000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 20033bf9a009SRabin Vincent } 20043bf9a009SRabin Vincent } 20053bf9a009SRabin Vincent 200620112475SJoe Perches# Check the patch for a signoff: 2007d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 20084a0df2efSAndy Whitcroft $signoff++; 200915662b3eSJoe Perches $in_commit_log = 0; 20100a920b5bSAndy Whitcroft } 201120112475SJoe Perches 201220112475SJoe Perches# Check signature styles 2013270c49a0SJoe Perches if (!$in_header_lines && 2014ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 201520112475SJoe Perches my $space_before = $1; 201620112475SJoe Perches my $sign_off = $2; 201720112475SJoe Perches my $space_after = $3; 201820112475SJoe Perches my $email = $4; 201920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 202020112475SJoe Perches 2021ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2022ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2023ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2024ce0338dfSJoe Perches } 202520112475SJoe Perches if (defined $space_before && $space_before ne "") { 20263705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 20273705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 20283705ce5bSJoe Perches $fix) { 2029194f66fcSJoe Perches $fixed[$fixlinenr] = 20303705ce5bSJoe Perches "$ucfirst_sign_off $email"; 20313705ce5bSJoe Perches } 203220112475SJoe Perches } 203320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 20343705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 20353705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 20363705ce5bSJoe Perches $fix) { 2037194f66fcSJoe Perches $fixed[$fixlinenr] = 20383705ce5bSJoe Perches "$ucfirst_sign_off $email"; 20393705ce5bSJoe Perches } 20403705ce5bSJoe Perches 204120112475SJoe Perches } 204220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 20433705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 20443705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 20453705ce5bSJoe Perches $fix) { 2046194f66fcSJoe Perches $fixed[$fixlinenr] = 20473705ce5bSJoe Perches "$ucfirst_sign_off $email"; 20483705ce5bSJoe Perches } 204920112475SJoe Perches } 205020112475SJoe Perches 205120112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 205220112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 205320112475SJoe Perches if ($suggested_email eq "") { 2054000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2055000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 205620112475SJoe Perches } else { 205720112475SJoe Perches my $dequoted = $suggested_email; 205820112475SJoe Perches $dequoted =~ s/^"//; 205920112475SJoe Perches $dequoted =~ s/" </ </; 206020112475SJoe Perches # Don't force email to have quotes 206120112475SJoe Perches # Allow just an angle bracketed address 206220112475SJoe Perches if ("$dequoted$comment" ne $email && 206320112475SJoe Perches "<$email_address>$comment" ne $email && 206420112475SJoe Perches "$suggested_email$comment" ne $email) { 2065000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2066000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 206720112475SJoe Perches } 20680a920b5bSAndy Whitcroft } 20697e51f197SJoe Perches 20707e51f197SJoe Perches# Check for duplicate signatures 20717e51f197SJoe Perches my $sig_nospace = $line; 20727e51f197SJoe Perches $sig_nospace =~ s/\s//g; 20737e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 20747e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 20757e51f197SJoe Perches WARN("BAD_SIGN_OFF", 20767e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 20777e51f197SJoe Perches } else { 20787e51f197SJoe Perches $signatures{$sig_nospace} = 1; 20797e51f197SJoe Perches } 20800a920b5bSAndy Whitcroft } 20810a920b5bSAndy Whitcroft 20829b3189ebSJoe Perches# Check for old stable address 20839b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 20849b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 20859b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 20869b3189ebSJoe Perches } 20879b3189ebSJoe Perches 20887ebd05efSChristopher Covington# Check for unwanted Gerrit info 20897ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 20907ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 20917ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 20927ebd05efSChristopher Covington } 20937ebd05efSChristopher Covington 2094d311cd44SJoe Perches# Check for improperly formed commit descriptions 2095d311cd44SJoe Perches if ($in_commit_log && 2096d311cd44SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}/i && 2097d311cd44SJoe Perches $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) { 2098d311cd44SJoe Perches $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i; 2099d311cd44SJoe Perches my $init_char = $1; 2100d311cd44SJoe Perches my $orig_commit = lc($2); 2101d311cd44SJoe Perches my $id = '01234567890ab'; 2102d311cd44SJoe Perches my $desc = 'commit description'; 2103d311cd44SJoe Perches ($id, $desc) = git_commit_info($orig_commit, $id, $desc); 2104d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 2105d311cd44SJoe Perches "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr); 2106d311cd44SJoe Perches } 2107d311cd44SJoe Perches 210813f1937eSJoe Perches# Check for added, moved or deleted files 210913f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 211013f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 211113f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 211213f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 211313f1937eSJoe Perches (defined($1) || defined($2))))) { 211413f1937eSJoe Perches $reported_maintainer_file = 1; 211513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 211613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 211713f1937eSJoe Perches } 211813f1937eSJoe Perches 211900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 21208905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2121000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2122000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 21236c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2124de7d4f0eSAndy Whitcroft } 2125de7d4f0eSAndy Whitcroft 21266ecd9674SAndy Whitcroft# Check for absolute kernel paths. 21276ecd9674SAndy Whitcroft if ($tree) { 21286ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 21296ecd9674SAndy Whitcroft my $file = $1; 21306ecd9674SAndy Whitcroft 21316ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 21326ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 21336ecd9674SAndy Whitcroft # 21346ecd9674SAndy Whitcroft } else { 21356ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 21366ecd9674SAndy Whitcroft } 21376ecd9674SAndy Whitcroft } 21386ecd9674SAndy Whitcroft } 21396ecd9674SAndy Whitcroft 2140de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2141de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2142171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2143171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2144171ae1a4SAndy Whitcroft 2145171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2146171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2147171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2148171ae1a4SAndy Whitcroft 214934d99219SJoe Perches CHK("INVALID_UTF8", 2150000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 215100df344fSAndy Whitcroft } 21520a920b5bSAndy Whitcroft 215315662b3eSJoe Perches# Check if it's the start of a commit log 215415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 215515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 215629ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 215729ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 215815662b3eSJoe Perches $in_header_lines = 0; 215915662b3eSJoe Perches $in_commit_log = 1; 216015662b3eSJoe Perches } 216115662b3eSJoe Perches 2162fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2163fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2164fa64205dSPasi Savanainen if ($in_header_lines && 2165fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2166fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2167fa64205dSPasi Savanainen $non_utf8_charset = 1; 2168fa64205dSPasi Savanainen } 2169fa64205dSPasi Savanainen 2170fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 217115662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2172fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 217315662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 217415662b3eSJoe Perches } 217515662b3eSJoe Perches 217630670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 217730670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 217800df344fSAndy Whitcroft 21790a920b5bSAndy Whitcroft#trailing whitespace 21809c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2181c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2182d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2183d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2184d5e616fcSJoe Perches $fix) { 2185194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2186d5e616fcSJoe Perches } 2187c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2188c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21893705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 21903705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 21913705ce5bSJoe Perches $fix) { 2192194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 21933705ce5bSJoe Perches } 21943705ce5bSJoe Perches 2195d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21960a920b5bSAndy Whitcroft } 21975368df20SAndy Whitcroft 21984783f894SJosh Triplett# Check for FSF mailing addresses. 2199109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 22003e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 22013e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 22024783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22034783f894SJosh Triplett my $msg_type = \&ERROR; 22044783f894SJosh Triplett $msg_type = \&CHK if ($file); 22054783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 22064783f894SJosh 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) 22074783f894SJosh Triplett } 22084783f894SJosh Triplett 22093354957aSAndi Kleen# check for Kconfig help text having a real description 22109fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 22119fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 22123354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 22138d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 22143354957aSAndi Kleen my $length = 0; 22159fe287d7SAndy Whitcroft my $cnt = $realcnt; 22169fe287d7SAndy Whitcroft my $ln = $linenr + 1; 22179fe287d7SAndy Whitcroft my $f; 2218a1385803SAndy Whitcroft my $is_start = 0; 22199fe287d7SAndy Whitcroft my $is_end = 0; 2220a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 22219fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 22229fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 22239fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 22249fe287d7SAndy Whitcroft 22259fe287d7SAndy Whitcroft next if ($f =~ /^-/); 22268d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2227a1385803SAndy Whitcroft 22288d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2229a1385803SAndy Whitcroft $is_start = 1; 22308d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2231a1385803SAndy Whitcroft $length = -1; 2232a1385803SAndy Whitcroft } 2233a1385803SAndy Whitcroft 22349fe287d7SAndy Whitcroft $f =~ s/^.//; 22353354957aSAndi Kleen $f =~ s/#.*//; 22363354957aSAndi Kleen $f =~ s/^\s+//; 22373354957aSAndi Kleen next if ($f =~ /^$/); 22389fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 22399fe287d7SAndy Whitcroft $is_end = 1; 22409fe287d7SAndy Whitcroft last; 22419fe287d7SAndy Whitcroft } 22423354957aSAndi Kleen $length++; 22433354957aSAndi Kleen } 2244000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2245a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2246a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 22473354957aSAndi Kleen } 22483354957aSAndi Kleen 22491ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 22501ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 22511ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 22521ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 22531ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 22541ba8dfd1SKees Cook } 22551ba8dfd1SKees Cook 2256c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2257c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2258c68e5878SArnaud Lacombe my $flag = $1; 2259c68e5878SArnaud Lacombe my $replacement = { 2260c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2261c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2262c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2263c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2264c68e5878SArnaud Lacombe }; 2265c68e5878SArnaud Lacombe 2266c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2267c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2268c68e5878SArnaud Lacombe } 2269c68e5878SArnaud Lacombe 2270bff5da43SRob Herring# check for DT compatible documentation 22717dd05b38SFlorian Vaussard if (defined $root && 22727dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 22737dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 22747dd05b38SFlorian Vaussard 2275bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2276bff5da43SRob Herring 2277cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2278cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2279cc93319bSFlorian Vaussard 2280bff5da43SRob Herring foreach my $compat (@compats) { 2281bff5da43SRob Herring my $compat2 = $compat; 2282185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2283185d566bSRob Herring my $compat3 = $compat; 2284185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2285185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2286bff5da43SRob Herring if ( $? >> 8 ) { 2287bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2288bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2289bff5da43SRob Herring } 2290bff5da43SRob Herring 22914fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 22924fbf32a6SFlorian Vaussard my $vendor = $1; 2293cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2294bff5da43SRob Herring if ( $? >> 8 ) { 2295bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2296cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2297bff5da43SRob Herring } 2298bff5da43SRob Herring } 2299bff5da43SRob Herring } 2300bff5da43SRob Herring 23015368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 23025368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 23035368df20SAndy Whitcroft 23046cd7f386SJoe Perches#line length limit 2305c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2306f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 23070fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 23088bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 23096cd7f386SJoe Perches $length > $max_line_length) 2310c45dcabdSAndy Whitcroft { 2311000d1cc1SJoe Perches WARN("LONG_LINE", 23126cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 23130a920b5bSAndy Whitcroft } 23140a920b5bSAndy Whitcroft 2315ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 23168c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 23178c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 23188c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2319ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2320ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 23218c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2322ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2323ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2324ca56dc09SJosh Triplett } 2325ca56dc09SJosh Triplett 23265e79d96eSJoe Perches# check for spaces before a quoted newline 23275e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 23283705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 23293705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 23303705ce5bSJoe Perches $fix) { 2331194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 23323705ce5bSJoe Perches } 23333705ce5bSJoe Perches 23345e79d96eSJoe Perches } 23355e79d96eSJoe Perches 23368905a67cSAndy Whitcroft# check for adding lines without a newline. 23378905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2338000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2339000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 23408905a67cSAndy Whitcroft } 23418905a67cSAndy Whitcroft 234242e41c54SMike Frysinger# Blackfin: use hi/lo macros 234342e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 234442e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 234542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2346000d1cc1SJoe Perches ERROR("LO_MACRO", 2347000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 234842e41c54SMike Frysinger } 234942e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 235042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2351000d1cc1SJoe Perches ERROR("HI_MACRO", 2352000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 235342e41c54SMike Frysinger } 235442e41c54SMike Frysinger } 235542e41c54SMike Frysinger 2356b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2357b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 23580a920b5bSAndy Whitcroft 23590a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 23600a920b5bSAndy Whitcroft# more than 8 must use tabs. 2361c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2362c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2363c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2364d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 23653705ce5bSJoe Perches if (ERROR("CODE_INDENT", 23663705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 23673705ce5bSJoe Perches $fix) { 2368194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 23693705ce5bSJoe Perches } 23700a920b5bSAndy Whitcroft } 23710a920b5bSAndy Whitcroft 237208e44365SAlberto Panizzo# check for space before tabs. 237308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 237408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23753705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 23763705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 23773705ce5bSJoe Perches $fix) { 2378194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2379c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2380194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2381c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 23823705ce5bSJoe Perches } 238308e44365SAlberto Panizzo } 238408e44365SAlberto Panizzo 2385d1fe9c09SJoe Perches# check for && or || at the start of a line 2386d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2387d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2388d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2389d1fe9c09SJoe Perches } 2390d1fe9c09SJoe Perches 2391d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2392d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 239391cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2394d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2395d1fe9c09SJoe Perches my $oldindent = $1; 2396d1fe9c09SJoe Perches my $rest = $2; 2397d1fe9c09SJoe Perches 2398d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2399d1fe9c09SJoe Perches if ($pos >= 0) { 2400b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2401b34a26f3SJoe Perches my $newindent = $2; 2402d1fe9c09SJoe Perches 2403d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2404d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2405d1fe9c09SJoe Perches " " x ($pos % 8); 2406d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2407d1fe9c09SJoe Perches 2408d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2409d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 24103705ce5bSJoe Perches 24113705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 24123705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 24133705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2414194f66fcSJoe Perches $fixed[$fixlinenr] =~ 24153705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 24163705ce5bSJoe Perches } 2417d1fe9c09SJoe Perches } 2418d1fe9c09SJoe Perches } 2419d1fe9c09SJoe Perches } 2420d1fe9c09SJoe Perches 2421f27c95dbSJoe Perches if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 24223705ce5bSJoe Perches if (CHK("SPACING", 2423f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 24243705ce5bSJoe Perches $fix) { 2425194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2426f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 24273705ce5bSJoe Perches } 2428aad4f614SJoe Perches } 2429aad4f614SJoe Perches 243005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2431fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 243285ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 243385ad978cSJoe Perches $realline > 2) { 243405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 243505880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 243605880600SJoe Perches } 243705880600SJoe Perches 243805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2439a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2440a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 244161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2442a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2443a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2444a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2445a605e32eSJoe Perches } 2446a605e32eSJoe Perches 2447a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2448c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2449c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2450c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2451c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 245205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 245305880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 245405880600SJoe Perches } 245505880600SJoe Perches 24567f619191SJoe Perches# check for missing blank lines after struct/union declarations 24577f619191SJoe Perches# with exceptions for various attributes and macros 24587f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 24597f619191SJoe Perches $line =~ /^\+/ && 24607f619191SJoe Perches !($line =~ /^\+\s*$/ || 24617f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 24627f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 24637f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 24647f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 24657f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 24667f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 24677f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2468d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2469d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2470d752fcc8SJoe Perches $fix) { 2471f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2472d752fcc8SJoe Perches } 24737f619191SJoe Perches } 24747f619191SJoe Perches 2475365dd4eaSJoe Perches# check for multiple consecutive blank lines 2476365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2477365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2478365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2479d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2480d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2481d752fcc8SJoe Perches $fix) { 2482f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2483d752fcc8SJoe Perches } 2484d752fcc8SJoe Perches 2485365dd4eaSJoe Perches $last_blank_line = $linenr; 2486365dd4eaSJoe Perches } 2487365dd4eaSJoe Perches 24883b617e3bSJoe Perches# check for missing blank lines after declarations 24893f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 24903f7bac03SJoe Perches # actual declarations 24913f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 24925a4e1fd3SJoe Perches # function pointer declarations 24935a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 24943f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 24953f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 24963f7bac03SJoe Perches # known declaration macros 24973f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 24983f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 24993f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 25003f7bac03SJoe Perches # other possible extensions of declaration lines 25013f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 25023f7bac03SJoe Perches # not starting a section or a macro "\" extended line 25033f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 25043f7bac03SJoe Perches # looks like a declaration 25053f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 25065a4e1fd3SJoe Perches # function pointer declarations 25075a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 25083f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 25093f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 25103f7bac03SJoe Perches # known declaration macros 25113f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 25123f7bac03SJoe Perches # start of struct or union or enum 25133b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 25143f7bac03SJoe Perches # start or end of block or continuation of declaration 25153f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 25163f7bac03SJoe Perches # bitfield continuation 25173f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 25183f7bac03SJoe Perches # other possible extensions of declaration lines 25193f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 25203f7bac03SJoe Perches # indentation of previous and current line are the same 25213f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2522d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2523d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2524d752fcc8SJoe Perches $fix) { 2525f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2526d752fcc8SJoe Perches } 25273b617e3bSJoe Perches } 25283b617e3bSJoe Perches 25295f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 25306b4c5bebSAndy Whitcroft# Exceptions: 25316b4c5bebSAndy Whitcroft# 1) within comments 25326b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 25336b4c5bebSAndy Whitcroft# 3) hanging labels 25343705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 25355f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25363705ce5bSJoe Perches if (WARN("LEADING_SPACE", 25373705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 25383705ce5bSJoe Perches $fix) { 2539194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 25403705ce5bSJoe Perches } 25415f7ddae6SRaffaele Recalcati } 25425f7ddae6SRaffaele Recalcati 2543b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2544b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2545b9ea10d6SAndy Whitcroft 2546032a4c0fSJoe Perches# check indentation of any line with a bare else 2547032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2548032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2549032a4c0fSJoe Perches my $tabs = length($1) + 1; 2550032a4c0fSJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) { 2551032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2552032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2553032a4c0fSJoe Perches } 2554032a4c0fSJoe Perches } 2555032a4c0fSJoe Perches 2556c00df19aSJoe Perches# check indentation of a line with a break; 2557c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2558c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2559c00df19aSJoe Perches my $tabs = $1; 2560c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2561c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2562c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2563c00df19aSJoe Perches } 2564c00df19aSJoe Perches } 2565c00df19aSJoe Perches 25661ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 25671ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 25681ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25691ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25701ba8dfd1SKees Cook } 25711ba8dfd1SKees Cook 2572c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2573cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2574000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2575000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2576c2fdda0dSAndy Whitcroft } 257722f2a2efSAndy Whitcroft 257842e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 257942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 258042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2581000d1cc1SJoe Perches ERROR("CSYNC", 2582000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 258342e41c54SMike Frysinger } 258442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 258542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2586000d1cc1SJoe Perches ERROR("SSYNC", 2587000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 258842e41c54SMike Frysinger } 258942e41c54SMike Frysinger 259056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 259156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 259256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 259356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 259456e77d70SJoe Perches } 259556e77d70SJoe Perches 25969c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 25972b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 25982b474a1aSAndy Whitcroft $realline_next); 25993e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 26003e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 26011b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2602170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2603f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2604171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2605171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2606171ae1a4SAndy Whitcroft 26073e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 26083e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 26093e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 26103e469cdcSAndy Whitcroft # until we hit end of it. 26113e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 26123e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 26133e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 26143e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 26153e469cdcSAndy Whitcroft } 2616f74bd194SAndy Whitcroft 26172b474a1aSAndy Whitcroft # Find the real next line. 26182b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 26192b474a1aSAndy Whitcroft if (defined $realline_next && 26202b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 26212b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 26222b474a1aSAndy Whitcroft $realline_next++; 26232b474a1aSAndy Whitcroft } 26242b474a1aSAndy Whitcroft 2625171ae1a4SAndy Whitcroft my $s = $stat; 2626171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2627cf655043SAndy Whitcroft 2628c2fdda0dSAndy Whitcroft # Ignore goto labels. 2629171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2630c2fdda0dSAndy Whitcroft 2631c2fdda0dSAndy Whitcroft # Ignore functions being called 2632171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2633c2fdda0dSAndy Whitcroft 2634463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2635463f2864SAndy Whitcroft 2636c45dcabdSAndy Whitcroft # declarations always start with types 2637d2506586SAndy 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) { 2638c45dcabdSAndy Whitcroft my $type = $1; 2639c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2640c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2641c45dcabdSAndy Whitcroft 26426c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2643a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2644c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2645c2fdda0dSAndy Whitcroft } 26468905a67cSAndy Whitcroft 26476c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 264865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2649c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 26509c0ca6f9SAndy Whitcroft } 26518905a67cSAndy Whitcroft 26528905a67cSAndy Whitcroft # Check for any sort of function declaration. 26538905a67cSAndy Whitcroft # int foo(something bar, other baz); 26548905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2655171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 26568905a67cSAndy Whitcroft my ($name_len) = length($1); 26578905a67cSAndy Whitcroft 2658cf655043SAndy Whitcroft my $ctx = $s; 2659773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 26608905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2661cf655043SAndy Whitcroft 26628905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2663c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 26648905a67cSAndy Whitcroft 2665c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 26668905a67cSAndy Whitcroft } 26678905a67cSAndy Whitcroft } 26688905a67cSAndy Whitcroft } 26698905a67cSAndy Whitcroft 26709c0ca6f9SAndy Whitcroft } 26719c0ca6f9SAndy Whitcroft 267200df344fSAndy Whitcroft# 267300df344fSAndy Whitcroft# Checks which may be anchored in the context. 267400df344fSAndy Whitcroft# 267500df344fSAndy Whitcroft 267600df344fSAndy Whitcroft# Check for switch () and associated case and default 267700df344fSAndy Whitcroft# statements should be at the same indent. 267800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 267900df344fSAndy Whitcroft my $err = ''; 268000df344fSAndy Whitcroft my $sep = ''; 268100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 268200df344fSAndy Whitcroft shift(@ctx); 268300df344fSAndy Whitcroft for my $ctx (@ctx) { 268400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 268500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 268600df344fSAndy Whitcroft $indent != $cindent) { 268700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 268800df344fSAndy Whitcroft $sep = ''; 268900df344fSAndy Whitcroft } else { 269000df344fSAndy Whitcroft $sep = "[...]\n"; 269100df344fSAndy Whitcroft } 269200df344fSAndy Whitcroft } 269300df344fSAndy Whitcroft if ($err ne '') { 2694000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2695000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2696de7d4f0eSAndy Whitcroft } 2697de7d4f0eSAndy Whitcroft } 2698de7d4f0eSAndy Whitcroft 2699de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2700de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2701*0fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2702773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2703773647a0SAndy Whitcroft 27049c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 27058eef05ddSJoe Perches 27068eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 27078eef05ddSJoe Perches WARN("DEEP_INDENTATION", 27088eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 27098eef05ddSJoe Perches } 27108eef05ddSJoe Perches 2711de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2712de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2713de7d4f0eSAndy Whitcroft 2714548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2715548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2716de7d4f0eSAndy Whitcroft 2717548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2718548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2719548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2720548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2721548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2722773647a0SAndy Whitcroft $ctx_ln++; 2723773647a0SAndy Whitcroft } 2724548596d5SAndy Whitcroft 272553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 272653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2727773647a0SAndy Whitcroft 2728773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2729000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2730000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 273101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 273200df344fSAndy Whitcroft } 2733773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2734773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2735773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2736773647a0SAndy Whitcroft { 27379c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 27389c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2739000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2740000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 274101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 27429c0ca6f9SAndy Whitcroft } 27439c0ca6f9SAndy Whitcroft } 274400df344fSAndy Whitcroft } 274500df344fSAndy Whitcroft 27464d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 2747*0fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 27483e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 27493e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 27503e469cdcSAndy Whitcroft if (!defined $stat); 27514d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 27524d001e4dSAndy Whitcroft 27534d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 27544d001e4dSAndy Whitcroft 27554d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 27564d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 27574d001e4dSAndy Whitcroft # where necessary. 27584d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 27594d001e4dSAndy Whitcroft 27604d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 27616f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 27626f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 27634d001e4dSAndy Whitcroft 27644d001e4dSAndy Whitcroft # We want to check the first line inside the block 27654d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 27664d001e4dSAndy Whitcroft # 1) any blank line termination 27674d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 27684d001e4dSAndy Whitcroft # 3) any do (...) { 27694d001e4dSAndy Whitcroft my $continuation = 0; 27704d001e4dSAndy Whitcroft my $check = 0; 27714d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 27724d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 27734d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 27744d001e4dSAndy Whitcroft $continuation = 1; 27754d001e4dSAndy Whitcroft } 27769bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 27774d001e4dSAndy Whitcroft $check = 1; 27784d001e4dSAndy Whitcroft $cond_lines++; 27794d001e4dSAndy Whitcroft } 27804d001e4dSAndy Whitcroft 27814d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 27824d001e4dSAndy Whitcroft # preprocessor statement. 27834d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 27844d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 27854d001e4dSAndy Whitcroft $check = 0; 27864d001e4dSAndy Whitcroft } 27874d001e4dSAndy Whitcroft 27889bd49efeSAndy Whitcroft my $cond_ptr = -1; 2789740504c6SAndy Whitcroft $continuation = 0; 27909bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 27919bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 27924d001e4dSAndy Whitcroft 2793f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2794f16fa28fSAndy Whitcroft # is not linear. 2795f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2796f16fa28fSAndy Whitcroft $check = 0; 2797f16fa28fSAndy Whitcroft } 2798f16fa28fSAndy Whitcroft 27999bd49efeSAndy Whitcroft # Ignore: 28009bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 28019bd49efeSAndy Whitcroft # 2) preprocessor lines, and 28029bd49efeSAndy Whitcroft # 3) labels. 2803740504c6SAndy Whitcroft if ($continuation || 2804740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 28059bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 28069bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2807740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 280830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 28099bd49efeSAndy Whitcroft $cond_lines++; 28109bd49efeSAndy Whitcroft } 28114d001e4dSAndy Whitcroft } 281230dad6ebSAndy Whitcroft } 28134d001e4dSAndy Whitcroft 28144d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 28154d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 28164d001e4dSAndy Whitcroft 28174d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 28184d001e4dSAndy Whitcroft # this is not this patch's fault. 28194d001e4dSAndy Whitcroft if (!defined($stat_real) || 28204d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 28214d001e4dSAndy Whitcroft $check = 0; 28224d001e4dSAndy Whitcroft } 28234d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 28244d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 28254d001e4dSAndy Whitcroft } 28264d001e4dSAndy Whitcroft 28279bd49efeSAndy 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"; 28284d001e4dSAndy Whitcroft 28294d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 28304d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2831000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2832000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 28334d001e4dSAndy Whitcroft } 28344d001e4dSAndy Whitcroft } 28354d001e4dSAndy Whitcroft 28366c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 28376c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 28381f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 28391f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 28406c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2841c2fdda0dSAndy Whitcroft if ($dbg_values) { 2842c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2843cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2844cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 28451f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2846c2fdda0dSAndy Whitcroft } 28476c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 28486c72ffaaSAndy Whitcroft 284900df344fSAndy Whitcroft#ignore lines not being added 28503705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 285100df344fSAndy Whitcroft 2852653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 28537429c690SAndy Whitcroft if ($dbg_type) { 28547429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2855000d1cc1SJoe Perches ERROR("TEST_TYPE", 2856000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 28577429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2858000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2859000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 28607429c690SAndy Whitcroft } 2861653d4876SAndy Whitcroft next; 2862653d4876SAndy Whitcroft } 2863a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2864a1ef277eSAndy Whitcroft if ($dbg_attr) { 28659360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2866000d1cc1SJoe Perches ERROR("TEST_ATTR", 2867000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 28689360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2869000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2870000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2871a1ef277eSAndy Whitcroft } 2872a1ef277eSAndy Whitcroft next; 2873a1ef277eSAndy Whitcroft } 2874653d4876SAndy Whitcroft 2875f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 287699423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 287799423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2878d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 2879d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 2880f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 2881f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 2882f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2883d752fcc8SJoe Perches my $fixedline = $prevrawline; 2884d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 2885f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 2886d752fcc8SJoe Perches $fixedline = $line; 2887d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 2888f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 2889d752fcc8SJoe Perches } 2890f0a594c1SAndy Whitcroft } 2891f0a594c1SAndy Whitcroft 289200df344fSAndy Whitcroft# 289300df344fSAndy Whitcroft# Checks which are anchored on the added line. 289400df344fSAndy Whitcroft# 289500df344fSAndy Whitcroft 2896653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2897c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2898653d4876SAndy Whitcroft my $path = $1; 2899653d4876SAndy Whitcroft if ($path =~ m{//}) { 2900000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2901495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2902495e9d84SJoe Perches } 2903495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2904495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2905495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2906653d4876SAndy Whitcroft } 2907653d4876SAndy Whitcroft } 2908653d4876SAndy Whitcroft 290900df344fSAndy Whitcroft# no C99 // comments 291000df344fSAndy Whitcroft if ($line =~ m{//}) { 29113705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 29123705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 29133705ce5bSJoe Perches $fix) { 2914194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 29153705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 29163705ce5bSJoe Perches my $comment = trim($1); 2917194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 29183705ce5bSJoe Perches } 29193705ce5bSJoe Perches } 292000df344fSAndy Whitcroft } 292100df344fSAndy Whitcroft # Remove C99 comments. 29220a920b5bSAndy Whitcroft $line =~ s@//.*@@; 29236c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 29240a920b5bSAndy Whitcroft 29252b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 29262b474a1aSAndy Whitcroft# the whole statement. 29272b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 29282b474a1aSAndy Whitcroft if (defined $realline_next && 29292b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 29302b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 29312b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 29322b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 29333cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 29343cbf62dfSAndy Whitcroft # a prefix: 29353cbf62dfSAndy Whitcroft # XXX(foo); 29363cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2937653d4876SAndy Whitcroft my $name = $1; 293887a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 29393cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 29403cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 29413cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 29423cbf62dfSAndy Whitcroft 29433cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 29442b474a1aSAndy Whitcroft \n.}\s*$| 294548012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 294648012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 294748012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 29482b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 29492b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 295048012058SAndy Whitcroft )/x) { 29512b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 29522b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 29532b474a1aSAndy Whitcroft } else { 29542b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 29550a920b5bSAndy Whitcroft } 29560a920b5bSAndy Whitcroft } 29572b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 29582b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 29592b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 29602b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 29612b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 29622b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 29632b474a1aSAndy Whitcroft } 29642b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 29652b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2966000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2967000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 29682b474a1aSAndy Whitcroft } 29690a920b5bSAndy Whitcroft 29705150bda4SJoe Eloff# check for global initialisers. 2971d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2972d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2973000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2974d5e616fcSJoe Perches $herecurr) && 2975d5e616fcSJoe Perches $fix) { 2976194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2977d5e616fcSJoe Perches } 2978f0a594c1SAndy Whitcroft } 29790a920b5bSAndy Whitcroft# check for static initialisers. 2980d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2981d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2982000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2983d5e616fcSJoe Perches $herecurr) && 2984d5e616fcSJoe Perches $fix) { 2985194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2986d5e616fcSJoe Perches } 29870a920b5bSAndy Whitcroft } 29880a920b5bSAndy Whitcroft 2989cb710ecaSJoe Perches# check for static const char * arrays. 2990cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2991000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2992000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2993cb710ecaSJoe Perches $herecurr); 2994cb710ecaSJoe Perches } 2995cb710ecaSJoe Perches 2996cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2997cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2998000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2999000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3000cb710ecaSJoe Perches $herecurr); 3001cb710ecaSJoe Perches } 3002cb710ecaSJoe Perches 30039b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 30049b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 30059b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 30069b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 30079b0fa60dSJoe Perches $herecurr); 30089b0fa60dSJoe Perches } 30099b0fa60dSJoe Perches 3010b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3011b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3012b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3013b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3014b36190c5SJoe Perches $fix) { 3015194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3016b36190c5SJoe Perches } 3017b36190c5SJoe Perches } 3018b36190c5SJoe Perches 301992e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 302092e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 302192e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 302292e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 302392e112fdSJoe Perches $fix) { 3024194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 302592e112fdSJoe Perches } 302693ed0e2dSJoe Perches } 302793ed0e2dSJoe Perches 3028653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3029653d4876SAndy Whitcroft# make sense. 3030653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 30318054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3032c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 30338ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3034653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3035000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3036000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 30370a920b5bSAndy Whitcroft } 30380a920b5bSAndy Whitcroft 30390a920b5bSAndy Whitcroft# * goes on variable not on type 304065863862SAndy Whitcroft # (char*[ const]) 3041bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3042bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 30433705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3044d8aaf121SAndy Whitcroft 304565863862SAndy Whitcroft # Should start with a space. 304665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 304765863862SAndy Whitcroft # Should not end with a space. 304865863862SAndy Whitcroft $to =~ s/\s+$//; 304965863862SAndy Whitcroft # '*'s should not have spaces between. 3050f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 305165863862SAndy Whitcroft } 3052d8aaf121SAndy Whitcroft 30533705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 305465863862SAndy Whitcroft if ($from ne $to) { 30553705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 30563705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 30573705ce5bSJoe Perches $fix) { 30583705ce5bSJoe Perches my $sub_from = $ident; 30593705ce5bSJoe Perches my $sub_to = $ident; 30603705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3061194f66fcSJoe Perches $fixed[$fixlinenr] =~ 30623705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 30633705ce5bSJoe Perches } 306465863862SAndy Whitcroft } 3065bfcb2cc7SAndy Whitcroft } 3066bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3067bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 30683705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3069d8aaf121SAndy Whitcroft 307065863862SAndy Whitcroft # Should start with a space. 307165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 307265863862SAndy Whitcroft # Should not end with a space. 307365863862SAndy Whitcroft $to =~ s/\s+$//; 307465863862SAndy Whitcroft # '*'s should not have spaces between. 3075f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 307665863862SAndy Whitcroft } 307765863862SAndy Whitcroft # Modifiers should have spaces. 307865863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 307965863862SAndy Whitcroft 30803705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3081667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 30823705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 30833705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 30843705ce5bSJoe Perches $fix) { 30853705ce5bSJoe Perches 30863705ce5bSJoe Perches my $sub_from = $match; 30873705ce5bSJoe Perches my $sub_to = $match; 30883705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3089194f66fcSJoe Perches $fixed[$fixlinenr] =~ 30903705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 30913705ce5bSJoe Perches } 309265863862SAndy Whitcroft } 30930a920b5bSAndy Whitcroft } 30940a920b5bSAndy Whitcroft 30950a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 30960a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 30970a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 30980a920b5bSAndy Whitcroft# print "$herecurr"; 30990a920b5bSAndy Whitcroft# $clean = 0; 31000a920b5bSAndy Whitcroft# } 31010a920b5bSAndy Whitcroft 31028905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3103000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3104000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 31058905a67cSAndy Whitcroft } 31068905a67cSAndy Whitcroft 310717441227SJoe Perches# check for uses of printk_ratelimit 310817441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3109000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3110000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 311117441227SJoe Perches } 311217441227SJoe Perches 311300df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 311400df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 311500df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 311625985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 311700df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3118f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 311900df344fSAndy Whitcroft my $ok = 0; 312000df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 312100df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 312225985edcSLucas De Marchi # we have a preceding printk if it ends 312300df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 312400df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 312500df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 312600df344fSAndy Whitcroft $ok = 1; 312700df344fSAndy Whitcroft } 312800df344fSAndy Whitcroft last; 312900df344fSAndy Whitcroft } 313000df344fSAndy Whitcroft } 313100df344fSAndy Whitcroft if ($ok == 0) { 3132000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3133000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 31340a920b5bSAndy Whitcroft } 313500df344fSAndy Whitcroft } 31360a920b5bSAndy Whitcroft 3137243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3138243f3803SJoe Perches my $orig = $1; 3139243f3803SJoe Perches my $level = lc($orig); 3140243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 31418f26b837SJoe Perches my $level2 = $level; 31428f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3143243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3144daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3145243f3803SJoe Perches } 3146243f3803SJoe Perches 3147243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3148d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3149d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3150d5e616fcSJoe Perches $fix) { 3151194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3152d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3153d5e616fcSJoe Perches } 3154243f3803SJoe Perches } 3155243f3803SJoe Perches 3156dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3157dc139313SJoe Perches my $orig = $1; 3158dc139313SJoe Perches my $level = lc($orig); 3159dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3160dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3161dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3162dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3163dc139313SJoe Perches } 3164dc139313SJoe Perches 3165653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3166653d4876SAndy Whitcroft# or if closed on same line 31678d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3168c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 31698d182478SJoe Perches if (ERROR("OPEN_BRACE", 31708d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 31718d182478SJoe Perches $fix) { 31728d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 31738d182478SJoe Perches my $fixed_line = $rawline; 31748d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 31758d182478SJoe Perches my $line1 = $1; 31768d182478SJoe Perches my $line2 = $2; 31778d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 31788d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 31798d182478SJoe Perches if ($line2 !~ /^\s*$/) { 31808d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 31818d182478SJoe Perches } 31828d182478SJoe Perches } 31830a920b5bSAndy Whitcroft } 3184653d4876SAndy Whitcroft 31858905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 31868905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 31878905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 31888d182478SJoe Perches if (ERROR("OPEN_BRACE", 31898d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 31908d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 31918d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 31928d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 31938d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 31948d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 31958d182478SJoe Perches $fixedline = $rawline; 31968d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 31978d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 31988d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 31998d182478SJoe Perches } 32008d182478SJoe Perches } 32018905a67cSAndy Whitcroft } 32028905a67cSAndy Whitcroft 32030c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 32043705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 32053705ce5bSJoe Perches if (WARN("SPACING", 32063705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 32073705ce5bSJoe Perches $fix) { 3208194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32093705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 32103705ce5bSJoe Perches } 32110c73b4ebSAndy Whitcroft } 32120c73b4ebSAndy Whitcroft 321331070b5dSJoe Perches# Function pointer declarations 321431070b5dSJoe Perches# check spacing between type, funcptr, and args 321531070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 321691f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 321731070b5dSJoe Perches my $declare = $1; 321831070b5dSJoe Perches my $pre_pointer_space = $2; 321931070b5dSJoe Perches my $post_pointer_space = $3; 322031070b5dSJoe Perches my $funcname = $4; 322131070b5dSJoe Perches my $post_funcname_space = $5; 322231070b5dSJoe Perches my $pre_args_space = $6; 322331070b5dSJoe Perches 322491f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 322591f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 322691f72e9cSJoe Perches# don't need a space so don't warn for those. 322791f72e9cSJoe Perches my $post_declare_space = ""; 322891f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 322991f72e9cSJoe Perches $post_declare_space = $1; 323091f72e9cSJoe Perches $declare = rtrim($declare); 323191f72e9cSJoe Perches } 323291f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 323331070b5dSJoe Perches WARN("SPACING", 323431070b5dSJoe Perches "missing space after return type\n" . $herecurr); 323591f72e9cSJoe Perches $post_declare_space = " "; 323631070b5dSJoe Perches } 323731070b5dSJoe Perches 323831070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 323991f72e9cSJoe Perches# This test is not currently implemented because these declarations are 324091f72e9cSJoe Perches# equivalent to 324191f72e9cSJoe Perches# int foo(int bar, ...) 324291f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 324391f72e9cSJoe Perches# 324491f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 324591f72e9cSJoe Perches# WARN("SPACING", 324691f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 324791f72e9cSJoe Perches# } 324831070b5dSJoe Perches 324931070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 325031070b5dSJoe Perches if (defined $pre_pointer_space && 325131070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 325231070b5dSJoe Perches WARN("SPACING", 325331070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 325431070b5dSJoe Perches } 325531070b5dSJoe Perches 325631070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 325731070b5dSJoe Perches if (defined $post_pointer_space && 325831070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 325931070b5dSJoe Perches WARN("SPACING", 326031070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 326131070b5dSJoe Perches } 326231070b5dSJoe Perches 326331070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 326431070b5dSJoe Perches if (defined $post_funcname_space && 326531070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 326631070b5dSJoe Perches WARN("SPACING", 326731070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 326831070b5dSJoe Perches } 326931070b5dSJoe Perches 327031070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 327131070b5dSJoe Perches if (defined $pre_args_space && 327231070b5dSJoe Perches $pre_args_space =~ /^\s/) { 327331070b5dSJoe Perches WARN("SPACING", 327431070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 327531070b5dSJoe Perches } 327631070b5dSJoe Perches 327731070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3278194f66fcSJoe Perches $fixed[$fixlinenr] =~ 327991f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 328031070b5dSJoe Perches } 328131070b5dSJoe Perches } 328231070b5dSJoe Perches 32838d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 32848d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3285fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3286fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 32878d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 32888d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 32898d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3290fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3291daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 32923705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 32933705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 32943705ce5bSJoe Perches $fix) { 3295194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32963705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 32973705ce5bSJoe Perches } 32988d31cfceSAndy Whitcroft } 32998d31cfceSAndy Whitcroft } 33008d31cfceSAndy Whitcroft 3301f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 33026c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3303c2fdda0dSAndy Whitcroft my $name = $1; 3304773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3305773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3306c2fdda0dSAndy Whitcroft 3307c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3308773647a0SAndy Whitcroft if ($name =~ /^(?: 3309773647a0SAndy Whitcroft if|for|while|switch|return|case| 3310773647a0SAndy Whitcroft volatile|__volatile__| 3311773647a0SAndy Whitcroft __attribute__|format|__extension__| 3312773647a0SAndy Whitcroft asm|__asm__)$/x) 3313773647a0SAndy Whitcroft { 3314c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3315c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3316c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3317c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3318773647a0SAndy Whitcroft 3319773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3320c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3321c2fdda0dSAndy Whitcroft 3322c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3323c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3324773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3325c2fdda0dSAndy Whitcroft 3326c2fdda0dSAndy Whitcroft } else { 33273705ce5bSJoe Perches if (WARN("SPACING", 33283705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 33293705ce5bSJoe Perches $fix) { 3330194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33313705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 33323705ce5bSJoe Perches } 3333f0a594c1SAndy Whitcroft } 33346c72ffaaSAndy Whitcroft } 33359a4cad4eSEric Nelson 3336653d4876SAndy Whitcroft# Check operator spacing. 33370a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 33383705ce5bSJoe Perches my $fixed_line = ""; 33393705ce5bSJoe Perches my $line_fixed = 0; 33403705ce5bSJoe Perches 33419c0ca6f9SAndy Whitcroft my $ops = qr{ 33429c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 33439c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 33449c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 33451f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 334684731623SJoe Perches \?:|\?|: 33479c0ca6f9SAndy Whitcroft }x; 3348cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 33493705ce5bSJoe Perches 33503705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 33513705ce5bSJoe Perches## foreach my $el (@elements) { 33523705ce5bSJoe Perches## print("el: <$el>\n"); 33533705ce5bSJoe Perches## } 33543705ce5bSJoe Perches 33553705ce5bSJoe Perches my @fix_elements = (); 335600df344fSAndy Whitcroft my $off = 0; 33576c72ffaaSAndy Whitcroft 33583705ce5bSJoe Perches foreach my $el (@elements) { 33593705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 33603705ce5bSJoe Perches $off += length($el); 33613705ce5bSJoe Perches } 33623705ce5bSJoe Perches 33633705ce5bSJoe Perches $off = 0; 33643705ce5bSJoe Perches 33656c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3366b34c648bSJoe Perches my $last_after = -1; 33676c72ffaaSAndy Whitcroft 33680a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 33693705ce5bSJoe Perches 33703705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 33713705ce5bSJoe Perches 33723705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 33733705ce5bSJoe Perches 33744a0df2efSAndy Whitcroft $off += length($elements[$n]); 33754a0df2efSAndy Whitcroft 337625985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3377773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3378773647a0SAndy Whitcroft my $cc = ''; 3379773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3380773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3381773647a0SAndy Whitcroft } 3382773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3383773647a0SAndy Whitcroft 33844a0df2efSAndy Whitcroft my $a = ''; 33854a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 33864a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3387cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 33884a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 33894a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3390773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 33914a0df2efSAndy Whitcroft 33920a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 33934a0df2efSAndy Whitcroft 33944a0df2efSAndy Whitcroft my $c = ''; 33950a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 33964a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 33974a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3398cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 33994a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 34004a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 34018b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 34024a0df2efSAndy Whitcroft } else { 34034a0df2efSAndy Whitcroft $c = 'E'; 34040a920b5bSAndy Whitcroft } 34050a920b5bSAndy Whitcroft 34064a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 34074a0df2efSAndy Whitcroft 34084a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 34094a0df2efSAndy Whitcroft 34106c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3411de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 34120a920b5bSAndy Whitcroft 341374048ed8SAndy Whitcroft # Pull out the value of this operator. 34146c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 34150a920b5bSAndy Whitcroft 34161f65f947SAndy Whitcroft # Get the full operator variant. 34171f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 34181f65f947SAndy Whitcroft 341913214adfSAndy Whitcroft # Ignore operators passed as parameters. 342013214adfSAndy Whitcroft if ($op_type ne 'V' && 342113214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 342213214adfSAndy Whitcroft 3423cf655043SAndy Whitcroft# # Ignore comments 3424cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 342513214adfSAndy Whitcroft 3426d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 342713214adfSAndy Whitcroft } elsif ($op eq ';') { 3428cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3429cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 34303705ce5bSJoe Perches if (ERROR("SPACING", 34313705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3432b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 34333705ce5bSJoe Perches $line_fixed = 1; 34343705ce5bSJoe Perches } 3435d8aaf121SAndy Whitcroft } 3436d8aaf121SAndy Whitcroft 3437d8aaf121SAndy Whitcroft # // is a comment 3438d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 34390a920b5bSAndy Whitcroft 3440b00e4814SJoe Perches # : when part of a bitfield 3441b00e4814SJoe Perches } elsif ($opv eq ':B') { 3442b00e4814SJoe Perches # skip the bitfield test for now 3443b00e4814SJoe Perches 34441f65f947SAndy Whitcroft # No spaces for: 34451f65f947SAndy Whitcroft # -> 3446b00e4814SJoe Perches } elsif ($op eq '->') { 34474a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 34483705ce5bSJoe Perches if (ERROR("SPACING", 34493705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3450b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 34513705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 34523705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 34533705ce5bSJoe Perches } 3454b34c648bSJoe Perches $line_fixed = 1; 34553705ce5bSJoe Perches } 34560a920b5bSAndy Whitcroft } 34570a920b5bSAndy Whitcroft 34580a920b5bSAndy Whitcroft # , must have a space on the right. 34590a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3460cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 34613705ce5bSJoe Perches if (ERROR("SPACING", 34623705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3463b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 34643705ce5bSJoe Perches $line_fixed = 1; 3465b34c648bSJoe Perches $last_after = $n; 34663705ce5bSJoe Perches } 34670a920b5bSAndy Whitcroft } 34680a920b5bSAndy Whitcroft 34699c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 347074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 34719c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 34729c0ca6f9SAndy Whitcroft 34739c0ca6f9SAndy Whitcroft # unary operators should have a space before and 34749c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 34759c0ca6f9SAndy Whitcroft # unary operator, or a cast 34769c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 347774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 34780d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3479cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 34803705ce5bSJoe Perches if (ERROR("SPACING", 34813705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3482b34c648bSJoe Perches if ($n != $last_after + 2) { 3483b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 34843705ce5bSJoe Perches $line_fixed = 1; 34853705ce5bSJoe Perches } 34860a920b5bSAndy Whitcroft } 3487b34c648bSJoe Perches } 3488a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3489171ae1a4SAndy Whitcroft # A unary '*' may be const 3490171ae1a4SAndy Whitcroft 3491171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 34923705ce5bSJoe Perches if (ERROR("SPACING", 34933705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3494b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 34953705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 34963705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 34973705ce5bSJoe Perches } 3498b34c648bSJoe Perches $line_fixed = 1; 34993705ce5bSJoe Perches } 35000a920b5bSAndy Whitcroft } 35010a920b5bSAndy Whitcroft 35020a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 35030a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3504773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 35053705ce5bSJoe Perches if (ERROR("SPACING", 35063705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3507b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 35083705ce5bSJoe Perches $line_fixed = 1; 35093705ce5bSJoe Perches } 35100a920b5bSAndy Whitcroft } 3511773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3512773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 35133705ce5bSJoe Perches if (ERROR("SPACING", 35143705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3515b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 35163705ce5bSJoe Perches $line_fixed = 1; 35173705ce5bSJoe Perches } 3518653d4876SAndy Whitcroft } 3519773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 35203705ce5bSJoe Perches if (ERROR("SPACING", 35213705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3522b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 35233705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 35243705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3525773647a0SAndy Whitcroft } 3526b34c648bSJoe Perches $line_fixed = 1; 35273705ce5bSJoe Perches } 35283705ce5bSJoe Perches } 35290a920b5bSAndy Whitcroft 35300a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 35319c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 35329c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 35339c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3534c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3535c2fdda0dSAndy Whitcroft $op eq '%') 35360a920b5bSAndy Whitcroft { 3537773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 35383705ce5bSJoe Perches if (ERROR("SPACING", 35393705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3540b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3541b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3542b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3543b34c648bSJoe Perches } 35443705ce5bSJoe Perches $line_fixed = 1; 35453705ce5bSJoe Perches } 35460a920b5bSAndy Whitcroft } 35470a920b5bSAndy Whitcroft 35481f65f947SAndy Whitcroft # A colon needs no spaces before when it is 35491f65f947SAndy Whitcroft # terminating a case value or a label. 35501f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 35511f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 35523705ce5bSJoe Perches if (ERROR("SPACING", 35533705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3554b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 35553705ce5bSJoe Perches $line_fixed = 1; 35563705ce5bSJoe Perches } 35571f65f947SAndy Whitcroft } 35581f65f947SAndy Whitcroft 35590a920b5bSAndy Whitcroft # All the others need spaces both sides. 3560cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 35611f65f947SAndy Whitcroft my $ok = 0; 35621f65f947SAndy Whitcroft 356322f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 35641f65f947SAndy Whitcroft if (($op eq '<' && 35651f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 35661f65f947SAndy Whitcroft ($op eq '>' && 35671f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 35681f65f947SAndy Whitcroft { 35691f65f947SAndy Whitcroft $ok = 1; 35701f65f947SAndy Whitcroft } 35711f65f947SAndy Whitcroft 357284731623SJoe Perches # messages are ERROR, but ?: are CHK 35731f65f947SAndy Whitcroft if ($ok == 0) { 357484731623SJoe Perches my $msg_type = \&ERROR; 357584731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 357684731623SJoe Perches 357784731623SJoe Perches if (&{$msg_type}("SPACING", 35783705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3579b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3580b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3581b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3582b34c648bSJoe Perches } 35833705ce5bSJoe Perches $line_fixed = 1; 35843705ce5bSJoe Perches } 35850a920b5bSAndy Whitcroft } 358622f2a2efSAndy Whitcroft } 35874a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 35883705ce5bSJoe Perches 35893705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 35903705ce5bSJoe Perches 35913705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 35920a920b5bSAndy Whitcroft } 35933705ce5bSJoe Perches 35943705ce5bSJoe Perches if (($#elements % 2) == 0) { 35953705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 35963705ce5bSJoe Perches } 35973705ce5bSJoe Perches 3598194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3599194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 36003705ce5bSJoe Perches } 36013705ce5bSJoe Perches 36023705ce5bSJoe Perches 36030a920b5bSAndy Whitcroft } 36040a920b5bSAndy Whitcroft 3605786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3606d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3607786b6326SJoe Perches if (WARN("SPACING", 3608786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3609786b6326SJoe Perches $fix) { 3610194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3611786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3612786b6326SJoe Perches } 3613786b6326SJoe Perches } 3614786b6326SJoe Perches 3615f0a594c1SAndy Whitcroft# check for multiple assignments 3616f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3617000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3618000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3619f0a594c1SAndy Whitcroft } 3620f0a594c1SAndy Whitcroft 362122f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 362222f2a2efSAndy Whitcroft## # continuation. 362322f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 362422f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 362522f2a2efSAndy Whitcroft## 362622f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 362722f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 362822f2a2efSAndy Whitcroft## my $ln = $line; 362922f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 363022f2a2efSAndy Whitcroft## } 363122f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3632000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3633000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 363422f2a2efSAndy Whitcroft## } 363522f2a2efSAndy Whitcroft## } 3636f0a594c1SAndy Whitcroft 36370a920b5bSAndy Whitcroft#need space before brace following if, while, etc 363822f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 363922f2a2efSAndy Whitcroft $line =~ /do{/) { 36403705ce5bSJoe Perches if (ERROR("SPACING", 36413705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 36423705ce5bSJoe Perches $fix) { 3643194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 36443705ce5bSJoe Perches } 3645de7d4f0eSAndy Whitcroft } 3646de7d4f0eSAndy Whitcroft 3647c4a62ef9SJoe Perches## # check for blank lines before declarations 3648c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3649c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3650c4a62ef9SJoe Perches## WARN("SPACING", 3651c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3652c4a62ef9SJoe Perches## } 3653c4a62ef9SJoe Perches## 3654c4a62ef9SJoe Perches 3655de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3656de7d4f0eSAndy Whitcroft# on the line 3657de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3658d5e616fcSJoe Perches if (ERROR("SPACING", 3659d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3660d5e616fcSJoe Perches $fix) { 3661194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3662d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3663d5e616fcSJoe Perches } 36640a920b5bSAndy Whitcroft } 36650a920b5bSAndy Whitcroft 366622f2a2efSAndy Whitcroft# check spacing on square brackets 366722f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 36683705ce5bSJoe Perches if (ERROR("SPACING", 36693705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 36703705ce5bSJoe Perches $fix) { 3671194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36723705ce5bSJoe Perches s/\[\s+/\[/; 36733705ce5bSJoe Perches } 367422f2a2efSAndy Whitcroft } 367522f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 36763705ce5bSJoe Perches if (ERROR("SPACING", 36773705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 36783705ce5bSJoe Perches $fix) { 3679194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36803705ce5bSJoe Perches s/\s+\]/\]/; 36813705ce5bSJoe Perches } 368222f2a2efSAndy Whitcroft } 368322f2a2efSAndy Whitcroft 3684c45dcabdSAndy Whitcroft# check spacing on parentheses 36859c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 36869c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 36873705ce5bSJoe Perches if (ERROR("SPACING", 36883705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 36893705ce5bSJoe Perches $fix) { 3690194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36913705ce5bSJoe Perches s/\(\s+/\(/; 36923705ce5bSJoe Perches } 369322f2a2efSAndy Whitcroft } 369413214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3695c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3696c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 36973705ce5bSJoe Perches if (ERROR("SPACING", 36983705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 36993705ce5bSJoe Perches $fix) { 3700194f66fcSJoe Perches print("fixlinenr: <$fixlinenr> fixed[fixlinenr]: <$fixed[$fixlinenr]>\n"); 3701194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37023705ce5bSJoe Perches s/\s+\)/\)/; 37033705ce5bSJoe Perches } 370422f2a2efSAndy Whitcroft } 370522f2a2efSAndy Whitcroft 3706e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 3707e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 3708e2826fd0SJoe Perches 3709e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 3710e2826fd0SJoe Perches CHK("UNNECESSARY_PARENTHESES", 3711e2826fd0SJoe Perches "Unnecessary parentheses around $1\n" . $herecurr); 3712e2826fd0SJoe Perches } 3713e2826fd0SJoe Perches 37140a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 37154a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 37160a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 37173705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 37183705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 37193705ce5bSJoe Perches $fix) { 3720194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37213705ce5bSJoe Perches s/^(.)\s+/$1/; 37223705ce5bSJoe Perches } 37230a920b5bSAndy Whitcroft } 37240a920b5bSAndy Whitcroft 37255b9553abSJoe Perches# return is not a function 3726507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3727c45dcabdSAndy Whitcroft my $spacing = $1; 3728507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 37295b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 37305b9553abSJoe Perches my $value = $1; 37315b9553abSJoe Perches $value = deparenthesize($value); 37325b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3733000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3734000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 37355b9553abSJoe Perches } 3736c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3737000d1cc1SJoe Perches ERROR("SPACING", 3738000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3739c45dcabdSAndy Whitcroft } 3740c45dcabdSAndy Whitcroft } 3741507e5141SJoe Perches 3742b43ae21bSJoe Perches# unnecessary return in a void function 3743b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 3744b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 3745b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 3746b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 3747b43ae21bSJoe Perches $linenr >= 3 && 3748b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 3749b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 37509819cf25SJoe Perches WARN("RETURN_VOID", 3751b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 37529819cf25SJoe Perches } 37539819cf25SJoe Perches 3754189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3755189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3756189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3757189248d8SJoe Perches my $openparens = $1; 3758189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3759189248d8SJoe Perches my $msg = ""; 3760189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3761189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3762189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3763189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3764189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3765189248d8SJoe Perches } 3766189248d8SJoe Perches } 3767189248d8SJoe Perches 376853a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 376953a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 377053a3c448SAndy Whitcroft my $name = $1; 377153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3772000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3773000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 377453a3c448SAndy Whitcroft } 377553a3c448SAndy Whitcroft } 3776c45dcabdSAndy Whitcroft 37770a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 37784a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 37793705ce5bSJoe Perches if (ERROR("SPACING", 37803705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 37813705ce5bSJoe Perches $fix) { 3782194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37833705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 37843705ce5bSJoe Perches } 37850a920b5bSAndy Whitcroft } 37860a920b5bSAndy Whitcroft 3787f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3788f5fe35ddSAndy Whitcroft# statements after the conditional. 3789170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 37903e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 37913e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 37923e469cdcSAndy Whitcroft if (!defined $stat); 3793170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3794170d3a22SAndy Whitcroft $remain_next, $off_next); 3795170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3796170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3797170d3a22SAndy Whitcroft 3798170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3799170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3800170d3a22SAndy Whitcroft # then count those as offsets. 3801170d3a22SAndy Whitcroft my ($whitespace) = 3802170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3803170d3a22SAndy Whitcroft my $offset = 3804170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3805170d3a22SAndy Whitcroft 3806170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3807170d3a22SAndy Whitcroft $offset} = 1; 3808170d3a22SAndy Whitcroft } 3809170d3a22SAndy Whitcroft } 3810170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3811c11230f4SJoe Perches defined($stat) && defined($cond) && 3812170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3813171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 38148905a67cSAndy Whitcroft 3815b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3816000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3817000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 38188905a67cSAndy Whitcroft } 38198905a67cSAndy Whitcroft 38208905a67cSAndy Whitcroft # Find out what is on the end of the line after the 38218905a67cSAndy Whitcroft # conditional. 3822773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 38238905a67cSAndy Whitcroft $s =~ s/\n.*//g; 382413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 382553210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 382653210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3827773647a0SAndy Whitcroft { 3828bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3829bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3830bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 383142bdf74cSHidetoshi Seto my $stat_real = ''; 3832bb44ad39SAndy Whitcroft 383342bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 383442bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3835bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3836bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3837bb44ad39SAndy Whitcroft } 3838bb44ad39SAndy Whitcroft 3839000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3840000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 38418905a67cSAndy Whitcroft } 38428905a67cSAndy Whitcroft } 38438905a67cSAndy Whitcroft 384413214adfSAndy Whitcroft# Check for bitwise tests written as boolean 384513214adfSAndy Whitcroft if ($line =~ / 384613214adfSAndy Whitcroft (?: 384713214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 384813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 384913214adfSAndy Whitcroft (?:\&\&|\|\|) 385013214adfSAndy Whitcroft | 385113214adfSAndy Whitcroft (?:\&\&|\|\|) 385213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 385313214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 385413214adfSAndy Whitcroft )/x) 385513214adfSAndy Whitcroft { 3856000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3857000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 385813214adfSAndy Whitcroft } 385913214adfSAndy Whitcroft 38608905a67cSAndy Whitcroft# if and else should not have general statements after it 386113214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 386213214adfSAndy Whitcroft my $s = $1; 386313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 386413214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3865000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3866000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 38670a920b5bSAndy Whitcroft } 386813214adfSAndy Whitcroft } 386939667782SAndy Whitcroft# if should not continue a brace 387039667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3871000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3872048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 387339667782SAndy Whitcroft $herecurr); 387439667782SAndy Whitcroft } 3875a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3876a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3877a1080bf8SAndy Whitcroft $line !~ /\G(?: 38783fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3879a1080bf8SAndy Whitcroft \s*return\s+ 3880a1080bf8SAndy Whitcroft )/xg) 3881a1080bf8SAndy Whitcroft { 3882000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3883000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3884a1080bf8SAndy Whitcroft } 38850a920b5bSAndy Whitcroft 38860a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 38870a920b5bSAndy Whitcroft # indent level to be relevant to each other. 38888b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 38890a920b5bSAndy Whitcroft $previndent == $indent) { 38908b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 38918b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 38928b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 38938b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 38948b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 38958b8856f4SJoe Perches my $fixedline = $prevrawline; 38968b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 38978b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 38988b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 38998b8856f4SJoe Perches } 39008b8856f4SJoe Perches $fixedline = $rawline; 39018b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 39028b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39038b8856f4SJoe Perches } 39040a920b5bSAndy Whitcroft } 39050a920b5bSAndy Whitcroft 39068b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 3907c2fdda0dSAndy Whitcroft $previndent == $indent) { 3908c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3909c2fdda0dSAndy Whitcroft 3910c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3911c2fdda0dSAndy Whitcroft # conditional. 3912773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3913c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3914c2fdda0dSAndy Whitcroft 3915c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 39168b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 39178b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 39188b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 39198b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 39208b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 39218b8856f4SJoe Perches my $fixedline = $prevrawline; 39228b8856f4SJoe Perches my $trailing = $rawline; 39238b8856f4SJoe Perches $trailing =~ s/^\+//; 39248b8856f4SJoe Perches $trailing = trim($trailing); 39258b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 39268b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 39278b8856f4SJoe Perches } 3928c2fdda0dSAndy Whitcroft } 3929c2fdda0dSAndy Whitcroft } 3930c2fdda0dSAndy Whitcroft 393195e2c602SJoe Perches#Specific variable tests 3932323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3933323c1260SJoe Perches my $var = $1; 393495e2c602SJoe Perches 393595e2c602SJoe Perches#gcc binary extension 393695e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3937d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3938d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3939d5e616fcSJoe Perches $fix) { 3940d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3941194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3942d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3943d5e616fcSJoe Perches } 394495e2c602SJoe Perches } 394595e2c602SJoe Perches 394695e2c602SJoe Perches#CamelCase 3947807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3948be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 394922735ce8SJoe Perches#Ignore Page<foo> variants 3950807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 395122735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 39523445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 39537e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 39547e781f67SJoe Perches my $word = $1; 39557e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3956d8b07710SJoe Perches if ($check) { 3957d8b07710SJoe Perches seed_camelcase_includes(); 3958d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3959d8b07710SJoe Perches seed_camelcase_file($realfile); 3960d8b07710SJoe Perches $camelcase_file_seeded = 1; 3961d8b07710SJoe Perches } 3962d8b07710SJoe Perches } 39637e781f67SJoe Perches if (!defined $camelcase{$word}) { 39647e781f67SJoe Perches $camelcase{$word} = 1; 3965be79794bSJoe Perches CHK("CAMELCASE", 39667e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 39677e781f67SJoe Perches } 3968323c1260SJoe Perches } 3969323c1260SJoe Perches } 39703445686aSJoe Perches } 39710a920b5bSAndy Whitcroft 39720a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3973d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3974d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3975d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3976d5e616fcSJoe Perches $fix) { 3977194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 3978d5e616fcSJoe Perches } 39790a920b5bSAndy Whitcroft } 39800a920b5bSAndy Whitcroft 3981653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3982c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3983e09dec48SAndy Whitcroft my $file = "$1.h"; 3984e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3985e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3986e09dec48SAndy Whitcroft $realfile ne $checkfile && 39877840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3988c45dcabdSAndy Whitcroft { 3989e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3990000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3991000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3992e09dec48SAndy Whitcroft } else { 3993000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3994000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3995e09dec48SAndy Whitcroft } 39960a920b5bSAndy Whitcroft } 39970a920b5bSAndy Whitcroft } 39980a920b5bSAndy Whitcroft 3999653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4000653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4001cf655043SAndy Whitcroft# in a known good container 4002b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4003b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4004d8aaf121SAndy Whitcroft my $ln = $linenr; 4005d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4006c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4007c45dcabdSAndy Whitcroft my $ctx = ''; 4008c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4009f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4010f74bd194SAndy Whitcroft $ctx = $dstat; 4011c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4012a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4013c45dcabdSAndy Whitcroft 4014f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4015292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4016c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4017c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4018c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4019c45dcabdSAndy Whitcroft 4020c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4021bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4022bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4023c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4024bf30d6edSAndy Whitcroft { 4025c45dcabdSAndy Whitcroft } 4026c45dcabdSAndy Whitcroft 4027e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 4028e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 4029e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 4030e45bab8eSAndy Whitcroft { 4031e45bab8eSAndy Whitcroft } 4032e45bab8eSAndy Whitcroft 4033c45dcabdSAndy Whitcroft my $exceptions = qr{ 4034c45dcabdSAndy Whitcroft $Declare| 4035c45dcabdSAndy Whitcroft module_param_named| 4036a0a0a7a9SKees Cook MODULE_PARM_DESC| 4037c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4038c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4039383099fdSAndy Whitcroft __typeof__\(| 404022fd2d3eSStefani Seibold union| 404122fd2d3eSStefani Seibold struct| 4042ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4043ea71a0a0SAndy Whitcroft ^\"|\"$ 4044c45dcabdSAndy Whitcroft }x; 40455eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4046f74bd194SAndy Whitcroft if ($dstat ne '' && 4047f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4048f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 40493cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4050356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4051f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4052f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4053e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 405472f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4055f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4056f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4057f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4058f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4059f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4060c45dcabdSAndy Whitcroft { 4061f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4062f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4063f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4064f74bd194SAndy Whitcroft 4065f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4066f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4067c45dcabdSAndy Whitcroft } 4068c45dcabdSAndy Whitcroft 4069f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4070f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4071f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4072f74bd194SAndy Whitcroft } else { 4073000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4074f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 4075d8aaf121SAndy Whitcroft } 40760a920b5bSAndy Whitcroft } 40775023d347SJoe Perches 4078481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 40795023d347SJoe Perches 40805023d347SJoe Perches } else { 40815023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4082481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4083481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 40845023d347SJoe Perches $line =~ /^\+.*\\$/) { 40855023d347SJoe Perches WARN("LINE_CONTINUATIONS", 40865023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 40875023d347SJoe Perches } 4088653d4876SAndy Whitcroft } 40890a920b5bSAndy Whitcroft 4090b13edf7fSJoe Perches# do {} while (0) macro tests: 4091b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4092b13edf7fSJoe Perches# macro should not end with a semicolon 4093b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4094b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4095b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4096b13edf7fSJoe Perches my $ln = $linenr; 4097b13edf7fSJoe Perches my $cnt = $realcnt; 4098b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4099b13edf7fSJoe Perches my $ctx = ''; 4100b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4101b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4102b13edf7fSJoe Perches $ctx = $dstat; 4103b13edf7fSJoe Perches 4104b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 4105b13edf7fSJoe Perches 4106b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4107b13edf7fSJoe Perches my $stmts = $2; 4108b13edf7fSJoe Perches my $semis = $3; 4109b13edf7fSJoe Perches 4110b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4111b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4112b13edf7fSJoe Perches my $herectx = $here . "\n"; 4113b13edf7fSJoe Perches 4114b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4115b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4116b13edf7fSJoe Perches } 4117b13edf7fSJoe Perches 4118ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4119ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4120b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4121b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4122b13edf7fSJoe Perches } 4123b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4124b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4125b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4126b13edf7fSJoe Perches } 4127f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4128f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4129f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4130f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4131f5ef95b1SJoe Perches 4132f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4133f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4134f5ef95b1SJoe Perches } 4135f5ef95b1SJoe Perches 4136f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4137f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4138b13edf7fSJoe Perches } 4139b13edf7fSJoe Perches } 4140b13edf7fSJoe Perches 4141080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4142080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4143080ba929SMike Frysinger# . 4144080ba929SMike Frysinger# ALIGN(...) 4145080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4146080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4147000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4148000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4149080ba929SMike Frysinger } 4150080ba929SMike Frysinger 4151f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 415213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 415313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4154cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 415513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4156cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4157cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4158aad4f614SJoe Perches my @allowed = (); 4159aad4f614SJoe Perches my $allow = 0; 416013214adfSAndy Whitcroft my $seen = 0; 4161773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4162cf655043SAndy Whitcroft my $ln = $linenr - 1; 416313214adfSAndy Whitcroft for my $chunk (@chunks) { 416413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 416513214adfSAndy Whitcroft 4166773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4167773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4168773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4169773647a0SAndy Whitcroft 4170aad4f614SJoe Perches $allowed[$allow] = 0; 4171773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4172773647a0SAndy Whitcroft 4173773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4174773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4175773647a0SAndy Whitcroft 4176773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4177cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4178cf655043SAndy Whitcroft 4179773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 418013214adfSAndy Whitcroft 418113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 418213214adfSAndy Whitcroft 4183aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4184cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4185cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4186aad4f614SJoe Perches $allowed[$allow] = 1; 418713214adfSAndy Whitcroft } 418813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4189cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4190aad4f614SJoe Perches $allowed[$allow] = 1; 419113214adfSAndy Whitcroft } 4192cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4193cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4194aad4f614SJoe Perches $allowed[$allow] = 1; 419513214adfSAndy Whitcroft } 4196aad4f614SJoe Perches $allow++; 419713214adfSAndy Whitcroft } 4198aad4f614SJoe Perches if ($seen) { 4199aad4f614SJoe Perches my $sum_allowed = 0; 4200aad4f614SJoe Perches foreach (@allowed) { 4201aad4f614SJoe Perches $sum_allowed += $_; 4202aad4f614SJoe Perches } 4203aad4f614SJoe Perches if ($sum_allowed == 0) { 4204000d1cc1SJoe Perches WARN("BRACES", 4205000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4206aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4207aad4f614SJoe Perches $seen != $allow) { 4208aad4f614SJoe Perches CHK("BRACES", 4209aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4210aad4f614SJoe Perches } 421113214adfSAndy Whitcroft } 421213214adfSAndy Whitcroft } 421313214adfSAndy Whitcroft } 4214773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 421513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4216cf655043SAndy Whitcroft my $allowed = 0; 4217f0a594c1SAndy Whitcroft 4218cf655043SAndy Whitcroft # Check the pre-context. 4219cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4220cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4221cf655043SAndy Whitcroft $allowed = 1; 4222f0a594c1SAndy Whitcroft } 4223773647a0SAndy Whitcroft 4224773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4225773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4226773647a0SAndy Whitcroft 4227cf655043SAndy Whitcroft # Check the condition. 4228cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4229773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4230cf655043SAndy Whitcroft if (defined $cond) { 4231773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4232cf655043SAndy Whitcroft } 4233cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4234cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4235cf655043SAndy Whitcroft $allowed = 1; 4236cf655043SAndy Whitcroft } 4237cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4238cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4239cf655043SAndy Whitcroft $allowed = 1; 4240cf655043SAndy Whitcroft } 4241cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4242cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4243cf655043SAndy Whitcroft $allowed = 1; 4244cf655043SAndy Whitcroft } 4245cf655043SAndy Whitcroft # Check the post-context. 4246cf655043SAndy Whitcroft if (defined $chunks[1]) { 4247cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4248cf655043SAndy Whitcroft if (defined $cond) { 4249773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4250cf655043SAndy Whitcroft } 4251cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4252cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4253cf655043SAndy Whitcroft $allowed = 1; 4254cf655043SAndy Whitcroft } 4255cf655043SAndy Whitcroft } 4256cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 425769932487SJustin P. Mattock my $herectx = $here . "\n"; 4258f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4259cf655043SAndy Whitcroft 4260f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 426169932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4262cf655043SAndy Whitcroft } 4263cf655043SAndy Whitcroft 4264000d1cc1SJoe Perches WARN("BRACES", 4265000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4266f0a594c1SAndy Whitcroft } 4267f0a594c1SAndy Whitcroft } 4268f0a594c1SAndy Whitcroft 42690979ae66SJoe Perches# check for unnecessary blank lines around braces 427077b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 42710979ae66SJoe Perches CHK("BRACES", 42720979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 42730979ae66SJoe Perches } 427477b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 42750979ae66SJoe Perches CHK("BRACES", 42760979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 42770979ae66SJoe Perches } 42780979ae66SJoe Perches 42794a0df2efSAndy Whitcroft# no volatiles please 42806c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 42816c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4282000d1cc1SJoe Perches WARN("VOLATILE", 4283000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 42844a0df2efSAndy Whitcroft } 42854a0df2efSAndy Whitcroft 428600df344fSAndy Whitcroft# warn about #if 0 4287c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4288000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4289000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4290de7d4f0eSAndy Whitcroft $herecurr); 42914a0df2efSAndy Whitcroft } 42924a0df2efSAndy Whitcroft 429303df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 429403df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 429503df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 429603df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 429703df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 429803df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 42994c432a8fSGreg Kroah-Hartman } 43004c432a8fSGreg Kroah-Hartman } 4301f0a594c1SAndy Whitcroft 4302ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4303ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4304ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4305ebfdc409SJoe Perches (defined $1 || defined $3) && 4306ebfdc409SJoe Perches $linenr > 3) { 4307ebfdc409SJoe Perches my $testval = $2; 4308ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4309ebfdc409SJoe Perches 4310ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4311ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4312ebfdc409SJoe Perches 4313ebfdc409SJoe 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)/) { 4314ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4315ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4316ebfdc409SJoe Perches } 4317ebfdc409SJoe Perches } 4318ebfdc409SJoe Perches 43198716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 43208716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 43218716de38SJoe Perches my $attr = $1; 43228716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 43238716de38SJoe Perches my $ptr = $1; 43248716de38SJoe Perches my $var = $2; 43258716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 43268716de38SJoe Perches ERROR("MISPLACED_INIT", 43278716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 43288716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 43298716de38SJoe Perches WARN("MISPLACED_INIT", 43308716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 43318716de38SJoe Perches $fix) { 4332194f66fcSJoe Perches $fixed[$fixlinenr] =~ 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; 43338716de38SJoe Perches } 43348716de38SJoe Perches } 43358716de38SJoe Perches } 43368716de38SJoe Perches 4337e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4338e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4339e970b884SJoe Perches my $attr = $1; 4340e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4341e970b884SJoe Perches my $attr_prefix = $1; 4342e970b884SJoe Perches my $attr_type = $2; 4343e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4344e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4345e970b884SJoe Perches $fix) { 4346194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4347e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4348e970b884SJoe Perches } 4349e970b884SJoe Perches } 4350e970b884SJoe Perches 4351e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4352e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4353e970b884SJoe Perches my $attr = $1; 4354e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4355e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4356e970b884SJoe Perches $fix) { 4357194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4358e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4359e970b884SJoe Perches $lead = rtrim($1); 4360e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4361e970b884SJoe Perches $lead = "${lead}const "; 4362194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4363e970b884SJoe Perches } 4364e970b884SJoe Perches } 4365e970b884SJoe Perches 4366fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4367fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4368fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4369fbdb8138SJoe Perches my $constant_func = $1; 4370fbdb8138SJoe Perches my $func = $constant_func; 4371fbdb8138SJoe Perches $func =~ s/^__constant_//; 4372fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4373fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4374fbdb8138SJoe Perches $fix) { 4375194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4376fbdb8138SJoe Perches } 4377fbdb8138SJoe Perches } 4378fbdb8138SJoe Perches 43791a15a250SPatrick Pannuto# prefer usleep_range over udelay 438037581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 438143c1d77cSJoe Perches my $delay = $1; 43821a15a250SPatrick Pannuto # ignore udelay's < 10, however 438343c1d77cSJoe Perches if (! ($delay < 10) ) { 4384000d1cc1SJoe Perches CHK("USLEEP_RANGE", 438543c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 438643c1d77cSJoe Perches } 438743c1d77cSJoe Perches if ($delay > 2000) { 438843c1d77cSJoe Perches WARN("LONG_UDELAY", 438943c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 43901a15a250SPatrick Pannuto } 43911a15a250SPatrick Pannuto } 43921a15a250SPatrick Pannuto 439309ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 439409ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 439509ef8725SPatrick Pannuto if ($1 < 20) { 4396000d1cc1SJoe Perches WARN("MSLEEP", 439743c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 439809ef8725SPatrick Pannuto } 439909ef8725SPatrick Pannuto } 440009ef8725SPatrick Pannuto 440136ec1939SJoe Perches# check for comparisons of jiffies 440236ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 440336ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 440436ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 440536ec1939SJoe Perches } 440636ec1939SJoe Perches 44079d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 44089d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 44099d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 44109d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 44119d7a34a5SJoe Perches } 44129d7a34a5SJoe Perches 441300df344fSAndy Whitcroft# warn about #ifdefs in C files 4414c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 441500df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 441600df344fSAndy Whitcroft# print "$herecurr"; 441700df344fSAndy Whitcroft# $clean = 0; 441800df344fSAndy Whitcroft# } 441900df344fSAndy Whitcroft 442022f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4421c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 44223705ce5bSJoe Perches if (ERROR("SPACING", 44233705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 44243705ce5bSJoe Perches $fix) { 4425194f66fcSJoe Perches $fixed[$fixlinenr] =~ 44263705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 44273705ce5bSJoe Perches } 44283705ce5bSJoe Perches 442922f2a2efSAndy Whitcroft } 443022f2a2efSAndy Whitcroft 44314a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4432171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4433171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 44344a0df2efSAndy Whitcroft my $which = $1; 44354a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4436000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4437000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 44384a0df2efSAndy Whitcroft } 44394a0df2efSAndy Whitcroft } 44404a0df2efSAndy Whitcroft# check for memory barriers without a comment. 44414a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 44424a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4443c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4444000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 44454a0df2efSAndy Whitcroft } 44464a0df2efSAndy Whitcroft } 44474a0df2efSAndy Whitcroft# check of hardware specific defines 4448c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4449000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4450000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 44510a920b5bSAndy Whitcroft } 4452653d4876SAndy Whitcroft 4453d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4454d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4455000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4456000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4457d4977c78STobias Klauser } 4458d4977c78STobias Klauser 4459de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4460de7d4f0eSAndy Whitcroft# storage class and type. 44619c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 44629c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4463000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4464000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4465de7d4f0eSAndy Whitcroft } 4466de7d4f0eSAndy Whitcroft 44678905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 44682b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 44692b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4470d5e616fcSJoe Perches if (WARN("INLINE", 4471d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4472d5e616fcSJoe Perches $fix) { 4473194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 4474d5e616fcSJoe Perches 4475d5e616fcSJoe Perches } 44768905a67cSAndy Whitcroft } 44778905a67cSAndy Whitcroft 44783d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 44792b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 44802b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4481000d1cc1SJoe Perches WARN("PREFER_PACKED", 4482000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 44833d130fd0SJoe Perches } 44843d130fd0SJoe Perches 448539b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 44862b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 44872b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4488000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4489000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 449039b7e287SJoe Perches } 449139b7e287SJoe Perches 44925f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 44932b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 44942b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4495d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4496d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4497d5e616fcSJoe Perches $fix) { 4498194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4499d5e616fcSJoe Perches 4500d5e616fcSJoe Perches } 45015f14d3bdSJoe Perches } 45025f14d3bdSJoe Perches 45036061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 45042b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 45052b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4506d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4507d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4508d5e616fcSJoe Perches $fix) { 4509194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4510d5e616fcSJoe Perches } 45116061d949SJoe Perches } 45126061d949SJoe Perches 45138f53a9b8SJoe Perches# check for sizeof(&) 45148f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4515000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4516000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 45178f53a9b8SJoe Perches } 45188f53a9b8SJoe Perches 451966c80b60SJoe Perches# check for sizeof without parenthesis 452066c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4521d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4522d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4523d5e616fcSJoe Perches $fix) { 4524194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4525d5e616fcSJoe Perches } 452666c80b60SJoe Perches } 452766c80b60SJoe Perches 4528428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4529428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4530000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4531000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4532428e2fdcSJoe Perches } 4533428e2fdcSJoe Perches 453488982feaSJoe Perches# check for struct spinlock declarations 453588982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 453688982feaSJoe Perches WARN("USE_SPINLOCK_T", 453788982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 453888982feaSJoe Perches } 453988982feaSJoe Perches 4540a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 454106668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4542a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 454306668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4544d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4545d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4546d5e616fcSJoe Perches $fix) { 4547194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 4548d5e616fcSJoe Perches } 4549a6962d72SJoe Perches } 4550a6962d72SJoe Perches } 4551a6962d72SJoe Perches 4552554e165cSAndy Whitcroft# Check for misused memsets 4553d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4554d1fe9c09SJoe Perches defined $stat && 4555d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4556554e165cSAndy Whitcroft 4557d7c76ba7SJoe Perches my $ms_addr = $2; 4558d1fe9c09SJoe Perches my $ms_val = $7; 4559d1fe9c09SJoe Perches my $ms_size = $12; 4560d7c76ba7SJoe Perches 4561554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4562554e165cSAndy Whitcroft ERROR("MEMSET", 4563d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4564554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4565554e165cSAndy Whitcroft WARN("MEMSET", 4566d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4567d7c76ba7SJoe Perches } 4568d7c76ba7SJoe Perches } 4569d7c76ba7SJoe Perches 457098a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 457198a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 457298a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 457398a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 457498a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 457598a9bba5SJoe Perches $fix) { 4576194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 457798a9bba5SJoe Perches } 457898a9bba5SJoe Perches } 457998a9bba5SJoe Perches 4580d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4581d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4582d1fe9c09SJoe Perches defined $stat && 4583d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4584d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4585d7c76ba7SJoe Perches my $call = $1; 4586d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4587d7c76ba7SJoe Perches my $arg1 = $3; 4588d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4589d1fe9c09SJoe Perches my $arg2 = $8; 4590d7c76ba7SJoe Perches my $cast; 4591d7c76ba7SJoe Perches 4592d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4593d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4594d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4595d7c76ba7SJoe Perches $cast = $cast1; 4596d7c76ba7SJoe Perches } else { 4597d7c76ba7SJoe Perches $cast = $cast2; 4598d7c76ba7SJoe Perches } 4599d7c76ba7SJoe Perches WARN("MINMAX", 4600d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4601554e165cSAndy Whitcroft } 4602554e165cSAndy Whitcroft } 4603554e165cSAndy Whitcroft 46044a273195SJoe Perches# check usleep_range arguments 46054a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 46064a273195SJoe Perches defined $stat && 46074a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 46084a273195SJoe Perches my $min = $1; 46094a273195SJoe Perches my $max = $7; 46104a273195SJoe Perches if ($min eq $max) { 46114a273195SJoe Perches WARN("USLEEP_RANGE", 46124a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 46134a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 46144a273195SJoe Perches $min > $max) { 46154a273195SJoe Perches WARN("USLEEP_RANGE", 46164a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 46174a273195SJoe Perches } 46184a273195SJoe Perches } 46194a273195SJoe Perches 4620823b794cSJoe Perches# check for naked sscanf 4621823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4622823b794cSJoe Perches defined $stat && 46236c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4624823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4625823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4626823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4627823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4628823b794cSJoe Perches $lc = $lc + $linenr; 4629823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4630823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4631823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4632823b794cSJoe Perches } 4633823b794cSJoe Perches WARN("NAKED_SSCANF", 4634823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4635823b794cSJoe Perches } 4636823b794cSJoe Perches 4637afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 4638afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 4639afc819abSJoe Perches defined $stat && 4640afc819abSJoe Perches $line =~ /\bsscanf\b/) { 4641afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 4642afc819abSJoe Perches $lc = $lc + $linenr; 4643afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 4644afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4645afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4646afc819abSJoe Perches } 4647afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 4648afc819abSJoe Perches my $format = $6; 4649afc819abSJoe Perches my $count = $format =~ tr@%@%@; 4650afc819abSJoe Perches if ($count == 1 && 4651afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 4652afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 4653afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 4654afc819abSJoe Perches } 4655afc819abSJoe Perches } 4656afc819abSJoe Perches } 4657afc819abSJoe Perches 465870dc8a48SJoe Perches# check for new externs in .h files. 465970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 466070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4661d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 466270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 466370dc8a48SJoe Perches $fix) { 4664194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 466570dc8a48SJoe Perches } 466670dc8a48SJoe Perches } 466770dc8a48SJoe Perches 4668de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4669171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4670c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4671171ae1a4SAndy Whitcroft { 4672c45dcabdSAndy Whitcroft my $function_name = $1; 4673c45dcabdSAndy Whitcroft my $paren_space = $2; 4674171ae1a4SAndy Whitcroft 4675171ae1a4SAndy Whitcroft my $s = $stat; 4676171ae1a4SAndy Whitcroft if (defined $cond) { 4677171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4678171ae1a4SAndy Whitcroft } 4679c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4680c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4681c45dcabdSAndy Whitcroft { 4682000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4683000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4684de7d4f0eSAndy Whitcroft } 4685de7d4f0eSAndy Whitcroft 4686171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4687000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4688000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4689171ae1a4SAndy Whitcroft } 46909c9ba34eSAndy Whitcroft 46919c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 46929c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 46939c9ba34eSAndy Whitcroft { 4694000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4695000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4696171ae1a4SAndy Whitcroft } 4697171ae1a4SAndy Whitcroft 4698de7d4f0eSAndy Whitcroft# checks for new __setup's 4699de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4700de7d4f0eSAndy Whitcroft my $name = $1; 4701de7d4f0eSAndy Whitcroft 4702de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4703000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4704000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4705de7d4f0eSAndy Whitcroft } 4706653d4876SAndy Whitcroft } 47079c0ca6f9SAndy Whitcroft 47089c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4709caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4710000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4711000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 47129c0ca6f9SAndy Whitcroft } 471313214adfSAndy Whitcroft 4714a640d25cSJoe Perches# alloc style 4715a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4716a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4717a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4718a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4719a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4720a640d25cSJoe Perches } 4721a640d25cSJoe Perches 472260a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 472360a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 4724e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 472560a55369SJoe Perches my $oldfunc = $3; 472660a55369SJoe Perches my $a1 = $4; 472760a55369SJoe Perches my $a2 = $10; 472860a55369SJoe Perches my $newfunc = "kmalloc_array"; 472960a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 473060a55369SJoe Perches my $r1 = $a1; 473160a55369SJoe Perches my $r2 = $a2; 473260a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 473360a55369SJoe Perches $r1 = $a2; 473460a55369SJoe Perches $r2 = $a1; 473560a55369SJoe Perches } 4736e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 4737e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 4738e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 4739e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 4740e367455aSJoe Perches $fix) { 4741194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 474260a55369SJoe Perches 474360a55369SJoe Perches } 474460a55369SJoe Perches } 474560a55369SJoe Perches } 474660a55369SJoe Perches 4747972fdea2SJoe Perches# check for krealloc arg reuse 4748972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4749972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4750972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4751972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4752972fdea2SJoe Perches } 4753972fdea2SJoe Perches 47545ce59ae0SJoe Perches# check for alloc argument mismatch 47555ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 47565ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 47575ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 47585ce59ae0SJoe Perches } 47595ce59ae0SJoe Perches 4760caf2a54fSJoe Perches# check for multiple semicolons 4761caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4762d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4763d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4764d5e616fcSJoe Perches $fix) { 4765194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 4766d5e616fcSJoe Perches } 4767d1e2ad07SJoe Perches } 4768d1e2ad07SJoe Perches 4769c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4770c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4771c34c09a8SJoe Perches my $has_break = 0; 4772c34c09a8SJoe Perches my $has_statement = 0; 4773c34c09a8SJoe Perches my $count = 0; 4774c34c09a8SJoe Perches my $prevline = $linenr; 4775c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4776c34c09a8SJoe Perches $prevline--; 4777c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4778c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4779c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4780c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4781c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4782c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4783c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4784c34c09a8SJoe Perches $has_statement = 1; 4785c34c09a8SJoe Perches $count++; 4786c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4787c34c09a8SJoe Perches } 4788c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4789c34c09a8SJoe Perches WARN("MISSING_BREAK", 4790c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4791c34c09a8SJoe Perches } 4792c34c09a8SJoe Perches } 4793c34c09a8SJoe Perches 4794d1e2ad07SJoe Perches# check for switch/default statements without a break; 4795d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4796d1e2ad07SJoe Perches defined $stat && 4797d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4798d1e2ad07SJoe Perches my $ctx = ''; 4799d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4800d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4801d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4802d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4803d1e2ad07SJoe Perches } 4804d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4805d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4806caf2a54fSJoe Perches } 4807caf2a54fSJoe Perches 480813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4809d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4810d5e616fcSJoe Perches if (WARN("USE_FUNC", 4811d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4812d5e616fcSJoe Perches $fix) { 4813194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 4814d5e616fcSJoe Perches } 481513214adfSAndy Whitcroft } 4816773647a0SAndy Whitcroft 48172c92488aSJoe Perches# check for use of yield() 48182c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 48192c92488aSJoe Perches WARN("YIELD", 48202c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 48212c92488aSJoe Perches } 48222c92488aSJoe Perches 4823179f8f40SJoe Perches# check for comparisons against true and false 4824179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4825179f8f40SJoe Perches my $lead = $1; 4826179f8f40SJoe Perches my $arg = $2; 4827179f8f40SJoe Perches my $test = $3; 4828179f8f40SJoe Perches my $otype = $4; 4829179f8f40SJoe Perches my $trail = $5; 4830179f8f40SJoe Perches my $op = "!"; 4831179f8f40SJoe Perches 4832179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4833179f8f40SJoe Perches 4834179f8f40SJoe Perches my $type = lc($otype); 4835179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4836179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4837179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4838179f8f40SJoe Perches $op = ""; 4839179f8f40SJoe Perches } 4840179f8f40SJoe Perches 4841179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4842179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4843179f8f40SJoe Perches 4844179f8f40SJoe Perches## maybe suggesting a correct construct would better 4845179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4846179f8f40SJoe Perches 4847179f8f40SJoe Perches } 4848179f8f40SJoe Perches } 4849179f8f40SJoe Perches 48504882720bSThomas Gleixner# check for semaphores initialized locked 48514882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4852000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4853000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4854773647a0SAndy Whitcroft } 48556712d858SJoe Perches 485667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 485767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4858000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 485967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4860773647a0SAndy Whitcroft } 48616712d858SJoe Perches 4862ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 4863f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4864000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4865ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 4866f3db6639SMichael Ellerman } 48676712d858SJoe Perches 486879404849SEmese Revfy# check for various ops structs, ensure they are const. 486979404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 487079404849SEmese Revfy address_space_operations| 487179404849SEmese Revfy backlight_ops| 487279404849SEmese Revfy block_device_operations| 487379404849SEmese Revfy dentry_operations| 487479404849SEmese Revfy dev_pm_ops| 487579404849SEmese Revfy dma_map_ops| 487679404849SEmese Revfy extent_io_ops| 487779404849SEmese Revfy file_lock_operations| 487879404849SEmese Revfy file_operations| 487979404849SEmese Revfy hv_ops| 488079404849SEmese Revfy ide_dma_ops| 488179404849SEmese Revfy intel_dvo_dev_ops| 488279404849SEmese Revfy item_operations| 488379404849SEmese Revfy iwl_ops| 488479404849SEmese Revfy kgdb_arch| 488579404849SEmese Revfy kgdb_io| 488679404849SEmese Revfy kset_uevent_ops| 488779404849SEmese Revfy lock_manager_operations| 488879404849SEmese Revfy microcode_ops| 488979404849SEmese Revfy mtrr_ops| 489079404849SEmese Revfy neigh_ops| 489179404849SEmese Revfy nlmsvc_binding| 489279404849SEmese Revfy pci_raw_ops| 489379404849SEmese Revfy pipe_buf_operations| 489479404849SEmese Revfy platform_hibernation_ops| 489579404849SEmese Revfy platform_suspend_ops| 489679404849SEmese Revfy proto_ops| 489779404849SEmese Revfy rpc_pipe_ops| 489879404849SEmese Revfy seq_operations| 489979404849SEmese Revfy snd_ac97_build_ops| 490079404849SEmese Revfy soc_pcmcia_socket_ops| 490179404849SEmese Revfy stacktrace_ops| 490279404849SEmese Revfy sysfs_ops| 490379404849SEmese Revfy tty_operations| 490479404849SEmese Revfy usb_mon_operations| 490579404849SEmese Revfy wd_ops}x; 49066903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 490779404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4908000d1cc1SJoe Perches WARN("CONST_STRUCT", 4909000d1cc1SJoe Perches "struct $1 should normally be const\n" . 49106903ffb2SAndy Whitcroft $herecurr); 49112b6db5cbSAndy Whitcroft } 4912773647a0SAndy Whitcroft 4913773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4914773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4915773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4916c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4917c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4918171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4919171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4920171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4921773647a0SAndy Whitcroft { 4922000d1cc1SJoe Perches WARN("NR_CPUS", 4923000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4924773647a0SAndy Whitcroft } 49259c9ba34eSAndy Whitcroft 492652ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 492752ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 492852ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 492952ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 493052ea8506SJoe Perches } 493152ea8506SJoe Perches 49329c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 49339c9ba34eSAndy Whitcroft my $string; 49349c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 49359c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 49362a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 49379c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4938000d1cc1SJoe Perches WARN("PRINTF_L", 4939000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 49409c9ba34eSAndy Whitcroft last; 49419c9ba34eSAndy Whitcroft } 49429c9ba34eSAndy Whitcroft } 4943691d77b6SAndy Whitcroft 4944691d77b6SAndy Whitcroft# whine mightly about in_atomic 4945691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4946691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4947000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4948000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4949f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4950000d1cc1SJoe Perches WARN("IN_ATOMIC", 4951000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4952691d77b6SAndy Whitcroft } 4953691d77b6SAndy Whitcroft } 49541704f47bSPeter Zijlstra 49551704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 49561704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 49571704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 49581704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 49591704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 49601704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4961000d1cc1SJoe Perches ERROR("LOCKDEP", 4962000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 49631704f47bSPeter Zijlstra } 49641704f47bSPeter Zijlstra } 496588f8831cSDave Jones 496688f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 496788f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4968000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4969000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 497088f8831cSDave Jones } 49712435880fSJoe Perches 4972515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 4973515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 4974515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 4975515a235eSJoe Perches $line =~ /$mode_perms_search/) { 49762435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 49772435880fSJoe Perches my $func = $entry->[0]; 49782435880fSJoe Perches my $arg_pos = $entry->[1]; 49792435880fSJoe Perches 49802435880fSJoe Perches my $skip_args = ""; 49812435880fSJoe Perches if ($arg_pos > 1) { 49822435880fSJoe Perches $arg_pos--; 49832435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 49842435880fSJoe Perches } 49852435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 4986515a235eSJoe Perches if ($line =~ /$test/) { 49872435880fSJoe Perches my $val = $1; 49882435880fSJoe Perches $val = $6 if ($skip_args ne ""); 49892435880fSJoe Perches 49901727cc70SJoe Perches if ($val !~ /^0$/ && 49911727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 49921727cc70SJoe Perches length($val) ne 4)) { 49932435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 49941727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 49952435880fSJoe Perches } 49962435880fSJoe Perches } 49972435880fSJoe Perches } 499813214adfSAndy Whitcroft } 4999515a235eSJoe Perches } 500013214adfSAndy Whitcroft 500113214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 500213214adfSAndy Whitcroft # so just keep quiet. 500313214adfSAndy Whitcroft if ($#rawlines == -1) { 500413214adfSAndy Whitcroft exit(0); 50050a920b5bSAndy Whitcroft } 50060a920b5bSAndy Whitcroft 50078905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 50088905a67cSAndy Whitcroft # things that appear to be patches. 50098905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 50108905a67cSAndy Whitcroft exit(0); 50118905a67cSAndy Whitcroft } 50128905a67cSAndy Whitcroft 50138905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 50148905a67cSAndy Whitcroft # just keep quiet. 50158905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 50168905a67cSAndy Whitcroft exit(0); 50178905a67cSAndy Whitcroft } 50188905a67cSAndy Whitcroft 50198905a67cSAndy Whitcroft if (!$is_patch) { 5020000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5021000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 50220a920b5bSAndy Whitcroft } 50230a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 5024000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5025000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 50260a920b5bSAndy Whitcroft } 50270a920b5bSAndy Whitcroft 5028f0a594c1SAndy Whitcroft print report_dump(); 502913214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 503013214adfSAndy Whitcroft print "$filename " if ($summary_file); 50316c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 50326c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 50336c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 50348905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 50356c72ffaaSAndy Whitcroft } 50368905a67cSAndy Whitcroft 5037d2c0a235SAndy Whitcroft if ($quiet == 0) { 5038d1fe9c09SJoe Perches 5039d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 5040d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 5041d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 5042d1fe9c09SJoe Perches } 5043d1fe9c09SJoe Perches 5044d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5045d2c0a235SAndy Whitcroft # then suggest that. 5046d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5047d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 5048d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 5049b0781216SMike Frysinger $rpt_cleaners = 0; 5050d2c0a235SAndy Whitcroft } 5051d2c0a235SAndy Whitcroft } 5052d2c0a235SAndy Whitcroft 505391bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 505491bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5055000d1cc1SJoe Perches 5056d752fcc8SJoe Perches if ($clean == 0 && $fix && 5057d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5058d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 50599624b8d6SJoe Perches my $newfile = $filename; 50609624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 50613705ce5bSJoe Perches my $linecount = 0; 50623705ce5bSJoe Perches my $f; 50633705ce5bSJoe Perches 5064d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5065d752fcc8SJoe Perches 50663705ce5bSJoe Perches open($f, '>', $newfile) 50673705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 50683705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 50693705ce5bSJoe Perches $linecount++; 50703705ce5bSJoe Perches if ($file) { 50713705ce5bSJoe Perches if ($linecount > 3) { 50723705ce5bSJoe Perches $fixed_line =~ s/^\+//; 50733705ce5bSJoe Perches print $f $fixed_line . "\n"; 50743705ce5bSJoe Perches } 50753705ce5bSJoe Perches } else { 50763705ce5bSJoe Perches print $f $fixed_line . "\n"; 50773705ce5bSJoe Perches } 50783705ce5bSJoe Perches } 50793705ce5bSJoe Perches close($f); 50803705ce5bSJoe Perches 50813705ce5bSJoe Perches if (!$quiet) { 50823705ce5bSJoe Perches print << "EOM"; 50833705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 50843705ce5bSJoe Perches 50853705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 50863705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 50873705ce5bSJoe Perches 50883705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 50893705ce5bSJoe PerchesNo warranties, expressed or implied... 50903705ce5bSJoe Perches 50913705ce5bSJoe PerchesEOM 50923705ce5bSJoe Perches } 50933705ce5bSJoe Perches } 50943705ce5bSJoe Perches 50950a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 5096c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 50970a920b5bSAndy Whitcroft } 50980a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 5099000d1cc1SJoe Perches print << "EOM"; 5100000d1cc1SJoe Perches$vname has style problems, please review. 5101000d1cc1SJoe Perches 5102000d1cc1SJoe PerchesIf any of these errors are false positives, please report 5103000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 5104000d1cc1SJoe PerchesEOM 51050a920b5bSAndy Whitcroft } 510613214adfSAndy Whitcroft 51070a920b5bSAndy Whitcroft return $clean; 51080a920b5bSAndy Whitcroft} 5109