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 = (); 586*194f66fcSJoe Perchesmy $fixlinenr = -1; 587*194f66fcSJoe Perches 588c2fdda0dSAndy Whitcroftmy $vname; 5896c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 59021caa13cSAndy Whitcroft my $FILE; 5916c72ffaaSAndy Whitcroft if ($file) { 59221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5936c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 59421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 59521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5966c72ffaaSAndy Whitcroft } else { 59721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5986c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5996c72ffaaSAndy Whitcroft } 600c2fdda0dSAndy Whitcroft if ($filename eq '-') { 601c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 602c2fdda0dSAndy Whitcroft } else { 603c2fdda0dSAndy Whitcroft $vname = $filename; 604c2fdda0dSAndy Whitcroft } 60521caa13cSAndy Whitcroft while (<$FILE>) { 6060a920b5bSAndy Whitcroft chomp; 60700df344fSAndy Whitcroft push(@rawlines, $_); 6086c72ffaaSAndy Whitcroft } 60921caa13cSAndy Whitcroft close($FILE); 610c2fdda0dSAndy Whitcroft if (!process($filename)) { 6110a920b5bSAndy Whitcroft $exit = 1; 6120a920b5bSAndy Whitcroft } 61300df344fSAndy Whitcroft @rawlines = (); 61413214adfSAndy Whitcroft @lines = (); 6153705ce5bSJoe Perches @fixed = (); 616*194f66fcSJoe Perches $fixlinenr = -1; 6170a920b5bSAndy Whitcroft} 6180a920b5bSAndy Whitcroft 6190a920b5bSAndy Whitcroftexit($exit); 6200a920b5bSAndy Whitcroft 6210a920b5bSAndy Whitcroftsub top_of_kernel_tree { 6226c72ffaaSAndy Whitcroft my ($root) = @_; 6236c72ffaaSAndy Whitcroft 6246c72ffaaSAndy Whitcroft my @tree_check = ( 6256c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 6266c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 6276c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 6286c72ffaaSAndy Whitcroft ); 6296c72ffaaSAndy Whitcroft 6306c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 6316c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 6320a920b5bSAndy Whitcroft return 0; 6330a920b5bSAndy Whitcroft } 6346c72ffaaSAndy Whitcroft } 6356c72ffaaSAndy Whitcroft return 1; 6366c72ffaaSAndy Whitcroft} 6370a920b5bSAndy Whitcroft 63820112475SJoe Perchessub parse_email { 63920112475SJoe Perches my ($formatted_email) = @_; 64020112475SJoe Perches 64120112475SJoe Perches my $name = ""; 64220112475SJoe Perches my $address = ""; 64320112475SJoe Perches my $comment = ""; 64420112475SJoe Perches 64520112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 64620112475SJoe Perches $name = $1; 64720112475SJoe Perches $address = $2; 64820112475SJoe Perches $comment = $3 if defined $3; 64920112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 65020112475SJoe Perches $address = $1; 65120112475SJoe Perches $comment = $2 if defined $2; 65220112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 65320112475SJoe Perches $address = $1; 65420112475SJoe Perches $comment = $2 if defined $2; 65520112475SJoe Perches $formatted_email =~ s/$address.*$//; 65620112475SJoe Perches $name = $formatted_email; 6573705ce5bSJoe Perches $name = trim($name); 65820112475SJoe Perches $name =~ s/^\"|\"$//g; 65920112475SJoe Perches # If there's a name left after stripping spaces and 66020112475SJoe Perches # leading quotes, and the address doesn't have both 66120112475SJoe Perches # leading and trailing angle brackets, the address 66220112475SJoe Perches # is invalid. ie: 66320112475SJoe Perches # "joe smith [email protected]" bad 66420112475SJoe Perches # "joe smith <[email protected]" bad 66520112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 66620112475SJoe Perches $name = ""; 66720112475SJoe Perches $address = ""; 66820112475SJoe Perches $comment = ""; 66920112475SJoe Perches } 67020112475SJoe Perches } 67120112475SJoe Perches 6723705ce5bSJoe Perches $name = trim($name); 67320112475SJoe Perches $name =~ s/^\"|\"$//g; 6743705ce5bSJoe Perches $address = trim($address); 67520112475SJoe Perches $address =~ s/^\<|\>$//g; 67620112475SJoe Perches 67720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 67820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 67920112475SJoe Perches $name = "\"$name\""; 68020112475SJoe Perches } 68120112475SJoe Perches 68220112475SJoe Perches return ($name, $address, $comment); 68320112475SJoe Perches} 68420112475SJoe Perches 68520112475SJoe Perchessub format_email { 68620112475SJoe Perches my ($name, $address) = @_; 68720112475SJoe Perches 68820112475SJoe Perches my $formatted_email; 68920112475SJoe Perches 6903705ce5bSJoe Perches $name = trim($name); 69120112475SJoe Perches $name =~ s/^\"|\"$//g; 6923705ce5bSJoe Perches $address = trim($address); 69320112475SJoe Perches 69420112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 69520112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 69620112475SJoe Perches $name = "\"$name\""; 69720112475SJoe Perches } 69820112475SJoe Perches 69920112475SJoe Perches if ("$name" eq "") { 70020112475SJoe Perches $formatted_email = "$address"; 70120112475SJoe Perches } else { 70220112475SJoe Perches $formatted_email = "$name <$address>"; 70320112475SJoe Perches } 70420112475SJoe Perches 70520112475SJoe Perches return $formatted_email; 70620112475SJoe Perches} 70720112475SJoe Perches 708d311cd44SJoe Perchessub which { 709d311cd44SJoe Perches my ($bin) = @_; 710d311cd44SJoe Perches 711d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 712d311cd44SJoe Perches if (-e "$path/$bin") { 713d311cd44SJoe Perches return "$path/$bin"; 714d311cd44SJoe Perches } 715d311cd44SJoe Perches } 716d311cd44SJoe Perches 717d311cd44SJoe Perches return ""; 718d311cd44SJoe Perches} 719d311cd44SJoe Perches 720000d1cc1SJoe Perchessub which_conf { 721000d1cc1SJoe Perches my ($conf) = @_; 722000d1cc1SJoe Perches 723000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 724000d1cc1SJoe Perches if (-e "$path/$conf") { 725000d1cc1SJoe Perches return "$path/$conf"; 726000d1cc1SJoe Perches } 727000d1cc1SJoe Perches } 728000d1cc1SJoe Perches 729000d1cc1SJoe Perches return ""; 730000d1cc1SJoe Perches} 731000d1cc1SJoe Perches 7320a920b5bSAndy Whitcroftsub expand_tabs { 7330a920b5bSAndy Whitcroft my ($str) = @_; 7340a920b5bSAndy Whitcroft 7350a920b5bSAndy Whitcroft my $res = ''; 7360a920b5bSAndy Whitcroft my $n = 0; 7370a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 7380a920b5bSAndy Whitcroft if ($c eq "\t") { 7390a920b5bSAndy Whitcroft $res .= ' '; 7400a920b5bSAndy Whitcroft $n++; 7410a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 7420a920b5bSAndy Whitcroft $res .= ' '; 7430a920b5bSAndy Whitcroft } 7440a920b5bSAndy Whitcroft next; 7450a920b5bSAndy Whitcroft } 7460a920b5bSAndy Whitcroft $res .= $c; 7470a920b5bSAndy Whitcroft $n++; 7480a920b5bSAndy Whitcroft } 7490a920b5bSAndy Whitcroft 7500a920b5bSAndy Whitcroft return $res; 7510a920b5bSAndy Whitcroft} 7526c72ffaaSAndy Whitcroftsub copy_spacing { 753773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 7546c72ffaaSAndy Whitcroft return $res; 7556c72ffaaSAndy Whitcroft} 7560a920b5bSAndy Whitcroft 7574a0df2efSAndy Whitcroftsub line_stats { 7584a0df2efSAndy Whitcroft my ($line) = @_; 7594a0df2efSAndy Whitcroft 7604a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 7614a0df2efSAndy Whitcroft $line =~ s/^.//; 7624a0df2efSAndy Whitcroft $line = expand_tabs($line); 7634a0df2efSAndy Whitcroft 7644a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 7654a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 7664a0df2efSAndy Whitcroft 7674a0df2efSAndy Whitcroft return (length($line), length($white)); 7684a0df2efSAndy Whitcroft} 7694a0df2efSAndy Whitcroft 770773647a0SAndy Whitcroftmy $sanitise_quote = ''; 771773647a0SAndy Whitcroft 772773647a0SAndy Whitcroftsub sanitise_line_reset { 773773647a0SAndy Whitcroft my ($in_comment) = @_; 774773647a0SAndy Whitcroft 775773647a0SAndy Whitcroft if ($in_comment) { 776773647a0SAndy Whitcroft $sanitise_quote = '*/'; 777773647a0SAndy Whitcroft } else { 778773647a0SAndy Whitcroft $sanitise_quote = ''; 779773647a0SAndy Whitcroft } 780773647a0SAndy Whitcroft} 78100df344fSAndy Whitcroftsub sanitise_line { 78200df344fSAndy Whitcroft my ($line) = @_; 78300df344fSAndy Whitcroft 78400df344fSAndy Whitcroft my $res = ''; 78500df344fSAndy Whitcroft my $l = ''; 78600df344fSAndy Whitcroft 787c2fdda0dSAndy Whitcroft my $qlen = 0; 788773647a0SAndy Whitcroft my $off = 0; 789773647a0SAndy Whitcroft my $c; 79000df344fSAndy Whitcroft 791773647a0SAndy Whitcroft # Always copy over the diff marker. 792773647a0SAndy Whitcroft $res = substr($line, 0, 1); 793773647a0SAndy Whitcroft 794773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 795773647a0SAndy Whitcroft $c = substr($line, $off, 1); 796773647a0SAndy Whitcroft 797773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 798773647a0SAndy Whitcroft # and end, all to $;. 799773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 800773647a0SAndy Whitcroft $sanitise_quote = '*/'; 801773647a0SAndy Whitcroft 802773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 803773647a0SAndy Whitcroft $off++; 80400df344fSAndy Whitcroft next; 805773647a0SAndy Whitcroft } 80681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 807773647a0SAndy Whitcroft $sanitise_quote = ''; 808773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 809773647a0SAndy Whitcroft $off++; 810773647a0SAndy Whitcroft next; 811773647a0SAndy Whitcroft } 812113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 813113f04a8SDaniel Walker $sanitise_quote = '//'; 814113f04a8SDaniel Walker 815113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 816113f04a8SDaniel Walker $off++; 817113f04a8SDaniel Walker next; 818113f04a8SDaniel Walker } 819773647a0SAndy Whitcroft 820773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 821773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 822773647a0SAndy Whitcroft $c eq "\\") { 823773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 824773647a0SAndy Whitcroft $off++; 825773647a0SAndy Whitcroft next; 826773647a0SAndy Whitcroft } 827773647a0SAndy Whitcroft # Regular quotes. 828773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 829773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 830773647a0SAndy Whitcroft $sanitise_quote = $c; 831773647a0SAndy Whitcroft 832773647a0SAndy Whitcroft substr($res, $off, 1, $c); 833773647a0SAndy Whitcroft next; 834773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 835773647a0SAndy Whitcroft $sanitise_quote = ''; 83600df344fSAndy Whitcroft } 83700df344fSAndy Whitcroft } 838773647a0SAndy Whitcroft 839fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 840773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 841773647a0SAndy Whitcroft substr($res, $off, 1, $;); 842113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 843113f04a8SDaniel Walker substr($res, $off, 1, $;); 844773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 845773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 84600df344fSAndy Whitcroft } else { 847773647a0SAndy Whitcroft substr($res, $off, 1, $c); 84800df344fSAndy Whitcroft } 849c2fdda0dSAndy Whitcroft } 850c2fdda0dSAndy Whitcroft 851113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 852113f04a8SDaniel Walker $sanitise_quote = ''; 853113f04a8SDaniel Walker } 854113f04a8SDaniel Walker 855c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 856c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 857c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 858c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 859c2fdda0dSAndy Whitcroft 860c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 861c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 862c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 863c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 864c2fdda0dSAndy Whitcroft } 865c2fdda0dSAndy Whitcroft 86600df344fSAndy Whitcroft return $res; 86700df344fSAndy Whitcroft} 86800df344fSAndy Whitcroft 869a6962d72SJoe Perchessub get_quoted_string { 870a6962d72SJoe Perches my ($line, $rawline) = @_; 871a6962d72SJoe Perches 872a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 873a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 874a6962d72SJoe Perches} 875a6962d72SJoe Perches 8768905a67cSAndy Whitcroftsub ctx_statement_block { 8778905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8788905a67cSAndy Whitcroft my $line = $linenr - 1; 8798905a67cSAndy Whitcroft my $blk = ''; 8808905a67cSAndy Whitcroft my $soff = $off; 8818905a67cSAndy Whitcroft my $coff = $off - 1; 882773647a0SAndy Whitcroft my $coff_set = 0; 8838905a67cSAndy Whitcroft 88413214adfSAndy Whitcroft my $loff = 0; 88513214adfSAndy Whitcroft 8868905a67cSAndy Whitcroft my $type = ''; 8878905a67cSAndy Whitcroft my $level = 0; 888a2750645SAndy Whitcroft my @stack = (); 889cf655043SAndy Whitcroft my $p; 8908905a67cSAndy Whitcroft my $c; 8918905a67cSAndy Whitcroft my $len = 0; 89213214adfSAndy Whitcroft 89313214adfSAndy Whitcroft my $remainder; 8948905a67cSAndy Whitcroft while (1) { 895a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 896a2750645SAndy Whitcroft 897773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8988905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8998905a67cSAndy Whitcroft # context. 9008905a67cSAndy Whitcroft if ($off >= $len) { 9018905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 902dea33496SAndy Whitcroft last if (!defined $lines[$line]); 903c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 9048905a67cSAndy Whitcroft $remain--; 90513214adfSAndy Whitcroft $loff = $len; 906c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 9078905a67cSAndy Whitcroft $len = length($blk); 9088905a67cSAndy Whitcroft $line++; 9098905a67cSAndy Whitcroft last; 9108905a67cSAndy Whitcroft } 9118905a67cSAndy Whitcroft # Bail if there is no further context. 9128905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 91313214adfSAndy Whitcroft if ($off >= $len) { 9148905a67cSAndy Whitcroft last; 9158905a67cSAndy Whitcroft } 916f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 917f74bd194SAndy Whitcroft $level++; 918f74bd194SAndy Whitcroft $type = '#'; 919f74bd194SAndy Whitcroft } 9208905a67cSAndy Whitcroft } 921cf655043SAndy Whitcroft $p = $c; 9228905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 92313214adfSAndy Whitcroft $remainder = substr($blk, $off); 9248905a67cSAndy Whitcroft 925773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 9264635f4fbSAndy Whitcroft 9274635f4fbSAndy Whitcroft # Handle nested #if/#else. 9284635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 9294635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 9304635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 9314635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 9324635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 9334635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 9344635f4fbSAndy Whitcroft } 9354635f4fbSAndy Whitcroft 9368905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 9378905a67cSAndy Whitcroft # outermost level. 9388905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 9398905a67cSAndy Whitcroft last; 9408905a67cSAndy Whitcroft } 9418905a67cSAndy Whitcroft 94213214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 943773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 944773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 945773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 946773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 947773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 948773647a0SAndy Whitcroft $coff_set = 1; 949773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 950773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 95113214adfSAndy Whitcroft } 95213214adfSAndy Whitcroft 9538905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 9548905a67cSAndy Whitcroft $level++; 9558905a67cSAndy Whitcroft $type = '('; 9568905a67cSAndy Whitcroft } 9578905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 9588905a67cSAndy Whitcroft $level--; 9598905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 9608905a67cSAndy Whitcroft 9618905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 9628905a67cSAndy Whitcroft $coff = $off; 963773647a0SAndy Whitcroft $coff_set = 1; 964773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 9658905a67cSAndy Whitcroft } 9668905a67cSAndy Whitcroft } 9678905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 9688905a67cSAndy Whitcroft $level++; 9698905a67cSAndy Whitcroft $type = '{'; 9708905a67cSAndy Whitcroft } 9718905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 9728905a67cSAndy Whitcroft $level--; 9738905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9748905a67cSAndy Whitcroft 9758905a67cSAndy Whitcroft if ($level == 0) { 976b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 977b998e001SPatrick Pannuto $off++; 978b998e001SPatrick Pannuto } 9798905a67cSAndy Whitcroft last; 9808905a67cSAndy Whitcroft } 9818905a67cSAndy Whitcroft } 982f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 983f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 984f74bd194SAndy Whitcroft $level--; 985f74bd194SAndy Whitcroft $type = ''; 986f74bd194SAndy Whitcroft $off++; 987f74bd194SAndy Whitcroft last; 988f74bd194SAndy Whitcroft } 9898905a67cSAndy Whitcroft $off++; 9908905a67cSAndy Whitcroft } 991a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 99213214adfSAndy Whitcroft if ($off == $len) { 993a3bb97a7SAndy Whitcroft $loff = $len + 1; 99413214adfSAndy Whitcroft $line++; 99513214adfSAndy Whitcroft $remain--; 99613214adfSAndy Whitcroft } 9978905a67cSAndy Whitcroft 9988905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9998905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 10008905a67cSAndy Whitcroft 10018905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 10028905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 10038905a67cSAndy Whitcroft 1004773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 100513214adfSAndy Whitcroft 100613214adfSAndy Whitcroft return ($statement, $condition, 100713214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 100813214adfSAndy Whitcroft} 100913214adfSAndy Whitcroft 1010cf655043SAndy Whitcroftsub statement_lines { 1011cf655043SAndy Whitcroft my ($stmt) = @_; 1012cf655043SAndy Whitcroft 1013cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1014cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1015cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1016cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1017cf655043SAndy Whitcroft 1018cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1019cf655043SAndy Whitcroft 1020cf655043SAndy Whitcroft return $#stmt_lines + 2; 1021cf655043SAndy Whitcroft} 1022cf655043SAndy Whitcroft 1023cf655043SAndy Whitcroftsub statement_rawlines { 1024cf655043SAndy Whitcroft my ($stmt) = @_; 1025cf655043SAndy Whitcroft 1026cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1027cf655043SAndy Whitcroft 1028cf655043SAndy Whitcroft return $#stmt_lines + 2; 1029cf655043SAndy Whitcroft} 1030cf655043SAndy Whitcroft 1031cf655043SAndy Whitcroftsub statement_block_size { 1032cf655043SAndy Whitcroft my ($stmt) = @_; 1033cf655043SAndy Whitcroft 1034cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1035cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1036cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1037cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1038cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1039cf655043SAndy Whitcroft 1040cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1041cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1042cf655043SAndy Whitcroft 1043cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1044cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1045cf655043SAndy Whitcroft 1046cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1047cf655043SAndy Whitcroft return $stmt_lines; 1048cf655043SAndy Whitcroft } else { 1049cf655043SAndy Whitcroft return $stmt_statements; 1050cf655043SAndy Whitcroft } 1051cf655043SAndy Whitcroft} 1052cf655043SAndy Whitcroft 105313214adfSAndy Whitcroftsub ctx_statement_full { 105413214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 105513214adfSAndy Whitcroft my ($statement, $condition, $level); 105613214adfSAndy Whitcroft 105713214adfSAndy Whitcroft my (@chunks); 105813214adfSAndy Whitcroft 1059cf655043SAndy Whitcroft # Grab the first conditional/block pair. 106013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 106113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1062773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 106313214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1064cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1065cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1066cf655043SAndy Whitcroft } 1067cf655043SAndy Whitcroft 1068cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1069cf655043SAndy Whitcroft # could continue the statement. 1070cf655043SAndy Whitcroft for (;;) { 107113214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 107213214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1073cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1074773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1075cf655043SAndy Whitcroft #print "C: push\n"; 1076cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 107713214adfSAndy Whitcroft } 107813214adfSAndy Whitcroft 107913214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10808905a67cSAndy Whitcroft} 10818905a67cSAndy Whitcroft 10824a0df2efSAndy Whitcroftsub ctx_block_get { 1083f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10844a0df2efSAndy Whitcroft my $line; 10854a0df2efSAndy Whitcroft my $start = $linenr - 1; 10864a0df2efSAndy Whitcroft my $blk = ''; 10874a0df2efSAndy Whitcroft my @o; 10884a0df2efSAndy Whitcroft my @c; 10894a0df2efSAndy Whitcroft my @res = (); 10904a0df2efSAndy Whitcroft 1091f0a594c1SAndy Whitcroft my $level = 0; 10924635f4fbSAndy Whitcroft my @stack = ($level); 109300df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 109400df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 109500df344fSAndy Whitcroft $remain--; 109600df344fSAndy Whitcroft 109700df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10984635f4fbSAndy Whitcroft 10994635f4fbSAndy Whitcroft # Handle nested #if/#else. 110001464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 11014635f4fbSAndy Whitcroft push(@stack, $level); 110201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 11034635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 110401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 11054635f4fbSAndy Whitcroft $level = pop(@stack); 11064635f4fbSAndy Whitcroft } 11074635f4fbSAndy Whitcroft 110801464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1109f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1110f0a594c1SAndy Whitcroft if ($off > 0) { 1111f0a594c1SAndy Whitcroft $off--; 1112f0a594c1SAndy Whitcroft next; 1113f0a594c1SAndy Whitcroft } 11144a0df2efSAndy Whitcroft 1115f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1116f0a594c1SAndy Whitcroft $level--; 1117f0a594c1SAndy Whitcroft last if ($level == 0); 1118f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1119f0a594c1SAndy Whitcroft $level++; 1120f0a594c1SAndy Whitcroft } 1121f0a594c1SAndy Whitcroft } 11224a0df2efSAndy Whitcroft 1123f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 112400df344fSAndy Whitcroft push(@res, $rawlines[$line]); 11254a0df2efSAndy Whitcroft } 11264a0df2efSAndy Whitcroft 1127f0a594c1SAndy Whitcroft last if ($level == 0); 11284a0df2efSAndy Whitcroft } 11294a0df2efSAndy Whitcroft 1130f0a594c1SAndy Whitcroft return ($level, @res); 11314a0df2efSAndy Whitcroft} 11324a0df2efSAndy Whitcroftsub ctx_block_outer { 11334a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 11344a0df2efSAndy Whitcroft 1135f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1136f0a594c1SAndy Whitcroft return @r; 11374a0df2efSAndy Whitcroft} 11384a0df2efSAndy Whitcroftsub ctx_block { 11394a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 11404a0df2efSAndy Whitcroft 1141f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1142f0a594c1SAndy Whitcroft return @r; 1143653d4876SAndy Whitcroft} 1144653d4876SAndy Whitcroftsub ctx_statement { 1145f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1146f0a594c1SAndy Whitcroft 1147f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1148f0a594c1SAndy Whitcroft return @r; 1149f0a594c1SAndy Whitcroft} 1150f0a594c1SAndy Whitcroftsub ctx_block_level { 1151653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1152653d4876SAndy Whitcroft 1153f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 11544a0df2efSAndy Whitcroft} 11559c0ca6f9SAndy Whitcroftsub ctx_statement_level { 11569c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 11579c0ca6f9SAndy Whitcroft 11589c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 11599c0ca6f9SAndy Whitcroft} 11604a0df2efSAndy Whitcroft 11614a0df2efSAndy Whitcroftsub ctx_locate_comment { 11624a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11634a0df2efSAndy Whitcroft 11644a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1165beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 11664a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 11674a0df2efSAndy Whitcroft 11684a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 11694a0df2efSAndy Whitcroft # comment. 11704a0df2efSAndy Whitcroft my $in_comment = 0; 11714a0df2efSAndy Whitcroft $current_comment = ''; 11724a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 117300df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 117400df344fSAndy Whitcroft #warn " $line\n"; 11754a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11764a0df2efSAndy Whitcroft $in_comment = 1; 11774a0df2efSAndy Whitcroft } 11784a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11794a0df2efSAndy Whitcroft $in_comment = 1; 11804a0df2efSAndy Whitcroft } 11814a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11824a0df2efSAndy Whitcroft $current_comment = ''; 11834a0df2efSAndy Whitcroft } 11844a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11854a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11864a0df2efSAndy Whitcroft $in_comment = 0; 11874a0df2efSAndy Whitcroft } 11884a0df2efSAndy Whitcroft } 11894a0df2efSAndy Whitcroft 11904a0df2efSAndy Whitcroft chomp($current_comment); 11914a0df2efSAndy Whitcroft return($current_comment); 11924a0df2efSAndy Whitcroft} 11934a0df2efSAndy Whitcroftsub ctx_has_comment { 11944a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11954a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11964a0df2efSAndy Whitcroft 119700df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11984a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11994a0df2efSAndy Whitcroft 12004a0df2efSAndy Whitcroft return ($cmt ne ''); 12014a0df2efSAndy Whitcroft} 12024a0df2efSAndy Whitcroft 12034d001e4dSAndy Whitcroftsub raw_line { 12044d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 12054d001e4dSAndy Whitcroft 12064d001e4dSAndy Whitcroft my $offset = $linenr - 1; 12074d001e4dSAndy Whitcroft $cnt++; 12084d001e4dSAndy Whitcroft 12094d001e4dSAndy Whitcroft my $line; 12104d001e4dSAndy Whitcroft while ($cnt) { 12114d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 12124d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 12134d001e4dSAndy Whitcroft $cnt--; 12144d001e4dSAndy Whitcroft } 12154d001e4dSAndy Whitcroft 12164d001e4dSAndy Whitcroft return $line; 12174d001e4dSAndy Whitcroft} 12184d001e4dSAndy Whitcroft 12190a920b5bSAndy Whitcroftsub cat_vet { 12200a920b5bSAndy Whitcroft my ($vet) = @_; 12219c0ca6f9SAndy Whitcroft my ($res, $coded); 12220a920b5bSAndy Whitcroft 12239c0ca6f9SAndy Whitcroft $res = ''; 12246c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 12256c72ffaaSAndy Whitcroft $res .= $1; 12266c72ffaaSAndy Whitcroft if ($2 ne '') { 12279c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 12286c72ffaaSAndy Whitcroft $res .= $coded; 12296c72ffaaSAndy Whitcroft } 12309c0ca6f9SAndy Whitcroft } 12319c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 12320a920b5bSAndy Whitcroft 12339c0ca6f9SAndy Whitcroft return $res; 12340a920b5bSAndy Whitcroft} 12350a920b5bSAndy Whitcroft 1236c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1237cf655043SAndy Whitcroftmy $av_pending; 1238c2fdda0dSAndy Whitcroftmy @av_paren_type; 12391f65f947SAndy Whitcroftmy $av_pend_colon; 1240c2fdda0dSAndy Whitcroft 1241c2fdda0dSAndy Whitcroftsub annotate_reset { 1242c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1243cf655043SAndy Whitcroft $av_pending = '_'; 1244cf655043SAndy Whitcroft @av_paren_type = ('E'); 12451f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1246c2fdda0dSAndy Whitcroft} 1247c2fdda0dSAndy Whitcroft 12486c72ffaaSAndy Whitcroftsub annotate_values { 12496c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 12506c72ffaaSAndy Whitcroft 12516c72ffaaSAndy Whitcroft my $res; 12521f65f947SAndy Whitcroft my $var = '_' x length($stream); 12536c72ffaaSAndy Whitcroft my $cur = $stream; 12546c72ffaaSAndy Whitcroft 1255c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 12566c72ffaaSAndy Whitcroft 12576c72ffaaSAndy Whitcroft while (length($cur)) { 1258773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1259cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1260171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 12616c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1262c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1263c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1264cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1265c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 12666c72ffaaSAndy Whitcroft } 12676c72ffaaSAndy Whitcroft 1268c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 12699446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 12709446ef56SAndy Whitcroft push(@av_paren_type, $type); 1271addcdceaSAndy Whitcroft $type = 'c'; 12729446ef56SAndy Whitcroft 1273e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1274c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12756c72ffaaSAndy Whitcroft $type = 'T'; 12766c72ffaaSAndy Whitcroft 1277389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1278389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1279389a2fe5SAndy Whitcroft $type = 'T'; 1280389a2fe5SAndy Whitcroft 1281c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1282171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1283c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1284171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1285171ae1a4SAndy Whitcroft if ($2 ne '') { 1286cf655043SAndy Whitcroft $av_pending = 'N'; 1287171ae1a4SAndy Whitcroft } 1288171ae1a4SAndy Whitcroft $type = 'E'; 1289171ae1a4SAndy Whitcroft 1290c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1291171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1292171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1293171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12946c72ffaaSAndy Whitcroft 1295c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1296cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1297c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1298cf655043SAndy Whitcroft 1299cf655043SAndy Whitcroft push(@av_paren_type, $type); 1300cf655043SAndy Whitcroft push(@av_paren_type, $type); 1301171ae1a4SAndy Whitcroft $type = 'E'; 1302cf655043SAndy Whitcroft 1303c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1304cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1305cf655043SAndy Whitcroft $av_preprocessor = 1; 1306cf655043SAndy Whitcroft 1307cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1308cf655043SAndy Whitcroft 1309171ae1a4SAndy Whitcroft $type = 'E'; 1310cf655043SAndy Whitcroft 1311c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1312cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1313cf655043SAndy Whitcroft 1314cf655043SAndy Whitcroft $av_preprocessor = 1; 1315cf655043SAndy Whitcroft 1316cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1317cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1318cf655043SAndy Whitcroft pop(@av_paren_type); 1319cf655043SAndy Whitcroft push(@av_paren_type, $type); 1320171ae1a4SAndy Whitcroft $type = 'E'; 13216c72ffaaSAndy Whitcroft 13226c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1323c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 13246c72ffaaSAndy Whitcroft 1325171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1326171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1327171ae1a4SAndy Whitcroft $av_pending = $type; 1328171ae1a4SAndy Whitcroft $type = 'N'; 1329171ae1a4SAndy Whitcroft 13306c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1331c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 13326c72ffaaSAndy Whitcroft if (defined $2) { 1333cf655043SAndy Whitcroft $av_pending = 'V'; 13346c72ffaaSAndy Whitcroft } 13356c72ffaaSAndy Whitcroft $type = 'N'; 13366c72ffaaSAndy Whitcroft 133714b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1338c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 133914b111c1SAndy Whitcroft $av_pending = 'E'; 13406c72ffaaSAndy Whitcroft $type = 'N'; 13416c72ffaaSAndy Whitcroft 13421f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 13431f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 13441f65f947SAndy Whitcroft $av_pend_colon = 'C'; 13451f65f947SAndy Whitcroft $type = 'N'; 13461f65f947SAndy Whitcroft 134714b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1348c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 13496c72ffaaSAndy Whitcroft $type = 'N'; 13506c72ffaaSAndy Whitcroft 13516c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1352c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1353cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1354cf655043SAndy Whitcroft $av_pending = '_'; 13556c72ffaaSAndy Whitcroft $type = 'N'; 13566c72ffaaSAndy Whitcroft 13576c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1358cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1359cf655043SAndy Whitcroft if ($new_type ne '_') { 1360cf655043SAndy Whitcroft $type = $new_type; 1361c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1362c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 13636c72ffaaSAndy Whitcroft } else { 1364c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 13656c72ffaaSAndy Whitcroft } 13666c72ffaaSAndy Whitcroft 1367c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1368c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1369c8cb2ca3SAndy Whitcroft $type = 'V'; 1370cf655043SAndy Whitcroft $av_pending = 'V'; 13716c72ffaaSAndy Whitcroft 13728e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 13738e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13741f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13758e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13768e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13771f65f947SAndy Whitcroft } 13781f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13791f65f947SAndy Whitcroft $type = 'V'; 13801f65f947SAndy Whitcroft 13816c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1382c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13836c72ffaaSAndy Whitcroft $type = 'V'; 13846c72ffaaSAndy Whitcroft 13856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1386c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13876c72ffaaSAndy Whitcroft $type = 'N'; 13886c72ffaaSAndy Whitcroft 1389cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1390c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 139113214adfSAndy Whitcroft $type = 'E'; 13921f65f947SAndy Whitcroft $av_pend_colon = 'O'; 139313214adfSAndy Whitcroft 13948e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13958e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13968e761b04SAndy Whitcroft $type = 'C'; 13978e761b04SAndy Whitcroft 13981f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13991f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 14001f65f947SAndy Whitcroft $type = 'N'; 14011f65f947SAndy Whitcroft 14021f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 14031f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 14041f65f947SAndy Whitcroft 14051f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 14061f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 14071f65f947SAndy Whitcroft $type = 'E'; 14081f65f947SAndy Whitcroft } else { 14091f65f947SAndy Whitcroft $type = 'N'; 14101f65f947SAndy Whitcroft } 14111f65f947SAndy Whitcroft $av_pend_colon = 'O'; 14121f65f947SAndy Whitcroft 14138e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 141413214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 14156c72ffaaSAndy Whitcroft $type = 'N'; 14166c72ffaaSAndy Whitcroft 14170d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 141874048ed8SAndy Whitcroft my $variant; 141974048ed8SAndy Whitcroft 142074048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 142174048ed8SAndy Whitcroft if ($type eq 'V') { 142274048ed8SAndy Whitcroft $variant = 'B'; 142374048ed8SAndy Whitcroft } else { 142474048ed8SAndy Whitcroft $variant = 'U'; 142574048ed8SAndy Whitcroft } 142674048ed8SAndy Whitcroft 142774048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 142874048ed8SAndy Whitcroft $type = 'N'; 142974048ed8SAndy Whitcroft 14306c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1431c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 14326c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 14336c72ffaaSAndy Whitcroft $type = 'N'; 14346c72ffaaSAndy Whitcroft } 14356c72ffaaSAndy Whitcroft 14366c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1437c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 14386c72ffaaSAndy Whitcroft } 14396c72ffaaSAndy Whitcroft if (defined $1) { 14406c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 14416c72ffaaSAndy Whitcroft $res .= $type x length($1); 14426c72ffaaSAndy Whitcroft } 14436c72ffaaSAndy Whitcroft } 14446c72ffaaSAndy Whitcroft 14451f65f947SAndy Whitcroft return ($res, $var); 14466c72ffaaSAndy Whitcroft} 14476c72ffaaSAndy Whitcroft 14488905a67cSAndy Whitcroftsub possible { 144913214adfSAndy Whitcroft my ($possible, $line) = @_; 14509a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 14510776e594SAndy Whitcroft ^(?: 14520776e594SAndy Whitcroft $Modifier| 14530776e594SAndy Whitcroft $Storage| 14540776e594SAndy Whitcroft $Type| 14559a974fdbSAndy Whitcroft DEFINE_\S+ 14569a974fdbSAndy Whitcroft )$| 14579a974fdbSAndy Whitcroft ^(?: 14580776e594SAndy Whitcroft goto| 14590776e594SAndy Whitcroft return| 14600776e594SAndy Whitcroft case| 14610776e594SAndy Whitcroft else| 14620776e594SAndy Whitcroft asm|__asm__| 146389a88353SAndy Whitcroft do| 146489a88353SAndy Whitcroft \#| 146589a88353SAndy Whitcroft \#\#| 14669a974fdbSAndy Whitcroft )(?:\s|$)| 14670776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 14689a974fdbSAndy Whitcroft )}x; 14699a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 14709a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1471c45dcabdSAndy Whitcroft # Check for modifiers. 1472c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1473c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1474c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1475c45dcabdSAndy Whitcroft 1476c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1477c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1478d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14799a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1480d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1481d2506586SAndy Whitcroft push(@modifierList, $modifier); 1482d2506586SAndy Whitcroft } 14839a974fdbSAndy Whitcroft } 1484c45dcabdSAndy Whitcroft 1485c45dcabdSAndy Whitcroft } else { 148613214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14878905a67cSAndy Whitcroft push(@typeList, $possible); 1488c45dcabdSAndy Whitcroft } 14898905a67cSAndy Whitcroft build_types(); 14900776e594SAndy Whitcroft } else { 14910776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14928905a67cSAndy Whitcroft } 14938905a67cSAndy Whitcroft} 14948905a67cSAndy Whitcroft 14956c72ffaaSAndy Whitcroftmy $prefix = ''; 14966c72ffaaSAndy Whitcroft 1497000d1cc1SJoe Perchessub show_type { 1498cbec18afSJoe Perches my ($type) = @_; 149991bfe484SJoe Perches 1500cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1501cbec18afSJoe Perches 1502cbec18afSJoe Perches return !defined $ignore_type{$type}; 1503000d1cc1SJoe Perches} 1504000d1cc1SJoe Perches 1505f0a594c1SAndy Whitcroftsub report { 1506cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1507cbec18afSJoe Perches 1508cbec18afSJoe Perches if (!show_type($type) || 1509cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1510773647a0SAndy Whitcroft return 0; 1511773647a0SAndy Whitcroft } 1512000d1cc1SJoe Perches my $line; 1513000d1cc1SJoe Perches if ($show_types) { 1514cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1515000d1cc1SJoe Perches } else { 1516cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1517000d1cc1SJoe Perches } 15188905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 15198905a67cSAndy Whitcroft 152013214adfSAndy Whitcroft push(our @report, $line); 1521773647a0SAndy Whitcroft 1522773647a0SAndy Whitcroft return 1; 1523f0a594c1SAndy Whitcroft} 1524cbec18afSJoe Perches 1525f0a594c1SAndy Whitcroftsub report_dump { 152613214adfSAndy Whitcroft our @report; 1527f0a594c1SAndy Whitcroft} 1528000d1cc1SJoe Perches 1529de7d4f0eSAndy Whitcroftsub ERROR { 1530cbec18afSJoe Perches my ($type, $msg) = @_; 1531cbec18afSJoe Perches 1532cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1533de7d4f0eSAndy Whitcroft our $clean = 0; 15346c72ffaaSAndy Whitcroft our $cnt_error++; 15353705ce5bSJoe Perches return 1; 1536de7d4f0eSAndy Whitcroft } 15373705ce5bSJoe Perches return 0; 1538773647a0SAndy Whitcroft} 1539de7d4f0eSAndy Whitcroftsub WARN { 1540cbec18afSJoe Perches my ($type, $msg) = @_; 1541cbec18afSJoe Perches 1542cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1543de7d4f0eSAndy Whitcroft our $clean = 0; 15446c72ffaaSAndy Whitcroft our $cnt_warn++; 15453705ce5bSJoe Perches return 1; 1546de7d4f0eSAndy Whitcroft } 15473705ce5bSJoe Perches return 0; 1548773647a0SAndy Whitcroft} 1549de7d4f0eSAndy Whitcroftsub CHK { 1550cbec18afSJoe Perches my ($type, $msg) = @_; 1551cbec18afSJoe Perches 1552cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1553de7d4f0eSAndy Whitcroft our $clean = 0; 15546c72ffaaSAndy Whitcroft our $cnt_chk++; 15553705ce5bSJoe Perches return 1; 15566c72ffaaSAndy Whitcroft } 15573705ce5bSJoe Perches return 0; 1558de7d4f0eSAndy Whitcroft} 1559de7d4f0eSAndy Whitcroft 15606ecd9674SAndy Whitcroftsub check_absolute_file { 15616ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 15626ecd9674SAndy Whitcroft my $file = $absolute; 15636ecd9674SAndy Whitcroft 15646ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 15656ecd9674SAndy Whitcroft 15666ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 15676ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 15686ecd9674SAndy Whitcroft if (-f "$root/$file") { 15696ecd9674SAndy Whitcroft ##print "file<$file>\n"; 15706ecd9674SAndy Whitcroft last; 15716ecd9674SAndy Whitcroft } 15726ecd9674SAndy Whitcroft } 15736ecd9674SAndy Whitcroft if (! -f _) { 15746ecd9674SAndy Whitcroft return 0; 15756ecd9674SAndy Whitcroft } 15766ecd9674SAndy Whitcroft 15776ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 15786ecd9674SAndy Whitcroft my $prefix = $absolute; 15796ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 15806ecd9674SAndy Whitcroft 15816ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 15826ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1583000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1584000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 15856ecd9674SAndy Whitcroft } 15866ecd9674SAndy Whitcroft} 15876ecd9674SAndy Whitcroft 15883705ce5bSJoe Perchessub trim { 15893705ce5bSJoe Perches my ($string) = @_; 15903705ce5bSJoe Perches 1591b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1592b34c648bSJoe Perches 1593b34c648bSJoe Perches return $string; 1594b34c648bSJoe Perches} 1595b34c648bSJoe Perches 1596b34c648bSJoe Perchessub ltrim { 1597b34c648bSJoe Perches my ($string) = @_; 1598b34c648bSJoe Perches 1599b34c648bSJoe Perches $string =~ s/^\s+//; 1600b34c648bSJoe Perches 1601b34c648bSJoe Perches return $string; 1602b34c648bSJoe Perches} 1603b34c648bSJoe Perches 1604b34c648bSJoe Perchessub rtrim { 1605b34c648bSJoe Perches my ($string) = @_; 1606b34c648bSJoe Perches 1607b34c648bSJoe Perches $string =~ s/\s+$//; 16083705ce5bSJoe Perches 16093705ce5bSJoe Perches return $string; 16103705ce5bSJoe Perches} 16113705ce5bSJoe Perches 161252ea8506SJoe Perchessub string_find_replace { 161352ea8506SJoe Perches my ($string, $find, $replace) = @_; 161452ea8506SJoe Perches 161552ea8506SJoe Perches $string =~ s/$find/$replace/g; 161652ea8506SJoe Perches 161752ea8506SJoe Perches return $string; 161852ea8506SJoe Perches} 161952ea8506SJoe Perches 16203705ce5bSJoe Perchessub tabify { 16213705ce5bSJoe Perches my ($leading) = @_; 16223705ce5bSJoe Perches 16233705ce5bSJoe Perches my $source_indent = 8; 16243705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 16253705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 16263705ce5bSJoe Perches 16273705ce5bSJoe Perches #convert leading spaces to tabs 16283705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 16293705ce5bSJoe Perches #Remove spaces before a tab 16303705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 16313705ce5bSJoe Perches 16323705ce5bSJoe Perches return "$leading"; 16333705ce5bSJoe Perches} 16343705ce5bSJoe Perches 1635d1fe9c09SJoe Perchessub pos_last_openparen { 1636d1fe9c09SJoe Perches my ($line) = @_; 1637d1fe9c09SJoe Perches 1638d1fe9c09SJoe Perches my $pos = 0; 1639d1fe9c09SJoe Perches 1640d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1641d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1642d1fe9c09SJoe Perches 1643d1fe9c09SJoe Perches my $last_openparen = 0; 1644d1fe9c09SJoe Perches 1645d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1646d1fe9c09SJoe Perches return -1; 1647d1fe9c09SJoe Perches } 1648d1fe9c09SJoe Perches 1649d1fe9c09SJoe Perches my $len = length($line); 1650d1fe9c09SJoe Perches 1651d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1652d1fe9c09SJoe Perches my $string = substr($line, $pos); 1653d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1654d1fe9c09SJoe Perches $pos += length($1) - 1; 1655d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1656d1fe9c09SJoe Perches $last_openparen = $pos; 1657d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1658d1fe9c09SJoe Perches last; 1659d1fe9c09SJoe Perches } 1660d1fe9c09SJoe Perches } 1661d1fe9c09SJoe Perches 166291cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1663d1fe9c09SJoe Perches} 1664d1fe9c09SJoe Perches 16650a920b5bSAndy Whitcroftsub process { 16660a920b5bSAndy Whitcroft my $filename = shift; 16670a920b5bSAndy Whitcroft 16680a920b5bSAndy Whitcroft my $linenr=0; 16690a920b5bSAndy Whitcroft my $prevline=""; 1670c2fdda0dSAndy Whitcroft my $prevrawline=""; 16710a920b5bSAndy Whitcroft my $stashline=""; 1672c2fdda0dSAndy Whitcroft my $stashrawline=""; 16730a920b5bSAndy Whitcroft 16744a0df2efSAndy Whitcroft my $length; 16750a920b5bSAndy Whitcroft my $indent; 16760a920b5bSAndy Whitcroft my $previndent=0; 16770a920b5bSAndy Whitcroft my $stashindent=0; 16780a920b5bSAndy Whitcroft 1679de7d4f0eSAndy Whitcroft our $clean = 1; 16800a920b5bSAndy Whitcroft my $signoff = 0; 16810a920b5bSAndy Whitcroft my $is_patch = 0; 16820a920b5bSAndy Whitcroft 168329ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 168415662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 168513f1937eSJoe Perches my $reported_maintainer_file = 0; 1686fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1687fa64205dSPasi Savanainen 1688365dd4eaSJoe Perches my $last_blank_line = 0; 1689365dd4eaSJoe Perches 169013214adfSAndy Whitcroft our @report = (); 16916c72ffaaSAndy Whitcroft our $cnt_lines = 0; 16926c72ffaaSAndy Whitcroft our $cnt_error = 0; 16936c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16946c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16956c72ffaaSAndy Whitcroft 16960a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16970a920b5bSAndy Whitcroft my $realfile = ''; 16980a920b5bSAndy Whitcroft my $realline = 0; 16990a920b5bSAndy Whitcroft my $realcnt = 0; 17000a920b5bSAndy Whitcroft my $here = ''; 17010a920b5bSAndy Whitcroft my $in_comment = 0; 1702c2fdda0dSAndy Whitcroft my $comment_edge = 0; 17030a920b5bSAndy Whitcroft my $first_line = 0; 17041e855726SWolfram Sang my $p1_prefix = ''; 17050a920b5bSAndy Whitcroft 170613214adfSAndy Whitcroft my $prev_values = 'E'; 170713214adfSAndy Whitcroft 170813214adfSAndy Whitcroft # suppression flags 1709773647a0SAndy Whitcroft my %suppress_ifbraces; 1710170d3a22SAndy Whitcroft my %suppress_whiletrailers; 17112b474a1aSAndy Whitcroft my %suppress_export; 17123e469cdcSAndy Whitcroft my $suppress_statement = 0; 1713653d4876SAndy Whitcroft 17147e51f197SJoe Perches my %signatures = (); 1715323c1260SJoe Perches 1716c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1717de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1718c2fdda0dSAndy Whitcroft # 1719de7d4f0eSAndy Whitcroft my @setup_docs = (); 1720de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1721773647a0SAndy Whitcroft 1722d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1723d8b07710SJoe Perches 1724773647a0SAndy Whitcroft sanitise_line_reset(); 1725c2fdda0dSAndy Whitcroft my $line; 1726c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1727773647a0SAndy Whitcroft $linenr++; 1728773647a0SAndy Whitcroft $line = $rawline; 1729c2fdda0dSAndy Whitcroft 17303705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 17313705ce5bSJoe Perches 1732773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1733de7d4f0eSAndy Whitcroft $setup_docs = 0; 1734de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1735de7d4f0eSAndy Whitcroft $setup_docs = 1; 1736de7d4f0eSAndy Whitcroft } 1737773647a0SAndy Whitcroft #next; 1738de7d4f0eSAndy Whitcroft } 1739773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1740773647a0SAndy Whitcroft $realline=$1-1; 1741773647a0SAndy Whitcroft if (defined $2) { 1742773647a0SAndy Whitcroft $realcnt=$3+1; 1743773647a0SAndy Whitcroft } else { 1744773647a0SAndy Whitcroft $realcnt=1+1; 1745773647a0SAndy Whitcroft } 1746c45dcabdSAndy Whitcroft $in_comment = 0; 1747773647a0SAndy Whitcroft 1748773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1749773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1750773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1751773647a0SAndy Whitcroft # at context start. 1752773647a0SAndy Whitcroft my $edge; 175301fa9147SAndy Whitcroft my $cnt = $realcnt; 175401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 175501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 175601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 175701fa9147SAndy Whitcroft $cnt--; 175801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1759721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1760fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1761fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1762fae17daeSAndy Whitcroft ($edge) = $1; 1763fae17daeSAndy Whitcroft last; 1764fae17daeSAndy Whitcroft } 1765773647a0SAndy Whitcroft } 1766773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1767773647a0SAndy Whitcroft $in_comment = 1; 1768773647a0SAndy Whitcroft } 1769773647a0SAndy Whitcroft 1770773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1771773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1772773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1773773647a0SAndy Whitcroft if (!defined $edge && 177483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1775773647a0SAndy Whitcroft { 1776773647a0SAndy Whitcroft $in_comment = 1; 1777773647a0SAndy Whitcroft } 1778773647a0SAndy Whitcroft 1779773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1780773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1781773647a0SAndy Whitcroft 1782171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1783773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1784171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1785773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1786773647a0SAndy Whitcroft } 1787773647a0SAndy Whitcroft push(@lines, $line); 1788773647a0SAndy Whitcroft 1789773647a0SAndy Whitcroft if ($realcnt > 1) { 1790773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1791773647a0SAndy Whitcroft } else { 1792773647a0SAndy Whitcroft $realcnt = 0; 1793773647a0SAndy Whitcroft } 1794773647a0SAndy Whitcroft 1795773647a0SAndy Whitcroft #print "==>$rawline\n"; 1796773647a0SAndy Whitcroft #print "-->$line\n"; 1797de7d4f0eSAndy Whitcroft 1798de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1799de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1800de7d4f0eSAndy Whitcroft } 1801de7d4f0eSAndy Whitcroft } 1802de7d4f0eSAndy Whitcroft 18036c72ffaaSAndy Whitcroft $prefix = ''; 18046c72ffaaSAndy Whitcroft 1805773647a0SAndy Whitcroft $realcnt = 0; 1806773647a0SAndy Whitcroft $linenr = 0; 1807*194f66fcSJoe Perches $fixlinenr = -1; 18080a920b5bSAndy Whitcroft foreach my $line (@lines) { 18090a920b5bSAndy Whitcroft $linenr++; 1810*194f66fcSJoe Perches $fixlinenr++; 18111b5539b1SJoe Perches my $sline = $line; #copy of $line 18121b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 18130a920b5bSAndy Whitcroft 1814c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 18156c72ffaaSAndy Whitcroft 18160a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 18176c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 18180a920b5bSAndy Whitcroft $is_patch = 1; 18194a0df2efSAndy Whitcroft $first_line = $linenr + 1; 18200a920b5bSAndy Whitcroft $realline=$1-1; 18210a920b5bSAndy Whitcroft if (defined $2) { 18220a920b5bSAndy Whitcroft $realcnt=$3+1; 18230a920b5bSAndy Whitcroft } else { 18240a920b5bSAndy Whitcroft $realcnt=1+1; 18250a920b5bSAndy Whitcroft } 1826c2fdda0dSAndy Whitcroft annotate_reset(); 182713214adfSAndy Whitcroft $prev_values = 'E'; 182813214adfSAndy Whitcroft 1829773647a0SAndy Whitcroft %suppress_ifbraces = (); 1830170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 18312b474a1aSAndy Whitcroft %suppress_export = (); 18323e469cdcSAndy Whitcroft $suppress_statement = 0; 18330a920b5bSAndy Whitcroft next; 18340a920b5bSAndy Whitcroft 18354a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 18364a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 18374a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1838773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 18390a920b5bSAndy Whitcroft $realline++; 1840d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 18410a920b5bSAndy Whitcroft 18424a0df2efSAndy Whitcroft # Measure the line length and indent. 1843c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 18440a920b5bSAndy Whitcroft 18450a920b5bSAndy Whitcroft # Track the previous line. 18460a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 18470a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1848c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1849c2fdda0dSAndy Whitcroft 1850773647a0SAndy Whitcroft #warn "line<$line>\n"; 18516c72ffaaSAndy Whitcroft 1852d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1853d8aaf121SAndy Whitcroft $realcnt--; 18540a920b5bSAndy Whitcroft } 18550a920b5bSAndy Whitcroft 1856cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1857cc77cdcaSAndy Whitcroft 18580a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1859773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1860773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1861773647a0SAndy Whitcroft 18626c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 18636c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1864773647a0SAndy Whitcroft 18652ac73b4fSJoe Perches my $found_file = 0; 1866773647a0SAndy Whitcroft # extract the filename as it passes 18673bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 18683bf9a009SRabin Vincent $realfile = $1; 18692b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1870270c49a0SJoe Perches $in_commit_log = 0; 18712ac73b4fSJoe Perches $found_file = 1; 18723bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1873773647a0SAndy Whitcroft $realfile = $1; 18742b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1875270c49a0SJoe Perches $in_commit_log = 0; 18761e855726SWolfram Sang 18771e855726SWolfram Sang $p1_prefix = $1; 1878e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1879e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1880000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1881000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 18821e855726SWolfram Sang } 1883773647a0SAndy Whitcroft 1884c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1885000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1886000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1887773647a0SAndy Whitcroft } 18882ac73b4fSJoe Perches $found_file = 1; 18892ac73b4fSJoe Perches } 18902ac73b4fSJoe Perches 18912ac73b4fSJoe Perches if ($found_file) { 18922ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 18932ac73b4fSJoe Perches $check = 1; 18942ac73b4fSJoe Perches } else { 18952ac73b4fSJoe Perches $check = $check_orig; 18962ac73b4fSJoe Perches } 1897773647a0SAndy Whitcroft next; 1898773647a0SAndy Whitcroft } 1899773647a0SAndy Whitcroft 1900389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 19010a920b5bSAndy Whitcroft 1902c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1903c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1904c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 19050a920b5bSAndy Whitcroft 19066c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 19076c72ffaaSAndy Whitcroft 19083bf9a009SRabin Vincent# Check for incorrect file permissions 19093bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 19103bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 191104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 191204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1913000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1914000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 19153bf9a009SRabin Vincent } 19163bf9a009SRabin Vincent } 19173bf9a009SRabin Vincent 191820112475SJoe Perches# Check the patch for a signoff: 1919d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 19204a0df2efSAndy Whitcroft $signoff++; 192115662b3eSJoe Perches $in_commit_log = 0; 19220a920b5bSAndy Whitcroft } 192320112475SJoe Perches 192420112475SJoe Perches# Check signature styles 1925270c49a0SJoe Perches if (!$in_header_lines && 1926ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 192720112475SJoe Perches my $space_before = $1; 192820112475SJoe Perches my $sign_off = $2; 192920112475SJoe Perches my $space_after = $3; 193020112475SJoe Perches my $email = $4; 193120112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 193220112475SJoe Perches 1933ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1934ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1935ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1936ce0338dfSJoe Perches } 193720112475SJoe Perches if (defined $space_before && $space_before ne "") { 19383705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 19393705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 19403705ce5bSJoe Perches $fix) { 1941*194f66fcSJoe Perches $fixed[$fixlinenr] = 19423705ce5bSJoe Perches "$ucfirst_sign_off $email"; 19433705ce5bSJoe Perches } 194420112475SJoe Perches } 194520112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 19463705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 19473705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 19483705ce5bSJoe Perches $fix) { 1949*194f66fcSJoe Perches $fixed[$fixlinenr] = 19503705ce5bSJoe Perches "$ucfirst_sign_off $email"; 19513705ce5bSJoe Perches } 19523705ce5bSJoe Perches 195320112475SJoe Perches } 195420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 19553705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 19563705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 19573705ce5bSJoe Perches $fix) { 1958*194f66fcSJoe Perches $fixed[$fixlinenr] = 19593705ce5bSJoe Perches "$ucfirst_sign_off $email"; 19603705ce5bSJoe Perches } 196120112475SJoe Perches } 196220112475SJoe Perches 196320112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 196420112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 196520112475SJoe Perches if ($suggested_email eq "") { 1966000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1967000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 196820112475SJoe Perches } else { 196920112475SJoe Perches my $dequoted = $suggested_email; 197020112475SJoe Perches $dequoted =~ s/^"//; 197120112475SJoe Perches $dequoted =~ s/" </ </; 197220112475SJoe Perches # Don't force email to have quotes 197320112475SJoe Perches # Allow just an angle bracketed address 197420112475SJoe Perches if ("$dequoted$comment" ne $email && 197520112475SJoe Perches "<$email_address>$comment" ne $email && 197620112475SJoe Perches "$suggested_email$comment" ne $email) { 1977000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1978000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 197920112475SJoe Perches } 19800a920b5bSAndy Whitcroft } 19817e51f197SJoe Perches 19827e51f197SJoe Perches# Check for duplicate signatures 19837e51f197SJoe Perches my $sig_nospace = $line; 19847e51f197SJoe Perches $sig_nospace =~ s/\s//g; 19857e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 19867e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 19877e51f197SJoe Perches WARN("BAD_SIGN_OFF", 19887e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 19897e51f197SJoe Perches } else { 19907e51f197SJoe Perches $signatures{$sig_nospace} = 1; 19917e51f197SJoe Perches } 19920a920b5bSAndy Whitcroft } 19930a920b5bSAndy Whitcroft 19949b3189ebSJoe Perches# Check for old stable address 19959b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 19969b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 19979b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 19989b3189ebSJoe Perches } 19999b3189ebSJoe Perches 20007ebd05efSChristopher Covington# Check for unwanted Gerrit info 20017ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 20027ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 20037ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 20047ebd05efSChristopher Covington } 20057ebd05efSChristopher Covington 2006d311cd44SJoe Perches# Check for improperly formed commit descriptions 2007d311cd44SJoe Perches if ($in_commit_log && 2008d311cd44SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}/i && 2009d311cd44SJoe Perches $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) { 2010d311cd44SJoe Perches $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i; 2011d311cd44SJoe Perches my $init_char = $1; 2012d311cd44SJoe Perches my $orig_commit = lc($2); 2013d311cd44SJoe Perches my $id = '01234567890ab'; 2014d311cd44SJoe Perches my $desc = 'commit description'; 2015d311cd44SJoe Perches ($id, $desc) = git_commit_info($orig_commit, $id, $desc); 2016d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 2017d311cd44SJoe Perches "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr); 2018d311cd44SJoe Perches } 2019d311cd44SJoe Perches 202013f1937eSJoe Perches# Check for added, moved or deleted files 202113f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 202213f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 202313f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 202413f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 202513f1937eSJoe Perches (defined($1) || defined($2))))) { 202613f1937eSJoe Perches $reported_maintainer_file = 1; 202713f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 202813f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 202913f1937eSJoe Perches } 203013f1937eSJoe Perches 203100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 20328905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2033000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2034000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 20356c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2036de7d4f0eSAndy Whitcroft } 2037de7d4f0eSAndy Whitcroft 20386ecd9674SAndy Whitcroft# Check for absolute kernel paths. 20396ecd9674SAndy Whitcroft if ($tree) { 20406ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 20416ecd9674SAndy Whitcroft my $file = $1; 20426ecd9674SAndy Whitcroft 20436ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 20446ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 20456ecd9674SAndy Whitcroft # 20466ecd9674SAndy Whitcroft } else { 20476ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 20486ecd9674SAndy Whitcroft } 20496ecd9674SAndy Whitcroft } 20506ecd9674SAndy Whitcroft } 20516ecd9674SAndy Whitcroft 2052de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2053de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2054171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2055171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2056171ae1a4SAndy Whitcroft 2057171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2058171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2059171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2060171ae1a4SAndy Whitcroft 206134d99219SJoe Perches CHK("INVALID_UTF8", 2062000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 206300df344fSAndy Whitcroft } 20640a920b5bSAndy Whitcroft 206515662b3eSJoe Perches# Check if it's the start of a commit log 206615662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 206715662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 206829ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 206929ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 207015662b3eSJoe Perches $in_header_lines = 0; 207115662b3eSJoe Perches $in_commit_log = 1; 207215662b3eSJoe Perches } 207315662b3eSJoe Perches 2074fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2075fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2076fa64205dSPasi Savanainen if ($in_header_lines && 2077fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2078fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2079fa64205dSPasi Savanainen $non_utf8_charset = 1; 2080fa64205dSPasi Savanainen } 2081fa64205dSPasi Savanainen 2082fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 208315662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2084fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 208515662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 208615662b3eSJoe Perches } 208715662b3eSJoe Perches 208830670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 208930670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 209000df344fSAndy Whitcroft 20910a920b5bSAndy Whitcroft#trailing whitespace 20929c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2093c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2094d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2095d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2096d5e616fcSJoe Perches $fix) { 2097*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2098d5e616fcSJoe Perches } 2099c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2100c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21013705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 21023705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 21033705ce5bSJoe Perches $fix) { 2104*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 21053705ce5bSJoe Perches } 21063705ce5bSJoe Perches 2107d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21080a920b5bSAndy Whitcroft } 21095368df20SAndy Whitcroft 21104783f894SJosh Triplett# Check for FSF mailing addresses. 2111109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 21123e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 21133e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 21144783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21154783f894SJosh Triplett my $msg_type = \&ERROR; 21164783f894SJosh Triplett $msg_type = \&CHK if ($file); 21174783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 21184783f894SJosh 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) 21194783f894SJosh Triplett } 21204783f894SJosh Triplett 21213354957aSAndi Kleen# check for Kconfig help text having a real description 21229fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 21239fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 21243354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 21258d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 21263354957aSAndi Kleen my $length = 0; 21279fe287d7SAndy Whitcroft my $cnt = $realcnt; 21289fe287d7SAndy Whitcroft my $ln = $linenr + 1; 21299fe287d7SAndy Whitcroft my $f; 2130a1385803SAndy Whitcroft my $is_start = 0; 21319fe287d7SAndy Whitcroft my $is_end = 0; 2132a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 21339fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 21349fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 21359fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 21369fe287d7SAndy Whitcroft 21379fe287d7SAndy Whitcroft next if ($f =~ /^-/); 21388d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2139a1385803SAndy Whitcroft 21408d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2141a1385803SAndy Whitcroft $is_start = 1; 21428d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2143a1385803SAndy Whitcroft $length = -1; 2144a1385803SAndy Whitcroft } 2145a1385803SAndy Whitcroft 21469fe287d7SAndy Whitcroft $f =~ s/^.//; 21473354957aSAndi Kleen $f =~ s/#.*//; 21483354957aSAndi Kleen $f =~ s/^\s+//; 21493354957aSAndi Kleen next if ($f =~ /^$/); 21509fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 21519fe287d7SAndy Whitcroft $is_end = 1; 21529fe287d7SAndy Whitcroft last; 21539fe287d7SAndy Whitcroft } 21543354957aSAndi Kleen $length++; 21553354957aSAndi Kleen } 2156000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2157a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2158a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 21593354957aSAndi Kleen } 21603354957aSAndi Kleen 21611ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 21621ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 21631ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 21641ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 21651ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 21661ba8dfd1SKees Cook } 21671ba8dfd1SKees Cook 2168c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2169c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2170c68e5878SArnaud Lacombe my $flag = $1; 2171c68e5878SArnaud Lacombe my $replacement = { 2172c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2173c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2174c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2175c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2176c68e5878SArnaud Lacombe }; 2177c68e5878SArnaud Lacombe 2178c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2179c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2180c68e5878SArnaud Lacombe } 2181c68e5878SArnaud Lacombe 2182bff5da43SRob Herring# check for DT compatible documentation 21837dd05b38SFlorian Vaussard if (defined $root && 21847dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 21857dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 21867dd05b38SFlorian Vaussard 2187bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2188bff5da43SRob Herring 2189cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2190cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2191cc93319bSFlorian Vaussard 2192bff5da43SRob Herring foreach my $compat (@compats) { 2193bff5da43SRob Herring my $compat2 = $compat; 2194185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2195185d566bSRob Herring my $compat3 = $compat; 2196185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2197185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2198bff5da43SRob Herring if ( $? >> 8 ) { 2199bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2200bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2201bff5da43SRob Herring } 2202bff5da43SRob Herring 22034fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 22044fbf32a6SFlorian Vaussard my $vendor = $1; 2205cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2206bff5da43SRob Herring if ( $? >> 8 ) { 2207bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2208cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2209bff5da43SRob Herring } 2210bff5da43SRob Herring } 2211bff5da43SRob Herring } 2212bff5da43SRob Herring 22135368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 22145368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 22155368df20SAndy Whitcroft 22166cd7f386SJoe Perches#line length limit 2217c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2218f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 22190fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 22208bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 22216cd7f386SJoe Perches $length > $max_line_length) 2222c45dcabdSAndy Whitcroft { 2223000d1cc1SJoe Perches WARN("LONG_LINE", 22246cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 22250a920b5bSAndy Whitcroft } 22260a920b5bSAndy Whitcroft 2227ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 22288c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 22298c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 22308c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2231ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2232ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 22338c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2234ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2235ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2236ca56dc09SJosh Triplett } 2237ca56dc09SJosh Triplett 22385e79d96eSJoe Perches# check for spaces before a quoted newline 22395e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 22403705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 22413705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 22423705ce5bSJoe Perches $fix) { 2243*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 22443705ce5bSJoe Perches } 22453705ce5bSJoe Perches 22465e79d96eSJoe Perches } 22475e79d96eSJoe Perches 22488905a67cSAndy Whitcroft# check for adding lines without a newline. 22498905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2250000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2251000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 22528905a67cSAndy Whitcroft } 22538905a67cSAndy Whitcroft 225442e41c54SMike Frysinger# Blackfin: use hi/lo macros 225542e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 225642e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 225742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2258000d1cc1SJoe Perches ERROR("LO_MACRO", 2259000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 226042e41c54SMike Frysinger } 226142e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 226242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2263000d1cc1SJoe Perches ERROR("HI_MACRO", 2264000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 226542e41c54SMike Frysinger } 226642e41c54SMike Frysinger } 226742e41c54SMike Frysinger 2268b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2269b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 22700a920b5bSAndy Whitcroft 22710a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 22720a920b5bSAndy Whitcroft# more than 8 must use tabs. 2273c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2274c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2275c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2276d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 22773705ce5bSJoe Perches if (ERROR("CODE_INDENT", 22783705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 22793705ce5bSJoe Perches $fix) { 2280*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22813705ce5bSJoe Perches } 22820a920b5bSAndy Whitcroft } 22830a920b5bSAndy Whitcroft 228408e44365SAlberto Panizzo# check for space before tabs. 228508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 228608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22873705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 22883705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 22893705ce5bSJoe Perches $fix) { 2290*194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2291c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2292*194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2293c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 22943705ce5bSJoe Perches } 229508e44365SAlberto Panizzo } 229608e44365SAlberto Panizzo 2297d1fe9c09SJoe Perches# check for && or || at the start of a line 2298d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2299d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2300d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2301d1fe9c09SJoe Perches } 2302d1fe9c09SJoe Perches 2303d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2304d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 230591cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2306d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2307d1fe9c09SJoe Perches my $oldindent = $1; 2308d1fe9c09SJoe Perches my $rest = $2; 2309d1fe9c09SJoe Perches 2310d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2311d1fe9c09SJoe Perches if ($pos >= 0) { 2312b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2313b34a26f3SJoe Perches my $newindent = $2; 2314d1fe9c09SJoe Perches 2315d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2316d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2317d1fe9c09SJoe Perches " " x ($pos % 8); 2318d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2319d1fe9c09SJoe Perches 2320d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2321d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 23223705ce5bSJoe Perches 23233705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 23243705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 23253705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2326*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 23273705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 23283705ce5bSJoe Perches } 2329d1fe9c09SJoe Perches } 2330d1fe9c09SJoe Perches } 2331d1fe9c09SJoe Perches } 2332d1fe9c09SJoe Perches 2333f27c95dbSJoe Perches if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 23343705ce5bSJoe Perches if (CHK("SPACING", 2335f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 23363705ce5bSJoe Perches $fix) { 2337*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2338f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 23393705ce5bSJoe Perches } 2340aad4f614SJoe Perches } 2341aad4f614SJoe Perches 234205880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2343fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 234485ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 234585ad978cSJoe Perches $realline > 2) { 234605880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 234705880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 234805880600SJoe Perches } 234905880600SJoe Perches 235005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2351a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2352a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 235361135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2354a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2355a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2356a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2357a605e32eSJoe Perches } 2358a605e32eSJoe Perches 2359a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2360c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2361c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2362c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2363c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 236405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 236505880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 236605880600SJoe Perches } 236705880600SJoe Perches 23687f619191SJoe Perches# check for missing blank lines after struct/union declarations 23697f619191SJoe Perches# with exceptions for various attributes and macros 23707f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 23717f619191SJoe Perches $line =~ /^\+/ && 23727f619191SJoe Perches !($line =~ /^\+\s*$/ || 23737f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 23747f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 23757f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 23767f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 23777f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 23787f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 23797f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 23807f619191SJoe Perches CHK("LINE_SPACING", 23817f619191SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev); 23827f619191SJoe Perches } 23837f619191SJoe Perches 2384365dd4eaSJoe Perches# check for multiple consecutive blank lines 2385365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2386365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2387365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2388365dd4eaSJoe Perches CHK("LINE_SPACING", 2389365dd4eaSJoe Perches "Please don't use multiple blank lines\n" . $hereprev); 2390365dd4eaSJoe Perches $last_blank_line = $linenr; 2391365dd4eaSJoe Perches } 2392365dd4eaSJoe Perches 23933b617e3bSJoe Perches# check for missing blank lines after declarations 23943f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 23953f7bac03SJoe Perches # actual declarations 23963f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 23975a4e1fd3SJoe Perches # function pointer declarations 23985a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 23993f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 24003f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 24013f7bac03SJoe Perches # known declaration macros 24023f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 24033f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 24043f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 24053f7bac03SJoe Perches # other possible extensions of declaration lines 24063f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 24073f7bac03SJoe Perches # not starting a section or a macro "\" extended line 24083f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 24093f7bac03SJoe Perches # looks like a declaration 24103f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 24115a4e1fd3SJoe Perches # function pointer declarations 24125a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 24133f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 24143f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 24153f7bac03SJoe Perches # known declaration macros 24163f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 24173f7bac03SJoe Perches # start of struct or union or enum 24183b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 24193f7bac03SJoe Perches # start or end of block or continuation of declaration 24203f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 24213f7bac03SJoe Perches # bitfield continuation 24223f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 24233f7bac03SJoe Perches # other possible extensions of declaration lines 24243f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 24253f7bac03SJoe Perches # indentation of previous and current line are the same 24263f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2427fee0aa83SJoe Perches WARN("LINE_SPACING", 24283f7bac03SJoe Perches "Missing a blank line after declarations\n" . $hereprev); 24293b617e3bSJoe Perches } 24303b617e3bSJoe Perches 24315f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 24326b4c5bebSAndy Whitcroft# Exceptions: 24336b4c5bebSAndy Whitcroft# 1) within comments 24346b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 24356b4c5bebSAndy Whitcroft# 3) hanging labels 24363705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 24375f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24383705ce5bSJoe Perches if (WARN("LEADING_SPACE", 24393705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 24403705ce5bSJoe Perches $fix) { 2441*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 24423705ce5bSJoe Perches } 24435f7ddae6SRaffaele Recalcati } 24445f7ddae6SRaffaele Recalcati 2445b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2446b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2447b9ea10d6SAndy Whitcroft 2448032a4c0fSJoe Perches# check indentation of any line with a bare else 2449032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2450032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2451032a4c0fSJoe Perches my $tabs = length($1) + 1; 2452032a4c0fSJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) { 2453032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2454032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2455032a4c0fSJoe Perches } 2456032a4c0fSJoe Perches } 2457032a4c0fSJoe Perches 2458c00df19aSJoe Perches# check indentation of a line with a break; 2459c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2460c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2461c00df19aSJoe Perches my $tabs = $1; 2462c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2463c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2464c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2465c00df19aSJoe Perches } 2466c00df19aSJoe Perches } 2467c00df19aSJoe Perches 24681ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 24691ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 24701ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 24711ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 24721ba8dfd1SKees Cook } 24731ba8dfd1SKees Cook 2474c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2475cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2476000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2477000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2478c2fdda0dSAndy Whitcroft } 247922f2a2efSAndy Whitcroft 248042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 248142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 248242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2483000d1cc1SJoe Perches ERROR("CSYNC", 2484000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 248542e41c54SMike Frysinger } 248642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 248742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2488000d1cc1SJoe Perches ERROR("SSYNC", 2489000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 249042e41c54SMike Frysinger } 249142e41c54SMike Frysinger 249256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 249356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 249456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 249556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 249656e77d70SJoe Perches } 249756e77d70SJoe Perches 24989c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 24992b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 25002b474a1aSAndy Whitcroft $realline_next); 25013e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 25023e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 25031b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2504170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2505f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2506171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2507171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2508171ae1a4SAndy Whitcroft 25093e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 25103e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 25113e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 25123e469cdcSAndy Whitcroft # until we hit end of it. 25133e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 25143e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 25153e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 25163e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 25173e469cdcSAndy Whitcroft } 2518f74bd194SAndy Whitcroft 25192b474a1aSAndy Whitcroft # Find the real next line. 25202b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 25212b474a1aSAndy Whitcroft if (defined $realline_next && 25222b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 25232b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 25242b474a1aSAndy Whitcroft $realline_next++; 25252b474a1aSAndy Whitcroft } 25262b474a1aSAndy Whitcroft 2527171ae1a4SAndy Whitcroft my $s = $stat; 2528171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2529cf655043SAndy Whitcroft 2530c2fdda0dSAndy Whitcroft # Ignore goto labels. 2531171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2532c2fdda0dSAndy Whitcroft 2533c2fdda0dSAndy Whitcroft # Ignore functions being called 2534171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2535c2fdda0dSAndy Whitcroft 2536463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2537463f2864SAndy Whitcroft 2538c45dcabdSAndy Whitcroft # declarations always start with types 2539d2506586SAndy 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) { 2540c45dcabdSAndy Whitcroft my $type = $1; 2541c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2542c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2543c45dcabdSAndy Whitcroft 25446c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2545a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2546c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2547c2fdda0dSAndy Whitcroft } 25488905a67cSAndy Whitcroft 25496c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 255065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2551c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 25529c0ca6f9SAndy Whitcroft } 25538905a67cSAndy Whitcroft 25548905a67cSAndy Whitcroft # Check for any sort of function declaration. 25558905a67cSAndy Whitcroft # int foo(something bar, other baz); 25568905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2557171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 25588905a67cSAndy Whitcroft my ($name_len) = length($1); 25598905a67cSAndy Whitcroft 2560cf655043SAndy Whitcroft my $ctx = $s; 2561773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 25628905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2563cf655043SAndy Whitcroft 25648905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2565c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 25668905a67cSAndy Whitcroft 2567c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 25688905a67cSAndy Whitcroft } 25698905a67cSAndy Whitcroft } 25708905a67cSAndy Whitcroft } 25718905a67cSAndy Whitcroft 25729c0ca6f9SAndy Whitcroft } 25739c0ca6f9SAndy Whitcroft 257400df344fSAndy Whitcroft# 257500df344fSAndy Whitcroft# Checks which may be anchored in the context. 257600df344fSAndy Whitcroft# 257700df344fSAndy Whitcroft 257800df344fSAndy Whitcroft# Check for switch () and associated case and default 257900df344fSAndy Whitcroft# statements should be at the same indent. 258000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 258100df344fSAndy Whitcroft my $err = ''; 258200df344fSAndy Whitcroft my $sep = ''; 258300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 258400df344fSAndy Whitcroft shift(@ctx); 258500df344fSAndy Whitcroft for my $ctx (@ctx) { 258600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 258700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 258800df344fSAndy Whitcroft $indent != $cindent) { 258900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 259000df344fSAndy Whitcroft $sep = ''; 259100df344fSAndy Whitcroft } else { 259200df344fSAndy Whitcroft $sep = "[...]\n"; 259300df344fSAndy Whitcroft } 259400df344fSAndy Whitcroft } 259500df344fSAndy Whitcroft if ($err ne '') { 2596000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2597000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2598de7d4f0eSAndy Whitcroft } 2599de7d4f0eSAndy Whitcroft } 2600de7d4f0eSAndy Whitcroft 2601de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2602de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2603c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2604773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2605773647a0SAndy Whitcroft 26069c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 26078eef05ddSJoe Perches 26088eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 26098eef05ddSJoe Perches WARN("DEEP_INDENTATION", 26108eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 26118eef05ddSJoe Perches } 26128eef05ddSJoe Perches 2613de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2614de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2615de7d4f0eSAndy Whitcroft 2616548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2617548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2618de7d4f0eSAndy Whitcroft 2619548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2620548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2621548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2622548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2623548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2624773647a0SAndy Whitcroft $ctx_ln++; 2625773647a0SAndy Whitcroft } 2626548596d5SAndy Whitcroft 262753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 262853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2629773647a0SAndy Whitcroft 2630773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2631000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2632000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 263301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 263400df344fSAndy Whitcroft } 2635773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2636773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2637773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2638773647a0SAndy Whitcroft { 26399c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 26409c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2641000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2642000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 264301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 26449c0ca6f9SAndy Whitcroft } 26459c0ca6f9SAndy Whitcroft } 264600df344fSAndy Whitcroft } 264700df344fSAndy Whitcroft 26484d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 26494d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 26503e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 26513e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 26523e469cdcSAndy Whitcroft if (!defined $stat); 26534d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 26544d001e4dSAndy Whitcroft 26554d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 26564d001e4dSAndy Whitcroft 26574d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 26584d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 26594d001e4dSAndy Whitcroft # where necessary. 26604d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 26614d001e4dSAndy Whitcroft 26624d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 26636f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 26646f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 26654d001e4dSAndy Whitcroft 26664d001e4dSAndy Whitcroft # We want to check the first line inside the block 26674d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 26684d001e4dSAndy Whitcroft # 1) any blank line termination 26694d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 26704d001e4dSAndy Whitcroft # 3) any do (...) { 26714d001e4dSAndy Whitcroft my $continuation = 0; 26724d001e4dSAndy Whitcroft my $check = 0; 26734d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 26744d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 26754d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 26764d001e4dSAndy Whitcroft $continuation = 1; 26774d001e4dSAndy Whitcroft } 26789bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 26794d001e4dSAndy Whitcroft $check = 1; 26804d001e4dSAndy Whitcroft $cond_lines++; 26814d001e4dSAndy Whitcroft } 26824d001e4dSAndy Whitcroft 26834d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 26844d001e4dSAndy Whitcroft # preprocessor statement. 26854d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 26864d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 26874d001e4dSAndy Whitcroft $check = 0; 26884d001e4dSAndy Whitcroft } 26894d001e4dSAndy Whitcroft 26909bd49efeSAndy Whitcroft my $cond_ptr = -1; 2691740504c6SAndy Whitcroft $continuation = 0; 26929bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 26939bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 26944d001e4dSAndy Whitcroft 2695f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2696f16fa28fSAndy Whitcroft # is not linear. 2697f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2698f16fa28fSAndy Whitcroft $check = 0; 2699f16fa28fSAndy Whitcroft } 2700f16fa28fSAndy Whitcroft 27019bd49efeSAndy Whitcroft # Ignore: 27029bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 27039bd49efeSAndy Whitcroft # 2) preprocessor lines, and 27049bd49efeSAndy Whitcroft # 3) labels. 2705740504c6SAndy Whitcroft if ($continuation || 2706740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 27079bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 27089bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2709740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 271030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 27119bd49efeSAndy Whitcroft $cond_lines++; 27129bd49efeSAndy Whitcroft } 27134d001e4dSAndy Whitcroft } 271430dad6ebSAndy Whitcroft } 27154d001e4dSAndy Whitcroft 27164d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 27174d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 27184d001e4dSAndy Whitcroft 27194d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 27204d001e4dSAndy Whitcroft # this is not this patch's fault. 27214d001e4dSAndy Whitcroft if (!defined($stat_real) || 27224d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 27234d001e4dSAndy Whitcroft $check = 0; 27244d001e4dSAndy Whitcroft } 27254d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 27264d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 27274d001e4dSAndy Whitcroft } 27284d001e4dSAndy Whitcroft 27299bd49efeSAndy 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"; 27304d001e4dSAndy Whitcroft 27314d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 27324d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2733000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2734000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 27354d001e4dSAndy Whitcroft } 27364d001e4dSAndy Whitcroft } 27374d001e4dSAndy Whitcroft 27386c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 27396c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 27401f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 27411f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 27426c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2743c2fdda0dSAndy Whitcroft if ($dbg_values) { 2744c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2745cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2746cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 27471f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2748c2fdda0dSAndy Whitcroft } 27496c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 27506c72ffaaSAndy Whitcroft 275100df344fSAndy Whitcroft#ignore lines not being added 27523705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 275300df344fSAndy Whitcroft 2754653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 27557429c690SAndy Whitcroft if ($dbg_type) { 27567429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2757000d1cc1SJoe Perches ERROR("TEST_TYPE", 2758000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 27597429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2760000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2761000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 27627429c690SAndy Whitcroft } 2763653d4876SAndy Whitcroft next; 2764653d4876SAndy Whitcroft } 2765a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2766a1ef277eSAndy Whitcroft if ($dbg_attr) { 27679360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2768000d1cc1SJoe Perches ERROR("TEST_ATTR", 2769000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 27709360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2771000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2772000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2773a1ef277eSAndy Whitcroft } 2774a1ef277eSAndy Whitcroft next; 2775a1ef277eSAndy Whitcroft } 2776653d4876SAndy Whitcroft 2777f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 277899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 277999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2780000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2781000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2782f0a594c1SAndy Whitcroft } 2783f0a594c1SAndy Whitcroft 278400df344fSAndy Whitcroft# 278500df344fSAndy Whitcroft# Checks which are anchored on the added line. 278600df344fSAndy Whitcroft# 278700df344fSAndy Whitcroft 2788653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2789c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2790653d4876SAndy Whitcroft my $path = $1; 2791653d4876SAndy Whitcroft if ($path =~ m{//}) { 2792000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2793495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2794495e9d84SJoe Perches } 2795495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2796495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2797495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2798653d4876SAndy Whitcroft } 2799653d4876SAndy Whitcroft } 2800653d4876SAndy Whitcroft 280100df344fSAndy Whitcroft# no C99 // comments 280200df344fSAndy Whitcroft if ($line =~ m{//}) { 28033705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 28043705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 28053705ce5bSJoe Perches $fix) { 2806*194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 28073705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 28083705ce5bSJoe Perches my $comment = trim($1); 2809*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 28103705ce5bSJoe Perches } 28113705ce5bSJoe Perches } 281200df344fSAndy Whitcroft } 281300df344fSAndy Whitcroft # Remove C99 comments. 28140a920b5bSAndy Whitcroft $line =~ s@//.*@@; 28156c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 28160a920b5bSAndy Whitcroft 28172b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 28182b474a1aSAndy Whitcroft# the whole statement. 28192b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 28202b474a1aSAndy Whitcroft if (defined $realline_next && 28212b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 28222b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 28232b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 28242b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 28253cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 28263cbf62dfSAndy Whitcroft # a prefix: 28273cbf62dfSAndy Whitcroft # XXX(foo); 28283cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2829653d4876SAndy Whitcroft my $name = $1; 283087a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 28313cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 28323cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 28333cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 28343cbf62dfSAndy Whitcroft 28353cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 28362b474a1aSAndy Whitcroft \n.}\s*$| 283748012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 283848012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 283948012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 28402b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 28412b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 284248012058SAndy Whitcroft )/x) { 28432b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 28442b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 28452b474a1aSAndy Whitcroft } else { 28462b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 28470a920b5bSAndy Whitcroft } 28480a920b5bSAndy Whitcroft } 28492b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 28502b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 28512b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 28522b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 28532b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 28542b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 28552b474a1aSAndy Whitcroft } 28562b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 28572b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2858000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2859000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 28602b474a1aSAndy Whitcroft } 28610a920b5bSAndy Whitcroft 28625150bda4SJoe Eloff# check for global initialisers. 2863d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2864d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2865000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2866d5e616fcSJoe Perches $herecurr) && 2867d5e616fcSJoe Perches $fix) { 2868*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2869d5e616fcSJoe Perches } 2870f0a594c1SAndy Whitcroft } 28710a920b5bSAndy Whitcroft# check for static initialisers. 2872d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2873d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2874000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2875d5e616fcSJoe Perches $herecurr) && 2876d5e616fcSJoe Perches $fix) { 2877*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2878d5e616fcSJoe Perches } 28790a920b5bSAndy Whitcroft } 28800a920b5bSAndy Whitcroft 2881cb710ecaSJoe Perches# check for static const char * arrays. 2882cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2883000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2884000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2885cb710ecaSJoe Perches $herecurr); 2886cb710ecaSJoe Perches } 2887cb710ecaSJoe Perches 2888cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2889cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2890000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2891000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2892cb710ecaSJoe Perches $herecurr); 2893cb710ecaSJoe Perches } 2894cb710ecaSJoe Perches 28959b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 28969b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 28979b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 28989b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 28999b0fa60dSJoe Perches $herecurr); 29009b0fa60dSJoe Perches } 29019b0fa60dSJoe Perches 2902b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 2903b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 2904b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 2905b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 2906b36190c5SJoe Perches $fix) { 2907*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 2908b36190c5SJoe Perches } 2909b36190c5SJoe Perches } 2910b36190c5SJoe Perches 291192e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 291292e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 291392e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 291492e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 291592e112fdSJoe Perches $fix) { 2916*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 291792e112fdSJoe Perches } 291893ed0e2dSJoe Perches } 291993ed0e2dSJoe Perches 2920653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2921653d4876SAndy Whitcroft# make sense. 2922653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 29238054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2924c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 29258ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2926653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2927000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2928000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 29290a920b5bSAndy Whitcroft } 29300a920b5bSAndy Whitcroft 29310a920b5bSAndy Whitcroft# * goes on variable not on type 293265863862SAndy Whitcroft # (char*[ const]) 2933bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2934bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 29353705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2936d8aaf121SAndy Whitcroft 293765863862SAndy Whitcroft # Should start with a space. 293865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 293965863862SAndy Whitcroft # Should not end with a space. 294065863862SAndy Whitcroft $to =~ s/\s+$//; 294165863862SAndy Whitcroft # '*'s should not have spaces between. 2942f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 294365863862SAndy Whitcroft } 2944d8aaf121SAndy Whitcroft 29453705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 294665863862SAndy Whitcroft if ($from ne $to) { 29473705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 29483705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 29493705ce5bSJoe Perches $fix) { 29503705ce5bSJoe Perches my $sub_from = $ident; 29513705ce5bSJoe Perches my $sub_to = $ident; 29523705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 2953*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 29543705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 29553705ce5bSJoe Perches } 295665863862SAndy Whitcroft } 2957bfcb2cc7SAndy Whitcroft } 2958bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2959bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 29603705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2961d8aaf121SAndy Whitcroft 296265863862SAndy Whitcroft # Should start with a space. 296365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 296465863862SAndy Whitcroft # Should not end with a space. 296565863862SAndy Whitcroft $to =~ s/\s+$//; 296665863862SAndy Whitcroft # '*'s should not have spaces between. 2967f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 296865863862SAndy Whitcroft } 296965863862SAndy Whitcroft # Modifiers should have spaces. 297065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 297165863862SAndy Whitcroft 29723705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2973667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 29743705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 29753705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 29763705ce5bSJoe Perches $fix) { 29773705ce5bSJoe Perches 29783705ce5bSJoe Perches my $sub_from = $match; 29793705ce5bSJoe Perches my $sub_to = $match; 29803705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 2981*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 29823705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 29833705ce5bSJoe Perches } 298465863862SAndy Whitcroft } 29850a920b5bSAndy Whitcroft } 29860a920b5bSAndy Whitcroft 29870a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 29880a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 29890a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 29900a920b5bSAndy Whitcroft# print "$herecurr"; 29910a920b5bSAndy Whitcroft# $clean = 0; 29920a920b5bSAndy Whitcroft# } 29930a920b5bSAndy Whitcroft 29948905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2995000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2996000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 29978905a67cSAndy Whitcroft } 29988905a67cSAndy Whitcroft 299917441227SJoe Perches# check for uses of printk_ratelimit 300017441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3001000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3002000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 300317441227SJoe Perches } 300417441227SJoe Perches 300500df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 300600df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 300700df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 300825985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 300900df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3010f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 301100df344fSAndy Whitcroft my $ok = 0; 301200df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 301300df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 301425985edcSLucas De Marchi # we have a preceding printk if it ends 301500df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 301600df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 301700df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 301800df344fSAndy Whitcroft $ok = 1; 301900df344fSAndy Whitcroft } 302000df344fSAndy Whitcroft last; 302100df344fSAndy Whitcroft } 302200df344fSAndy Whitcroft } 302300df344fSAndy Whitcroft if ($ok == 0) { 3024000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3025000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 30260a920b5bSAndy Whitcroft } 302700df344fSAndy Whitcroft } 30280a920b5bSAndy Whitcroft 3029243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3030243f3803SJoe Perches my $orig = $1; 3031243f3803SJoe Perches my $level = lc($orig); 3032243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 30338f26b837SJoe Perches my $level2 = $level; 30348f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3035243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3036daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3037243f3803SJoe Perches } 3038243f3803SJoe Perches 3039243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3040d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3041d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3042d5e616fcSJoe Perches $fix) { 3043*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3044d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3045d5e616fcSJoe Perches } 3046243f3803SJoe Perches } 3047243f3803SJoe Perches 3048dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3049dc139313SJoe Perches my $orig = $1; 3050dc139313SJoe Perches my $level = lc($orig); 3051dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3052dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3053dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3054dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3055dc139313SJoe Perches } 3056dc139313SJoe Perches 3057653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3058653d4876SAndy Whitcroft# or if closed on same line 3059c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 3060c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 3061000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3062000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 30630a920b5bSAndy Whitcroft } 3064653d4876SAndy Whitcroft 30658905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 30668905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 30678905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 3068000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3069000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 30708905a67cSAndy Whitcroft } 30718905a67cSAndy Whitcroft 30720c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 30733705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 30743705ce5bSJoe Perches if (WARN("SPACING", 30753705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 30763705ce5bSJoe Perches $fix) { 3077*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 30783705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 30793705ce5bSJoe Perches } 30800c73b4ebSAndy Whitcroft } 30810c73b4ebSAndy Whitcroft 308231070b5dSJoe Perches# Function pointer declarations 308331070b5dSJoe Perches# check spacing between type, funcptr, and args 308431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 308591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 308631070b5dSJoe Perches my $declare = $1; 308731070b5dSJoe Perches my $pre_pointer_space = $2; 308831070b5dSJoe Perches my $post_pointer_space = $3; 308931070b5dSJoe Perches my $funcname = $4; 309031070b5dSJoe Perches my $post_funcname_space = $5; 309131070b5dSJoe Perches my $pre_args_space = $6; 309231070b5dSJoe Perches 309391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 309491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 309591f72e9cSJoe Perches# don't need a space so don't warn for those. 309691f72e9cSJoe Perches my $post_declare_space = ""; 309791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 309891f72e9cSJoe Perches $post_declare_space = $1; 309991f72e9cSJoe Perches $declare = rtrim($declare); 310091f72e9cSJoe Perches } 310191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 310231070b5dSJoe Perches WARN("SPACING", 310331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 310491f72e9cSJoe Perches $post_declare_space = " "; 310531070b5dSJoe Perches } 310631070b5dSJoe Perches 310731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 310891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 310991f72e9cSJoe Perches# equivalent to 311091f72e9cSJoe Perches# int foo(int bar, ...) 311191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 311291f72e9cSJoe Perches# 311391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 311491f72e9cSJoe Perches# WARN("SPACING", 311591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 311691f72e9cSJoe Perches# } 311731070b5dSJoe Perches 311831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 311931070b5dSJoe Perches if (defined $pre_pointer_space && 312031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 312131070b5dSJoe Perches WARN("SPACING", 312231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 312331070b5dSJoe Perches } 312431070b5dSJoe Perches 312531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 312631070b5dSJoe Perches if (defined $post_pointer_space && 312731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 312831070b5dSJoe Perches WARN("SPACING", 312931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 313031070b5dSJoe Perches } 313131070b5dSJoe Perches 313231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 313331070b5dSJoe Perches if (defined $post_funcname_space && 313431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 313531070b5dSJoe Perches WARN("SPACING", 313631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 313731070b5dSJoe Perches } 313831070b5dSJoe Perches 313931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 314031070b5dSJoe Perches if (defined $pre_args_space && 314131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 314231070b5dSJoe Perches WARN("SPACING", 314331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 314431070b5dSJoe Perches } 314531070b5dSJoe Perches 314631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3147*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 314891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 314931070b5dSJoe Perches } 315031070b5dSJoe Perches } 315131070b5dSJoe Perches 31528d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 31538d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3154fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3155fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 31568d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 31578d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 31588d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3159fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3160daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 31613705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 31623705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 31633705ce5bSJoe Perches $fix) { 3164*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31653705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 31663705ce5bSJoe Perches } 31678d31cfceSAndy Whitcroft } 31688d31cfceSAndy Whitcroft } 31698d31cfceSAndy Whitcroft 3170f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 31716c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3172c2fdda0dSAndy Whitcroft my $name = $1; 3173773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3174773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3175c2fdda0dSAndy Whitcroft 3176c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3177773647a0SAndy Whitcroft if ($name =~ /^(?: 3178773647a0SAndy Whitcroft if|for|while|switch|return|case| 3179773647a0SAndy Whitcroft volatile|__volatile__| 3180773647a0SAndy Whitcroft __attribute__|format|__extension__| 3181773647a0SAndy Whitcroft asm|__asm__)$/x) 3182773647a0SAndy Whitcroft { 3183c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3184c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3185c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3186c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3187773647a0SAndy Whitcroft 3188773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3189c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3190c2fdda0dSAndy Whitcroft 3191c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3192c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3193773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3194c2fdda0dSAndy Whitcroft 3195c2fdda0dSAndy Whitcroft } else { 31963705ce5bSJoe Perches if (WARN("SPACING", 31973705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 31983705ce5bSJoe Perches $fix) { 3199*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32003705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 32013705ce5bSJoe Perches } 3202f0a594c1SAndy Whitcroft } 32036c72ffaaSAndy Whitcroft } 32049a4cad4eSEric Nelson 3205653d4876SAndy Whitcroft# Check operator spacing. 32060a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 32073705ce5bSJoe Perches my $fixed_line = ""; 32083705ce5bSJoe Perches my $line_fixed = 0; 32093705ce5bSJoe Perches 32109c0ca6f9SAndy Whitcroft my $ops = qr{ 32119c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 32129c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 32139c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 32141f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 321584731623SJoe Perches \?:|\?|: 32169c0ca6f9SAndy Whitcroft }x; 3217cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 32183705ce5bSJoe Perches 32193705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 32203705ce5bSJoe Perches## foreach my $el (@elements) { 32213705ce5bSJoe Perches## print("el: <$el>\n"); 32223705ce5bSJoe Perches## } 32233705ce5bSJoe Perches 32243705ce5bSJoe Perches my @fix_elements = (); 322500df344fSAndy Whitcroft my $off = 0; 32266c72ffaaSAndy Whitcroft 32273705ce5bSJoe Perches foreach my $el (@elements) { 32283705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 32293705ce5bSJoe Perches $off += length($el); 32303705ce5bSJoe Perches } 32313705ce5bSJoe Perches 32323705ce5bSJoe Perches $off = 0; 32333705ce5bSJoe Perches 32346c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3235b34c648bSJoe Perches my $last_after = -1; 32366c72ffaaSAndy Whitcroft 32370a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 32383705ce5bSJoe Perches 32393705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 32403705ce5bSJoe Perches 32413705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 32423705ce5bSJoe Perches 32434a0df2efSAndy Whitcroft $off += length($elements[$n]); 32444a0df2efSAndy Whitcroft 324525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3246773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3247773647a0SAndy Whitcroft my $cc = ''; 3248773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3249773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3250773647a0SAndy Whitcroft } 3251773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3252773647a0SAndy Whitcroft 32534a0df2efSAndy Whitcroft my $a = ''; 32544a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 32554a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3256cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 32574a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 32584a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3259773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 32604a0df2efSAndy Whitcroft 32610a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 32624a0df2efSAndy Whitcroft 32634a0df2efSAndy Whitcroft my $c = ''; 32640a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 32654a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 32664a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3267cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 32684a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 32694a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 32708b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 32714a0df2efSAndy Whitcroft } else { 32724a0df2efSAndy Whitcroft $c = 'E'; 32730a920b5bSAndy Whitcroft } 32740a920b5bSAndy Whitcroft 32754a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 32764a0df2efSAndy Whitcroft 32774a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 32784a0df2efSAndy Whitcroft 32796c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3280de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 32810a920b5bSAndy Whitcroft 328274048ed8SAndy Whitcroft # Pull out the value of this operator. 32836c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 32840a920b5bSAndy Whitcroft 32851f65f947SAndy Whitcroft # Get the full operator variant. 32861f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 32871f65f947SAndy Whitcroft 328813214adfSAndy Whitcroft # Ignore operators passed as parameters. 328913214adfSAndy Whitcroft if ($op_type ne 'V' && 329013214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 329113214adfSAndy Whitcroft 3292cf655043SAndy Whitcroft# # Ignore comments 3293cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 329413214adfSAndy Whitcroft 3295d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 329613214adfSAndy Whitcroft } elsif ($op eq ';') { 3297cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3298cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 32993705ce5bSJoe Perches if (ERROR("SPACING", 33003705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3301b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 33023705ce5bSJoe Perches $line_fixed = 1; 33033705ce5bSJoe Perches } 3304d8aaf121SAndy Whitcroft } 3305d8aaf121SAndy Whitcroft 3306d8aaf121SAndy Whitcroft # // is a comment 3307d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 33080a920b5bSAndy Whitcroft 3309b00e4814SJoe Perches # : when part of a bitfield 3310b00e4814SJoe Perches } elsif ($opv eq ':B') { 3311b00e4814SJoe Perches # skip the bitfield test for now 3312b00e4814SJoe Perches 33131f65f947SAndy Whitcroft # No spaces for: 33141f65f947SAndy Whitcroft # -> 3315b00e4814SJoe Perches } elsif ($op eq '->') { 33164a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 33173705ce5bSJoe Perches if (ERROR("SPACING", 33183705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3319b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 33203705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 33213705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 33223705ce5bSJoe Perches } 3323b34c648bSJoe Perches $line_fixed = 1; 33243705ce5bSJoe Perches } 33250a920b5bSAndy Whitcroft } 33260a920b5bSAndy Whitcroft 33270a920b5bSAndy Whitcroft # , must have a space on the right. 33280a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3329cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 33303705ce5bSJoe Perches if (ERROR("SPACING", 33313705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3332b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 33333705ce5bSJoe Perches $line_fixed = 1; 3334b34c648bSJoe Perches $last_after = $n; 33353705ce5bSJoe Perches } 33360a920b5bSAndy Whitcroft } 33370a920b5bSAndy Whitcroft 33389c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 333974048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 33409c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 33419c0ca6f9SAndy Whitcroft 33429c0ca6f9SAndy Whitcroft # unary operators should have a space before and 33439c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 33449c0ca6f9SAndy Whitcroft # unary operator, or a cast 33459c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 334674048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 33470d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3348cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 33493705ce5bSJoe Perches if (ERROR("SPACING", 33503705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3351b34c648bSJoe Perches if ($n != $last_after + 2) { 3352b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 33533705ce5bSJoe Perches $line_fixed = 1; 33543705ce5bSJoe Perches } 33550a920b5bSAndy Whitcroft } 3356b34c648bSJoe Perches } 3357a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3358171ae1a4SAndy Whitcroft # A unary '*' may be const 3359171ae1a4SAndy Whitcroft 3360171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 33613705ce5bSJoe Perches if (ERROR("SPACING", 33623705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3363b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 33643705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 33653705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 33663705ce5bSJoe Perches } 3367b34c648bSJoe Perches $line_fixed = 1; 33683705ce5bSJoe Perches } 33690a920b5bSAndy Whitcroft } 33700a920b5bSAndy Whitcroft 33710a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 33720a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3373773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 33743705ce5bSJoe Perches if (ERROR("SPACING", 33753705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3376b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 33773705ce5bSJoe Perches $line_fixed = 1; 33783705ce5bSJoe Perches } 33790a920b5bSAndy Whitcroft } 3380773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3381773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 33823705ce5bSJoe Perches if (ERROR("SPACING", 33833705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3384b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 33853705ce5bSJoe Perches $line_fixed = 1; 33863705ce5bSJoe Perches } 3387653d4876SAndy Whitcroft } 3388773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 33893705ce5bSJoe Perches if (ERROR("SPACING", 33903705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3391b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 33923705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 33933705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3394773647a0SAndy Whitcroft } 3395b34c648bSJoe Perches $line_fixed = 1; 33963705ce5bSJoe Perches } 33973705ce5bSJoe Perches } 33980a920b5bSAndy Whitcroft 33990a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 34009c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 34019c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 34029c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3403c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3404c2fdda0dSAndy Whitcroft $op eq '%') 34050a920b5bSAndy Whitcroft { 3406773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 34073705ce5bSJoe Perches if (ERROR("SPACING", 34083705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3409b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3410b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3411b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3412b34c648bSJoe Perches } 34133705ce5bSJoe Perches $line_fixed = 1; 34143705ce5bSJoe Perches } 34150a920b5bSAndy Whitcroft } 34160a920b5bSAndy Whitcroft 34171f65f947SAndy Whitcroft # A colon needs no spaces before when it is 34181f65f947SAndy Whitcroft # terminating a case value or a label. 34191f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 34201f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 34213705ce5bSJoe Perches if (ERROR("SPACING", 34223705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3423b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 34243705ce5bSJoe Perches $line_fixed = 1; 34253705ce5bSJoe Perches } 34261f65f947SAndy Whitcroft } 34271f65f947SAndy Whitcroft 34280a920b5bSAndy Whitcroft # All the others need spaces both sides. 3429cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 34301f65f947SAndy Whitcroft my $ok = 0; 34311f65f947SAndy Whitcroft 343222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 34331f65f947SAndy Whitcroft if (($op eq '<' && 34341f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 34351f65f947SAndy Whitcroft ($op eq '>' && 34361f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 34371f65f947SAndy Whitcroft { 34381f65f947SAndy Whitcroft $ok = 1; 34391f65f947SAndy Whitcroft } 34401f65f947SAndy Whitcroft 344184731623SJoe Perches # messages are ERROR, but ?: are CHK 34421f65f947SAndy Whitcroft if ($ok == 0) { 344384731623SJoe Perches my $msg_type = \&ERROR; 344484731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 344584731623SJoe Perches 344684731623SJoe Perches if (&{$msg_type}("SPACING", 34473705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3448b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3449b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3450b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3451b34c648bSJoe Perches } 34523705ce5bSJoe Perches $line_fixed = 1; 34533705ce5bSJoe Perches } 34540a920b5bSAndy Whitcroft } 345522f2a2efSAndy Whitcroft } 34564a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 34573705ce5bSJoe Perches 34583705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 34593705ce5bSJoe Perches 34603705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 34610a920b5bSAndy Whitcroft } 34623705ce5bSJoe Perches 34633705ce5bSJoe Perches if (($#elements % 2) == 0) { 34643705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 34653705ce5bSJoe Perches } 34663705ce5bSJoe Perches 3467*194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3468*194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 34693705ce5bSJoe Perches } 34703705ce5bSJoe Perches 34713705ce5bSJoe Perches 34720a920b5bSAndy Whitcroft } 34730a920b5bSAndy Whitcroft 3474786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3475d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3476786b6326SJoe Perches if (WARN("SPACING", 3477786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3478786b6326SJoe Perches $fix) { 3479*194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3480786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3481786b6326SJoe Perches } 3482786b6326SJoe Perches } 3483786b6326SJoe Perches 3484f0a594c1SAndy Whitcroft# check for multiple assignments 3485f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3486000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3487000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3488f0a594c1SAndy Whitcroft } 3489f0a594c1SAndy Whitcroft 349022f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 349122f2a2efSAndy Whitcroft## # continuation. 349222f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 349322f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 349422f2a2efSAndy Whitcroft## 349522f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 349622f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 349722f2a2efSAndy Whitcroft## my $ln = $line; 349822f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 349922f2a2efSAndy Whitcroft## } 350022f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3501000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3502000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 350322f2a2efSAndy Whitcroft## } 350422f2a2efSAndy Whitcroft## } 3505f0a594c1SAndy Whitcroft 35060a920b5bSAndy Whitcroft#need space before brace following if, while, etc 350722f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 350822f2a2efSAndy Whitcroft $line =~ /do{/) { 35093705ce5bSJoe Perches if (ERROR("SPACING", 35103705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 35113705ce5bSJoe Perches $fix) { 3512*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 35133705ce5bSJoe Perches } 3514de7d4f0eSAndy Whitcroft } 3515de7d4f0eSAndy Whitcroft 3516c4a62ef9SJoe Perches## # check for blank lines before declarations 3517c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3518c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3519c4a62ef9SJoe Perches## WARN("SPACING", 3520c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3521c4a62ef9SJoe Perches## } 3522c4a62ef9SJoe Perches## 3523c4a62ef9SJoe Perches 3524de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3525de7d4f0eSAndy Whitcroft# on the line 3526de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3527d5e616fcSJoe Perches if (ERROR("SPACING", 3528d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3529d5e616fcSJoe Perches $fix) { 3530*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3531d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3532d5e616fcSJoe Perches } 35330a920b5bSAndy Whitcroft } 35340a920b5bSAndy Whitcroft 353522f2a2efSAndy Whitcroft# check spacing on square brackets 353622f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 35373705ce5bSJoe Perches if (ERROR("SPACING", 35383705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 35393705ce5bSJoe Perches $fix) { 3540*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35413705ce5bSJoe Perches s/\[\s+/\[/; 35423705ce5bSJoe Perches } 354322f2a2efSAndy Whitcroft } 354422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 35453705ce5bSJoe Perches if (ERROR("SPACING", 35463705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 35473705ce5bSJoe Perches $fix) { 3548*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35493705ce5bSJoe Perches s/\s+\]/\]/; 35503705ce5bSJoe Perches } 355122f2a2efSAndy Whitcroft } 355222f2a2efSAndy Whitcroft 3553c45dcabdSAndy Whitcroft# check spacing on parentheses 35549c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 35559c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 35563705ce5bSJoe Perches if (ERROR("SPACING", 35573705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 35583705ce5bSJoe Perches $fix) { 3559*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35603705ce5bSJoe Perches s/\(\s+/\(/; 35613705ce5bSJoe Perches } 356222f2a2efSAndy Whitcroft } 356313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3564c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3565c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 35663705ce5bSJoe Perches if (ERROR("SPACING", 35673705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 35683705ce5bSJoe Perches $fix) { 3569*194f66fcSJoe Perches print("fixlinenr: <$fixlinenr> fixed[fixlinenr]: <$fixed[$fixlinenr]>\n"); 3570*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35713705ce5bSJoe Perches s/\s+\)/\)/; 35723705ce5bSJoe Perches } 357322f2a2efSAndy Whitcroft } 357422f2a2efSAndy Whitcroft 3575e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 3576e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 3577e2826fd0SJoe Perches 3578e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 3579e2826fd0SJoe Perches CHK("UNNECESSARY_PARENTHESES", 3580e2826fd0SJoe Perches "Unnecessary parentheses around $1\n" . $herecurr); 3581e2826fd0SJoe Perches } 3582e2826fd0SJoe Perches 35830a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 35844a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 35850a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 35863705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 35873705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 35883705ce5bSJoe Perches $fix) { 3589*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35903705ce5bSJoe Perches s/^(.)\s+/$1/; 35913705ce5bSJoe Perches } 35920a920b5bSAndy Whitcroft } 35930a920b5bSAndy Whitcroft 35945b9553abSJoe Perches# return is not a function 3595507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3596c45dcabdSAndy Whitcroft my $spacing = $1; 3597507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 35985b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 35995b9553abSJoe Perches my $value = $1; 36005b9553abSJoe Perches $value = deparenthesize($value); 36015b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3602000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3603000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 36045b9553abSJoe Perches } 3605c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3606000d1cc1SJoe Perches ERROR("SPACING", 3607000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3608c45dcabdSAndy Whitcroft } 3609c45dcabdSAndy Whitcroft } 3610507e5141SJoe Perches 3611b43ae21bSJoe Perches# unnecessary return in a void function 3612b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 3613b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 3614b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 3615b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 3616b43ae21bSJoe Perches $linenr >= 3 && 3617b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 3618b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 36199819cf25SJoe Perches WARN("RETURN_VOID", 3620b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 36219819cf25SJoe Perches } 36229819cf25SJoe Perches 3623189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3624189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3625189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3626189248d8SJoe Perches my $openparens = $1; 3627189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3628189248d8SJoe Perches my $msg = ""; 3629189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3630189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3631189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3632189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3633189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3634189248d8SJoe Perches } 3635189248d8SJoe Perches } 3636189248d8SJoe Perches 363753a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 363853a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 363953a3c448SAndy Whitcroft my $name = $1; 364053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3641000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3642000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 364353a3c448SAndy Whitcroft } 364453a3c448SAndy Whitcroft } 3645c45dcabdSAndy Whitcroft 36460a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 36474a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 36483705ce5bSJoe Perches if (ERROR("SPACING", 36493705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 36503705ce5bSJoe Perches $fix) { 3651*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36523705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 36533705ce5bSJoe Perches } 36540a920b5bSAndy Whitcroft } 36550a920b5bSAndy Whitcroft 3656f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3657f5fe35ddSAndy Whitcroft# statements after the conditional. 3658170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 36593e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 36603e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 36613e469cdcSAndy Whitcroft if (!defined $stat); 3662170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3663170d3a22SAndy Whitcroft $remain_next, $off_next); 3664170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3665170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3666170d3a22SAndy Whitcroft 3667170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3668170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3669170d3a22SAndy Whitcroft # then count those as offsets. 3670170d3a22SAndy Whitcroft my ($whitespace) = 3671170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3672170d3a22SAndy Whitcroft my $offset = 3673170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3674170d3a22SAndy Whitcroft 3675170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3676170d3a22SAndy Whitcroft $offset} = 1; 3677170d3a22SAndy Whitcroft } 3678170d3a22SAndy Whitcroft } 3679170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3680c11230f4SJoe Perches defined($stat) && defined($cond) && 3681170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3682171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 36838905a67cSAndy Whitcroft 3684b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3685000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3686000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 36878905a67cSAndy Whitcroft } 36888905a67cSAndy Whitcroft 36898905a67cSAndy Whitcroft # Find out what is on the end of the line after the 36908905a67cSAndy Whitcroft # conditional. 3691773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 36928905a67cSAndy Whitcroft $s =~ s/\n.*//g; 369313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 369453210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 369553210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3696773647a0SAndy Whitcroft { 3697bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3698bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3699bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 370042bdf74cSHidetoshi Seto my $stat_real = ''; 3701bb44ad39SAndy Whitcroft 370242bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 370342bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3704bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3705bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3706bb44ad39SAndy Whitcroft } 3707bb44ad39SAndy Whitcroft 3708000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3709000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 37108905a67cSAndy Whitcroft } 37118905a67cSAndy Whitcroft } 37128905a67cSAndy Whitcroft 371313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 371413214adfSAndy Whitcroft if ($line =~ / 371513214adfSAndy Whitcroft (?: 371613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 371713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 371813214adfSAndy Whitcroft (?:\&\&|\|\|) 371913214adfSAndy Whitcroft | 372013214adfSAndy Whitcroft (?:\&\&|\|\|) 372113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 372213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 372313214adfSAndy Whitcroft )/x) 372413214adfSAndy Whitcroft { 3725000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3726000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 372713214adfSAndy Whitcroft } 372813214adfSAndy Whitcroft 37298905a67cSAndy Whitcroft# if and else should not have general statements after it 373013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 373113214adfSAndy Whitcroft my $s = $1; 373213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 373313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3734000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3735000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 37360a920b5bSAndy Whitcroft } 373713214adfSAndy Whitcroft } 373839667782SAndy Whitcroft# if should not continue a brace 373939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3740000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3741048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 374239667782SAndy Whitcroft $herecurr); 374339667782SAndy Whitcroft } 3744a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3745a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3746a1080bf8SAndy Whitcroft $line !~ /\G(?: 37473fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3748a1080bf8SAndy Whitcroft \s*return\s+ 3749a1080bf8SAndy Whitcroft )/xg) 3750a1080bf8SAndy Whitcroft { 3751000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3752000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3753a1080bf8SAndy Whitcroft } 37540a920b5bSAndy Whitcroft 37550a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 37560a920b5bSAndy Whitcroft # indent level to be relevant to each other. 37570a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 37580a920b5bSAndy Whitcroft $previndent == $indent) { 3759000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3760000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 37610a920b5bSAndy Whitcroft } 37620a920b5bSAndy Whitcroft 3763c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3764c2fdda0dSAndy Whitcroft $previndent == $indent) { 3765c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3766c2fdda0dSAndy Whitcroft 3767c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3768c2fdda0dSAndy Whitcroft # conditional. 3769773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3770c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3771c2fdda0dSAndy Whitcroft 3772c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3773000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3774000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3775c2fdda0dSAndy Whitcroft } 3776c2fdda0dSAndy Whitcroft } 3777c2fdda0dSAndy Whitcroft 377895e2c602SJoe Perches#Specific variable tests 3779323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3780323c1260SJoe Perches my $var = $1; 378195e2c602SJoe Perches 378295e2c602SJoe Perches#gcc binary extension 378395e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3784d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3785d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3786d5e616fcSJoe Perches $fix) { 3787d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3788*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3789d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3790d5e616fcSJoe Perches } 379195e2c602SJoe Perches } 379295e2c602SJoe Perches 379395e2c602SJoe Perches#CamelCase 3794807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3795be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 379622735ce8SJoe Perches#Ignore Page<foo> variants 3797807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 379822735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 37993445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 38007e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 38017e781f67SJoe Perches my $word = $1; 38027e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3803d8b07710SJoe Perches if ($check) { 3804d8b07710SJoe Perches seed_camelcase_includes(); 3805d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3806d8b07710SJoe Perches seed_camelcase_file($realfile); 3807d8b07710SJoe Perches $camelcase_file_seeded = 1; 3808d8b07710SJoe Perches } 3809d8b07710SJoe Perches } 38107e781f67SJoe Perches if (!defined $camelcase{$word}) { 38117e781f67SJoe Perches $camelcase{$word} = 1; 3812be79794bSJoe Perches CHK("CAMELCASE", 38137e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 38147e781f67SJoe Perches } 3815323c1260SJoe Perches } 3816323c1260SJoe Perches } 38173445686aSJoe Perches } 38180a920b5bSAndy Whitcroft 38190a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3820d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3821d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3822d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3823d5e616fcSJoe Perches $fix) { 3824*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 3825d5e616fcSJoe Perches } 38260a920b5bSAndy Whitcroft } 38270a920b5bSAndy Whitcroft 3828653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3829c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3830e09dec48SAndy Whitcroft my $file = "$1.h"; 3831e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3832e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3833e09dec48SAndy Whitcroft $realfile ne $checkfile && 38347840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3835c45dcabdSAndy Whitcroft { 3836e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3837000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3838000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3839e09dec48SAndy Whitcroft } else { 3840000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3841000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3842e09dec48SAndy Whitcroft } 38430a920b5bSAndy Whitcroft } 38440a920b5bSAndy Whitcroft } 38450a920b5bSAndy Whitcroft 3846653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3847653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3848cf655043SAndy Whitcroft# in a known good container 3849b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3850b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3851d8aaf121SAndy Whitcroft my $ln = $linenr; 3852d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3853c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3854c45dcabdSAndy Whitcroft my $ctx = ''; 3855c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3856f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3857f74bd194SAndy Whitcroft $ctx = $dstat; 3858c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3859a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3860c45dcabdSAndy Whitcroft 3861f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3862292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3863c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3864c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3865c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3866c45dcabdSAndy Whitcroft 3867c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3868bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3869bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3870c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3871bf30d6edSAndy Whitcroft { 3872c45dcabdSAndy Whitcroft } 3873c45dcabdSAndy Whitcroft 3874e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3875e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3876e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3877e45bab8eSAndy Whitcroft { 3878e45bab8eSAndy Whitcroft } 3879e45bab8eSAndy Whitcroft 3880c45dcabdSAndy Whitcroft my $exceptions = qr{ 3881c45dcabdSAndy Whitcroft $Declare| 3882c45dcabdSAndy Whitcroft module_param_named| 3883a0a0a7a9SKees Cook MODULE_PARM_DESC| 3884c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3885c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3886383099fdSAndy Whitcroft __typeof__\(| 388722fd2d3eSStefani Seibold union| 388822fd2d3eSStefani Seibold struct| 3889ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3890ea71a0a0SAndy Whitcroft ^\"|\"$ 3891c45dcabdSAndy Whitcroft }x; 38925eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3893f74bd194SAndy Whitcroft if ($dstat ne '' && 3894f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3895f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 38963cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3897356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 3898f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3899f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3900e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 390172f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3902f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3903f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3904f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3905f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3906f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3907c45dcabdSAndy Whitcroft { 3908f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3909f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3910f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3911f74bd194SAndy Whitcroft 3912f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3913f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3914c45dcabdSAndy Whitcroft } 3915c45dcabdSAndy Whitcroft 3916f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3917f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3918f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3919f74bd194SAndy Whitcroft } else { 3920000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3921f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3922d8aaf121SAndy Whitcroft } 39230a920b5bSAndy Whitcroft } 39245023d347SJoe Perches 3925481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 39265023d347SJoe Perches 39275023d347SJoe Perches } else { 39285023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3929481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3930481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 39315023d347SJoe Perches $line =~ /^\+.*\\$/) { 39325023d347SJoe Perches WARN("LINE_CONTINUATIONS", 39335023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 39345023d347SJoe Perches } 3935653d4876SAndy Whitcroft } 39360a920b5bSAndy Whitcroft 3937b13edf7fSJoe Perches# do {} while (0) macro tests: 3938b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3939b13edf7fSJoe Perches# macro should not end with a semicolon 3940b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3941b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3942b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3943b13edf7fSJoe Perches my $ln = $linenr; 3944b13edf7fSJoe Perches my $cnt = $realcnt; 3945b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3946b13edf7fSJoe Perches my $ctx = ''; 3947b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3948b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3949b13edf7fSJoe Perches $ctx = $dstat; 3950b13edf7fSJoe Perches 3951b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3952b13edf7fSJoe Perches 3953b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3954b13edf7fSJoe Perches my $stmts = $2; 3955b13edf7fSJoe Perches my $semis = $3; 3956b13edf7fSJoe Perches 3957b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3958b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3959b13edf7fSJoe Perches my $herectx = $here . "\n"; 3960b13edf7fSJoe Perches 3961b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3962b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3963b13edf7fSJoe Perches } 3964b13edf7fSJoe Perches 3965ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3966ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3967b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3968b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3969b13edf7fSJoe Perches } 3970b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3971b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3972b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3973b13edf7fSJoe Perches } 3974f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 3975f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 3976f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 3977f5ef95b1SJoe Perches my $herectx = $here . "\n"; 3978f5ef95b1SJoe Perches 3979f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3980f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3981f5ef95b1SJoe Perches } 3982f5ef95b1SJoe Perches 3983f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 3984f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 3985b13edf7fSJoe Perches } 3986b13edf7fSJoe Perches } 3987b13edf7fSJoe Perches 3988080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3989080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3990080ba929SMike Frysinger# . 3991080ba929SMike Frysinger# ALIGN(...) 3992080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3993080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3994000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3995000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3996080ba929SMike Frysinger } 3997080ba929SMike Frysinger 3998f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 399913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 400013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4001cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 400213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4003cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4004cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4005aad4f614SJoe Perches my @allowed = (); 4006aad4f614SJoe Perches my $allow = 0; 400713214adfSAndy Whitcroft my $seen = 0; 4008773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4009cf655043SAndy Whitcroft my $ln = $linenr - 1; 401013214adfSAndy Whitcroft for my $chunk (@chunks) { 401113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 401213214adfSAndy Whitcroft 4013773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4014773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4015773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4016773647a0SAndy Whitcroft 4017aad4f614SJoe Perches $allowed[$allow] = 0; 4018773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4019773647a0SAndy Whitcroft 4020773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4021773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4022773647a0SAndy Whitcroft 4023773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4024cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4025cf655043SAndy Whitcroft 4026773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 402713214adfSAndy Whitcroft 402813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 402913214adfSAndy Whitcroft 4030aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4031cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4032cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4033aad4f614SJoe Perches $allowed[$allow] = 1; 403413214adfSAndy Whitcroft } 403513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4036cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4037aad4f614SJoe Perches $allowed[$allow] = 1; 403813214adfSAndy Whitcroft } 4039cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4040cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4041aad4f614SJoe Perches $allowed[$allow] = 1; 404213214adfSAndy Whitcroft } 4043aad4f614SJoe Perches $allow++; 404413214adfSAndy Whitcroft } 4045aad4f614SJoe Perches if ($seen) { 4046aad4f614SJoe Perches my $sum_allowed = 0; 4047aad4f614SJoe Perches foreach (@allowed) { 4048aad4f614SJoe Perches $sum_allowed += $_; 4049aad4f614SJoe Perches } 4050aad4f614SJoe Perches if ($sum_allowed == 0) { 4051000d1cc1SJoe Perches WARN("BRACES", 4052000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4053aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4054aad4f614SJoe Perches $seen != $allow) { 4055aad4f614SJoe Perches CHK("BRACES", 4056aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4057aad4f614SJoe Perches } 405813214adfSAndy Whitcroft } 405913214adfSAndy Whitcroft } 406013214adfSAndy Whitcroft } 4061773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 406213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4063cf655043SAndy Whitcroft my $allowed = 0; 4064f0a594c1SAndy Whitcroft 4065cf655043SAndy Whitcroft # Check the pre-context. 4066cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4067cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4068cf655043SAndy Whitcroft $allowed = 1; 4069f0a594c1SAndy Whitcroft } 4070773647a0SAndy Whitcroft 4071773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4072773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4073773647a0SAndy Whitcroft 4074cf655043SAndy Whitcroft # Check the condition. 4075cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4076773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4077cf655043SAndy Whitcroft if (defined $cond) { 4078773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4079cf655043SAndy Whitcroft } 4080cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4081cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4082cf655043SAndy Whitcroft $allowed = 1; 4083cf655043SAndy Whitcroft } 4084cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4085cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4086cf655043SAndy Whitcroft $allowed = 1; 4087cf655043SAndy Whitcroft } 4088cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4089cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4090cf655043SAndy Whitcroft $allowed = 1; 4091cf655043SAndy Whitcroft } 4092cf655043SAndy Whitcroft # Check the post-context. 4093cf655043SAndy Whitcroft if (defined $chunks[1]) { 4094cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4095cf655043SAndy Whitcroft if (defined $cond) { 4096773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4097cf655043SAndy Whitcroft } 4098cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4099cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4100cf655043SAndy Whitcroft $allowed = 1; 4101cf655043SAndy Whitcroft } 4102cf655043SAndy Whitcroft } 4103cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 410469932487SJustin P. Mattock my $herectx = $here . "\n"; 4105f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4106cf655043SAndy Whitcroft 4107f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 410869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4109cf655043SAndy Whitcroft } 4110cf655043SAndy Whitcroft 4111000d1cc1SJoe Perches WARN("BRACES", 4112000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4113f0a594c1SAndy Whitcroft } 4114f0a594c1SAndy Whitcroft } 4115f0a594c1SAndy Whitcroft 41160979ae66SJoe Perches# check for unnecessary blank lines around braces 411777b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 41180979ae66SJoe Perches CHK("BRACES", 41190979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 41200979ae66SJoe Perches } 412177b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 41220979ae66SJoe Perches CHK("BRACES", 41230979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 41240979ae66SJoe Perches } 41250979ae66SJoe Perches 41264a0df2efSAndy Whitcroft# no volatiles please 41276c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 41286c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4129000d1cc1SJoe Perches WARN("VOLATILE", 4130000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 41314a0df2efSAndy Whitcroft } 41324a0df2efSAndy Whitcroft 413300df344fSAndy Whitcroft# warn about #if 0 4134c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4135000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4136000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4137de7d4f0eSAndy Whitcroft $herecurr); 41384a0df2efSAndy Whitcroft } 41394a0df2efSAndy Whitcroft 414003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 414103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 414203df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 414303df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 414403df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 414503df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 41464c432a8fSGreg Kroah-Hartman } 41474c432a8fSGreg Kroah-Hartman } 4148f0a594c1SAndy Whitcroft 4149ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4150ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4151ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4152ebfdc409SJoe Perches (defined $1 || defined $3) && 4153ebfdc409SJoe Perches $linenr > 3) { 4154ebfdc409SJoe Perches my $testval = $2; 4155ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4156ebfdc409SJoe Perches 4157ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4158ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4159ebfdc409SJoe Perches 4160ebfdc409SJoe 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)/) { 4161ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4162ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4163ebfdc409SJoe Perches } 4164ebfdc409SJoe Perches } 4165ebfdc409SJoe Perches 41668716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 41678716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 41688716de38SJoe Perches my $attr = $1; 41698716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 41708716de38SJoe Perches my $ptr = $1; 41718716de38SJoe Perches my $var = $2; 41728716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 41738716de38SJoe Perches ERROR("MISPLACED_INIT", 41748716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 41758716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 41768716de38SJoe Perches WARN("MISPLACED_INIT", 41778716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 41788716de38SJoe Perches $fix) { 4179*194f66fcSJoe 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; 41808716de38SJoe Perches } 41818716de38SJoe Perches } 41828716de38SJoe Perches } 41838716de38SJoe Perches 4184e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4185e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4186e970b884SJoe Perches my $attr = $1; 4187e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4188e970b884SJoe Perches my $attr_prefix = $1; 4189e970b884SJoe Perches my $attr_type = $2; 4190e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4191e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4192e970b884SJoe Perches $fix) { 4193*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4194e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4195e970b884SJoe Perches } 4196e970b884SJoe Perches } 4197e970b884SJoe Perches 4198e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4199e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4200e970b884SJoe Perches my $attr = $1; 4201e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4202e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4203e970b884SJoe Perches $fix) { 4204*194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4205e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4206e970b884SJoe Perches $lead = rtrim($1); 4207e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4208e970b884SJoe Perches $lead = "${lead}const "; 4209*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4210e970b884SJoe Perches } 4211e970b884SJoe Perches } 4212e970b884SJoe Perches 4213fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4214fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4215fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4216fbdb8138SJoe Perches my $constant_func = $1; 4217fbdb8138SJoe Perches my $func = $constant_func; 4218fbdb8138SJoe Perches $func =~ s/^__constant_//; 4219fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4220fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4221fbdb8138SJoe Perches $fix) { 4222*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4223fbdb8138SJoe Perches } 4224fbdb8138SJoe Perches } 4225fbdb8138SJoe Perches 42261a15a250SPatrick Pannuto# prefer usleep_range over udelay 422737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 422843c1d77cSJoe Perches my $delay = $1; 42291a15a250SPatrick Pannuto # ignore udelay's < 10, however 423043c1d77cSJoe Perches if (! ($delay < 10) ) { 4231000d1cc1SJoe Perches CHK("USLEEP_RANGE", 423243c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 423343c1d77cSJoe Perches } 423443c1d77cSJoe Perches if ($delay > 2000) { 423543c1d77cSJoe Perches WARN("LONG_UDELAY", 423643c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 42371a15a250SPatrick Pannuto } 42381a15a250SPatrick Pannuto } 42391a15a250SPatrick Pannuto 424009ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 424109ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 424209ef8725SPatrick Pannuto if ($1 < 20) { 4243000d1cc1SJoe Perches WARN("MSLEEP", 424443c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 424509ef8725SPatrick Pannuto } 424609ef8725SPatrick Pannuto } 424709ef8725SPatrick Pannuto 424836ec1939SJoe Perches# check for comparisons of jiffies 424936ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 425036ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 425136ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 425236ec1939SJoe Perches } 425336ec1939SJoe Perches 42549d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 42559d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 42569d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 42579d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 42589d7a34a5SJoe Perches } 42599d7a34a5SJoe Perches 426000df344fSAndy Whitcroft# warn about #ifdefs in C files 4261c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 426200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 426300df344fSAndy Whitcroft# print "$herecurr"; 426400df344fSAndy Whitcroft# $clean = 0; 426500df344fSAndy Whitcroft# } 426600df344fSAndy Whitcroft 426722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4268c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 42693705ce5bSJoe Perches if (ERROR("SPACING", 42703705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 42713705ce5bSJoe Perches $fix) { 4272*194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42733705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 42743705ce5bSJoe Perches } 42753705ce5bSJoe Perches 427622f2a2efSAndy Whitcroft } 427722f2a2efSAndy Whitcroft 42784a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4279171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4280171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 42814a0df2efSAndy Whitcroft my $which = $1; 42824a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4283000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4284000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 42854a0df2efSAndy Whitcroft } 42864a0df2efSAndy Whitcroft } 42874a0df2efSAndy Whitcroft# check for memory barriers without a comment. 42884a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 42894a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4290c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4291000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 42924a0df2efSAndy Whitcroft } 42934a0df2efSAndy Whitcroft } 42944a0df2efSAndy Whitcroft# check of hardware specific defines 4295c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4296000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4297000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 42980a920b5bSAndy Whitcroft } 4299653d4876SAndy Whitcroft 4300d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4301d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4302000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4303000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4304d4977c78STobias Klauser } 4305d4977c78STobias Klauser 4306de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4307de7d4f0eSAndy Whitcroft# storage class and type. 43089c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 43099c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4310000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4311000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4312de7d4f0eSAndy Whitcroft } 4313de7d4f0eSAndy Whitcroft 43148905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 43152b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 43162b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4317d5e616fcSJoe Perches if (WARN("INLINE", 4318d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4319d5e616fcSJoe Perches $fix) { 4320*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 4321d5e616fcSJoe Perches 4322d5e616fcSJoe Perches } 43238905a67cSAndy Whitcroft } 43248905a67cSAndy Whitcroft 43253d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 43262b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 43272b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4328000d1cc1SJoe Perches WARN("PREFER_PACKED", 4329000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 43303d130fd0SJoe Perches } 43313d130fd0SJoe Perches 433239b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 43332b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 43342b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4335000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4336000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 433739b7e287SJoe Perches } 433839b7e287SJoe Perches 43395f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 43402b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 43412b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4342d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4343d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4344d5e616fcSJoe Perches $fix) { 4345*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4346d5e616fcSJoe Perches 4347d5e616fcSJoe Perches } 43485f14d3bdSJoe Perches } 43495f14d3bdSJoe Perches 43506061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 43512b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 43522b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4353d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4354d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4355d5e616fcSJoe Perches $fix) { 4356*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4357d5e616fcSJoe Perches } 43586061d949SJoe Perches } 43596061d949SJoe Perches 43608f53a9b8SJoe Perches# check for sizeof(&) 43618f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4362000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4363000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 43648f53a9b8SJoe Perches } 43658f53a9b8SJoe Perches 436666c80b60SJoe Perches# check for sizeof without parenthesis 436766c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4368d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4369d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4370d5e616fcSJoe Perches $fix) { 4371*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4372d5e616fcSJoe Perches } 437366c80b60SJoe Perches } 437466c80b60SJoe Perches 4375428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4376428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4377000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4378000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4379428e2fdcSJoe Perches } 4380428e2fdcSJoe Perches 438188982feaSJoe Perches# check for struct spinlock declarations 438288982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 438388982feaSJoe Perches WARN("USE_SPINLOCK_T", 438488982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 438588982feaSJoe Perches } 438688982feaSJoe Perches 4387a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 438806668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4389a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 439006668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4391d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4392d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4393d5e616fcSJoe Perches $fix) { 4394*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 4395d5e616fcSJoe Perches } 4396a6962d72SJoe Perches } 4397a6962d72SJoe Perches } 4398a6962d72SJoe Perches 4399554e165cSAndy Whitcroft# Check for misused memsets 4400d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4401d1fe9c09SJoe Perches defined $stat && 4402d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4403554e165cSAndy Whitcroft 4404d7c76ba7SJoe Perches my $ms_addr = $2; 4405d1fe9c09SJoe Perches my $ms_val = $7; 4406d1fe9c09SJoe Perches my $ms_size = $12; 4407d7c76ba7SJoe Perches 4408554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4409554e165cSAndy Whitcroft ERROR("MEMSET", 4410d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4411554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4412554e165cSAndy Whitcroft WARN("MEMSET", 4413d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4414d7c76ba7SJoe Perches } 4415d7c76ba7SJoe Perches } 4416d7c76ba7SJoe Perches 441798a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 441898a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 441998a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 442098a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 442198a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 442298a9bba5SJoe Perches $fix) { 4423*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 442498a9bba5SJoe Perches } 442598a9bba5SJoe Perches } 442698a9bba5SJoe Perches 4427d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4428d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4429d1fe9c09SJoe Perches defined $stat && 4430d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4431d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4432d7c76ba7SJoe Perches my $call = $1; 4433d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4434d7c76ba7SJoe Perches my $arg1 = $3; 4435d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4436d1fe9c09SJoe Perches my $arg2 = $8; 4437d7c76ba7SJoe Perches my $cast; 4438d7c76ba7SJoe Perches 4439d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4440d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4441d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4442d7c76ba7SJoe Perches $cast = $cast1; 4443d7c76ba7SJoe Perches } else { 4444d7c76ba7SJoe Perches $cast = $cast2; 4445d7c76ba7SJoe Perches } 4446d7c76ba7SJoe Perches WARN("MINMAX", 4447d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4448554e165cSAndy Whitcroft } 4449554e165cSAndy Whitcroft } 4450554e165cSAndy Whitcroft 44514a273195SJoe Perches# check usleep_range arguments 44524a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 44534a273195SJoe Perches defined $stat && 44544a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 44554a273195SJoe Perches my $min = $1; 44564a273195SJoe Perches my $max = $7; 44574a273195SJoe Perches if ($min eq $max) { 44584a273195SJoe Perches WARN("USLEEP_RANGE", 44594a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 44604a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 44614a273195SJoe Perches $min > $max) { 44624a273195SJoe Perches WARN("USLEEP_RANGE", 44634a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 44644a273195SJoe Perches } 44654a273195SJoe Perches } 44664a273195SJoe Perches 4467823b794cSJoe Perches# check for naked sscanf 4468823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4469823b794cSJoe Perches defined $stat && 44706c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4471823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4472823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4473823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4474823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4475823b794cSJoe Perches $lc = $lc + $linenr; 4476823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4477823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4478823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4479823b794cSJoe Perches } 4480823b794cSJoe Perches WARN("NAKED_SSCANF", 4481823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4482823b794cSJoe Perches } 4483823b794cSJoe Perches 4484afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 4485afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 4486afc819abSJoe Perches defined $stat && 4487afc819abSJoe Perches $line =~ /\bsscanf\b/) { 4488afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 4489afc819abSJoe Perches $lc = $lc + $linenr; 4490afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 4491afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4492afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4493afc819abSJoe Perches } 4494afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 4495afc819abSJoe Perches my $format = $6; 4496afc819abSJoe Perches my $count = $format =~ tr@%@%@; 4497afc819abSJoe Perches if ($count == 1 && 4498afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 4499afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 4500afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 4501afc819abSJoe Perches } 4502afc819abSJoe Perches } 4503afc819abSJoe Perches } 4504afc819abSJoe Perches 450570dc8a48SJoe Perches# check for new externs in .h files. 450670dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 450770dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4508d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 450970dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 451070dc8a48SJoe Perches $fix) { 4511*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 451270dc8a48SJoe Perches } 451370dc8a48SJoe Perches } 451470dc8a48SJoe Perches 4515de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4516171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4517c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4518171ae1a4SAndy Whitcroft { 4519c45dcabdSAndy Whitcroft my $function_name = $1; 4520c45dcabdSAndy Whitcroft my $paren_space = $2; 4521171ae1a4SAndy Whitcroft 4522171ae1a4SAndy Whitcroft my $s = $stat; 4523171ae1a4SAndy Whitcroft if (defined $cond) { 4524171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4525171ae1a4SAndy Whitcroft } 4526c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4527c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4528c45dcabdSAndy Whitcroft { 4529000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4530000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4531de7d4f0eSAndy Whitcroft } 4532de7d4f0eSAndy Whitcroft 4533171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4534000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4535000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4536171ae1a4SAndy Whitcroft } 45379c9ba34eSAndy Whitcroft 45389c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 45399c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 45409c9ba34eSAndy Whitcroft { 4541000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4542000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4543171ae1a4SAndy Whitcroft } 4544171ae1a4SAndy Whitcroft 4545de7d4f0eSAndy Whitcroft# checks for new __setup's 4546de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4547de7d4f0eSAndy Whitcroft my $name = $1; 4548de7d4f0eSAndy Whitcroft 4549de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4550000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4551000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4552de7d4f0eSAndy Whitcroft } 4553653d4876SAndy Whitcroft } 45549c0ca6f9SAndy Whitcroft 45559c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4556caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4557000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4558000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 45599c0ca6f9SAndy Whitcroft } 456013214adfSAndy Whitcroft 4561a640d25cSJoe Perches# alloc style 4562a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4563a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4564a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4565a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4566a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4567a640d25cSJoe Perches } 4568a640d25cSJoe Perches 456960a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 457060a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 4571e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 457260a55369SJoe Perches my $oldfunc = $3; 457360a55369SJoe Perches my $a1 = $4; 457460a55369SJoe Perches my $a2 = $10; 457560a55369SJoe Perches my $newfunc = "kmalloc_array"; 457660a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 457760a55369SJoe Perches my $r1 = $a1; 457860a55369SJoe Perches my $r2 = $a2; 457960a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 458060a55369SJoe Perches $r1 = $a2; 458160a55369SJoe Perches $r2 = $a1; 458260a55369SJoe Perches } 4583e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 4584e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 4585e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 4586e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 4587e367455aSJoe Perches $fix) { 4588*194f66fcSJoe 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; 458960a55369SJoe Perches 459060a55369SJoe Perches } 459160a55369SJoe Perches } 459260a55369SJoe Perches } 459360a55369SJoe Perches 4594972fdea2SJoe Perches# check for krealloc arg reuse 4595972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4596972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4597972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4598972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4599972fdea2SJoe Perches } 4600972fdea2SJoe Perches 46015ce59ae0SJoe Perches# check for alloc argument mismatch 46025ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 46035ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 46045ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 46055ce59ae0SJoe Perches } 46065ce59ae0SJoe Perches 4607caf2a54fSJoe Perches# check for multiple semicolons 4608caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4609d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4610d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4611d5e616fcSJoe Perches $fix) { 4612*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 4613d5e616fcSJoe Perches } 4614d1e2ad07SJoe Perches } 4615d1e2ad07SJoe Perches 4616c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4617c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4618c34c09a8SJoe Perches my $has_break = 0; 4619c34c09a8SJoe Perches my $has_statement = 0; 4620c34c09a8SJoe Perches my $count = 0; 4621c34c09a8SJoe Perches my $prevline = $linenr; 4622c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4623c34c09a8SJoe Perches $prevline--; 4624c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4625c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4626c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4627c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4628c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4629c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4630c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4631c34c09a8SJoe Perches $has_statement = 1; 4632c34c09a8SJoe Perches $count++; 4633c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4634c34c09a8SJoe Perches } 4635c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4636c34c09a8SJoe Perches WARN("MISSING_BREAK", 4637c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4638c34c09a8SJoe Perches } 4639c34c09a8SJoe Perches } 4640c34c09a8SJoe Perches 4641d1e2ad07SJoe Perches# check for switch/default statements without a break; 4642d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4643d1e2ad07SJoe Perches defined $stat && 4644d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4645d1e2ad07SJoe Perches my $ctx = ''; 4646d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4647d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4648d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4649d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4650d1e2ad07SJoe Perches } 4651d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4652d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4653caf2a54fSJoe Perches } 4654caf2a54fSJoe Perches 465513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4656d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4657d5e616fcSJoe Perches if (WARN("USE_FUNC", 4658d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4659d5e616fcSJoe Perches $fix) { 4660*194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 4661d5e616fcSJoe Perches } 466213214adfSAndy Whitcroft } 4663773647a0SAndy Whitcroft 46642c92488aSJoe Perches# check for use of yield() 46652c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 46662c92488aSJoe Perches WARN("YIELD", 46672c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 46682c92488aSJoe Perches } 46692c92488aSJoe Perches 4670179f8f40SJoe Perches# check for comparisons against true and false 4671179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4672179f8f40SJoe Perches my $lead = $1; 4673179f8f40SJoe Perches my $arg = $2; 4674179f8f40SJoe Perches my $test = $3; 4675179f8f40SJoe Perches my $otype = $4; 4676179f8f40SJoe Perches my $trail = $5; 4677179f8f40SJoe Perches my $op = "!"; 4678179f8f40SJoe Perches 4679179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4680179f8f40SJoe Perches 4681179f8f40SJoe Perches my $type = lc($otype); 4682179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4683179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4684179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4685179f8f40SJoe Perches $op = ""; 4686179f8f40SJoe Perches } 4687179f8f40SJoe Perches 4688179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4689179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4690179f8f40SJoe Perches 4691179f8f40SJoe Perches## maybe suggesting a correct construct would better 4692179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4693179f8f40SJoe Perches 4694179f8f40SJoe Perches } 4695179f8f40SJoe Perches } 4696179f8f40SJoe Perches 46974882720bSThomas Gleixner# check for semaphores initialized locked 46984882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4699000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4700000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4701773647a0SAndy Whitcroft } 47026712d858SJoe Perches 470367d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 470467d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4705000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 470667d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4707773647a0SAndy Whitcroft } 47086712d858SJoe Perches 4709ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 4710f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4711000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4712ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 4713f3db6639SMichael Ellerman } 47146712d858SJoe Perches 471579404849SEmese Revfy# check for various ops structs, ensure they are const. 471679404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 471779404849SEmese Revfy address_space_operations| 471879404849SEmese Revfy backlight_ops| 471979404849SEmese Revfy block_device_operations| 472079404849SEmese Revfy dentry_operations| 472179404849SEmese Revfy dev_pm_ops| 472279404849SEmese Revfy dma_map_ops| 472379404849SEmese Revfy extent_io_ops| 472479404849SEmese Revfy file_lock_operations| 472579404849SEmese Revfy file_operations| 472679404849SEmese Revfy hv_ops| 472779404849SEmese Revfy ide_dma_ops| 472879404849SEmese Revfy intel_dvo_dev_ops| 472979404849SEmese Revfy item_operations| 473079404849SEmese Revfy iwl_ops| 473179404849SEmese Revfy kgdb_arch| 473279404849SEmese Revfy kgdb_io| 473379404849SEmese Revfy kset_uevent_ops| 473479404849SEmese Revfy lock_manager_operations| 473579404849SEmese Revfy microcode_ops| 473679404849SEmese Revfy mtrr_ops| 473779404849SEmese Revfy neigh_ops| 473879404849SEmese Revfy nlmsvc_binding| 473979404849SEmese Revfy pci_raw_ops| 474079404849SEmese Revfy pipe_buf_operations| 474179404849SEmese Revfy platform_hibernation_ops| 474279404849SEmese Revfy platform_suspend_ops| 474379404849SEmese Revfy proto_ops| 474479404849SEmese Revfy rpc_pipe_ops| 474579404849SEmese Revfy seq_operations| 474679404849SEmese Revfy snd_ac97_build_ops| 474779404849SEmese Revfy soc_pcmcia_socket_ops| 474879404849SEmese Revfy stacktrace_ops| 474979404849SEmese Revfy sysfs_ops| 475079404849SEmese Revfy tty_operations| 475179404849SEmese Revfy usb_mon_operations| 475279404849SEmese Revfy wd_ops}x; 47536903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 475479404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4755000d1cc1SJoe Perches WARN("CONST_STRUCT", 4756000d1cc1SJoe Perches "struct $1 should normally be const\n" . 47576903ffb2SAndy Whitcroft $herecurr); 47582b6db5cbSAndy Whitcroft } 4759773647a0SAndy Whitcroft 4760773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4761773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4762773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4763c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4764c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4765171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4766171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4767171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4768773647a0SAndy Whitcroft { 4769000d1cc1SJoe Perches WARN("NR_CPUS", 4770000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4771773647a0SAndy Whitcroft } 47729c9ba34eSAndy Whitcroft 477352ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 477452ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 477552ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 477652ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 477752ea8506SJoe Perches } 477852ea8506SJoe Perches 47799c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 47809c9ba34eSAndy Whitcroft my $string; 47819c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 47829c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 47832a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 47849c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4785000d1cc1SJoe Perches WARN("PRINTF_L", 4786000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 47879c9ba34eSAndy Whitcroft last; 47889c9ba34eSAndy Whitcroft } 47899c9ba34eSAndy Whitcroft } 4790691d77b6SAndy Whitcroft 4791691d77b6SAndy Whitcroft# whine mightly about in_atomic 4792691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4793691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4794000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4795000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4796f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4797000d1cc1SJoe Perches WARN("IN_ATOMIC", 4798000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4799691d77b6SAndy Whitcroft } 4800691d77b6SAndy Whitcroft } 48011704f47bSPeter Zijlstra 48021704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 48031704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 48041704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 48051704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 48061704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 48071704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4808000d1cc1SJoe Perches ERROR("LOCKDEP", 4809000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 48101704f47bSPeter Zijlstra } 48111704f47bSPeter Zijlstra } 481288f8831cSDave Jones 481388f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 481488f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4815000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4816000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 481788f8831cSDave Jones } 48182435880fSJoe Perches 4819515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 4820515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 4821515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 4822515a235eSJoe Perches $line =~ /$mode_perms_search/) { 48232435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 48242435880fSJoe Perches my $func = $entry->[0]; 48252435880fSJoe Perches my $arg_pos = $entry->[1]; 48262435880fSJoe Perches 48272435880fSJoe Perches my $skip_args = ""; 48282435880fSJoe Perches if ($arg_pos > 1) { 48292435880fSJoe Perches $arg_pos--; 48302435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 48312435880fSJoe Perches } 48322435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 4833515a235eSJoe Perches if ($line =~ /$test/) { 48342435880fSJoe Perches my $val = $1; 48352435880fSJoe Perches $val = $6 if ($skip_args ne ""); 48362435880fSJoe Perches 48371727cc70SJoe Perches if ($val !~ /^0$/ && 48381727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 48391727cc70SJoe Perches length($val) ne 4)) { 48402435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 48411727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 48422435880fSJoe Perches } 48432435880fSJoe Perches } 48442435880fSJoe Perches } 484513214adfSAndy Whitcroft } 4846515a235eSJoe Perches } 484713214adfSAndy Whitcroft 484813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 484913214adfSAndy Whitcroft # so just keep quiet. 485013214adfSAndy Whitcroft if ($#rawlines == -1) { 485113214adfSAndy Whitcroft exit(0); 48520a920b5bSAndy Whitcroft } 48530a920b5bSAndy Whitcroft 48548905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 48558905a67cSAndy Whitcroft # things that appear to be patches. 48568905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 48578905a67cSAndy Whitcroft exit(0); 48588905a67cSAndy Whitcroft } 48598905a67cSAndy Whitcroft 48608905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 48618905a67cSAndy Whitcroft # just keep quiet. 48628905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 48638905a67cSAndy Whitcroft exit(0); 48648905a67cSAndy Whitcroft } 48658905a67cSAndy Whitcroft 48668905a67cSAndy Whitcroft if (!$is_patch) { 4867000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4868000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 48690a920b5bSAndy Whitcroft } 48700a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4871000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4872000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 48730a920b5bSAndy Whitcroft } 48740a920b5bSAndy Whitcroft 4875f0a594c1SAndy Whitcroft print report_dump(); 487613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 487713214adfSAndy Whitcroft print "$filename " if ($summary_file); 48786c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 48796c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 48806c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 48818905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 48826c72ffaaSAndy Whitcroft } 48838905a67cSAndy Whitcroft 4884d2c0a235SAndy Whitcroft if ($quiet == 0) { 4885d1fe9c09SJoe Perches 4886d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4887d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4888d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4889d1fe9c09SJoe Perches } 4890d1fe9c09SJoe Perches 4891d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4892d2c0a235SAndy Whitcroft # then suggest that. 4893d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4894d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4895d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4896b0781216SMike Frysinger $rpt_cleaners = 0; 4897d2c0a235SAndy Whitcroft } 4898d2c0a235SAndy Whitcroft } 4899d2c0a235SAndy Whitcroft 490091bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 490191bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4902000d1cc1SJoe Perches 49033705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 49049624b8d6SJoe Perches my $newfile = $filename; 49059624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 49063705ce5bSJoe Perches my $linecount = 0; 49073705ce5bSJoe Perches my $f; 49083705ce5bSJoe Perches 49093705ce5bSJoe Perches open($f, '>', $newfile) 49103705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 49113705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 49123705ce5bSJoe Perches $linecount++; 49133705ce5bSJoe Perches if ($file) { 49143705ce5bSJoe Perches if ($linecount > 3) { 49153705ce5bSJoe Perches $fixed_line =~ s/^\+//; 49163705ce5bSJoe Perches print $f $fixed_line. "\n"; 49173705ce5bSJoe Perches } 49183705ce5bSJoe Perches } else { 49193705ce5bSJoe Perches print $f $fixed_line . "\n"; 49203705ce5bSJoe Perches } 49213705ce5bSJoe Perches } 49223705ce5bSJoe Perches close($f); 49233705ce5bSJoe Perches 49243705ce5bSJoe Perches if (!$quiet) { 49253705ce5bSJoe Perches print << "EOM"; 49263705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 49273705ce5bSJoe Perches 49283705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 49293705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 49303705ce5bSJoe Perches 49313705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 49323705ce5bSJoe PerchesNo warranties, expressed or implied... 49333705ce5bSJoe Perches 49343705ce5bSJoe PerchesEOM 49353705ce5bSJoe Perches } 49363705ce5bSJoe Perches } 49373705ce5bSJoe Perches 49380a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4939c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 49400a920b5bSAndy Whitcroft } 49410a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4942000d1cc1SJoe Perches print << "EOM"; 4943000d1cc1SJoe Perches$vname has style problems, please review. 4944000d1cc1SJoe Perches 4945000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4946000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4947000d1cc1SJoe PerchesEOM 49480a920b5bSAndy Whitcroft } 494913214adfSAndy Whitcroft 49500a920b5bSAndy Whitcroft return $clean; 49510a920b5bSAndy Whitcroft} 4952