10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 9c707a81dSJoe Perchesuse POSIX; 100a920b5bSAndy Whitcroft 110a920b5bSAndy Whitcroftmy $P = $0; 1200df344fSAndy Whitcroft$P =~ s@.*/@@g; 130a920b5bSAndy Whitcroft 14000d1cc1SJoe Perchesmy $V = '0.32'; 150a920b5bSAndy Whitcroft 160a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $quiet = 0; 190a920b5bSAndy Whitcroftmy $tree = 1; 200a920b5bSAndy Whitcroftmy $chk_signoff = 1; 210a920b5bSAndy Whitcroftmy $chk_patch = 1; 22773647a0SAndy Whitcroftmy $tst_only; 236c72ffaaSAndy Whitcroftmy $emacs = 0; 248905a67cSAndy Whitcroftmy $terse = 0; 256c72ffaaSAndy Whitcroftmy $file = 0; 266c72ffaaSAndy Whitcroftmy $check = 0; 278905a67cSAndy Whitcroftmy $summary = 1; 288905a67cSAndy Whitcroftmy $mailback = 0; 2913214adfSAndy Whitcroftmy $summary_file = 0; 30000d1cc1SJoe Perchesmy $show_types = 0; 313705ce5bSJoe Perchesmy $fix = 0; 329624b8d6SJoe Perchesmy $fix_inplace = 0; 336c72ffaaSAndy Whitcroftmy $root; 34c2fdda0dSAndy Whitcroftmy %debug; 353445686aSJoe Perchesmy %camelcase = (); 3691bfe484SJoe Perchesmy %use_type = (); 3791bfe484SJoe Perchesmy @use = (); 3891bfe484SJoe Perchesmy %ignore_type = (); 39000d1cc1SJoe Perchesmy @ignore = (); 4077f5b10aSHannes Edermy $help = 0; 41000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 426cd7f386SJoe Perchesmy $max_line_length = 80; 43d62a201fSDave Hansenmy $ignore_perl_version = 0; 44d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4577f5b10aSHannes Eder 4677f5b10aSHannes Edersub help { 4777f5b10aSHannes Eder my ($exitcode) = @_; 4877f5b10aSHannes Eder 4977f5b10aSHannes Eder print << "EOM"; 5077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5177f5b10aSHannes EderVersion: $V 5277f5b10aSHannes Eder 5377f5b10aSHannes EderOptions: 5477f5b10aSHannes Eder -q, --quiet quiet 5577f5b10aSHannes Eder --no-tree run without a kernel tree 5677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5877f5b10aSHannes Eder --emacs emacs compile window format 5977f5b10aSHannes Eder --terse one line per report 6077f5b10aSHannes Eder -f, --file treat FILE as regular source file 6177f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6291bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 63000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 646cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 65000d1cc1SJoe Perches --show-types show the message "types" in the output 6677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6777f5b10aSHannes Eder --no-summary suppress the per-file summary 6877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6977f5b10aSHannes Eder --summary-file include the filename in summary 7077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7277f5b10aSHannes Eder is all off) 7377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7477f5b10aSHannes Eder literally 753705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 763705ce5bSJoe Perches If correctable single-line errors exist, create 773705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 783705ce5bSJoe Perches with potential errors corrected to the preferred 793705ce5bSJoe Perches checkpatch style 809624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 819624b8d6SJoe Perches Is the same as --fix, but overwrites the input 829624b8d6SJoe Perches file. It's your fault if there's no backup or git 83d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 84d62a201fSDave Hansen runtime errors. 8577f5b10aSHannes Eder -h, --help, --version display this help and exit 8677f5b10aSHannes Eder 8777f5b10aSHannes EderWhen FILE is - read standard input. 8877f5b10aSHannes EderEOM 8977f5b10aSHannes Eder 9077f5b10aSHannes Eder exit($exitcode); 9177f5b10aSHannes Eder} 9277f5b10aSHannes Eder 93000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 94000d1cc1SJoe Perchesif (-f $conf) { 95000d1cc1SJoe Perches my @conf_args; 96000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 97000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 98000d1cc1SJoe Perches 99000d1cc1SJoe Perches while (<$conffile>) { 100000d1cc1SJoe Perches my $line = $_; 101000d1cc1SJoe Perches 102000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 103000d1cc1SJoe Perches $line =~ s/^\s*//g; 104000d1cc1SJoe Perches $line =~ s/\s+/ /g; 105000d1cc1SJoe Perches 106000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 107000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 108000d1cc1SJoe Perches 109000d1cc1SJoe Perches my @words = split(" ", $line); 110000d1cc1SJoe Perches foreach my $word (@words) { 111000d1cc1SJoe Perches last if ($word =~ m/^#/); 112000d1cc1SJoe Perches push (@conf_args, $word); 113000d1cc1SJoe Perches } 114000d1cc1SJoe Perches } 115000d1cc1SJoe Perches close($conffile); 116000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 117000d1cc1SJoe Perches} 118000d1cc1SJoe Perches 1190a920b5bSAndy WhitcroftGetOptions( 1206c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1210a920b5bSAndy Whitcroft 'tree!' => \$tree, 1220a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1230a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1246c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1258905a67cSAndy Whitcroft 'terse!' => \$terse, 12677f5b10aSHannes Eder 'f|file!' => \$file, 1276c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1286c72ffaaSAndy Whitcroft 'strict!' => \$check, 129000d1cc1SJoe Perches 'ignore=s' => \@ignore, 13091bfe484SJoe Perches 'types=s' => \@use, 131000d1cc1SJoe Perches 'show-types!' => \$show_types, 1326cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1336c72ffaaSAndy Whitcroft 'root=s' => \$root, 1348905a67cSAndy Whitcroft 'summary!' => \$summary, 1358905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1373705ce5bSJoe Perches 'fix!' => \$fix, 1389624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 139d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 140c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 141773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 14277f5b10aSHannes Eder 'h|help' => \$help, 14377f5b10aSHannes Eder 'version' => \$help 14477f5b10aSHannes Eder) or help(1); 14577f5b10aSHannes Eder 14677f5b10aSHannes Ederhelp(0) if ($help); 1470a920b5bSAndy Whitcroft 1489624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1499624b8d6SJoe Perches 1500a920b5bSAndy Whitcroftmy $exit = 0; 1510a920b5bSAndy Whitcroft 152d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 153d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 154d62a201fSDave Hansen if (!$ignore_perl_version) { 155d62a201fSDave Hansen exit(1); 156d62a201fSDave Hansen } 157d62a201fSDave Hansen} 158d62a201fSDave Hansen 1590a920b5bSAndy Whitcroftif ($#ARGV < 0) { 16077f5b10aSHannes Eder print "$P: no input files\n"; 1610a920b5bSAndy Whitcroft exit(1); 1620a920b5bSAndy Whitcroft} 1630a920b5bSAndy Whitcroft 16491bfe484SJoe Perchessub hash_save_array_words { 16591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 16691bfe484SJoe Perches 16791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 16891bfe484SJoe Perches foreach my $word (@array) { 169000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 170000d1cc1SJoe Perches $word =~ s/^\s*//g; 171000d1cc1SJoe Perches $word =~ s/\s+/ /g; 172000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 173000d1cc1SJoe Perches 174000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 175000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 176000d1cc1SJoe Perches 17791bfe484SJoe Perches $hashRef->{$word}++; 178000d1cc1SJoe Perches } 17991bfe484SJoe Perches} 18091bfe484SJoe Perches 18191bfe484SJoe Perchessub hash_show_words { 18291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 18391bfe484SJoe Perches 18458cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 18591bfe484SJoe Perches print "NOTE: $prefix message types:"; 18658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 18791bfe484SJoe Perches print " $word"; 18891bfe484SJoe Perches } 18991bfe484SJoe Perches print "\n\n"; 19091bfe484SJoe Perches } 19191bfe484SJoe Perches} 19291bfe484SJoe Perches 19391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 19491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 195000d1cc1SJoe Perches 196c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 197c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1987429c690SAndy Whitcroftmy $dbg_type = 0; 199a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 200c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 20121caa13cSAndy Whitcroft ## no critic 20221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 20321caa13cSAndy Whitcroft die "$@" if ($@); 204c2fdda0dSAndy Whitcroft} 205c2fdda0dSAndy Whitcroft 206d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 207d2c0a235SAndy Whitcroft 2088905a67cSAndy Whitcroftif ($terse) { 2098905a67cSAndy Whitcroft $emacs = 1; 2108905a67cSAndy Whitcroft $quiet++; 2118905a67cSAndy Whitcroft} 2128905a67cSAndy Whitcroft 2136c72ffaaSAndy Whitcroftif ($tree) { 2146c72ffaaSAndy Whitcroft if (defined $root) { 2156c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2166c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2176c72ffaaSAndy Whitcroft } 2186c72ffaaSAndy Whitcroft } else { 2196c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2206c72ffaaSAndy Whitcroft $root = '.'; 2216c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2226c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2236c72ffaaSAndy Whitcroft $root = $1; 2246c72ffaaSAndy Whitcroft } 2256c72ffaaSAndy Whitcroft } 2266c72ffaaSAndy Whitcroft 2276c72ffaaSAndy Whitcroft if (!defined $root) { 2280a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2290a920b5bSAndy Whitcroft exit(2); 2300a920b5bSAndy Whitcroft } 2316c72ffaaSAndy Whitcroft} 2326c72ffaaSAndy Whitcroft 2336c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2346c72ffaaSAndy Whitcroft 2352ceb532bSAndy Whitcroftour $Ident = qr{ 2362ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2372ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2382ceb532bSAndy Whitcroft }x; 2396c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2406c72ffaaSAndy Whitcroftour $Sparse = qr{ 2416c72ffaaSAndy Whitcroft __user| 2426c72ffaaSAndy Whitcroft __kernel| 2436c72ffaaSAndy Whitcroft __force| 2446c72ffaaSAndy Whitcroft __iomem| 2456c72ffaaSAndy Whitcroft __must_check| 2466c72ffaaSAndy Whitcroft __init_refok| 247417495edSAndy Whitcroft __kprobes| 248165e72a6SSven Eckelmann __ref| 249165e72a6SSven Eckelmann __rcu 2506c72ffaaSAndy Whitcroft }x; 251e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 252e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 253e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 254e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 255e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2568716de38SJoe Perches 25752131292SWolfram Sang# Notes to $Attribute: 25852131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2596c72ffaaSAndy Whitcroftour $Attribute = qr{ 2606c72ffaaSAndy Whitcroft const| 26103f1df7dSJoe Perches __percpu| 26203f1df7dSJoe Perches __nocast| 26303f1df7dSJoe Perches __safe| 26403f1df7dSJoe Perches __bitwise__| 26503f1df7dSJoe Perches __packed__| 26603f1df7dSJoe Perches __packed2__| 26703f1df7dSJoe Perches __naked| 26803f1df7dSJoe Perches __maybe_unused| 26903f1df7dSJoe Perches __always_unused| 27003f1df7dSJoe Perches __noreturn| 27103f1df7dSJoe Perches __used| 27203f1df7dSJoe Perches __cold| 27303f1df7dSJoe Perches __noclone| 27403f1df7dSJoe Perches __deprecated| 2756c72ffaaSAndy Whitcroft __read_mostly| 2766c72ffaaSAndy Whitcroft __kprobes| 2778716de38SJoe Perches $InitAttribute| 27824e1d81aSAndy Whitcroft ____cacheline_aligned| 27924e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2805fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2815fe3af11SAndy Whitcroft __weak 2826c72ffaaSAndy Whitcroft }x; 283c45dcabdSAndy Whitcroftour $Modifier; 2846c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2856c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2866c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2876c72ffaaSAndy Whitcroft 28895e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 28995e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 29095e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 29195e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 292326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 293326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 294326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 29574349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 29695e2c602SJoe Perchesour $Constant = qr{$Float|$Binary|$Hex|$Int}; 297326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 29886f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 29923f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3006c72ffaaSAndy Whitcroftour $Operators = qr{ 3016c72ffaaSAndy Whitcroft <=|>=|==|!=| 3026c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 30323f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3046c72ffaaSAndy Whitcroft }x; 3056c72ffaaSAndy Whitcroft 3068905a67cSAndy Whitcroftour $NonptrType; 3078716de38SJoe Perchesour $NonptrTypeWithAttr; 3088905a67cSAndy Whitcroftour $Type; 3098905a67cSAndy Whitcroftour $Declare; 3108905a67cSAndy Whitcroft 31115662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 31215662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 313171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 314171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 315171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 316171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 317171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 318171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 319171ae1a4SAndy Whitcroft}x; 320171ae1a4SAndy Whitcroft 32115662b3eSJoe Perchesour $UTF8 = qr{ 32215662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 32315662b3eSJoe Perches | $NON_ASCII_UTF8 32415662b3eSJoe Perches}x; 32515662b3eSJoe Perches 3268ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 327fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3288ed22cadSAndy Whitcroft atomic_t 3298ed22cadSAndy Whitcroft)}; 3308ed22cadSAndy Whitcroft 331691e669bSJoe Perchesour $logFunctions = qr{(?x: 3326e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3337d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3346e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 335b0531722SJoe Perches panic| 33606668727SJoe Perches MODULE_[A-Z_]+| 33706668727SJoe Perches seq_vprintf|seq_printf|seq_puts 338691e669bSJoe Perches)}; 339691e669bSJoe Perches 34020112475SJoe Perchesour $signature_tags = qr{(?xi: 34120112475SJoe Perches Signed-off-by:| 34220112475SJoe Perches Acked-by:| 34320112475SJoe Perches Tested-by:| 34420112475SJoe Perches Reviewed-by:| 34520112475SJoe Perches Reported-by:| 3468543ae12SMugunthan V N Suggested-by:| 34720112475SJoe Perches To:| 34820112475SJoe Perches Cc: 34920112475SJoe Perches)}; 35020112475SJoe Perches 3518905a67cSAndy Whitcroftour @typeList = ( 3528905a67cSAndy Whitcroft qr{void}, 353c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 354c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 355c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 356c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 357c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 358c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 359c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3608905a67cSAndy Whitcroft qr{unsigned}, 3618905a67cSAndy Whitcroft qr{float}, 3628905a67cSAndy Whitcroft qr{double}, 3638905a67cSAndy Whitcroft qr{bool}, 3648905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3658905a67cSAndy Whitcroft qr{union\s+$Ident}, 3668905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3678905a67cSAndy Whitcroft qr{${Ident}_t}, 3688905a67cSAndy Whitcroft qr{${Ident}_handler}, 3698905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3708905a67cSAndy Whitcroft); 3718716de38SJoe Perchesour @typeListWithAttr = ( 3728716de38SJoe Perches @typeList, 3738716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 3748716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 3758716de38SJoe Perches); 3768716de38SJoe Perches 377c45dcabdSAndy Whitcroftour @modifierList = ( 378c45dcabdSAndy Whitcroft qr{fastcall}, 379c45dcabdSAndy Whitcroft); 3808905a67cSAndy Whitcroft 3817840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3827840a94cSWolfram Sang irq| 3837840a94cSWolfram Sang memory 3847840a94cSWolfram Sang)}; 3857840a94cSWolfram Sang# memory.h: ARM has a custom one 3867840a94cSWolfram Sang 3878905a67cSAndy Whitcroftsub build_types { 388d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 389d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 3908716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 391c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3928905a67cSAndy Whitcroft $NonptrType = qr{ 393d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 394cf655043SAndy Whitcroft (?: 3956b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 3968ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 397c45dcabdSAndy Whitcroft (?:${all}\b) 398cf655043SAndy Whitcroft ) 399c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 4008905a67cSAndy Whitcroft }x; 4018716de38SJoe Perches $NonptrTypeWithAttr = qr{ 4028716de38SJoe Perches (?:$Modifier\s+|const\s+)* 4038716de38SJoe Perches (?: 4048716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 4058716de38SJoe Perches (?:$typeTypedefs\b)| 4068716de38SJoe Perches (?:${allWithAttr}\b) 4078716de38SJoe Perches ) 4088716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4098716de38SJoe Perches }x; 4108905a67cSAndy Whitcroft $Type = qr{ 411c45dcabdSAndy Whitcroft $NonptrType 412b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 413c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 4148905a67cSAndy Whitcroft }x; 4158905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 4168905a67cSAndy Whitcroft} 4178905a67cSAndy Whitcroftbuild_types(); 4186c72ffaaSAndy Whitcroft 4197d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 420d1fe9c09SJoe Perches 421d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 422d1fe9c09SJoe Perches# requires at least perl version v5.10.0 423d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 424d1fe9c09SJoe Perches 425d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 426d1fe9c09SJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; 427d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 4287d2367afSJoe Perches 4297d2367afSJoe Perchessub deparenthesize { 4307d2367afSJoe Perches my ($string) = @_; 4317d2367afSJoe Perches return "" if (!defined($string)); 4327d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 4337d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 4347d2367afSJoe Perches $string =~ s@\s+@ @g; 4357d2367afSJoe Perches return $string; 4367d2367afSJoe Perches} 4377d2367afSJoe Perches 4383445686aSJoe Perchessub seed_camelcase_file { 4393445686aSJoe Perches my ($file) = @_; 4403445686aSJoe Perches 4413445686aSJoe Perches return if (!(-f $file)); 4423445686aSJoe Perches 4433445686aSJoe Perches local $/; 4443445686aSJoe Perches 4453445686aSJoe Perches open(my $include_file, '<', "$file") 4463445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4473445686aSJoe Perches my $text = <$include_file>; 4483445686aSJoe Perches close($include_file); 4493445686aSJoe Perches 4503445686aSJoe Perches my @lines = split('\n', $text); 4513445686aSJoe Perches 4523445686aSJoe Perches foreach my $line (@lines) { 4533445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4543445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4553445686aSJoe Perches $camelcase{$1} = 1; 45611ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 45711ea516aSJoe Perches $camelcase{$1} = 1; 45811ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 4593445686aSJoe Perches $camelcase{$1} = 1; 4603445686aSJoe Perches } 4613445686aSJoe Perches } 4623445686aSJoe Perches} 4633445686aSJoe Perches 4643445686aSJoe Perchesmy $camelcase_seeded = 0; 4653445686aSJoe Perchessub seed_camelcase_includes { 4663445686aSJoe Perches return if ($camelcase_seeded); 4673445686aSJoe Perches 4683445686aSJoe Perches my $files; 469c707a81dSJoe Perches my $camelcase_cache = ""; 470c707a81dSJoe Perches my @include_files = (); 471c707a81dSJoe Perches 472c707a81dSJoe Perches $camelcase_seeded = 1; 473351b2a1fSJoe Perches 4743445686aSJoe Perches if (-d ".git") { 475351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 476351b2a1fSJoe Perches chomp $git_last_include_commit; 477c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 478c707a81dSJoe Perches } else { 479c707a81dSJoe Perches my $last_mod_date = 0; 480c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 481c707a81dSJoe Perches @include_files = split('\n', $files); 482c707a81dSJoe Perches foreach my $file (@include_files) { 483c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 484c707a81dSJoe Perches localtime((stat $file)[9])); 485c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 486c707a81dSJoe Perches } 487c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 488c707a81dSJoe Perches } 489c707a81dSJoe Perches 490c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 491c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 492c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 493351b2a1fSJoe Perches while (<$camelcase_file>) { 494351b2a1fSJoe Perches chomp; 495351b2a1fSJoe Perches $camelcase{$_} = 1; 496351b2a1fSJoe Perches } 497351b2a1fSJoe Perches close($camelcase_file); 498351b2a1fSJoe Perches 499351b2a1fSJoe Perches return; 500351b2a1fSJoe Perches } 501c707a81dSJoe Perches 502c707a81dSJoe Perches if (-d ".git") { 503c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 504c707a81dSJoe Perches @include_files = split('\n', $files); 5053445686aSJoe Perches } 506c707a81dSJoe Perches 5073445686aSJoe Perches foreach my $file (@include_files) { 5083445686aSJoe Perches seed_camelcase_file($file); 5093445686aSJoe Perches } 510351b2a1fSJoe Perches 511c707a81dSJoe Perches if ($camelcase_cache ne "") { 512351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 513c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 514c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 515351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 516351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 517351b2a1fSJoe Perches } 518351b2a1fSJoe Perches close($camelcase_file); 519351b2a1fSJoe Perches } 5203445686aSJoe Perches} 5213445686aSJoe Perches 5226c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5230a920b5bSAndy Whitcroft 52400df344fSAndy Whitcroftmy @rawlines = (); 525c2fdda0dSAndy Whitcroftmy @lines = (); 5263705ce5bSJoe Perchesmy @fixed = (); 527c2fdda0dSAndy Whitcroftmy $vname; 5286c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 52921caa13cSAndy Whitcroft my $FILE; 5306c72ffaaSAndy Whitcroft if ($file) { 53121caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5326c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 53321caa13cSAndy Whitcroft } elsif ($filename eq '-') { 53421caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5356c72ffaaSAndy Whitcroft } else { 53621caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5376c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5386c72ffaaSAndy Whitcroft } 539c2fdda0dSAndy Whitcroft if ($filename eq '-') { 540c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 541c2fdda0dSAndy Whitcroft } else { 542c2fdda0dSAndy Whitcroft $vname = $filename; 543c2fdda0dSAndy Whitcroft } 54421caa13cSAndy Whitcroft while (<$FILE>) { 5450a920b5bSAndy Whitcroft chomp; 54600df344fSAndy Whitcroft push(@rawlines, $_); 5476c72ffaaSAndy Whitcroft } 54821caa13cSAndy Whitcroft close($FILE); 549c2fdda0dSAndy Whitcroft if (!process($filename)) { 5500a920b5bSAndy Whitcroft $exit = 1; 5510a920b5bSAndy Whitcroft } 55200df344fSAndy Whitcroft @rawlines = (); 55313214adfSAndy Whitcroft @lines = (); 5543705ce5bSJoe Perches @fixed = (); 5550a920b5bSAndy Whitcroft} 5560a920b5bSAndy Whitcroft 5570a920b5bSAndy Whitcroftexit($exit); 5580a920b5bSAndy Whitcroft 5590a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5606c72ffaaSAndy Whitcroft my ($root) = @_; 5616c72ffaaSAndy Whitcroft 5626c72ffaaSAndy Whitcroft my @tree_check = ( 5636c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5646c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5656c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5666c72ffaaSAndy Whitcroft ); 5676c72ffaaSAndy Whitcroft 5686c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 5696c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 5700a920b5bSAndy Whitcroft return 0; 5710a920b5bSAndy Whitcroft } 5726c72ffaaSAndy Whitcroft } 5736c72ffaaSAndy Whitcroft return 1; 5746c72ffaaSAndy Whitcroft} 5750a920b5bSAndy Whitcroft 57620112475SJoe Perchessub parse_email { 57720112475SJoe Perches my ($formatted_email) = @_; 57820112475SJoe Perches 57920112475SJoe Perches my $name = ""; 58020112475SJoe Perches my $address = ""; 58120112475SJoe Perches my $comment = ""; 58220112475SJoe Perches 58320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 58420112475SJoe Perches $name = $1; 58520112475SJoe Perches $address = $2; 58620112475SJoe Perches $comment = $3 if defined $3; 58720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 58820112475SJoe Perches $address = $1; 58920112475SJoe Perches $comment = $2 if defined $2; 59020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 59120112475SJoe Perches $address = $1; 59220112475SJoe Perches $comment = $2 if defined $2; 59320112475SJoe Perches $formatted_email =~ s/$address.*$//; 59420112475SJoe Perches $name = $formatted_email; 5953705ce5bSJoe Perches $name = trim($name); 59620112475SJoe Perches $name =~ s/^\"|\"$//g; 59720112475SJoe Perches # If there's a name left after stripping spaces and 59820112475SJoe Perches # leading quotes, and the address doesn't have both 59920112475SJoe Perches # leading and trailing angle brackets, the address 60020112475SJoe Perches # is invalid. ie: 60120112475SJoe Perches # "joe smith [email protected]" bad 60220112475SJoe Perches # "joe smith <[email protected]" bad 60320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 60420112475SJoe Perches $name = ""; 60520112475SJoe Perches $address = ""; 60620112475SJoe Perches $comment = ""; 60720112475SJoe Perches } 60820112475SJoe Perches } 60920112475SJoe Perches 6103705ce5bSJoe Perches $name = trim($name); 61120112475SJoe Perches $name =~ s/^\"|\"$//g; 6123705ce5bSJoe Perches $address = trim($address); 61320112475SJoe Perches $address =~ s/^\<|\>$//g; 61420112475SJoe Perches 61520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 61620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 61720112475SJoe Perches $name = "\"$name\""; 61820112475SJoe Perches } 61920112475SJoe Perches 62020112475SJoe Perches return ($name, $address, $comment); 62120112475SJoe Perches} 62220112475SJoe Perches 62320112475SJoe Perchessub format_email { 62420112475SJoe Perches my ($name, $address) = @_; 62520112475SJoe Perches 62620112475SJoe Perches my $formatted_email; 62720112475SJoe Perches 6283705ce5bSJoe Perches $name = trim($name); 62920112475SJoe Perches $name =~ s/^\"|\"$//g; 6303705ce5bSJoe Perches $address = trim($address); 63120112475SJoe Perches 63220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 63320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 63420112475SJoe Perches $name = "\"$name\""; 63520112475SJoe Perches } 63620112475SJoe Perches 63720112475SJoe Perches if ("$name" eq "") { 63820112475SJoe Perches $formatted_email = "$address"; 63920112475SJoe Perches } else { 64020112475SJoe Perches $formatted_email = "$name <$address>"; 64120112475SJoe Perches } 64220112475SJoe Perches 64320112475SJoe Perches return $formatted_email; 64420112475SJoe Perches} 64520112475SJoe Perches 646000d1cc1SJoe Perchessub which_conf { 647000d1cc1SJoe Perches my ($conf) = @_; 648000d1cc1SJoe Perches 649000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 650000d1cc1SJoe Perches if (-e "$path/$conf") { 651000d1cc1SJoe Perches return "$path/$conf"; 652000d1cc1SJoe Perches } 653000d1cc1SJoe Perches } 654000d1cc1SJoe Perches 655000d1cc1SJoe Perches return ""; 656000d1cc1SJoe Perches} 657000d1cc1SJoe Perches 6580a920b5bSAndy Whitcroftsub expand_tabs { 6590a920b5bSAndy Whitcroft my ($str) = @_; 6600a920b5bSAndy Whitcroft 6610a920b5bSAndy Whitcroft my $res = ''; 6620a920b5bSAndy Whitcroft my $n = 0; 6630a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6640a920b5bSAndy Whitcroft if ($c eq "\t") { 6650a920b5bSAndy Whitcroft $res .= ' '; 6660a920b5bSAndy Whitcroft $n++; 6670a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6680a920b5bSAndy Whitcroft $res .= ' '; 6690a920b5bSAndy Whitcroft } 6700a920b5bSAndy Whitcroft next; 6710a920b5bSAndy Whitcroft } 6720a920b5bSAndy Whitcroft $res .= $c; 6730a920b5bSAndy Whitcroft $n++; 6740a920b5bSAndy Whitcroft } 6750a920b5bSAndy Whitcroft 6760a920b5bSAndy Whitcroft return $res; 6770a920b5bSAndy Whitcroft} 6786c72ffaaSAndy Whitcroftsub copy_spacing { 679773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 6806c72ffaaSAndy Whitcroft return $res; 6816c72ffaaSAndy Whitcroft} 6820a920b5bSAndy Whitcroft 6834a0df2efSAndy Whitcroftsub line_stats { 6844a0df2efSAndy Whitcroft my ($line) = @_; 6854a0df2efSAndy Whitcroft 6864a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 6874a0df2efSAndy Whitcroft $line =~ s/^.//; 6884a0df2efSAndy Whitcroft $line = expand_tabs($line); 6894a0df2efSAndy Whitcroft 6904a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 6914a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 6924a0df2efSAndy Whitcroft 6934a0df2efSAndy Whitcroft return (length($line), length($white)); 6944a0df2efSAndy Whitcroft} 6954a0df2efSAndy Whitcroft 696773647a0SAndy Whitcroftmy $sanitise_quote = ''; 697773647a0SAndy Whitcroft 698773647a0SAndy Whitcroftsub sanitise_line_reset { 699773647a0SAndy Whitcroft my ($in_comment) = @_; 700773647a0SAndy Whitcroft 701773647a0SAndy Whitcroft if ($in_comment) { 702773647a0SAndy Whitcroft $sanitise_quote = '*/'; 703773647a0SAndy Whitcroft } else { 704773647a0SAndy Whitcroft $sanitise_quote = ''; 705773647a0SAndy Whitcroft } 706773647a0SAndy Whitcroft} 70700df344fSAndy Whitcroftsub sanitise_line { 70800df344fSAndy Whitcroft my ($line) = @_; 70900df344fSAndy Whitcroft 71000df344fSAndy Whitcroft my $res = ''; 71100df344fSAndy Whitcroft my $l = ''; 71200df344fSAndy Whitcroft 713c2fdda0dSAndy Whitcroft my $qlen = 0; 714773647a0SAndy Whitcroft my $off = 0; 715773647a0SAndy Whitcroft my $c; 71600df344fSAndy Whitcroft 717773647a0SAndy Whitcroft # Always copy over the diff marker. 718773647a0SAndy Whitcroft $res = substr($line, 0, 1); 719773647a0SAndy Whitcroft 720773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 721773647a0SAndy Whitcroft $c = substr($line, $off, 1); 722773647a0SAndy Whitcroft 723773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 724773647a0SAndy Whitcroft # and end, all to $;. 725773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 726773647a0SAndy Whitcroft $sanitise_quote = '*/'; 727773647a0SAndy Whitcroft 728773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 729773647a0SAndy Whitcroft $off++; 73000df344fSAndy Whitcroft next; 731773647a0SAndy Whitcroft } 73281bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 733773647a0SAndy Whitcroft $sanitise_quote = ''; 734773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 735773647a0SAndy Whitcroft $off++; 736773647a0SAndy Whitcroft next; 737773647a0SAndy Whitcroft } 738113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 739113f04a8SDaniel Walker $sanitise_quote = '//'; 740113f04a8SDaniel Walker 741113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 742113f04a8SDaniel Walker $off++; 743113f04a8SDaniel Walker next; 744113f04a8SDaniel Walker } 745773647a0SAndy Whitcroft 746773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 747773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 748773647a0SAndy Whitcroft $c eq "\\") { 749773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 750773647a0SAndy Whitcroft $off++; 751773647a0SAndy Whitcroft next; 752773647a0SAndy Whitcroft } 753773647a0SAndy Whitcroft # Regular quotes. 754773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 755773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 756773647a0SAndy Whitcroft $sanitise_quote = $c; 757773647a0SAndy Whitcroft 758773647a0SAndy Whitcroft substr($res, $off, 1, $c); 759773647a0SAndy Whitcroft next; 760773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 761773647a0SAndy Whitcroft $sanitise_quote = ''; 76200df344fSAndy Whitcroft } 76300df344fSAndy Whitcroft } 764773647a0SAndy Whitcroft 765fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 766773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 767773647a0SAndy Whitcroft substr($res, $off, 1, $;); 768113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 769113f04a8SDaniel Walker substr($res, $off, 1, $;); 770773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 771773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 77200df344fSAndy Whitcroft } else { 773773647a0SAndy Whitcroft substr($res, $off, 1, $c); 77400df344fSAndy Whitcroft } 775c2fdda0dSAndy Whitcroft } 776c2fdda0dSAndy Whitcroft 777113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 778113f04a8SDaniel Walker $sanitise_quote = ''; 779113f04a8SDaniel Walker } 780113f04a8SDaniel Walker 781c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 782c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 783c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 784c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 785c2fdda0dSAndy Whitcroft 786c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 787c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 788c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 789c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 790c2fdda0dSAndy Whitcroft } 791c2fdda0dSAndy Whitcroft 79200df344fSAndy Whitcroft return $res; 79300df344fSAndy Whitcroft} 79400df344fSAndy Whitcroft 795a6962d72SJoe Perchessub get_quoted_string { 796a6962d72SJoe Perches my ($line, $rawline) = @_; 797a6962d72SJoe Perches 798a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 799a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 800a6962d72SJoe Perches} 801a6962d72SJoe Perches 8028905a67cSAndy Whitcroftsub ctx_statement_block { 8038905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8048905a67cSAndy Whitcroft my $line = $linenr - 1; 8058905a67cSAndy Whitcroft my $blk = ''; 8068905a67cSAndy Whitcroft my $soff = $off; 8078905a67cSAndy Whitcroft my $coff = $off - 1; 808773647a0SAndy Whitcroft my $coff_set = 0; 8098905a67cSAndy Whitcroft 81013214adfSAndy Whitcroft my $loff = 0; 81113214adfSAndy Whitcroft 8128905a67cSAndy Whitcroft my $type = ''; 8138905a67cSAndy Whitcroft my $level = 0; 814a2750645SAndy Whitcroft my @stack = (); 815cf655043SAndy Whitcroft my $p; 8168905a67cSAndy Whitcroft my $c; 8178905a67cSAndy Whitcroft my $len = 0; 81813214adfSAndy Whitcroft 81913214adfSAndy Whitcroft my $remainder; 8208905a67cSAndy Whitcroft while (1) { 821a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 822a2750645SAndy Whitcroft 823773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8248905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8258905a67cSAndy Whitcroft # context. 8268905a67cSAndy Whitcroft if ($off >= $len) { 8278905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 828dea33496SAndy Whitcroft last if (!defined $lines[$line]); 829c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 8308905a67cSAndy Whitcroft $remain--; 83113214adfSAndy Whitcroft $loff = $len; 832c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8338905a67cSAndy Whitcroft $len = length($blk); 8348905a67cSAndy Whitcroft $line++; 8358905a67cSAndy Whitcroft last; 8368905a67cSAndy Whitcroft } 8378905a67cSAndy Whitcroft # Bail if there is no further context. 8388905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 83913214adfSAndy Whitcroft if ($off >= $len) { 8408905a67cSAndy Whitcroft last; 8418905a67cSAndy Whitcroft } 842f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 843f74bd194SAndy Whitcroft $level++; 844f74bd194SAndy Whitcroft $type = '#'; 845f74bd194SAndy Whitcroft } 8468905a67cSAndy Whitcroft } 847cf655043SAndy Whitcroft $p = $c; 8488905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 84913214adfSAndy Whitcroft $remainder = substr($blk, $off); 8508905a67cSAndy Whitcroft 851773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8524635f4fbSAndy Whitcroft 8534635f4fbSAndy Whitcroft # Handle nested #if/#else. 8544635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8554635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8564635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8574635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8584635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8594635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8604635f4fbSAndy Whitcroft } 8614635f4fbSAndy Whitcroft 8628905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8638905a67cSAndy Whitcroft # outermost level. 8648905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8658905a67cSAndy Whitcroft last; 8668905a67cSAndy Whitcroft } 8678905a67cSAndy Whitcroft 86813214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 869773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 870773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 871773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 872773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 873773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 874773647a0SAndy Whitcroft $coff_set = 1; 875773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 876773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 87713214adfSAndy Whitcroft } 87813214adfSAndy Whitcroft 8798905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 8808905a67cSAndy Whitcroft $level++; 8818905a67cSAndy Whitcroft $type = '('; 8828905a67cSAndy Whitcroft } 8838905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 8848905a67cSAndy Whitcroft $level--; 8858905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 8868905a67cSAndy Whitcroft 8878905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 8888905a67cSAndy Whitcroft $coff = $off; 889773647a0SAndy Whitcroft $coff_set = 1; 890773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 8918905a67cSAndy Whitcroft } 8928905a67cSAndy Whitcroft } 8938905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 8948905a67cSAndy Whitcroft $level++; 8958905a67cSAndy Whitcroft $type = '{'; 8968905a67cSAndy Whitcroft } 8978905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 8988905a67cSAndy Whitcroft $level--; 8998905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9008905a67cSAndy Whitcroft 9018905a67cSAndy Whitcroft if ($level == 0) { 902b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 903b998e001SPatrick Pannuto $off++; 904b998e001SPatrick Pannuto } 9058905a67cSAndy Whitcroft last; 9068905a67cSAndy Whitcroft } 9078905a67cSAndy Whitcroft } 908f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 909f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 910f74bd194SAndy Whitcroft $level--; 911f74bd194SAndy Whitcroft $type = ''; 912f74bd194SAndy Whitcroft $off++; 913f74bd194SAndy Whitcroft last; 914f74bd194SAndy Whitcroft } 9158905a67cSAndy Whitcroft $off++; 9168905a67cSAndy Whitcroft } 917a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 91813214adfSAndy Whitcroft if ($off == $len) { 919a3bb97a7SAndy Whitcroft $loff = $len + 1; 92013214adfSAndy Whitcroft $line++; 92113214adfSAndy Whitcroft $remain--; 92213214adfSAndy Whitcroft } 9238905a67cSAndy Whitcroft 9248905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9258905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 9268905a67cSAndy Whitcroft 9278905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 9288905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 9298905a67cSAndy Whitcroft 930773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 93113214adfSAndy Whitcroft 93213214adfSAndy Whitcroft return ($statement, $condition, 93313214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 93413214adfSAndy Whitcroft} 93513214adfSAndy Whitcroft 936cf655043SAndy Whitcroftsub statement_lines { 937cf655043SAndy Whitcroft my ($stmt) = @_; 938cf655043SAndy Whitcroft 939cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 940cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 941cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 942cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 943cf655043SAndy Whitcroft 944cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 945cf655043SAndy Whitcroft 946cf655043SAndy Whitcroft return $#stmt_lines + 2; 947cf655043SAndy Whitcroft} 948cf655043SAndy Whitcroft 949cf655043SAndy Whitcroftsub statement_rawlines { 950cf655043SAndy Whitcroft my ($stmt) = @_; 951cf655043SAndy Whitcroft 952cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 953cf655043SAndy Whitcroft 954cf655043SAndy Whitcroft return $#stmt_lines + 2; 955cf655043SAndy Whitcroft} 956cf655043SAndy Whitcroft 957cf655043SAndy Whitcroftsub statement_block_size { 958cf655043SAndy Whitcroft my ($stmt) = @_; 959cf655043SAndy Whitcroft 960cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 961cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 962cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 963cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 964cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 965cf655043SAndy Whitcroft 966cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 967cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 968cf655043SAndy Whitcroft 969cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 970cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 971cf655043SAndy Whitcroft 972cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 973cf655043SAndy Whitcroft return $stmt_lines; 974cf655043SAndy Whitcroft } else { 975cf655043SAndy Whitcroft return $stmt_statements; 976cf655043SAndy Whitcroft } 977cf655043SAndy Whitcroft} 978cf655043SAndy Whitcroft 97913214adfSAndy Whitcroftsub ctx_statement_full { 98013214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 98113214adfSAndy Whitcroft my ($statement, $condition, $level); 98213214adfSAndy Whitcroft 98313214adfSAndy Whitcroft my (@chunks); 98413214adfSAndy Whitcroft 985cf655043SAndy Whitcroft # Grab the first conditional/block pair. 98613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 98713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 988773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 98913214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 990cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 991cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 992cf655043SAndy Whitcroft } 993cf655043SAndy Whitcroft 994cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 995cf655043SAndy Whitcroft # could continue the statement. 996cf655043SAndy Whitcroft for (;;) { 99713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 99813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 999cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1000773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1001cf655043SAndy Whitcroft #print "C: push\n"; 1002cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 100313214adfSAndy Whitcroft } 100413214adfSAndy Whitcroft 100513214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10068905a67cSAndy Whitcroft} 10078905a67cSAndy Whitcroft 10084a0df2efSAndy Whitcroftsub ctx_block_get { 1009f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10104a0df2efSAndy Whitcroft my $line; 10114a0df2efSAndy Whitcroft my $start = $linenr - 1; 10124a0df2efSAndy Whitcroft my $blk = ''; 10134a0df2efSAndy Whitcroft my @o; 10144a0df2efSAndy Whitcroft my @c; 10154a0df2efSAndy Whitcroft my @res = (); 10164a0df2efSAndy Whitcroft 1017f0a594c1SAndy Whitcroft my $level = 0; 10184635f4fbSAndy Whitcroft my @stack = ($level); 101900df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 102000df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 102100df344fSAndy Whitcroft $remain--; 102200df344fSAndy Whitcroft 102300df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10244635f4fbSAndy Whitcroft 10254635f4fbSAndy Whitcroft # Handle nested #if/#else. 102601464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 10274635f4fbSAndy Whitcroft push(@stack, $level); 102801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 10294635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 103001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10314635f4fbSAndy Whitcroft $level = pop(@stack); 10324635f4fbSAndy Whitcroft } 10334635f4fbSAndy Whitcroft 103401464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1035f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1036f0a594c1SAndy Whitcroft if ($off > 0) { 1037f0a594c1SAndy Whitcroft $off--; 1038f0a594c1SAndy Whitcroft next; 1039f0a594c1SAndy Whitcroft } 10404a0df2efSAndy Whitcroft 1041f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1042f0a594c1SAndy Whitcroft $level--; 1043f0a594c1SAndy Whitcroft last if ($level == 0); 1044f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1045f0a594c1SAndy Whitcroft $level++; 1046f0a594c1SAndy Whitcroft } 1047f0a594c1SAndy Whitcroft } 10484a0df2efSAndy Whitcroft 1049f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 105000df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10514a0df2efSAndy Whitcroft } 10524a0df2efSAndy Whitcroft 1053f0a594c1SAndy Whitcroft last if ($level == 0); 10544a0df2efSAndy Whitcroft } 10554a0df2efSAndy Whitcroft 1056f0a594c1SAndy Whitcroft return ($level, @res); 10574a0df2efSAndy Whitcroft} 10584a0df2efSAndy Whitcroftsub ctx_block_outer { 10594a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10604a0df2efSAndy Whitcroft 1061f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1062f0a594c1SAndy Whitcroft return @r; 10634a0df2efSAndy Whitcroft} 10644a0df2efSAndy Whitcroftsub ctx_block { 10654a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10664a0df2efSAndy Whitcroft 1067f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1068f0a594c1SAndy Whitcroft return @r; 1069653d4876SAndy Whitcroft} 1070653d4876SAndy Whitcroftsub ctx_statement { 1071f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1072f0a594c1SAndy Whitcroft 1073f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1074f0a594c1SAndy Whitcroft return @r; 1075f0a594c1SAndy Whitcroft} 1076f0a594c1SAndy Whitcroftsub ctx_block_level { 1077653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1078653d4876SAndy Whitcroft 1079f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 10804a0df2efSAndy Whitcroft} 10819c0ca6f9SAndy Whitcroftsub ctx_statement_level { 10829c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 10839c0ca6f9SAndy Whitcroft 10849c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 10859c0ca6f9SAndy Whitcroft} 10864a0df2efSAndy Whitcroft 10874a0df2efSAndy Whitcroftsub ctx_locate_comment { 10884a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 10894a0df2efSAndy Whitcroft 10904a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1091beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 10924a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 10934a0df2efSAndy Whitcroft 10944a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 10954a0df2efSAndy Whitcroft # comment. 10964a0df2efSAndy Whitcroft my $in_comment = 0; 10974a0df2efSAndy Whitcroft $current_comment = ''; 10984a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 109900df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 110000df344fSAndy Whitcroft #warn " $line\n"; 11014a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11024a0df2efSAndy Whitcroft $in_comment = 1; 11034a0df2efSAndy Whitcroft } 11044a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11054a0df2efSAndy Whitcroft $in_comment = 1; 11064a0df2efSAndy Whitcroft } 11074a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11084a0df2efSAndy Whitcroft $current_comment = ''; 11094a0df2efSAndy Whitcroft } 11104a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11114a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11124a0df2efSAndy Whitcroft $in_comment = 0; 11134a0df2efSAndy Whitcroft } 11144a0df2efSAndy Whitcroft } 11154a0df2efSAndy Whitcroft 11164a0df2efSAndy Whitcroft chomp($current_comment); 11174a0df2efSAndy Whitcroft return($current_comment); 11184a0df2efSAndy Whitcroft} 11194a0df2efSAndy Whitcroftsub ctx_has_comment { 11204a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11214a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11224a0df2efSAndy Whitcroft 112300df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11244a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11254a0df2efSAndy Whitcroft 11264a0df2efSAndy Whitcroft return ($cmt ne ''); 11274a0df2efSAndy Whitcroft} 11284a0df2efSAndy Whitcroft 11294d001e4dSAndy Whitcroftsub raw_line { 11304d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11314d001e4dSAndy Whitcroft 11324d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11334d001e4dSAndy Whitcroft $cnt++; 11344d001e4dSAndy Whitcroft 11354d001e4dSAndy Whitcroft my $line; 11364d001e4dSAndy Whitcroft while ($cnt) { 11374d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11384d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11394d001e4dSAndy Whitcroft $cnt--; 11404d001e4dSAndy Whitcroft } 11414d001e4dSAndy Whitcroft 11424d001e4dSAndy Whitcroft return $line; 11434d001e4dSAndy Whitcroft} 11444d001e4dSAndy Whitcroft 11450a920b5bSAndy Whitcroftsub cat_vet { 11460a920b5bSAndy Whitcroft my ($vet) = @_; 11479c0ca6f9SAndy Whitcroft my ($res, $coded); 11480a920b5bSAndy Whitcroft 11499c0ca6f9SAndy Whitcroft $res = ''; 11506c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11516c72ffaaSAndy Whitcroft $res .= $1; 11526c72ffaaSAndy Whitcroft if ($2 ne '') { 11539c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11546c72ffaaSAndy Whitcroft $res .= $coded; 11556c72ffaaSAndy Whitcroft } 11569c0ca6f9SAndy Whitcroft } 11579c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11580a920b5bSAndy Whitcroft 11599c0ca6f9SAndy Whitcroft return $res; 11600a920b5bSAndy Whitcroft} 11610a920b5bSAndy Whitcroft 1162c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1163cf655043SAndy Whitcroftmy $av_pending; 1164c2fdda0dSAndy Whitcroftmy @av_paren_type; 11651f65f947SAndy Whitcroftmy $av_pend_colon; 1166c2fdda0dSAndy Whitcroft 1167c2fdda0dSAndy Whitcroftsub annotate_reset { 1168c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1169cf655043SAndy Whitcroft $av_pending = '_'; 1170cf655043SAndy Whitcroft @av_paren_type = ('E'); 11711f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1172c2fdda0dSAndy Whitcroft} 1173c2fdda0dSAndy Whitcroft 11746c72ffaaSAndy Whitcroftsub annotate_values { 11756c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 11766c72ffaaSAndy Whitcroft 11776c72ffaaSAndy Whitcroft my $res; 11781f65f947SAndy Whitcroft my $var = '_' x length($stream); 11796c72ffaaSAndy Whitcroft my $cur = $stream; 11806c72ffaaSAndy Whitcroft 1181c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 11826c72ffaaSAndy Whitcroft 11836c72ffaaSAndy Whitcroft while (length($cur)) { 1184773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1185cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1186171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 11876c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1188c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1189c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1190cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1191c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 11926c72ffaaSAndy Whitcroft } 11936c72ffaaSAndy Whitcroft 1194c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 11959446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 11969446ef56SAndy Whitcroft push(@av_paren_type, $type); 1197addcdceaSAndy Whitcroft $type = 'c'; 11989446ef56SAndy Whitcroft 1199e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1200c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12016c72ffaaSAndy Whitcroft $type = 'T'; 12026c72ffaaSAndy Whitcroft 1203389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1204389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1205389a2fe5SAndy Whitcroft $type = 'T'; 1206389a2fe5SAndy Whitcroft 1207c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1208171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1209c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1210171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1211171ae1a4SAndy Whitcroft if ($2 ne '') { 1212cf655043SAndy Whitcroft $av_pending = 'N'; 1213171ae1a4SAndy Whitcroft } 1214171ae1a4SAndy Whitcroft $type = 'E'; 1215171ae1a4SAndy Whitcroft 1216c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1217171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1218171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1219171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12206c72ffaaSAndy Whitcroft 1221c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1222cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1223c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1224cf655043SAndy Whitcroft 1225cf655043SAndy Whitcroft push(@av_paren_type, $type); 1226cf655043SAndy Whitcroft push(@av_paren_type, $type); 1227171ae1a4SAndy Whitcroft $type = 'E'; 1228cf655043SAndy Whitcroft 1229c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1230cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1231cf655043SAndy Whitcroft $av_preprocessor = 1; 1232cf655043SAndy Whitcroft 1233cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1234cf655043SAndy Whitcroft 1235171ae1a4SAndy Whitcroft $type = 'E'; 1236cf655043SAndy Whitcroft 1237c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1238cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1239cf655043SAndy Whitcroft 1240cf655043SAndy Whitcroft $av_preprocessor = 1; 1241cf655043SAndy Whitcroft 1242cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1243cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1244cf655043SAndy Whitcroft pop(@av_paren_type); 1245cf655043SAndy Whitcroft push(@av_paren_type, $type); 1246171ae1a4SAndy Whitcroft $type = 'E'; 12476c72ffaaSAndy Whitcroft 12486c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1249c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12506c72ffaaSAndy Whitcroft 1251171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1252171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1253171ae1a4SAndy Whitcroft $av_pending = $type; 1254171ae1a4SAndy Whitcroft $type = 'N'; 1255171ae1a4SAndy Whitcroft 12566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1257c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12586c72ffaaSAndy Whitcroft if (defined $2) { 1259cf655043SAndy Whitcroft $av_pending = 'V'; 12606c72ffaaSAndy Whitcroft } 12616c72ffaaSAndy Whitcroft $type = 'N'; 12626c72ffaaSAndy Whitcroft 126314b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1264c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 126514b111c1SAndy Whitcroft $av_pending = 'E'; 12666c72ffaaSAndy Whitcroft $type = 'N'; 12676c72ffaaSAndy Whitcroft 12681f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 12691f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 12701f65f947SAndy Whitcroft $av_pend_colon = 'C'; 12711f65f947SAndy Whitcroft $type = 'N'; 12721f65f947SAndy Whitcroft 127314b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1274c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 12756c72ffaaSAndy Whitcroft $type = 'N'; 12766c72ffaaSAndy Whitcroft 12776c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1278c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1279cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1280cf655043SAndy Whitcroft $av_pending = '_'; 12816c72ffaaSAndy Whitcroft $type = 'N'; 12826c72ffaaSAndy Whitcroft 12836c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1284cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1285cf655043SAndy Whitcroft if ($new_type ne '_') { 1286cf655043SAndy Whitcroft $type = $new_type; 1287c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1288c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 12896c72ffaaSAndy Whitcroft } else { 1290c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 12916c72ffaaSAndy Whitcroft } 12926c72ffaaSAndy Whitcroft 1293c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1294c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1295c8cb2ca3SAndy Whitcroft $type = 'V'; 1296cf655043SAndy Whitcroft $av_pending = 'V'; 12976c72ffaaSAndy Whitcroft 12988e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 12998e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13001f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13018e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13028e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13031f65f947SAndy Whitcroft } 13041f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13051f65f947SAndy Whitcroft $type = 'V'; 13061f65f947SAndy Whitcroft 13076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1308c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13096c72ffaaSAndy Whitcroft $type = 'V'; 13106c72ffaaSAndy Whitcroft 13116c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1312c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13136c72ffaaSAndy Whitcroft $type = 'N'; 13146c72ffaaSAndy Whitcroft 1315cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1316c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 131713214adfSAndy Whitcroft $type = 'E'; 13181f65f947SAndy Whitcroft $av_pend_colon = 'O'; 131913214adfSAndy Whitcroft 13208e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13218e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13228e761b04SAndy Whitcroft $type = 'C'; 13238e761b04SAndy Whitcroft 13241f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13251f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 13261f65f947SAndy Whitcroft $type = 'N'; 13271f65f947SAndy Whitcroft 13281f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 13291f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 13301f65f947SAndy Whitcroft 13311f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13321f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13331f65f947SAndy Whitcroft $type = 'E'; 13341f65f947SAndy Whitcroft } else { 13351f65f947SAndy Whitcroft $type = 'N'; 13361f65f947SAndy Whitcroft } 13371f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13381f65f947SAndy Whitcroft 13398e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 134013214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13416c72ffaaSAndy Whitcroft $type = 'N'; 13426c72ffaaSAndy Whitcroft 13430d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 134474048ed8SAndy Whitcroft my $variant; 134574048ed8SAndy Whitcroft 134674048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 134774048ed8SAndy Whitcroft if ($type eq 'V') { 134874048ed8SAndy Whitcroft $variant = 'B'; 134974048ed8SAndy Whitcroft } else { 135074048ed8SAndy Whitcroft $variant = 'U'; 135174048ed8SAndy Whitcroft } 135274048ed8SAndy Whitcroft 135374048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 135474048ed8SAndy Whitcroft $type = 'N'; 135574048ed8SAndy Whitcroft 13566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1357c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13586c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13596c72ffaaSAndy Whitcroft $type = 'N'; 13606c72ffaaSAndy Whitcroft } 13616c72ffaaSAndy Whitcroft 13626c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1363c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13646c72ffaaSAndy Whitcroft } 13656c72ffaaSAndy Whitcroft if (defined $1) { 13666c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13676c72ffaaSAndy Whitcroft $res .= $type x length($1); 13686c72ffaaSAndy Whitcroft } 13696c72ffaaSAndy Whitcroft } 13706c72ffaaSAndy Whitcroft 13711f65f947SAndy Whitcroft return ($res, $var); 13726c72ffaaSAndy Whitcroft} 13736c72ffaaSAndy Whitcroft 13748905a67cSAndy Whitcroftsub possible { 137513214adfSAndy Whitcroft my ($possible, $line) = @_; 13769a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 13770776e594SAndy Whitcroft ^(?: 13780776e594SAndy Whitcroft $Modifier| 13790776e594SAndy Whitcroft $Storage| 13800776e594SAndy Whitcroft $Type| 13819a974fdbSAndy Whitcroft DEFINE_\S+ 13829a974fdbSAndy Whitcroft )$| 13839a974fdbSAndy Whitcroft ^(?: 13840776e594SAndy Whitcroft goto| 13850776e594SAndy Whitcroft return| 13860776e594SAndy Whitcroft case| 13870776e594SAndy Whitcroft else| 13880776e594SAndy Whitcroft asm|__asm__| 138989a88353SAndy Whitcroft do| 139089a88353SAndy Whitcroft \#| 139189a88353SAndy Whitcroft \#\#| 13929a974fdbSAndy Whitcroft )(?:\s|$)| 13930776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 13949a974fdbSAndy Whitcroft )}x; 13959a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 13969a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1397c45dcabdSAndy Whitcroft # Check for modifiers. 1398c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1399c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1400c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1401c45dcabdSAndy Whitcroft 1402c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1403c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1404d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14059a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1406d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1407d2506586SAndy Whitcroft push(@modifierList, $modifier); 1408d2506586SAndy Whitcroft } 14099a974fdbSAndy Whitcroft } 1410c45dcabdSAndy Whitcroft 1411c45dcabdSAndy Whitcroft } else { 141213214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14138905a67cSAndy Whitcroft push(@typeList, $possible); 1414c45dcabdSAndy Whitcroft } 14158905a67cSAndy Whitcroft build_types(); 14160776e594SAndy Whitcroft } else { 14170776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14188905a67cSAndy Whitcroft } 14198905a67cSAndy Whitcroft} 14208905a67cSAndy Whitcroft 14216c72ffaaSAndy Whitcroftmy $prefix = ''; 14226c72ffaaSAndy Whitcroft 1423000d1cc1SJoe Perchessub show_type { 142491bfe484SJoe Perches return defined $use_type{$_[0]} if (scalar keys %use_type > 0); 142591bfe484SJoe Perches 1426000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1427000d1cc1SJoe Perches} 1428000d1cc1SJoe Perches 1429f0a594c1SAndy Whitcroftsub report { 1430000d1cc1SJoe Perches if (!show_type($_[1]) || 1431000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1432773647a0SAndy Whitcroft return 0; 1433773647a0SAndy Whitcroft } 1434000d1cc1SJoe Perches my $line; 1435000d1cc1SJoe Perches if ($show_types) { 1436000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1437000d1cc1SJoe Perches } else { 1438000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1439000d1cc1SJoe Perches } 14408905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14418905a67cSAndy Whitcroft 144213214adfSAndy Whitcroft push(our @report, $line); 1443773647a0SAndy Whitcroft 1444773647a0SAndy Whitcroft return 1; 1445f0a594c1SAndy Whitcroft} 1446f0a594c1SAndy Whitcroftsub report_dump { 144713214adfSAndy Whitcroft our @report; 1448f0a594c1SAndy Whitcroft} 1449000d1cc1SJoe Perches 1450de7d4f0eSAndy Whitcroftsub ERROR { 1451000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1452de7d4f0eSAndy Whitcroft our $clean = 0; 14536c72ffaaSAndy Whitcroft our $cnt_error++; 14543705ce5bSJoe Perches return 1; 1455de7d4f0eSAndy Whitcroft } 14563705ce5bSJoe Perches return 0; 1457773647a0SAndy Whitcroft} 1458de7d4f0eSAndy Whitcroftsub WARN { 1459000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1460de7d4f0eSAndy Whitcroft our $clean = 0; 14616c72ffaaSAndy Whitcroft our $cnt_warn++; 14623705ce5bSJoe Perches return 1; 1463de7d4f0eSAndy Whitcroft } 14643705ce5bSJoe Perches return 0; 1465773647a0SAndy Whitcroft} 1466de7d4f0eSAndy Whitcroftsub CHK { 1467000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1468de7d4f0eSAndy Whitcroft our $clean = 0; 14696c72ffaaSAndy Whitcroft our $cnt_chk++; 14703705ce5bSJoe Perches return 1; 14716c72ffaaSAndy Whitcroft } 14723705ce5bSJoe Perches return 0; 1473de7d4f0eSAndy Whitcroft} 1474de7d4f0eSAndy Whitcroft 14756ecd9674SAndy Whitcroftsub check_absolute_file { 14766ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 14776ecd9674SAndy Whitcroft my $file = $absolute; 14786ecd9674SAndy Whitcroft 14796ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 14806ecd9674SAndy Whitcroft 14816ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 14826ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 14836ecd9674SAndy Whitcroft if (-f "$root/$file") { 14846ecd9674SAndy Whitcroft ##print "file<$file>\n"; 14856ecd9674SAndy Whitcroft last; 14866ecd9674SAndy Whitcroft } 14876ecd9674SAndy Whitcroft } 14886ecd9674SAndy Whitcroft if (! -f _) { 14896ecd9674SAndy Whitcroft return 0; 14906ecd9674SAndy Whitcroft } 14916ecd9674SAndy Whitcroft 14926ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 14936ecd9674SAndy Whitcroft my $prefix = $absolute; 14946ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 14956ecd9674SAndy Whitcroft 14966ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 14976ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1498000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1499000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 15006ecd9674SAndy Whitcroft } 15016ecd9674SAndy Whitcroft} 15026ecd9674SAndy Whitcroft 15033705ce5bSJoe Perchessub trim { 15043705ce5bSJoe Perches my ($string) = @_; 15053705ce5bSJoe Perches 1506b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1507b34c648bSJoe Perches 1508b34c648bSJoe Perches return $string; 1509b34c648bSJoe Perches} 1510b34c648bSJoe Perches 1511b34c648bSJoe Perchessub ltrim { 1512b34c648bSJoe Perches my ($string) = @_; 1513b34c648bSJoe Perches 1514b34c648bSJoe Perches $string =~ s/^\s+//; 1515b34c648bSJoe Perches 1516b34c648bSJoe Perches return $string; 1517b34c648bSJoe Perches} 1518b34c648bSJoe Perches 1519b34c648bSJoe Perchessub rtrim { 1520b34c648bSJoe Perches my ($string) = @_; 1521b34c648bSJoe Perches 1522b34c648bSJoe Perches $string =~ s/\s+$//; 15233705ce5bSJoe Perches 15243705ce5bSJoe Perches return $string; 15253705ce5bSJoe Perches} 15263705ce5bSJoe Perches 152752ea8506SJoe Perchessub string_find_replace { 152852ea8506SJoe Perches my ($string, $find, $replace) = @_; 152952ea8506SJoe Perches 153052ea8506SJoe Perches $string =~ s/$find/$replace/g; 153152ea8506SJoe Perches 153252ea8506SJoe Perches return $string; 153352ea8506SJoe Perches} 153452ea8506SJoe Perches 15353705ce5bSJoe Perchessub tabify { 15363705ce5bSJoe Perches my ($leading) = @_; 15373705ce5bSJoe Perches 15383705ce5bSJoe Perches my $source_indent = 8; 15393705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 15403705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 15413705ce5bSJoe Perches 15423705ce5bSJoe Perches #convert leading spaces to tabs 15433705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 15443705ce5bSJoe Perches #Remove spaces before a tab 15453705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 15463705ce5bSJoe Perches 15473705ce5bSJoe Perches return "$leading"; 15483705ce5bSJoe Perches} 15493705ce5bSJoe Perches 1550d1fe9c09SJoe Perchessub pos_last_openparen { 1551d1fe9c09SJoe Perches my ($line) = @_; 1552d1fe9c09SJoe Perches 1553d1fe9c09SJoe Perches my $pos = 0; 1554d1fe9c09SJoe Perches 1555d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1556d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1557d1fe9c09SJoe Perches 1558d1fe9c09SJoe Perches my $last_openparen = 0; 1559d1fe9c09SJoe Perches 1560d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1561d1fe9c09SJoe Perches return -1; 1562d1fe9c09SJoe Perches } 1563d1fe9c09SJoe Perches 1564d1fe9c09SJoe Perches my $len = length($line); 1565d1fe9c09SJoe Perches 1566d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1567d1fe9c09SJoe Perches my $string = substr($line, $pos); 1568d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1569d1fe9c09SJoe Perches $pos += length($1) - 1; 1570d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1571d1fe9c09SJoe Perches $last_openparen = $pos; 1572d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1573d1fe9c09SJoe Perches last; 1574d1fe9c09SJoe Perches } 1575d1fe9c09SJoe Perches } 1576d1fe9c09SJoe Perches 1577d1fe9c09SJoe Perches return $last_openparen + 1; 1578d1fe9c09SJoe Perches} 1579d1fe9c09SJoe Perches 15800a920b5bSAndy Whitcroftsub process { 15810a920b5bSAndy Whitcroft my $filename = shift; 15820a920b5bSAndy Whitcroft 15830a920b5bSAndy Whitcroft my $linenr=0; 15840a920b5bSAndy Whitcroft my $prevline=""; 1585c2fdda0dSAndy Whitcroft my $prevrawline=""; 15860a920b5bSAndy Whitcroft my $stashline=""; 1587c2fdda0dSAndy Whitcroft my $stashrawline=""; 15880a920b5bSAndy Whitcroft 15894a0df2efSAndy Whitcroft my $length; 15900a920b5bSAndy Whitcroft my $indent; 15910a920b5bSAndy Whitcroft my $previndent=0; 15920a920b5bSAndy Whitcroft my $stashindent=0; 15930a920b5bSAndy Whitcroft 1594de7d4f0eSAndy Whitcroft our $clean = 1; 15950a920b5bSAndy Whitcroft my $signoff = 0; 15960a920b5bSAndy Whitcroft my $is_patch = 0; 15970a920b5bSAndy Whitcroft 159815662b3eSJoe Perches my $in_header_lines = 1; 159915662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 160015662b3eSJoe Perches 1601fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1602fa64205dSPasi Savanainen 160313214adfSAndy Whitcroft our @report = (); 16046c72ffaaSAndy Whitcroft our $cnt_lines = 0; 16056c72ffaaSAndy Whitcroft our $cnt_error = 0; 16066c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16076c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16086c72ffaaSAndy Whitcroft 16090a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16100a920b5bSAndy Whitcroft my $realfile = ''; 16110a920b5bSAndy Whitcroft my $realline = 0; 16120a920b5bSAndy Whitcroft my $realcnt = 0; 16130a920b5bSAndy Whitcroft my $here = ''; 16140a920b5bSAndy Whitcroft my $in_comment = 0; 1615c2fdda0dSAndy Whitcroft my $comment_edge = 0; 16160a920b5bSAndy Whitcroft my $first_line = 0; 16171e855726SWolfram Sang my $p1_prefix = ''; 16180a920b5bSAndy Whitcroft 161913214adfSAndy Whitcroft my $prev_values = 'E'; 162013214adfSAndy Whitcroft 162113214adfSAndy Whitcroft # suppression flags 1622773647a0SAndy Whitcroft my %suppress_ifbraces; 1623170d3a22SAndy Whitcroft my %suppress_whiletrailers; 16242b474a1aSAndy Whitcroft my %suppress_export; 16253e469cdcSAndy Whitcroft my $suppress_statement = 0; 1626653d4876SAndy Whitcroft 16277e51f197SJoe Perches my %signatures = (); 1628323c1260SJoe Perches 1629c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1630de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1631c2fdda0dSAndy Whitcroft # 1632de7d4f0eSAndy Whitcroft my @setup_docs = (); 1633de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1634773647a0SAndy Whitcroft 1635d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1636d8b07710SJoe Perches 1637773647a0SAndy Whitcroft sanitise_line_reset(); 1638c2fdda0dSAndy Whitcroft my $line; 1639c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1640773647a0SAndy Whitcroft $linenr++; 1641773647a0SAndy Whitcroft $line = $rawline; 1642c2fdda0dSAndy Whitcroft 16433705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 16443705ce5bSJoe Perches 1645773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1646de7d4f0eSAndy Whitcroft $setup_docs = 0; 1647de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1648de7d4f0eSAndy Whitcroft $setup_docs = 1; 1649de7d4f0eSAndy Whitcroft } 1650773647a0SAndy Whitcroft #next; 1651de7d4f0eSAndy Whitcroft } 1652773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1653773647a0SAndy Whitcroft $realline=$1-1; 1654773647a0SAndy Whitcroft if (defined $2) { 1655773647a0SAndy Whitcroft $realcnt=$3+1; 1656773647a0SAndy Whitcroft } else { 1657773647a0SAndy Whitcroft $realcnt=1+1; 1658773647a0SAndy Whitcroft } 1659c45dcabdSAndy Whitcroft $in_comment = 0; 1660773647a0SAndy Whitcroft 1661773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1662773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1663773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1664773647a0SAndy Whitcroft # at context start. 1665773647a0SAndy Whitcroft my $edge; 166601fa9147SAndy Whitcroft my $cnt = $realcnt; 166701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 166801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 166901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 167001fa9147SAndy Whitcroft $cnt--; 167101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1672721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1673fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1674fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1675fae17daeSAndy Whitcroft ($edge) = $1; 1676fae17daeSAndy Whitcroft last; 1677fae17daeSAndy Whitcroft } 1678773647a0SAndy Whitcroft } 1679773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1680773647a0SAndy Whitcroft $in_comment = 1; 1681773647a0SAndy Whitcroft } 1682773647a0SAndy Whitcroft 1683773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1684773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1685773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1686773647a0SAndy Whitcroft if (!defined $edge && 168783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1688773647a0SAndy Whitcroft { 1689773647a0SAndy Whitcroft $in_comment = 1; 1690773647a0SAndy Whitcroft } 1691773647a0SAndy Whitcroft 1692773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1693773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1694773647a0SAndy Whitcroft 1695171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1696773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1697171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1698773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1699773647a0SAndy Whitcroft } 1700773647a0SAndy Whitcroft push(@lines, $line); 1701773647a0SAndy Whitcroft 1702773647a0SAndy Whitcroft if ($realcnt > 1) { 1703773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1704773647a0SAndy Whitcroft } else { 1705773647a0SAndy Whitcroft $realcnt = 0; 1706773647a0SAndy Whitcroft } 1707773647a0SAndy Whitcroft 1708773647a0SAndy Whitcroft #print "==>$rawline\n"; 1709773647a0SAndy Whitcroft #print "-->$line\n"; 1710de7d4f0eSAndy Whitcroft 1711de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1712de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1713de7d4f0eSAndy Whitcroft } 1714de7d4f0eSAndy Whitcroft } 1715de7d4f0eSAndy Whitcroft 17166c72ffaaSAndy Whitcroft $prefix = ''; 17176c72ffaaSAndy Whitcroft 1718773647a0SAndy Whitcroft $realcnt = 0; 1719773647a0SAndy Whitcroft $linenr = 0; 17200a920b5bSAndy Whitcroft foreach my $line (@lines) { 17210a920b5bSAndy Whitcroft $linenr++; 17221b5539b1SJoe Perches my $sline = $line; #copy of $line 17231b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 17240a920b5bSAndy Whitcroft 1725c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 17266c72ffaaSAndy Whitcroft 17270a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 17286c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 17290a920b5bSAndy Whitcroft $is_patch = 1; 17304a0df2efSAndy Whitcroft $first_line = $linenr + 1; 17310a920b5bSAndy Whitcroft $realline=$1-1; 17320a920b5bSAndy Whitcroft if (defined $2) { 17330a920b5bSAndy Whitcroft $realcnt=$3+1; 17340a920b5bSAndy Whitcroft } else { 17350a920b5bSAndy Whitcroft $realcnt=1+1; 17360a920b5bSAndy Whitcroft } 1737c2fdda0dSAndy Whitcroft annotate_reset(); 173813214adfSAndy Whitcroft $prev_values = 'E'; 173913214adfSAndy Whitcroft 1740773647a0SAndy Whitcroft %suppress_ifbraces = (); 1741170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 17422b474a1aSAndy Whitcroft %suppress_export = (); 17433e469cdcSAndy Whitcroft $suppress_statement = 0; 17440a920b5bSAndy Whitcroft next; 17450a920b5bSAndy Whitcroft 17464a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 17474a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 17484a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1749773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 17500a920b5bSAndy Whitcroft $realline++; 1751d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 17520a920b5bSAndy Whitcroft 17534a0df2efSAndy Whitcroft # Measure the line length and indent. 1754c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 17550a920b5bSAndy Whitcroft 17560a920b5bSAndy Whitcroft # Track the previous line. 17570a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 17580a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1759c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1760c2fdda0dSAndy Whitcroft 1761773647a0SAndy Whitcroft #warn "line<$line>\n"; 17626c72ffaaSAndy Whitcroft 1763d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1764d8aaf121SAndy Whitcroft $realcnt--; 17650a920b5bSAndy Whitcroft } 17660a920b5bSAndy Whitcroft 1767cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1768cc77cdcaSAndy Whitcroft 17690a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1770773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1771773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1772773647a0SAndy Whitcroft 17736c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 17746c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1775773647a0SAndy Whitcroft 1776773647a0SAndy Whitcroft # extract the filename as it passes 17773bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 17783bf9a009SRabin Vincent $realfile = $1; 17792b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1780270c49a0SJoe Perches $in_commit_log = 0; 17813bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1782773647a0SAndy Whitcroft $realfile = $1; 17832b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1784270c49a0SJoe Perches $in_commit_log = 0; 17851e855726SWolfram Sang 17861e855726SWolfram Sang $p1_prefix = $1; 1787e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1788e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1789000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1790000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 17911e855726SWolfram Sang } 1792773647a0SAndy Whitcroft 1793c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1794000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1795000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1796773647a0SAndy Whitcroft } 1797773647a0SAndy Whitcroft next; 1798773647a0SAndy Whitcroft } 1799773647a0SAndy Whitcroft 1800389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 18010a920b5bSAndy Whitcroft 1802c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1803c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1804c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 18050a920b5bSAndy Whitcroft 18066c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 18076c72ffaaSAndy Whitcroft 18083bf9a009SRabin Vincent# Check for incorrect file permissions 18093bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 18103bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 181104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 181204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1813000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1814000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 18153bf9a009SRabin Vincent } 18163bf9a009SRabin Vincent } 18173bf9a009SRabin Vincent 181820112475SJoe Perches# Check the patch for a signoff: 1819d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 18204a0df2efSAndy Whitcroft $signoff++; 182115662b3eSJoe Perches $in_commit_log = 0; 18220a920b5bSAndy Whitcroft } 182320112475SJoe Perches 182420112475SJoe Perches# Check signature styles 1825270c49a0SJoe Perches if (!$in_header_lines && 1826ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 182720112475SJoe Perches my $space_before = $1; 182820112475SJoe Perches my $sign_off = $2; 182920112475SJoe Perches my $space_after = $3; 183020112475SJoe Perches my $email = $4; 183120112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 183220112475SJoe Perches 1833ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1834ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1835ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1836ce0338dfSJoe Perches } 183720112475SJoe Perches if (defined $space_before && $space_before ne "") { 18383705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18393705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 18403705ce5bSJoe Perches $fix) { 18413705ce5bSJoe Perches $fixed[$linenr - 1] = 18423705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18433705ce5bSJoe Perches } 184420112475SJoe Perches } 184520112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 18463705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18473705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 18483705ce5bSJoe Perches $fix) { 18493705ce5bSJoe Perches $fixed[$linenr - 1] = 18503705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18513705ce5bSJoe Perches } 18523705ce5bSJoe Perches 185320112475SJoe Perches } 185420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 18553705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18563705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 18573705ce5bSJoe Perches $fix) { 18583705ce5bSJoe Perches $fixed[$linenr - 1] = 18593705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18603705ce5bSJoe Perches } 186120112475SJoe Perches } 186220112475SJoe Perches 186320112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 186420112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 186520112475SJoe Perches if ($suggested_email eq "") { 1866000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1867000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 186820112475SJoe Perches } else { 186920112475SJoe Perches my $dequoted = $suggested_email; 187020112475SJoe Perches $dequoted =~ s/^"//; 187120112475SJoe Perches $dequoted =~ s/" </ </; 187220112475SJoe Perches # Don't force email to have quotes 187320112475SJoe Perches # Allow just an angle bracketed address 187420112475SJoe Perches if ("$dequoted$comment" ne $email && 187520112475SJoe Perches "<$email_address>$comment" ne $email && 187620112475SJoe Perches "$suggested_email$comment" ne $email) { 1877000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1878000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 187920112475SJoe Perches } 18800a920b5bSAndy Whitcroft } 18817e51f197SJoe Perches 18827e51f197SJoe Perches# Check for duplicate signatures 18837e51f197SJoe Perches my $sig_nospace = $line; 18847e51f197SJoe Perches $sig_nospace =~ s/\s//g; 18857e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 18867e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 18877e51f197SJoe Perches WARN("BAD_SIGN_OFF", 18887e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 18897e51f197SJoe Perches } else { 18907e51f197SJoe Perches $signatures{$sig_nospace} = 1; 18917e51f197SJoe Perches } 18920a920b5bSAndy Whitcroft } 18930a920b5bSAndy Whitcroft 189400df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 18958905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1896000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1897000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 18986c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1899de7d4f0eSAndy Whitcroft } 1900de7d4f0eSAndy Whitcroft 19016ecd9674SAndy Whitcroft# Check for absolute kernel paths. 19026ecd9674SAndy Whitcroft if ($tree) { 19036ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 19046ecd9674SAndy Whitcroft my $file = $1; 19056ecd9674SAndy Whitcroft 19066ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19076ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19086ecd9674SAndy Whitcroft # 19096ecd9674SAndy Whitcroft } else { 19106ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19116ecd9674SAndy Whitcroft } 19126ecd9674SAndy Whitcroft } 19136ecd9674SAndy Whitcroft } 19146ecd9674SAndy Whitcroft 1915de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1916de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1917171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1918171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1919171ae1a4SAndy Whitcroft 1920171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1921171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1922171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1923171ae1a4SAndy Whitcroft 192434d99219SJoe Perches CHK("INVALID_UTF8", 1925000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 192600df344fSAndy Whitcroft } 19270a920b5bSAndy Whitcroft 192815662b3eSJoe Perches# Check if it's the start of a commit log 192915662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 193015662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1931270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 193215662b3eSJoe Perches $in_header_lines = 0; 193315662b3eSJoe Perches $in_commit_log = 1; 193415662b3eSJoe Perches } 193515662b3eSJoe Perches 1936fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1937fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1938fa64205dSPasi Savanainen if ($in_header_lines && 1939fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1940fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1941fa64205dSPasi Savanainen $non_utf8_charset = 1; 1942fa64205dSPasi Savanainen } 1943fa64205dSPasi Savanainen 1944fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 194515662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1946fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 194715662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 194815662b3eSJoe Perches } 194915662b3eSJoe Perches 195030670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 195130670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 195200df344fSAndy Whitcroft 19530a920b5bSAndy Whitcroft#trailing whitespace 19549c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1955c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1956d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 1957d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 1958d5e616fcSJoe Perches $fix) { 1959d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 1960d5e616fcSJoe Perches } 1961c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1962c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19633705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 19643705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 19653705ce5bSJoe Perches $fix) { 1966d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 19673705ce5bSJoe Perches } 19683705ce5bSJoe Perches 1969d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 19700a920b5bSAndy Whitcroft } 19715368df20SAndy Whitcroft 19724783f894SJosh Triplett# Check for FSF mailing addresses. 19733e2232f2SJoe Perches if ($rawline =~ /\bYou should have received a copy/i || 19743e2232f2SJoe Perches $rawline =~ /\bwrite to the Free/i || 19753e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 19763e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 19774783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19784783f894SJosh Triplett my $msg_type = \&ERROR; 19794783f894SJosh Triplett $msg_type = \&CHK if ($file); 19803e2232f2SJoe Perches $msg_type = \&CHK if ($rawline =~ /\bYou should have received a copy/i); 19814783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 19824783f894SJosh 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) 19834783f894SJosh Triplett } 19844783f894SJosh Triplett 19853354957aSAndi Kleen# check for Kconfig help text having a real description 19869fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 19879fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 19883354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1989a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 19903354957aSAndi Kleen my $length = 0; 19919fe287d7SAndy Whitcroft my $cnt = $realcnt; 19929fe287d7SAndy Whitcroft my $ln = $linenr + 1; 19939fe287d7SAndy Whitcroft my $f; 1994a1385803SAndy Whitcroft my $is_start = 0; 19959fe287d7SAndy Whitcroft my $is_end = 0; 1996a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 19979fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 19989fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 19999fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 20009fe287d7SAndy Whitcroft 20019fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2002a1385803SAndy Whitcroft 2003a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2004a1385803SAndy Whitcroft $is_start = 1; 2005a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2006a1385803SAndy Whitcroft $length = -1; 2007a1385803SAndy Whitcroft } 2008a1385803SAndy Whitcroft 20099fe287d7SAndy Whitcroft $f =~ s/^.//; 20103354957aSAndi Kleen $f =~ s/#.*//; 20113354957aSAndi Kleen $f =~ s/^\s+//; 20123354957aSAndi Kleen next if ($f =~ /^$/); 20139fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20149fe287d7SAndy Whitcroft $is_end = 1; 20159fe287d7SAndy Whitcroft last; 20169fe287d7SAndy Whitcroft } 20173354957aSAndi Kleen $length++; 20183354957aSAndi Kleen } 2019000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2020a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2021a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20223354957aSAndi Kleen } 20233354957aSAndi Kleen 20241ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20251ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20261ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20271ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20281ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20291ba8dfd1SKees Cook } 20301ba8dfd1SKees Cook 2031c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2032c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2033c68e5878SArnaud Lacombe my $flag = $1; 2034c68e5878SArnaud Lacombe my $replacement = { 2035c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2036c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2037c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2038c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2039c68e5878SArnaud Lacombe }; 2040c68e5878SArnaud Lacombe 2041c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2042c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2043c68e5878SArnaud Lacombe } 2044c68e5878SArnaud Lacombe 20455368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 20465368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 20475368df20SAndy Whitcroft 20486cd7f386SJoe Perches#line length limit 2049c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2050f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 20510fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 20528bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 20536cd7f386SJoe Perches $length > $max_line_length) 2054c45dcabdSAndy Whitcroft { 2055000d1cc1SJoe Perches WARN("LONG_LINE", 20566cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 20570a920b5bSAndy Whitcroft } 20580a920b5bSAndy Whitcroft 2059ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 20608c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 20618c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 20628c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2063ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2064ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 20658c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2066ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2067ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2068ca56dc09SJosh Triplett } 2069ca56dc09SJosh Triplett 20705e79d96eSJoe Perches# check for spaces before a quoted newline 20715e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 20723705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 20733705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 20743705ce5bSJoe Perches $fix) { 20753705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 20763705ce5bSJoe Perches } 20773705ce5bSJoe Perches 20785e79d96eSJoe Perches } 20795e79d96eSJoe Perches 20808905a67cSAndy Whitcroft# check for adding lines without a newline. 20818905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2082000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2083000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 20848905a67cSAndy Whitcroft } 20858905a67cSAndy Whitcroft 208642e41c54SMike Frysinger# Blackfin: use hi/lo macros 208742e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 208842e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 208942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2090000d1cc1SJoe Perches ERROR("LO_MACRO", 2091000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 209242e41c54SMike Frysinger } 209342e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 209442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2095000d1cc1SJoe Perches ERROR("HI_MACRO", 2096000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 209742e41c54SMike Frysinger } 209842e41c54SMike Frysinger } 209942e41c54SMike Frysinger 2100b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2101b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21020a920b5bSAndy Whitcroft 21030a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21040a920b5bSAndy Whitcroft# more than 8 must use tabs. 2105c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2106c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2107c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2108d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21093705ce5bSJoe Perches if (ERROR("CODE_INDENT", 21103705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 21113705ce5bSJoe Perches $fix) { 21123705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 21133705ce5bSJoe Perches } 21140a920b5bSAndy Whitcroft } 21150a920b5bSAndy Whitcroft 211608e44365SAlberto Panizzo# check for space before tabs. 211708e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 211808e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21193705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 21203705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 21213705ce5bSJoe Perches $fix) { 2122c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2123c76f4cb3SJoe Perches s/(^\+.*) {8,8}+\t/$1\t\t/) {} 2124c76f4cb3SJoe Perches while ($fixed[$linenr - 1] =~ 2125c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 21263705ce5bSJoe Perches } 212708e44365SAlberto Panizzo } 212808e44365SAlberto Panizzo 2129d1fe9c09SJoe Perches# check for && or || at the start of a line 2130d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2131d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2132d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2133d1fe9c09SJoe Perches } 2134d1fe9c09SJoe Perches 2135d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2136d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2137d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 2138d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2139d1fe9c09SJoe Perches my $oldindent = $1; 2140d1fe9c09SJoe Perches my $rest = $2; 2141d1fe9c09SJoe Perches 2142d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2143d1fe9c09SJoe Perches if ($pos >= 0) { 2144b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2145b34a26f3SJoe Perches my $newindent = $2; 2146d1fe9c09SJoe Perches 2147d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2148d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2149d1fe9c09SJoe Perches " " x ($pos % 8); 2150d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2151d1fe9c09SJoe Perches 2152d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2153d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 21543705ce5bSJoe Perches 21553705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 21563705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 21573705ce5bSJoe Perches $fix && $line =~ /^\+/) { 21583705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21593705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 21603705ce5bSJoe Perches } 2161d1fe9c09SJoe Perches } 2162d1fe9c09SJoe Perches } 2163d1fe9c09SJoe Perches } 2164d1fe9c09SJoe Perches 216523f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 21663705ce5bSJoe Perches if (CHK("SPACING", 21673705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 21683705ce5bSJoe Perches $fix) { 21693705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21703705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 21713705ce5bSJoe Perches } 2172aad4f614SJoe Perches } 2173aad4f614SJoe Perches 217405880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2175fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 2176fdb4bcd6SJoe Perches $rawline =~ /^\+[ \t]*\*/) { 217705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 217805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 217905880600SJoe Perches } 218005880600SJoe Perches 218105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2182a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2183a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 218461135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2185a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2186a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2187a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2188a605e32eSJoe Perches } 2189a605e32eSJoe Perches 2190a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2191c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2192c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2193c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2194c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 219505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 219605880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 219705880600SJoe Perches } 219805880600SJoe Perches 21995f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 22006b4c5bebSAndy Whitcroft# Exceptions: 22016b4c5bebSAndy Whitcroft# 1) within comments 22026b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 22036b4c5bebSAndy Whitcroft# 3) hanging labels 22043705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 22055f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22063705ce5bSJoe Perches if (WARN("LEADING_SPACE", 22073705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 22083705ce5bSJoe Perches $fix) { 22093705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22103705ce5bSJoe Perches } 22115f7ddae6SRaffaele Recalcati } 22125f7ddae6SRaffaele Recalcati 2213b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2214b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2215b9ea10d6SAndy Whitcroft 22161ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 22171ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 22181ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 22191ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 22201ba8dfd1SKees Cook } 22211ba8dfd1SKees Cook 2222c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2223cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2224000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2225000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2226c2fdda0dSAndy Whitcroft } 222722f2a2efSAndy Whitcroft 222842e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 222942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 223042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2231000d1cc1SJoe Perches ERROR("CSYNC", 2232000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 223342e41c54SMike Frysinger } 223442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 223542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2236000d1cc1SJoe Perches ERROR("SSYNC", 2237000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 223842e41c54SMike Frysinger } 223942e41c54SMike Frysinger 224056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 224156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 224256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 224356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 224456e77d70SJoe Perches } 224556e77d70SJoe Perches 22469c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 22472b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 22482b474a1aSAndy Whitcroft $realline_next); 22493e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 22503e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 22511b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2252170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2253f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2254171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2255171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2256171ae1a4SAndy Whitcroft 22573e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 22583e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 22593e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 22603e469cdcSAndy Whitcroft # until we hit end of it. 22613e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 22623e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 22633e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 22643e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 22653e469cdcSAndy Whitcroft } 2266f74bd194SAndy Whitcroft 22672b474a1aSAndy Whitcroft # Find the real next line. 22682b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 22692b474a1aSAndy Whitcroft if (defined $realline_next && 22702b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 22712b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 22722b474a1aSAndy Whitcroft $realline_next++; 22732b474a1aSAndy Whitcroft } 22742b474a1aSAndy Whitcroft 2275171ae1a4SAndy Whitcroft my $s = $stat; 2276171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2277cf655043SAndy Whitcroft 2278c2fdda0dSAndy Whitcroft # Ignore goto labels. 2279171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2280c2fdda0dSAndy Whitcroft 2281c2fdda0dSAndy Whitcroft # Ignore functions being called 2282171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2283c2fdda0dSAndy Whitcroft 2284463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2285463f2864SAndy Whitcroft 2286c45dcabdSAndy Whitcroft # declarations always start with types 2287d2506586SAndy 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) { 2288c45dcabdSAndy Whitcroft my $type = $1; 2289c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2290c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2291c45dcabdSAndy Whitcroft 22926c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2293a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2294c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2295c2fdda0dSAndy Whitcroft } 22968905a67cSAndy Whitcroft 22976c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 229865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2299c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 23009c0ca6f9SAndy Whitcroft } 23018905a67cSAndy Whitcroft 23028905a67cSAndy Whitcroft # Check for any sort of function declaration. 23038905a67cSAndy Whitcroft # int foo(something bar, other baz); 23048905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2305171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 23068905a67cSAndy Whitcroft my ($name_len) = length($1); 23078905a67cSAndy Whitcroft 2308cf655043SAndy Whitcroft my $ctx = $s; 2309773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 23108905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2311cf655043SAndy Whitcroft 23128905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2313c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 23148905a67cSAndy Whitcroft 2315c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 23168905a67cSAndy Whitcroft } 23178905a67cSAndy Whitcroft } 23188905a67cSAndy Whitcroft } 23198905a67cSAndy Whitcroft 23209c0ca6f9SAndy Whitcroft } 23219c0ca6f9SAndy Whitcroft 232200df344fSAndy Whitcroft# 232300df344fSAndy Whitcroft# Checks which may be anchored in the context. 232400df344fSAndy Whitcroft# 232500df344fSAndy Whitcroft 232600df344fSAndy Whitcroft# Check for switch () and associated case and default 232700df344fSAndy Whitcroft# statements should be at the same indent. 232800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 232900df344fSAndy Whitcroft my $err = ''; 233000df344fSAndy Whitcroft my $sep = ''; 233100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 233200df344fSAndy Whitcroft shift(@ctx); 233300df344fSAndy Whitcroft for my $ctx (@ctx) { 233400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 233500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 233600df344fSAndy Whitcroft $indent != $cindent) { 233700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 233800df344fSAndy Whitcroft $sep = ''; 233900df344fSAndy Whitcroft } else { 234000df344fSAndy Whitcroft $sep = "[...]\n"; 234100df344fSAndy Whitcroft } 234200df344fSAndy Whitcroft } 234300df344fSAndy Whitcroft if ($err ne '') { 2344000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2345000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2346de7d4f0eSAndy Whitcroft } 2347de7d4f0eSAndy Whitcroft } 2348de7d4f0eSAndy Whitcroft 2349de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2350de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2351c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2352773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2353773647a0SAndy Whitcroft 23549c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 23558eef05ddSJoe Perches 23568eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 23578eef05ddSJoe Perches WARN("DEEP_INDENTATION", 23588eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 23598eef05ddSJoe Perches } 23608eef05ddSJoe Perches 2361de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2362de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2363de7d4f0eSAndy Whitcroft 2364548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2365548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2366de7d4f0eSAndy Whitcroft 2367548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2368548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2369548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2370548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2371548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2372773647a0SAndy Whitcroft $ctx_ln++; 2373773647a0SAndy Whitcroft } 2374548596d5SAndy Whitcroft 237553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 237653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2377773647a0SAndy Whitcroft 2378773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2379000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2380000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 238101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 238200df344fSAndy Whitcroft } 2383773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2384773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2385773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2386773647a0SAndy Whitcroft { 23879c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 23889c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2389000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2390000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 239101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 23929c0ca6f9SAndy Whitcroft } 23939c0ca6f9SAndy Whitcroft } 239400df344fSAndy Whitcroft } 239500df344fSAndy Whitcroft 23964d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 23974d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 23983e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 23993e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 24003e469cdcSAndy Whitcroft if (!defined $stat); 24014d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 24024d001e4dSAndy Whitcroft 24034d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 24044d001e4dSAndy Whitcroft 24054d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 24064d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 24074d001e4dSAndy Whitcroft # where necessary. 24084d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 24094d001e4dSAndy Whitcroft 24104d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 24116f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 24126f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 24134d001e4dSAndy Whitcroft 24144d001e4dSAndy Whitcroft # We want to check the first line inside the block 24154d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 24164d001e4dSAndy Whitcroft # 1) any blank line termination 24174d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 24184d001e4dSAndy Whitcroft # 3) any do (...) { 24194d001e4dSAndy Whitcroft my $continuation = 0; 24204d001e4dSAndy Whitcroft my $check = 0; 24214d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 24224d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 24234d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 24244d001e4dSAndy Whitcroft $continuation = 1; 24254d001e4dSAndy Whitcroft } 24269bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 24274d001e4dSAndy Whitcroft $check = 1; 24284d001e4dSAndy Whitcroft $cond_lines++; 24294d001e4dSAndy Whitcroft } 24304d001e4dSAndy Whitcroft 24314d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 24324d001e4dSAndy Whitcroft # preprocessor statement. 24334d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 24344d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 24354d001e4dSAndy Whitcroft $check = 0; 24364d001e4dSAndy Whitcroft } 24374d001e4dSAndy Whitcroft 24389bd49efeSAndy Whitcroft my $cond_ptr = -1; 2439740504c6SAndy Whitcroft $continuation = 0; 24409bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 24419bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 24424d001e4dSAndy Whitcroft 2443f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2444f16fa28fSAndy Whitcroft # is not linear. 2445f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2446f16fa28fSAndy Whitcroft $check = 0; 2447f16fa28fSAndy Whitcroft } 2448f16fa28fSAndy Whitcroft 24499bd49efeSAndy Whitcroft # Ignore: 24509bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 24519bd49efeSAndy Whitcroft # 2) preprocessor lines, and 24529bd49efeSAndy Whitcroft # 3) labels. 2453740504c6SAndy Whitcroft if ($continuation || 2454740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 24559bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 24569bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2457740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 245830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 24599bd49efeSAndy Whitcroft $cond_lines++; 24609bd49efeSAndy Whitcroft } 24614d001e4dSAndy Whitcroft } 246230dad6ebSAndy Whitcroft } 24634d001e4dSAndy Whitcroft 24644d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 24654d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 24664d001e4dSAndy Whitcroft 24674d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 24684d001e4dSAndy Whitcroft # this is not this patch's fault. 24694d001e4dSAndy Whitcroft if (!defined($stat_real) || 24704d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 24714d001e4dSAndy Whitcroft $check = 0; 24724d001e4dSAndy Whitcroft } 24734d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 24744d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 24754d001e4dSAndy Whitcroft } 24764d001e4dSAndy Whitcroft 24779bd49efeSAndy 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"; 24784d001e4dSAndy Whitcroft 24794d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 24804d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2481000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2482000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 24834d001e4dSAndy Whitcroft } 24844d001e4dSAndy Whitcroft } 24854d001e4dSAndy Whitcroft 24866c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 24876c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 24881f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 24891f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 24906c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2491c2fdda0dSAndy Whitcroft if ($dbg_values) { 2492c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2493cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2494cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 24951f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2496c2fdda0dSAndy Whitcroft } 24976c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 24986c72ffaaSAndy Whitcroft 249900df344fSAndy Whitcroft#ignore lines not being added 25003705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 250100df344fSAndy Whitcroft 2502653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 25037429c690SAndy Whitcroft if ($dbg_type) { 25047429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2505000d1cc1SJoe Perches ERROR("TEST_TYPE", 2506000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 25077429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2508000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2509000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 25107429c690SAndy Whitcroft } 2511653d4876SAndy Whitcroft next; 2512653d4876SAndy Whitcroft } 2513a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2514a1ef277eSAndy Whitcroft if ($dbg_attr) { 25159360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2516000d1cc1SJoe Perches ERROR("TEST_ATTR", 2517000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 25189360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2519000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2520000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2521a1ef277eSAndy Whitcroft } 2522a1ef277eSAndy Whitcroft next; 2523a1ef277eSAndy Whitcroft } 2524653d4876SAndy Whitcroft 2525f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 252699423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 252799423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2528000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2529000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2530f0a594c1SAndy Whitcroft } 2531f0a594c1SAndy Whitcroft 253200df344fSAndy Whitcroft# 253300df344fSAndy Whitcroft# Checks which are anchored on the added line. 253400df344fSAndy Whitcroft# 253500df344fSAndy Whitcroft 2536653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2537c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2538653d4876SAndy Whitcroft my $path = $1; 2539653d4876SAndy Whitcroft if ($path =~ m{//}) { 2540000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2541495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2542495e9d84SJoe Perches } 2543495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2544495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2545495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2546653d4876SAndy Whitcroft } 2547653d4876SAndy Whitcroft } 2548653d4876SAndy Whitcroft 254900df344fSAndy Whitcroft# no C99 // comments 255000df344fSAndy Whitcroft if ($line =~ m{//}) { 25513705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 25523705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 25533705ce5bSJoe Perches $fix) { 25543705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 25553705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 25563705ce5bSJoe Perches my $comment = trim($1); 25573705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 25583705ce5bSJoe Perches } 25593705ce5bSJoe Perches } 256000df344fSAndy Whitcroft } 256100df344fSAndy Whitcroft # Remove C99 comments. 25620a920b5bSAndy Whitcroft $line =~ s@//.*@@; 25636c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 25640a920b5bSAndy Whitcroft 25652b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 25662b474a1aSAndy Whitcroft# the whole statement. 25672b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 25682b474a1aSAndy Whitcroft if (defined $realline_next && 25692b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 25702b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 25712b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25722b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25733cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 25743cbf62dfSAndy Whitcroft # a prefix: 25753cbf62dfSAndy Whitcroft # XXX(foo); 25763cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2577653d4876SAndy Whitcroft my $name = $1; 257887a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 25793cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 25803cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 25813cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 25823cbf62dfSAndy Whitcroft 25833cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 25842b474a1aSAndy Whitcroft \n.}\s*$| 258548012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 258648012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 258748012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 25882b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 25892b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 259048012058SAndy Whitcroft )/x) { 25912b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 25922b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 25932b474a1aSAndy Whitcroft } else { 25942b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 25950a920b5bSAndy Whitcroft } 25960a920b5bSAndy Whitcroft } 25972b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 25982b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 25992b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 26002b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 26012b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 26022b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 26032b474a1aSAndy Whitcroft } 26042b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 26052b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2606000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2607000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 26082b474a1aSAndy Whitcroft } 26090a920b5bSAndy Whitcroft 26105150bda4SJoe Eloff# check for global initialisers. 2611d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2612d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2613000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2614d5e616fcSJoe Perches $herecurr) && 2615d5e616fcSJoe Perches $fix) { 2616d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2617d5e616fcSJoe Perches } 2618f0a594c1SAndy Whitcroft } 26190a920b5bSAndy Whitcroft# check for static initialisers. 2620d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2621d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2622000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2623d5e616fcSJoe Perches $herecurr) && 2624d5e616fcSJoe Perches $fix) { 2625d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2626d5e616fcSJoe Perches } 26270a920b5bSAndy Whitcroft } 26280a920b5bSAndy Whitcroft 2629cb710ecaSJoe Perches# check for static const char * arrays. 2630cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2631000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2632000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2633cb710ecaSJoe Perches $herecurr); 2634cb710ecaSJoe Perches } 2635cb710ecaSJoe Perches 2636cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2637cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2638000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2639000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2640cb710ecaSJoe Perches $herecurr); 2641cb710ecaSJoe Perches } 2642cb710ecaSJoe Perches 264392e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 264492e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 264592e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 264692e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 264792e112fdSJoe Perches $fix) { 264892e112fdSJoe 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\[\] = /; 264992e112fdSJoe Perches } 265093ed0e2dSJoe Perches } 265193ed0e2dSJoe Perches 2652653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2653653d4876SAndy Whitcroft# make sense. 2654653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 26558054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2656c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 26578ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2658653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2659000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2660000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 26610a920b5bSAndy Whitcroft } 26620a920b5bSAndy Whitcroft 26630a920b5bSAndy Whitcroft# * goes on variable not on type 266465863862SAndy Whitcroft # (char*[ const]) 2665bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2666bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 26673705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2668d8aaf121SAndy Whitcroft 266965863862SAndy Whitcroft # Should start with a space. 267065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 267165863862SAndy Whitcroft # Should not end with a space. 267265863862SAndy Whitcroft $to =~ s/\s+$//; 267365863862SAndy Whitcroft # '*'s should not have spaces between. 2674f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 267565863862SAndy Whitcroft } 2676d8aaf121SAndy Whitcroft 26773705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 267865863862SAndy Whitcroft if ($from ne $to) { 26793705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 26803705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 26813705ce5bSJoe Perches $fix) { 26823705ce5bSJoe Perches my $sub_from = $ident; 26833705ce5bSJoe Perches my $sub_to = $ident; 26843705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 26853705ce5bSJoe Perches $fixed[$linenr - 1] =~ 26863705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 26873705ce5bSJoe Perches } 268865863862SAndy Whitcroft } 2689bfcb2cc7SAndy Whitcroft } 2690bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2691bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 26923705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2693d8aaf121SAndy Whitcroft 269465863862SAndy Whitcroft # Should start with a space. 269565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 269665863862SAndy Whitcroft # Should not end with a space. 269765863862SAndy Whitcroft $to =~ s/\s+$//; 269865863862SAndy Whitcroft # '*'s should not have spaces between. 2699f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 270065863862SAndy Whitcroft } 270165863862SAndy Whitcroft # Modifiers should have spaces. 270265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 270365863862SAndy Whitcroft 27043705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2705667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 27063705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 27073705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 27083705ce5bSJoe Perches $fix) { 27093705ce5bSJoe Perches 27103705ce5bSJoe Perches my $sub_from = $match; 27113705ce5bSJoe Perches my $sub_to = $match; 27123705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 27133705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27143705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 27153705ce5bSJoe Perches } 271665863862SAndy Whitcroft } 27170a920b5bSAndy Whitcroft } 27180a920b5bSAndy Whitcroft 27190a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 27200a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 27210a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 27220a920b5bSAndy Whitcroft# print "$herecurr"; 27230a920b5bSAndy Whitcroft# $clean = 0; 27240a920b5bSAndy Whitcroft# } 27250a920b5bSAndy Whitcroft 27268905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2727000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2728000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 27298905a67cSAndy Whitcroft } 27308905a67cSAndy Whitcroft 273117441227SJoe Perches# check for uses of printk_ratelimit 273217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2733000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2734000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 273517441227SJoe Perches } 273617441227SJoe Perches 273700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 273800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 273900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 274025985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 274100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2742f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 274300df344fSAndy Whitcroft my $ok = 0; 274400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 274500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 274625985edcSLucas De Marchi # we have a preceding printk if it ends 274700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 274800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 274900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 275000df344fSAndy Whitcroft $ok = 1; 275100df344fSAndy Whitcroft } 275200df344fSAndy Whitcroft last; 275300df344fSAndy Whitcroft } 275400df344fSAndy Whitcroft } 275500df344fSAndy Whitcroft if ($ok == 0) { 2756000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2757000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 27580a920b5bSAndy Whitcroft } 275900df344fSAndy Whitcroft } 27600a920b5bSAndy Whitcroft 2761243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2762243f3803SJoe Perches my $orig = $1; 2763243f3803SJoe Perches my $level = lc($orig); 2764243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 27658f26b837SJoe Perches my $level2 = $level; 27668f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2767243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 27688f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2769243f3803SJoe Perches } 2770243f3803SJoe Perches 2771243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2772d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2773d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2774d5e616fcSJoe Perches $fix) { 2775d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2776d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2777d5e616fcSJoe Perches } 2778243f3803SJoe Perches } 2779243f3803SJoe Perches 2780dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2781dc139313SJoe Perches my $orig = $1; 2782dc139313SJoe Perches my $level = lc($orig); 2783dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2784dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2785dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2786dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2787dc139313SJoe Perches } 2788dc139313SJoe Perches 2789653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2790653d4876SAndy Whitcroft# or if closed on same line 2791c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2792c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2793000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2794000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 27950a920b5bSAndy Whitcroft } 2796653d4876SAndy Whitcroft 27978905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 27988905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 27998905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2800000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2801000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 28028905a67cSAndy Whitcroft } 28038905a67cSAndy Whitcroft 28040c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 28053705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 28063705ce5bSJoe Perches if (WARN("SPACING", 28073705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 28083705ce5bSJoe Perches $fix) { 28093705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28103705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 28113705ce5bSJoe Perches } 28120c73b4ebSAndy Whitcroft } 28130c73b4ebSAndy Whitcroft 2814*31070b5dSJoe Perches# Function pointer declarations 2815*31070b5dSJoe Perches# check spacing between type, funcptr, and args 2816*31070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 2817*31070b5dSJoe Perches# 2818*31070b5dSJoe Perches# the $Declare variable will capture all spaces after the type 2819*31070b5dSJoe Perches# so check it for trailing missing spaces or multiple spaces 2820*31070b5dSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)$Ident(\s*)\)(\s*)\(/) { 2821*31070b5dSJoe Perches my $declare = $1; 2822*31070b5dSJoe Perches my $pre_pointer_space = $2; 2823*31070b5dSJoe Perches my $post_pointer_space = $3; 2824*31070b5dSJoe Perches my $funcname = $4; 2825*31070b5dSJoe Perches my $post_funcname_space = $5; 2826*31070b5dSJoe Perches my $pre_args_space = $6; 2827*31070b5dSJoe Perches 2828*31070b5dSJoe Perches if ($declare !~ /\s$/) { 2829*31070b5dSJoe Perches WARN("SPACING", 2830*31070b5dSJoe Perches "missing space after return type\n" . $herecurr); 2831*31070b5dSJoe Perches } 2832*31070b5dSJoe Perches 2833*31070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 2834*31070b5dSJoe Perches elsif ($declare =~ /\s{2,}$/) { 2835*31070b5dSJoe Perches WARN("SPACING", 2836*31070b5dSJoe Perches "Multiple spaces after return type\n" . $herecurr); 2837*31070b5dSJoe Perches } 2838*31070b5dSJoe Perches 2839*31070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 2840*31070b5dSJoe Perches if (defined $pre_pointer_space && 2841*31070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 2842*31070b5dSJoe Perches WARN("SPACING", 2843*31070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 2844*31070b5dSJoe Perches } 2845*31070b5dSJoe Perches 2846*31070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 2847*31070b5dSJoe Perches if (defined $post_pointer_space && 2848*31070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 2849*31070b5dSJoe Perches WARN("SPACING", 2850*31070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 2851*31070b5dSJoe Perches } 2852*31070b5dSJoe Perches 2853*31070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 2854*31070b5dSJoe Perches if (defined $post_funcname_space && 2855*31070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 2856*31070b5dSJoe Perches WARN("SPACING", 2857*31070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 2858*31070b5dSJoe Perches } 2859*31070b5dSJoe Perches 2860*31070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 2861*31070b5dSJoe Perches if (defined $pre_args_space && 2862*31070b5dSJoe Perches $pre_args_space =~ /^\s/) { 2863*31070b5dSJoe Perches WARN("SPACING", 2864*31070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 2865*31070b5dSJoe Perches } 2866*31070b5dSJoe Perches 2867*31070b5dSJoe Perches if (show_type("SPACING") && $fix) { 2868*31070b5dSJoe Perches $fixed[$linenr - 1] =~ 2869*31070b5dSJoe Perches s/^(.\s*$Declare)\(\s*\*\s*($Ident)\s*\)\s*\(/rtrim($1) . " " . "\(\*$2\)\("/ex; 2870*31070b5dSJoe Perches } 2871*31070b5dSJoe Perches } 2872*31070b5dSJoe Perches 28738d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 28748d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2875fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2876fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 28778d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 28788d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 28798d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2880fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2881daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 28823705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 28833705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 28843705ce5bSJoe Perches $fix) { 28853705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28863705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 28873705ce5bSJoe Perches } 28888d31cfceSAndy Whitcroft } 28898d31cfceSAndy Whitcroft } 28908d31cfceSAndy Whitcroft 2891f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 28926c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2893c2fdda0dSAndy Whitcroft my $name = $1; 2894773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2895773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2896c2fdda0dSAndy Whitcroft 2897c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2898773647a0SAndy Whitcroft if ($name =~ /^(?: 2899773647a0SAndy Whitcroft if|for|while|switch|return|case| 2900773647a0SAndy Whitcroft volatile|__volatile__| 2901773647a0SAndy Whitcroft __attribute__|format|__extension__| 2902773647a0SAndy Whitcroft asm|__asm__)$/x) 2903773647a0SAndy Whitcroft { 2904c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2905c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2906c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2907c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2908773647a0SAndy Whitcroft 2909773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2910c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2911c2fdda0dSAndy Whitcroft 2912c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2913c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2914773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2915c2fdda0dSAndy Whitcroft 2916c2fdda0dSAndy Whitcroft } else { 29173705ce5bSJoe Perches if (WARN("SPACING", 29183705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 29193705ce5bSJoe Perches $fix) { 29203705ce5bSJoe Perches $fixed[$linenr - 1] =~ 29213705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 29223705ce5bSJoe Perches } 2923f0a594c1SAndy Whitcroft } 29246c72ffaaSAndy Whitcroft } 29259a4cad4eSEric Nelson 2926653d4876SAndy Whitcroft# Check operator spacing. 29270a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 29283705ce5bSJoe Perches my $fixed_line = ""; 29293705ce5bSJoe Perches my $line_fixed = 0; 29303705ce5bSJoe Perches 29319c0ca6f9SAndy Whitcroft my $ops = qr{ 29329c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 29339c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 29349c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 29351f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 293684731623SJoe Perches \?:|\?|: 29379c0ca6f9SAndy Whitcroft }x; 2938cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 29393705ce5bSJoe Perches 29403705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 29413705ce5bSJoe Perches## foreach my $el (@elements) { 29423705ce5bSJoe Perches## print("el: <$el>\n"); 29433705ce5bSJoe Perches## } 29443705ce5bSJoe Perches 29453705ce5bSJoe Perches my @fix_elements = (); 294600df344fSAndy Whitcroft my $off = 0; 29476c72ffaaSAndy Whitcroft 29483705ce5bSJoe Perches foreach my $el (@elements) { 29493705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 29503705ce5bSJoe Perches $off += length($el); 29513705ce5bSJoe Perches } 29523705ce5bSJoe Perches 29533705ce5bSJoe Perches $off = 0; 29543705ce5bSJoe Perches 29556c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 2956b34c648bSJoe Perches my $last_after = -1; 29576c72ffaaSAndy Whitcroft 29580a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 29593705ce5bSJoe Perches 29603705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 29613705ce5bSJoe Perches 29623705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 29633705ce5bSJoe Perches 29644a0df2efSAndy Whitcroft $off += length($elements[$n]); 29654a0df2efSAndy Whitcroft 296625985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2967773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2968773647a0SAndy Whitcroft my $cc = ''; 2969773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2970773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2971773647a0SAndy Whitcroft } 2972773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2973773647a0SAndy Whitcroft 29744a0df2efSAndy Whitcroft my $a = ''; 29754a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 29764a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2977cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 29784a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 29794a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2980773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 29814a0df2efSAndy Whitcroft 29820a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 29834a0df2efSAndy Whitcroft 29844a0df2efSAndy Whitcroft my $c = ''; 29850a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 29864a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 29874a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2988cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 29894a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 29904a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 29918b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 29924a0df2efSAndy Whitcroft } else { 29934a0df2efSAndy Whitcroft $c = 'E'; 29940a920b5bSAndy Whitcroft } 29950a920b5bSAndy Whitcroft 29964a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 29974a0df2efSAndy Whitcroft 29984a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 29994a0df2efSAndy Whitcroft 30006c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3001de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 30020a920b5bSAndy Whitcroft 300374048ed8SAndy Whitcroft # Pull out the value of this operator. 30046c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 30050a920b5bSAndy Whitcroft 30061f65f947SAndy Whitcroft # Get the full operator variant. 30071f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 30081f65f947SAndy Whitcroft 300913214adfSAndy Whitcroft # Ignore operators passed as parameters. 301013214adfSAndy Whitcroft if ($op_type ne 'V' && 301113214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 301213214adfSAndy Whitcroft 3013cf655043SAndy Whitcroft# # Ignore comments 3014cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 301513214adfSAndy Whitcroft 3016d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 301713214adfSAndy Whitcroft } elsif ($op eq ';') { 3018cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3019cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 30203705ce5bSJoe Perches if (ERROR("SPACING", 30213705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3022b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 30233705ce5bSJoe Perches $line_fixed = 1; 30243705ce5bSJoe Perches } 3025d8aaf121SAndy Whitcroft } 3026d8aaf121SAndy Whitcroft 3027d8aaf121SAndy Whitcroft # // is a comment 3028d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 30290a920b5bSAndy Whitcroft 30301f65f947SAndy Whitcroft # No spaces for: 30311f65f947SAndy Whitcroft # -> 30321f65f947SAndy Whitcroft # : when part of a bitfield 30331f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 30344a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 30353705ce5bSJoe Perches if (ERROR("SPACING", 30363705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3037b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 30383705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 30393705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 30403705ce5bSJoe Perches } 3041b34c648bSJoe Perches $line_fixed = 1; 30423705ce5bSJoe Perches } 30430a920b5bSAndy Whitcroft } 30440a920b5bSAndy Whitcroft 30450a920b5bSAndy Whitcroft # , must have a space on the right. 30460a920b5bSAndy Whitcroft } elsif ($op eq ',') { 3047cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 30483705ce5bSJoe Perches if (ERROR("SPACING", 30493705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3050b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 30513705ce5bSJoe Perches $line_fixed = 1; 3052b34c648bSJoe Perches $last_after = $n; 30533705ce5bSJoe Perches } 30540a920b5bSAndy Whitcroft } 30550a920b5bSAndy Whitcroft 30569c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 305774048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 30589c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 30599c0ca6f9SAndy Whitcroft 30609c0ca6f9SAndy Whitcroft # unary operators should have a space before and 30619c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 30629c0ca6f9SAndy Whitcroft # unary operator, or a cast 30639c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 306474048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 30650d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3066cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 30673705ce5bSJoe Perches if (ERROR("SPACING", 30683705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3069b34c648bSJoe Perches if ($n != $last_after + 2) { 3070b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 30713705ce5bSJoe Perches $line_fixed = 1; 30723705ce5bSJoe Perches } 30730a920b5bSAndy Whitcroft } 3074b34c648bSJoe Perches } 3075a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3076171ae1a4SAndy Whitcroft # A unary '*' may be const 3077171ae1a4SAndy Whitcroft 3078171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 30793705ce5bSJoe Perches if (ERROR("SPACING", 30803705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3081b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 30823705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 30833705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 30843705ce5bSJoe Perches } 3085b34c648bSJoe Perches $line_fixed = 1; 30863705ce5bSJoe Perches } 30870a920b5bSAndy Whitcroft } 30880a920b5bSAndy Whitcroft 30890a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 30900a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3091773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 30923705ce5bSJoe Perches if (ERROR("SPACING", 30933705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3094b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 30953705ce5bSJoe Perches $line_fixed = 1; 30963705ce5bSJoe Perches } 30970a920b5bSAndy Whitcroft } 3098773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3099773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 31003705ce5bSJoe Perches if (ERROR("SPACING", 31013705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3102b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 31033705ce5bSJoe Perches $line_fixed = 1; 31043705ce5bSJoe Perches } 3105653d4876SAndy Whitcroft } 3106773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 31073705ce5bSJoe Perches if (ERROR("SPACING", 31083705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3109b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 31103705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 31113705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3112773647a0SAndy Whitcroft } 3113b34c648bSJoe Perches $line_fixed = 1; 31143705ce5bSJoe Perches } 31153705ce5bSJoe Perches } 31160a920b5bSAndy Whitcroft 31170a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 31189c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 31199c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 31209c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3121c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3122c2fdda0dSAndy Whitcroft $op eq '%') 31230a920b5bSAndy Whitcroft { 3124773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 31253705ce5bSJoe Perches if (ERROR("SPACING", 31263705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3127b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3128b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3129b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3130b34c648bSJoe Perches } 31313705ce5bSJoe Perches $line_fixed = 1; 31323705ce5bSJoe Perches } 31330a920b5bSAndy Whitcroft } 31340a920b5bSAndy Whitcroft 31351f65f947SAndy Whitcroft # A colon needs no spaces before when it is 31361f65f947SAndy Whitcroft # terminating a case value or a label. 31371f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 31381f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 31393705ce5bSJoe Perches if (ERROR("SPACING", 31403705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3141b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 31423705ce5bSJoe Perches $line_fixed = 1; 31433705ce5bSJoe Perches } 31441f65f947SAndy Whitcroft } 31451f65f947SAndy Whitcroft 31460a920b5bSAndy Whitcroft # All the others need spaces both sides. 3147cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 31481f65f947SAndy Whitcroft my $ok = 0; 31491f65f947SAndy Whitcroft 315022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 31511f65f947SAndy Whitcroft if (($op eq '<' && 31521f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 31531f65f947SAndy Whitcroft ($op eq '>' && 31541f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 31551f65f947SAndy Whitcroft { 31561f65f947SAndy Whitcroft $ok = 1; 31571f65f947SAndy Whitcroft } 31581f65f947SAndy Whitcroft 315984731623SJoe Perches # messages are ERROR, but ?: are CHK 31601f65f947SAndy Whitcroft if ($ok == 0) { 316184731623SJoe Perches my $msg_type = \&ERROR; 316284731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 316384731623SJoe Perches 316484731623SJoe Perches if (&{$msg_type}("SPACING", 31653705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3166b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3167b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3168b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3169b34c648bSJoe Perches } 31703705ce5bSJoe Perches $line_fixed = 1; 31713705ce5bSJoe Perches } 31720a920b5bSAndy Whitcroft } 317322f2a2efSAndy Whitcroft } 31744a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 31753705ce5bSJoe Perches 31763705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 31773705ce5bSJoe Perches 31783705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 31790a920b5bSAndy Whitcroft } 31803705ce5bSJoe Perches 31813705ce5bSJoe Perches if (($#elements % 2) == 0) { 31823705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 31833705ce5bSJoe Perches } 31843705ce5bSJoe Perches 31853705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 31863705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 31873705ce5bSJoe Perches } 31883705ce5bSJoe Perches 31893705ce5bSJoe Perches 31900a920b5bSAndy Whitcroft } 31910a920b5bSAndy Whitcroft 3192786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3193d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3194786b6326SJoe Perches if (WARN("SPACING", 3195786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3196786b6326SJoe Perches $fix) { 3197786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3198786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3199786b6326SJoe Perches } 3200786b6326SJoe Perches } 3201786b6326SJoe Perches 3202f0a594c1SAndy Whitcroft# check for multiple assignments 3203f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3204000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3205000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3206f0a594c1SAndy Whitcroft } 3207f0a594c1SAndy Whitcroft 320822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 320922f2a2efSAndy Whitcroft## # continuation. 321022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 321122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 321222f2a2efSAndy Whitcroft## 321322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 321422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 321522f2a2efSAndy Whitcroft## my $ln = $line; 321622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 321722f2a2efSAndy Whitcroft## } 321822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3219000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3220000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 322122f2a2efSAndy Whitcroft## } 322222f2a2efSAndy Whitcroft## } 3223f0a594c1SAndy Whitcroft 32240a920b5bSAndy Whitcroft#need space before brace following if, while, etc 322522f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 322622f2a2efSAndy Whitcroft $line =~ /do{/) { 32273705ce5bSJoe Perches if (ERROR("SPACING", 32283705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 32293705ce5bSJoe Perches $fix) { 3230d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 32313705ce5bSJoe Perches } 3232de7d4f0eSAndy Whitcroft } 3233de7d4f0eSAndy Whitcroft 3234c4a62ef9SJoe Perches## # check for blank lines before declarations 3235c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3236c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3237c4a62ef9SJoe Perches## WARN("SPACING", 3238c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3239c4a62ef9SJoe Perches## } 3240c4a62ef9SJoe Perches## 3241c4a62ef9SJoe Perches 3242de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3243de7d4f0eSAndy Whitcroft# on the line 3244de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3245d5e616fcSJoe Perches if (ERROR("SPACING", 3246d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3247d5e616fcSJoe Perches $fix) { 3248d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3249d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3250d5e616fcSJoe Perches } 32510a920b5bSAndy Whitcroft } 32520a920b5bSAndy Whitcroft 325322f2a2efSAndy Whitcroft# check spacing on square brackets 325422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 32553705ce5bSJoe Perches if (ERROR("SPACING", 32563705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 32573705ce5bSJoe Perches $fix) { 32583705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32593705ce5bSJoe Perches s/\[\s+/\[/; 32603705ce5bSJoe Perches } 326122f2a2efSAndy Whitcroft } 326222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 32633705ce5bSJoe Perches if (ERROR("SPACING", 32643705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 32653705ce5bSJoe Perches $fix) { 32663705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32673705ce5bSJoe Perches s/\s+\]/\]/; 32683705ce5bSJoe Perches } 326922f2a2efSAndy Whitcroft } 327022f2a2efSAndy Whitcroft 3271c45dcabdSAndy Whitcroft# check spacing on parentheses 32729c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 32739c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 32743705ce5bSJoe Perches if (ERROR("SPACING", 32753705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 32763705ce5bSJoe Perches $fix) { 32773705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32783705ce5bSJoe Perches s/\(\s+/\(/; 32793705ce5bSJoe Perches } 328022f2a2efSAndy Whitcroft } 328113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3282c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3283c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 32843705ce5bSJoe Perches if (ERROR("SPACING", 32853705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 32863705ce5bSJoe Perches $fix) { 32873705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32883705ce5bSJoe Perches s/\s+\)/\)/; 32893705ce5bSJoe Perches } 329022f2a2efSAndy Whitcroft } 329122f2a2efSAndy Whitcroft 32920a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 32934a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 32940a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 32953705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 32963705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 32973705ce5bSJoe Perches $fix) { 32983705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32993705ce5bSJoe Perches s/^(.)\s+/$1/; 33003705ce5bSJoe Perches } 33010a920b5bSAndy Whitcroft } 33020a920b5bSAndy Whitcroft 3303c45dcabdSAndy Whitcroft# Return is not a function. 3304507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3305c45dcabdSAndy Whitcroft my $spacing = $1; 3306507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 3307507e5141SJoe Perches $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) { 3308000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3309000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 3310c45dcabdSAndy Whitcroft 3311c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3312000d1cc1SJoe Perches ERROR("SPACING", 3313000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3314c45dcabdSAndy Whitcroft } 3315c45dcabdSAndy Whitcroft } 3316507e5141SJoe Perches 3317189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3318189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3319189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3320189248d8SJoe Perches my $openparens = $1; 3321189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3322189248d8SJoe Perches my $msg = ""; 3323189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3324189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3325189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3326189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3327189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3328189248d8SJoe Perches } 3329189248d8SJoe Perches } 3330189248d8SJoe Perches 333153a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 333253a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 333353a3c448SAndy Whitcroft my $name = $1; 333453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3335000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3336000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 333753a3c448SAndy Whitcroft } 333853a3c448SAndy Whitcroft } 3339c45dcabdSAndy Whitcroft 33400a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 33414a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 33423705ce5bSJoe Perches if (ERROR("SPACING", 33433705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 33443705ce5bSJoe Perches $fix) { 33453705ce5bSJoe Perches $fixed[$linenr - 1] =~ 33463705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 33473705ce5bSJoe Perches } 33480a920b5bSAndy Whitcroft } 33490a920b5bSAndy Whitcroft 3350f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3351f5fe35ddSAndy Whitcroft# statements after the conditional. 3352170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 33533e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 33543e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 33553e469cdcSAndy Whitcroft if (!defined $stat); 3356170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3357170d3a22SAndy Whitcroft $remain_next, $off_next); 3358170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3359170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3360170d3a22SAndy Whitcroft 3361170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3362170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3363170d3a22SAndy Whitcroft # then count those as offsets. 3364170d3a22SAndy Whitcroft my ($whitespace) = 3365170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3366170d3a22SAndy Whitcroft my $offset = 3367170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3368170d3a22SAndy Whitcroft 3369170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3370170d3a22SAndy Whitcroft $offset} = 1; 3371170d3a22SAndy Whitcroft } 3372170d3a22SAndy Whitcroft } 3373170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3374c11230f4SJoe Perches defined($stat) && defined($cond) && 3375170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3376171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 33778905a67cSAndy Whitcroft 3378b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3379000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3380000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 33818905a67cSAndy Whitcroft } 33828905a67cSAndy Whitcroft 33838905a67cSAndy Whitcroft # Find out what is on the end of the line after the 33848905a67cSAndy Whitcroft # conditional. 3385773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 33868905a67cSAndy Whitcroft $s =~ s/\n.*//g; 338713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 338853210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 338953210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3390773647a0SAndy Whitcroft { 3391bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3392bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3393bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 339442bdf74cSHidetoshi Seto my $stat_real = ''; 3395bb44ad39SAndy Whitcroft 339642bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 339742bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3398bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3399bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3400bb44ad39SAndy Whitcroft } 3401bb44ad39SAndy Whitcroft 3402000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3403000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 34048905a67cSAndy Whitcroft } 34058905a67cSAndy Whitcroft } 34068905a67cSAndy Whitcroft 340713214adfSAndy Whitcroft# Check for bitwise tests written as boolean 340813214adfSAndy Whitcroft if ($line =~ / 340913214adfSAndy Whitcroft (?: 341013214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 341113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 341213214adfSAndy Whitcroft (?:\&\&|\|\|) 341313214adfSAndy Whitcroft | 341413214adfSAndy Whitcroft (?:\&\&|\|\|) 341513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 341613214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 341713214adfSAndy Whitcroft )/x) 341813214adfSAndy Whitcroft { 3419000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3420000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 342113214adfSAndy Whitcroft } 342213214adfSAndy Whitcroft 34238905a67cSAndy Whitcroft# if and else should not have general statements after it 342413214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 342513214adfSAndy Whitcroft my $s = $1; 342613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 342713214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3428000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3429000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 34300a920b5bSAndy Whitcroft } 343113214adfSAndy Whitcroft } 343239667782SAndy Whitcroft# if should not continue a brace 343339667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3434000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3435000d1cc1SJoe Perches "trailing statements should be on next line\n" . 343639667782SAndy Whitcroft $herecurr); 343739667782SAndy Whitcroft } 3438a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3439a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3440a1080bf8SAndy Whitcroft $line !~ /\G(?: 34413fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3442a1080bf8SAndy Whitcroft \s*return\s+ 3443a1080bf8SAndy Whitcroft )/xg) 3444a1080bf8SAndy Whitcroft { 3445000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3446000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3447a1080bf8SAndy Whitcroft } 34480a920b5bSAndy Whitcroft 34490a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 34500a920b5bSAndy Whitcroft # indent level to be relevant to each other. 34510a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 34520a920b5bSAndy Whitcroft $previndent == $indent) { 3453000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3454000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 34550a920b5bSAndy Whitcroft } 34560a920b5bSAndy Whitcroft 3457c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3458c2fdda0dSAndy Whitcroft $previndent == $indent) { 3459c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3460c2fdda0dSAndy Whitcroft 3461c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3462c2fdda0dSAndy Whitcroft # conditional. 3463773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3464c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3465c2fdda0dSAndy Whitcroft 3466c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3467000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3468000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3469c2fdda0dSAndy Whitcroft } 3470c2fdda0dSAndy Whitcroft } 3471c2fdda0dSAndy Whitcroft 347295e2c602SJoe Perches#Specific variable tests 3473323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3474323c1260SJoe Perches my $var = $1; 347595e2c602SJoe Perches 347695e2c602SJoe Perches#gcc binary extension 347795e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3478d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3479d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3480d5e616fcSJoe Perches $fix) { 3481d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3482d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3483d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3484d5e616fcSJoe Perches } 348595e2c602SJoe Perches } 348695e2c602SJoe Perches 348795e2c602SJoe Perches#CamelCase 3488807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3489be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 349022735ce8SJoe Perches#Ignore Page<foo> variants 3491807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 349222735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 34933445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 34947e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 34957e781f67SJoe Perches my $word = $1; 34967e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3497d8b07710SJoe Perches if ($check) { 3498d8b07710SJoe Perches seed_camelcase_includes(); 3499d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3500d8b07710SJoe Perches seed_camelcase_file($realfile); 3501d8b07710SJoe Perches $camelcase_file_seeded = 1; 3502d8b07710SJoe Perches } 3503d8b07710SJoe Perches } 35047e781f67SJoe Perches if (!defined $camelcase{$word}) { 35057e781f67SJoe Perches $camelcase{$word} = 1; 3506be79794bSJoe Perches CHK("CAMELCASE", 35077e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 35087e781f67SJoe Perches } 3509323c1260SJoe Perches } 3510323c1260SJoe Perches } 35113445686aSJoe Perches } 35120a920b5bSAndy Whitcroft 35130a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3514d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3515d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3516d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3517d5e616fcSJoe Perches $fix) { 3518d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3519d5e616fcSJoe Perches } 35200a920b5bSAndy Whitcroft } 35210a920b5bSAndy Whitcroft 3522653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3523c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3524e09dec48SAndy Whitcroft my $file = "$1.h"; 3525e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3526e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3527e09dec48SAndy Whitcroft $realfile ne $checkfile && 35287840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3529c45dcabdSAndy Whitcroft { 3530e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3531000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3532000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3533e09dec48SAndy Whitcroft } else { 3534000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3535000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3536e09dec48SAndy Whitcroft } 35370a920b5bSAndy Whitcroft } 35380a920b5bSAndy Whitcroft } 35390a920b5bSAndy Whitcroft 3540653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3541653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3542cf655043SAndy Whitcroft# in a known good container 3543b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3544b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3545d8aaf121SAndy Whitcroft my $ln = $linenr; 3546d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3547c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3548c45dcabdSAndy Whitcroft my $ctx = ''; 3549c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3550f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3551f74bd194SAndy Whitcroft $ctx = $dstat; 3552c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3553a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3554c45dcabdSAndy Whitcroft 3555f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3556292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3557c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3558c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3559c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3560c45dcabdSAndy Whitcroft 3561c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3562bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3563bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3564c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3565bf30d6edSAndy Whitcroft { 3566c45dcabdSAndy Whitcroft } 3567c45dcabdSAndy Whitcroft 3568e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3569e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3570e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3571e45bab8eSAndy Whitcroft { 3572e45bab8eSAndy Whitcroft } 3573e45bab8eSAndy Whitcroft 3574c45dcabdSAndy Whitcroft my $exceptions = qr{ 3575c45dcabdSAndy Whitcroft $Declare| 3576c45dcabdSAndy Whitcroft module_param_named| 3577a0a0a7a9SKees Cook MODULE_PARM_DESC| 3578c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3579c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3580383099fdSAndy Whitcroft __typeof__\(| 358122fd2d3eSStefani Seibold union| 358222fd2d3eSStefani Seibold struct| 3583ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3584ea71a0a0SAndy Whitcroft ^\"|\"$ 3585c45dcabdSAndy Whitcroft }x; 35865eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3587f74bd194SAndy Whitcroft if ($dstat ne '' && 3588f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3589f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 35903cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3591b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3592f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3593f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3594e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 359572f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3596f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3597f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3598f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3599f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3600f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3601c45dcabdSAndy Whitcroft { 3602f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3603f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3604f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3605f74bd194SAndy Whitcroft 3606f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3607f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3608c45dcabdSAndy Whitcroft } 3609c45dcabdSAndy Whitcroft 3610f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3611f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3612f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3613f74bd194SAndy Whitcroft } else { 3614000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3615f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3616d8aaf121SAndy Whitcroft } 36170a920b5bSAndy Whitcroft } 36185023d347SJoe Perches 3619481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 36205023d347SJoe Perches 36215023d347SJoe Perches } else { 36225023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3623481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3624481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 36255023d347SJoe Perches $line =~ /^\+.*\\$/) { 36265023d347SJoe Perches WARN("LINE_CONTINUATIONS", 36275023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 36285023d347SJoe Perches } 3629653d4876SAndy Whitcroft } 36300a920b5bSAndy Whitcroft 3631b13edf7fSJoe Perches# do {} while (0) macro tests: 3632b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3633b13edf7fSJoe Perches# macro should not end with a semicolon 3634b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3635b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3636b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3637b13edf7fSJoe Perches my $ln = $linenr; 3638b13edf7fSJoe Perches my $cnt = $realcnt; 3639b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3640b13edf7fSJoe Perches my $ctx = ''; 3641b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3642b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3643b13edf7fSJoe Perches $ctx = $dstat; 3644b13edf7fSJoe Perches 3645b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3646b13edf7fSJoe Perches 3647b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3648b13edf7fSJoe Perches my $stmts = $2; 3649b13edf7fSJoe Perches my $semis = $3; 3650b13edf7fSJoe Perches 3651b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3652b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3653b13edf7fSJoe Perches my $herectx = $here . "\n"; 3654b13edf7fSJoe Perches 3655b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3656b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3657b13edf7fSJoe Perches } 3658b13edf7fSJoe Perches 3659ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3660ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3661b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3662b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3663b13edf7fSJoe Perches } 3664b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3665b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3666b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3667b13edf7fSJoe Perches } 3668b13edf7fSJoe Perches } 3669b13edf7fSJoe Perches } 3670b13edf7fSJoe Perches 3671080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3672080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3673080ba929SMike Frysinger# . 3674080ba929SMike Frysinger# ALIGN(...) 3675080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3676080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3677000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3678000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3679080ba929SMike Frysinger } 3680080ba929SMike Frysinger 3681f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 368213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 368313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3684cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 368513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3686cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3687cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3688aad4f614SJoe Perches my @allowed = (); 3689aad4f614SJoe Perches my $allow = 0; 369013214adfSAndy Whitcroft my $seen = 0; 3691773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3692cf655043SAndy Whitcroft my $ln = $linenr - 1; 369313214adfSAndy Whitcroft for my $chunk (@chunks) { 369413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 369513214adfSAndy Whitcroft 3696773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3697773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3698773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3699773647a0SAndy Whitcroft 3700aad4f614SJoe Perches $allowed[$allow] = 0; 3701773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3702773647a0SAndy Whitcroft 3703773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3704773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3705773647a0SAndy Whitcroft 3706773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3707cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3708cf655043SAndy Whitcroft 3709773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 371013214adfSAndy Whitcroft 371113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 371213214adfSAndy Whitcroft 3713aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3714cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3715cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3716aad4f614SJoe Perches $allowed[$allow] = 1; 371713214adfSAndy Whitcroft } 371813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3719cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3720aad4f614SJoe Perches $allowed[$allow] = 1; 372113214adfSAndy Whitcroft } 3722cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3723cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3724aad4f614SJoe Perches $allowed[$allow] = 1; 372513214adfSAndy Whitcroft } 3726aad4f614SJoe Perches $allow++; 372713214adfSAndy Whitcroft } 3728aad4f614SJoe Perches if ($seen) { 3729aad4f614SJoe Perches my $sum_allowed = 0; 3730aad4f614SJoe Perches foreach (@allowed) { 3731aad4f614SJoe Perches $sum_allowed += $_; 3732aad4f614SJoe Perches } 3733aad4f614SJoe Perches if ($sum_allowed == 0) { 3734000d1cc1SJoe Perches WARN("BRACES", 3735000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3736aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3737aad4f614SJoe Perches $seen != $allow) { 3738aad4f614SJoe Perches CHK("BRACES", 3739aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3740aad4f614SJoe Perches } 374113214adfSAndy Whitcroft } 374213214adfSAndy Whitcroft } 374313214adfSAndy Whitcroft } 3744773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 374513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3746cf655043SAndy Whitcroft my $allowed = 0; 3747f0a594c1SAndy Whitcroft 3748cf655043SAndy Whitcroft # Check the pre-context. 3749cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3750cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3751cf655043SAndy Whitcroft $allowed = 1; 3752f0a594c1SAndy Whitcroft } 3753773647a0SAndy Whitcroft 3754773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3755773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3756773647a0SAndy Whitcroft 3757cf655043SAndy Whitcroft # Check the condition. 3758cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3759773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3760cf655043SAndy Whitcroft if (defined $cond) { 3761773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3762cf655043SAndy Whitcroft } 3763cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3764cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3765cf655043SAndy Whitcroft $allowed = 1; 3766cf655043SAndy Whitcroft } 3767cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3768cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3769cf655043SAndy Whitcroft $allowed = 1; 3770cf655043SAndy Whitcroft } 3771cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3772cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3773cf655043SAndy Whitcroft $allowed = 1; 3774cf655043SAndy Whitcroft } 3775cf655043SAndy Whitcroft # Check the post-context. 3776cf655043SAndy Whitcroft if (defined $chunks[1]) { 3777cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3778cf655043SAndy Whitcroft if (defined $cond) { 3779773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3780cf655043SAndy Whitcroft } 3781cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3782cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3783cf655043SAndy Whitcroft $allowed = 1; 3784cf655043SAndy Whitcroft } 3785cf655043SAndy Whitcroft } 3786cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 378769932487SJustin P. Mattock my $herectx = $here . "\n"; 3788f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3789cf655043SAndy Whitcroft 3790f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 379169932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3792cf655043SAndy Whitcroft } 3793cf655043SAndy Whitcroft 3794000d1cc1SJoe Perches WARN("BRACES", 3795000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3796f0a594c1SAndy Whitcroft } 3797f0a594c1SAndy Whitcroft } 3798f0a594c1SAndy Whitcroft 37990979ae66SJoe Perches# check for unnecessary blank lines around braces 380077b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 38010979ae66SJoe Perches CHK("BRACES", 38020979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 38030979ae66SJoe Perches } 380477b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 38050979ae66SJoe Perches CHK("BRACES", 38060979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 38070979ae66SJoe Perches } 38080979ae66SJoe Perches 38094a0df2efSAndy Whitcroft# no volatiles please 38106c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 38116c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3812000d1cc1SJoe Perches WARN("VOLATILE", 3813000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 38144a0df2efSAndy Whitcroft } 38154a0df2efSAndy Whitcroft 381600df344fSAndy Whitcroft# warn about #if 0 3817c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3818000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3819000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3820de7d4f0eSAndy Whitcroft $herecurr); 38214a0df2efSAndy Whitcroft } 38224a0df2efSAndy Whitcroft 382303df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 382403df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 382503df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 382603df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 382703df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 382803df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 38294c432a8fSGreg Kroah-Hartman } 38304c432a8fSGreg Kroah-Hartman } 3831f0a594c1SAndy Whitcroft 38328716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 38338716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 38348716de38SJoe Perches my $attr = $1; 38358716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 38368716de38SJoe Perches my $ptr = $1; 38378716de38SJoe Perches my $var = $2; 38388716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 38398716de38SJoe Perches ERROR("MISPLACED_INIT", 38408716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 38418716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 38428716de38SJoe Perches WARN("MISPLACED_INIT", 38438716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 38448716de38SJoe Perches $fix) { 38458716de38SJoe 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; 38468716de38SJoe Perches } 38478716de38SJoe Perches } 38488716de38SJoe Perches } 38498716de38SJoe Perches 3850e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 3851e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 3852e970b884SJoe Perches my $attr = $1; 3853e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 3854e970b884SJoe Perches my $attr_prefix = $1; 3855e970b884SJoe Perches my $attr_type = $2; 3856e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3857e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 3858e970b884SJoe Perches $fix) { 3859e970b884SJoe Perches $fixed[$linenr - 1] =~ 3860e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 3861e970b884SJoe Perches } 3862e970b884SJoe Perches } 3863e970b884SJoe Perches 3864e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 3865e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 3866e970b884SJoe Perches my $attr = $1; 3867e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3868e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 3869e970b884SJoe Perches $fix) { 3870e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 3871e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 3872e970b884SJoe Perches $lead = rtrim($1); 3873e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 3874e970b884SJoe Perches $lead = "${lead}const "; 3875e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 3876e970b884SJoe Perches } 3877e970b884SJoe Perches } 3878e970b884SJoe Perches 38791a15a250SPatrick Pannuto# prefer usleep_range over udelay 388037581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 38811a15a250SPatrick Pannuto # ignore udelay's < 10, however 388237581c28SBruce Allan if (! ($1 < 10) ) { 3883000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3884000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 38851a15a250SPatrick Pannuto } 38861a15a250SPatrick Pannuto } 38871a15a250SPatrick Pannuto 388809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 388909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 389009ef8725SPatrick Pannuto if ($1 < 20) { 3891000d1cc1SJoe Perches WARN("MSLEEP", 3892000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 389309ef8725SPatrick Pannuto } 389409ef8725SPatrick Pannuto } 389509ef8725SPatrick Pannuto 389636ec1939SJoe Perches# check for comparisons of jiffies 389736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 389836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 389936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 390036ec1939SJoe Perches } 390136ec1939SJoe Perches 39029d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 39039d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 39049d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 39059d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 39069d7a34a5SJoe Perches } 39079d7a34a5SJoe Perches 390800df344fSAndy Whitcroft# warn about #ifdefs in C files 3909c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 391000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 391100df344fSAndy Whitcroft# print "$herecurr"; 391200df344fSAndy Whitcroft# $clean = 0; 391300df344fSAndy Whitcroft# } 391400df344fSAndy Whitcroft 391522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3916c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 39173705ce5bSJoe Perches if (ERROR("SPACING", 39183705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 39193705ce5bSJoe Perches $fix) { 39203705ce5bSJoe Perches $fixed[$linenr - 1] =~ 39213705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 39223705ce5bSJoe Perches } 39233705ce5bSJoe Perches 392422f2a2efSAndy Whitcroft } 392522f2a2efSAndy Whitcroft 39264a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3927171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3928171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 39294a0df2efSAndy Whitcroft my $which = $1; 39304a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3931000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3932000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 39334a0df2efSAndy Whitcroft } 39344a0df2efSAndy Whitcroft } 39354a0df2efSAndy Whitcroft# check for memory barriers without a comment. 39364a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 39374a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3938c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 3939000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 39404a0df2efSAndy Whitcroft } 39414a0df2efSAndy Whitcroft } 39424a0df2efSAndy Whitcroft# check of hardware specific defines 3943c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3944000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3945000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 39460a920b5bSAndy Whitcroft } 3947653d4876SAndy Whitcroft 3948d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3949d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3950000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3951000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3952d4977c78STobias Klauser } 3953d4977c78STobias Klauser 3954de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3955de7d4f0eSAndy Whitcroft# storage class and type. 39569c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 39579c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3958000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3959000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3960de7d4f0eSAndy Whitcroft } 3961de7d4f0eSAndy Whitcroft 39628905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 39632b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39642b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 3965d5e616fcSJoe Perches if (WARN("INLINE", 3966d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 3967d5e616fcSJoe Perches $fix) { 3968d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 3969d5e616fcSJoe Perches 3970d5e616fcSJoe Perches } 39718905a67cSAndy Whitcroft } 39728905a67cSAndy Whitcroft 39733d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 39742b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39752b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3976000d1cc1SJoe Perches WARN("PREFER_PACKED", 3977000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 39783d130fd0SJoe Perches } 39793d130fd0SJoe Perches 398039b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 39812b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39822b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3983000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3984000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 398539b7e287SJoe Perches } 398639b7e287SJoe Perches 39875f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 39882b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39892b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 3990d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 3991d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 3992d5e616fcSJoe Perches $fix) { 3993d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 3994d5e616fcSJoe Perches 3995d5e616fcSJoe Perches } 39965f14d3bdSJoe Perches } 39975f14d3bdSJoe Perches 39986061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 39992b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 40002b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4001d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4002d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4003d5e616fcSJoe Perches $fix) { 4004d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4005d5e616fcSJoe Perches } 40066061d949SJoe Perches } 40076061d949SJoe Perches 40088f53a9b8SJoe Perches# check for sizeof(&) 40098f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4010000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4011000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 40128f53a9b8SJoe Perches } 40138f53a9b8SJoe Perches 401466c80b60SJoe Perches# check for sizeof without parenthesis 401566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4016d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4017d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4018d5e616fcSJoe Perches $fix) { 4019d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4020d5e616fcSJoe Perches } 402166c80b60SJoe Perches } 402266c80b60SJoe Perches 4023428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4024428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4025000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4026000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4027428e2fdcSJoe Perches } 4028428e2fdcSJoe Perches 402988982feaSJoe Perches# check for struct spinlock declarations 403088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 403188982feaSJoe Perches WARN("USE_SPINLOCK_T", 403288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 403388982feaSJoe Perches } 403488982feaSJoe Perches 4035a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 403606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4037a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 403806668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4039d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4040d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4041d5e616fcSJoe Perches $fix) { 4042d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 4043d5e616fcSJoe Perches } 4044a6962d72SJoe Perches } 4045a6962d72SJoe Perches } 4046a6962d72SJoe Perches 4047554e165cSAndy Whitcroft# Check for misused memsets 4048d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4049d1fe9c09SJoe Perches defined $stat && 4050d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4051554e165cSAndy Whitcroft 4052d7c76ba7SJoe Perches my $ms_addr = $2; 4053d1fe9c09SJoe Perches my $ms_val = $7; 4054d1fe9c09SJoe Perches my $ms_size = $12; 4055d7c76ba7SJoe Perches 4056554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4057554e165cSAndy Whitcroft ERROR("MEMSET", 4058d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4059554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4060554e165cSAndy Whitcroft WARN("MEMSET", 4061d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4062d7c76ba7SJoe Perches } 4063d7c76ba7SJoe Perches } 4064d7c76ba7SJoe Perches 4065d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4066d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4067d1fe9c09SJoe Perches defined $stat && 4068d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4069d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4070d7c76ba7SJoe Perches my $call = $1; 4071d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4072d7c76ba7SJoe Perches my $arg1 = $3; 4073d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4074d1fe9c09SJoe Perches my $arg2 = $8; 4075d7c76ba7SJoe Perches my $cast; 4076d7c76ba7SJoe Perches 4077d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4078d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4079d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4080d7c76ba7SJoe Perches $cast = $cast1; 4081d7c76ba7SJoe Perches } else { 4082d7c76ba7SJoe Perches $cast = $cast2; 4083d7c76ba7SJoe Perches } 4084d7c76ba7SJoe Perches WARN("MINMAX", 4085d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4086554e165cSAndy Whitcroft } 4087554e165cSAndy Whitcroft } 4088554e165cSAndy Whitcroft 40894a273195SJoe Perches# check usleep_range arguments 40904a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 40914a273195SJoe Perches defined $stat && 40924a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 40934a273195SJoe Perches my $min = $1; 40944a273195SJoe Perches my $max = $7; 40954a273195SJoe Perches if ($min eq $max) { 40964a273195SJoe Perches WARN("USLEEP_RANGE", 40974a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 40984a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 40994a273195SJoe Perches $min > $max) { 41004a273195SJoe Perches WARN("USLEEP_RANGE", 41014a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 41024a273195SJoe Perches } 41034a273195SJoe Perches } 41044a273195SJoe Perches 4105823b794cSJoe Perches# check for naked sscanf 4106823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4107823b794cSJoe Perches defined $stat && 4108823b794cSJoe Perches $stat =~ /\bsscanf\b/ && 4109823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4110823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4111823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4112823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4113823b794cSJoe Perches $lc = $lc + $linenr; 4114823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4115823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4116823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4117823b794cSJoe Perches } 4118823b794cSJoe Perches WARN("NAKED_SSCANF", 4119823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4120823b794cSJoe Perches } 4121823b794cSJoe Perches 412270dc8a48SJoe Perches# check for new externs in .h files. 412370dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 412470dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4125d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 412670dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 412770dc8a48SJoe Perches $fix) { 412870dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 412970dc8a48SJoe Perches } 413070dc8a48SJoe Perches } 413170dc8a48SJoe Perches 4132de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4133171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4134c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4135171ae1a4SAndy Whitcroft { 4136c45dcabdSAndy Whitcroft my $function_name = $1; 4137c45dcabdSAndy Whitcroft my $paren_space = $2; 4138171ae1a4SAndy Whitcroft 4139171ae1a4SAndy Whitcroft my $s = $stat; 4140171ae1a4SAndy Whitcroft if (defined $cond) { 4141171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4142171ae1a4SAndy Whitcroft } 4143c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4144c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4145c45dcabdSAndy Whitcroft { 4146000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4147000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4148de7d4f0eSAndy Whitcroft } 4149de7d4f0eSAndy Whitcroft 4150171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4151000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4152000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4153171ae1a4SAndy Whitcroft } 41549c9ba34eSAndy Whitcroft 41559c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 41569c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 41579c9ba34eSAndy Whitcroft { 4158000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4159000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4160171ae1a4SAndy Whitcroft } 4161171ae1a4SAndy Whitcroft 4162de7d4f0eSAndy Whitcroft# checks for new __setup's 4163de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4164de7d4f0eSAndy Whitcroft my $name = $1; 4165de7d4f0eSAndy Whitcroft 4166de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4167000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4168000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4169de7d4f0eSAndy Whitcroft } 4170653d4876SAndy Whitcroft } 41719c0ca6f9SAndy Whitcroft 41729c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4173caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4174000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4175000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 41769c0ca6f9SAndy Whitcroft } 417713214adfSAndy Whitcroft 4178a640d25cSJoe Perches# alloc style 4179a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4180a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4181a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4182a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4183a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4184a640d25cSJoe Perches } 4185a640d25cSJoe Perches 4186972fdea2SJoe Perches# check for krealloc arg reuse 4187972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4188972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4189972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4190972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4191972fdea2SJoe Perches } 4192972fdea2SJoe Perches 41935ce59ae0SJoe Perches# check for alloc argument mismatch 41945ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 41955ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 41965ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 41975ce59ae0SJoe Perches } 41985ce59ae0SJoe Perches 41997e4915e7SDavid Rientjes# check for GFP_NOWAIT use 42007e4915e7SDavid Rientjes if ($line =~ /\b__GFP_NOFAIL\b/) { 42017e4915e7SDavid Rientjes WARN("__GFP_NOFAIL", 42027e4915e7SDavid Rientjes "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr); 42037e4915e7SDavid Rientjes } 42047e4915e7SDavid Rientjes 4205caf2a54fSJoe Perches# check for multiple semicolons 4206caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4207d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4208d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4209d5e616fcSJoe Perches $fix) { 4210d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4211d5e616fcSJoe Perches } 4212d1e2ad07SJoe Perches } 4213d1e2ad07SJoe Perches 4214c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4215c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4216c34c09a8SJoe Perches my $has_break = 0; 4217c34c09a8SJoe Perches my $has_statement = 0; 4218c34c09a8SJoe Perches my $count = 0; 4219c34c09a8SJoe Perches my $prevline = $linenr; 4220c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4221c34c09a8SJoe Perches $prevline--; 4222c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4223c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4224c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4225c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4226c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4227c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4228c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4229c34c09a8SJoe Perches $has_statement = 1; 4230c34c09a8SJoe Perches $count++; 4231c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4232c34c09a8SJoe Perches } 4233c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4234c34c09a8SJoe Perches WARN("MISSING_BREAK", 4235c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4236c34c09a8SJoe Perches } 4237c34c09a8SJoe Perches } 4238c34c09a8SJoe Perches 4239d1e2ad07SJoe Perches# check for switch/default statements without a break; 4240d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4241d1e2ad07SJoe Perches defined $stat && 4242d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4243d1e2ad07SJoe Perches my $ctx = ''; 4244d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4245d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4246d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4247d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4248d1e2ad07SJoe Perches } 4249d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4250d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4251caf2a54fSJoe Perches } 4252caf2a54fSJoe Perches 425313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4254d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4255d5e616fcSJoe Perches if (WARN("USE_FUNC", 4256d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4257d5e616fcSJoe Perches $fix) { 4258d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4259d5e616fcSJoe Perches } 426013214adfSAndy Whitcroft } 4261773647a0SAndy Whitcroft 42622c92488aSJoe Perches# check for use of yield() 42632c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 42642c92488aSJoe Perches WARN("YIELD", 42652c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 42662c92488aSJoe Perches } 42672c92488aSJoe Perches 4268179f8f40SJoe Perches# check for comparisons against true and false 4269179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4270179f8f40SJoe Perches my $lead = $1; 4271179f8f40SJoe Perches my $arg = $2; 4272179f8f40SJoe Perches my $test = $3; 4273179f8f40SJoe Perches my $otype = $4; 4274179f8f40SJoe Perches my $trail = $5; 4275179f8f40SJoe Perches my $op = "!"; 4276179f8f40SJoe Perches 4277179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4278179f8f40SJoe Perches 4279179f8f40SJoe Perches my $type = lc($otype); 4280179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4281179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4282179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4283179f8f40SJoe Perches $op = ""; 4284179f8f40SJoe Perches } 4285179f8f40SJoe Perches 4286179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4287179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4288179f8f40SJoe Perches 4289179f8f40SJoe Perches## maybe suggesting a correct construct would better 4290179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4291179f8f40SJoe Perches 4292179f8f40SJoe Perches } 4293179f8f40SJoe Perches } 4294179f8f40SJoe Perches 42954882720bSThomas Gleixner# check for semaphores initialized locked 42964882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4297000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4298000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4299773647a0SAndy Whitcroft } 43006712d858SJoe Perches 430167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 430267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4303000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 430467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4305773647a0SAndy Whitcroft } 43066712d858SJoe Perches 4307f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4308f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4309000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4310000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4311f3db6639SMichael Ellerman } 43126712d858SJoe Perches 431379404849SEmese Revfy# check for various ops structs, ensure they are const. 431479404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 431579404849SEmese Revfy address_space_operations| 431679404849SEmese Revfy backlight_ops| 431779404849SEmese Revfy block_device_operations| 431879404849SEmese Revfy dentry_operations| 431979404849SEmese Revfy dev_pm_ops| 432079404849SEmese Revfy dma_map_ops| 432179404849SEmese Revfy extent_io_ops| 432279404849SEmese Revfy file_lock_operations| 432379404849SEmese Revfy file_operations| 432479404849SEmese Revfy hv_ops| 432579404849SEmese Revfy ide_dma_ops| 432679404849SEmese Revfy intel_dvo_dev_ops| 432779404849SEmese Revfy item_operations| 432879404849SEmese Revfy iwl_ops| 432979404849SEmese Revfy kgdb_arch| 433079404849SEmese Revfy kgdb_io| 433179404849SEmese Revfy kset_uevent_ops| 433279404849SEmese Revfy lock_manager_operations| 433379404849SEmese Revfy microcode_ops| 433479404849SEmese Revfy mtrr_ops| 433579404849SEmese Revfy neigh_ops| 433679404849SEmese Revfy nlmsvc_binding| 433779404849SEmese Revfy pci_raw_ops| 433879404849SEmese Revfy pipe_buf_operations| 433979404849SEmese Revfy platform_hibernation_ops| 434079404849SEmese Revfy platform_suspend_ops| 434179404849SEmese Revfy proto_ops| 434279404849SEmese Revfy rpc_pipe_ops| 434379404849SEmese Revfy seq_operations| 434479404849SEmese Revfy snd_ac97_build_ops| 434579404849SEmese Revfy soc_pcmcia_socket_ops| 434679404849SEmese Revfy stacktrace_ops| 434779404849SEmese Revfy sysfs_ops| 434879404849SEmese Revfy tty_operations| 434979404849SEmese Revfy usb_mon_operations| 435079404849SEmese Revfy wd_ops}x; 43516903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 435279404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4353000d1cc1SJoe Perches WARN("CONST_STRUCT", 4354000d1cc1SJoe Perches "struct $1 should normally be const\n" . 43556903ffb2SAndy Whitcroft $herecurr); 43562b6db5cbSAndy Whitcroft } 4357773647a0SAndy Whitcroft 4358773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4359773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4360773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4361c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4362c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4363171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4364171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4365171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4366773647a0SAndy Whitcroft { 4367000d1cc1SJoe Perches WARN("NR_CPUS", 4368000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4369773647a0SAndy Whitcroft } 43709c9ba34eSAndy Whitcroft 437152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 437252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 437352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 437452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 437552ea8506SJoe Perches } 437652ea8506SJoe Perches 43779c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 43789c9ba34eSAndy Whitcroft my $string; 43799c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 43809c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 43812a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 43829c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4383000d1cc1SJoe Perches WARN("PRINTF_L", 4384000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 43859c9ba34eSAndy Whitcroft last; 43869c9ba34eSAndy Whitcroft } 43879c9ba34eSAndy Whitcroft } 4388691d77b6SAndy Whitcroft 4389691d77b6SAndy Whitcroft# whine mightly about in_atomic 4390691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4391691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4392000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4393000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4394f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4395000d1cc1SJoe Perches WARN("IN_ATOMIC", 4396000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4397691d77b6SAndy Whitcroft } 4398691d77b6SAndy Whitcroft } 43991704f47bSPeter Zijlstra 44001704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 44011704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 44021704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 44031704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 44041704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 44051704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4406000d1cc1SJoe Perches ERROR("LOCKDEP", 4407000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 44081704f47bSPeter Zijlstra } 44091704f47bSPeter Zijlstra } 441088f8831cSDave Jones 441188f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 441288f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4413000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4414000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 441588f8831cSDave Jones } 441613214adfSAndy Whitcroft } 441713214adfSAndy Whitcroft 441813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 441913214adfSAndy Whitcroft # so just keep quiet. 442013214adfSAndy Whitcroft if ($#rawlines == -1) { 442113214adfSAndy Whitcroft exit(0); 44220a920b5bSAndy Whitcroft } 44230a920b5bSAndy Whitcroft 44248905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 44258905a67cSAndy Whitcroft # things that appear to be patches. 44268905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 44278905a67cSAndy Whitcroft exit(0); 44288905a67cSAndy Whitcroft } 44298905a67cSAndy Whitcroft 44308905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 44318905a67cSAndy Whitcroft # just keep quiet. 44328905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 44338905a67cSAndy Whitcroft exit(0); 44348905a67cSAndy Whitcroft } 44358905a67cSAndy Whitcroft 44368905a67cSAndy Whitcroft if (!$is_patch) { 4437000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4438000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 44390a920b5bSAndy Whitcroft } 44400a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4441000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4442000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 44430a920b5bSAndy Whitcroft } 44440a920b5bSAndy Whitcroft 4445f0a594c1SAndy Whitcroft print report_dump(); 444613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 444713214adfSAndy Whitcroft print "$filename " if ($summary_file); 44486c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 44496c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 44506c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 44518905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 44526c72ffaaSAndy Whitcroft } 44538905a67cSAndy Whitcroft 4454d2c0a235SAndy Whitcroft if ($quiet == 0) { 4455d1fe9c09SJoe Perches 4456d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4457d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4458d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4459d1fe9c09SJoe Perches } 4460d1fe9c09SJoe Perches 4461d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4462d2c0a235SAndy Whitcroft # then suggest that. 4463d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4464d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4465d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4466b0781216SMike Frysinger $rpt_cleaners = 0; 4467d2c0a235SAndy Whitcroft } 4468d2c0a235SAndy Whitcroft } 4469d2c0a235SAndy Whitcroft 447091bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 447191bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4472000d1cc1SJoe Perches 44733705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 44749624b8d6SJoe Perches my $newfile = $filename; 44759624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 44763705ce5bSJoe Perches my $linecount = 0; 44773705ce5bSJoe Perches my $f; 44783705ce5bSJoe Perches 44793705ce5bSJoe Perches open($f, '>', $newfile) 44803705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 44813705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 44823705ce5bSJoe Perches $linecount++; 44833705ce5bSJoe Perches if ($file) { 44843705ce5bSJoe Perches if ($linecount > 3) { 44853705ce5bSJoe Perches $fixed_line =~ s/^\+//; 44863705ce5bSJoe Perches print $f $fixed_line. "\n"; 44873705ce5bSJoe Perches } 44883705ce5bSJoe Perches } else { 44893705ce5bSJoe Perches print $f $fixed_line . "\n"; 44903705ce5bSJoe Perches } 44913705ce5bSJoe Perches } 44923705ce5bSJoe Perches close($f); 44933705ce5bSJoe Perches 44943705ce5bSJoe Perches if (!$quiet) { 44953705ce5bSJoe Perches print << "EOM"; 44963705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 44973705ce5bSJoe Perches 44983705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 44993705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 45003705ce5bSJoe Perches 45013705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 45023705ce5bSJoe PerchesNo warranties, expressed or implied... 45033705ce5bSJoe Perches 45043705ce5bSJoe PerchesEOM 45053705ce5bSJoe Perches } 45063705ce5bSJoe Perches } 45073705ce5bSJoe Perches 45080a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4509c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 45100a920b5bSAndy Whitcroft } 45110a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4512000d1cc1SJoe Perches print << "EOM"; 4513000d1cc1SJoe Perches$vname has style problems, please review. 4514000d1cc1SJoe Perches 4515000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4516000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4517000d1cc1SJoe PerchesEOM 45180a920b5bSAndy Whitcroft } 451913214adfSAndy Whitcroft 45200a920b5bSAndy Whitcroft return $clean; 45210a920b5bSAndy Whitcroft} 4522