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; 278905a67cSAndy Whitcroftmy $summary = 1; 288905a67cSAndy Whitcroftmy $mailback = 0; 2913214adfSAndy Whitcroftmy $summary_file = 0; 30000d1cc1SJoe Perchesmy $show_types = 0; 313705ce5bSJoe Perchesmy $fix = 0; 329624b8d6SJoe Perchesmy $fix_inplace = 0; 336c72ffaaSAndy Whitcroftmy $root; 34c2fdda0dSAndy Whitcroftmy %debug; 353445686aSJoe Perchesmy %camelcase = (); 3691bfe484SJoe Perchesmy %use_type = (); 3791bfe484SJoe Perchesmy @use = (); 3891bfe484SJoe Perchesmy %ignore_type = (); 39000d1cc1SJoe Perchesmy @ignore = (); 4077f5b10aSHannes Edermy $help = 0; 41000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 426cd7f386SJoe Perchesmy $max_line_length = 80; 43d62a201fSDave Hansenmy $ignore_perl_version = 0; 44d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4577f5b10aSHannes Eder 4677f5b10aSHannes Edersub help { 4777f5b10aSHannes Eder my ($exitcode) = @_; 4877f5b10aSHannes Eder 4977f5b10aSHannes Eder print << "EOM"; 5077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5177f5b10aSHannes EderVersion: $V 5277f5b10aSHannes Eder 5377f5b10aSHannes EderOptions: 5477f5b10aSHannes Eder -q, --quiet quiet 5577f5b10aSHannes Eder --no-tree run without a kernel tree 5677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5877f5b10aSHannes Eder --emacs emacs compile window format 5977f5b10aSHannes Eder --terse one line per report 6077f5b10aSHannes Eder -f, --file treat FILE as regular source file 6177f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6291bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 63000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 646cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 65000d1cc1SJoe Perches --show-types show the message "types" in the output 6677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6777f5b10aSHannes Eder --no-summary suppress the per-file summary 6877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6977f5b10aSHannes Eder --summary-file include the filename in summary 7077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7277f5b10aSHannes Eder is all off) 7377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7477f5b10aSHannes Eder literally 753705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 763705ce5bSJoe Perches If correctable single-line errors exist, create 773705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 783705ce5bSJoe Perches with potential errors corrected to the preferred 793705ce5bSJoe Perches checkpatch style 809624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 819624b8d6SJoe Perches Is the same as --fix, but overwrites the input 829624b8d6SJoe Perches file. It's your fault if there's no backup or git 83d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 84d62a201fSDave Hansen runtime errors. 8577f5b10aSHannes Eder -h, --help, --version display this help and exit 8677f5b10aSHannes Eder 8777f5b10aSHannes EderWhen FILE is - read standard input. 8877f5b10aSHannes EderEOM 8977f5b10aSHannes Eder 9077f5b10aSHannes Eder exit($exitcode); 9177f5b10aSHannes Eder} 9277f5b10aSHannes Eder 93000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 94000d1cc1SJoe Perchesif (-f $conf) { 95000d1cc1SJoe Perches my @conf_args; 96000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 97000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 98000d1cc1SJoe Perches 99000d1cc1SJoe Perches while (<$conffile>) { 100000d1cc1SJoe Perches my $line = $_; 101000d1cc1SJoe Perches 102000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 103000d1cc1SJoe Perches $line =~ s/^\s*//g; 104000d1cc1SJoe Perches $line =~ s/\s+/ /g; 105000d1cc1SJoe Perches 106000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 107000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 108000d1cc1SJoe Perches 109000d1cc1SJoe Perches my @words = split(" ", $line); 110000d1cc1SJoe Perches foreach my $word (@words) { 111000d1cc1SJoe Perches last if ($word =~ m/^#/); 112000d1cc1SJoe Perches push (@conf_args, $word); 113000d1cc1SJoe Perches } 114000d1cc1SJoe Perches } 115000d1cc1SJoe Perches close($conffile); 116000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 117000d1cc1SJoe Perches} 118000d1cc1SJoe Perches 1190a920b5bSAndy WhitcroftGetOptions( 1206c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1210a920b5bSAndy Whitcroft 'tree!' => \$tree, 1220a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1230a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1246c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1258905a67cSAndy Whitcroft 'terse!' => \$terse, 12677f5b10aSHannes Eder 'f|file!' => \$file, 1276c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1286c72ffaaSAndy Whitcroft 'strict!' => \$check, 129000d1cc1SJoe Perches 'ignore=s' => \@ignore, 13091bfe484SJoe Perches 'types=s' => \@use, 131000d1cc1SJoe Perches 'show-types!' => \$show_types, 1326cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1336c72ffaaSAndy Whitcroft 'root=s' => \$root, 1348905a67cSAndy Whitcroft 'summary!' => \$summary, 1358905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1373705ce5bSJoe Perches 'fix!' => \$fix, 1389624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 139d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 140c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 141773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 14277f5b10aSHannes Eder 'h|help' => \$help, 14377f5b10aSHannes Eder 'version' => \$help 14477f5b10aSHannes Eder) or help(1); 14577f5b10aSHannes Eder 14677f5b10aSHannes Ederhelp(0) if ($help); 1470a920b5bSAndy Whitcroft 1489624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1499624b8d6SJoe Perches 1500a920b5bSAndy Whitcroftmy $exit = 0; 1510a920b5bSAndy Whitcroft 152d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 153d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 154d62a201fSDave Hansen if (!$ignore_perl_version) { 155d62a201fSDave Hansen exit(1); 156d62a201fSDave Hansen } 157d62a201fSDave Hansen} 158d62a201fSDave Hansen 1590a920b5bSAndy Whitcroftif ($#ARGV < 0) { 16077f5b10aSHannes Eder print "$P: no input files\n"; 1610a920b5bSAndy Whitcroft exit(1); 1620a920b5bSAndy Whitcroft} 1630a920b5bSAndy Whitcroft 16491bfe484SJoe Perchessub hash_save_array_words { 16591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 16691bfe484SJoe Perches 16791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 16891bfe484SJoe Perches foreach my $word (@array) { 169000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 170000d1cc1SJoe Perches $word =~ s/^\s*//g; 171000d1cc1SJoe Perches $word =~ s/\s+/ /g; 172000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 173000d1cc1SJoe Perches 174000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 175000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 176000d1cc1SJoe Perches 17791bfe484SJoe Perches $hashRef->{$word}++; 178000d1cc1SJoe Perches } 17991bfe484SJoe Perches} 18091bfe484SJoe Perches 18191bfe484SJoe Perchessub hash_show_words { 18291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 18391bfe484SJoe Perches 18458cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 18591bfe484SJoe Perches print "NOTE: $prefix message types:"; 18658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 18791bfe484SJoe Perches print " $word"; 18891bfe484SJoe Perches } 18991bfe484SJoe Perches print "\n\n"; 19091bfe484SJoe Perches } 19191bfe484SJoe Perches} 19291bfe484SJoe Perches 19391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 19491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 195000d1cc1SJoe Perches 196c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 197c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1987429c690SAndy Whitcroftmy $dbg_type = 0; 199a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 200c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 20121caa13cSAndy Whitcroft ## no critic 20221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 20321caa13cSAndy Whitcroft die "$@" if ($@); 204c2fdda0dSAndy Whitcroft} 205c2fdda0dSAndy Whitcroft 206d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 207d2c0a235SAndy Whitcroft 2088905a67cSAndy Whitcroftif ($terse) { 2098905a67cSAndy Whitcroft $emacs = 1; 2108905a67cSAndy Whitcroft $quiet++; 2118905a67cSAndy Whitcroft} 2128905a67cSAndy Whitcroft 2136c72ffaaSAndy Whitcroftif ($tree) { 2146c72ffaaSAndy Whitcroft if (defined $root) { 2156c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2166c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2176c72ffaaSAndy Whitcroft } 2186c72ffaaSAndy Whitcroft } else { 2196c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2206c72ffaaSAndy Whitcroft $root = '.'; 2216c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2226c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2236c72ffaaSAndy Whitcroft $root = $1; 2246c72ffaaSAndy Whitcroft } 2256c72ffaaSAndy Whitcroft } 2266c72ffaaSAndy Whitcroft 2276c72ffaaSAndy Whitcroft if (!defined $root) { 2280a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2290a920b5bSAndy Whitcroft exit(2); 2300a920b5bSAndy Whitcroft } 2316c72ffaaSAndy Whitcroft} 2326c72ffaaSAndy Whitcroft 2336c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2346c72ffaaSAndy Whitcroft 2352ceb532bSAndy Whitcroftour $Ident = qr{ 2362ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2372ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2382ceb532bSAndy Whitcroft }x; 2396c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2406c72ffaaSAndy Whitcroftour $Sparse = qr{ 2416c72ffaaSAndy Whitcroft __user| 2426c72ffaaSAndy Whitcroft __kernel| 2436c72ffaaSAndy Whitcroft __force| 2446c72ffaaSAndy Whitcroft __iomem| 2456c72ffaaSAndy Whitcroft __must_check| 2466c72ffaaSAndy Whitcroft __init_refok| 247417495edSAndy Whitcroft __kprobes| 248165e72a6SSven Eckelmann __ref| 249165e72a6SSven Eckelmann __rcu 2506c72ffaaSAndy Whitcroft }x; 251e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 252e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 253e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 254e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 255e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2568716de38SJoe Perches 25752131292SWolfram Sang# Notes to $Attribute: 25852131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2596c72ffaaSAndy Whitcroftour $Attribute = qr{ 2606c72ffaaSAndy Whitcroft const| 26103f1df7dSJoe Perches __percpu| 26203f1df7dSJoe Perches __nocast| 26303f1df7dSJoe Perches __safe| 26403f1df7dSJoe Perches __bitwise__| 26503f1df7dSJoe Perches __packed__| 26603f1df7dSJoe Perches __packed2__| 26703f1df7dSJoe Perches __naked| 26803f1df7dSJoe Perches __maybe_unused| 26903f1df7dSJoe Perches __always_unused| 27003f1df7dSJoe Perches __noreturn| 27103f1df7dSJoe Perches __used| 27203f1df7dSJoe Perches __cold| 27303f1df7dSJoe Perches __noclone| 27403f1df7dSJoe Perches __deprecated| 2756c72ffaaSAndy Whitcroft __read_mostly| 2766c72ffaaSAndy Whitcroft __kprobes| 2778716de38SJoe Perches $InitAttribute| 27824e1d81aSAndy Whitcroft ____cacheline_aligned| 27924e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2805fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2815fe3af11SAndy Whitcroft __weak 2826c72ffaaSAndy Whitcroft }x; 283c45dcabdSAndy Whitcroftour $Modifier; 2846c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2856c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2866c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2876c72ffaaSAndy Whitcroft 28895e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 28995e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 29095e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 29195e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 2922435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 293326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 294326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 295326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 29674349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 2972435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 298326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 299447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 30023f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3016c72ffaaSAndy Whitcroftour $Operators = qr{ 3026c72ffaaSAndy Whitcroft <=|>=|==|!=| 3036c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 30423f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3056c72ffaaSAndy Whitcroft }x; 3066c72ffaaSAndy Whitcroft 3078905a67cSAndy Whitcroftour $NonptrType; 3088716de38SJoe Perchesour $NonptrTypeWithAttr; 3098905a67cSAndy Whitcroftour $Type; 3108905a67cSAndy Whitcroftour $Declare; 3118905a67cSAndy Whitcroft 31215662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 31315662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 314171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 315171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 316171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 317171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 318171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 319171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 320171ae1a4SAndy Whitcroft}x; 321171ae1a4SAndy Whitcroft 32215662b3eSJoe Perchesour $UTF8 = qr{ 32315662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 32415662b3eSJoe Perches | $NON_ASCII_UTF8 32515662b3eSJoe Perches}x; 32615662b3eSJoe Perches 3278ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 328fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3298ed22cadSAndy Whitcroft atomic_t 3308ed22cadSAndy Whitcroft)}; 3318ed22cadSAndy Whitcroft 332691e669bSJoe Perchesour $logFunctions = qr{(?x: 3336e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3347d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3356e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 336b0531722SJoe Perches panic| 33706668727SJoe Perches MODULE_[A-Z_]+| 33806668727SJoe Perches seq_vprintf|seq_printf|seq_puts 339691e669bSJoe Perches)}; 340691e669bSJoe Perches 34120112475SJoe Perchesour $signature_tags = qr{(?xi: 34220112475SJoe Perches Signed-off-by:| 34320112475SJoe Perches Acked-by:| 34420112475SJoe Perches Tested-by:| 34520112475SJoe Perches Reviewed-by:| 34620112475SJoe Perches Reported-by:| 3478543ae12SMugunthan V N Suggested-by:| 34820112475SJoe Perches To:| 34920112475SJoe Perches Cc: 35020112475SJoe Perches)}; 35120112475SJoe Perches 3528905a67cSAndy Whitcroftour @typeList = ( 3538905a67cSAndy Whitcroft qr{void}, 354c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 355c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 356c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 357c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 358c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 359c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 360c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3618905a67cSAndy Whitcroft qr{unsigned}, 3628905a67cSAndy Whitcroft qr{float}, 3638905a67cSAndy Whitcroft qr{double}, 3648905a67cSAndy Whitcroft qr{bool}, 3658905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3668905a67cSAndy Whitcroft qr{union\s+$Ident}, 3678905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3688905a67cSAndy Whitcroft qr{${Ident}_t}, 3698905a67cSAndy Whitcroft qr{${Ident}_handler}, 3708905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3718905a67cSAndy Whitcroft); 3728716de38SJoe Perchesour @typeListWithAttr = ( 3738716de38SJoe Perches @typeList, 3748716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 3758716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 3768716de38SJoe Perches); 3778716de38SJoe Perches 378c45dcabdSAndy Whitcroftour @modifierList = ( 379c45dcabdSAndy Whitcroft qr{fastcall}, 380c45dcabdSAndy Whitcroft); 3818905a67cSAndy Whitcroft 3822435880fSJoe Perchesour @mode_permission_funcs = ( 3832435880fSJoe Perches ["module_param", 3], 3842435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 3852435880fSJoe Perches ["module_param_array_named", 5], 3862435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 3872435880fSJoe Perches ["proc_create(?:_data|)", 2], 3882435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 3892435880fSJoe Perches); 3902435880fSJoe Perches 3917840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3927840a94cSWolfram Sang irq| 3937840a94cSWolfram Sang memory 3947840a94cSWolfram Sang)}; 3957840a94cSWolfram Sang# memory.h: ARM has a custom one 3967840a94cSWolfram Sang 3978905a67cSAndy Whitcroftsub build_types { 398d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 399d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 4008716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 401c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 4028905a67cSAndy Whitcroft $NonptrType = qr{ 403d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 404cf655043SAndy Whitcroft (?: 4056b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 4068ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 407c45dcabdSAndy Whitcroft (?:${all}\b) 408cf655043SAndy Whitcroft ) 409c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 4108905a67cSAndy Whitcroft }x; 4118716de38SJoe Perches $NonptrTypeWithAttr = qr{ 4128716de38SJoe Perches (?:$Modifier\s+|const\s+)* 4138716de38SJoe Perches (?: 4148716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 4158716de38SJoe Perches (?:$typeTypedefs\b)| 4168716de38SJoe Perches (?:${allWithAttr}\b) 4178716de38SJoe Perches ) 4188716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4198716de38SJoe Perches }x; 4208905a67cSAndy Whitcroft $Type = qr{ 421c45dcabdSAndy Whitcroft $NonptrType 422b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 423c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 4248905a67cSAndy Whitcroft }x; 4258905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 4268905a67cSAndy Whitcroft} 4278905a67cSAndy Whitcroftbuild_types(); 4286c72ffaaSAndy Whitcroft 4297d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 430d1fe9c09SJoe Perches 431d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 432d1fe9c09SJoe Perches# requires at least perl version v5.10.0 433d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 434d1fe9c09SJoe Perches 435d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 4362435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 437d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 4387d2367afSJoe Perches 4397d2367afSJoe Perchessub deparenthesize { 4407d2367afSJoe Perches my ($string) = @_; 4417d2367afSJoe Perches return "" if (!defined($string)); 4425b9553abSJoe Perches 4435b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 4445b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 4455b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 4465b9553abSJoe Perches } 4475b9553abSJoe Perches 4487d2367afSJoe Perches $string =~ s@\s+@ @g; 4495b9553abSJoe Perches 4507d2367afSJoe Perches return $string; 4517d2367afSJoe Perches} 4527d2367afSJoe Perches 4533445686aSJoe Perchessub seed_camelcase_file { 4543445686aSJoe Perches my ($file) = @_; 4553445686aSJoe Perches 4563445686aSJoe Perches return if (!(-f $file)); 4573445686aSJoe Perches 4583445686aSJoe Perches local $/; 4593445686aSJoe Perches 4603445686aSJoe Perches open(my $include_file, '<', "$file") 4613445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4623445686aSJoe Perches my $text = <$include_file>; 4633445686aSJoe Perches close($include_file); 4643445686aSJoe Perches 4653445686aSJoe Perches my @lines = split('\n', $text); 4663445686aSJoe Perches 4673445686aSJoe Perches foreach my $line (@lines) { 4683445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4693445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4703445686aSJoe Perches $camelcase{$1} = 1; 47111ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 47211ea516aSJoe Perches $camelcase{$1} = 1; 47311ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 4743445686aSJoe Perches $camelcase{$1} = 1; 4753445686aSJoe Perches } 4763445686aSJoe Perches } 4773445686aSJoe Perches} 4783445686aSJoe Perches 4793445686aSJoe Perchesmy $camelcase_seeded = 0; 4803445686aSJoe Perchessub seed_camelcase_includes { 4813445686aSJoe Perches return if ($camelcase_seeded); 4823445686aSJoe Perches 4833445686aSJoe Perches my $files; 484c707a81dSJoe Perches my $camelcase_cache = ""; 485c707a81dSJoe Perches my @include_files = (); 486c707a81dSJoe Perches 487c707a81dSJoe Perches $camelcase_seeded = 1; 488351b2a1fSJoe Perches 4893645e328SRichard Genoud if (-e ".git") { 490351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 491351b2a1fSJoe Perches chomp $git_last_include_commit; 492c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 493c707a81dSJoe Perches } else { 494c707a81dSJoe Perches my $last_mod_date = 0; 495c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 496c707a81dSJoe Perches @include_files = split('\n', $files); 497c707a81dSJoe Perches foreach my $file (@include_files) { 498c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 499c707a81dSJoe Perches localtime((stat $file)[9])); 500c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 501c707a81dSJoe Perches } 502c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 503c707a81dSJoe Perches } 504c707a81dSJoe Perches 505c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 506c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 507c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 508351b2a1fSJoe Perches while (<$camelcase_file>) { 509351b2a1fSJoe Perches chomp; 510351b2a1fSJoe Perches $camelcase{$_} = 1; 511351b2a1fSJoe Perches } 512351b2a1fSJoe Perches close($camelcase_file); 513351b2a1fSJoe Perches 514351b2a1fSJoe Perches return; 515351b2a1fSJoe Perches } 516c707a81dSJoe Perches 5173645e328SRichard Genoud if (-e ".git") { 518c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 519c707a81dSJoe Perches @include_files = split('\n', $files); 5203445686aSJoe Perches } 521c707a81dSJoe Perches 5223445686aSJoe Perches foreach my $file (@include_files) { 5233445686aSJoe Perches seed_camelcase_file($file); 5243445686aSJoe Perches } 525351b2a1fSJoe Perches 526c707a81dSJoe Perches if ($camelcase_cache ne "") { 527351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 528c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 529c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 530351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 531351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 532351b2a1fSJoe Perches } 533351b2a1fSJoe Perches close($camelcase_file); 534351b2a1fSJoe Perches } 5353445686aSJoe Perches} 5363445686aSJoe Perches 5376c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5380a920b5bSAndy Whitcroft 53900df344fSAndy Whitcroftmy @rawlines = (); 540c2fdda0dSAndy Whitcroftmy @lines = (); 5413705ce5bSJoe Perchesmy @fixed = (); 542c2fdda0dSAndy Whitcroftmy $vname; 5436c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 54421caa13cSAndy Whitcroft my $FILE; 5456c72ffaaSAndy Whitcroft if ($file) { 54621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5476c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 54821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 54921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5506c72ffaaSAndy Whitcroft } else { 55121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5526c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5536c72ffaaSAndy Whitcroft } 554c2fdda0dSAndy Whitcroft if ($filename eq '-') { 555c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 556c2fdda0dSAndy Whitcroft } else { 557c2fdda0dSAndy Whitcroft $vname = $filename; 558c2fdda0dSAndy Whitcroft } 55921caa13cSAndy Whitcroft while (<$FILE>) { 5600a920b5bSAndy Whitcroft chomp; 56100df344fSAndy Whitcroft push(@rawlines, $_); 5626c72ffaaSAndy Whitcroft } 56321caa13cSAndy Whitcroft close($FILE); 564c2fdda0dSAndy Whitcroft if (!process($filename)) { 5650a920b5bSAndy Whitcroft $exit = 1; 5660a920b5bSAndy Whitcroft } 56700df344fSAndy Whitcroft @rawlines = (); 56813214adfSAndy Whitcroft @lines = (); 5693705ce5bSJoe Perches @fixed = (); 5700a920b5bSAndy Whitcroft} 5710a920b5bSAndy Whitcroft 5720a920b5bSAndy Whitcroftexit($exit); 5730a920b5bSAndy Whitcroft 5740a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5756c72ffaaSAndy Whitcroft my ($root) = @_; 5766c72ffaaSAndy Whitcroft 5776c72ffaaSAndy Whitcroft my @tree_check = ( 5786c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5796c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5806c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5816c72ffaaSAndy Whitcroft ); 5826c72ffaaSAndy Whitcroft 5836c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 5846c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 5850a920b5bSAndy Whitcroft return 0; 5860a920b5bSAndy Whitcroft } 5876c72ffaaSAndy Whitcroft } 5886c72ffaaSAndy Whitcroft return 1; 5896c72ffaaSAndy Whitcroft} 5900a920b5bSAndy Whitcroft 59120112475SJoe Perchessub parse_email { 59220112475SJoe Perches my ($formatted_email) = @_; 59320112475SJoe Perches 59420112475SJoe Perches my $name = ""; 59520112475SJoe Perches my $address = ""; 59620112475SJoe Perches my $comment = ""; 59720112475SJoe Perches 59820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 59920112475SJoe Perches $name = $1; 60020112475SJoe Perches $address = $2; 60120112475SJoe Perches $comment = $3 if defined $3; 60220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 60320112475SJoe Perches $address = $1; 60420112475SJoe Perches $comment = $2 if defined $2; 60520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 60620112475SJoe Perches $address = $1; 60720112475SJoe Perches $comment = $2 if defined $2; 60820112475SJoe Perches $formatted_email =~ s/$address.*$//; 60920112475SJoe Perches $name = $formatted_email; 6103705ce5bSJoe Perches $name = trim($name); 61120112475SJoe Perches $name =~ s/^\"|\"$//g; 61220112475SJoe Perches # If there's a name left after stripping spaces and 61320112475SJoe Perches # leading quotes, and the address doesn't have both 61420112475SJoe Perches # leading and trailing angle brackets, the address 61520112475SJoe Perches # is invalid. ie: 61620112475SJoe Perches # "joe smith [email protected]" bad 61720112475SJoe Perches # "joe smith <[email protected]" bad 61820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 61920112475SJoe Perches $name = ""; 62020112475SJoe Perches $address = ""; 62120112475SJoe Perches $comment = ""; 62220112475SJoe Perches } 62320112475SJoe Perches } 62420112475SJoe Perches 6253705ce5bSJoe Perches $name = trim($name); 62620112475SJoe Perches $name =~ s/^\"|\"$//g; 6273705ce5bSJoe Perches $address = trim($address); 62820112475SJoe Perches $address =~ s/^\<|\>$//g; 62920112475SJoe Perches 63020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 63120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 63220112475SJoe Perches $name = "\"$name\""; 63320112475SJoe Perches } 63420112475SJoe Perches 63520112475SJoe Perches return ($name, $address, $comment); 63620112475SJoe Perches} 63720112475SJoe Perches 63820112475SJoe Perchessub format_email { 63920112475SJoe Perches my ($name, $address) = @_; 64020112475SJoe Perches 64120112475SJoe Perches my $formatted_email; 64220112475SJoe Perches 6433705ce5bSJoe Perches $name = trim($name); 64420112475SJoe Perches $name =~ s/^\"|\"$//g; 6453705ce5bSJoe Perches $address = trim($address); 64620112475SJoe Perches 64720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 64820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 64920112475SJoe Perches $name = "\"$name\""; 65020112475SJoe Perches } 65120112475SJoe Perches 65220112475SJoe Perches if ("$name" eq "") { 65320112475SJoe Perches $formatted_email = "$address"; 65420112475SJoe Perches } else { 65520112475SJoe Perches $formatted_email = "$name <$address>"; 65620112475SJoe Perches } 65720112475SJoe Perches 65820112475SJoe Perches return $formatted_email; 65920112475SJoe Perches} 66020112475SJoe Perches 661000d1cc1SJoe Perchessub which_conf { 662000d1cc1SJoe Perches my ($conf) = @_; 663000d1cc1SJoe Perches 664000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 665000d1cc1SJoe Perches if (-e "$path/$conf") { 666000d1cc1SJoe Perches return "$path/$conf"; 667000d1cc1SJoe Perches } 668000d1cc1SJoe Perches } 669000d1cc1SJoe Perches 670000d1cc1SJoe Perches return ""; 671000d1cc1SJoe Perches} 672000d1cc1SJoe Perches 6730a920b5bSAndy Whitcroftsub expand_tabs { 6740a920b5bSAndy Whitcroft my ($str) = @_; 6750a920b5bSAndy Whitcroft 6760a920b5bSAndy Whitcroft my $res = ''; 6770a920b5bSAndy Whitcroft my $n = 0; 6780a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6790a920b5bSAndy Whitcroft if ($c eq "\t") { 6800a920b5bSAndy Whitcroft $res .= ' '; 6810a920b5bSAndy Whitcroft $n++; 6820a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6830a920b5bSAndy Whitcroft $res .= ' '; 6840a920b5bSAndy Whitcroft } 6850a920b5bSAndy Whitcroft next; 6860a920b5bSAndy Whitcroft } 6870a920b5bSAndy Whitcroft $res .= $c; 6880a920b5bSAndy Whitcroft $n++; 6890a920b5bSAndy Whitcroft } 6900a920b5bSAndy Whitcroft 6910a920b5bSAndy Whitcroft return $res; 6920a920b5bSAndy Whitcroft} 6936c72ffaaSAndy Whitcroftsub copy_spacing { 694773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 6956c72ffaaSAndy Whitcroft return $res; 6966c72ffaaSAndy Whitcroft} 6970a920b5bSAndy Whitcroft 6984a0df2efSAndy Whitcroftsub line_stats { 6994a0df2efSAndy Whitcroft my ($line) = @_; 7004a0df2efSAndy Whitcroft 7014a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 7024a0df2efSAndy Whitcroft $line =~ s/^.//; 7034a0df2efSAndy Whitcroft $line = expand_tabs($line); 7044a0df2efSAndy Whitcroft 7054a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 7064a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 7074a0df2efSAndy Whitcroft 7084a0df2efSAndy Whitcroft return (length($line), length($white)); 7094a0df2efSAndy Whitcroft} 7104a0df2efSAndy Whitcroft 711773647a0SAndy Whitcroftmy $sanitise_quote = ''; 712773647a0SAndy Whitcroft 713773647a0SAndy Whitcroftsub sanitise_line_reset { 714773647a0SAndy Whitcroft my ($in_comment) = @_; 715773647a0SAndy Whitcroft 716773647a0SAndy Whitcroft if ($in_comment) { 717773647a0SAndy Whitcroft $sanitise_quote = '*/'; 718773647a0SAndy Whitcroft } else { 719773647a0SAndy Whitcroft $sanitise_quote = ''; 720773647a0SAndy Whitcroft } 721773647a0SAndy Whitcroft} 72200df344fSAndy Whitcroftsub sanitise_line { 72300df344fSAndy Whitcroft my ($line) = @_; 72400df344fSAndy Whitcroft 72500df344fSAndy Whitcroft my $res = ''; 72600df344fSAndy Whitcroft my $l = ''; 72700df344fSAndy Whitcroft 728c2fdda0dSAndy Whitcroft my $qlen = 0; 729773647a0SAndy Whitcroft my $off = 0; 730773647a0SAndy Whitcroft my $c; 73100df344fSAndy Whitcroft 732773647a0SAndy Whitcroft # Always copy over the diff marker. 733773647a0SAndy Whitcroft $res = substr($line, 0, 1); 734773647a0SAndy Whitcroft 735773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 736773647a0SAndy Whitcroft $c = substr($line, $off, 1); 737773647a0SAndy Whitcroft 738773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 739773647a0SAndy Whitcroft # and end, all to $;. 740773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 741773647a0SAndy Whitcroft $sanitise_quote = '*/'; 742773647a0SAndy Whitcroft 743773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 744773647a0SAndy Whitcroft $off++; 74500df344fSAndy Whitcroft next; 746773647a0SAndy Whitcroft } 74781bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 748773647a0SAndy Whitcroft $sanitise_quote = ''; 749773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 750773647a0SAndy Whitcroft $off++; 751773647a0SAndy Whitcroft next; 752773647a0SAndy Whitcroft } 753113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 754113f04a8SDaniel Walker $sanitise_quote = '//'; 755113f04a8SDaniel Walker 756113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 757113f04a8SDaniel Walker $off++; 758113f04a8SDaniel Walker next; 759113f04a8SDaniel Walker } 760773647a0SAndy Whitcroft 761773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 762773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 763773647a0SAndy Whitcroft $c eq "\\") { 764773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 765773647a0SAndy Whitcroft $off++; 766773647a0SAndy Whitcroft next; 767773647a0SAndy Whitcroft } 768773647a0SAndy Whitcroft # Regular quotes. 769773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 770773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 771773647a0SAndy Whitcroft $sanitise_quote = $c; 772773647a0SAndy Whitcroft 773773647a0SAndy Whitcroft substr($res, $off, 1, $c); 774773647a0SAndy Whitcroft next; 775773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 776773647a0SAndy Whitcroft $sanitise_quote = ''; 77700df344fSAndy Whitcroft } 77800df344fSAndy Whitcroft } 779773647a0SAndy Whitcroft 780fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 781773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 782773647a0SAndy Whitcroft substr($res, $off, 1, $;); 783113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 784113f04a8SDaniel Walker substr($res, $off, 1, $;); 785773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 786773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 78700df344fSAndy Whitcroft } else { 788773647a0SAndy Whitcroft substr($res, $off, 1, $c); 78900df344fSAndy Whitcroft } 790c2fdda0dSAndy Whitcroft } 791c2fdda0dSAndy Whitcroft 792113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 793113f04a8SDaniel Walker $sanitise_quote = ''; 794113f04a8SDaniel Walker } 795113f04a8SDaniel Walker 796c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 797c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 798c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 799c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 800c2fdda0dSAndy Whitcroft 801c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 802c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 803c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 804c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 805c2fdda0dSAndy Whitcroft } 806c2fdda0dSAndy Whitcroft 80700df344fSAndy Whitcroft return $res; 80800df344fSAndy Whitcroft} 80900df344fSAndy Whitcroft 810a6962d72SJoe Perchessub get_quoted_string { 811a6962d72SJoe Perches my ($line, $rawline) = @_; 812a6962d72SJoe Perches 813a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 814a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 815a6962d72SJoe Perches} 816a6962d72SJoe Perches 8178905a67cSAndy Whitcroftsub ctx_statement_block { 8188905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8198905a67cSAndy Whitcroft my $line = $linenr - 1; 8208905a67cSAndy Whitcroft my $blk = ''; 8218905a67cSAndy Whitcroft my $soff = $off; 8228905a67cSAndy Whitcroft my $coff = $off - 1; 823773647a0SAndy Whitcroft my $coff_set = 0; 8248905a67cSAndy Whitcroft 82513214adfSAndy Whitcroft my $loff = 0; 82613214adfSAndy Whitcroft 8278905a67cSAndy Whitcroft my $type = ''; 8288905a67cSAndy Whitcroft my $level = 0; 829a2750645SAndy Whitcroft my @stack = (); 830cf655043SAndy Whitcroft my $p; 8318905a67cSAndy Whitcroft my $c; 8328905a67cSAndy Whitcroft my $len = 0; 83313214adfSAndy Whitcroft 83413214adfSAndy Whitcroft my $remainder; 8358905a67cSAndy Whitcroft while (1) { 836a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 837a2750645SAndy Whitcroft 838773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8398905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8408905a67cSAndy Whitcroft # context. 8418905a67cSAndy Whitcroft if ($off >= $len) { 8428905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 843dea33496SAndy Whitcroft last if (!defined $lines[$line]); 844c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 8458905a67cSAndy Whitcroft $remain--; 84613214adfSAndy Whitcroft $loff = $len; 847c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8488905a67cSAndy Whitcroft $len = length($blk); 8498905a67cSAndy Whitcroft $line++; 8508905a67cSAndy Whitcroft last; 8518905a67cSAndy Whitcroft } 8528905a67cSAndy Whitcroft # Bail if there is no further context. 8538905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 85413214adfSAndy Whitcroft if ($off >= $len) { 8558905a67cSAndy Whitcroft last; 8568905a67cSAndy Whitcroft } 857f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 858f74bd194SAndy Whitcroft $level++; 859f74bd194SAndy Whitcroft $type = '#'; 860f74bd194SAndy Whitcroft } 8618905a67cSAndy Whitcroft } 862cf655043SAndy Whitcroft $p = $c; 8638905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 86413214adfSAndy Whitcroft $remainder = substr($blk, $off); 8658905a67cSAndy Whitcroft 866773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8674635f4fbSAndy Whitcroft 8684635f4fbSAndy Whitcroft # Handle nested #if/#else. 8694635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8704635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8714635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8724635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8734635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8744635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8754635f4fbSAndy Whitcroft } 8764635f4fbSAndy Whitcroft 8778905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8788905a67cSAndy Whitcroft # outermost level. 8798905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8808905a67cSAndy Whitcroft last; 8818905a67cSAndy Whitcroft } 8828905a67cSAndy Whitcroft 88313214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 884773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 885773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 886773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 887773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 888773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 889773647a0SAndy Whitcroft $coff_set = 1; 890773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 891773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 89213214adfSAndy Whitcroft } 89313214adfSAndy Whitcroft 8948905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 8958905a67cSAndy Whitcroft $level++; 8968905a67cSAndy Whitcroft $type = '('; 8978905a67cSAndy Whitcroft } 8988905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 8998905a67cSAndy Whitcroft $level--; 9008905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 9018905a67cSAndy Whitcroft 9028905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 9038905a67cSAndy Whitcroft $coff = $off; 904773647a0SAndy Whitcroft $coff_set = 1; 905773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 9068905a67cSAndy Whitcroft } 9078905a67cSAndy Whitcroft } 9088905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 9098905a67cSAndy Whitcroft $level++; 9108905a67cSAndy Whitcroft $type = '{'; 9118905a67cSAndy Whitcroft } 9128905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 9138905a67cSAndy Whitcroft $level--; 9148905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9158905a67cSAndy Whitcroft 9168905a67cSAndy Whitcroft if ($level == 0) { 917b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 918b998e001SPatrick Pannuto $off++; 919b998e001SPatrick Pannuto } 9208905a67cSAndy Whitcroft last; 9218905a67cSAndy Whitcroft } 9228905a67cSAndy Whitcroft } 923f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 924f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 925f74bd194SAndy Whitcroft $level--; 926f74bd194SAndy Whitcroft $type = ''; 927f74bd194SAndy Whitcroft $off++; 928f74bd194SAndy Whitcroft last; 929f74bd194SAndy Whitcroft } 9308905a67cSAndy Whitcroft $off++; 9318905a67cSAndy Whitcroft } 932a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 93313214adfSAndy Whitcroft if ($off == $len) { 934a3bb97a7SAndy Whitcroft $loff = $len + 1; 93513214adfSAndy Whitcroft $line++; 93613214adfSAndy Whitcroft $remain--; 93713214adfSAndy Whitcroft } 9388905a67cSAndy Whitcroft 9398905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9408905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 9418905a67cSAndy Whitcroft 9428905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 9438905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 9448905a67cSAndy Whitcroft 945773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 94613214adfSAndy Whitcroft 94713214adfSAndy Whitcroft return ($statement, $condition, 94813214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 94913214adfSAndy Whitcroft} 95013214adfSAndy Whitcroft 951cf655043SAndy Whitcroftsub statement_lines { 952cf655043SAndy Whitcroft my ($stmt) = @_; 953cf655043SAndy Whitcroft 954cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 955cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 956cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 957cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 958cf655043SAndy Whitcroft 959cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 960cf655043SAndy Whitcroft 961cf655043SAndy Whitcroft return $#stmt_lines + 2; 962cf655043SAndy Whitcroft} 963cf655043SAndy Whitcroft 964cf655043SAndy Whitcroftsub statement_rawlines { 965cf655043SAndy Whitcroft my ($stmt) = @_; 966cf655043SAndy Whitcroft 967cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 968cf655043SAndy Whitcroft 969cf655043SAndy Whitcroft return $#stmt_lines + 2; 970cf655043SAndy Whitcroft} 971cf655043SAndy Whitcroft 972cf655043SAndy Whitcroftsub statement_block_size { 973cf655043SAndy Whitcroft my ($stmt) = @_; 974cf655043SAndy Whitcroft 975cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 976cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 977cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 978cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 979cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 980cf655043SAndy Whitcroft 981cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 982cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 983cf655043SAndy Whitcroft 984cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 985cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 986cf655043SAndy Whitcroft 987cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 988cf655043SAndy Whitcroft return $stmt_lines; 989cf655043SAndy Whitcroft } else { 990cf655043SAndy Whitcroft return $stmt_statements; 991cf655043SAndy Whitcroft } 992cf655043SAndy Whitcroft} 993cf655043SAndy Whitcroft 99413214adfSAndy Whitcroftsub ctx_statement_full { 99513214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 99613214adfSAndy Whitcroft my ($statement, $condition, $level); 99713214adfSAndy Whitcroft 99813214adfSAndy Whitcroft my (@chunks); 99913214adfSAndy Whitcroft 1000cf655043SAndy Whitcroft # Grab the first conditional/block pair. 100113214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 100213214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1003773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 100413214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1005cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1006cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1007cf655043SAndy Whitcroft } 1008cf655043SAndy Whitcroft 1009cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1010cf655043SAndy Whitcroft # could continue the statement. 1011cf655043SAndy Whitcroft for (;;) { 101213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 101313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1014cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1015773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1016cf655043SAndy Whitcroft #print "C: push\n"; 1017cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 101813214adfSAndy Whitcroft } 101913214adfSAndy Whitcroft 102013214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10218905a67cSAndy Whitcroft} 10228905a67cSAndy Whitcroft 10234a0df2efSAndy Whitcroftsub ctx_block_get { 1024f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10254a0df2efSAndy Whitcroft my $line; 10264a0df2efSAndy Whitcroft my $start = $linenr - 1; 10274a0df2efSAndy Whitcroft my $blk = ''; 10284a0df2efSAndy Whitcroft my @o; 10294a0df2efSAndy Whitcroft my @c; 10304a0df2efSAndy Whitcroft my @res = (); 10314a0df2efSAndy Whitcroft 1032f0a594c1SAndy Whitcroft my $level = 0; 10334635f4fbSAndy Whitcroft my @stack = ($level); 103400df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 103500df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 103600df344fSAndy Whitcroft $remain--; 103700df344fSAndy Whitcroft 103800df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10394635f4fbSAndy Whitcroft 10404635f4fbSAndy Whitcroft # Handle nested #if/#else. 104101464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 10424635f4fbSAndy Whitcroft push(@stack, $level); 104301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 10444635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 104501464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10464635f4fbSAndy Whitcroft $level = pop(@stack); 10474635f4fbSAndy Whitcroft } 10484635f4fbSAndy Whitcroft 104901464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1050f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1051f0a594c1SAndy Whitcroft if ($off > 0) { 1052f0a594c1SAndy Whitcroft $off--; 1053f0a594c1SAndy Whitcroft next; 1054f0a594c1SAndy Whitcroft } 10554a0df2efSAndy Whitcroft 1056f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1057f0a594c1SAndy Whitcroft $level--; 1058f0a594c1SAndy Whitcroft last if ($level == 0); 1059f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1060f0a594c1SAndy Whitcroft $level++; 1061f0a594c1SAndy Whitcroft } 1062f0a594c1SAndy Whitcroft } 10634a0df2efSAndy Whitcroft 1064f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 106500df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10664a0df2efSAndy Whitcroft } 10674a0df2efSAndy Whitcroft 1068f0a594c1SAndy Whitcroft last if ($level == 0); 10694a0df2efSAndy Whitcroft } 10704a0df2efSAndy Whitcroft 1071f0a594c1SAndy Whitcroft return ($level, @res); 10724a0df2efSAndy Whitcroft} 10734a0df2efSAndy Whitcroftsub ctx_block_outer { 10744a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10754a0df2efSAndy Whitcroft 1076f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1077f0a594c1SAndy Whitcroft return @r; 10784a0df2efSAndy Whitcroft} 10794a0df2efSAndy Whitcroftsub ctx_block { 10804a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10814a0df2efSAndy Whitcroft 1082f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1083f0a594c1SAndy Whitcroft return @r; 1084653d4876SAndy Whitcroft} 1085653d4876SAndy Whitcroftsub ctx_statement { 1086f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1087f0a594c1SAndy Whitcroft 1088f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1089f0a594c1SAndy Whitcroft return @r; 1090f0a594c1SAndy Whitcroft} 1091f0a594c1SAndy Whitcroftsub ctx_block_level { 1092653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1093653d4876SAndy Whitcroft 1094f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 10954a0df2efSAndy Whitcroft} 10969c0ca6f9SAndy Whitcroftsub ctx_statement_level { 10979c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 10989c0ca6f9SAndy Whitcroft 10999c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 11009c0ca6f9SAndy Whitcroft} 11014a0df2efSAndy Whitcroft 11024a0df2efSAndy Whitcroftsub ctx_locate_comment { 11034a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11044a0df2efSAndy Whitcroft 11054a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1106beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 11074a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 11084a0df2efSAndy Whitcroft 11094a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 11104a0df2efSAndy Whitcroft # comment. 11114a0df2efSAndy Whitcroft my $in_comment = 0; 11124a0df2efSAndy Whitcroft $current_comment = ''; 11134a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 111400df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 111500df344fSAndy Whitcroft #warn " $line\n"; 11164a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11174a0df2efSAndy Whitcroft $in_comment = 1; 11184a0df2efSAndy Whitcroft } 11194a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11204a0df2efSAndy Whitcroft $in_comment = 1; 11214a0df2efSAndy Whitcroft } 11224a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11234a0df2efSAndy Whitcroft $current_comment = ''; 11244a0df2efSAndy Whitcroft } 11254a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11264a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11274a0df2efSAndy Whitcroft $in_comment = 0; 11284a0df2efSAndy Whitcroft } 11294a0df2efSAndy Whitcroft } 11304a0df2efSAndy Whitcroft 11314a0df2efSAndy Whitcroft chomp($current_comment); 11324a0df2efSAndy Whitcroft return($current_comment); 11334a0df2efSAndy Whitcroft} 11344a0df2efSAndy Whitcroftsub ctx_has_comment { 11354a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11364a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11374a0df2efSAndy Whitcroft 113800df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11394a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11404a0df2efSAndy Whitcroft 11414a0df2efSAndy Whitcroft return ($cmt ne ''); 11424a0df2efSAndy Whitcroft} 11434a0df2efSAndy Whitcroft 11444d001e4dSAndy Whitcroftsub raw_line { 11454d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11464d001e4dSAndy Whitcroft 11474d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11484d001e4dSAndy Whitcroft $cnt++; 11494d001e4dSAndy Whitcroft 11504d001e4dSAndy Whitcroft my $line; 11514d001e4dSAndy Whitcroft while ($cnt) { 11524d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11534d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11544d001e4dSAndy Whitcroft $cnt--; 11554d001e4dSAndy Whitcroft } 11564d001e4dSAndy Whitcroft 11574d001e4dSAndy Whitcroft return $line; 11584d001e4dSAndy Whitcroft} 11594d001e4dSAndy Whitcroft 11600a920b5bSAndy Whitcroftsub cat_vet { 11610a920b5bSAndy Whitcroft my ($vet) = @_; 11629c0ca6f9SAndy Whitcroft my ($res, $coded); 11630a920b5bSAndy Whitcroft 11649c0ca6f9SAndy Whitcroft $res = ''; 11656c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11666c72ffaaSAndy Whitcroft $res .= $1; 11676c72ffaaSAndy Whitcroft if ($2 ne '') { 11689c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11696c72ffaaSAndy Whitcroft $res .= $coded; 11706c72ffaaSAndy Whitcroft } 11719c0ca6f9SAndy Whitcroft } 11729c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11730a920b5bSAndy Whitcroft 11749c0ca6f9SAndy Whitcroft return $res; 11750a920b5bSAndy Whitcroft} 11760a920b5bSAndy Whitcroft 1177c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1178cf655043SAndy Whitcroftmy $av_pending; 1179c2fdda0dSAndy Whitcroftmy @av_paren_type; 11801f65f947SAndy Whitcroftmy $av_pend_colon; 1181c2fdda0dSAndy Whitcroft 1182c2fdda0dSAndy Whitcroftsub annotate_reset { 1183c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1184cf655043SAndy Whitcroft $av_pending = '_'; 1185cf655043SAndy Whitcroft @av_paren_type = ('E'); 11861f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1187c2fdda0dSAndy Whitcroft} 1188c2fdda0dSAndy Whitcroft 11896c72ffaaSAndy Whitcroftsub annotate_values { 11906c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 11916c72ffaaSAndy Whitcroft 11926c72ffaaSAndy Whitcroft my $res; 11931f65f947SAndy Whitcroft my $var = '_' x length($stream); 11946c72ffaaSAndy Whitcroft my $cur = $stream; 11956c72ffaaSAndy Whitcroft 1196c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 11976c72ffaaSAndy Whitcroft 11986c72ffaaSAndy Whitcroft while (length($cur)) { 1199773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1200cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1201171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 12026c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1203c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1204c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1205cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1206c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 12076c72ffaaSAndy Whitcroft } 12086c72ffaaSAndy Whitcroft 1209c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 12109446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 12119446ef56SAndy Whitcroft push(@av_paren_type, $type); 1212addcdceaSAndy Whitcroft $type = 'c'; 12139446ef56SAndy Whitcroft 1214e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1215c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12166c72ffaaSAndy Whitcroft $type = 'T'; 12176c72ffaaSAndy Whitcroft 1218389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1219389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1220389a2fe5SAndy Whitcroft $type = 'T'; 1221389a2fe5SAndy Whitcroft 1222c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1223171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1224c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1225171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1226171ae1a4SAndy Whitcroft if ($2 ne '') { 1227cf655043SAndy Whitcroft $av_pending = 'N'; 1228171ae1a4SAndy Whitcroft } 1229171ae1a4SAndy Whitcroft $type = 'E'; 1230171ae1a4SAndy Whitcroft 1231c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1232171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1233171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1234171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12356c72ffaaSAndy Whitcroft 1236c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1237cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1238c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1239cf655043SAndy Whitcroft 1240cf655043SAndy Whitcroft push(@av_paren_type, $type); 1241cf655043SAndy Whitcroft push(@av_paren_type, $type); 1242171ae1a4SAndy Whitcroft $type = 'E'; 1243cf655043SAndy Whitcroft 1244c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1245cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1246cf655043SAndy Whitcroft $av_preprocessor = 1; 1247cf655043SAndy Whitcroft 1248cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1249cf655043SAndy Whitcroft 1250171ae1a4SAndy Whitcroft $type = 'E'; 1251cf655043SAndy Whitcroft 1252c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1253cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1254cf655043SAndy Whitcroft 1255cf655043SAndy Whitcroft $av_preprocessor = 1; 1256cf655043SAndy Whitcroft 1257cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1258cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1259cf655043SAndy Whitcroft pop(@av_paren_type); 1260cf655043SAndy Whitcroft push(@av_paren_type, $type); 1261171ae1a4SAndy Whitcroft $type = 'E'; 12626c72ffaaSAndy Whitcroft 12636c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1264c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12656c72ffaaSAndy Whitcroft 1266171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1267171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1268171ae1a4SAndy Whitcroft $av_pending = $type; 1269171ae1a4SAndy Whitcroft $type = 'N'; 1270171ae1a4SAndy Whitcroft 12716c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1272c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12736c72ffaaSAndy Whitcroft if (defined $2) { 1274cf655043SAndy Whitcroft $av_pending = 'V'; 12756c72ffaaSAndy Whitcroft } 12766c72ffaaSAndy Whitcroft $type = 'N'; 12776c72ffaaSAndy Whitcroft 127814b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1279c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 128014b111c1SAndy Whitcroft $av_pending = 'E'; 12816c72ffaaSAndy Whitcroft $type = 'N'; 12826c72ffaaSAndy Whitcroft 12831f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 12841f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 12851f65f947SAndy Whitcroft $av_pend_colon = 'C'; 12861f65f947SAndy Whitcroft $type = 'N'; 12871f65f947SAndy Whitcroft 128814b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1289c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 12906c72ffaaSAndy Whitcroft $type = 'N'; 12916c72ffaaSAndy Whitcroft 12926c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1293c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1294cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1295cf655043SAndy Whitcroft $av_pending = '_'; 12966c72ffaaSAndy Whitcroft $type = 'N'; 12976c72ffaaSAndy Whitcroft 12986c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1299cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1300cf655043SAndy Whitcroft if ($new_type ne '_') { 1301cf655043SAndy Whitcroft $type = $new_type; 1302c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1303c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 13046c72ffaaSAndy Whitcroft } else { 1305c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 13066c72ffaaSAndy Whitcroft } 13076c72ffaaSAndy Whitcroft 1308c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1309c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1310c8cb2ca3SAndy Whitcroft $type = 'V'; 1311cf655043SAndy Whitcroft $av_pending = 'V'; 13126c72ffaaSAndy Whitcroft 13138e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 13148e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13151f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13168e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13178e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13181f65f947SAndy Whitcroft } 13191f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13201f65f947SAndy Whitcroft $type = 'V'; 13211f65f947SAndy Whitcroft 13226c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1323c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13246c72ffaaSAndy Whitcroft $type = 'V'; 13256c72ffaaSAndy Whitcroft 13266c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1327c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13286c72ffaaSAndy Whitcroft $type = 'N'; 13296c72ffaaSAndy Whitcroft 1330cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1331c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 133213214adfSAndy Whitcroft $type = 'E'; 13331f65f947SAndy Whitcroft $av_pend_colon = 'O'; 133413214adfSAndy Whitcroft 13358e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13368e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13378e761b04SAndy Whitcroft $type = 'C'; 13388e761b04SAndy Whitcroft 13391f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13401f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 13411f65f947SAndy Whitcroft $type = 'N'; 13421f65f947SAndy Whitcroft 13431f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 13441f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 13451f65f947SAndy Whitcroft 13461f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13471f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13481f65f947SAndy Whitcroft $type = 'E'; 13491f65f947SAndy Whitcroft } else { 13501f65f947SAndy Whitcroft $type = 'N'; 13511f65f947SAndy Whitcroft } 13521f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13531f65f947SAndy Whitcroft 13548e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 135513214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13566c72ffaaSAndy Whitcroft $type = 'N'; 13576c72ffaaSAndy Whitcroft 13580d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 135974048ed8SAndy Whitcroft my $variant; 136074048ed8SAndy Whitcroft 136174048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 136274048ed8SAndy Whitcroft if ($type eq 'V') { 136374048ed8SAndy Whitcroft $variant = 'B'; 136474048ed8SAndy Whitcroft } else { 136574048ed8SAndy Whitcroft $variant = 'U'; 136674048ed8SAndy Whitcroft } 136774048ed8SAndy Whitcroft 136874048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 136974048ed8SAndy Whitcroft $type = 'N'; 137074048ed8SAndy Whitcroft 13716c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1372c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13736c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13746c72ffaaSAndy Whitcroft $type = 'N'; 13756c72ffaaSAndy Whitcroft } 13766c72ffaaSAndy Whitcroft 13776c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1378c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13796c72ffaaSAndy Whitcroft } 13806c72ffaaSAndy Whitcroft if (defined $1) { 13816c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13826c72ffaaSAndy Whitcroft $res .= $type x length($1); 13836c72ffaaSAndy Whitcroft } 13846c72ffaaSAndy Whitcroft } 13856c72ffaaSAndy Whitcroft 13861f65f947SAndy Whitcroft return ($res, $var); 13876c72ffaaSAndy Whitcroft} 13886c72ffaaSAndy Whitcroft 13898905a67cSAndy Whitcroftsub possible { 139013214adfSAndy Whitcroft my ($possible, $line) = @_; 13919a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 13920776e594SAndy Whitcroft ^(?: 13930776e594SAndy Whitcroft $Modifier| 13940776e594SAndy Whitcroft $Storage| 13950776e594SAndy Whitcroft $Type| 13969a974fdbSAndy Whitcroft DEFINE_\S+ 13979a974fdbSAndy Whitcroft )$| 13989a974fdbSAndy Whitcroft ^(?: 13990776e594SAndy Whitcroft goto| 14000776e594SAndy Whitcroft return| 14010776e594SAndy Whitcroft case| 14020776e594SAndy Whitcroft else| 14030776e594SAndy Whitcroft asm|__asm__| 140489a88353SAndy Whitcroft do| 140589a88353SAndy Whitcroft \#| 140689a88353SAndy Whitcroft \#\#| 14079a974fdbSAndy Whitcroft )(?:\s|$)| 14080776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 14099a974fdbSAndy Whitcroft )}x; 14109a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 14119a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1412c45dcabdSAndy Whitcroft # Check for modifiers. 1413c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1414c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1415c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1416c45dcabdSAndy Whitcroft 1417c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1418c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1419d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14209a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1421d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1422d2506586SAndy Whitcroft push(@modifierList, $modifier); 1423d2506586SAndy Whitcroft } 14249a974fdbSAndy Whitcroft } 1425c45dcabdSAndy Whitcroft 1426c45dcabdSAndy Whitcroft } else { 142713214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14288905a67cSAndy Whitcroft push(@typeList, $possible); 1429c45dcabdSAndy Whitcroft } 14308905a67cSAndy Whitcroft build_types(); 14310776e594SAndy Whitcroft } else { 14320776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14338905a67cSAndy Whitcroft } 14348905a67cSAndy Whitcroft} 14358905a67cSAndy Whitcroft 14366c72ffaaSAndy Whitcroftmy $prefix = ''; 14376c72ffaaSAndy Whitcroft 1438000d1cc1SJoe Perchessub show_type { 1439cbec18afSJoe Perches my ($type) = @_; 144091bfe484SJoe Perches 1441cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1442cbec18afSJoe Perches 1443cbec18afSJoe Perches return !defined $ignore_type{$type}; 1444000d1cc1SJoe Perches} 1445000d1cc1SJoe Perches 1446f0a594c1SAndy Whitcroftsub report { 1447cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1448cbec18afSJoe Perches 1449cbec18afSJoe Perches if (!show_type($type) || 1450cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1451773647a0SAndy Whitcroft return 0; 1452773647a0SAndy Whitcroft } 1453000d1cc1SJoe Perches my $line; 1454000d1cc1SJoe Perches if ($show_types) { 1455cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1456000d1cc1SJoe Perches } else { 1457cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1458000d1cc1SJoe Perches } 14598905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14608905a67cSAndy Whitcroft 146113214adfSAndy Whitcroft push(our @report, $line); 1462773647a0SAndy Whitcroft 1463773647a0SAndy Whitcroft return 1; 1464f0a594c1SAndy Whitcroft} 1465cbec18afSJoe Perches 1466f0a594c1SAndy Whitcroftsub report_dump { 146713214adfSAndy Whitcroft our @report; 1468f0a594c1SAndy Whitcroft} 1469000d1cc1SJoe Perches 1470de7d4f0eSAndy Whitcroftsub ERROR { 1471cbec18afSJoe Perches my ($type, $msg) = @_; 1472cbec18afSJoe Perches 1473cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1474de7d4f0eSAndy Whitcroft our $clean = 0; 14756c72ffaaSAndy Whitcroft our $cnt_error++; 14763705ce5bSJoe Perches return 1; 1477de7d4f0eSAndy Whitcroft } 14783705ce5bSJoe Perches return 0; 1479773647a0SAndy Whitcroft} 1480de7d4f0eSAndy Whitcroftsub WARN { 1481cbec18afSJoe Perches my ($type, $msg) = @_; 1482cbec18afSJoe Perches 1483cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1484de7d4f0eSAndy Whitcroft our $clean = 0; 14856c72ffaaSAndy Whitcroft our $cnt_warn++; 14863705ce5bSJoe Perches return 1; 1487de7d4f0eSAndy Whitcroft } 14883705ce5bSJoe Perches return 0; 1489773647a0SAndy Whitcroft} 1490de7d4f0eSAndy Whitcroftsub CHK { 1491cbec18afSJoe Perches my ($type, $msg) = @_; 1492cbec18afSJoe Perches 1493cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1494de7d4f0eSAndy Whitcroft our $clean = 0; 14956c72ffaaSAndy Whitcroft our $cnt_chk++; 14963705ce5bSJoe Perches return 1; 14976c72ffaaSAndy Whitcroft } 14983705ce5bSJoe Perches return 0; 1499de7d4f0eSAndy Whitcroft} 1500de7d4f0eSAndy Whitcroft 15016ecd9674SAndy Whitcroftsub check_absolute_file { 15026ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 15036ecd9674SAndy Whitcroft my $file = $absolute; 15046ecd9674SAndy Whitcroft 15056ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 15066ecd9674SAndy Whitcroft 15076ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 15086ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 15096ecd9674SAndy Whitcroft if (-f "$root/$file") { 15106ecd9674SAndy Whitcroft ##print "file<$file>\n"; 15116ecd9674SAndy Whitcroft last; 15126ecd9674SAndy Whitcroft } 15136ecd9674SAndy Whitcroft } 15146ecd9674SAndy Whitcroft if (! -f _) { 15156ecd9674SAndy Whitcroft return 0; 15166ecd9674SAndy Whitcroft } 15176ecd9674SAndy Whitcroft 15186ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 15196ecd9674SAndy Whitcroft my $prefix = $absolute; 15206ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 15216ecd9674SAndy Whitcroft 15226ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 15236ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1524000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1525000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 15266ecd9674SAndy Whitcroft } 15276ecd9674SAndy Whitcroft} 15286ecd9674SAndy Whitcroft 15293705ce5bSJoe Perchessub trim { 15303705ce5bSJoe Perches my ($string) = @_; 15313705ce5bSJoe Perches 1532b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1533b34c648bSJoe Perches 1534b34c648bSJoe Perches return $string; 1535b34c648bSJoe Perches} 1536b34c648bSJoe Perches 1537b34c648bSJoe Perchessub ltrim { 1538b34c648bSJoe Perches my ($string) = @_; 1539b34c648bSJoe Perches 1540b34c648bSJoe Perches $string =~ s/^\s+//; 1541b34c648bSJoe Perches 1542b34c648bSJoe Perches return $string; 1543b34c648bSJoe Perches} 1544b34c648bSJoe Perches 1545b34c648bSJoe Perchessub rtrim { 1546b34c648bSJoe Perches my ($string) = @_; 1547b34c648bSJoe Perches 1548b34c648bSJoe Perches $string =~ s/\s+$//; 15493705ce5bSJoe Perches 15503705ce5bSJoe Perches return $string; 15513705ce5bSJoe Perches} 15523705ce5bSJoe Perches 155352ea8506SJoe Perchessub string_find_replace { 155452ea8506SJoe Perches my ($string, $find, $replace) = @_; 155552ea8506SJoe Perches 155652ea8506SJoe Perches $string =~ s/$find/$replace/g; 155752ea8506SJoe Perches 155852ea8506SJoe Perches return $string; 155952ea8506SJoe Perches} 156052ea8506SJoe Perches 15613705ce5bSJoe Perchessub tabify { 15623705ce5bSJoe Perches my ($leading) = @_; 15633705ce5bSJoe Perches 15643705ce5bSJoe Perches my $source_indent = 8; 15653705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 15663705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 15673705ce5bSJoe Perches 15683705ce5bSJoe Perches #convert leading spaces to tabs 15693705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 15703705ce5bSJoe Perches #Remove spaces before a tab 15713705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 15723705ce5bSJoe Perches 15733705ce5bSJoe Perches return "$leading"; 15743705ce5bSJoe Perches} 15753705ce5bSJoe Perches 1576d1fe9c09SJoe Perchessub pos_last_openparen { 1577d1fe9c09SJoe Perches my ($line) = @_; 1578d1fe9c09SJoe Perches 1579d1fe9c09SJoe Perches my $pos = 0; 1580d1fe9c09SJoe Perches 1581d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1582d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1583d1fe9c09SJoe Perches 1584d1fe9c09SJoe Perches my $last_openparen = 0; 1585d1fe9c09SJoe Perches 1586d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1587d1fe9c09SJoe Perches return -1; 1588d1fe9c09SJoe Perches } 1589d1fe9c09SJoe Perches 1590d1fe9c09SJoe Perches my $len = length($line); 1591d1fe9c09SJoe Perches 1592d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1593d1fe9c09SJoe Perches my $string = substr($line, $pos); 1594d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1595d1fe9c09SJoe Perches $pos += length($1) - 1; 1596d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1597d1fe9c09SJoe Perches $last_openparen = $pos; 1598d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1599d1fe9c09SJoe Perches last; 1600d1fe9c09SJoe Perches } 1601d1fe9c09SJoe Perches } 1602d1fe9c09SJoe Perches 1603d1fe9c09SJoe Perches return $last_openparen + 1; 1604d1fe9c09SJoe Perches} 1605d1fe9c09SJoe Perches 16060a920b5bSAndy Whitcroftsub process { 16070a920b5bSAndy Whitcroft my $filename = shift; 16080a920b5bSAndy Whitcroft 16090a920b5bSAndy Whitcroft my $linenr=0; 16100a920b5bSAndy Whitcroft my $prevline=""; 1611c2fdda0dSAndy Whitcroft my $prevrawline=""; 16120a920b5bSAndy Whitcroft my $stashline=""; 1613c2fdda0dSAndy Whitcroft my $stashrawline=""; 16140a920b5bSAndy Whitcroft 16154a0df2efSAndy Whitcroft my $length; 16160a920b5bSAndy Whitcroft my $indent; 16170a920b5bSAndy Whitcroft my $previndent=0; 16180a920b5bSAndy Whitcroft my $stashindent=0; 16190a920b5bSAndy Whitcroft 1620de7d4f0eSAndy Whitcroft our $clean = 1; 16210a920b5bSAndy Whitcroft my $signoff = 0; 16220a920b5bSAndy Whitcroft my $is_patch = 0; 16230a920b5bSAndy Whitcroft 162415662b3eSJoe Perches my $in_header_lines = 1; 162515662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 162615662b3eSJoe Perches 1627fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1628fa64205dSPasi Savanainen 162913214adfSAndy Whitcroft our @report = (); 16306c72ffaaSAndy Whitcroft our $cnt_lines = 0; 16316c72ffaaSAndy Whitcroft our $cnt_error = 0; 16326c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16336c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16346c72ffaaSAndy Whitcroft 16350a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16360a920b5bSAndy Whitcroft my $realfile = ''; 16370a920b5bSAndy Whitcroft my $realline = 0; 16380a920b5bSAndy Whitcroft my $realcnt = 0; 16390a920b5bSAndy Whitcroft my $here = ''; 16400a920b5bSAndy Whitcroft my $in_comment = 0; 1641c2fdda0dSAndy Whitcroft my $comment_edge = 0; 16420a920b5bSAndy Whitcroft my $first_line = 0; 16431e855726SWolfram Sang my $p1_prefix = ''; 16440a920b5bSAndy Whitcroft 164513214adfSAndy Whitcroft my $prev_values = 'E'; 164613214adfSAndy Whitcroft 164713214adfSAndy Whitcroft # suppression flags 1648773647a0SAndy Whitcroft my %suppress_ifbraces; 1649170d3a22SAndy Whitcroft my %suppress_whiletrailers; 16502b474a1aSAndy Whitcroft my %suppress_export; 16513e469cdcSAndy Whitcroft my $suppress_statement = 0; 1652653d4876SAndy Whitcroft 16537e51f197SJoe Perches my %signatures = (); 1654323c1260SJoe Perches 1655c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1656de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1657c2fdda0dSAndy Whitcroft # 1658de7d4f0eSAndy Whitcroft my @setup_docs = (); 1659de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1660773647a0SAndy Whitcroft 1661d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1662d8b07710SJoe Perches 1663773647a0SAndy Whitcroft sanitise_line_reset(); 1664c2fdda0dSAndy Whitcroft my $line; 1665c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1666773647a0SAndy Whitcroft $linenr++; 1667773647a0SAndy Whitcroft $line = $rawline; 1668c2fdda0dSAndy Whitcroft 16693705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 16703705ce5bSJoe Perches 1671773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1672de7d4f0eSAndy Whitcroft $setup_docs = 0; 1673de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1674de7d4f0eSAndy Whitcroft $setup_docs = 1; 1675de7d4f0eSAndy Whitcroft } 1676773647a0SAndy Whitcroft #next; 1677de7d4f0eSAndy Whitcroft } 1678773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1679773647a0SAndy Whitcroft $realline=$1-1; 1680773647a0SAndy Whitcroft if (defined $2) { 1681773647a0SAndy Whitcroft $realcnt=$3+1; 1682773647a0SAndy Whitcroft } else { 1683773647a0SAndy Whitcroft $realcnt=1+1; 1684773647a0SAndy Whitcroft } 1685c45dcabdSAndy Whitcroft $in_comment = 0; 1686773647a0SAndy Whitcroft 1687773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1688773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1689773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1690773647a0SAndy Whitcroft # at context start. 1691773647a0SAndy Whitcroft my $edge; 169201fa9147SAndy Whitcroft my $cnt = $realcnt; 169301fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 169401fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 169501fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 169601fa9147SAndy Whitcroft $cnt--; 169701fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1698721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1699fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1700fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1701fae17daeSAndy Whitcroft ($edge) = $1; 1702fae17daeSAndy Whitcroft last; 1703fae17daeSAndy Whitcroft } 1704773647a0SAndy Whitcroft } 1705773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1706773647a0SAndy Whitcroft $in_comment = 1; 1707773647a0SAndy Whitcroft } 1708773647a0SAndy Whitcroft 1709773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1710773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1711773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1712773647a0SAndy Whitcroft if (!defined $edge && 171383242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1714773647a0SAndy Whitcroft { 1715773647a0SAndy Whitcroft $in_comment = 1; 1716773647a0SAndy Whitcroft } 1717773647a0SAndy Whitcroft 1718773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1719773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1720773647a0SAndy Whitcroft 1721171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1722773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1723171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1724773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1725773647a0SAndy Whitcroft } 1726773647a0SAndy Whitcroft push(@lines, $line); 1727773647a0SAndy Whitcroft 1728773647a0SAndy Whitcroft if ($realcnt > 1) { 1729773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1730773647a0SAndy Whitcroft } else { 1731773647a0SAndy Whitcroft $realcnt = 0; 1732773647a0SAndy Whitcroft } 1733773647a0SAndy Whitcroft 1734773647a0SAndy Whitcroft #print "==>$rawline\n"; 1735773647a0SAndy Whitcroft #print "-->$line\n"; 1736de7d4f0eSAndy Whitcroft 1737de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1738de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1739de7d4f0eSAndy Whitcroft } 1740de7d4f0eSAndy Whitcroft } 1741de7d4f0eSAndy Whitcroft 17426c72ffaaSAndy Whitcroft $prefix = ''; 17436c72ffaaSAndy Whitcroft 1744773647a0SAndy Whitcroft $realcnt = 0; 1745773647a0SAndy Whitcroft $linenr = 0; 17460a920b5bSAndy Whitcroft foreach my $line (@lines) { 17470a920b5bSAndy Whitcroft $linenr++; 17481b5539b1SJoe Perches my $sline = $line; #copy of $line 17491b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 17500a920b5bSAndy Whitcroft 1751c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 17526c72ffaaSAndy Whitcroft 17530a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 17546c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 17550a920b5bSAndy Whitcroft $is_patch = 1; 17564a0df2efSAndy Whitcroft $first_line = $linenr + 1; 17570a920b5bSAndy Whitcroft $realline=$1-1; 17580a920b5bSAndy Whitcroft if (defined $2) { 17590a920b5bSAndy Whitcroft $realcnt=$3+1; 17600a920b5bSAndy Whitcroft } else { 17610a920b5bSAndy Whitcroft $realcnt=1+1; 17620a920b5bSAndy Whitcroft } 1763c2fdda0dSAndy Whitcroft annotate_reset(); 176413214adfSAndy Whitcroft $prev_values = 'E'; 176513214adfSAndy Whitcroft 1766773647a0SAndy Whitcroft %suppress_ifbraces = (); 1767170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 17682b474a1aSAndy Whitcroft %suppress_export = (); 17693e469cdcSAndy Whitcroft $suppress_statement = 0; 17700a920b5bSAndy Whitcroft next; 17710a920b5bSAndy Whitcroft 17724a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 17734a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 17744a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1775773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 17760a920b5bSAndy Whitcroft $realline++; 1777d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 17780a920b5bSAndy Whitcroft 17794a0df2efSAndy Whitcroft # Measure the line length and indent. 1780c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 17810a920b5bSAndy Whitcroft 17820a920b5bSAndy Whitcroft # Track the previous line. 17830a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 17840a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1785c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1786c2fdda0dSAndy Whitcroft 1787773647a0SAndy Whitcroft #warn "line<$line>\n"; 17886c72ffaaSAndy Whitcroft 1789d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1790d8aaf121SAndy Whitcroft $realcnt--; 17910a920b5bSAndy Whitcroft } 17920a920b5bSAndy Whitcroft 1793cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1794cc77cdcaSAndy Whitcroft 17950a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1796773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1797773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1798773647a0SAndy Whitcroft 17996c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 18006c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1801773647a0SAndy Whitcroft 1802773647a0SAndy Whitcroft # extract the filename as it passes 18033bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 18043bf9a009SRabin Vincent $realfile = $1; 18052b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1806270c49a0SJoe Perches $in_commit_log = 0; 18073bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1808773647a0SAndy Whitcroft $realfile = $1; 18092b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1810270c49a0SJoe Perches $in_commit_log = 0; 18111e855726SWolfram Sang 18121e855726SWolfram Sang $p1_prefix = $1; 1813e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1814e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1815000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1816000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 18171e855726SWolfram Sang } 1818773647a0SAndy Whitcroft 1819c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1820000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1821000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1822773647a0SAndy Whitcroft } 1823773647a0SAndy Whitcroft next; 1824773647a0SAndy Whitcroft } 1825773647a0SAndy Whitcroft 1826389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 18270a920b5bSAndy Whitcroft 1828c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1829c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1830c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 18310a920b5bSAndy Whitcroft 18326c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 18336c72ffaaSAndy Whitcroft 18343bf9a009SRabin Vincent# Check for incorrect file permissions 18353bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 18363bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 183704db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 183804db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1839000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1840000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 18413bf9a009SRabin Vincent } 18423bf9a009SRabin Vincent } 18433bf9a009SRabin Vincent 184420112475SJoe Perches# Check the patch for a signoff: 1845d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 18464a0df2efSAndy Whitcroft $signoff++; 184715662b3eSJoe Perches $in_commit_log = 0; 18480a920b5bSAndy Whitcroft } 184920112475SJoe Perches 185020112475SJoe Perches# Check signature styles 1851270c49a0SJoe Perches if (!$in_header_lines && 1852ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 185320112475SJoe Perches my $space_before = $1; 185420112475SJoe Perches my $sign_off = $2; 185520112475SJoe Perches my $space_after = $3; 185620112475SJoe Perches my $email = $4; 185720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 185820112475SJoe Perches 1859ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1860ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1861ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1862ce0338dfSJoe Perches } 186320112475SJoe Perches if (defined $space_before && $space_before ne "") { 18643705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18653705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 18663705ce5bSJoe Perches $fix) { 18673705ce5bSJoe Perches $fixed[$linenr - 1] = 18683705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18693705ce5bSJoe Perches } 187020112475SJoe Perches } 187120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 18723705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18733705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 18743705ce5bSJoe Perches $fix) { 18753705ce5bSJoe Perches $fixed[$linenr - 1] = 18763705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18773705ce5bSJoe Perches } 18783705ce5bSJoe Perches 187920112475SJoe Perches } 188020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 18813705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18823705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 18833705ce5bSJoe Perches $fix) { 18843705ce5bSJoe Perches $fixed[$linenr - 1] = 18853705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18863705ce5bSJoe Perches } 188720112475SJoe Perches } 188820112475SJoe Perches 188920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 189020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 189120112475SJoe Perches if ($suggested_email eq "") { 1892000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1893000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 189420112475SJoe Perches } else { 189520112475SJoe Perches my $dequoted = $suggested_email; 189620112475SJoe Perches $dequoted =~ s/^"//; 189720112475SJoe Perches $dequoted =~ s/" </ </; 189820112475SJoe Perches # Don't force email to have quotes 189920112475SJoe Perches # Allow just an angle bracketed address 190020112475SJoe Perches if ("$dequoted$comment" ne $email && 190120112475SJoe Perches "<$email_address>$comment" ne $email && 190220112475SJoe Perches "$suggested_email$comment" ne $email) { 1903000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1904000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 190520112475SJoe Perches } 19060a920b5bSAndy Whitcroft } 19077e51f197SJoe Perches 19087e51f197SJoe Perches# Check for duplicate signatures 19097e51f197SJoe Perches my $sig_nospace = $line; 19107e51f197SJoe Perches $sig_nospace =~ s/\s//g; 19117e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 19127e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 19137e51f197SJoe Perches WARN("BAD_SIGN_OFF", 19147e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 19157e51f197SJoe Perches } else { 19167e51f197SJoe Perches $signatures{$sig_nospace} = 1; 19177e51f197SJoe Perches } 19180a920b5bSAndy Whitcroft } 19190a920b5bSAndy Whitcroft 192000df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 19218905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1922000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1923000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 19246c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1925de7d4f0eSAndy Whitcroft } 1926de7d4f0eSAndy Whitcroft 19276ecd9674SAndy Whitcroft# Check for absolute kernel paths. 19286ecd9674SAndy Whitcroft if ($tree) { 19296ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 19306ecd9674SAndy Whitcroft my $file = $1; 19316ecd9674SAndy Whitcroft 19326ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19336ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19346ecd9674SAndy Whitcroft # 19356ecd9674SAndy Whitcroft } else { 19366ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19376ecd9674SAndy Whitcroft } 19386ecd9674SAndy Whitcroft } 19396ecd9674SAndy Whitcroft } 19406ecd9674SAndy Whitcroft 1941de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1942de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1943171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1944171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1945171ae1a4SAndy Whitcroft 1946171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1947171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1948171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1949171ae1a4SAndy Whitcroft 195034d99219SJoe Perches CHK("INVALID_UTF8", 1951000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 195200df344fSAndy Whitcroft } 19530a920b5bSAndy Whitcroft 195415662b3eSJoe Perches# Check if it's the start of a commit log 195515662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 195615662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1957270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 195815662b3eSJoe Perches $in_header_lines = 0; 195915662b3eSJoe Perches $in_commit_log = 1; 196015662b3eSJoe Perches } 196115662b3eSJoe Perches 1962fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1963fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1964fa64205dSPasi Savanainen if ($in_header_lines && 1965fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1966fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1967fa64205dSPasi Savanainen $non_utf8_charset = 1; 1968fa64205dSPasi Savanainen } 1969fa64205dSPasi Savanainen 1970fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 197115662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1972fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 197315662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 197415662b3eSJoe Perches } 197515662b3eSJoe Perches 197630670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 197730670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 197800df344fSAndy Whitcroft 19790a920b5bSAndy Whitcroft#trailing whitespace 19809c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1981c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1982d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 1983d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 1984d5e616fcSJoe Perches $fix) { 1985d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 1986d5e616fcSJoe Perches } 1987c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1988c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19893705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 19903705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 19913705ce5bSJoe Perches $fix) { 1992d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 19933705ce5bSJoe Perches } 19943705ce5bSJoe Perches 1995d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 19960a920b5bSAndy Whitcroft } 19975368df20SAndy Whitcroft 19984783f894SJosh Triplett# Check for FSF mailing addresses. 1999109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 20003e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 20013e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 20024783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20034783f894SJosh Triplett my $msg_type = \&ERROR; 20044783f894SJosh Triplett $msg_type = \&CHK if ($file); 20054783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 20064783f894SJosh 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) 20074783f894SJosh Triplett } 20084783f894SJosh Triplett 20093354957aSAndi Kleen# check for Kconfig help text having a real description 20109fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 20119fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 20123354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 2013a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 20143354957aSAndi Kleen my $length = 0; 20159fe287d7SAndy Whitcroft my $cnt = $realcnt; 20169fe287d7SAndy Whitcroft my $ln = $linenr + 1; 20179fe287d7SAndy Whitcroft my $f; 2018a1385803SAndy Whitcroft my $is_start = 0; 20199fe287d7SAndy Whitcroft my $is_end = 0; 2020a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 20219fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 20229fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 20239fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 20249fe287d7SAndy Whitcroft 20259fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2026a1385803SAndy Whitcroft 2027a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2028a1385803SAndy Whitcroft $is_start = 1; 2029a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2030a1385803SAndy Whitcroft $length = -1; 2031a1385803SAndy Whitcroft } 2032a1385803SAndy Whitcroft 20339fe287d7SAndy Whitcroft $f =~ s/^.//; 20343354957aSAndi Kleen $f =~ s/#.*//; 20353354957aSAndi Kleen $f =~ s/^\s+//; 20363354957aSAndi Kleen next if ($f =~ /^$/); 20379fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20389fe287d7SAndy Whitcroft $is_end = 1; 20399fe287d7SAndy Whitcroft last; 20409fe287d7SAndy Whitcroft } 20413354957aSAndi Kleen $length++; 20423354957aSAndi Kleen } 2043000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2044a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2045a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20463354957aSAndi Kleen } 20473354957aSAndi Kleen 20481ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20491ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20501ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20511ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20521ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20531ba8dfd1SKees Cook } 20541ba8dfd1SKees Cook 2055c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2056c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2057c68e5878SArnaud Lacombe my $flag = $1; 2058c68e5878SArnaud Lacombe my $replacement = { 2059c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2060c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2061c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2062c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2063c68e5878SArnaud Lacombe }; 2064c68e5878SArnaud Lacombe 2065c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2066c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2067c68e5878SArnaud Lacombe } 2068c68e5878SArnaud Lacombe 2069bff5da43SRob Herring# check for DT compatible documentation 2070bff5da43SRob Herring if (defined $root && $realfile =~ /\.dts/ && 2071bff5da43SRob Herring $rawline =~ /^\+\s*compatible\s*=/) { 2072bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2073bff5da43SRob Herring 2074bff5da43SRob Herring foreach my $compat (@compats) { 2075bff5da43SRob Herring my $compat2 = $compat; 2076bff5da43SRob Herring my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2077bff5da43SRob Herring $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/; 2078bff5da43SRob Herring `grep -Erq "$compat|$compat2" $dt_path`; 2079bff5da43SRob Herring if ( $? >> 8 ) { 2080bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2081bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2082bff5da43SRob Herring } 2083bff5da43SRob Herring 2084bff5da43SRob Herring my $vendor = $compat; 2085bff5da43SRob Herring my $vendor_path = $dt_path . "vendor-prefixes.txt"; 2086bff5da43SRob Herring next if (! -f $vendor_path); 2087bff5da43SRob Herring $vendor =~ s/^([a-zA-Z0-9]+)\,.*/$1/; 2088bff5da43SRob Herring `grep -Eq "$vendor" $vendor_path`; 2089bff5da43SRob Herring if ( $? >> 8 ) { 2090bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2091bff5da43SRob Herring "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr); 2092bff5da43SRob Herring } 2093bff5da43SRob Herring } 2094bff5da43SRob Herring } 2095bff5da43SRob Herring 20965368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 20975368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 20985368df20SAndy Whitcroft 20996cd7f386SJoe Perches#line length limit 2100c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2101f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 21020fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 21038bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 21046cd7f386SJoe Perches $length > $max_line_length) 2105c45dcabdSAndy Whitcroft { 2106000d1cc1SJoe Perches WARN("LONG_LINE", 21076cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 21080a920b5bSAndy Whitcroft } 21090a920b5bSAndy Whitcroft 2110ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 21118c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 21128c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 21138c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2114ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2115ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 21168c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2117ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2118ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2119ca56dc09SJosh Triplett } 2120ca56dc09SJosh Triplett 21215e79d96eSJoe Perches# check for spaces before a quoted newline 21225e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 21233705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 21243705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 21253705ce5bSJoe Perches $fix) { 21263705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 21273705ce5bSJoe Perches } 21283705ce5bSJoe Perches 21295e79d96eSJoe Perches } 21305e79d96eSJoe Perches 21318905a67cSAndy Whitcroft# check for adding lines without a newline. 21328905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2133000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2134000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 21358905a67cSAndy Whitcroft } 21368905a67cSAndy Whitcroft 213742e41c54SMike Frysinger# Blackfin: use hi/lo macros 213842e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 213942e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 214042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2141000d1cc1SJoe Perches ERROR("LO_MACRO", 2142000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 214342e41c54SMike Frysinger } 214442e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 214542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2146000d1cc1SJoe Perches ERROR("HI_MACRO", 2147000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 214842e41c54SMike Frysinger } 214942e41c54SMike Frysinger } 215042e41c54SMike Frysinger 2151b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2152b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21530a920b5bSAndy Whitcroft 21540a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21550a920b5bSAndy Whitcroft# more than 8 must use tabs. 2156c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2157c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2158c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2159d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21603705ce5bSJoe Perches if (ERROR("CODE_INDENT", 21613705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 21623705ce5bSJoe Perches $fix) { 21633705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 21643705ce5bSJoe Perches } 21650a920b5bSAndy Whitcroft } 21660a920b5bSAndy Whitcroft 216708e44365SAlberto Panizzo# check for space before tabs. 216808e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 216908e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21703705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 21713705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 21723705ce5bSJoe Perches $fix) { 2173c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2174c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2175c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2176c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 21773705ce5bSJoe Perches } 217808e44365SAlberto Panizzo } 217908e44365SAlberto Panizzo 2180d1fe9c09SJoe Perches# check for && or || at the start of a line 2181d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2182d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2183d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2184d1fe9c09SJoe Perches } 2185d1fe9c09SJoe Perches 2186d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2187d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2188d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 2189d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2190d1fe9c09SJoe Perches my $oldindent = $1; 2191d1fe9c09SJoe Perches my $rest = $2; 2192d1fe9c09SJoe Perches 2193d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2194d1fe9c09SJoe Perches if ($pos >= 0) { 2195b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2196b34a26f3SJoe Perches my $newindent = $2; 2197d1fe9c09SJoe Perches 2198d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2199d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2200d1fe9c09SJoe Perches " " x ($pos % 8); 2201d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2202d1fe9c09SJoe Perches 2203d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2204d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 22053705ce5bSJoe Perches 22063705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 22073705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 22083705ce5bSJoe Perches $fix && $line =~ /^\+/) { 22093705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22103705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 22113705ce5bSJoe Perches } 2212d1fe9c09SJoe Perches } 2213d1fe9c09SJoe Perches } 2214d1fe9c09SJoe Perches } 2215d1fe9c09SJoe Perches 221623f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 22173705ce5bSJoe Perches if (CHK("SPACING", 22183705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 22193705ce5bSJoe Perches $fix) { 22203705ce5bSJoe Perches $fixed[$linenr - 1] =~ 22213705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 22223705ce5bSJoe Perches } 2223aad4f614SJoe Perches } 2224aad4f614SJoe Perches 222505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2226fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 222785ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 222885ad978cSJoe Perches $realline > 2) { 222905880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 223005880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 223105880600SJoe Perches } 223205880600SJoe Perches 223305880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2234a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2235a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 223661135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2237a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2238a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2239a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2240a605e32eSJoe Perches } 2241a605e32eSJoe Perches 2242a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2243c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2244c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2245c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2246c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 224705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 224805880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 224905880600SJoe Perches } 225005880600SJoe Perches 22515f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 22526b4c5bebSAndy Whitcroft# Exceptions: 22536b4c5bebSAndy Whitcroft# 1) within comments 22546b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 22556b4c5bebSAndy Whitcroft# 3) hanging labels 22563705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 22575f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22583705ce5bSJoe Perches if (WARN("LEADING_SPACE", 22593705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 22603705ce5bSJoe Perches $fix) { 22613705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22623705ce5bSJoe Perches } 22635f7ddae6SRaffaele Recalcati } 22645f7ddae6SRaffaele Recalcati 2265b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2266b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2267b9ea10d6SAndy Whitcroft 22681ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 22691ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 22701ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 22711ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 22721ba8dfd1SKees Cook } 22731ba8dfd1SKees Cook 2274c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2275cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2276000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2277000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2278c2fdda0dSAndy Whitcroft } 227922f2a2efSAndy Whitcroft 228042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 228142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 228242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2283000d1cc1SJoe Perches ERROR("CSYNC", 2284000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 228542e41c54SMike Frysinger } 228642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 228742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2288000d1cc1SJoe Perches ERROR("SSYNC", 2289000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 229042e41c54SMike Frysinger } 229142e41c54SMike Frysinger 229256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 229356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 229456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 229556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 229656e77d70SJoe Perches } 229756e77d70SJoe Perches 22989c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 22992b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 23002b474a1aSAndy Whitcroft $realline_next); 23013e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 23023e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 23031b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2304170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2305f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2306171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2307171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2308171ae1a4SAndy Whitcroft 23093e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 23103e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 23113e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 23123e469cdcSAndy Whitcroft # until we hit end of it. 23133e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 23143e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 23153e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 23163e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 23173e469cdcSAndy Whitcroft } 2318f74bd194SAndy Whitcroft 23192b474a1aSAndy Whitcroft # Find the real next line. 23202b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 23212b474a1aSAndy Whitcroft if (defined $realline_next && 23222b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 23232b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 23242b474a1aSAndy Whitcroft $realline_next++; 23252b474a1aSAndy Whitcroft } 23262b474a1aSAndy Whitcroft 2327171ae1a4SAndy Whitcroft my $s = $stat; 2328171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2329cf655043SAndy Whitcroft 2330c2fdda0dSAndy Whitcroft # Ignore goto labels. 2331171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2332c2fdda0dSAndy Whitcroft 2333c2fdda0dSAndy Whitcroft # Ignore functions being called 2334171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2335c2fdda0dSAndy Whitcroft 2336463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2337463f2864SAndy Whitcroft 2338c45dcabdSAndy Whitcroft # declarations always start with types 2339d2506586SAndy 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) { 2340c45dcabdSAndy Whitcroft my $type = $1; 2341c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2342c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2343c45dcabdSAndy Whitcroft 23446c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2345a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2346c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2347c2fdda0dSAndy Whitcroft } 23488905a67cSAndy Whitcroft 23496c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 235065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2351c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 23529c0ca6f9SAndy Whitcroft } 23538905a67cSAndy Whitcroft 23548905a67cSAndy Whitcroft # Check for any sort of function declaration. 23558905a67cSAndy Whitcroft # int foo(something bar, other baz); 23568905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2357171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 23588905a67cSAndy Whitcroft my ($name_len) = length($1); 23598905a67cSAndy Whitcroft 2360cf655043SAndy Whitcroft my $ctx = $s; 2361773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 23628905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2363cf655043SAndy Whitcroft 23648905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2365c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 23668905a67cSAndy Whitcroft 2367c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 23688905a67cSAndy Whitcroft } 23698905a67cSAndy Whitcroft } 23708905a67cSAndy Whitcroft } 23718905a67cSAndy Whitcroft 23729c0ca6f9SAndy Whitcroft } 23739c0ca6f9SAndy Whitcroft 237400df344fSAndy Whitcroft# 237500df344fSAndy Whitcroft# Checks which may be anchored in the context. 237600df344fSAndy Whitcroft# 237700df344fSAndy Whitcroft 237800df344fSAndy Whitcroft# Check for switch () and associated case and default 237900df344fSAndy Whitcroft# statements should be at the same indent. 238000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 238100df344fSAndy Whitcroft my $err = ''; 238200df344fSAndy Whitcroft my $sep = ''; 238300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 238400df344fSAndy Whitcroft shift(@ctx); 238500df344fSAndy Whitcroft for my $ctx (@ctx) { 238600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 238700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 238800df344fSAndy Whitcroft $indent != $cindent) { 238900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 239000df344fSAndy Whitcroft $sep = ''; 239100df344fSAndy Whitcroft } else { 239200df344fSAndy Whitcroft $sep = "[...]\n"; 239300df344fSAndy Whitcroft } 239400df344fSAndy Whitcroft } 239500df344fSAndy Whitcroft if ($err ne '') { 2396000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2397000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2398de7d4f0eSAndy Whitcroft } 2399de7d4f0eSAndy Whitcroft } 2400de7d4f0eSAndy Whitcroft 2401de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2402de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2403c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2404773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2405773647a0SAndy Whitcroft 24069c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 24078eef05ddSJoe Perches 24088eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 24098eef05ddSJoe Perches WARN("DEEP_INDENTATION", 24108eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 24118eef05ddSJoe Perches } 24128eef05ddSJoe Perches 2413de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2414de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2415de7d4f0eSAndy Whitcroft 2416548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2417548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2418de7d4f0eSAndy Whitcroft 2419548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2420548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2421548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2422548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2423548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2424773647a0SAndy Whitcroft $ctx_ln++; 2425773647a0SAndy Whitcroft } 2426548596d5SAndy Whitcroft 242753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 242853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2429773647a0SAndy Whitcroft 2430773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2431000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2432000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 243301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 243400df344fSAndy Whitcroft } 2435773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2436773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2437773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2438773647a0SAndy Whitcroft { 24399c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 24409c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2441000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2442000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 244301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 24449c0ca6f9SAndy Whitcroft } 24459c0ca6f9SAndy Whitcroft } 244600df344fSAndy Whitcroft } 244700df344fSAndy Whitcroft 24484d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 24494d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 24503e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 24513e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 24523e469cdcSAndy Whitcroft if (!defined $stat); 24534d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 24544d001e4dSAndy Whitcroft 24554d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 24564d001e4dSAndy Whitcroft 24574d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 24584d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 24594d001e4dSAndy Whitcroft # where necessary. 24604d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 24614d001e4dSAndy Whitcroft 24624d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 24636f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 24646f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 24654d001e4dSAndy Whitcroft 24664d001e4dSAndy Whitcroft # We want to check the first line inside the block 24674d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 24684d001e4dSAndy Whitcroft # 1) any blank line termination 24694d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 24704d001e4dSAndy Whitcroft # 3) any do (...) { 24714d001e4dSAndy Whitcroft my $continuation = 0; 24724d001e4dSAndy Whitcroft my $check = 0; 24734d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 24744d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 24754d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 24764d001e4dSAndy Whitcroft $continuation = 1; 24774d001e4dSAndy Whitcroft } 24789bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 24794d001e4dSAndy Whitcroft $check = 1; 24804d001e4dSAndy Whitcroft $cond_lines++; 24814d001e4dSAndy Whitcroft } 24824d001e4dSAndy Whitcroft 24834d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 24844d001e4dSAndy Whitcroft # preprocessor statement. 24854d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 24864d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 24874d001e4dSAndy Whitcroft $check = 0; 24884d001e4dSAndy Whitcroft } 24894d001e4dSAndy Whitcroft 24909bd49efeSAndy Whitcroft my $cond_ptr = -1; 2491740504c6SAndy Whitcroft $continuation = 0; 24929bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 24939bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 24944d001e4dSAndy Whitcroft 2495f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2496f16fa28fSAndy Whitcroft # is not linear. 2497f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2498f16fa28fSAndy Whitcroft $check = 0; 2499f16fa28fSAndy Whitcroft } 2500f16fa28fSAndy Whitcroft 25019bd49efeSAndy Whitcroft # Ignore: 25029bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 25039bd49efeSAndy Whitcroft # 2) preprocessor lines, and 25049bd49efeSAndy Whitcroft # 3) labels. 2505740504c6SAndy Whitcroft if ($continuation || 2506740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 25079bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 25089bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2509740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 251030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 25119bd49efeSAndy Whitcroft $cond_lines++; 25129bd49efeSAndy Whitcroft } 25134d001e4dSAndy Whitcroft } 251430dad6ebSAndy Whitcroft } 25154d001e4dSAndy Whitcroft 25164d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 25174d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 25184d001e4dSAndy Whitcroft 25194d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 25204d001e4dSAndy Whitcroft # this is not this patch's fault. 25214d001e4dSAndy Whitcroft if (!defined($stat_real) || 25224d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 25234d001e4dSAndy Whitcroft $check = 0; 25244d001e4dSAndy Whitcroft } 25254d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 25264d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 25274d001e4dSAndy Whitcroft } 25284d001e4dSAndy Whitcroft 25299bd49efeSAndy 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"; 25304d001e4dSAndy Whitcroft 25314d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 25324d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2533000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2534000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 25354d001e4dSAndy Whitcroft } 25364d001e4dSAndy Whitcroft } 25374d001e4dSAndy Whitcroft 25386c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 25396c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 25401f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 25411f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 25426c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2543c2fdda0dSAndy Whitcroft if ($dbg_values) { 2544c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2545cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2546cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 25471f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2548c2fdda0dSAndy Whitcroft } 25496c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 25506c72ffaaSAndy Whitcroft 255100df344fSAndy Whitcroft#ignore lines not being added 25523705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 255300df344fSAndy Whitcroft 2554653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 25557429c690SAndy Whitcroft if ($dbg_type) { 25567429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2557000d1cc1SJoe Perches ERROR("TEST_TYPE", 2558000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 25597429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2560000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2561000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 25627429c690SAndy Whitcroft } 2563653d4876SAndy Whitcroft next; 2564653d4876SAndy Whitcroft } 2565a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2566a1ef277eSAndy Whitcroft if ($dbg_attr) { 25679360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2568000d1cc1SJoe Perches ERROR("TEST_ATTR", 2569000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 25709360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2571000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2572000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2573a1ef277eSAndy Whitcroft } 2574a1ef277eSAndy Whitcroft next; 2575a1ef277eSAndy Whitcroft } 2576653d4876SAndy Whitcroft 2577f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 257899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 257999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2580000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2581000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2582f0a594c1SAndy Whitcroft } 2583f0a594c1SAndy Whitcroft 258400df344fSAndy Whitcroft# 258500df344fSAndy Whitcroft# Checks which are anchored on the added line. 258600df344fSAndy Whitcroft# 258700df344fSAndy Whitcroft 2588653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2589c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2590653d4876SAndy Whitcroft my $path = $1; 2591653d4876SAndy Whitcroft if ($path =~ m{//}) { 2592000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2593495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2594495e9d84SJoe Perches } 2595495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2596495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2597495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2598653d4876SAndy Whitcroft } 2599653d4876SAndy Whitcroft } 2600653d4876SAndy Whitcroft 260100df344fSAndy Whitcroft# no C99 // comments 260200df344fSAndy Whitcroft if ($line =~ m{//}) { 26033705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 26043705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 26053705ce5bSJoe Perches $fix) { 26063705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 26073705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 26083705ce5bSJoe Perches my $comment = trim($1); 26093705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 26103705ce5bSJoe Perches } 26113705ce5bSJoe Perches } 261200df344fSAndy Whitcroft } 261300df344fSAndy Whitcroft # Remove C99 comments. 26140a920b5bSAndy Whitcroft $line =~ s@//.*@@; 26156c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 26160a920b5bSAndy Whitcroft 26172b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 26182b474a1aSAndy Whitcroft# the whole statement. 26192b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 26202b474a1aSAndy Whitcroft if (defined $realline_next && 26212b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 26222b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 26232b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 26242b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 26253cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 26263cbf62dfSAndy Whitcroft # a prefix: 26273cbf62dfSAndy Whitcroft # XXX(foo); 26283cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2629653d4876SAndy Whitcroft my $name = $1; 263087a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 26313cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 26323cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 26333cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 26343cbf62dfSAndy Whitcroft 26353cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 26362b474a1aSAndy Whitcroft \n.}\s*$| 263748012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 263848012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 263948012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 26402b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 26412b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 264248012058SAndy Whitcroft )/x) { 26432b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 26442b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 26452b474a1aSAndy Whitcroft } else { 26462b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 26470a920b5bSAndy Whitcroft } 26480a920b5bSAndy Whitcroft } 26492b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 26502b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 26512b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 26522b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 26532b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 26542b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 26552b474a1aSAndy Whitcroft } 26562b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 26572b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2658000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2659000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 26602b474a1aSAndy Whitcroft } 26610a920b5bSAndy Whitcroft 26625150bda4SJoe Eloff# check for global initialisers. 2663d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2664d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2665000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2666d5e616fcSJoe Perches $herecurr) && 2667d5e616fcSJoe Perches $fix) { 2668d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2669d5e616fcSJoe Perches } 2670f0a594c1SAndy Whitcroft } 26710a920b5bSAndy Whitcroft# check for static initialisers. 2672d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2673d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2674000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2675d5e616fcSJoe Perches $herecurr) && 2676d5e616fcSJoe Perches $fix) { 2677d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2678d5e616fcSJoe Perches } 26790a920b5bSAndy Whitcroft } 26800a920b5bSAndy Whitcroft 2681cb710ecaSJoe Perches# check for static const char * arrays. 2682cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2683000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2684000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2685cb710ecaSJoe Perches $herecurr); 2686cb710ecaSJoe Perches } 2687cb710ecaSJoe Perches 2688cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2689cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2690000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2691000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2692cb710ecaSJoe Perches $herecurr); 2693cb710ecaSJoe Perches } 2694cb710ecaSJoe Perches 26959b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 26969b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 26979b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 26989b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 26999b0fa60dSJoe Perches $herecurr); 27009b0fa60dSJoe Perches } 27019b0fa60dSJoe Perches 2702b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 2703b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 2704b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 2705b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 2706b36190c5SJoe Perches $fix) { 2707b36190c5SJoe Perches $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 2708b36190c5SJoe Perches } 2709b36190c5SJoe Perches } 2710b36190c5SJoe Perches 271192e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 271292e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 271392e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 271492e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 271592e112fdSJoe Perches $fix) { 271692e112fdSJoe Perches $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 271792e112fdSJoe Perches } 271893ed0e2dSJoe Perches } 271993ed0e2dSJoe Perches 2720653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2721653d4876SAndy Whitcroft# make sense. 2722653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 27238054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2724c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 27258ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2726653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2727000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2728000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 27290a920b5bSAndy Whitcroft } 27300a920b5bSAndy Whitcroft 27310a920b5bSAndy Whitcroft# * goes on variable not on type 273265863862SAndy Whitcroft # (char*[ const]) 2733bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2734bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 27353705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2736d8aaf121SAndy Whitcroft 273765863862SAndy Whitcroft # Should start with a space. 273865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 273965863862SAndy Whitcroft # Should not end with a space. 274065863862SAndy Whitcroft $to =~ s/\s+$//; 274165863862SAndy Whitcroft # '*'s should not have spaces between. 2742f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 274365863862SAndy Whitcroft } 2744d8aaf121SAndy Whitcroft 27453705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 274665863862SAndy Whitcroft if ($from ne $to) { 27473705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 27483705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 27493705ce5bSJoe Perches $fix) { 27503705ce5bSJoe Perches my $sub_from = $ident; 27513705ce5bSJoe Perches my $sub_to = $ident; 27523705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 27533705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27543705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 27553705ce5bSJoe Perches } 275665863862SAndy Whitcroft } 2757bfcb2cc7SAndy Whitcroft } 2758bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2759bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 27603705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2761d8aaf121SAndy Whitcroft 276265863862SAndy Whitcroft # Should start with a space. 276365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 276465863862SAndy Whitcroft # Should not end with a space. 276565863862SAndy Whitcroft $to =~ s/\s+$//; 276665863862SAndy Whitcroft # '*'s should not have spaces between. 2767f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 276865863862SAndy Whitcroft } 276965863862SAndy Whitcroft # Modifiers should have spaces. 277065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 277165863862SAndy Whitcroft 27723705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2773667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 27743705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 27753705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 27763705ce5bSJoe Perches $fix) { 27773705ce5bSJoe Perches 27783705ce5bSJoe Perches my $sub_from = $match; 27793705ce5bSJoe Perches my $sub_to = $match; 27803705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 27813705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27823705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 27833705ce5bSJoe Perches } 278465863862SAndy Whitcroft } 27850a920b5bSAndy Whitcroft } 27860a920b5bSAndy Whitcroft 27870a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 27880a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 27890a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 27900a920b5bSAndy Whitcroft# print "$herecurr"; 27910a920b5bSAndy Whitcroft# $clean = 0; 27920a920b5bSAndy Whitcroft# } 27930a920b5bSAndy Whitcroft 27948905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2795000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2796000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 27978905a67cSAndy Whitcroft } 27988905a67cSAndy Whitcroft 279917441227SJoe Perches# check for uses of printk_ratelimit 280017441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2801000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2802000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 280317441227SJoe Perches } 280417441227SJoe Perches 280500df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 280600df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 280700df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 280825985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 280900df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2810f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 281100df344fSAndy Whitcroft my $ok = 0; 281200df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 281300df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 281425985edcSLucas De Marchi # we have a preceding printk if it ends 281500df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 281600df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 281700df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 281800df344fSAndy Whitcroft $ok = 1; 281900df344fSAndy Whitcroft } 282000df344fSAndy Whitcroft last; 282100df344fSAndy Whitcroft } 282200df344fSAndy Whitcroft } 282300df344fSAndy Whitcroft if ($ok == 0) { 2824000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2825000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 28260a920b5bSAndy Whitcroft } 282700df344fSAndy Whitcroft } 28280a920b5bSAndy Whitcroft 2829243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2830243f3803SJoe Perches my $orig = $1; 2831243f3803SJoe Perches my $level = lc($orig); 2832243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 28338f26b837SJoe Perches my $level2 = $level; 28348f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2835243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 2836*daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2837243f3803SJoe Perches } 2838243f3803SJoe Perches 2839243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2840d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2841d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2842d5e616fcSJoe Perches $fix) { 2843d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2844d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2845d5e616fcSJoe Perches } 2846243f3803SJoe Perches } 2847243f3803SJoe Perches 2848dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2849dc139313SJoe Perches my $orig = $1; 2850dc139313SJoe Perches my $level = lc($orig); 2851dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2852dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2853dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2854dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2855dc139313SJoe Perches } 2856dc139313SJoe Perches 2857653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2858653d4876SAndy Whitcroft# or if closed on same line 2859c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2860c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2861000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2862000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 28630a920b5bSAndy Whitcroft } 2864653d4876SAndy Whitcroft 28658905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 28668905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 28678905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2868000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2869000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 28708905a67cSAndy Whitcroft } 28718905a67cSAndy Whitcroft 28720c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 28733705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 28743705ce5bSJoe Perches if (WARN("SPACING", 28753705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 28763705ce5bSJoe Perches $fix) { 28773705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28783705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 28793705ce5bSJoe Perches } 28800c73b4ebSAndy Whitcroft } 28810c73b4ebSAndy Whitcroft 288231070b5dSJoe Perches# Function pointer declarations 288331070b5dSJoe Perches# check spacing between type, funcptr, and args 288431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 288591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 288631070b5dSJoe Perches my $declare = $1; 288731070b5dSJoe Perches my $pre_pointer_space = $2; 288831070b5dSJoe Perches my $post_pointer_space = $3; 288931070b5dSJoe Perches my $funcname = $4; 289031070b5dSJoe Perches my $post_funcname_space = $5; 289131070b5dSJoe Perches my $pre_args_space = $6; 289231070b5dSJoe Perches 289391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 289491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 289591f72e9cSJoe Perches# don't need a space so don't warn for those. 289691f72e9cSJoe Perches my $post_declare_space = ""; 289791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 289891f72e9cSJoe Perches $post_declare_space = $1; 289991f72e9cSJoe Perches $declare = rtrim($declare); 290091f72e9cSJoe Perches } 290191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 290231070b5dSJoe Perches WARN("SPACING", 290331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 290491f72e9cSJoe Perches $post_declare_space = " "; 290531070b5dSJoe Perches } 290631070b5dSJoe Perches 290731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 290891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 290991f72e9cSJoe Perches# equivalent to 291091f72e9cSJoe Perches# int foo(int bar, ...) 291191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 291291f72e9cSJoe Perches# 291391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 291491f72e9cSJoe Perches# WARN("SPACING", 291591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 291691f72e9cSJoe Perches# } 291731070b5dSJoe Perches 291831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 291931070b5dSJoe Perches if (defined $pre_pointer_space && 292031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 292131070b5dSJoe Perches WARN("SPACING", 292231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 292331070b5dSJoe Perches } 292431070b5dSJoe Perches 292531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 292631070b5dSJoe Perches if (defined $post_pointer_space && 292731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 292831070b5dSJoe Perches WARN("SPACING", 292931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 293031070b5dSJoe Perches } 293131070b5dSJoe Perches 293231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 293331070b5dSJoe Perches if (defined $post_funcname_space && 293431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 293531070b5dSJoe Perches WARN("SPACING", 293631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 293731070b5dSJoe Perches } 293831070b5dSJoe Perches 293931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 294031070b5dSJoe Perches if (defined $pre_args_space && 294131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 294231070b5dSJoe Perches WARN("SPACING", 294331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 294431070b5dSJoe Perches } 294531070b5dSJoe Perches 294631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 294731070b5dSJoe Perches $fixed[$linenr - 1] =~ 294891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 294931070b5dSJoe Perches } 295031070b5dSJoe Perches } 295131070b5dSJoe Perches 29528d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 29538d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2954fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2955fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 29568d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 29578d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 29588d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2959fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2960daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 29613705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 29623705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 29633705ce5bSJoe Perches $fix) { 29643705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29653705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 29663705ce5bSJoe Perches } 29678d31cfceSAndy Whitcroft } 29688d31cfceSAndy Whitcroft } 29698d31cfceSAndy Whitcroft 2970f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 29716c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2972c2fdda0dSAndy Whitcroft my $name = $1; 2973773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2974773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2975c2fdda0dSAndy Whitcroft 2976c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2977773647a0SAndy Whitcroft if ($name =~ /^(?: 2978773647a0SAndy Whitcroft if|for|while|switch|return|case| 2979773647a0SAndy Whitcroft volatile|__volatile__| 2980773647a0SAndy Whitcroft __attribute__|format|__extension__| 2981773647a0SAndy Whitcroft asm|__asm__)$/x) 2982773647a0SAndy Whitcroft { 2983c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2984c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2985c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2986c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2987773647a0SAndy Whitcroft 2988773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2989c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2990c2fdda0dSAndy Whitcroft 2991c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2992c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2993773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2994c2fdda0dSAndy Whitcroft 2995c2fdda0dSAndy Whitcroft } else { 29963705ce5bSJoe Perches if (WARN("SPACING", 29973705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 29983705ce5bSJoe Perches $fix) { 29993705ce5bSJoe Perches $fixed[$linenr - 1] =~ 30003705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 30013705ce5bSJoe Perches } 3002f0a594c1SAndy Whitcroft } 30036c72ffaaSAndy Whitcroft } 30049a4cad4eSEric Nelson 3005653d4876SAndy Whitcroft# Check operator spacing. 30060a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 30073705ce5bSJoe Perches my $fixed_line = ""; 30083705ce5bSJoe Perches my $line_fixed = 0; 30093705ce5bSJoe Perches 30109c0ca6f9SAndy Whitcroft my $ops = qr{ 30119c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 30129c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 30139c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 30141f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 301584731623SJoe Perches \?:|\?|: 30169c0ca6f9SAndy Whitcroft }x; 3017cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 30183705ce5bSJoe Perches 30193705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 30203705ce5bSJoe Perches## foreach my $el (@elements) { 30213705ce5bSJoe Perches## print("el: <$el>\n"); 30223705ce5bSJoe Perches## } 30233705ce5bSJoe Perches 30243705ce5bSJoe Perches my @fix_elements = (); 302500df344fSAndy Whitcroft my $off = 0; 30266c72ffaaSAndy Whitcroft 30273705ce5bSJoe Perches foreach my $el (@elements) { 30283705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 30293705ce5bSJoe Perches $off += length($el); 30303705ce5bSJoe Perches } 30313705ce5bSJoe Perches 30323705ce5bSJoe Perches $off = 0; 30333705ce5bSJoe Perches 30346c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3035b34c648bSJoe Perches my $last_after = -1; 30366c72ffaaSAndy Whitcroft 30370a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 30383705ce5bSJoe Perches 30393705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 30403705ce5bSJoe Perches 30413705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 30423705ce5bSJoe Perches 30434a0df2efSAndy Whitcroft $off += length($elements[$n]); 30444a0df2efSAndy Whitcroft 304525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3046773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3047773647a0SAndy Whitcroft my $cc = ''; 3048773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3049773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3050773647a0SAndy Whitcroft } 3051773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3052773647a0SAndy Whitcroft 30534a0df2efSAndy Whitcroft my $a = ''; 30544a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 30554a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3056cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 30574a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 30584a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3059773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 30604a0df2efSAndy Whitcroft 30610a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 30624a0df2efSAndy Whitcroft 30634a0df2efSAndy Whitcroft my $c = ''; 30640a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 30654a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 30664a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3067cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 30684a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 30694a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 30708b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 30714a0df2efSAndy Whitcroft } else { 30724a0df2efSAndy Whitcroft $c = 'E'; 30730a920b5bSAndy Whitcroft } 30740a920b5bSAndy Whitcroft 30754a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 30764a0df2efSAndy Whitcroft 30774a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 30784a0df2efSAndy Whitcroft 30796c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3080de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 30810a920b5bSAndy Whitcroft 308274048ed8SAndy Whitcroft # Pull out the value of this operator. 30836c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 30840a920b5bSAndy Whitcroft 30851f65f947SAndy Whitcroft # Get the full operator variant. 30861f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 30871f65f947SAndy Whitcroft 308813214adfSAndy Whitcroft # Ignore operators passed as parameters. 308913214adfSAndy Whitcroft if ($op_type ne 'V' && 309013214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 309113214adfSAndy Whitcroft 3092cf655043SAndy Whitcroft# # Ignore comments 3093cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 309413214adfSAndy Whitcroft 3095d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 309613214adfSAndy Whitcroft } elsif ($op eq ';') { 3097cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3098cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 30993705ce5bSJoe Perches if (ERROR("SPACING", 31003705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3101b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31023705ce5bSJoe Perches $line_fixed = 1; 31033705ce5bSJoe Perches } 3104d8aaf121SAndy Whitcroft } 3105d8aaf121SAndy Whitcroft 3106d8aaf121SAndy Whitcroft # // is a comment 3107d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 31080a920b5bSAndy Whitcroft 31091f65f947SAndy Whitcroft # No spaces for: 31101f65f947SAndy Whitcroft # -> 31111f65f947SAndy Whitcroft # : when part of a bitfield 31121f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 31134a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 31143705ce5bSJoe Perches if (ERROR("SPACING", 31153705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3116b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 31173705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31183705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 31193705ce5bSJoe Perches } 3120b34c648bSJoe Perches $line_fixed = 1; 31213705ce5bSJoe Perches } 31220a920b5bSAndy Whitcroft } 31230a920b5bSAndy Whitcroft 31240a920b5bSAndy Whitcroft # , must have a space on the right. 31250a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3126cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 31273705ce5bSJoe Perches if (ERROR("SPACING", 31283705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3129b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31303705ce5bSJoe Perches $line_fixed = 1; 3131b34c648bSJoe Perches $last_after = $n; 31323705ce5bSJoe Perches } 31330a920b5bSAndy Whitcroft } 31340a920b5bSAndy Whitcroft 31359c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 313674048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 31379c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 31389c0ca6f9SAndy Whitcroft 31399c0ca6f9SAndy Whitcroft # unary operators should have a space before and 31409c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 31419c0ca6f9SAndy Whitcroft # unary operator, or a cast 31429c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 314374048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 31440d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3145cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 31463705ce5bSJoe Perches if (ERROR("SPACING", 31473705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3148b34c648bSJoe Perches if ($n != $last_after + 2) { 3149b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 31503705ce5bSJoe Perches $line_fixed = 1; 31513705ce5bSJoe Perches } 31520a920b5bSAndy Whitcroft } 3153b34c648bSJoe Perches } 3154a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3155171ae1a4SAndy Whitcroft # A unary '*' may be const 3156171ae1a4SAndy Whitcroft 3157171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 31583705ce5bSJoe Perches if (ERROR("SPACING", 31593705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3160b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 31613705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31623705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 31633705ce5bSJoe Perches } 3164b34c648bSJoe Perches $line_fixed = 1; 31653705ce5bSJoe Perches } 31660a920b5bSAndy Whitcroft } 31670a920b5bSAndy Whitcroft 31680a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 31690a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3170773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 31713705ce5bSJoe Perches if (ERROR("SPACING", 31723705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3173b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 31743705ce5bSJoe Perches $line_fixed = 1; 31753705ce5bSJoe Perches } 31760a920b5bSAndy Whitcroft } 3177773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3178773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 31793705ce5bSJoe Perches if (ERROR("SPACING", 31803705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3181b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 31823705ce5bSJoe Perches $line_fixed = 1; 31833705ce5bSJoe Perches } 3184653d4876SAndy Whitcroft } 3185773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 31863705ce5bSJoe Perches if (ERROR("SPACING", 31873705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3188b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 31893705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31903705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3191773647a0SAndy Whitcroft } 3192b34c648bSJoe Perches $line_fixed = 1; 31933705ce5bSJoe Perches } 31943705ce5bSJoe Perches } 31950a920b5bSAndy Whitcroft 31960a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 31979c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 31989c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 31999c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3200c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3201c2fdda0dSAndy Whitcroft $op eq '%') 32020a920b5bSAndy Whitcroft { 3203773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 32043705ce5bSJoe Perches if (ERROR("SPACING", 32053705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3206b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3207b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3208b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3209b34c648bSJoe Perches } 32103705ce5bSJoe Perches $line_fixed = 1; 32113705ce5bSJoe Perches } 32120a920b5bSAndy Whitcroft } 32130a920b5bSAndy Whitcroft 32141f65f947SAndy Whitcroft # A colon needs no spaces before when it is 32151f65f947SAndy Whitcroft # terminating a case value or a label. 32161f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 32171f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 32183705ce5bSJoe Perches if (ERROR("SPACING", 32193705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3220b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 32213705ce5bSJoe Perches $line_fixed = 1; 32223705ce5bSJoe Perches } 32231f65f947SAndy Whitcroft } 32241f65f947SAndy Whitcroft 32250a920b5bSAndy Whitcroft # All the others need spaces both sides. 3226cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 32271f65f947SAndy Whitcroft my $ok = 0; 32281f65f947SAndy Whitcroft 322922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 32301f65f947SAndy Whitcroft if (($op eq '<' && 32311f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 32321f65f947SAndy Whitcroft ($op eq '>' && 32331f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 32341f65f947SAndy Whitcroft { 32351f65f947SAndy Whitcroft $ok = 1; 32361f65f947SAndy Whitcroft } 32371f65f947SAndy Whitcroft 323884731623SJoe Perches # messages are ERROR, but ?: are CHK 32391f65f947SAndy Whitcroft if ($ok == 0) { 324084731623SJoe Perches my $msg_type = \&ERROR; 324184731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 324284731623SJoe Perches 324384731623SJoe Perches if (&{$msg_type}("SPACING", 32443705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3245b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3246b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3247b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3248b34c648bSJoe Perches } 32493705ce5bSJoe Perches $line_fixed = 1; 32503705ce5bSJoe Perches } 32510a920b5bSAndy Whitcroft } 325222f2a2efSAndy Whitcroft } 32534a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 32543705ce5bSJoe Perches 32553705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 32563705ce5bSJoe Perches 32573705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 32580a920b5bSAndy Whitcroft } 32593705ce5bSJoe Perches 32603705ce5bSJoe Perches if (($#elements % 2) == 0) { 32613705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 32623705ce5bSJoe Perches } 32633705ce5bSJoe Perches 32643705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 32653705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 32663705ce5bSJoe Perches } 32673705ce5bSJoe Perches 32683705ce5bSJoe Perches 32690a920b5bSAndy Whitcroft } 32700a920b5bSAndy Whitcroft 3271786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3272d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3273786b6326SJoe Perches if (WARN("SPACING", 3274786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3275786b6326SJoe Perches $fix) { 3276786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3277786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3278786b6326SJoe Perches } 3279786b6326SJoe Perches } 3280786b6326SJoe Perches 3281f0a594c1SAndy Whitcroft# check for multiple assignments 3282f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3283000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3284000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3285f0a594c1SAndy Whitcroft } 3286f0a594c1SAndy Whitcroft 328722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 328822f2a2efSAndy Whitcroft## # continuation. 328922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 329022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 329122f2a2efSAndy Whitcroft## 329222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 329322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 329422f2a2efSAndy Whitcroft## my $ln = $line; 329522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 329622f2a2efSAndy Whitcroft## } 329722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3298000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3299000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 330022f2a2efSAndy Whitcroft## } 330122f2a2efSAndy Whitcroft## } 3302f0a594c1SAndy Whitcroft 33030a920b5bSAndy Whitcroft#need space before brace following if, while, etc 330422f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 330522f2a2efSAndy Whitcroft $line =~ /do{/) { 33063705ce5bSJoe Perches if (ERROR("SPACING", 33073705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 33083705ce5bSJoe Perches $fix) { 3309d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 33103705ce5bSJoe Perches } 3311de7d4f0eSAndy Whitcroft } 3312de7d4f0eSAndy Whitcroft 3313c4a62ef9SJoe Perches## # check for blank lines before declarations 3314c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3315c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3316c4a62ef9SJoe Perches## WARN("SPACING", 3317c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3318c4a62ef9SJoe Perches## } 3319c4a62ef9SJoe Perches## 3320c4a62ef9SJoe Perches 3321de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3322de7d4f0eSAndy Whitcroft# on the line 3323de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3324d5e616fcSJoe Perches if (ERROR("SPACING", 3325d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3326d5e616fcSJoe Perches $fix) { 3327d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3328d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3329d5e616fcSJoe Perches } 33300a920b5bSAndy Whitcroft } 33310a920b5bSAndy Whitcroft 333222f2a2efSAndy Whitcroft# check spacing on square brackets 333322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 33343705ce5bSJoe Perches if (ERROR("SPACING", 33353705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 33363705ce5bSJoe Perches $fix) { 33373705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33383705ce5bSJoe Perches s/\[\s+/\[/; 33393705ce5bSJoe Perches } 334022f2a2efSAndy Whitcroft } 334122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 33423705ce5bSJoe Perches if (ERROR("SPACING", 33433705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 33443705ce5bSJoe Perches $fix) { 33453705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33463705ce5bSJoe Perches s/\s+\]/\]/; 33473705ce5bSJoe Perches } 334822f2a2efSAndy Whitcroft } 334922f2a2efSAndy Whitcroft 3350c45dcabdSAndy Whitcroft# check spacing on parentheses 33519c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 33529c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 33533705ce5bSJoe Perches if (ERROR("SPACING", 33543705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 33553705ce5bSJoe Perches $fix) { 33563705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33573705ce5bSJoe Perches s/\(\s+/\(/; 33583705ce5bSJoe Perches } 335922f2a2efSAndy Whitcroft } 336013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3361c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3362c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 33633705ce5bSJoe Perches if (ERROR("SPACING", 33643705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 33653705ce5bSJoe Perches $fix) { 33663705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33673705ce5bSJoe Perches s/\s+\)/\)/; 33683705ce5bSJoe Perches } 336922f2a2efSAndy Whitcroft } 337022f2a2efSAndy Whitcroft 33710a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 33724a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 33730a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 33743705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 33753705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 33763705ce5bSJoe Perches $fix) { 33773705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33783705ce5bSJoe Perches s/^(.)\s+/$1/; 33793705ce5bSJoe Perches } 33800a920b5bSAndy Whitcroft } 33810a920b5bSAndy Whitcroft 33825b9553abSJoe Perches# return is not a function 3383507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3384c45dcabdSAndy Whitcroft my $spacing = $1; 3385507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 33865b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 33875b9553abSJoe Perches my $value = $1; 33885b9553abSJoe Perches $value = deparenthesize($value); 33895b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3390000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3391000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 33925b9553abSJoe Perches } 3393c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3394000d1cc1SJoe Perches ERROR("SPACING", 3395000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3396c45dcabdSAndy Whitcroft } 3397c45dcabdSAndy Whitcroft } 3398507e5141SJoe Perches 3399189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3400189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3401189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3402189248d8SJoe Perches my $openparens = $1; 3403189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3404189248d8SJoe Perches my $msg = ""; 3405189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3406189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3407189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3408189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3409189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3410189248d8SJoe Perches } 3411189248d8SJoe Perches } 3412189248d8SJoe Perches 341353a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 341453a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 341553a3c448SAndy Whitcroft my $name = $1; 341653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3417000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3418000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 341953a3c448SAndy Whitcroft } 342053a3c448SAndy Whitcroft } 3421c45dcabdSAndy Whitcroft 34220a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 34234a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 34243705ce5bSJoe Perches if (ERROR("SPACING", 34253705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 34263705ce5bSJoe Perches $fix) { 34273705ce5bSJoe Perches $fixed[$linenr - 1] =~ 34283705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 34293705ce5bSJoe Perches } 34300a920b5bSAndy Whitcroft } 34310a920b5bSAndy Whitcroft 3432f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3433f5fe35ddSAndy Whitcroft# statements after the conditional. 3434170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 34353e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 34363e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 34373e469cdcSAndy Whitcroft if (!defined $stat); 3438170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3439170d3a22SAndy Whitcroft $remain_next, $off_next); 3440170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3441170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3442170d3a22SAndy Whitcroft 3443170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3444170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3445170d3a22SAndy Whitcroft # then count those as offsets. 3446170d3a22SAndy Whitcroft my ($whitespace) = 3447170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3448170d3a22SAndy Whitcroft my $offset = 3449170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3450170d3a22SAndy Whitcroft 3451170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3452170d3a22SAndy Whitcroft $offset} = 1; 3453170d3a22SAndy Whitcroft } 3454170d3a22SAndy Whitcroft } 3455170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3456c11230f4SJoe Perches defined($stat) && defined($cond) && 3457170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3458171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 34598905a67cSAndy Whitcroft 3460b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3461000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3462000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 34638905a67cSAndy Whitcroft } 34648905a67cSAndy Whitcroft 34658905a67cSAndy Whitcroft # Find out what is on the end of the line after the 34668905a67cSAndy Whitcroft # conditional. 3467773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 34688905a67cSAndy Whitcroft $s =~ s/\n.*//g; 346913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 347053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 347153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3472773647a0SAndy Whitcroft { 3473bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3474bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3475bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 347642bdf74cSHidetoshi Seto my $stat_real = ''; 3477bb44ad39SAndy Whitcroft 347842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 347942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3480bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3481bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3482bb44ad39SAndy Whitcroft } 3483bb44ad39SAndy Whitcroft 3484000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3485000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 34868905a67cSAndy Whitcroft } 34878905a67cSAndy Whitcroft } 34888905a67cSAndy Whitcroft 348913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 349013214adfSAndy Whitcroft if ($line =~ / 349113214adfSAndy Whitcroft (?: 349213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 349313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 349413214adfSAndy Whitcroft (?:\&\&|\|\|) 349513214adfSAndy Whitcroft | 349613214adfSAndy Whitcroft (?:\&\&|\|\|) 349713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 349813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 349913214adfSAndy Whitcroft )/x) 350013214adfSAndy Whitcroft { 3501000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3502000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 350313214adfSAndy Whitcroft } 350413214adfSAndy Whitcroft 35058905a67cSAndy Whitcroft# if and else should not have general statements after it 350613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 350713214adfSAndy Whitcroft my $s = $1; 350813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 350913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3510000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3511000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 35120a920b5bSAndy Whitcroft } 351313214adfSAndy Whitcroft } 351439667782SAndy Whitcroft# if should not continue a brace 351539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3516000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3517000d1cc1SJoe Perches "trailing statements should be on next line\n" . 351839667782SAndy Whitcroft $herecurr); 351939667782SAndy Whitcroft } 3520a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3521a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3522a1080bf8SAndy Whitcroft $line !~ /\G(?: 35233fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3524a1080bf8SAndy Whitcroft \s*return\s+ 3525a1080bf8SAndy Whitcroft )/xg) 3526a1080bf8SAndy Whitcroft { 3527000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3528000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3529a1080bf8SAndy Whitcroft } 35300a920b5bSAndy Whitcroft 35310a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 35320a920b5bSAndy Whitcroft # indent level to be relevant to each other. 35330a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 35340a920b5bSAndy Whitcroft $previndent == $indent) { 3535000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3536000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 35370a920b5bSAndy Whitcroft } 35380a920b5bSAndy Whitcroft 3539c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3540c2fdda0dSAndy Whitcroft $previndent == $indent) { 3541c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3542c2fdda0dSAndy Whitcroft 3543c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3544c2fdda0dSAndy Whitcroft # conditional. 3545773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3546c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3547c2fdda0dSAndy Whitcroft 3548c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3549000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3550000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3551c2fdda0dSAndy Whitcroft } 3552c2fdda0dSAndy Whitcroft } 3553c2fdda0dSAndy Whitcroft 355495e2c602SJoe Perches#Specific variable tests 3555323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3556323c1260SJoe Perches my $var = $1; 355795e2c602SJoe Perches 355895e2c602SJoe Perches#gcc binary extension 355995e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3560d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3561d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3562d5e616fcSJoe Perches $fix) { 3563d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3564d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3565d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3566d5e616fcSJoe Perches } 356795e2c602SJoe Perches } 356895e2c602SJoe Perches 356995e2c602SJoe Perches#CamelCase 3570807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3571be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 357222735ce8SJoe Perches#Ignore Page<foo> variants 3573807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 357422735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 35753445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 35767e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 35777e781f67SJoe Perches my $word = $1; 35787e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3579d8b07710SJoe Perches if ($check) { 3580d8b07710SJoe Perches seed_camelcase_includes(); 3581d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3582d8b07710SJoe Perches seed_camelcase_file($realfile); 3583d8b07710SJoe Perches $camelcase_file_seeded = 1; 3584d8b07710SJoe Perches } 3585d8b07710SJoe Perches } 35867e781f67SJoe Perches if (!defined $camelcase{$word}) { 35877e781f67SJoe Perches $camelcase{$word} = 1; 3588be79794bSJoe Perches CHK("CAMELCASE", 35897e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 35907e781f67SJoe Perches } 3591323c1260SJoe Perches } 3592323c1260SJoe Perches } 35933445686aSJoe Perches } 35940a920b5bSAndy Whitcroft 35950a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3596d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3597d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3598d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3599d5e616fcSJoe Perches $fix) { 3600d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3601d5e616fcSJoe Perches } 36020a920b5bSAndy Whitcroft } 36030a920b5bSAndy Whitcroft 3604653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3605c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3606e09dec48SAndy Whitcroft my $file = "$1.h"; 3607e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3608e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3609e09dec48SAndy Whitcroft $realfile ne $checkfile && 36107840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3611c45dcabdSAndy Whitcroft { 3612e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3613000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3614000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3615e09dec48SAndy Whitcroft } else { 3616000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3617000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3618e09dec48SAndy Whitcroft } 36190a920b5bSAndy Whitcroft } 36200a920b5bSAndy Whitcroft } 36210a920b5bSAndy Whitcroft 3622653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3623653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3624cf655043SAndy Whitcroft# in a known good container 3625b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3626b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3627d8aaf121SAndy Whitcroft my $ln = $linenr; 3628d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3629c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3630c45dcabdSAndy Whitcroft my $ctx = ''; 3631c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3632f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3633f74bd194SAndy Whitcroft $ctx = $dstat; 3634c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3635a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3636c45dcabdSAndy Whitcroft 3637f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3638292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3639c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3640c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3641c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3642c45dcabdSAndy Whitcroft 3643c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3644bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3645bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3646c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3647bf30d6edSAndy Whitcroft { 3648c45dcabdSAndy Whitcroft } 3649c45dcabdSAndy Whitcroft 3650e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3651e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3652e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3653e45bab8eSAndy Whitcroft { 3654e45bab8eSAndy Whitcroft } 3655e45bab8eSAndy Whitcroft 3656c45dcabdSAndy Whitcroft my $exceptions = qr{ 3657c45dcabdSAndy Whitcroft $Declare| 3658c45dcabdSAndy Whitcroft module_param_named| 3659a0a0a7a9SKees Cook MODULE_PARM_DESC| 3660c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3661c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3662383099fdSAndy Whitcroft __typeof__\(| 366322fd2d3eSStefani Seibold union| 366422fd2d3eSStefani Seibold struct| 3665ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3666ea71a0a0SAndy Whitcroft ^\"|\"$ 3667c45dcabdSAndy Whitcroft }x; 36685eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3669f74bd194SAndy Whitcroft if ($dstat ne '' && 3670f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3671f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 36723cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3673b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3674f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3675f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3676e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 367772f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3678f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3679f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3680f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3681f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3682f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3683c45dcabdSAndy Whitcroft { 3684f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3685f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3686f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3687f74bd194SAndy Whitcroft 3688f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3689f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3690c45dcabdSAndy Whitcroft } 3691c45dcabdSAndy Whitcroft 3692f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3693f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3694f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3695f74bd194SAndy Whitcroft } else { 3696000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3697f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3698d8aaf121SAndy Whitcroft } 36990a920b5bSAndy Whitcroft } 37005023d347SJoe Perches 3701481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 37025023d347SJoe Perches 37035023d347SJoe Perches } else { 37045023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3705481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3706481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 37075023d347SJoe Perches $line =~ /^\+.*\\$/) { 37085023d347SJoe Perches WARN("LINE_CONTINUATIONS", 37095023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 37105023d347SJoe Perches } 3711653d4876SAndy Whitcroft } 37120a920b5bSAndy Whitcroft 3713b13edf7fSJoe Perches# do {} while (0) macro tests: 3714b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3715b13edf7fSJoe Perches# macro should not end with a semicolon 3716b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3717b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3718b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3719b13edf7fSJoe Perches my $ln = $linenr; 3720b13edf7fSJoe Perches my $cnt = $realcnt; 3721b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3722b13edf7fSJoe Perches my $ctx = ''; 3723b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3724b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3725b13edf7fSJoe Perches $ctx = $dstat; 3726b13edf7fSJoe Perches 3727b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3728b13edf7fSJoe Perches 3729b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3730b13edf7fSJoe Perches my $stmts = $2; 3731b13edf7fSJoe Perches my $semis = $3; 3732b13edf7fSJoe Perches 3733b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3734b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3735b13edf7fSJoe Perches my $herectx = $here . "\n"; 3736b13edf7fSJoe Perches 3737b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3738b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3739b13edf7fSJoe Perches } 3740b13edf7fSJoe Perches 3741ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3742ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3743b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3744b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3745b13edf7fSJoe Perches } 3746b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3747b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3748b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3749b13edf7fSJoe Perches } 3750b13edf7fSJoe Perches } 3751b13edf7fSJoe Perches } 3752b13edf7fSJoe Perches 3753080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3754080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3755080ba929SMike Frysinger# . 3756080ba929SMike Frysinger# ALIGN(...) 3757080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3758080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3759000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3760000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3761080ba929SMike Frysinger } 3762080ba929SMike Frysinger 3763f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 376413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 376513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3766cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 376713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3768cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3769cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3770aad4f614SJoe Perches my @allowed = (); 3771aad4f614SJoe Perches my $allow = 0; 377213214adfSAndy Whitcroft my $seen = 0; 3773773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3774cf655043SAndy Whitcroft my $ln = $linenr - 1; 377513214adfSAndy Whitcroft for my $chunk (@chunks) { 377613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 377713214adfSAndy Whitcroft 3778773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3779773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3780773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3781773647a0SAndy Whitcroft 3782aad4f614SJoe Perches $allowed[$allow] = 0; 3783773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3784773647a0SAndy Whitcroft 3785773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3786773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3787773647a0SAndy Whitcroft 3788773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3789cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3790cf655043SAndy Whitcroft 3791773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 379213214adfSAndy Whitcroft 379313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 379413214adfSAndy Whitcroft 3795aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3796cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3797cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3798aad4f614SJoe Perches $allowed[$allow] = 1; 379913214adfSAndy Whitcroft } 380013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3801cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3802aad4f614SJoe Perches $allowed[$allow] = 1; 380313214adfSAndy Whitcroft } 3804cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3805cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3806aad4f614SJoe Perches $allowed[$allow] = 1; 380713214adfSAndy Whitcroft } 3808aad4f614SJoe Perches $allow++; 380913214adfSAndy Whitcroft } 3810aad4f614SJoe Perches if ($seen) { 3811aad4f614SJoe Perches my $sum_allowed = 0; 3812aad4f614SJoe Perches foreach (@allowed) { 3813aad4f614SJoe Perches $sum_allowed += $_; 3814aad4f614SJoe Perches } 3815aad4f614SJoe Perches if ($sum_allowed == 0) { 3816000d1cc1SJoe Perches WARN("BRACES", 3817000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3818aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3819aad4f614SJoe Perches $seen != $allow) { 3820aad4f614SJoe Perches CHK("BRACES", 3821aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3822aad4f614SJoe Perches } 382313214adfSAndy Whitcroft } 382413214adfSAndy Whitcroft } 382513214adfSAndy Whitcroft } 3826773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 382713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3828cf655043SAndy Whitcroft my $allowed = 0; 3829f0a594c1SAndy Whitcroft 3830cf655043SAndy Whitcroft # Check the pre-context. 3831cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3832cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3833cf655043SAndy Whitcroft $allowed = 1; 3834f0a594c1SAndy Whitcroft } 3835773647a0SAndy Whitcroft 3836773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3837773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3838773647a0SAndy Whitcroft 3839cf655043SAndy Whitcroft # Check the condition. 3840cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3841773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3842cf655043SAndy Whitcroft if (defined $cond) { 3843773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3844cf655043SAndy Whitcroft } 3845cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3846cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3847cf655043SAndy Whitcroft $allowed = 1; 3848cf655043SAndy Whitcroft } 3849cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3850cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3851cf655043SAndy Whitcroft $allowed = 1; 3852cf655043SAndy Whitcroft } 3853cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3854cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3855cf655043SAndy Whitcroft $allowed = 1; 3856cf655043SAndy Whitcroft } 3857cf655043SAndy Whitcroft # Check the post-context. 3858cf655043SAndy Whitcroft if (defined $chunks[1]) { 3859cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3860cf655043SAndy Whitcroft if (defined $cond) { 3861773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3862cf655043SAndy Whitcroft } 3863cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3864cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3865cf655043SAndy Whitcroft $allowed = 1; 3866cf655043SAndy Whitcroft } 3867cf655043SAndy Whitcroft } 3868cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 386969932487SJustin P. Mattock my $herectx = $here . "\n"; 3870f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3871cf655043SAndy Whitcroft 3872f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 387369932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3874cf655043SAndy Whitcroft } 3875cf655043SAndy Whitcroft 3876000d1cc1SJoe Perches WARN("BRACES", 3877000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3878f0a594c1SAndy Whitcroft } 3879f0a594c1SAndy Whitcroft } 3880f0a594c1SAndy Whitcroft 38810979ae66SJoe Perches# check for unnecessary blank lines around braces 388277b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 38830979ae66SJoe Perches CHK("BRACES", 38840979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 38850979ae66SJoe Perches } 388677b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 38870979ae66SJoe Perches CHK("BRACES", 38880979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 38890979ae66SJoe Perches } 38900979ae66SJoe Perches 38914a0df2efSAndy Whitcroft# no volatiles please 38926c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 38936c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3894000d1cc1SJoe Perches WARN("VOLATILE", 3895000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 38964a0df2efSAndy Whitcroft } 38974a0df2efSAndy Whitcroft 389800df344fSAndy Whitcroft# warn about #if 0 3899c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3900000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3901000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3902de7d4f0eSAndy Whitcroft $herecurr); 39034a0df2efSAndy Whitcroft } 39044a0df2efSAndy Whitcroft 390503df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 390603df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 390703df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 390803df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 390903df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 391003df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 39114c432a8fSGreg Kroah-Hartman } 39124c432a8fSGreg Kroah-Hartman } 3913f0a594c1SAndy Whitcroft 39148716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 39158716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 39168716de38SJoe Perches my $attr = $1; 39178716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 39188716de38SJoe Perches my $ptr = $1; 39198716de38SJoe Perches my $var = $2; 39208716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 39218716de38SJoe Perches ERROR("MISPLACED_INIT", 39228716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 39238716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 39248716de38SJoe Perches WARN("MISPLACED_INIT", 39258716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 39268716de38SJoe Perches $fix) { 39278716de38SJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e; 39288716de38SJoe Perches } 39298716de38SJoe Perches } 39308716de38SJoe Perches } 39318716de38SJoe Perches 3932e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 3933e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 3934e970b884SJoe Perches my $attr = $1; 3935e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 3936e970b884SJoe Perches my $attr_prefix = $1; 3937e970b884SJoe Perches my $attr_type = $2; 3938e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3939e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 3940e970b884SJoe Perches $fix) { 3941e970b884SJoe Perches $fixed[$linenr - 1] =~ 3942e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 3943e970b884SJoe Perches } 3944e970b884SJoe Perches } 3945e970b884SJoe Perches 3946e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 3947e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 3948e970b884SJoe Perches my $attr = $1; 3949e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3950e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 3951e970b884SJoe Perches $fix) { 3952e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 3953e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 3954e970b884SJoe Perches $lead = rtrim($1); 3955e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 3956e970b884SJoe Perches $lead = "${lead}const "; 3957e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 3958e970b884SJoe Perches } 3959e970b884SJoe Perches } 3960e970b884SJoe Perches 3961fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 3962fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 3963fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 3964fbdb8138SJoe Perches my $constant_func = $1; 3965fbdb8138SJoe Perches my $func = $constant_func; 3966fbdb8138SJoe Perches $func =~ s/^__constant_//; 3967fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 3968fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 3969fbdb8138SJoe Perches $fix) { 3970fbdb8138SJoe Perches $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g; 3971fbdb8138SJoe Perches } 3972fbdb8138SJoe Perches } 3973fbdb8138SJoe Perches 39741a15a250SPatrick Pannuto# prefer usleep_range over udelay 397537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 397643c1d77cSJoe Perches my $delay = $1; 39771a15a250SPatrick Pannuto # ignore udelay's < 10, however 397843c1d77cSJoe Perches if (! ($delay < 10) ) { 3979000d1cc1SJoe Perches CHK("USLEEP_RANGE", 398043c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 398143c1d77cSJoe Perches } 398243c1d77cSJoe Perches if ($delay > 2000) { 398343c1d77cSJoe Perches WARN("LONG_UDELAY", 398443c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 39851a15a250SPatrick Pannuto } 39861a15a250SPatrick Pannuto } 39871a15a250SPatrick Pannuto 398809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 398909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 399009ef8725SPatrick Pannuto if ($1 < 20) { 3991000d1cc1SJoe Perches WARN("MSLEEP", 399243c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 399309ef8725SPatrick Pannuto } 399409ef8725SPatrick Pannuto } 399509ef8725SPatrick Pannuto 399636ec1939SJoe Perches# check for comparisons of jiffies 399736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 399836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 399936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 400036ec1939SJoe Perches } 400136ec1939SJoe Perches 40029d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 40039d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 40049d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 40059d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 40069d7a34a5SJoe Perches } 40079d7a34a5SJoe Perches 400800df344fSAndy Whitcroft# warn about #ifdefs in C files 4009c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 401000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 401100df344fSAndy Whitcroft# print "$herecurr"; 401200df344fSAndy Whitcroft# $clean = 0; 401300df344fSAndy Whitcroft# } 401400df344fSAndy Whitcroft 401522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4016c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 40173705ce5bSJoe Perches if (ERROR("SPACING", 40183705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 40193705ce5bSJoe Perches $fix) { 40203705ce5bSJoe Perches $fixed[$linenr - 1] =~ 40213705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 40223705ce5bSJoe Perches } 40233705ce5bSJoe Perches 402422f2a2efSAndy Whitcroft } 402522f2a2efSAndy Whitcroft 40264a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4027171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4028171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 40294a0df2efSAndy Whitcroft my $which = $1; 40304a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4031000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4032000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 40334a0df2efSAndy Whitcroft } 40344a0df2efSAndy Whitcroft } 40354a0df2efSAndy Whitcroft# check for memory barriers without a comment. 40364a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 40374a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4038c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4039000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 40404a0df2efSAndy Whitcroft } 40414a0df2efSAndy Whitcroft } 40424a0df2efSAndy Whitcroft# check of hardware specific defines 4043c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4044000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4045000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 40460a920b5bSAndy Whitcroft } 4047653d4876SAndy Whitcroft 4048d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4049d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4050000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4051000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4052d4977c78STobias Klauser } 4053d4977c78STobias Klauser 4054de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4055de7d4f0eSAndy Whitcroft# storage class and type. 40569c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 40579c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4058000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4059000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4060de7d4f0eSAndy Whitcroft } 4061de7d4f0eSAndy Whitcroft 40628905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 40632b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 40642b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4065d5e616fcSJoe Perches if (WARN("INLINE", 4066d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4067d5e616fcSJoe Perches $fix) { 4068d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 4069d5e616fcSJoe Perches 4070d5e616fcSJoe Perches } 40718905a67cSAndy Whitcroft } 40728905a67cSAndy Whitcroft 40733d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 40742b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 40752b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4076000d1cc1SJoe Perches WARN("PREFER_PACKED", 4077000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 40783d130fd0SJoe Perches } 40793d130fd0SJoe Perches 408039b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 40812b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 40822b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4083000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4084000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 408539b7e287SJoe Perches } 408639b7e287SJoe Perches 40875f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 40882b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 40892b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4090d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4091d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4092d5e616fcSJoe Perches $fix) { 4093d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4094d5e616fcSJoe Perches 4095d5e616fcSJoe Perches } 40965f14d3bdSJoe Perches } 40975f14d3bdSJoe Perches 40986061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 40992b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 41002b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4101d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4102d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4103d5e616fcSJoe Perches $fix) { 4104d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4105d5e616fcSJoe Perches } 41066061d949SJoe Perches } 41076061d949SJoe Perches 41088f53a9b8SJoe Perches# check for sizeof(&) 41098f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4110000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4111000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 41128f53a9b8SJoe Perches } 41138f53a9b8SJoe Perches 411466c80b60SJoe Perches# check for sizeof without parenthesis 411566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4116d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4117d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4118d5e616fcSJoe Perches $fix) { 4119d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4120d5e616fcSJoe Perches } 412166c80b60SJoe Perches } 412266c80b60SJoe Perches 4123428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4124428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4125000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4126000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4127428e2fdcSJoe Perches } 4128428e2fdcSJoe Perches 412988982feaSJoe Perches# check for struct spinlock declarations 413088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 413188982feaSJoe Perches WARN("USE_SPINLOCK_T", 413288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 413388982feaSJoe Perches } 413488982feaSJoe Perches 4135a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 413606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4137a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 413806668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4139d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4140d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4141d5e616fcSJoe Perches $fix) { 4142d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 4143d5e616fcSJoe Perches } 4144a6962d72SJoe Perches } 4145a6962d72SJoe Perches } 4146a6962d72SJoe Perches 4147554e165cSAndy Whitcroft# Check for misused memsets 4148d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4149d1fe9c09SJoe Perches defined $stat && 4150d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4151554e165cSAndy Whitcroft 4152d7c76ba7SJoe Perches my $ms_addr = $2; 4153d1fe9c09SJoe Perches my $ms_val = $7; 4154d1fe9c09SJoe Perches my $ms_size = $12; 4155d7c76ba7SJoe Perches 4156554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4157554e165cSAndy Whitcroft ERROR("MEMSET", 4158d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4159554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4160554e165cSAndy Whitcroft WARN("MEMSET", 4161d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4162d7c76ba7SJoe Perches } 4163d7c76ba7SJoe Perches } 4164d7c76ba7SJoe Perches 416598a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 416698a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 416798a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 416898a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 416998a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 417098a9bba5SJoe Perches $fix) { 417198a9bba5SJoe Perches $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 417298a9bba5SJoe Perches } 417398a9bba5SJoe Perches } 417498a9bba5SJoe Perches 4175d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4176d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4177d1fe9c09SJoe Perches defined $stat && 4178d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4179d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4180d7c76ba7SJoe Perches my $call = $1; 4181d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4182d7c76ba7SJoe Perches my $arg1 = $3; 4183d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4184d1fe9c09SJoe Perches my $arg2 = $8; 4185d7c76ba7SJoe Perches my $cast; 4186d7c76ba7SJoe Perches 4187d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4188d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4189d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4190d7c76ba7SJoe Perches $cast = $cast1; 4191d7c76ba7SJoe Perches } else { 4192d7c76ba7SJoe Perches $cast = $cast2; 4193d7c76ba7SJoe Perches } 4194d7c76ba7SJoe Perches WARN("MINMAX", 4195d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4196554e165cSAndy Whitcroft } 4197554e165cSAndy Whitcroft } 4198554e165cSAndy Whitcroft 41994a273195SJoe Perches# check usleep_range arguments 42004a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 42014a273195SJoe Perches defined $stat && 42024a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 42034a273195SJoe Perches my $min = $1; 42044a273195SJoe Perches my $max = $7; 42054a273195SJoe Perches if ($min eq $max) { 42064a273195SJoe Perches WARN("USLEEP_RANGE", 42074a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 42084a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 42094a273195SJoe Perches $min > $max) { 42104a273195SJoe Perches WARN("USLEEP_RANGE", 42114a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 42124a273195SJoe Perches } 42134a273195SJoe Perches } 42144a273195SJoe Perches 4215823b794cSJoe Perches# check for naked sscanf 4216823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4217823b794cSJoe Perches defined $stat && 42186c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4219823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4220823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4221823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4222823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4223823b794cSJoe Perches $lc = $lc + $linenr; 4224823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4225823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4226823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4227823b794cSJoe Perches } 4228823b794cSJoe Perches WARN("NAKED_SSCANF", 4229823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4230823b794cSJoe Perches } 4231823b794cSJoe Perches 423270dc8a48SJoe Perches# check for new externs in .h files. 423370dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 423470dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4235d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 423670dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 423770dc8a48SJoe Perches $fix) { 423870dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 423970dc8a48SJoe Perches } 424070dc8a48SJoe Perches } 424170dc8a48SJoe Perches 4242de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4243171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4244c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4245171ae1a4SAndy Whitcroft { 4246c45dcabdSAndy Whitcroft my $function_name = $1; 4247c45dcabdSAndy Whitcroft my $paren_space = $2; 4248171ae1a4SAndy Whitcroft 4249171ae1a4SAndy Whitcroft my $s = $stat; 4250171ae1a4SAndy Whitcroft if (defined $cond) { 4251171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4252171ae1a4SAndy Whitcroft } 4253c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4254c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4255c45dcabdSAndy Whitcroft { 4256000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4257000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4258de7d4f0eSAndy Whitcroft } 4259de7d4f0eSAndy Whitcroft 4260171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4261000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4262000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4263171ae1a4SAndy Whitcroft } 42649c9ba34eSAndy Whitcroft 42659c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 42669c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 42679c9ba34eSAndy Whitcroft { 4268000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4269000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4270171ae1a4SAndy Whitcroft } 4271171ae1a4SAndy Whitcroft 4272de7d4f0eSAndy Whitcroft# checks for new __setup's 4273de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4274de7d4f0eSAndy Whitcroft my $name = $1; 4275de7d4f0eSAndy Whitcroft 4276de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4277000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4278000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4279de7d4f0eSAndy Whitcroft } 4280653d4876SAndy Whitcroft } 42819c0ca6f9SAndy Whitcroft 42829c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4283caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4284000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4285000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 42869c0ca6f9SAndy Whitcroft } 428713214adfSAndy Whitcroft 4288a640d25cSJoe Perches# alloc style 4289a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4290a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4291a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4292a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4293a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4294a640d25cSJoe Perches } 4295a640d25cSJoe Perches 4296972fdea2SJoe Perches# check for krealloc arg reuse 4297972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4298972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4299972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4300972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4301972fdea2SJoe Perches } 4302972fdea2SJoe Perches 43035ce59ae0SJoe Perches# check for alloc argument mismatch 43045ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 43055ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 43065ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 43075ce59ae0SJoe Perches } 43085ce59ae0SJoe Perches 43097e4915e7SDavid Rientjes# check for GFP_NOWAIT use 43107e4915e7SDavid Rientjes if ($line =~ /\b__GFP_NOFAIL\b/) { 43117e4915e7SDavid Rientjes WARN("__GFP_NOFAIL", 43127e4915e7SDavid Rientjes "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr); 43137e4915e7SDavid Rientjes } 43147e4915e7SDavid Rientjes 4315caf2a54fSJoe Perches# check for multiple semicolons 4316caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4317d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4318d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4319d5e616fcSJoe Perches $fix) { 4320d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4321d5e616fcSJoe Perches } 4322d1e2ad07SJoe Perches } 4323d1e2ad07SJoe Perches 4324c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4325c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4326c34c09a8SJoe Perches my $has_break = 0; 4327c34c09a8SJoe Perches my $has_statement = 0; 4328c34c09a8SJoe Perches my $count = 0; 4329c34c09a8SJoe Perches my $prevline = $linenr; 4330c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4331c34c09a8SJoe Perches $prevline--; 4332c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4333c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4334c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4335c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4336c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4337c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4338c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4339c34c09a8SJoe Perches $has_statement = 1; 4340c34c09a8SJoe Perches $count++; 4341c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4342c34c09a8SJoe Perches } 4343c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4344c34c09a8SJoe Perches WARN("MISSING_BREAK", 4345c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4346c34c09a8SJoe Perches } 4347c34c09a8SJoe Perches } 4348c34c09a8SJoe Perches 4349d1e2ad07SJoe Perches# check for switch/default statements without a break; 4350d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4351d1e2ad07SJoe Perches defined $stat && 4352d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4353d1e2ad07SJoe Perches my $ctx = ''; 4354d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4355d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4356d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4357d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4358d1e2ad07SJoe Perches } 4359d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4360d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4361caf2a54fSJoe Perches } 4362caf2a54fSJoe Perches 436313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4364d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4365d5e616fcSJoe Perches if (WARN("USE_FUNC", 4366d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4367d5e616fcSJoe Perches $fix) { 4368d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4369d5e616fcSJoe Perches } 437013214adfSAndy Whitcroft } 4371773647a0SAndy Whitcroft 43722c92488aSJoe Perches# check for use of yield() 43732c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 43742c92488aSJoe Perches WARN("YIELD", 43752c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 43762c92488aSJoe Perches } 43772c92488aSJoe Perches 4378179f8f40SJoe Perches# check for comparisons against true and false 4379179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4380179f8f40SJoe Perches my $lead = $1; 4381179f8f40SJoe Perches my $arg = $2; 4382179f8f40SJoe Perches my $test = $3; 4383179f8f40SJoe Perches my $otype = $4; 4384179f8f40SJoe Perches my $trail = $5; 4385179f8f40SJoe Perches my $op = "!"; 4386179f8f40SJoe Perches 4387179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4388179f8f40SJoe Perches 4389179f8f40SJoe Perches my $type = lc($otype); 4390179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4391179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4392179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4393179f8f40SJoe Perches $op = ""; 4394179f8f40SJoe Perches } 4395179f8f40SJoe Perches 4396179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4397179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4398179f8f40SJoe Perches 4399179f8f40SJoe Perches## maybe suggesting a correct construct would better 4400179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4401179f8f40SJoe Perches 4402179f8f40SJoe Perches } 4403179f8f40SJoe Perches } 4404179f8f40SJoe Perches 44054882720bSThomas Gleixner# check for semaphores initialized locked 44064882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4407000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4408000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4409773647a0SAndy Whitcroft } 44106712d858SJoe Perches 441167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 441267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4413000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 441467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4415773647a0SAndy Whitcroft } 44166712d858SJoe Perches 4417f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4418f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4419000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4420000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4421f3db6639SMichael Ellerman } 44226712d858SJoe Perches 442379404849SEmese Revfy# check for various ops structs, ensure they are const. 442479404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 442579404849SEmese Revfy address_space_operations| 442679404849SEmese Revfy backlight_ops| 442779404849SEmese Revfy block_device_operations| 442879404849SEmese Revfy dentry_operations| 442979404849SEmese Revfy dev_pm_ops| 443079404849SEmese Revfy dma_map_ops| 443179404849SEmese Revfy extent_io_ops| 443279404849SEmese Revfy file_lock_operations| 443379404849SEmese Revfy file_operations| 443479404849SEmese Revfy hv_ops| 443579404849SEmese Revfy ide_dma_ops| 443679404849SEmese Revfy intel_dvo_dev_ops| 443779404849SEmese Revfy item_operations| 443879404849SEmese Revfy iwl_ops| 443979404849SEmese Revfy kgdb_arch| 444079404849SEmese Revfy kgdb_io| 444179404849SEmese Revfy kset_uevent_ops| 444279404849SEmese Revfy lock_manager_operations| 444379404849SEmese Revfy microcode_ops| 444479404849SEmese Revfy mtrr_ops| 444579404849SEmese Revfy neigh_ops| 444679404849SEmese Revfy nlmsvc_binding| 444779404849SEmese Revfy pci_raw_ops| 444879404849SEmese Revfy pipe_buf_operations| 444979404849SEmese Revfy platform_hibernation_ops| 445079404849SEmese Revfy platform_suspend_ops| 445179404849SEmese Revfy proto_ops| 445279404849SEmese Revfy rpc_pipe_ops| 445379404849SEmese Revfy seq_operations| 445479404849SEmese Revfy snd_ac97_build_ops| 445579404849SEmese Revfy soc_pcmcia_socket_ops| 445679404849SEmese Revfy stacktrace_ops| 445779404849SEmese Revfy sysfs_ops| 445879404849SEmese Revfy tty_operations| 445979404849SEmese Revfy usb_mon_operations| 446079404849SEmese Revfy wd_ops}x; 44616903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 446279404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4463000d1cc1SJoe Perches WARN("CONST_STRUCT", 4464000d1cc1SJoe Perches "struct $1 should normally be const\n" . 44656903ffb2SAndy Whitcroft $herecurr); 44662b6db5cbSAndy Whitcroft } 4467773647a0SAndy Whitcroft 4468773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4469773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4470773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4471c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4472c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4473171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4474171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4475171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4476773647a0SAndy Whitcroft { 4477000d1cc1SJoe Perches WARN("NR_CPUS", 4478000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4479773647a0SAndy Whitcroft } 44809c9ba34eSAndy Whitcroft 448152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 448252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 448352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 448452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 448552ea8506SJoe Perches } 448652ea8506SJoe Perches 44879c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 44889c9ba34eSAndy Whitcroft my $string; 44899c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 44909c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 44912a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 44929c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4493000d1cc1SJoe Perches WARN("PRINTF_L", 4494000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 44959c9ba34eSAndy Whitcroft last; 44969c9ba34eSAndy Whitcroft } 44979c9ba34eSAndy Whitcroft } 4498691d77b6SAndy Whitcroft 4499691d77b6SAndy Whitcroft# whine mightly about in_atomic 4500691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4501691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4502000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4503000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4504f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4505000d1cc1SJoe Perches WARN("IN_ATOMIC", 4506000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4507691d77b6SAndy Whitcroft } 4508691d77b6SAndy Whitcroft } 45091704f47bSPeter Zijlstra 45101704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 45111704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 45121704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 45131704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 45141704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 45151704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4516000d1cc1SJoe Perches ERROR("LOCKDEP", 4517000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 45181704f47bSPeter Zijlstra } 45191704f47bSPeter Zijlstra } 452088f8831cSDave Jones 452188f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 452288f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4523000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4524000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 452588f8831cSDave Jones } 45262435880fSJoe Perches 45272435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 45282435880fSJoe Perches my $func = $entry->[0]; 45292435880fSJoe Perches my $arg_pos = $entry->[1]; 45302435880fSJoe Perches 45312435880fSJoe Perches my $skip_args = ""; 45322435880fSJoe Perches if ($arg_pos > 1) { 45332435880fSJoe Perches $arg_pos--; 45342435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 45352435880fSJoe Perches } 45362435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 45372435880fSJoe Perches if ($^V && $^V ge 5.10.0 && 45382435880fSJoe Perches $line =~ /$test/) { 45392435880fSJoe Perches my $val = $1; 45402435880fSJoe Perches $val = $6 if ($skip_args ne ""); 45412435880fSJoe Perches 45421727cc70SJoe Perches if ($val !~ /^0$/ && 45431727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 45441727cc70SJoe Perches length($val) ne 4)) { 45452435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 45461727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 45472435880fSJoe Perches } 45482435880fSJoe Perches } 45492435880fSJoe Perches } 455013214adfSAndy Whitcroft } 455113214adfSAndy Whitcroft 455213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 455313214adfSAndy Whitcroft # so just keep quiet. 455413214adfSAndy Whitcroft if ($#rawlines == -1) { 455513214adfSAndy Whitcroft exit(0); 45560a920b5bSAndy Whitcroft } 45570a920b5bSAndy Whitcroft 45588905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 45598905a67cSAndy Whitcroft # things that appear to be patches. 45608905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 45618905a67cSAndy Whitcroft exit(0); 45628905a67cSAndy Whitcroft } 45638905a67cSAndy Whitcroft 45648905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 45658905a67cSAndy Whitcroft # just keep quiet. 45668905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 45678905a67cSAndy Whitcroft exit(0); 45688905a67cSAndy Whitcroft } 45698905a67cSAndy Whitcroft 45708905a67cSAndy Whitcroft if (!$is_patch) { 4571000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4572000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 45730a920b5bSAndy Whitcroft } 45740a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4575000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4576000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 45770a920b5bSAndy Whitcroft } 45780a920b5bSAndy Whitcroft 4579f0a594c1SAndy Whitcroft print report_dump(); 458013214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 458113214adfSAndy Whitcroft print "$filename " if ($summary_file); 45826c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 45836c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 45846c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 45858905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 45866c72ffaaSAndy Whitcroft } 45878905a67cSAndy Whitcroft 4588d2c0a235SAndy Whitcroft if ($quiet == 0) { 4589d1fe9c09SJoe Perches 4590d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4591d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4592d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4593d1fe9c09SJoe Perches } 4594d1fe9c09SJoe Perches 4595d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4596d2c0a235SAndy Whitcroft # then suggest that. 4597d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4598d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4599d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4600b0781216SMike Frysinger $rpt_cleaners = 0; 4601d2c0a235SAndy Whitcroft } 4602d2c0a235SAndy Whitcroft } 4603d2c0a235SAndy Whitcroft 460491bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 460591bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4606000d1cc1SJoe Perches 46073705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 46089624b8d6SJoe Perches my $newfile = $filename; 46099624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 46103705ce5bSJoe Perches my $linecount = 0; 46113705ce5bSJoe Perches my $f; 46123705ce5bSJoe Perches 46133705ce5bSJoe Perches open($f, '>', $newfile) 46143705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 46153705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 46163705ce5bSJoe Perches $linecount++; 46173705ce5bSJoe Perches if ($file) { 46183705ce5bSJoe Perches if ($linecount > 3) { 46193705ce5bSJoe Perches $fixed_line =~ s/^\+//; 46203705ce5bSJoe Perches print $f $fixed_line. "\n"; 46213705ce5bSJoe Perches } 46223705ce5bSJoe Perches } else { 46233705ce5bSJoe Perches print $f $fixed_line . "\n"; 46243705ce5bSJoe Perches } 46253705ce5bSJoe Perches } 46263705ce5bSJoe Perches close($f); 46273705ce5bSJoe Perches 46283705ce5bSJoe Perches if (!$quiet) { 46293705ce5bSJoe Perches print << "EOM"; 46303705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 46313705ce5bSJoe Perches 46323705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 46333705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 46343705ce5bSJoe Perches 46353705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 46363705ce5bSJoe PerchesNo warranties, expressed or implied... 46373705ce5bSJoe Perches 46383705ce5bSJoe PerchesEOM 46393705ce5bSJoe Perches } 46403705ce5bSJoe Perches } 46413705ce5bSJoe Perches 46420a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4643c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 46440a920b5bSAndy Whitcroft } 46450a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4646000d1cc1SJoe Perches print << "EOM"; 4647000d1cc1SJoe Perches$vname has style problems, please review. 4648000d1cc1SJoe Perches 4649000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4650000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4651000d1cc1SJoe PerchesEOM 46520a920b5bSAndy Whitcroft } 465313214adfSAndy Whitcroft 46540a920b5bSAndy Whitcroft return $clean; 46550a920b5bSAndy Whitcroft} 4656