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; 326c72ffaaSAndy Whitcroftmy $root; 33c2fdda0dSAndy Whitcroftmy %debug; 343445686aSJoe Perchesmy %camelcase = (); 3591bfe484SJoe Perchesmy %use_type = (); 3691bfe484SJoe Perchesmy @use = (); 3791bfe484SJoe Perchesmy %ignore_type = (); 38000d1cc1SJoe Perchesmy @ignore = (); 3977f5b10aSHannes Edermy $help = 0; 40000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 416cd7f386SJoe Perchesmy $max_line_length = 80; 42d62a201fSDave Hansenmy $ignore_perl_version = 0; 43d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4477f5b10aSHannes Eder 4577f5b10aSHannes Edersub help { 4677f5b10aSHannes Eder my ($exitcode) = @_; 4777f5b10aSHannes Eder 4877f5b10aSHannes Eder print << "EOM"; 4977f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5077f5b10aSHannes EderVersion: $V 5177f5b10aSHannes Eder 5277f5b10aSHannes EderOptions: 5377f5b10aSHannes Eder -q, --quiet quiet 5477f5b10aSHannes Eder --no-tree run without a kernel tree 5577f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5677f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5777f5b10aSHannes Eder --emacs emacs compile window format 5877f5b10aSHannes Eder --terse one line per report 5977f5b10aSHannes Eder -f, --file treat FILE as regular source file 6077f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6191bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 62000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 636cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 64000d1cc1SJoe Perches --show-types show the message "types" in the output 6577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6677f5b10aSHannes Eder --no-summary suppress the per-file summary 6777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6877f5b10aSHannes Eder --summary-file include the filename in summary 6977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7177f5b10aSHannes Eder is all off) 7277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7377f5b10aSHannes Eder literally 743705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 753705ce5bSJoe Perches If correctable single-line errors exist, create 763705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 773705ce5bSJoe Perches with potential errors corrected to the preferred 783705ce5bSJoe Perches checkpatch style 79d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 80d62a201fSDave Hansen runtime errors. 8177f5b10aSHannes Eder -h, --help, --version display this help and exit 8277f5b10aSHannes Eder 8377f5b10aSHannes EderWhen FILE is - read standard input. 8477f5b10aSHannes EderEOM 8577f5b10aSHannes Eder 8677f5b10aSHannes Eder exit($exitcode); 8777f5b10aSHannes Eder} 8877f5b10aSHannes Eder 89000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 90000d1cc1SJoe Perchesif (-f $conf) { 91000d1cc1SJoe Perches my @conf_args; 92000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 93000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 94000d1cc1SJoe Perches 95000d1cc1SJoe Perches while (<$conffile>) { 96000d1cc1SJoe Perches my $line = $_; 97000d1cc1SJoe Perches 98000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 99000d1cc1SJoe Perches $line =~ s/^\s*//g; 100000d1cc1SJoe Perches $line =~ s/\s+/ /g; 101000d1cc1SJoe Perches 102000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 103000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 104000d1cc1SJoe Perches 105000d1cc1SJoe Perches my @words = split(" ", $line); 106000d1cc1SJoe Perches foreach my $word (@words) { 107000d1cc1SJoe Perches last if ($word =~ m/^#/); 108000d1cc1SJoe Perches push (@conf_args, $word); 109000d1cc1SJoe Perches } 110000d1cc1SJoe Perches } 111000d1cc1SJoe Perches close($conffile); 112000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 113000d1cc1SJoe Perches} 114000d1cc1SJoe Perches 1150a920b5bSAndy WhitcroftGetOptions( 1166c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1170a920b5bSAndy Whitcroft 'tree!' => \$tree, 1180a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1190a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1206c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1218905a67cSAndy Whitcroft 'terse!' => \$terse, 12277f5b10aSHannes Eder 'f|file!' => \$file, 1236c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1246c72ffaaSAndy Whitcroft 'strict!' => \$check, 125000d1cc1SJoe Perches 'ignore=s' => \@ignore, 12691bfe484SJoe Perches 'types=s' => \@use, 127000d1cc1SJoe Perches 'show-types!' => \$show_types, 1286cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1296c72ffaaSAndy Whitcroft 'root=s' => \$root, 1308905a67cSAndy Whitcroft 'summary!' => \$summary, 1318905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13213214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1333705ce5bSJoe Perches 'fix!' => \$fix, 134d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 135c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 136773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 13777f5b10aSHannes Eder 'h|help' => \$help, 13877f5b10aSHannes Eder 'version' => \$help 13977f5b10aSHannes Eder) or help(1); 14077f5b10aSHannes Eder 14177f5b10aSHannes Ederhelp(0) if ($help); 1420a920b5bSAndy Whitcroft 1430a920b5bSAndy Whitcroftmy $exit = 0; 1440a920b5bSAndy Whitcroft 145d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 146d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 147d62a201fSDave Hansen if (!$ignore_perl_version) { 148d62a201fSDave Hansen exit(1); 149d62a201fSDave Hansen } 150d62a201fSDave Hansen} 151d62a201fSDave Hansen 1520a920b5bSAndy Whitcroftif ($#ARGV < 0) { 15377f5b10aSHannes Eder print "$P: no input files\n"; 1540a920b5bSAndy Whitcroft exit(1); 1550a920b5bSAndy Whitcroft} 1560a920b5bSAndy Whitcroft 15791bfe484SJoe Perchessub hash_save_array_words { 15891bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 15991bfe484SJoe Perches 16091bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 16191bfe484SJoe Perches foreach my $word (@array) { 162000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 163000d1cc1SJoe Perches $word =~ s/^\s*//g; 164000d1cc1SJoe Perches $word =~ s/\s+/ /g; 165000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 166000d1cc1SJoe Perches 167000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 168000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 169000d1cc1SJoe Perches 17091bfe484SJoe Perches $hashRef->{$word}++; 171000d1cc1SJoe Perches } 17291bfe484SJoe Perches} 17391bfe484SJoe Perches 17491bfe484SJoe Perchessub hash_show_words { 17591bfe484SJoe Perches my ($hashRef, $prefix) = @_; 17691bfe484SJoe Perches 17758cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 17891bfe484SJoe Perches print "NOTE: $prefix message types:"; 17958cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 18091bfe484SJoe Perches print " $word"; 18191bfe484SJoe Perches } 18291bfe484SJoe Perches print "\n\n"; 18391bfe484SJoe Perches } 18491bfe484SJoe Perches} 18591bfe484SJoe Perches 18691bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 18791bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 188000d1cc1SJoe Perches 189c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 190c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1917429c690SAndy Whitcroftmy $dbg_type = 0; 192a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 193c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 19421caa13cSAndy Whitcroft ## no critic 19521caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 19621caa13cSAndy Whitcroft die "$@" if ($@); 197c2fdda0dSAndy Whitcroft} 198c2fdda0dSAndy Whitcroft 199d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 200d2c0a235SAndy Whitcroft 2018905a67cSAndy Whitcroftif ($terse) { 2028905a67cSAndy Whitcroft $emacs = 1; 2038905a67cSAndy Whitcroft $quiet++; 2048905a67cSAndy Whitcroft} 2058905a67cSAndy Whitcroft 2066c72ffaaSAndy Whitcroftif ($tree) { 2076c72ffaaSAndy Whitcroft if (defined $root) { 2086c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2096c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2106c72ffaaSAndy Whitcroft } 2116c72ffaaSAndy Whitcroft } else { 2126c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2136c72ffaaSAndy Whitcroft $root = '.'; 2146c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2156c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2166c72ffaaSAndy Whitcroft $root = $1; 2176c72ffaaSAndy Whitcroft } 2186c72ffaaSAndy Whitcroft } 2196c72ffaaSAndy Whitcroft 2206c72ffaaSAndy Whitcroft if (!defined $root) { 2210a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2220a920b5bSAndy Whitcroft exit(2); 2230a920b5bSAndy Whitcroft } 2246c72ffaaSAndy Whitcroft} 2256c72ffaaSAndy Whitcroft 2266c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2276c72ffaaSAndy Whitcroft 2282ceb532bSAndy Whitcroftour $Ident = qr{ 2292ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2302ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2312ceb532bSAndy Whitcroft }x; 2326c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2336c72ffaaSAndy Whitcroftour $Sparse = qr{ 2346c72ffaaSAndy Whitcroft __user| 2356c72ffaaSAndy Whitcroft __kernel| 2366c72ffaaSAndy Whitcroft __force| 2376c72ffaaSAndy Whitcroft __iomem| 2386c72ffaaSAndy Whitcroft __must_check| 2396c72ffaaSAndy Whitcroft __init_refok| 240417495edSAndy Whitcroft __kprobes| 241165e72a6SSven Eckelmann __ref| 242165e72a6SSven Eckelmann __rcu 2436c72ffaaSAndy Whitcroft }x; 244e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 245e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 246e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 247e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 248e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2498716de38SJoe Perches 25052131292SWolfram Sang# Notes to $Attribute: 25152131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2526c72ffaaSAndy Whitcroftour $Attribute = qr{ 2536c72ffaaSAndy Whitcroft const| 25403f1df7dSJoe Perches __percpu| 25503f1df7dSJoe Perches __nocast| 25603f1df7dSJoe Perches __safe| 25703f1df7dSJoe Perches __bitwise__| 25803f1df7dSJoe Perches __packed__| 25903f1df7dSJoe Perches __packed2__| 26003f1df7dSJoe Perches __naked| 26103f1df7dSJoe Perches __maybe_unused| 26203f1df7dSJoe Perches __always_unused| 26303f1df7dSJoe Perches __noreturn| 26403f1df7dSJoe Perches __used| 26503f1df7dSJoe Perches __cold| 26603f1df7dSJoe Perches __noclone| 26703f1df7dSJoe Perches __deprecated| 2686c72ffaaSAndy Whitcroft __read_mostly| 2696c72ffaaSAndy Whitcroft __kprobes| 2708716de38SJoe Perches $InitAttribute| 27124e1d81aSAndy Whitcroft ____cacheline_aligned| 27224e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2735fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2745fe3af11SAndy Whitcroft __weak 2756c72ffaaSAndy Whitcroft }x; 276c45dcabdSAndy Whitcroftour $Modifier; 2776c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2786c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2796c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2806c72ffaaSAndy Whitcroft 28195e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 28295e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 28395e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 28495e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 285326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 286326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 287326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 28874349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 28995e2c602SJoe Perchesour $Constant = qr{$Float|$Binary|$Hex|$Int}; 290326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 29186f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 29223f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 2936c72ffaaSAndy Whitcroftour $Operators = qr{ 2946c72ffaaSAndy Whitcroft <=|>=|==|!=| 2956c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 29623f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 2976c72ffaaSAndy Whitcroft }x; 2986c72ffaaSAndy Whitcroft 2998905a67cSAndy Whitcroftour $NonptrType; 3008716de38SJoe Perchesour $NonptrTypeWithAttr; 3018905a67cSAndy Whitcroftour $Type; 3028905a67cSAndy Whitcroftour $Declare; 3038905a67cSAndy Whitcroft 30415662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 30515662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 306171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 307171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 308171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 309171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 310171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 311171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 312171ae1a4SAndy Whitcroft}x; 313171ae1a4SAndy Whitcroft 31415662b3eSJoe Perchesour $UTF8 = qr{ 31515662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 31615662b3eSJoe Perches | $NON_ASCII_UTF8 31715662b3eSJoe Perches}x; 31815662b3eSJoe Perches 3198ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 320fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3218ed22cadSAndy Whitcroft atomic_t 3228ed22cadSAndy Whitcroft)}; 3238ed22cadSAndy Whitcroft 324691e669bSJoe Perchesour $logFunctions = qr{(?x: 3256e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3267d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3276e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 328b0531722SJoe Perches panic| 32906668727SJoe Perches MODULE_[A-Z_]+| 33006668727SJoe Perches seq_vprintf|seq_printf|seq_puts 331691e669bSJoe Perches)}; 332691e669bSJoe Perches 33320112475SJoe Perchesour $signature_tags = qr{(?xi: 33420112475SJoe Perches Signed-off-by:| 33520112475SJoe Perches Acked-by:| 33620112475SJoe Perches Tested-by:| 33720112475SJoe Perches Reviewed-by:| 33820112475SJoe Perches Reported-by:| 3398543ae12SMugunthan V N Suggested-by:| 34020112475SJoe Perches To:| 34120112475SJoe Perches Cc: 34220112475SJoe Perches)}; 34320112475SJoe Perches 3448905a67cSAndy Whitcroftour @typeList = ( 3458905a67cSAndy Whitcroft qr{void}, 346c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 347c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 348c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 349c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 350c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 351c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 352c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3538905a67cSAndy Whitcroft qr{unsigned}, 3548905a67cSAndy Whitcroft qr{float}, 3558905a67cSAndy Whitcroft qr{double}, 3568905a67cSAndy Whitcroft qr{bool}, 3578905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3588905a67cSAndy Whitcroft qr{union\s+$Ident}, 3598905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3608905a67cSAndy Whitcroft qr{${Ident}_t}, 3618905a67cSAndy Whitcroft qr{${Ident}_handler}, 3628905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3638905a67cSAndy Whitcroft); 3648716de38SJoe Perchesour @typeListWithAttr = ( 3658716de38SJoe Perches @typeList, 3668716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 3678716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 3688716de38SJoe Perches); 3698716de38SJoe Perches 370c45dcabdSAndy Whitcroftour @modifierList = ( 371c45dcabdSAndy Whitcroft qr{fastcall}, 372c45dcabdSAndy Whitcroft); 3738905a67cSAndy Whitcroft 3747840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3757840a94cSWolfram Sang irq| 3767840a94cSWolfram Sang memory 3777840a94cSWolfram Sang)}; 3787840a94cSWolfram Sang# memory.h: ARM has a custom one 3797840a94cSWolfram Sang 3808905a67cSAndy Whitcroftsub build_types { 381d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 382d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 3838716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 384c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3858905a67cSAndy Whitcroft $NonptrType = qr{ 386d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 387cf655043SAndy Whitcroft (?: 3886b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 3898ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 390c45dcabdSAndy Whitcroft (?:${all}\b) 391cf655043SAndy Whitcroft ) 392c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 3938905a67cSAndy Whitcroft }x; 3948716de38SJoe Perches $NonptrTypeWithAttr = qr{ 3958716de38SJoe Perches (?:$Modifier\s+|const\s+)* 3968716de38SJoe Perches (?: 3978716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 3988716de38SJoe Perches (?:$typeTypedefs\b)| 3998716de38SJoe Perches (?:${allWithAttr}\b) 4008716de38SJoe Perches ) 4018716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4028716de38SJoe Perches }x; 4038905a67cSAndy Whitcroft $Type = qr{ 404c45dcabdSAndy Whitcroft $NonptrType 405b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 406c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 4078905a67cSAndy Whitcroft }x; 4088905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 4098905a67cSAndy Whitcroft} 4108905a67cSAndy Whitcroftbuild_types(); 4116c72ffaaSAndy Whitcroft 4127d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 413d1fe9c09SJoe Perches 414d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 415d1fe9c09SJoe Perches# requires at least perl version v5.10.0 416d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 417d1fe9c09SJoe Perches 418d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 419d1fe9c09SJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; 420d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 4217d2367afSJoe Perches 4227d2367afSJoe Perchessub deparenthesize { 4237d2367afSJoe Perches my ($string) = @_; 4247d2367afSJoe Perches return "" if (!defined($string)); 4257d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 4267d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 4277d2367afSJoe Perches $string =~ s@\s+@ @g; 4287d2367afSJoe Perches return $string; 4297d2367afSJoe Perches} 4307d2367afSJoe Perches 4313445686aSJoe Perchessub seed_camelcase_file { 4323445686aSJoe Perches my ($file) = @_; 4333445686aSJoe Perches 4343445686aSJoe Perches return if (!(-f $file)); 4353445686aSJoe Perches 4363445686aSJoe Perches local $/; 4373445686aSJoe Perches 4383445686aSJoe Perches open(my $include_file, '<', "$file") 4393445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4403445686aSJoe Perches my $text = <$include_file>; 4413445686aSJoe Perches close($include_file); 4423445686aSJoe Perches 4433445686aSJoe Perches my @lines = split('\n', $text); 4443445686aSJoe Perches 4453445686aSJoe Perches foreach my $line (@lines) { 4463445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4473445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4483445686aSJoe Perches $camelcase{$1} = 1; 44911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 45011ea516aSJoe Perches $camelcase{$1} = 1; 45111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 4523445686aSJoe Perches $camelcase{$1} = 1; 4533445686aSJoe Perches } 4543445686aSJoe Perches } 4553445686aSJoe Perches} 4563445686aSJoe Perches 4573445686aSJoe Perchesmy $camelcase_seeded = 0; 4583445686aSJoe Perchessub seed_camelcase_includes { 4593445686aSJoe Perches return if ($camelcase_seeded); 4603445686aSJoe Perches 4613445686aSJoe Perches my $files; 462c707a81dSJoe Perches my $camelcase_cache = ""; 463c707a81dSJoe Perches my @include_files = (); 464c707a81dSJoe Perches 465c707a81dSJoe Perches $camelcase_seeded = 1; 466351b2a1fSJoe Perches 4673445686aSJoe Perches if (-d ".git") { 468351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 469351b2a1fSJoe Perches chomp $git_last_include_commit; 470c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 471c707a81dSJoe Perches } else { 472c707a81dSJoe Perches my $last_mod_date = 0; 473c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 474c707a81dSJoe Perches @include_files = split('\n', $files); 475c707a81dSJoe Perches foreach my $file (@include_files) { 476c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 477c707a81dSJoe Perches localtime((stat $file)[9])); 478c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 479c707a81dSJoe Perches } 480c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 481c707a81dSJoe Perches } 482c707a81dSJoe Perches 483c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 484c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 485c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 486351b2a1fSJoe Perches while (<$camelcase_file>) { 487351b2a1fSJoe Perches chomp; 488351b2a1fSJoe Perches $camelcase{$_} = 1; 489351b2a1fSJoe Perches } 490351b2a1fSJoe Perches close($camelcase_file); 491351b2a1fSJoe Perches 492351b2a1fSJoe Perches return; 493351b2a1fSJoe Perches } 494c707a81dSJoe Perches 495c707a81dSJoe Perches if (-d ".git") { 496c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 497c707a81dSJoe Perches @include_files = split('\n', $files); 4983445686aSJoe Perches } 499c707a81dSJoe Perches 5003445686aSJoe Perches foreach my $file (@include_files) { 5013445686aSJoe Perches seed_camelcase_file($file); 5023445686aSJoe Perches } 503351b2a1fSJoe Perches 504c707a81dSJoe Perches if ($camelcase_cache ne "") { 505351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 506c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 507c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 508351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 509351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 510351b2a1fSJoe Perches } 511351b2a1fSJoe Perches close($camelcase_file); 512351b2a1fSJoe Perches } 5133445686aSJoe Perches} 5143445686aSJoe Perches 5156c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5160a920b5bSAndy Whitcroft 51700df344fSAndy Whitcroftmy @rawlines = (); 518c2fdda0dSAndy Whitcroftmy @lines = (); 5193705ce5bSJoe Perchesmy @fixed = (); 520c2fdda0dSAndy Whitcroftmy $vname; 5216c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 52221caa13cSAndy Whitcroft my $FILE; 5236c72ffaaSAndy Whitcroft if ($file) { 52421caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5256c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 52621caa13cSAndy Whitcroft } elsif ($filename eq '-') { 52721caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5286c72ffaaSAndy Whitcroft } else { 52921caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5306c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5316c72ffaaSAndy Whitcroft } 532c2fdda0dSAndy Whitcroft if ($filename eq '-') { 533c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 534c2fdda0dSAndy Whitcroft } else { 535c2fdda0dSAndy Whitcroft $vname = $filename; 536c2fdda0dSAndy Whitcroft } 53721caa13cSAndy Whitcroft while (<$FILE>) { 5380a920b5bSAndy Whitcroft chomp; 53900df344fSAndy Whitcroft push(@rawlines, $_); 5406c72ffaaSAndy Whitcroft } 54121caa13cSAndy Whitcroft close($FILE); 542c2fdda0dSAndy Whitcroft if (!process($filename)) { 5430a920b5bSAndy Whitcroft $exit = 1; 5440a920b5bSAndy Whitcroft } 54500df344fSAndy Whitcroft @rawlines = (); 54613214adfSAndy Whitcroft @lines = (); 5473705ce5bSJoe Perches @fixed = (); 5480a920b5bSAndy Whitcroft} 5490a920b5bSAndy Whitcroft 5500a920b5bSAndy Whitcroftexit($exit); 5510a920b5bSAndy Whitcroft 5520a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5536c72ffaaSAndy Whitcroft my ($root) = @_; 5546c72ffaaSAndy Whitcroft 5556c72ffaaSAndy Whitcroft my @tree_check = ( 5566c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5576c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5586c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5596c72ffaaSAndy Whitcroft ); 5606c72ffaaSAndy Whitcroft 5616c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 5626c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 5630a920b5bSAndy Whitcroft return 0; 5640a920b5bSAndy Whitcroft } 5656c72ffaaSAndy Whitcroft } 5666c72ffaaSAndy Whitcroft return 1; 5676c72ffaaSAndy Whitcroft} 5680a920b5bSAndy Whitcroft 56920112475SJoe Perchessub parse_email { 57020112475SJoe Perches my ($formatted_email) = @_; 57120112475SJoe Perches 57220112475SJoe Perches my $name = ""; 57320112475SJoe Perches my $address = ""; 57420112475SJoe Perches my $comment = ""; 57520112475SJoe Perches 57620112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 57720112475SJoe Perches $name = $1; 57820112475SJoe Perches $address = $2; 57920112475SJoe Perches $comment = $3 if defined $3; 58020112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 58120112475SJoe Perches $address = $1; 58220112475SJoe Perches $comment = $2 if defined $2; 58320112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 58420112475SJoe Perches $address = $1; 58520112475SJoe Perches $comment = $2 if defined $2; 58620112475SJoe Perches $formatted_email =~ s/$address.*$//; 58720112475SJoe Perches $name = $formatted_email; 5883705ce5bSJoe Perches $name = trim($name); 58920112475SJoe Perches $name =~ s/^\"|\"$//g; 59020112475SJoe Perches # If there's a name left after stripping spaces and 59120112475SJoe Perches # leading quotes, and the address doesn't have both 59220112475SJoe Perches # leading and trailing angle brackets, the address 59320112475SJoe Perches # is invalid. ie: 59420112475SJoe Perches # "joe smith [email protected]" bad 59520112475SJoe Perches # "joe smith <[email protected]" bad 59620112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 59720112475SJoe Perches $name = ""; 59820112475SJoe Perches $address = ""; 59920112475SJoe Perches $comment = ""; 60020112475SJoe Perches } 60120112475SJoe Perches } 60220112475SJoe Perches 6033705ce5bSJoe Perches $name = trim($name); 60420112475SJoe Perches $name =~ s/^\"|\"$//g; 6053705ce5bSJoe Perches $address = trim($address); 60620112475SJoe Perches $address =~ s/^\<|\>$//g; 60720112475SJoe Perches 60820112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 60920112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 61020112475SJoe Perches $name = "\"$name\""; 61120112475SJoe Perches } 61220112475SJoe Perches 61320112475SJoe Perches return ($name, $address, $comment); 61420112475SJoe Perches} 61520112475SJoe Perches 61620112475SJoe Perchessub format_email { 61720112475SJoe Perches my ($name, $address) = @_; 61820112475SJoe Perches 61920112475SJoe Perches my $formatted_email; 62020112475SJoe Perches 6213705ce5bSJoe Perches $name = trim($name); 62220112475SJoe Perches $name =~ s/^\"|\"$//g; 6233705ce5bSJoe Perches $address = trim($address); 62420112475SJoe Perches 62520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 62620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 62720112475SJoe Perches $name = "\"$name\""; 62820112475SJoe Perches } 62920112475SJoe Perches 63020112475SJoe Perches if ("$name" eq "") { 63120112475SJoe Perches $formatted_email = "$address"; 63220112475SJoe Perches } else { 63320112475SJoe Perches $formatted_email = "$name <$address>"; 63420112475SJoe Perches } 63520112475SJoe Perches 63620112475SJoe Perches return $formatted_email; 63720112475SJoe Perches} 63820112475SJoe Perches 639000d1cc1SJoe Perchessub which_conf { 640000d1cc1SJoe Perches my ($conf) = @_; 641000d1cc1SJoe Perches 642000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 643000d1cc1SJoe Perches if (-e "$path/$conf") { 644000d1cc1SJoe Perches return "$path/$conf"; 645000d1cc1SJoe Perches } 646000d1cc1SJoe Perches } 647000d1cc1SJoe Perches 648000d1cc1SJoe Perches return ""; 649000d1cc1SJoe Perches} 650000d1cc1SJoe Perches 6510a920b5bSAndy Whitcroftsub expand_tabs { 6520a920b5bSAndy Whitcroft my ($str) = @_; 6530a920b5bSAndy Whitcroft 6540a920b5bSAndy Whitcroft my $res = ''; 6550a920b5bSAndy Whitcroft my $n = 0; 6560a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6570a920b5bSAndy Whitcroft if ($c eq "\t") { 6580a920b5bSAndy Whitcroft $res .= ' '; 6590a920b5bSAndy Whitcroft $n++; 6600a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6610a920b5bSAndy Whitcroft $res .= ' '; 6620a920b5bSAndy Whitcroft } 6630a920b5bSAndy Whitcroft next; 6640a920b5bSAndy Whitcroft } 6650a920b5bSAndy Whitcroft $res .= $c; 6660a920b5bSAndy Whitcroft $n++; 6670a920b5bSAndy Whitcroft } 6680a920b5bSAndy Whitcroft 6690a920b5bSAndy Whitcroft return $res; 6700a920b5bSAndy Whitcroft} 6716c72ffaaSAndy Whitcroftsub copy_spacing { 672773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 6736c72ffaaSAndy Whitcroft return $res; 6746c72ffaaSAndy Whitcroft} 6750a920b5bSAndy Whitcroft 6764a0df2efSAndy Whitcroftsub line_stats { 6774a0df2efSAndy Whitcroft my ($line) = @_; 6784a0df2efSAndy Whitcroft 6794a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 6804a0df2efSAndy Whitcroft $line =~ s/^.//; 6814a0df2efSAndy Whitcroft $line = expand_tabs($line); 6824a0df2efSAndy Whitcroft 6834a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 6844a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 6854a0df2efSAndy Whitcroft 6864a0df2efSAndy Whitcroft return (length($line), length($white)); 6874a0df2efSAndy Whitcroft} 6884a0df2efSAndy Whitcroft 689773647a0SAndy Whitcroftmy $sanitise_quote = ''; 690773647a0SAndy Whitcroft 691773647a0SAndy Whitcroftsub sanitise_line_reset { 692773647a0SAndy Whitcroft my ($in_comment) = @_; 693773647a0SAndy Whitcroft 694773647a0SAndy Whitcroft if ($in_comment) { 695773647a0SAndy Whitcroft $sanitise_quote = '*/'; 696773647a0SAndy Whitcroft } else { 697773647a0SAndy Whitcroft $sanitise_quote = ''; 698773647a0SAndy Whitcroft } 699773647a0SAndy Whitcroft} 70000df344fSAndy Whitcroftsub sanitise_line { 70100df344fSAndy Whitcroft my ($line) = @_; 70200df344fSAndy Whitcroft 70300df344fSAndy Whitcroft my $res = ''; 70400df344fSAndy Whitcroft my $l = ''; 70500df344fSAndy Whitcroft 706c2fdda0dSAndy Whitcroft my $qlen = 0; 707773647a0SAndy Whitcroft my $off = 0; 708773647a0SAndy Whitcroft my $c; 70900df344fSAndy Whitcroft 710773647a0SAndy Whitcroft # Always copy over the diff marker. 711773647a0SAndy Whitcroft $res = substr($line, 0, 1); 712773647a0SAndy Whitcroft 713773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 714773647a0SAndy Whitcroft $c = substr($line, $off, 1); 715773647a0SAndy Whitcroft 716773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 717773647a0SAndy Whitcroft # and end, all to $;. 718773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 719773647a0SAndy Whitcroft $sanitise_quote = '*/'; 720773647a0SAndy Whitcroft 721773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 722773647a0SAndy Whitcroft $off++; 72300df344fSAndy Whitcroft next; 724773647a0SAndy Whitcroft } 72581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 726773647a0SAndy Whitcroft $sanitise_quote = ''; 727773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 728773647a0SAndy Whitcroft $off++; 729773647a0SAndy Whitcroft next; 730773647a0SAndy Whitcroft } 731113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 732113f04a8SDaniel Walker $sanitise_quote = '//'; 733113f04a8SDaniel Walker 734113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 735113f04a8SDaniel Walker $off++; 736113f04a8SDaniel Walker next; 737113f04a8SDaniel Walker } 738773647a0SAndy Whitcroft 739773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 740773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 741773647a0SAndy Whitcroft $c eq "\\") { 742773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 743773647a0SAndy Whitcroft $off++; 744773647a0SAndy Whitcroft next; 745773647a0SAndy Whitcroft } 746773647a0SAndy Whitcroft # Regular quotes. 747773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 748773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 749773647a0SAndy Whitcroft $sanitise_quote = $c; 750773647a0SAndy Whitcroft 751773647a0SAndy Whitcroft substr($res, $off, 1, $c); 752773647a0SAndy Whitcroft next; 753773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 754773647a0SAndy Whitcroft $sanitise_quote = ''; 75500df344fSAndy Whitcroft } 75600df344fSAndy Whitcroft } 757773647a0SAndy Whitcroft 758fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 759773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 760773647a0SAndy Whitcroft substr($res, $off, 1, $;); 761113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 762113f04a8SDaniel Walker substr($res, $off, 1, $;); 763773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 764773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 76500df344fSAndy Whitcroft } else { 766773647a0SAndy Whitcroft substr($res, $off, 1, $c); 76700df344fSAndy Whitcroft } 768c2fdda0dSAndy Whitcroft } 769c2fdda0dSAndy Whitcroft 770113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 771113f04a8SDaniel Walker $sanitise_quote = ''; 772113f04a8SDaniel Walker } 773113f04a8SDaniel Walker 774c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 775c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 776c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 777c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 778c2fdda0dSAndy Whitcroft 779c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 780c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 781c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 782c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 783c2fdda0dSAndy Whitcroft } 784c2fdda0dSAndy Whitcroft 78500df344fSAndy Whitcroft return $res; 78600df344fSAndy Whitcroft} 78700df344fSAndy Whitcroft 788a6962d72SJoe Perchessub get_quoted_string { 789a6962d72SJoe Perches my ($line, $rawline) = @_; 790a6962d72SJoe Perches 791a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 792a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 793a6962d72SJoe Perches} 794a6962d72SJoe Perches 7958905a67cSAndy Whitcroftsub ctx_statement_block { 7968905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 7978905a67cSAndy Whitcroft my $line = $linenr - 1; 7988905a67cSAndy Whitcroft my $blk = ''; 7998905a67cSAndy Whitcroft my $soff = $off; 8008905a67cSAndy Whitcroft my $coff = $off - 1; 801773647a0SAndy Whitcroft my $coff_set = 0; 8028905a67cSAndy Whitcroft 80313214adfSAndy Whitcroft my $loff = 0; 80413214adfSAndy Whitcroft 8058905a67cSAndy Whitcroft my $type = ''; 8068905a67cSAndy Whitcroft my $level = 0; 807a2750645SAndy Whitcroft my @stack = (); 808cf655043SAndy Whitcroft my $p; 8098905a67cSAndy Whitcroft my $c; 8108905a67cSAndy Whitcroft my $len = 0; 81113214adfSAndy Whitcroft 81213214adfSAndy Whitcroft my $remainder; 8138905a67cSAndy Whitcroft while (1) { 814a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 815a2750645SAndy Whitcroft 816773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8178905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8188905a67cSAndy Whitcroft # context. 8198905a67cSAndy Whitcroft if ($off >= $len) { 8208905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 821dea33496SAndy Whitcroft last if (!defined $lines[$line]); 822c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 8238905a67cSAndy Whitcroft $remain--; 82413214adfSAndy Whitcroft $loff = $len; 825c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8268905a67cSAndy Whitcroft $len = length($blk); 8278905a67cSAndy Whitcroft $line++; 8288905a67cSAndy Whitcroft last; 8298905a67cSAndy Whitcroft } 8308905a67cSAndy Whitcroft # Bail if there is no further context. 8318905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 83213214adfSAndy Whitcroft if ($off >= $len) { 8338905a67cSAndy Whitcroft last; 8348905a67cSAndy Whitcroft } 835f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 836f74bd194SAndy Whitcroft $level++; 837f74bd194SAndy Whitcroft $type = '#'; 838f74bd194SAndy Whitcroft } 8398905a67cSAndy Whitcroft } 840cf655043SAndy Whitcroft $p = $c; 8418905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 84213214adfSAndy Whitcroft $remainder = substr($blk, $off); 8438905a67cSAndy Whitcroft 844773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8454635f4fbSAndy Whitcroft 8464635f4fbSAndy Whitcroft # Handle nested #if/#else. 8474635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8484635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8494635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8504635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8514635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8524635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8534635f4fbSAndy Whitcroft } 8544635f4fbSAndy Whitcroft 8558905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8568905a67cSAndy Whitcroft # outermost level. 8578905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8588905a67cSAndy Whitcroft last; 8598905a67cSAndy Whitcroft } 8608905a67cSAndy Whitcroft 86113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 862773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 863773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 864773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 865773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 866773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 867773647a0SAndy Whitcroft $coff_set = 1; 868773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 869773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 87013214adfSAndy Whitcroft } 87113214adfSAndy Whitcroft 8728905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 8738905a67cSAndy Whitcroft $level++; 8748905a67cSAndy Whitcroft $type = '('; 8758905a67cSAndy Whitcroft } 8768905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 8778905a67cSAndy Whitcroft $level--; 8788905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 8798905a67cSAndy Whitcroft 8808905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 8818905a67cSAndy Whitcroft $coff = $off; 882773647a0SAndy Whitcroft $coff_set = 1; 883773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 8848905a67cSAndy Whitcroft } 8858905a67cSAndy Whitcroft } 8868905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 8878905a67cSAndy Whitcroft $level++; 8888905a67cSAndy Whitcroft $type = '{'; 8898905a67cSAndy Whitcroft } 8908905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 8918905a67cSAndy Whitcroft $level--; 8928905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 8938905a67cSAndy Whitcroft 8948905a67cSAndy Whitcroft if ($level == 0) { 895b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 896b998e001SPatrick Pannuto $off++; 897b998e001SPatrick Pannuto } 8988905a67cSAndy Whitcroft last; 8998905a67cSAndy Whitcroft } 9008905a67cSAndy Whitcroft } 901f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 902f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 903f74bd194SAndy Whitcroft $level--; 904f74bd194SAndy Whitcroft $type = ''; 905f74bd194SAndy Whitcroft $off++; 906f74bd194SAndy Whitcroft last; 907f74bd194SAndy Whitcroft } 9088905a67cSAndy Whitcroft $off++; 9098905a67cSAndy Whitcroft } 910a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 91113214adfSAndy Whitcroft if ($off == $len) { 912a3bb97a7SAndy Whitcroft $loff = $len + 1; 91313214adfSAndy Whitcroft $line++; 91413214adfSAndy Whitcroft $remain--; 91513214adfSAndy Whitcroft } 9168905a67cSAndy Whitcroft 9178905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9188905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 9198905a67cSAndy Whitcroft 9208905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 9218905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 9228905a67cSAndy Whitcroft 923773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 92413214adfSAndy Whitcroft 92513214adfSAndy Whitcroft return ($statement, $condition, 92613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 92713214adfSAndy Whitcroft} 92813214adfSAndy Whitcroft 929cf655043SAndy Whitcroftsub statement_lines { 930cf655043SAndy Whitcroft my ($stmt) = @_; 931cf655043SAndy Whitcroft 932cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 933cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 934cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 935cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 936cf655043SAndy Whitcroft 937cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 938cf655043SAndy Whitcroft 939cf655043SAndy Whitcroft return $#stmt_lines + 2; 940cf655043SAndy Whitcroft} 941cf655043SAndy Whitcroft 942cf655043SAndy Whitcroftsub statement_rawlines { 943cf655043SAndy Whitcroft my ($stmt) = @_; 944cf655043SAndy Whitcroft 945cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 946cf655043SAndy Whitcroft 947cf655043SAndy Whitcroft return $#stmt_lines + 2; 948cf655043SAndy Whitcroft} 949cf655043SAndy Whitcroft 950cf655043SAndy Whitcroftsub statement_block_size { 951cf655043SAndy Whitcroft my ($stmt) = @_; 952cf655043SAndy Whitcroft 953cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 954cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 955cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 956cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 957cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 958cf655043SAndy Whitcroft 959cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 960cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 961cf655043SAndy Whitcroft 962cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 963cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 964cf655043SAndy Whitcroft 965cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 966cf655043SAndy Whitcroft return $stmt_lines; 967cf655043SAndy Whitcroft } else { 968cf655043SAndy Whitcroft return $stmt_statements; 969cf655043SAndy Whitcroft } 970cf655043SAndy Whitcroft} 971cf655043SAndy Whitcroft 97213214adfSAndy Whitcroftsub ctx_statement_full { 97313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 97413214adfSAndy Whitcroft my ($statement, $condition, $level); 97513214adfSAndy Whitcroft 97613214adfSAndy Whitcroft my (@chunks); 97713214adfSAndy Whitcroft 978cf655043SAndy Whitcroft # Grab the first conditional/block pair. 97913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 98013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 981773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 98213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 983cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 984cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 985cf655043SAndy Whitcroft } 986cf655043SAndy Whitcroft 987cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 988cf655043SAndy Whitcroft # could continue the statement. 989cf655043SAndy Whitcroft for (;;) { 99013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 99113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 992cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 993773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 994cf655043SAndy Whitcroft #print "C: push\n"; 995cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 99613214adfSAndy Whitcroft } 99713214adfSAndy Whitcroft 99813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 9998905a67cSAndy Whitcroft} 10008905a67cSAndy Whitcroft 10014a0df2efSAndy Whitcroftsub ctx_block_get { 1002f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10034a0df2efSAndy Whitcroft my $line; 10044a0df2efSAndy Whitcroft my $start = $linenr - 1; 10054a0df2efSAndy Whitcroft my $blk = ''; 10064a0df2efSAndy Whitcroft my @o; 10074a0df2efSAndy Whitcroft my @c; 10084a0df2efSAndy Whitcroft my @res = (); 10094a0df2efSAndy Whitcroft 1010f0a594c1SAndy Whitcroft my $level = 0; 10114635f4fbSAndy Whitcroft my @stack = ($level); 101200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 101300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 101400df344fSAndy Whitcroft $remain--; 101500df344fSAndy Whitcroft 101600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10174635f4fbSAndy Whitcroft 10184635f4fbSAndy Whitcroft # Handle nested #if/#else. 101901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 10204635f4fbSAndy Whitcroft push(@stack, $level); 102101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 10224635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 102301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10244635f4fbSAndy Whitcroft $level = pop(@stack); 10254635f4fbSAndy Whitcroft } 10264635f4fbSAndy Whitcroft 102701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1028f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1029f0a594c1SAndy Whitcroft if ($off > 0) { 1030f0a594c1SAndy Whitcroft $off--; 1031f0a594c1SAndy Whitcroft next; 1032f0a594c1SAndy Whitcroft } 10334a0df2efSAndy Whitcroft 1034f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1035f0a594c1SAndy Whitcroft $level--; 1036f0a594c1SAndy Whitcroft last if ($level == 0); 1037f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1038f0a594c1SAndy Whitcroft $level++; 1039f0a594c1SAndy Whitcroft } 1040f0a594c1SAndy Whitcroft } 10414a0df2efSAndy Whitcroft 1042f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 104300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10444a0df2efSAndy Whitcroft } 10454a0df2efSAndy Whitcroft 1046f0a594c1SAndy Whitcroft last if ($level == 0); 10474a0df2efSAndy Whitcroft } 10484a0df2efSAndy Whitcroft 1049f0a594c1SAndy Whitcroft return ($level, @res); 10504a0df2efSAndy Whitcroft} 10514a0df2efSAndy Whitcroftsub ctx_block_outer { 10524a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10534a0df2efSAndy Whitcroft 1054f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1055f0a594c1SAndy Whitcroft return @r; 10564a0df2efSAndy Whitcroft} 10574a0df2efSAndy Whitcroftsub ctx_block { 10584a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10594a0df2efSAndy Whitcroft 1060f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1061f0a594c1SAndy Whitcroft return @r; 1062653d4876SAndy Whitcroft} 1063653d4876SAndy Whitcroftsub ctx_statement { 1064f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1065f0a594c1SAndy Whitcroft 1066f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1067f0a594c1SAndy Whitcroft return @r; 1068f0a594c1SAndy Whitcroft} 1069f0a594c1SAndy Whitcroftsub ctx_block_level { 1070653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1071653d4876SAndy Whitcroft 1072f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 10734a0df2efSAndy Whitcroft} 10749c0ca6f9SAndy Whitcroftsub ctx_statement_level { 10759c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 10769c0ca6f9SAndy Whitcroft 10779c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 10789c0ca6f9SAndy Whitcroft} 10794a0df2efSAndy Whitcroft 10804a0df2efSAndy Whitcroftsub ctx_locate_comment { 10814a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 10824a0df2efSAndy Whitcroft 10834a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1084beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 10854a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 10864a0df2efSAndy Whitcroft 10874a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 10884a0df2efSAndy Whitcroft # comment. 10894a0df2efSAndy Whitcroft my $in_comment = 0; 10904a0df2efSAndy Whitcroft $current_comment = ''; 10914a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 109200df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 109300df344fSAndy Whitcroft #warn " $line\n"; 10944a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 10954a0df2efSAndy Whitcroft $in_comment = 1; 10964a0df2efSAndy Whitcroft } 10974a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 10984a0df2efSAndy Whitcroft $in_comment = 1; 10994a0df2efSAndy Whitcroft } 11004a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11014a0df2efSAndy Whitcroft $current_comment = ''; 11024a0df2efSAndy Whitcroft } 11034a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11044a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11054a0df2efSAndy Whitcroft $in_comment = 0; 11064a0df2efSAndy Whitcroft } 11074a0df2efSAndy Whitcroft } 11084a0df2efSAndy Whitcroft 11094a0df2efSAndy Whitcroft chomp($current_comment); 11104a0df2efSAndy Whitcroft return($current_comment); 11114a0df2efSAndy Whitcroft} 11124a0df2efSAndy Whitcroftsub ctx_has_comment { 11134a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11144a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11154a0df2efSAndy Whitcroft 111600df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11174a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11184a0df2efSAndy Whitcroft 11194a0df2efSAndy Whitcroft return ($cmt ne ''); 11204a0df2efSAndy Whitcroft} 11214a0df2efSAndy Whitcroft 11224d001e4dSAndy Whitcroftsub raw_line { 11234d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11244d001e4dSAndy Whitcroft 11254d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11264d001e4dSAndy Whitcroft $cnt++; 11274d001e4dSAndy Whitcroft 11284d001e4dSAndy Whitcroft my $line; 11294d001e4dSAndy Whitcroft while ($cnt) { 11304d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11314d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11324d001e4dSAndy Whitcroft $cnt--; 11334d001e4dSAndy Whitcroft } 11344d001e4dSAndy Whitcroft 11354d001e4dSAndy Whitcroft return $line; 11364d001e4dSAndy Whitcroft} 11374d001e4dSAndy Whitcroft 11380a920b5bSAndy Whitcroftsub cat_vet { 11390a920b5bSAndy Whitcroft my ($vet) = @_; 11409c0ca6f9SAndy Whitcroft my ($res, $coded); 11410a920b5bSAndy Whitcroft 11429c0ca6f9SAndy Whitcroft $res = ''; 11436c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11446c72ffaaSAndy Whitcroft $res .= $1; 11456c72ffaaSAndy Whitcroft if ($2 ne '') { 11469c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11476c72ffaaSAndy Whitcroft $res .= $coded; 11486c72ffaaSAndy Whitcroft } 11499c0ca6f9SAndy Whitcroft } 11509c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11510a920b5bSAndy Whitcroft 11529c0ca6f9SAndy Whitcroft return $res; 11530a920b5bSAndy Whitcroft} 11540a920b5bSAndy Whitcroft 1155c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1156cf655043SAndy Whitcroftmy $av_pending; 1157c2fdda0dSAndy Whitcroftmy @av_paren_type; 11581f65f947SAndy Whitcroftmy $av_pend_colon; 1159c2fdda0dSAndy Whitcroft 1160c2fdda0dSAndy Whitcroftsub annotate_reset { 1161c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1162cf655043SAndy Whitcroft $av_pending = '_'; 1163cf655043SAndy Whitcroft @av_paren_type = ('E'); 11641f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1165c2fdda0dSAndy Whitcroft} 1166c2fdda0dSAndy Whitcroft 11676c72ffaaSAndy Whitcroftsub annotate_values { 11686c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 11696c72ffaaSAndy Whitcroft 11706c72ffaaSAndy Whitcroft my $res; 11711f65f947SAndy Whitcroft my $var = '_' x length($stream); 11726c72ffaaSAndy Whitcroft my $cur = $stream; 11736c72ffaaSAndy Whitcroft 1174c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 11756c72ffaaSAndy Whitcroft 11766c72ffaaSAndy Whitcroft while (length($cur)) { 1177773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1178cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1179171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 11806c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1181c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1182c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1183cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1184c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 11856c72ffaaSAndy Whitcroft } 11866c72ffaaSAndy Whitcroft 1187c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 11889446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 11899446ef56SAndy Whitcroft push(@av_paren_type, $type); 1190addcdceaSAndy Whitcroft $type = 'c'; 11919446ef56SAndy Whitcroft 1192e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1193c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 11946c72ffaaSAndy Whitcroft $type = 'T'; 11956c72ffaaSAndy Whitcroft 1196389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1197389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1198389a2fe5SAndy Whitcroft $type = 'T'; 1199389a2fe5SAndy Whitcroft 1200c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1201171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1202c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1203171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1204171ae1a4SAndy Whitcroft if ($2 ne '') { 1205cf655043SAndy Whitcroft $av_pending = 'N'; 1206171ae1a4SAndy Whitcroft } 1207171ae1a4SAndy Whitcroft $type = 'E'; 1208171ae1a4SAndy Whitcroft 1209c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1210171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1211171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1212171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12136c72ffaaSAndy Whitcroft 1214c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1215cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1216c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1217cf655043SAndy Whitcroft 1218cf655043SAndy Whitcroft push(@av_paren_type, $type); 1219cf655043SAndy Whitcroft push(@av_paren_type, $type); 1220171ae1a4SAndy Whitcroft $type = 'E'; 1221cf655043SAndy Whitcroft 1222c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1223cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1224cf655043SAndy Whitcroft $av_preprocessor = 1; 1225cf655043SAndy Whitcroft 1226cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1227cf655043SAndy Whitcroft 1228171ae1a4SAndy Whitcroft $type = 'E'; 1229cf655043SAndy Whitcroft 1230c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1231cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1232cf655043SAndy Whitcroft 1233cf655043SAndy Whitcroft $av_preprocessor = 1; 1234cf655043SAndy Whitcroft 1235cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1236cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1237cf655043SAndy Whitcroft pop(@av_paren_type); 1238cf655043SAndy Whitcroft push(@av_paren_type, $type); 1239171ae1a4SAndy Whitcroft $type = 'E'; 12406c72ffaaSAndy Whitcroft 12416c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1242c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12436c72ffaaSAndy Whitcroft 1244171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1245171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1246171ae1a4SAndy Whitcroft $av_pending = $type; 1247171ae1a4SAndy Whitcroft $type = 'N'; 1248171ae1a4SAndy Whitcroft 12496c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1250c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12516c72ffaaSAndy Whitcroft if (defined $2) { 1252cf655043SAndy Whitcroft $av_pending = 'V'; 12536c72ffaaSAndy Whitcroft } 12546c72ffaaSAndy Whitcroft $type = 'N'; 12556c72ffaaSAndy Whitcroft 125614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1257c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 125814b111c1SAndy Whitcroft $av_pending = 'E'; 12596c72ffaaSAndy Whitcroft $type = 'N'; 12606c72ffaaSAndy Whitcroft 12611f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 12621f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 12631f65f947SAndy Whitcroft $av_pend_colon = 'C'; 12641f65f947SAndy Whitcroft $type = 'N'; 12651f65f947SAndy Whitcroft 126614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1267c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 12686c72ffaaSAndy Whitcroft $type = 'N'; 12696c72ffaaSAndy Whitcroft 12706c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1271c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1272cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1273cf655043SAndy Whitcroft $av_pending = '_'; 12746c72ffaaSAndy Whitcroft $type = 'N'; 12756c72ffaaSAndy Whitcroft 12766c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1277cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1278cf655043SAndy Whitcroft if ($new_type ne '_') { 1279cf655043SAndy Whitcroft $type = $new_type; 1280c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1281c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 12826c72ffaaSAndy Whitcroft } else { 1283c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 12846c72ffaaSAndy Whitcroft } 12856c72ffaaSAndy Whitcroft 1286c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1287c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1288c8cb2ca3SAndy Whitcroft $type = 'V'; 1289cf655043SAndy Whitcroft $av_pending = 'V'; 12906c72ffaaSAndy Whitcroft 12918e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 12928e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 12931f65f947SAndy Whitcroft $av_pend_colon = 'B'; 12948e761b04SAndy Whitcroft } elsif ($type eq 'E') { 12958e761b04SAndy Whitcroft $av_pend_colon = 'L'; 12961f65f947SAndy Whitcroft } 12971f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 12981f65f947SAndy Whitcroft $type = 'V'; 12991f65f947SAndy Whitcroft 13006c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1301c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13026c72ffaaSAndy Whitcroft $type = 'V'; 13036c72ffaaSAndy Whitcroft 13046c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1305c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13066c72ffaaSAndy Whitcroft $type = 'N'; 13076c72ffaaSAndy Whitcroft 1308cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1309c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 131013214adfSAndy Whitcroft $type = 'E'; 13111f65f947SAndy Whitcroft $av_pend_colon = 'O'; 131213214adfSAndy Whitcroft 13138e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13148e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13158e761b04SAndy Whitcroft $type = 'C'; 13168e761b04SAndy Whitcroft 13171f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13181f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 13191f65f947SAndy Whitcroft $type = 'N'; 13201f65f947SAndy Whitcroft 13211f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 13221f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 13231f65f947SAndy Whitcroft 13241f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13251f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13261f65f947SAndy Whitcroft $type = 'E'; 13271f65f947SAndy Whitcroft } else { 13281f65f947SAndy Whitcroft $type = 'N'; 13291f65f947SAndy Whitcroft } 13301f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13311f65f947SAndy Whitcroft 13328e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 133313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13346c72ffaaSAndy Whitcroft $type = 'N'; 13356c72ffaaSAndy Whitcroft 13360d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 133774048ed8SAndy Whitcroft my $variant; 133874048ed8SAndy Whitcroft 133974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 134074048ed8SAndy Whitcroft if ($type eq 'V') { 134174048ed8SAndy Whitcroft $variant = 'B'; 134274048ed8SAndy Whitcroft } else { 134374048ed8SAndy Whitcroft $variant = 'U'; 134474048ed8SAndy Whitcroft } 134574048ed8SAndy Whitcroft 134674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 134774048ed8SAndy Whitcroft $type = 'N'; 134874048ed8SAndy Whitcroft 13496c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1350c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13516c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13526c72ffaaSAndy Whitcroft $type = 'N'; 13536c72ffaaSAndy Whitcroft } 13546c72ffaaSAndy Whitcroft 13556c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1356c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13576c72ffaaSAndy Whitcroft } 13586c72ffaaSAndy Whitcroft if (defined $1) { 13596c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13606c72ffaaSAndy Whitcroft $res .= $type x length($1); 13616c72ffaaSAndy Whitcroft } 13626c72ffaaSAndy Whitcroft } 13636c72ffaaSAndy Whitcroft 13641f65f947SAndy Whitcroft return ($res, $var); 13656c72ffaaSAndy Whitcroft} 13666c72ffaaSAndy Whitcroft 13678905a67cSAndy Whitcroftsub possible { 136813214adfSAndy Whitcroft my ($possible, $line) = @_; 13699a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 13700776e594SAndy Whitcroft ^(?: 13710776e594SAndy Whitcroft $Modifier| 13720776e594SAndy Whitcroft $Storage| 13730776e594SAndy Whitcroft $Type| 13749a974fdbSAndy Whitcroft DEFINE_\S+ 13759a974fdbSAndy Whitcroft )$| 13769a974fdbSAndy Whitcroft ^(?: 13770776e594SAndy Whitcroft goto| 13780776e594SAndy Whitcroft return| 13790776e594SAndy Whitcroft case| 13800776e594SAndy Whitcroft else| 13810776e594SAndy Whitcroft asm|__asm__| 138289a88353SAndy Whitcroft do| 138389a88353SAndy Whitcroft \#| 138489a88353SAndy Whitcroft \#\#| 13859a974fdbSAndy Whitcroft )(?:\s|$)| 13860776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 13879a974fdbSAndy Whitcroft )}x; 13889a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 13899a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1390c45dcabdSAndy Whitcroft # Check for modifiers. 1391c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1392c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1393c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1394c45dcabdSAndy Whitcroft 1395c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1396c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1397d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 13989a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1399d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1400d2506586SAndy Whitcroft push(@modifierList, $modifier); 1401d2506586SAndy Whitcroft } 14029a974fdbSAndy Whitcroft } 1403c45dcabdSAndy Whitcroft 1404c45dcabdSAndy Whitcroft } else { 140513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14068905a67cSAndy Whitcroft push(@typeList, $possible); 1407c45dcabdSAndy Whitcroft } 14088905a67cSAndy Whitcroft build_types(); 14090776e594SAndy Whitcroft } else { 14100776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14118905a67cSAndy Whitcroft } 14128905a67cSAndy Whitcroft} 14138905a67cSAndy Whitcroft 14146c72ffaaSAndy Whitcroftmy $prefix = ''; 14156c72ffaaSAndy Whitcroft 1416000d1cc1SJoe Perchessub show_type { 141791bfe484SJoe Perches return defined $use_type{$_[0]} if (scalar keys %use_type > 0); 141891bfe484SJoe Perches 1419000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1420000d1cc1SJoe Perches} 1421000d1cc1SJoe Perches 1422f0a594c1SAndy Whitcroftsub report { 1423000d1cc1SJoe Perches if (!show_type($_[1]) || 1424000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1425773647a0SAndy Whitcroft return 0; 1426773647a0SAndy Whitcroft } 1427000d1cc1SJoe Perches my $line; 1428000d1cc1SJoe Perches if ($show_types) { 1429000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1430000d1cc1SJoe Perches } else { 1431000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1432000d1cc1SJoe Perches } 14338905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14348905a67cSAndy Whitcroft 143513214adfSAndy Whitcroft push(our @report, $line); 1436773647a0SAndy Whitcroft 1437773647a0SAndy Whitcroft return 1; 1438f0a594c1SAndy Whitcroft} 1439f0a594c1SAndy Whitcroftsub report_dump { 144013214adfSAndy Whitcroft our @report; 1441f0a594c1SAndy Whitcroft} 1442000d1cc1SJoe Perches 1443de7d4f0eSAndy Whitcroftsub ERROR { 1444000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1445de7d4f0eSAndy Whitcroft our $clean = 0; 14466c72ffaaSAndy Whitcroft our $cnt_error++; 14473705ce5bSJoe Perches return 1; 1448de7d4f0eSAndy Whitcroft } 14493705ce5bSJoe Perches return 0; 1450773647a0SAndy Whitcroft} 1451de7d4f0eSAndy Whitcroftsub WARN { 1452000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1453de7d4f0eSAndy Whitcroft our $clean = 0; 14546c72ffaaSAndy Whitcroft our $cnt_warn++; 14553705ce5bSJoe Perches return 1; 1456de7d4f0eSAndy Whitcroft } 14573705ce5bSJoe Perches return 0; 1458773647a0SAndy Whitcroft} 1459de7d4f0eSAndy Whitcroftsub CHK { 1460000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1461de7d4f0eSAndy Whitcroft our $clean = 0; 14626c72ffaaSAndy Whitcroft our $cnt_chk++; 14633705ce5bSJoe Perches return 1; 14646c72ffaaSAndy Whitcroft } 14653705ce5bSJoe Perches return 0; 1466de7d4f0eSAndy Whitcroft} 1467de7d4f0eSAndy Whitcroft 14686ecd9674SAndy Whitcroftsub check_absolute_file { 14696ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 14706ecd9674SAndy Whitcroft my $file = $absolute; 14716ecd9674SAndy Whitcroft 14726ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 14736ecd9674SAndy Whitcroft 14746ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 14756ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 14766ecd9674SAndy Whitcroft if (-f "$root/$file") { 14776ecd9674SAndy Whitcroft ##print "file<$file>\n"; 14786ecd9674SAndy Whitcroft last; 14796ecd9674SAndy Whitcroft } 14806ecd9674SAndy Whitcroft } 14816ecd9674SAndy Whitcroft if (! -f _) { 14826ecd9674SAndy Whitcroft return 0; 14836ecd9674SAndy Whitcroft } 14846ecd9674SAndy Whitcroft 14856ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 14866ecd9674SAndy Whitcroft my $prefix = $absolute; 14876ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 14886ecd9674SAndy Whitcroft 14896ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 14906ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1491000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1492000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 14936ecd9674SAndy Whitcroft } 14946ecd9674SAndy Whitcroft} 14956ecd9674SAndy Whitcroft 14963705ce5bSJoe Perchessub trim { 14973705ce5bSJoe Perches my ($string) = @_; 14983705ce5bSJoe Perches 1499b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1500b34c648bSJoe Perches 1501b34c648bSJoe Perches return $string; 1502b34c648bSJoe Perches} 1503b34c648bSJoe Perches 1504b34c648bSJoe Perchessub ltrim { 1505b34c648bSJoe Perches my ($string) = @_; 1506b34c648bSJoe Perches 1507b34c648bSJoe Perches $string =~ s/^\s+//; 1508b34c648bSJoe Perches 1509b34c648bSJoe Perches return $string; 1510b34c648bSJoe Perches} 1511b34c648bSJoe Perches 1512b34c648bSJoe Perchessub rtrim { 1513b34c648bSJoe Perches my ($string) = @_; 1514b34c648bSJoe Perches 1515b34c648bSJoe Perches $string =~ s/\s+$//; 15163705ce5bSJoe Perches 15173705ce5bSJoe Perches return $string; 15183705ce5bSJoe Perches} 15193705ce5bSJoe Perches 152052ea8506SJoe Perchessub string_find_replace { 152152ea8506SJoe Perches my ($string, $find, $replace) = @_; 152252ea8506SJoe Perches 152352ea8506SJoe Perches $string =~ s/$find/$replace/g; 152452ea8506SJoe Perches 152552ea8506SJoe Perches return $string; 152652ea8506SJoe Perches} 152752ea8506SJoe Perches 15283705ce5bSJoe Perchessub tabify { 15293705ce5bSJoe Perches my ($leading) = @_; 15303705ce5bSJoe Perches 15313705ce5bSJoe Perches my $source_indent = 8; 15323705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 15333705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 15343705ce5bSJoe Perches 15353705ce5bSJoe Perches #convert leading spaces to tabs 15363705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 15373705ce5bSJoe Perches #Remove spaces before a tab 15383705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 15393705ce5bSJoe Perches 15403705ce5bSJoe Perches return "$leading"; 15413705ce5bSJoe Perches} 15423705ce5bSJoe Perches 1543d1fe9c09SJoe Perchessub pos_last_openparen { 1544d1fe9c09SJoe Perches my ($line) = @_; 1545d1fe9c09SJoe Perches 1546d1fe9c09SJoe Perches my $pos = 0; 1547d1fe9c09SJoe Perches 1548d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1549d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1550d1fe9c09SJoe Perches 1551d1fe9c09SJoe Perches my $last_openparen = 0; 1552d1fe9c09SJoe Perches 1553d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1554d1fe9c09SJoe Perches return -1; 1555d1fe9c09SJoe Perches } 1556d1fe9c09SJoe Perches 1557d1fe9c09SJoe Perches my $len = length($line); 1558d1fe9c09SJoe Perches 1559d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1560d1fe9c09SJoe Perches my $string = substr($line, $pos); 1561d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1562d1fe9c09SJoe Perches $pos += length($1) - 1; 1563d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1564d1fe9c09SJoe Perches $last_openparen = $pos; 1565d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1566d1fe9c09SJoe Perches last; 1567d1fe9c09SJoe Perches } 1568d1fe9c09SJoe Perches } 1569d1fe9c09SJoe Perches 1570d1fe9c09SJoe Perches return $last_openparen + 1; 1571d1fe9c09SJoe Perches} 1572d1fe9c09SJoe Perches 15730a920b5bSAndy Whitcroftsub process { 15740a920b5bSAndy Whitcroft my $filename = shift; 15750a920b5bSAndy Whitcroft 15760a920b5bSAndy Whitcroft my $linenr=0; 15770a920b5bSAndy Whitcroft my $prevline=""; 1578c2fdda0dSAndy Whitcroft my $prevrawline=""; 15790a920b5bSAndy Whitcroft my $stashline=""; 1580c2fdda0dSAndy Whitcroft my $stashrawline=""; 15810a920b5bSAndy Whitcroft 15824a0df2efSAndy Whitcroft my $length; 15830a920b5bSAndy Whitcroft my $indent; 15840a920b5bSAndy Whitcroft my $previndent=0; 15850a920b5bSAndy Whitcroft my $stashindent=0; 15860a920b5bSAndy Whitcroft 1587de7d4f0eSAndy Whitcroft our $clean = 1; 15880a920b5bSAndy Whitcroft my $signoff = 0; 15890a920b5bSAndy Whitcroft my $is_patch = 0; 15900a920b5bSAndy Whitcroft 159115662b3eSJoe Perches my $in_header_lines = 1; 159215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 159315662b3eSJoe Perches 1594fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1595fa64205dSPasi Savanainen 159613214adfSAndy Whitcroft our @report = (); 15976c72ffaaSAndy Whitcroft our $cnt_lines = 0; 15986c72ffaaSAndy Whitcroft our $cnt_error = 0; 15996c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16006c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16016c72ffaaSAndy Whitcroft 16020a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16030a920b5bSAndy Whitcroft my $realfile = ''; 16040a920b5bSAndy Whitcroft my $realline = 0; 16050a920b5bSAndy Whitcroft my $realcnt = 0; 16060a920b5bSAndy Whitcroft my $here = ''; 16070a920b5bSAndy Whitcroft my $in_comment = 0; 1608c2fdda0dSAndy Whitcroft my $comment_edge = 0; 16090a920b5bSAndy Whitcroft my $first_line = 0; 16101e855726SWolfram Sang my $p1_prefix = ''; 16110a920b5bSAndy Whitcroft 161213214adfSAndy Whitcroft my $prev_values = 'E'; 161313214adfSAndy Whitcroft 161413214adfSAndy Whitcroft # suppression flags 1615773647a0SAndy Whitcroft my %suppress_ifbraces; 1616170d3a22SAndy Whitcroft my %suppress_whiletrailers; 16172b474a1aSAndy Whitcroft my %suppress_export; 16183e469cdcSAndy Whitcroft my $suppress_statement = 0; 1619653d4876SAndy Whitcroft 16207e51f197SJoe Perches my %signatures = (); 1621323c1260SJoe Perches 1622c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1623de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1624c2fdda0dSAndy Whitcroft # 1625de7d4f0eSAndy Whitcroft my @setup_docs = (); 1626de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1627773647a0SAndy Whitcroft 1628d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1629d8b07710SJoe Perches 1630773647a0SAndy Whitcroft sanitise_line_reset(); 1631c2fdda0dSAndy Whitcroft my $line; 1632c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1633773647a0SAndy Whitcroft $linenr++; 1634773647a0SAndy Whitcroft $line = $rawline; 1635c2fdda0dSAndy Whitcroft 16363705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 16373705ce5bSJoe Perches 1638773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1639de7d4f0eSAndy Whitcroft $setup_docs = 0; 1640de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1641de7d4f0eSAndy Whitcroft $setup_docs = 1; 1642de7d4f0eSAndy Whitcroft } 1643773647a0SAndy Whitcroft #next; 1644de7d4f0eSAndy Whitcroft } 1645773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1646773647a0SAndy Whitcroft $realline=$1-1; 1647773647a0SAndy Whitcroft if (defined $2) { 1648773647a0SAndy Whitcroft $realcnt=$3+1; 1649773647a0SAndy Whitcroft } else { 1650773647a0SAndy Whitcroft $realcnt=1+1; 1651773647a0SAndy Whitcroft } 1652c45dcabdSAndy Whitcroft $in_comment = 0; 1653773647a0SAndy Whitcroft 1654773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1655773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1656773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1657773647a0SAndy Whitcroft # at context start. 1658773647a0SAndy Whitcroft my $edge; 165901fa9147SAndy Whitcroft my $cnt = $realcnt; 166001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 166101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 166201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 166301fa9147SAndy Whitcroft $cnt--; 166401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1665721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1666fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1667fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1668fae17daeSAndy Whitcroft ($edge) = $1; 1669fae17daeSAndy Whitcroft last; 1670fae17daeSAndy Whitcroft } 1671773647a0SAndy Whitcroft } 1672773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1673773647a0SAndy Whitcroft $in_comment = 1; 1674773647a0SAndy Whitcroft } 1675773647a0SAndy Whitcroft 1676773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1677773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1678773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1679773647a0SAndy Whitcroft if (!defined $edge && 168083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1681773647a0SAndy Whitcroft { 1682773647a0SAndy Whitcroft $in_comment = 1; 1683773647a0SAndy Whitcroft } 1684773647a0SAndy Whitcroft 1685773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1686773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1687773647a0SAndy Whitcroft 1688171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1689773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1690171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1691773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1692773647a0SAndy Whitcroft } 1693773647a0SAndy Whitcroft push(@lines, $line); 1694773647a0SAndy Whitcroft 1695773647a0SAndy Whitcroft if ($realcnt > 1) { 1696773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1697773647a0SAndy Whitcroft } else { 1698773647a0SAndy Whitcroft $realcnt = 0; 1699773647a0SAndy Whitcroft } 1700773647a0SAndy Whitcroft 1701773647a0SAndy Whitcroft #print "==>$rawline\n"; 1702773647a0SAndy Whitcroft #print "-->$line\n"; 1703de7d4f0eSAndy Whitcroft 1704de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1705de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1706de7d4f0eSAndy Whitcroft } 1707de7d4f0eSAndy Whitcroft } 1708de7d4f0eSAndy Whitcroft 17096c72ffaaSAndy Whitcroft $prefix = ''; 17106c72ffaaSAndy Whitcroft 1711773647a0SAndy Whitcroft $realcnt = 0; 1712773647a0SAndy Whitcroft $linenr = 0; 17130a920b5bSAndy Whitcroft foreach my $line (@lines) { 17140a920b5bSAndy Whitcroft $linenr++; 17151b5539b1SJoe Perches my $sline = $line; #copy of $line 17161b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 17170a920b5bSAndy Whitcroft 1718c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 17196c72ffaaSAndy Whitcroft 17200a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 17216c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 17220a920b5bSAndy Whitcroft $is_patch = 1; 17234a0df2efSAndy Whitcroft $first_line = $linenr + 1; 17240a920b5bSAndy Whitcroft $realline=$1-1; 17250a920b5bSAndy Whitcroft if (defined $2) { 17260a920b5bSAndy Whitcroft $realcnt=$3+1; 17270a920b5bSAndy Whitcroft } else { 17280a920b5bSAndy Whitcroft $realcnt=1+1; 17290a920b5bSAndy Whitcroft } 1730c2fdda0dSAndy Whitcroft annotate_reset(); 173113214adfSAndy Whitcroft $prev_values = 'E'; 173213214adfSAndy Whitcroft 1733773647a0SAndy Whitcroft %suppress_ifbraces = (); 1734170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 17352b474a1aSAndy Whitcroft %suppress_export = (); 17363e469cdcSAndy Whitcroft $suppress_statement = 0; 17370a920b5bSAndy Whitcroft next; 17380a920b5bSAndy Whitcroft 17394a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 17404a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 17414a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1742773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 17430a920b5bSAndy Whitcroft $realline++; 1744d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 17450a920b5bSAndy Whitcroft 17464a0df2efSAndy Whitcroft # Measure the line length and indent. 1747c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 17480a920b5bSAndy Whitcroft 17490a920b5bSAndy Whitcroft # Track the previous line. 17500a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 17510a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1752c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1753c2fdda0dSAndy Whitcroft 1754773647a0SAndy Whitcroft #warn "line<$line>\n"; 17556c72ffaaSAndy Whitcroft 1756d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1757d8aaf121SAndy Whitcroft $realcnt--; 17580a920b5bSAndy Whitcroft } 17590a920b5bSAndy Whitcroft 1760cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1761cc77cdcaSAndy Whitcroft 17620a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1763773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1764773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1765773647a0SAndy Whitcroft 17666c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 17676c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1768773647a0SAndy Whitcroft 1769773647a0SAndy Whitcroft # extract the filename as it passes 17703bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 17713bf9a009SRabin Vincent $realfile = $1; 17722b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1773270c49a0SJoe Perches $in_commit_log = 0; 17743bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1775773647a0SAndy Whitcroft $realfile = $1; 17762b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1777270c49a0SJoe Perches $in_commit_log = 0; 17781e855726SWolfram Sang 17791e855726SWolfram Sang $p1_prefix = $1; 1780e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1781e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1782000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1783000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 17841e855726SWolfram Sang } 1785773647a0SAndy Whitcroft 1786c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1787000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1788000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1789773647a0SAndy Whitcroft } 1790773647a0SAndy Whitcroft next; 1791773647a0SAndy Whitcroft } 1792773647a0SAndy Whitcroft 1793389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 17940a920b5bSAndy Whitcroft 1795c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1796c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1797c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 17980a920b5bSAndy Whitcroft 17996c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 18006c72ffaaSAndy Whitcroft 18013bf9a009SRabin Vincent# Check for incorrect file permissions 18023bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 18033bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 180404db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 180504db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1806000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1807000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 18083bf9a009SRabin Vincent } 18093bf9a009SRabin Vincent } 18103bf9a009SRabin Vincent 181120112475SJoe Perches# Check the patch for a signoff: 1812d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 18134a0df2efSAndy Whitcroft $signoff++; 181415662b3eSJoe Perches $in_commit_log = 0; 18150a920b5bSAndy Whitcroft } 181620112475SJoe Perches 181720112475SJoe Perches# Check signature styles 1818270c49a0SJoe Perches if (!$in_header_lines && 1819ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 182020112475SJoe Perches my $space_before = $1; 182120112475SJoe Perches my $sign_off = $2; 182220112475SJoe Perches my $space_after = $3; 182320112475SJoe Perches my $email = $4; 182420112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 182520112475SJoe Perches 1826ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1827ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1828ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1829ce0338dfSJoe Perches } 183020112475SJoe Perches if (defined $space_before && $space_before ne "") { 18313705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18323705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 18333705ce5bSJoe Perches $fix) { 18343705ce5bSJoe Perches $fixed[$linenr - 1] = 18353705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18363705ce5bSJoe Perches } 183720112475SJoe Perches } 183820112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 18393705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18403705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 18413705ce5bSJoe Perches $fix) { 18423705ce5bSJoe Perches $fixed[$linenr - 1] = 18433705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18443705ce5bSJoe Perches } 18453705ce5bSJoe Perches 184620112475SJoe Perches } 184720112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 18483705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18493705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 18503705ce5bSJoe Perches $fix) { 18513705ce5bSJoe Perches $fixed[$linenr - 1] = 18523705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18533705ce5bSJoe Perches } 185420112475SJoe Perches } 185520112475SJoe Perches 185620112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 185720112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 185820112475SJoe Perches if ($suggested_email eq "") { 1859000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1860000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 186120112475SJoe Perches } else { 186220112475SJoe Perches my $dequoted = $suggested_email; 186320112475SJoe Perches $dequoted =~ s/^"//; 186420112475SJoe Perches $dequoted =~ s/" </ </; 186520112475SJoe Perches # Don't force email to have quotes 186620112475SJoe Perches # Allow just an angle bracketed address 186720112475SJoe Perches if ("$dequoted$comment" ne $email && 186820112475SJoe Perches "<$email_address>$comment" ne $email && 186920112475SJoe Perches "$suggested_email$comment" ne $email) { 1870000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1871000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 187220112475SJoe Perches } 18730a920b5bSAndy Whitcroft } 18747e51f197SJoe Perches 18757e51f197SJoe Perches# Check for duplicate signatures 18767e51f197SJoe Perches my $sig_nospace = $line; 18777e51f197SJoe Perches $sig_nospace =~ s/\s//g; 18787e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 18797e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 18807e51f197SJoe Perches WARN("BAD_SIGN_OFF", 18817e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 18827e51f197SJoe Perches } else { 18837e51f197SJoe Perches $signatures{$sig_nospace} = 1; 18847e51f197SJoe Perches } 18850a920b5bSAndy Whitcroft } 18860a920b5bSAndy Whitcroft 188700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 18888905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1889000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1890000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 18916c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1892de7d4f0eSAndy Whitcroft } 1893de7d4f0eSAndy Whitcroft 18946ecd9674SAndy Whitcroft# Check for absolute kernel paths. 18956ecd9674SAndy Whitcroft if ($tree) { 18966ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 18976ecd9674SAndy Whitcroft my $file = $1; 18986ecd9674SAndy Whitcroft 18996ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19006ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19016ecd9674SAndy Whitcroft # 19026ecd9674SAndy Whitcroft } else { 19036ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19046ecd9674SAndy Whitcroft } 19056ecd9674SAndy Whitcroft } 19066ecd9674SAndy Whitcroft } 19076ecd9674SAndy Whitcroft 1908de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1909de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1910171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1911171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1912171ae1a4SAndy Whitcroft 1913171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1914171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1915171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1916171ae1a4SAndy Whitcroft 191734d99219SJoe Perches CHK("INVALID_UTF8", 1918000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 191900df344fSAndy Whitcroft } 19200a920b5bSAndy Whitcroft 192115662b3eSJoe Perches# Check if it's the start of a commit log 192215662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 192315662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1924270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 192515662b3eSJoe Perches $in_header_lines = 0; 192615662b3eSJoe Perches $in_commit_log = 1; 192715662b3eSJoe Perches } 192815662b3eSJoe Perches 1929fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1930fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1931fa64205dSPasi Savanainen if ($in_header_lines && 1932fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1933fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1934fa64205dSPasi Savanainen $non_utf8_charset = 1; 1935fa64205dSPasi Savanainen } 1936fa64205dSPasi Savanainen 1937fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 193815662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1939fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 194015662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 194115662b3eSJoe Perches } 194215662b3eSJoe Perches 194330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 194430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 194500df344fSAndy Whitcroft 19460a920b5bSAndy Whitcroft#trailing whitespace 19479c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1948c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1949d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 1950d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 1951d5e616fcSJoe Perches $fix) { 1952d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 1953d5e616fcSJoe Perches } 1954c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1955c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19563705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 19573705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 19583705ce5bSJoe Perches $fix) { 1959d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 19603705ce5bSJoe Perches } 19613705ce5bSJoe Perches 1962d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 19630a920b5bSAndy Whitcroft } 19645368df20SAndy Whitcroft 19654783f894SJosh Triplett# Check for FSF mailing addresses. 19664783f894SJosh Triplett if ($rawline =~ /You should have received a copy/ || 19674783f894SJosh Triplett $rawline =~ /write to the Free Software/ || 19684783f894SJosh Triplett $rawline =~ /59 Temple Place/ || 19694783f894SJosh Triplett $rawline =~ /51 Franklin Street/) { 19704783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19714783f894SJosh Triplett my $msg_type = \&ERROR; 19724783f894SJosh Triplett $msg_type = \&CHK if ($file); 19734783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 19744783f894SJosh 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) 19754783f894SJosh Triplett } 19764783f894SJosh Triplett 19773354957aSAndi Kleen# check for Kconfig help text having a real description 19789fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 19799fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 19803354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1981a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 19823354957aSAndi Kleen my $length = 0; 19839fe287d7SAndy Whitcroft my $cnt = $realcnt; 19849fe287d7SAndy Whitcroft my $ln = $linenr + 1; 19859fe287d7SAndy Whitcroft my $f; 1986a1385803SAndy Whitcroft my $is_start = 0; 19879fe287d7SAndy Whitcroft my $is_end = 0; 1988a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 19899fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 19909fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 19919fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 19929fe287d7SAndy Whitcroft 19939fe287d7SAndy Whitcroft next if ($f =~ /^-/); 1994a1385803SAndy Whitcroft 1995a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1996a1385803SAndy Whitcroft $is_start = 1; 1997a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1998a1385803SAndy Whitcroft $length = -1; 1999a1385803SAndy Whitcroft } 2000a1385803SAndy Whitcroft 20019fe287d7SAndy Whitcroft $f =~ s/^.//; 20023354957aSAndi Kleen $f =~ s/#.*//; 20033354957aSAndi Kleen $f =~ s/^\s+//; 20043354957aSAndi Kleen next if ($f =~ /^$/); 20059fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20069fe287d7SAndy Whitcroft $is_end = 1; 20079fe287d7SAndy Whitcroft last; 20089fe287d7SAndy Whitcroft } 20093354957aSAndi Kleen $length++; 20103354957aSAndi Kleen } 2011000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2012a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2013a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20143354957aSAndi Kleen } 20153354957aSAndi Kleen 20161ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20171ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20181ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20191ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20201ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20211ba8dfd1SKees Cook } 20221ba8dfd1SKees Cook 2023c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2024c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2025c68e5878SArnaud Lacombe my $flag = $1; 2026c68e5878SArnaud Lacombe my $replacement = { 2027c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2028c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2029c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2030c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2031c68e5878SArnaud Lacombe }; 2032c68e5878SArnaud Lacombe 2033c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2034c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2035c68e5878SArnaud Lacombe } 2036c68e5878SArnaud Lacombe 20375368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 20385368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 20395368df20SAndy Whitcroft 20406cd7f386SJoe Perches#line length limit 2041c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2042f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 20430fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 20448bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 20456cd7f386SJoe Perches $length > $max_line_length) 2046c45dcabdSAndy Whitcroft { 2047000d1cc1SJoe Perches WARN("LONG_LINE", 20486cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 20490a920b5bSAndy Whitcroft } 20500a920b5bSAndy Whitcroft 2051ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 20528c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 20538c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 20548c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2055ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2056ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 20578c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2058ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2059ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2060ca56dc09SJosh Triplett } 2061ca56dc09SJosh Triplett 20625e79d96eSJoe Perches# check for spaces before a quoted newline 20635e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 20643705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 20653705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 20663705ce5bSJoe Perches $fix) { 20673705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 20683705ce5bSJoe Perches } 20693705ce5bSJoe Perches 20705e79d96eSJoe Perches } 20715e79d96eSJoe Perches 20728905a67cSAndy Whitcroft# check for adding lines without a newline. 20738905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2074000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2075000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 20768905a67cSAndy Whitcroft } 20778905a67cSAndy Whitcroft 207842e41c54SMike Frysinger# Blackfin: use hi/lo macros 207942e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 208042e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 208142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2082000d1cc1SJoe Perches ERROR("LO_MACRO", 2083000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 208442e41c54SMike Frysinger } 208542e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 208642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2087000d1cc1SJoe Perches ERROR("HI_MACRO", 2088000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 208942e41c54SMike Frysinger } 209042e41c54SMike Frysinger } 209142e41c54SMike Frysinger 2092b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2093b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 20940a920b5bSAndy Whitcroft 20950a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 20960a920b5bSAndy Whitcroft# more than 8 must use tabs. 2097c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2098c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2099c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2100d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21013705ce5bSJoe Perches if (ERROR("CODE_INDENT", 21023705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 21033705ce5bSJoe Perches $fix) { 21043705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 21053705ce5bSJoe Perches } 21060a920b5bSAndy Whitcroft } 21070a920b5bSAndy Whitcroft 210808e44365SAlberto Panizzo# check for space before tabs. 210908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 211008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21113705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 21123705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 21133705ce5bSJoe Perches $fix) { 21143705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21153705ce5bSJoe Perches s/(^\+.*) +\t/$1\t/; 21163705ce5bSJoe Perches } 211708e44365SAlberto Panizzo } 211808e44365SAlberto Panizzo 2119d1fe9c09SJoe Perches# check for && or || at the start of a line 2120d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2121d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2122d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2123d1fe9c09SJoe Perches } 2124d1fe9c09SJoe Perches 2125d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2126d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2127d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 2128d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2129d1fe9c09SJoe Perches my $oldindent = $1; 2130d1fe9c09SJoe Perches my $rest = $2; 2131d1fe9c09SJoe Perches 2132d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2133d1fe9c09SJoe Perches if ($pos >= 0) { 2134b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2135b34a26f3SJoe Perches my $newindent = $2; 2136d1fe9c09SJoe Perches 2137d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2138d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2139d1fe9c09SJoe Perches " " x ($pos % 8); 2140d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2141d1fe9c09SJoe Perches 2142d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2143d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 21443705ce5bSJoe Perches 21453705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 21463705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 21473705ce5bSJoe Perches $fix && $line =~ /^\+/) { 21483705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21493705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 21503705ce5bSJoe Perches } 2151d1fe9c09SJoe Perches } 2152d1fe9c09SJoe Perches } 2153d1fe9c09SJoe Perches } 2154d1fe9c09SJoe Perches 215523f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 21563705ce5bSJoe Perches if (CHK("SPACING", 21573705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 21583705ce5bSJoe Perches $fix) { 21593705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21603705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 21613705ce5bSJoe Perches } 2162aad4f614SJoe Perches } 2163aad4f614SJoe Perches 216405880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2165fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 2166fdb4bcd6SJoe Perches $rawline =~ /^\+[ \t]*\*/) { 216705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 216805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 216905880600SJoe Perches } 217005880600SJoe Perches 217105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2172a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2173a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 217461135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2175a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2176a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2177a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2178a605e32eSJoe Perches } 2179a605e32eSJoe Perches 2180a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2181c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2182c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2183c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2184c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 218505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 218605880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 218705880600SJoe Perches } 218805880600SJoe Perches 21895f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 21906b4c5bebSAndy Whitcroft# Exceptions: 21916b4c5bebSAndy Whitcroft# 1) within comments 21926b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 21936b4c5bebSAndy Whitcroft# 3) hanging labels 21943705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 21955f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21963705ce5bSJoe Perches if (WARN("LEADING_SPACE", 21973705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 21983705ce5bSJoe Perches $fix) { 21993705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22003705ce5bSJoe Perches } 22015f7ddae6SRaffaele Recalcati } 22025f7ddae6SRaffaele Recalcati 2203b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2204b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2205b9ea10d6SAndy Whitcroft 22061ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 22071ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 22081ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 22091ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 22101ba8dfd1SKees Cook } 22111ba8dfd1SKees Cook 2212c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2213cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2214000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2215000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2216c2fdda0dSAndy Whitcroft } 221722f2a2efSAndy Whitcroft 221842e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 221942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 222042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2221000d1cc1SJoe Perches ERROR("CSYNC", 2222000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 222342e41c54SMike Frysinger } 222442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 222542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2226000d1cc1SJoe Perches ERROR("SSYNC", 2227000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 222842e41c54SMike Frysinger } 222942e41c54SMike Frysinger 223056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 223156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 223256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 223356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 223456e77d70SJoe Perches } 223556e77d70SJoe Perches 22369c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 22372b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 22382b474a1aSAndy Whitcroft $realline_next); 22393e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 22403e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 22411b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2242170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2243f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2244171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2245171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2246171ae1a4SAndy Whitcroft 22473e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 22483e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 22493e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 22503e469cdcSAndy Whitcroft # until we hit end of it. 22513e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 22523e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 22533e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 22543e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 22553e469cdcSAndy Whitcroft } 2256f74bd194SAndy Whitcroft 22572b474a1aSAndy Whitcroft # Find the real next line. 22582b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 22592b474a1aSAndy Whitcroft if (defined $realline_next && 22602b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 22612b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 22622b474a1aSAndy Whitcroft $realline_next++; 22632b474a1aSAndy Whitcroft } 22642b474a1aSAndy Whitcroft 2265171ae1a4SAndy Whitcroft my $s = $stat; 2266171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2267cf655043SAndy Whitcroft 2268c2fdda0dSAndy Whitcroft # Ignore goto labels. 2269171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2270c2fdda0dSAndy Whitcroft 2271c2fdda0dSAndy Whitcroft # Ignore functions being called 2272171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2273c2fdda0dSAndy Whitcroft 2274463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2275463f2864SAndy Whitcroft 2276c45dcabdSAndy Whitcroft # declarations always start with types 2277d2506586SAndy 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) { 2278c45dcabdSAndy Whitcroft my $type = $1; 2279c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2280c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2281c45dcabdSAndy Whitcroft 22826c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2283a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2284c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2285c2fdda0dSAndy Whitcroft } 22868905a67cSAndy Whitcroft 22876c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 228865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2289c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 22909c0ca6f9SAndy Whitcroft } 22918905a67cSAndy Whitcroft 22928905a67cSAndy Whitcroft # Check for any sort of function declaration. 22938905a67cSAndy Whitcroft # int foo(something bar, other baz); 22948905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2295171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 22968905a67cSAndy Whitcroft my ($name_len) = length($1); 22978905a67cSAndy Whitcroft 2298cf655043SAndy Whitcroft my $ctx = $s; 2299773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 23008905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2301cf655043SAndy Whitcroft 23028905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2303c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 23048905a67cSAndy Whitcroft 2305c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 23068905a67cSAndy Whitcroft } 23078905a67cSAndy Whitcroft } 23088905a67cSAndy Whitcroft } 23098905a67cSAndy Whitcroft 23109c0ca6f9SAndy Whitcroft } 23119c0ca6f9SAndy Whitcroft 231200df344fSAndy Whitcroft# 231300df344fSAndy Whitcroft# Checks which may be anchored in the context. 231400df344fSAndy Whitcroft# 231500df344fSAndy Whitcroft 231600df344fSAndy Whitcroft# Check for switch () and associated case and default 231700df344fSAndy Whitcroft# statements should be at the same indent. 231800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 231900df344fSAndy Whitcroft my $err = ''; 232000df344fSAndy Whitcroft my $sep = ''; 232100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 232200df344fSAndy Whitcroft shift(@ctx); 232300df344fSAndy Whitcroft for my $ctx (@ctx) { 232400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 232500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 232600df344fSAndy Whitcroft $indent != $cindent) { 232700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 232800df344fSAndy Whitcroft $sep = ''; 232900df344fSAndy Whitcroft } else { 233000df344fSAndy Whitcroft $sep = "[...]\n"; 233100df344fSAndy Whitcroft } 233200df344fSAndy Whitcroft } 233300df344fSAndy Whitcroft if ($err ne '') { 2334000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2335000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2336de7d4f0eSAndy Whitcroft } 2337de7d4f0eSAndy Whitcroft } 2338de7d4f0eSAndy Whitcroft 2339de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2340de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2341c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2342773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2343773647a0SAndy Whitcroft 23449c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 23458eef05ddSJoe Perches 23468eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 23478eef05ddSJoe Perches WARN("DEEP_INDENTATION", 23488eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 23498eef05ddSJoe Perches } 23508eef05ddSJoe Perches 2351de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2352de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2353de7d4f0eSAndy Whitcroft 2354548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2355548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2356de7d4f0eSAndy Whitcroft 2357548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2358548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2359548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2360548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2361548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2362773647a0SAndy Whitcroft $ctx_ln++; 2363773647a0SAndy Whitcroft } 2364548596d5SAndy Whitcroft 236553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 236653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2367773647a0SAndy Whitcroft 2368773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2369000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2370000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 237101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 237200df344fSAndy Whitcroft } 2373773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2374773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2375773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2376773647a0SAndy Whitcroft { 23779c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 23789c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2379000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2380000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 238101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 23829c0ca6f9SAndy Whitcroft } 23839c0ca6f9SAndy Whitcroft } 238400df344fSAndy Whitcroft } 238500df344fSAndy Whitcroft 23864d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 23874d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 23883e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 23893e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 23903e469cdcSAndy Whitcroft if (!defined $stat); 23914d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 23924d001e4dSAndy Whitcroft 23934d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 23944d001e4dSAndy Whitcroft 23954d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 23964d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 23974d001e4dSAndy Whitcroft # where necessary. 23984d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 23994d001e4dSAndy Whitcroft 24004d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 24016f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 24026f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 24034d001e4dSAndy Whitcroft 24044d001e4dSAndy Whitcroft # We want to check the first line inside the block 24054d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 24064d001e4dSAndy Whitcroft # 1) any blank line termination 24074d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 24084d001e4dSAndy Whitcroft # 3) any do (...) { 24094d001e4dSAndy Whitcroft my $continuation = 0; 24104d001e4dSAndy Whitcroft my $check = 0; 24114d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 24124d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 24134d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 24144d001e4dSAndy Whitcroft $continuation = 1; 24154d001e4dSAndy Whitcroft } 24169bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 24174d001e4dSAndy Whitcroft $check = 1; 24184d001e4dSAndy Whitcroft $cond_lines++; 24194d001e4dSAndy Whitcroft } 24204d001e4dSAndy Whitcroft 24214d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 24224d001e4dSAndy Whitcroft # preprocessor statement. 24234d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 24244d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 24254d001e4dSAndy Whitcroft $check = 0; 24264d001e4dSAndy Whitcroft } 24274d001e4dSAndy Whitcroft 24289bd49efeSAndy Whitcroft my $cond_ptr = -1; 2429740504c6SAndy Whitcroft $continuation = 0; 24309bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 24319bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 24324d001e4dSAndy Whitcroft 2433f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2434f16fa28fSAndy Whitcroft # is not linear. 2435f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2436f16fa28fSAndy Whitcroft $check = 0; 2437f16fa28fSAndy Whitcroft } 2438f16fa28fSAndy Whitcroft 24399bd49efeSAndy Whitcroft # Ignore: 24409bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 24419bd49efeSAndy Whitcroft # 2) preprocessor lines, and 24429bd49efeSAndy Whitcroft # 3) labels. 2443740504c6SAndy Whitcroft if ($continuation || 2444740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 24459bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 24469bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2447740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 244830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 24499bd49efeSAndy Whitcroft $cond_lines++; 24509bd49efeSAndy Whitcroft } 24514d001e4dSAndy Whitcroft } 245230dad6ebSAndy Whitcroft } 24534d001e4dSAndy Whitcroft 24544d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 24554d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 24564d001e4dSAndy Whitcroft 24574d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 24584d001e4dSAndy Whitcroft # this is not this patch's fault. 24594d001e4dSAndy Whitcroft if (!defined($stat_real) || 24604d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 24614d001e4dSAndy Whitcroft $check = 0; 24624d001e4dSAndy Whitcroft } 24634d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 24644d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 24654d001e4dSAndy Whitcroft } 24664d001e4dSAndy Whitcroft 24679bd49efeSAndy 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"; 24684d001e4dSAndy Whitcroft 24694d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 24704d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2471000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2472000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 24734d001e4dSAndy Whitcroft } 24744d001e4dSAndy Whitcroft } 24754d001e4dSAndy Whitcroft 24766c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 24776c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 24781f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 24791f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 24806c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2481c2fdda0dSAndy Whitcroft if ($dbg_values) { 2482c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2483cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2484cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 24851f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2486c2fdda0dSAndy Whitcroft } 24876c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 24886c72ffaaSAndy Whitcroft 248900df344fSAndy Whitcroft#ignore lines not being added 24903705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 249100df344fSAndy Whitcroft 2492653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 24937429c690SAndy Whitcroft if ($dbg_type) { 24947429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2495000d1cc1SJoe Perches ERROR("TEST_TYPE", 2496000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 24977429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2498000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2499000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 25007429c690SAndy Whitcroft } 2501653d4876SAndy Whitcroft next; 2502653d4876SAndy Whitcroft } 2503a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2504a1ef277eSAndy Whitcroft if ($dbg_attr) { 25059360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2506000d1cc1SJoe Perches ERROR("TEST_ATTR", 2507000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 25089360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2509000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2510000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2511a1ef277eSAndy Whitcroft } 2512a1ef277eSAndy Whitcroft next; 2513a1ef277eSAndy Whitcroft } 2514653d4876SAndy Whitcroft 2515f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 251699423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 251799423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2518000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2519000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2520f0a594c1SAndy Whitcroft } 2521f0a594c1SAndy Whitcroft 252200df344fSAndy Whitcroft# 252300df344fSAndy Whitcroft# Checks which are anchored on the added line. 252400df344fSAndy Whitcroft# 252500df344fSAndy Whitcroft 2526653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2527c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2528653d4876SAndy Whitcroft my $path = $1; 2529653d4876SAndy Whitcroft if ($path =~ m{//}) { 2530000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2531495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2532495e9d84SJoe Perches } 2533495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2534495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2535495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2536653d4876SAndy Whitcroft } 2537653d4876SAndy Whitcroft } 2538653d4876SAndy Whitcroft 253900df344fSAndy Whitcroft# no C99 // comments 254000df344fSAndy Whitcroft if ($line =~ m{//}) { 25413705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 25423705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 25433705ce5bSJoe Perches $fix) { 25443705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 25453705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 25463705ce5bSJoe Perches my $comment = trim($1); 25473705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 25483705ce5bSJoe Perches } 25493705ce5bSJoe Perches } 255000df344fSAndy Whitcroft } 255100df344fSAndy Whitcroft # Remove C99 comments. 25520a920b5bSAndy Whitcroft $line =~ s@//.*@@; 25536c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 25540a920b5bSAndy Whitcroft 25552b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 25562b474a1aSAndy Whitcroft# the whole statement. 25572b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 25582b474a1aSAndy Whitcroft if (defined $realline_next && 25592b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 25602b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 25612b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25622b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25633cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 25643cbf62dfSAndy Whitcroft # a prefix: 25653cbf62dfSAndy Whitcroft # XXX(foo); 25663cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2567653d4876SAndy Whitcroft my $name = $1; 256887a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 25693cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 25703cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 25713cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 25723cbf62dfSAndy Whitcroft 25733cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 25742b474a1aSAndy Whitcroft \n.}\s*$| 257548012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 257648012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 257748012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 25782b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 25792b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 258048012058SAndy Whitcroft )/x) { 25812b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 25822b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 25832b474a1aSAndy Whitcroft } else { 25842b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 25850a920b5bSAndy Whitcroft } 25860a920b5bSAndy Whitcroft } 25872b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 25882b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 25892b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25902b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25912b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 25922b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 25932b474a1aSAndy Whitcroft } 25942b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 25952b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2596000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2597000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 25982b474a1aSAndy Whitcroft } 25990a920b5bSAndy Whitcroft 26005150bda4SJoe Eloff# check for global initialisers. 2601d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2602d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2603000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2604d5e616fcSJoe Perches $herecurr) && 2605d5e616fcSJoe Perches $fix) { 2606d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2607d5e616fcSJoe Perches } 2608f0a594c1SAndy Whitcroft } 26090a920b5bSAndy Whitcroft# check for static initialisers. 2610d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2611d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2612000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2613d5e616fcSJoe Perches $herecurr) && 2614d5e616fcSJoe Perches $fix) { 2615d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2616d5e616fcSJoe Perches } 26170a920b5bSAndy Whitcroft } 26180a920b5bSAndy Whitcroft 2619cb710ecaSJoe Perches# check for static const char * arrays. 2620cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2621000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2622000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2623cb710ecaSJoe Perches $herecurr); 2624cb710ecaSJoe Perches } 2625cb710ecaSJoe Perches 2626cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2627cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2628000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2629000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2630cb710ecaSJoe Perches $herecurr); 2631cb710ecaSJoe Perches } 2632cb710ecaSJoe Perches 263392e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 263492e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 263592e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 263692e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 263792e112fdSJoe Perches $fix) { 263892e112fdSJoe 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\[\] = /; 263992e112fdSJoe Perches } 264093ed0e2dSJoe Perches } 264193ed0e2dSJoe Perches 2642653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2643653d4876SAndy Whitcroft# make sense. 2644653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 26458054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2646c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 26478ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2648653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2649000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2650000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 26510a920b5bSAndy Whitcroft } 26520a920b5bSAndy Whitcroft 26530a920b5bSAndy Whitcroft# * goes on variable not on type 265465863862SAndy Whitcroft # (char*[ const]) 2655bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2656bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 26573705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2658d8aaf121SAndy Whitcroft 265965863862SAndy Whitcroft # Should start with a space. 266065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 266165863862SAndy Whitcroft # Should not end with a space. 266265863862SAndy Whitcroft $to =~ s/\s+$//; 266365863862SAndy Whitcroft # '*'s should not have spaces between. 2664f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 266565863862SAndy Whitcroft } 2666d8aaf121SAndy Whitcroft 26673705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 266865863862SAndy Whitcroft if ($from ne $to) { 26693705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 26703705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 26713705ce5bSJoe Perches $fix) { 26723705ce5bSJoe Perches my $sub_from = $ident; 26733705ce5bSJoe Perches my $sub_to = $ident; 26743705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 26753705ce5bSJoe Perches $fixed[$linenr - 1] =~ 26763705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 26773705ce5bSJoe Perches } 267865863862SAndy Whitcroft } 2679bfcb2cc7SAndy Whitcroft } 2680bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2681bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 26823705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2683d8aaf121SAndy Whitcroft 268465863862SAndy Whitcroft # Should start with a space. 268565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 268665863862SAndy Whitcroft # Should not end with a space. 268765863862SAndy Whitcroft $to =~ s/\s+$//; 268865863862SAndy Whitcroft # '*'s should not have spaces between. 2689f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 269065863862SAndy Whitcroft } 269165863862SAndy Whitcroft # Modifiers should have spaces. 269265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 269365863862SAndy Whitcroft 26943705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2695667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 26963705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 26973705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 26983705ce5bSJoe Perches $fix) { 26993705ce5bSJoe Perches 27003705ce5bSJoe Perches my $sub_from = $match; 27013705ce5bSJoe Perches my $sub_to = $match; 27023705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 27033705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27043705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 27053705ce5bSJoe Perches } 270665863862SAndy Whitcroft } 27070a920b5bSAndy Whitcroft } 27080a920b5bSAndy Whitcroft 27090a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 27100a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 27110a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 27120a920b5bSAndy Whitcroft# print "$herecurr"; 27130a920b5bSAndy Whitcroft# $clean = 0; 27140a920b5bSAndy Whitcroft# } 27150a920b5bSAndy Whitcroft 27168905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2717000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2718000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 27198905a67cSAndy Whitcroft } 27208905a67cSAndy Whitcroft 272117441227SJoe Perches# check for uses of printk_ratelimit 272217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2723000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2724000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 272517441227SJoe Perches } 272617441227SJoe Perches 272700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 272800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 272900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 273025985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 273100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2732f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 273300df344fSAndy Whitcroft my $ok = 0; 273400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 273500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 273625985edcSLucas De Marchi # we have a preceding printk if it ends 273700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 273800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 273900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 274000df344fSAndy Whitcroft $ok = 1; 274100df344fSAndy Whitcroft } 274200df344fSAndy Whitcroft last; 274300df344fSAndy Whitcroft } 274400df344fSAndy Whitcroft } 274500df344fSAndy Whitcroft if ($ok == 0) { 2746000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2747000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 27480a920b5bSAndy Whitcroft } 274900df344fSAndy Whitcroft } 27500a920b5bSAndy Whitcroft 2751243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2752243f3803SJoe Perches my $orig = $1; 2753243f3803SJoe Perches my $level = lc($orig); 2754243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 27558f26b837SJoe Perches my $level2 = $level; 27568f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2757243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 27588f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2759243f3803SJoe Perches } 2760243f3803SJoe Perches 2761243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2762d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2763d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2764d5e616fcSJoe Perches $fix) { 2765d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2766d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2767d5e616fcSJoe Perches } 2768243f3803SJoe Perches } 2769243f3803SJoe Perches 2770dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2771dc139313SJoe Perches my $orig = $1; 2772dc139313SJoe Perches my $level = lc($orig); 2773dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2774dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2775dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2776dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2777dc139313SJoe Perches } 2778dc139313SJoe Perches 2779653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2780653d4876SAndy Whitcroft# or if closed on same line 2781c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2782c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2783000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2784000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 27850a920b5bSAndy Whitcroft } 2786653d4876SAndy Whitcroft 27878905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 27888905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 27898905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2790000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2791000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 27928905a67cSAndy Whitcroft } 27938905a67cSAndy Whitcroft 27940c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 27953705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 27963705ce5bSJoe Perches if (WARN("SPACING", 27973705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 27983705ce5bSJoe Perches $fix) { 27993705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28003705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 28013705ce5bSJoe Perches } 28020c73b4ebSAndy Whitcroft } 28030c73b4ebSAndy Whitcroft 28048d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 28058d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2806fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2807fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 28088d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 28098d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 28108d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2811fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2812daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 28133705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 28143705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 28153705ce5bSJoe Perches $fix) { 28163705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28173705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 28183705ce5bSJoe Perches } 28198d31cfceSAndy Whitcroft } 28208d31cfceSAndy Whitcroft } 28218d31cfceSAndy Whitcroft 2822f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 28236c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2824c2fdda0dSAndy Whitcroft my $name = $1; 2825773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2826773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2827c2fdda0dSAndy Whitcroft 2828c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2829773647a0SAndy Whitcroft if ($name =~ /^(?: 2830773647a0SAndy Whitcroft if|for|while|switch|return|case| 2831773647a0SAndy Whitcroft volatile|__volatile__| 2832773647a0SAndy Whitcroft __attribute__|format|__extension__| 2833773647a0SAndy Whitcroft asm|__asm__)$/x) 2834773647a0SAndy Whitcroft { 2835c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2836c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2837c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2838c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2839773647a0SAndy Whitcroft 2840773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2841c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2842c2fdda0dSAndy Whitcroft 2843c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2844c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2845773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2846c2fdda0dSAndy Whitcroft 2847c2fdda0dSAndy Whitcroft } else { 28483705ce5bSJoe Perches if (WARN("SPACING", 28493705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 28503705ce5bSJoe Perches $fix) { 28513705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28523705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 28533705ce5bSJoe Perches } 2854f0a594c1SAndy Whitcroft } 28556c72ffaaSAndy Whitcroft } 28569a4cad4eSEric Nelson 2857653d4876SAndy Whitcroft# Check operator spacing. 28580a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 28593705ce5bSJoe Perches my $fixed_line = ""; 28603705ce5bSJoe Perches my $line_fixed = 0; 28613705ce5bSJoe Perches 28629c0ca6f9SAndy Whitcroft my $ops = qr{ 28639c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 28649c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 28659c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 28661f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 286784731623SJoe Perches \?:|\?|: 28689c0ca6f9SAndy Whitcroft }x; 2869cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 28703705ce5bSJoe Perches 28713705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 28723705ce5bSJoe Perches## foreach my $el (@elements) { 28733705ce5bSJoe Perches## print("el: <$el>\n"); 28743705ce5bSJoe Perches## } 28753705ce5bSJoe Perches 28763705ce5bSJoe Perches my @fix_elements = (); 287700df344fSAndy Whitcroft my $off = 0; 28786c72ffaaSAndy Whitcroft 28793705ce5bSJoe Perches foreach my $el (@elements) { 28803705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 28813705ce5bSJoe Perches $off += length($el); 28823705ce5bSJoe Perches } 28833705ce5bSJoe Perches 28843705ce5bSJoe Perches $off = 0; 28853705ce5bSJoe Perches 28866c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 2887b34c648bSJoe Perches my $last_after = -1; 28886c72ffaaSAndy Whitcroft 28890a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 28903705ce5bSJoe Perches 28913705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 28923705ce5bSJoe Perches 28933705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 28943705ce5bSJoe Perches 28954a0df2efSAndy Whitcroft $off += length($elements[$n]); 28964a0df2efSAndy Whitcroft 289725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2898773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2899773647a0SAndy Whitcroft my $cc = ''; 2900773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2901773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2902773647a0SAndy Whitcroft } 2903773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2904773647a0SAndy Whitcroft 29054a0df2efSAndy Whitcroft my $a = ''; 29064a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 29074a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2908cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 29094a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 29104a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2911773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 29124a0df2efSAndy Whitcroft 29130a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 29144a0df2efSAndy Whitcroft 29154a0df2efSAndy Whitcroft my $c = ''; 29160a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 29174a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 29184a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2919cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 29204a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 29214a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 29228b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 29234a0df2efSAndy Whitcroft } else { 29244a0df2efSAndy Whitcroft $c = 'E'; 29250a920b5bSAndy Whitcroft } 29260a920b5bSAndy Whitcroft 29274a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 29284a0df2efSAndy Whitcroft 29294a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 29304a0df2efSAndy Whitcroft 29316c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2932de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 29330a920b5bSAndy Whitcroft 293474048ed8SAndy Whitcroft # Pull out the value of this operator. 29356c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 29360a920b5bSAndy Whitcroft 29371f65f947SAndy Whitcroft # Get the full operator variant. 29381f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 29391f65f947SAndy Whitcroft 294013214adfSAndy Whitcroft # Ignore operators passed as parameters. 294113214adfSAndy Whitcroft if ($op_type ne 'V' && 294213214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 294313214adfSAndy Whitcroft 2944cf655043SAndy Whitcroft# # Ignore comments 2945cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 294613214adfSAndy Whitcroft 2947d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 294813214adfSAndy Whitcroft } elsif ($op eq ';') { 2949cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2950cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 29513705ce5bSJoe Perches if (ERROR("SPACING", 29523705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 2953b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 29543705ce5bSJoe Perches $line_fixed = 1; 29553705ce5bSJoe Perches } 2956d8aaf121SAndy Whitcroft } 2957d8aaf121SAndy Whitcroft 2958d8aaf121SAndy Whitcroft # // is a comment 2959d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 29600a920b5bSAndy Whitcroft 29611f65f947SAndy Whitcroft # No spaces for: 29621f65f947SAndy Whitcroft # -> 29631f65f947SAndy Whitcroft # : when part of a bitfield 29641f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 29654a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 29663705ce5bSJoe Perches if (ERROR("SPACING", 29673705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 2968b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 29693705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 29703705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 29713705ce5bSJoe Perches } 2972b34c648bSJoe Perches $line_fixed = 1; 29733705ce5bSJoe Perches } 29740a920b5bSAndy Whitcroft } 29750a920b5bSAndy Whitcroft 29760a920b5bSAndy Whitcroft # , must have a space on the right. 29770a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2978cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 29793705ce5bSJoe Perches if (ERROR("SPACING", 29803705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 2981b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 29823705ce5bSJoe Perches $line_fixed = 1; 2983b34c648bSJoe Perches $last_after = $n; 29843705ce5bSJoe Perches } 29850a920b5bSAndy Whitcroft } 29860a920b5bSAndy Whitcroft 29879c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 298874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 29899c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 29909c0ca6f9SAndy Whitcroft 29919c0ca6f9SAndy Whitcroft # unary operators should have a space before and 29929c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 29939c0ca6f9SAndy Whitcroft # unary operator, or a cast 29949c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 299574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 29960d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2997cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 29983705ce5bSJoe Perches if (ERROR("SPACING", 29993705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3000b34c648bSJoe Perches if ($n != $last_after + 2) { 3001b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 30023705ce5bSJoe Perches $line_fixed = 1; 30033705ce5bSJoe Perches } 30040a920b5bSAndy Whitcroft } 3005b34c648bSJoe Perches } 3006a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3007171ae1a4SAndy Whitcroft # A unary '*' may be const 3008171ae1a4SAndy Whitcroft 3009171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 30103705ce5bSJoe Perches if (ERROR("SPACING", 30113705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3012b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 30133705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 30143705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 30153705ce5bSJoe Perches } 3016b34c648bSJoe Perches $line_fixed = 1; 30173705ce5bSJoe Perches } 30180a920b5bSAndy Whitcroft } 30190a920b5bSAndy Whitcroft 30200a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 30210a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3022773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 30233705ce5bSJoe Perches if (ERROR("SPACING", 30243705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3025b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 30263705ce5bSJoe Perches $line_fixed = 1; 30273705ce5bSJoe Perches } 30280a920b5bSAndy Whitcroft } 3029773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3030773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 30313705ce5bSJoe Perches if (ERROR("SPACING", 30323705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3033b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 30343705ce5bSJoe Perches $line_fixed = 1; 30353705ce5bSJoe Perches } 3036653d4876SAndy Whitcroft } 3037773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 30383705ce5bSJoe Perches if (ERROR("SPACING", 30393705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3040b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 30413705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 30423705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3043773647a0SAndy Whitcroft } 3044b34c648bSJoe Perches $line_fixed = 1; 30453705ce5bSJoe Perches } 30463705ce5bSJoe Perches } 30470a920b5bSAndy Whitcroft 30480a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 30499c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 30509c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 30519c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3052c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3053c2fdda0dSAndy Whitcroft $op eq '%') 30540a920b5bSAndy Whitcroft { 3055773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 30563705ce5bSJoe Perches if (ERROR("SPACING", 30573705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3058b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3059b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3060b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3061b34c648bSJoe Perches } 30623705ce5bSJoe Perches $line_fixed = 1; 30633705ce5bSJoe Perches } 30640a920b5bSAndy Whitcroft } 30650a920b5bSAndy Whitcroft 30661f65f947SAndy Whitcroft # A colon needs no spaces before when it is 30671f65f947SAndy Whitcroft # terminating a case value or a label. 30681f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 30691f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 30703705ce5bSJoe Perches if (ERROR("SPACING", 30713705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3072b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 30733705ce5bSJoe Perches $line_fixed = 1; 30743705ce5bSJoe Perches } 30751f65f947SAndy Whitcroft } 30761f65f947SAndy Whitcroft 30770a920b5bSAndy Whitcroft # All the others need spaces both sides. 3078cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 30791f65f947SAndy Whitcroft my $ok = 0; 30801f65f947SAndy Whitcroft 308122f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 30821f65f947SAndy Whitcroft if (($op eq '<' && 30831f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 30841f65f947SAndy Whitcroft ($op eq '>' && 30851f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 30861f65f947SAndy Whitcroft { 30871f65f947SAndy Whitcroft $ok = 1; 30881f65f947SAndy Whitcroft } 30891f65f947SAndy Whitcroft 309084731623SJoe Perches # messages are ERROR, but ?: are CHK 30911f65f947SAndy Whitcroft if ($ok == 0) { 309284731623SJoe Perches my $msg_type = \&ERROR; 309384731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 309484731623SJoe Perches 309584731623SJoe Perches if (&{$msg_type}("SPACING", 30963705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3097b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3098b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3099b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3100b34c648bSJoe Perches } 31013705ce5bSJoe Perches $line_fixed = 1; 31023705ce5bSJoe Perches } 31030a920b5bSAndy Whitcroft } 310422f2a2efSAndy Whitcroft } 31054a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 31063705ce5bSJoe Perches 31073705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 31083705ce5bSJoe Perches 31093705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 31100a920b5bSAndy Whitcroft } 31113705ce5bSJoe Perches 31123705ce5bSJoe Perches if (($#elements % 2) == 0) { 31133705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 31143705ce5bSJoe Perches } 31153705ce5bSJoe Perches 31163705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 31173705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 31183705ce5bSJoe Perches } 31193705ce5bSJoe Perches 31203705ce5bSJoe Perches 31210a920b5bSAndy Whitcroft } 31220a920b5bSAndy Whitcroft 3123786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3124*d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3125786b6326SJoe Perches if (WARN("SPACING", 3126786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3127786b6326SJoe Perches $fix) { 3128786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3129786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3130786b6326SJoe Perches } 3131786b6326SJoe Perches } 3132786b6326SJoe Perches 3133f0a594c1SAndy Whitcroft# check for multiple assignments 3134f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3135000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3136000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3137f0a594c1SAndy Whitcroft } 3138f0a594c1SAndy Whitcroft 313922f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 314022f2a2efSAndy Whitcroft## # continuation. 314122f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 314222f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 314322f2a2efSAndy Whitcroft## 314422f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 314522f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 314622f2a2efSAndy Whitcroft## my $ln = $line; 314722f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 314822f2a2efSAndy Whitcroft## } 314922f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3150000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3151000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 315222f2a2efSAndy Whitcroft## } 315322f2a2efSAndy Whitcroft## } 3154f0a594c1SAndy Whitcroft 31550a920b5bSAndy Whitcroft#need space before brace following if, while, etc 315622f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 315722f2a2efSAndy Whitcroft $line =~ /do{/) { 31583705ce5bSJoe Perches if (ERROR("SPACING", 31593705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 31603705ce5bSJoe Perches $fix) { 3161d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 31623705ce5bSJoe Perches } 3163de7d4f0eSAndy Whitcroft } 3164de7d4f0eSAndy Whitcroft 3165c4a62ef9SJoe Perches## # check for blank lines before declarations 3166c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3167c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3168c4a62ef9SJoe Perches## WARN("SPACING", 3169c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3170c4a62ef9SJoe Perches## } 3171c4a62ef9SJoe Perches## 3172c4a62ef9SJoe Perches 3173de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3174de7d4f0eSAndy Whitcroft# on the line 3175de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3176d5e616fcSJoe Perches if (ERROR("SPACING", 3177d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3178d5e616fcSJoe Perches $fix) { 3179d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3180d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3181d5e616fcSJoe Perches } 31820a920b5bSAndy Whitcroft } 31830a920b5bSAndy Whitcroft 318422f2a2efSAndy Whitcroft# check spacing on square brackets 318522f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 31863705ce5bSJoe Perches if (ERROR("SPACING", 31873705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 31883705ce5bSJoe Perches $fix) { 31893705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31903705ce5bSJoe Perches s/\[\s+/\[/; 31913705ce5bSJoe Perches } 319222f2a2efSAndy Whitcroft } 319322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 31943705ce5bSJoe Perches if (ERROR("SPACING", 31953705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 31963705ce5bSJoe Perches $fix) { 31973705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31983705ce5bSJoe Perches s/\s+\]/\]/; 31993705ce5bSJoe Perches } 320022f2a2efSAndy Whitcroft } 320122f2a2efSAndy Whitcroft 3202c45dcabdSAndy Whitcroft# check spacing on parentheses 32039c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 32049c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 32053705ce5bSJoe Perches if (ERROR("SPACING", 32063705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 32073705ce5bSJoe Perches $fix) { 32083705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32093705ce5bSJoe Perches s/\(\s+/\(/; 32103705ce5bSJoe Perches } 321122f2a2efSAndy Whitcroft } 321213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3213c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3214c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 32153705ce5bSJoe Perches if (ERROR("SPACING", 32163705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 32173705ce5bSJoe Perches $fix) { 32183705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32193705ce5bSJoe Perches s/\s+\)/\)/; 32203705ce5bSJoe Perches } 322122f2a2efSAndy Whitcroft } 322222f2a2efSAndy Whitcroft 32230a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 32244a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 32250a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 32263705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 32273705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 32283705ce5bSJoe Perches $fix) { 32293705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32303705ce5bSJoe Perches s/^(.)\s+/$1/; 32313705ce5bSJoe Perches } 32320a920b5bSAndy Whitcroft } 32330a920b5bSAndy Whitcroft 3234c45dcabdSAndy Whitcroft# Return is not a function. 3235507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3236c45dcabdSAndy Whitcroft my $spacing = $1; 3237507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 3238507e5141SJoe Perches $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) { 3239000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3240000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 3241c45dcabdSAndy Whitcroft 3242c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3243000d1cc1SJoe Perches ERROR("SPACING", 3244000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3245c45dcabdSAndy Whitcroft } 3246c45dcabdSAndy Whitcroft } 3247507e5141SJoe Perches 324853a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 324953a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 325053a3c448SAndy Whitcroft my $name = $1; 325153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3252000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3253000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 325453a3c448SAndy Whitcroft } 325553a3c448SAndy Whitcroft } 3256c45dcabdSAndy Whitcroft 32570a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 32584a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 32593705ce5bSJoe Perches if (ERROR("SPACING", 32603705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 32613705ce5bSJoe Perches $fix) { 32623705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32633705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 32643705ce5bSJoe Perches } 32650a920b5bSAndy Whitcroft } 32660a920b5bSAndy Whitcroft 3267f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3268f5fe35ddSAndy Whitcroft# statements after the conditional. 3269170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 32703e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 32713e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 32723e469cdcSAndy Whitcroft if (!defined $stat); 3273170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3274170d3a22SAndy Whitcroft $remain_next, $off_next); 3275170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3276170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3277170d3a22SAndy Whitcroft 3278170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3279170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3280170d3a22SAndy Whitcroft # then count those as offsets. 3281170d3a22SAndy Whitcroft my ($whitespace) = 3282170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3283170d3a22SAndy Whitcroft my $offset = 3284170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3285170d3a22SAndy Whitcroft 3286170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3287170d3a22SAndy Whitcroft $offset} = 1; 3288170d3a22SAndy Whitcroft } 3289170d3a22SAndy Whitcroft } 3290170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3291c11230f4SJoe Perches defined($stat) && defined($cond) && 3292170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3293171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 32948905a67cSAndy Whitcroft 3295b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3296000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3297000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 32988905a67cSAndy Whitcroft } 32998905a67cSAndy Whitcroft 33008905a67cSAndy Whitcroft # Find out what is on the end of the line after the 33018905a67cSAndy Whitcroft # conditional. 3302773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 33038905a67cSAndy Whitcroft $s =~ s/\n.*//g; 330413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 330553210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 330653210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3307773647a0SAndy Whitcroft { 3308bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3309bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3310bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 331142bdf74cSHidetoshi Seto my $stat_real = ''; 3312bb44ad39SAndy Whitcroft 331342bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 331442bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3315bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3316bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3317bb44ad39SAndy Whitcroft } 3318bb44ad39SAndy Whitcroft 3319000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3320000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 33218905a67cSAndy Whitcroft } 33228905a67cSAndy Whitcroft } 33238905a67cSAndy Whitcroft 332413214adfSAndy Whitcroft# Check for bitwise tests written as boolean 332513214adfSAndy Whitcroft if ($line =~ / 332613214adfSAndy Whitcroft (?: 332713214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 332813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 332913214adfSAndy Whitcroft (?:\&\&|\|\|) 333013214adfSAndy Whitcroft | 333113214adfSAndy Whitcroft (?:\&\&|\|\|) 333213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 333313214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 333413214adfSAndy Whitcroft )/x) 333513214adfSAndy Whitcroft { 3336000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3337000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 333813214adfSAndy Whitcroft } 333913214adfSAndy Whitcroft 33408905a67cSAndy Whitcroft# if and else should not have general statements after it 334113214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 334213214adfSAndy Whitcroft my $s = $1; 334313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 334413214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3345000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3346000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 33470a920b5bSAndy Whitcroft } 334813214adfSAndy Whitcroft } 334939667782SAndy Whitcroft# if should not continue a brace 335039667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3351000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3352000d1cc1SJoe Perches "trailing statements should be on next line\n" . 335339667782SAndy Whitcroft $herecurr); 335439667782SAndy Whitcroft } 3355a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3356a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3357a1080bf8SAndy Whitcroft $line !~ /\G(?: 33583fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3359a1080bf8SAndy Whitcroft \s*return\s+ 3360a1080bf8SAndy Whitcroft )/xg) 3361a1080bf8SAndy Whitcroft { 3362000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3363000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3364a1080bf8SAndy Whitcroft } 33650a920b5bSAndy Whitcroft 33660a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 33670a920b5bSAndy Whitcroft # indent level to be relevant to each other. 33680a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 33690a920b5bSAndy Whitcroft $previndent == $indent) { 3370000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3371000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 33720a920b5bSAndy Whitcroft } 33730a920b5bSAndy Whitcroft 3374c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3375c2fdda0dSAndy Whitcroft $previndent == $indent) { 3376c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3377c2fdda0dSAndy Whitcroft 3378c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3379c2fdda0dSAndy Whitcroft # conditional. 3380773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3381c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3382c2fdda0dSAndy Whitcroft 3383c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3384000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3385000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3386c2fdda0dSAndy Whitcroft } 3387c2fdda0dSAndy Whitcroft } 3388c2fdda0dSAndy Whitcroft 338995e2c602SJoe Perches#Specific variable tests 3390323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3391323c1260SJoe Perches my $var = $1; 339295e2c602SJoe Perches 339395e2c602SJoe Perches#gcc binary extension 339495e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3395d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3396d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3397d5e616fcSJoe Perches $fix) { 3398d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3399d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3400d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3401d5e616fcSJoe Perches } 340295e2c602SJoe Perches } 340395e2c602SJoe Perches 340495e2c602SJoe Perches#CamelCase 3405807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3406be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 340722735ce8SJoe Perches#Ignore Page<foo> variants 3408807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 340922735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 34103445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 34117e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 34127e781f67SJoe Perches my $word = $1; 34137e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3414d8b07710SJoe Perches if ($check) { 3415d8b07710SJoe Perches seed_camelcase_includes(); 3416d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3417d8b07710SJoe Perches seed_camelcase_file($realfile); 3418d8b07710SJoe Perches $camelcase_file_seeded = 1; 3419d8b07710SJoe Perches } 3420d8b07710SJoe Perches } 34217e781f67SJoe Perches if (!defined $camelcase{$word}) { 34227e781f67SJoe Perches $camelcase{$word} = 1; 3423be79794bSJoe Perches CHK("CAMELCASE", 34247e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 34257e781f67SJoe Perches } 3426323c1260SJoe Perches } 3427323c1260SJoe Perches } 34283445686aSJoe Perches } 34290a920b5bSAndy Whitcroft 34300a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3431d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3432d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3433d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3434d5e616fcSJoe Perches $fix) { 3435d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3436d5e616fcSJoe Perches } 34370a920b5bSAndy Whitcroft } 34380a920b5bSAndy Whitcroft 3439653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3440c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3441e09dec48SAndy Whitcroft my $file = "$1.h"; 3442e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3443e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3444e09dec48SAndy Whitcroft $realfile ne $checkfile && 34457840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3446c45dcabdSAndy Whitcroft { 3447e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3448000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3449000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3450e09dec48SAndy Whitcroft } else { 3451000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3452000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3453e09dec48SAndy Whitcroft } 34540a920b5bSAndy Whitcroft } 34550a920b5bSAndy Whitcroft } 34560a920b5bSAndy Whitcroft 3457653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3458653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3459cf655043SAndy Whitcroft# in a known good container 3460b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3461b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3462d8aaf121SAndy Whitcroft my $ln = $linenr; 3463d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3464c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3465c45dcabdSAndy Whitcroft my $ctx = ''; 3466c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3467f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3468f74bd194SAndy Whitcroft $ctx = $dstat; 3469c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3470a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3471c45dcabdSAndy Whitcroft 3472f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3473292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3474c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3475c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3476c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3477c45dcabdSAndy Whitcroft 3478c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3479bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3480bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3481c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3482bf30d6edSAndy Whitcroft { 3483c45dcabdSAndy Whitcroft } 3484c45dcabdSAndy Whitcroft 3485e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3486e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3487e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3488e45bab8eSAndy Whitcroft { 3489e45bab8eSAndy Whitcroft } 3490e45bab8eSAndy Whitcroft 3491c45dcabdSAndy Whitcroft my $exceptions = qr{ 3492c45dcabdSAndy Whitcroft $Declare| 3493c45dcabdSAndy Whitcroft module_param_named| 3494a0a0a7a9SKees Cook MODULE_PARM_DESC| 3495c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3496c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3497383099fdSAndy Whitcroft __typeof__\(| 349822fd2d3eSStefani Seibold union| 349922fd2d3eSStefani Seibold struct| 3500ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3501ea71a0a0SAndy Whitcroft ^\"|\"$ 3502c45dcabdSAndy Whitcroft }x; 35035eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3504f74bd194SAndy Whitcroft if ($dstat ne '' && 3505f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3506f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 35073cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3508b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3509f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3510f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3511e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 351272f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3513f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3514f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3515f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3516f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3517f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3518c45dcabdSAndy Whitcroft { 3519f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3520f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3521f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3522f74bd194SAndy Whitcroft 3523f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3524f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3525c45dcabdSAndy Whitcroft } 3526c45dcabdSAndy Whitcroft 3527f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3528f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3529f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3530f74bd194SAndy Whitcroft } else { 3531000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3532f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3533d8aaf121SAndy Whitcroft } 35340a920b5bSAndy Whitcroft } 35355023d347SJoe Perches 3536481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 35375023d347SJoe Perches 35385023d347SJoe Perches } else { 35395023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3540481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3541481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 35425023d347SJoe Perches $line =~ /^\+.*\\$/) { 35435023d347SJoe Perches WARN("LINE_CONTINUATIONS", 35445023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 35455023d347SJoe Perches } 3546653d4876SAndy Whitcroft } 35470a920b5bSAndy Whitcroft 3548b13edf7fSJoe Perches# do {} while (0) macro tests: 3549b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3550b13edf7fSJoe Perches# macro should not end with a semicolon 3551b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3552b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3553b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3554b13edf7fSJoe Perches my $ln = $linenr; 3555b13edf7fSJoe Perches my $cnt = $realcnt; 3556b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3557b13edf7fSJoe Perches my $ctx = ''; 3558b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3559b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3560b13edf7fSJoe Perches $ctx = $dstat; 3561b13edf7fSJoe Perches 3562b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3563b13edf7fSJoe Perches 3564b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3565b13edf7fSJoe Perches my $stmts = $2; 3566b13edf7fSJoe Perches my $semis = $3; 3567b13edf7fSJoe Perches 3568b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3569b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3570b13edf7fSJoe Perches my $herectx = $here . "\n"; 3571b13edf7fSJoe Perches 3572b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3573b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3574b13edf7fSJoe Perches } 3575b13edf7fSJoe Perches 3576ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3577ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3578b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3579b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3580b13edf7fSJoe Perches } 3581b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3582b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3583b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3584b13edf7fSJoe Perches } 3585b13edf7fSJoe Perches } 3586b13edf7fSJoe Perches } 3587b13edf7fSJoe Perches 3588080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3589080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3590080ba929SMike Frysinger# . 3591080ba929SMike Frysinger# ALIGN(...) 3592080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3593080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3594000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3595000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3596080ba929SMike Frysinger } 3597080ba929SMike Frysinger 3598f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 359913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 360013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3601cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 360213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3603cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3604cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3605aad4f614SJoe Perches my @allowed = (); 3606aad4f614SJoe Perches my $allow = 0; 360713214adfSAndy Whitcroft my $seen = 0; 3608773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3609cf655043SAndy Whitcroft my $ln = $linenr - 1; 361013214adfSAndy Whitcroft for my $chunk (@chunks) { 361113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 361213214adfSAndy Whitcroft 3613773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3614773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3615773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3616773647a0SAndy Whitcroft 3617aad4f614SJoe Perches $allowed[$allow] = 0; 3618773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3619773647a0SAndy Whitcroft 3620773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3621773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3622773647a0SAndy Whitcroft 3623773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3624cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3625cf655043SAndy Whitcroft 3626773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 362713214adfSAndy Whitcroft 362813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 362913214adfSAndy Whitcroft 3630aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3631cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3632cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3633aad4f614SJoe Perches $allowed[$allow] = 1; 363413214adfSAndy Whitcroft } 363513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3636cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3637aad4f614SJoe Perches $allowed[$allow] = 1; 363813214adfSAndy Whitcroft } 3639cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3640cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3641aad4f614SJoe Perches $allowed[$allow] = 1; 364213214adfSAndy Whitcroft } 3643aad4f614SJoe Perches $allow++; 364413214adfSAndy Whitcroft } 3645aad4f614SJoe Perches if ($seen) { 3646aad4f614SJoe Perches my $sum_allowed = 0; 3647aad4f614SJoe Perches foreach (@allowed) { 3648aad4f614SJoe Perches $sum_allowed += $_; 3649aad4f614SJoe Perches } 3650aad4f614SJoe Perches if ($sum_allowed == 0) { 3651000d1cc1SJoe Perches WARN("BRACES", 3652000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3653aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3654aad4f614SJoe Perches $seen != $allow) { 3655aad4f614SJoe Perches CHK("BRACES", 3656aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3657aad4f614SJoe Perches } 365813214adfSAndy Whitcroft } 365913214adfSAndy Whitcroft } 366013214adfSAndy Whitcroft } 3661773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 366213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3663cf655043SAndy Whitcroft my $allowed = 0; 3664f0a594c1SAndy Whitcroft 3665cf655043SAndy Whitcroft # Check the pre-context. 3666cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3667cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3668cf655043SAndy Whitcroft $allowed = 1; 3669f0a594c1SAndy Whitcroft } 3670773647a0SAndy Whitcroft 3671773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3672773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3673773647a0SAndy Whitcroft 3674cf655043SAndy Whitcroft # Check the condition. 3675cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3676773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3677cf655043SAndy Whitcroft if (defined $cond) { 3678773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3679cf655043SAndy Whitcroft } 3680cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3681cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3682cf655043SAndy Whitcroft $allowed = 1; 3683cf655043SAndy Whitcroft } 3684cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3685cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3686cf655043SAndy Whitcroft $allowed = 1; 3687cf655043SAndy Whitcroft } 3688cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3689cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3690cf655043SAndy Whitcroft $allowed = 1; 3691cf655043SAndy Whitcroft } 3692cf655043SAndy Whitcroft # Check the post-context. 3693cf655043SAndy Whitcroft if (defined $chunks[1]) { 3694cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3695cf655043SAndy Whitcroft if (defined $cond) { 3696773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3697cf655043SAndy Whitcroft } 3698cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3699cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3700cf655043SAndy Whitcroft $allowed = 1; 3701cf655043SAndy Whitcroft } 3702cf655043SAndy Whitcroft } 3703cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 370469932487SJustin P. Mattock my $herectx = $here . "\n"; 3705f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3706cf655043SAndy Whitcroft 3707f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 370869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3709cf655043SAndy Whitcroft } 3710cf655043SAndy Whitcroft 3711000d1cc1SJoe Perches WARN("BRACES", 3712000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3713f0a594c1SAndy Whitcroft } 3714f0a594c1SAndy Whitcroft } 3715f0a594c1SAndy Whitcroft 37160979ae66SJoe Perches# check for unnecessary blank lines around braces 371777b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 37180979ae66SJoe Perches CHK("BRACES", 37190979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 37200979ae66SJoe Perches } 372177b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 37220979ae66SJoe Perches CHK("BRACES", 37230979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 37240979ae66SJoe Perches } 37250979ae66SJoe Perches 37264a0df2efSAndy Whitcroft# no volatiles please 37276c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 37286c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3729000d1cc1SJoe Perches WARN("VOLATILE", 3730000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 37314a0df2efSAndy Whitcroft } 37324a0df2efSAndy Whitcroft 373300df344fSAndy Whitcroft# warn about #if 0 3734c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3735000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3736000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3737de7d4f0eSAndy Whitcroft $herecurr); 37384a0df2efSAndy Whitcroft } 37394a0df2efSAndy Whitcroft 374003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 374103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 374203df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 374303df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 374403df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 374503df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 37464c432a8fSGreg Kroah-Hartman } 37474c432a8fSGreg Kroah-Hartman } 3748f0a594c1SAndy Whitcroft 37498716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 37508716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 37518716de38SJoe Perches my $attr = $1; 37528716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 37538716de38SJoe Perches my $ptr = $1; 37548716de38SJoe Perches my $var = $2; 37558716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 37568716de38SJoe Perches ERROR("MISPLACED_INIT", 37578716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 37588716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 37598716de38SJoe Perches WARN("MISPLACED_INIT", 37608716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 37618716de38SJoe Perches $fix) { 37628716de38SJoe 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; 37638716de38SJoe Perches } 37648716de38SJoe Perches } 37658716de38SJoe Perches } 37668716de38SJoe Perches 3767e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 3768e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 3769e970b884SJoe Perches my $attr = $1; 3770e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 3771e970b884SJoe Perches my $attr_prefix = $1; 3772e970b884SJoe Perches my $attr_type = $2; 3773e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3774e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 3775e970b884SJoe Perches $fix) { 3776e970b884SJoe Perches $fixed[$linenr - 1] =~ 3777e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 3778e970b884SJoe Perches } 3779e970b884SJoe Perches } 3780e970b884SJoe Perches 3781e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 3782e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 3783e970b884SJoe Perches my $attr = $1; 3784e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3785e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 3786e970b884SJoe Perches $fix) { 3787e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 3788e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 3789e970b884SJoe Perches $lead = rtrim($1); 3790e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 3791e970b884SJoe Perches $lead = "${lead}const "; 3792e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 3793e970b884SJoe Perches } 3794e970b884SJoe Perches } 3795e970b884SJoe Perches 37961a15a250SPatrick Pannuto# prefer usleep_range over udelay 379737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 37981a15a250SPatrick Pannuto # ignore udelay's < 10, however 379937581c28SBruce Allan if (! ($1 < 10) ) { 3800000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3801000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 38021a15a250SPatrick Pannuto } 38031a15a250SPatrick Pannuto } 38041a15a250SPatrick Pannuto 380509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 380609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 380709ef8725SPatrick Pannuto if ($1 < 20) { 3808000d1cc1SJoe Perches WARN("MSLEEP", 3809000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 381009ef8725SPatrick Pannuto } 381109ef8725SPatrick Pannuto } 381209ef8725SPatrick Pannuto 381336ec1939SJoe Perches# check for comparisons of jiffies 381436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 381536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 381636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 381736ec1939SJoe Perches } 381836ec1939SJoe Perches 38199d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 38209d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 38219d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 38229d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 38239d7a34a5SJoe Perches } 38249d7a34a5SJoe Perches 382500df344fSAndy Whitcroft# warn about #ifdefs in C files 3826c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 382700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 382800df344fSAndy Whitcroft# print "$herecurr"; 382900df344fSAndy Whitcroft# $clean = 0; 383000df344fSAndy Whitcroft# } 383100df344fSAndy Whitcroft 383222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3833c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 38343705ce5bSJoe Perches if (ERROR("SPACING", 38353705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 38363705ce5bSJoe Perches $fix) { 38373705ce5bSJoe Perches $fixed[$linenr - 1] =~ 38383705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 38393705ce5bSJoe Perches } 38403705ce5bSJoe Perches 384122f2a2efSAndy Whitcroft } 384222f2a2efSAndy Whitcroft 38434a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3844171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3845171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 38464a0df2efSAndy Whitcroft my $which = $1; 38474a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3848000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3849000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 38504a0df2efSAndy Whitcroft } 38514a0df2efSAndy Whitcroft } 38524a0df2efSAndy Whitcroft# check for memory barriers without a comment. 38534a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 38544a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3855c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 3856000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 38574a0df2efSAndy Whitcroft } 38584a0df2efSAndy Whitcroft } 38594a0df2efSAndy Whitcroft# check of hardware specific defines 3860c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3861000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3862000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 38630a920b5bSAndy Whitcroft } 3864653d4876SAndy Whitcroft 3865d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3866d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3867000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3868000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3869d4977c78STobias Klauser } 3870d4977c78STobias Klauser 3871de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3872de7d4f0eSAndy Whitcroft# storage class and type. 38739c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 38749c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3875000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3876000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3877de7d4f0eSAndy Whitcroft } 3878de7d4f0eSAndy Whitcroft 38798905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 38802b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 38812b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 3882d5e616fcSJoe Perches if (WARN("INLINE", 3883d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 3884d5e616fcSJoe Perches $fix) { 3885d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 3886d5e616fcSJoe Perches 3887d5e616fcSJoe Perches } 38888905a67cSAndy Whitcroft } 38898905a67cSAndy Whitcroft 38903d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 38912b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 38922b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3893000d1cc1SJoe Perches WARN("PREFER_PACKED", 3894000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 38953d130fd0SJoe Perches } 38963d130fd0SJoe Perches 389739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 38982b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 38992b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3900000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3901000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 390239b7e287SJoe Perches } 390339b7e287SJoe Perches 39045f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 39052b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39062b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 3907d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 3908d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 3909d5e616fcSJoe Perches $fix) { 3910d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 3911d5e616fcSJoe Perches 3912d5e616fcSJoe Perches } 39135f14d3bdSJoe Perches } 39145f14d3bdSJoe Perches 39156061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 39162b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39172b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 3918d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 3919d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 3920d5e616fcSJoe Perches $fix) { 3921d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 3922d5e616fcSJoe Perches } 39236061d949SJoe Perches } 39246061d949SJoe Perches 39258f53a9b8SJoe Perches# check for sizeof(&) 39268f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3927000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3928000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 39298f53a9b8SJoe Perches } 39308f53a9b8SJoe Perches 393166c80b60SJoe Perches# check for sizeof without parenthesis 393266c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 3933d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 3934d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 3935d5e616fcSJoe Perches $fix) { 3936d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 3937d5e616fcSJoe Perches } 393866c80b60SJoe Perches } 393966c80b60SJoe Perches 3940428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3941428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3942000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3943000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3944428e2fdcSJoe Perches } 3945428e2fdcSJoe Perches 394688982feaSJoe Perches# check for struct spinlock declarations 394788982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 394888982feaSJoe Perches WARN("USE_SPINLOCK_T", 394988982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 395088982feaSJoe Perches } 395188982feaSJoe Perches 3952a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 395306668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 3954a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 395506668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 3956d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 3957d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 3958d5e616fcSJoe Perches $fix) { 3959d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 3960d5e616fcSJoe Perches } 3961a6962d72SJoe Perches } 3962a6962d72SJoe Perches } 3963a6962d72SJoe Perches 3964554e165cSAndy Whitcroft# Check for misused memsets 3965d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3966d1fe9c09SJoe Perches defined $stat && 3967d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3968554e165cSAndy Whitcroft 3969d7c76ba7SJoe Perches my $ms_addr = $2; 3970d1fe9c09SJoe Perches my $ms_val = $7; 3971d1fe9c09SJoe Perches my $ms_size = $12; 3972d7c76ba7SJoe Perches 3973554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3974554e165cSAndy Whitcroft ERROR("MEMSET", 3975d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3976554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3977554e165cSAndy Whitcroft WARN("MEMSET", 3978d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3979d7c76ba7SJoe Perches } 3980d7c76ba7SJoe Perches } 3981d7c76ba7SJoe Perches 3982d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3983d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3984d1fe9c09SJoe Perches defined $stat && 3985d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3986d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3987d7c76ba7SJoe Perches my $call = $1; 3988d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3989d7c76ba7SJoe Perches my $arg1 = $3; 3990d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3991d1fe9c09SJoe Perches my $arg2 = $8; 3992d7c76ba7SJoe Perches my $cast; 3993d7c76ba7SJoe Perches 3994d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3995d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3996d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3997d7c76ba7SJoe Perches $cast = $cast1; 3998d7c76ba7SJoe Perches } else { 3999d7c76ba7SJoe Perches $cast = $cast2; 4000d7c76ba7SJoe Perches } 4001d7c76ba7SJoe Perches WARN("MINMAX", 4002d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4003554e165cSAndy Whitcroft } 4004554e165cSAndy Whitcroft } 4005554e165cSAndy Whitcroft 40064a273195SJoe Perches# check usleep_range arguments 40074a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 40084a273195SJoe Perches defined $stat && 40094a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 40104a273195SJoe Perches my $min = $1; 40114a273195SJoe Perches my $max = $7; 40124a273195SJoe Perches if ($min eq $max) { 40134a273195SJoe Perches WARN("USLEEP_RANGE", 40144a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 40154a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 40164a273195SJoe Perches $min > $max) { 40174a273195SJoe Perches WARN("USLEEP_RANGE", 40184a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 40194a273195SJoe Perches } 40204a273195SJoe Perches } 40214a273195SJoe Perches 4022823b794cSJoe Perches# check for naked sscanf 4023823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4024823b794cSJoe Perches defined $stat && 4025823b794cSJoe Perches $stat =~ /\bsscanf\b/ && 4026823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4027823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4028823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4029823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4030823b794cSJoe Perches $lc = $lc + $linenr; 4031823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4032823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4033823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4034823b794cSJoe Perches } 4035823b794cSJoe Perches WARN("NAKED_SSCANF", 4036823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4037823b794cSJoe Perches } 4038823b794cSJoe Perches 403970dc8a48SJoe Perches# check for new externs in .h files. 404070dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 404170dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4042d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 404370dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 404470dc8a48SJoe Perches $fix) { 404570dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 404670dc8a48SJoe Perches } 404770dc8a48SJoe Perches } 404870dc8a48SJoe Perches 4049de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4050171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4051c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4052171ae1a4SAndy Whitcroft { 4053c45dcabdSAndy Whitcroft my $function_name = $1; 4054c45dcabdSAndy Whitcroft my $paren_space = $2; 4055171ae1a4SAndy Whitcroft 4056171ae1a4SAndy Whitcroft my $s = $stat; 4057171ae1a4SAndy Whitcroft if (defined $cond) { 4058171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4059171ae1a4SAndy Whitcroft } 4060c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4061c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4062c45dcabdSAndy Whitcroft { 4063000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4064000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4065de7d4f0eSAndy Whitcroft } 4066de7d4f0eSAndy Whitcroft 4067171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4068000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4069000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4070171ae1a4SAndy Whitcroft } 40719c9ba34eSAndy Whitcroft 40729c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 40739c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 40749c9ba34eSAndy Whitcroft { 4075000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4076000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4077171ae1a4SAndy Whitcroft } 4078171ae1a4SAndy Whitcroft 4079de7d4f0eSAndy Whitcroft# checks for new __setup's 4080de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4081de7d4f0eSAndy Whitcroft my $name = $1; 4082de7d4f0eSAndy Whitcroft 4083de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4084000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4085000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4086de7d4f0eSAndy Whitcroft } 4087653d4876SAndy Whitcroft } 40889c0ca6f9SAndy Whitcroft 40899c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4090caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4091000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4092000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 40939c0ca6f9SAndy Whitcroft } 409413214adfSAndy Whitcroft 4095a640d25cSJoe Perches# alloc style 4096a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4097a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4098a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4099a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4100a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4101a640d25cSJoe Perches } 4102a640d25cSJoe Perches 4103972fdea2SJoe Perches# check for krealloc arg reuse 4104972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4105972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4106972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4107972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4108972fdea2SJoe Perches } 4109972fdea2SJoe Perches 41105ce59ae0SJoe Perches# check for alloc argument mismatch 41115ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 41125ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 41135ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 41145ce59ae0SJoe Perches } 41155ce59ae0SJoe Perches 4116caf2a54fSJoe Perches# check for multiple semicolons 4117caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4118d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4119d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4120d5e616fcSJoe Perches $fix) { 4121d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4122d5e616fcSJoe Perches } 4123d1e2ad07SJoe Perches } 4124d1e2ad07SJoe Perches 4125d1e2ad07SJoe Perches# check for switch/default statements without a break; 4126d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4127d1e2ad07SJoe Perches defined $stat && 4128d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4129d1e2ad07SJoe Perches my $ctx = ''; 4130d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4131d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4132d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4133d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4134d1e2ad07SJoe Perches } 4135d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4136d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4137caf2a54fSJoe Perches } 4138caf2a54fSJoe Perches 413913214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4140d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4141d5e616fcSJoe Perches if (WARN("USE_FUNC", 4142d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4143d5e616fcSJoe Perches $fix) { 4144d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4145d5e616fcSJoe Perches } 414613214adfSAndy Whitcroft } 4147773647a0SAndy Whitcroft 41482c92488aSJoe Perches# check for use of yield() 41492c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 41502c92488aSJoe Perches WARN("YIELD", 41512c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 41522c92488aSJoe Perches } 41532c92488aSJoe Perches 4154179f8f40SJoe Perches# check for comparisons against true and false 4155179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4156179f8f40SJoe Perches my $lead = $1; 4157179f8f40SJoe Perches my $arg = $2; 4158179f8f40SJoe Perches my $test = $3; 4159179f8f40SJoe Perches my $otype = $4; 4160179f8f40SJoe Perches my $trail = $5; 4161179f8f40SJoe Perches my $op = "!"; 4162179f8f40SJoe Perches 4163179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4164179f8f40SJoe Perches 4165179f8f40SJoe Perches my $type = lc($otype); 4166179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4167179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4168179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4169179f8f40SJoe Perches $op = ""; 4170179f8f40SJoe Perches } 4171179f8f40SJoe Perches 4172179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4173179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4174179f8f40SJoe Perches 4175179f8f40SJoe Perches## maybe suggesting a correct construct would better 4176179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4177179f8f40SJoe Perches 4178179f8f40SJoe Perches } 4179179f8f40SJoe Perches } 4180179f8f40SJoe Perches 41814882720bSThomas Gleixner# check for semaphores initialized locked 41824882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4183000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4184000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4185773647a0SAndy Whitcroft } 41866712d858SJoe Perches 418767d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 418867d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4189000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 419067d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4191773647a0SAndy Whitcroft } 41926712d858SJoe Perches 4193f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4194f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4195000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4196000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4197f3db6639SMichael Ellerman } 41986712d858SJoe Perches 419979404849SEmese Revfy# check for various ops structs, ensure they are const. 420079404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 420179404849SEmese Revfy address_space_operations| 420279404849SEmese Revfy backlight_ops| 420379404849SEmese Revfy block_device_operations| 420479404849SEmese Revfy dentry_operations| 420579404849SEmese Revfy dev_pm_ops| 420679404849SEmese Revfy dma_map_ops| 420779404849SEmese Revfy extent_io_ops| 420879404849SEmese Revfy file_lock_operations| 420979404849SEmese Revfy file_operations| 421079404849SEmese Revfy hv_ops| 421179404849SEmese Revfy ide_dma_ops| 421279404849SEmese Revfy intel_dvo_dev_ops| 421379404849SEmese Revfy item_operations| 421479404849SEmese Revfy iwl_ops| 421579404849SEmese Revfy kgdb_arch| 421679404849SEmese Revfy kgdb_io| 421779404849SEmese Revfy kset_uevent_ops| 421879404849SEmese Revfy lock_manager_operations| 421979404849SEmese Revfy microcode_ops| 422079404849SEmese Revfy mtrr_ops| 422179404849SEmese Revfy neigh_ops| 422279404849SEmese Revfy nlmsvc_binding| 422379404849SEmese Revfy pci_raw_ops| 422479404849SEmese Revfy pipe_buf_operations| 422579404849SEmese Revfy platform_hibernation_ops| 422679404849SEmese Revfy platform_suspend_ops| 422779404849SEmese Revfy proto_ops| 422879404849SEmese Revfy rpc_pipe_ops| 422979404849SEmese Revfy seq_operations| 423079404849SEmese Revfy snd_ac97_build_ops| 423179404849SEmese Revfy soc_pcmcia_socket_ops| 423279404849SEmese Revfy stacktrace_ops| 423379404849SEmese Revfy sysfs_ops| 423479404849SEmese Revfy tty_operations| 423579404849SEmese Revfy usb_mon_operations| 423679404849SEmese Revfy wd_ops}x; 42376903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 423879404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4239000d1cc1SJoe Perches WARN("CONST_STRUCT", 4240000d1cc1SJoe Perches "struct $1 should normally be const\n" . 42416903ffb2SAndy Whitcroft $herecurr); 42422b6db5cbSAndy Whitcroft } 4243773647a0SAndy Whitcroft 4244773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4245773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4246773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4247c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4248c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4249171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4250171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4251171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4252773647a0SAndy Whitcroft { 4253000d1cc1SJoe Perches WARN("NR_CPUS", 4254000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4255773647a0SAndy Whitcroft } 42569c9ba34eSAndy Whitcroft 425752ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 425852ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 425952ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 426052ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 426152ea8506SJoe Perches } 426252ea8506SJoe Perches 42639c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 42649c9ba34eSAndy Whitcroft my $string; 42659c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 42669c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 42672a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 42689c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4269000d1cc1SJoe Perches WARN("PRINTF_L", 4270000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 42719c9ba34eSAndy Whitcroft last; 42729c9ba34eSAndy Whitcroft } 42739c9ba34eSAndy Whitcroft } 4274691d77b6SAndy Whitcroft 4275691d77b6SAndy Whitcroft# whine mightly about in_atomic 4276691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4277691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4278000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4279000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4280f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4281000d1cc1SJoe Perches WARN("IN_ATOMIC", 4282000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4283691d77b6SAndy Whitcroft } 4284691d77b6SAndy Whitcroft } 42851704f47bSPeter Zijlstra 42861704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 42871704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 42881704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 42891704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 42901704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 42911704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4292000d1cc1SJoe Perches ERROR("LOCKDEP", 4293000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 42941704f47bSPeter Zijlstra } 42951704f47bSPeter Zijlstra } 429688f8831cSDave Jones 429788f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 429888f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4299000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4300000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 430188f8831cSDave Jones } 430213214adfSAndy Whitcroft } 430313214adfSAndy Whitcroft 430413214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 430513214adfSAndy Whitcroft # so just keep quiet. 430613214adfSAndy Whitcroft if ($#rawlines == -1) { 430713214adfSAndy Whitcroft exit(0); 43080a920b5bSAndy Whitcroft } 43090a920b5bSAndy Whitcroft 43108905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 43118905a67cSAndy Whitcroft # things that appear to be patches. 43128905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 43138905a67cSAndy Whitcroft exit(0); 43148905a67cSAndy Whitcroft } 43158905a67cSAndy Whitcroft 43168905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 43178905a67cSAndy Whitcroft # just keep quiet. 43188905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 43198905a67cSAndy Whitcroft exit(0); 43208905a67cSAndy Whitcroft } 43218905a67cSAndy Whitcroft 43228905a67cSAndy Whitcroft if (!$is_patch) { 4323000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4324000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 43250a920b5bSAndy Whitcroft } 43260a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4327000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4328000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 43290a920b5bSAndy Whitcroft } 43300a920b5bSAndy Whitcroft 4331f0a594c1SAndy Whitcroft print report_dump(); 433213214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 433313214adfSAndy Whitcroft print "$filename " if ($summary_file); 43346c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 43356c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 43366c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 43378905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 43386c72ffaaSAndy Whitcroft } 43398905a67cSAndy Whitcroft 4340d2c0a235SAndy Whitcroft if ($quiet == 0) { 4341d1fe9c09SJoe Perches 4342d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4343d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4344d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4345d1fe9c09SJoe Perches } 4346d1fe9c09SJoe Perches 4347d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4348d2c0a235SAndy Whitcroft # then suggest that. 4349d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4350d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4351d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4352b0781216SMike Frysinger $rpt_cleaners = 0; 4353d2c0a235SAndy Whitcroft } 4354d2c0a235SAndy Whitcroft } 4355d2c0a235SAndy Whitcroft 435691bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 435791bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4358000d1cc1SJoe Perches 43593705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 43603705ce5bSJoe Perches my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes"; 43613705ce5bSJoe Perches my $linecount = 0; 43623705ce5bSJoe Perches my $f; 43633705ce5bSJoe Perches 43643705ce5bSJoe Perches open($f, '>', $newfile) 43653705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 43663705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 43673705ce5bSJoe Perches $linecount++; 43683705ce5bSJoe Perches if ($file) { 43693705ce5bSJoe Perches if ($linecount > 3) { 43703705ce5bSJoe Perches $fixed_line =~ s/^\+//; 43713705ce5bSJoe Perches print $f $fixed_line. "\n"; 43723705ce5bSJoe Perches } 43733705ce5bSJoe Perches } else { 43743705ce5bSJoe Perches print $f $fixed_line . "\n"; 43753705ce5bSJoe Perches } 43763705ce5bSJoe Perches } 43773705ce5bSJoe Perches close($f); 43783705ce5bSJoe Perches 43793705ce5bSJoe Perches if (!$quiet) { 43803705ce5bSJoe Perches print << "EOM"; 43813705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 43823705ce5bSJoe Perches 43833705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 43843705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 43853705ce5bSJoe Perches 43863705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 43873705ce5bSJoe PerchesNo warranties, expressed or implied... 43883705ce5bSJoe Perches 43893705ce5bSJoe PerchesEOM 43903705ce5bSJoe Perches } 43913705ce5bSJoe Perches } 43923705ce5bSJoe Perches 43930a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4394c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 43950a920b5bSAndy Whitcroft } 43960a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4397000d1cc1SJoe Perches print << "EOM"; 4398000d1cc1SJoe Perches$vname has style problems, please review. 4399000d1cc1SJoe Perches 4400000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4401000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4402000d1cc1SJoe PerchesEOM 44030a920b5bSAndy Whitcroft } 440413214adfSAndy Whitcroft 44050a920b5bSAndy Whitcroft return $clean; 44060a920b5bSAndy Whitcroft} 4407