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; 1036061e38SJoe Perchesuse File::Basename; 1136061e38SJoe Perchesuse Cwd 'abs_path'; 120a920b5bSAndy Whitcroft 130a920b5bSAndy Whitcroftmy $P = $0; 1436061e38SJoe Perchesmy $D = dirname(abs_path($P)); 150a920b5bSAndy Whitcroft 16000d1cc1SJoe Perchesmy $V = '0.32'; 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 190a920b5bSAndy Whitcroft 200a920b5bSAndy Whitcroftmy $quiet = 0; 210a920b5bSAndy Whitcroftmy $tree = 1; 220a920b5bSAndy Whitcroftmy $chk_signoff = 1; 230a920b5bSAndy Whitcroftmy $chk_patch = 1; 24773647a0SAndy Whitcroftmy $tst_only; 256c72ffaaSAndy Whitcroftmy $emacs = 0; 268905a67cSAndy Whitcroftmy $terse = 0; 276c72ffaaSAndy Whitcroftmy $file = 0; 286c72ffaaSAndy Whitcroftmy $check = 0; 292ac73b4fSJoe Perchesmy $check_orig = 0; 308905a67cSAndy Whitcroftmy $summary = 1; 318905a67cSAndy Whitcroftmy $mailback = 0; 3213214adfSAndy Whitcroftmy $summary_file = 0; 33000d1cc1SJoe Perchesmy $show_types = 0; 343705ce5bSJoe Perchesmy $fix = 0; 359624b8d6SJoe Perchesmy $fix_inplace = 0; 366c72ffaaSAndy Whitcroftmy $root; 37c2fdda0dSAndy Whitcroftmy %debug; 383445686aSJoe Perchesmy %camelcase = (); 3991bfe484SJoe Perchesmy %use_type = (); 4091bfe484SJoe Perchesmy @use = (); 4191bfe484SJoe Perchesmy %ignore_type = (); 42000d1cc1SJoe Perchesmy @ignore = (); 4377f5b10aSHannes Edermy $help = 0; 44000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 456cd7f386SJoe Perchesmy $max_line_length = 80; 46d62a201fSDave Hansenmy $ignore_perl_version = 0; 47d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4856193274SVadim Bendeburymy $min_conf_desc_length = 4; 4966b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 5077f5b10aSHannes Eder 5177f5b10aSHannes Edersub help { 5277f5b10aSHannes Eder my ($exitcode) = @_; 5377f5b10aSHannes Eder 5477f5b10aSHannes Eder print << "EOM"; 5577f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5677f5b10aSHannes EderVersion: $V 5777f5b10aSHannes Eder 5877f5b10aSHannes EderOptions: 5977f5b10aSHannes Eder -q, --quiet quiet 6077f5b10aSHannes Eder --no-tree run without a kernel tree 6177f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 6277f5b10aSHannes Eder --patch treat FILE as patchfile (default) 6377f5b10aSHannes Eder --emacs emacs compile window format 6477f5b10aSHannes Eder --terse one line per report 6577f5b10aSHannes Eder -f, --file treat FILE as regular source file 6677f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6791bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 68000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 696cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 7056193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 71000d1cc1SJoe Perches --show-types show the message "types" in the output 7277f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 7377f5b10aSHannes Eder --no-summary suppress the per-file summary 7477f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 7577f5b10aSHannes Eder --summary-file include the filename in summary 7677f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7777f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7877f5b10aSHannes Eder is all off) 7977f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 8077f5b10aSHannes Eder literally 813705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 823705ce5bSJoe Perches If correctable single-line errors exist, create 833705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 843705ce5bSJoe Perches with potential errors corrected to the preferred 853705ce5bSJoe Perches checkpatch style 869624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 879624b8d6SJoe Perches Is the same as --fix, but overwrites the input 889624b8d6SJoe Perches file. It's your fault if there's no backup or git 89d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 90d62a201fSDave Hansen runtime errors. 9177f5b10aSHannes Eder -h, --help, --version display this help and exit 9277f5b10aSHannes Eder 9377f5b10aSHannes EderWhen FILE is - read standard input. 9477f5b10aSHannes EderEOM 9577f5b10aSHannes Eder 9677f5b10aSHannes Eder exit($exitcode); 9777f5b10aSHannes Eder} 9877f5b10aSHannes Eder 99000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 100000d1cc1SJoe Perchesif (-f $conf) { 101000d1cc1SJoe Perches my @conf_args; 102000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 103000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 104000d1cc1SJoe Perches 105000d1cc1SJoe Perches while (<$conffile>) { 106000d1cc1SJoe Perches my $line = $_; 107000d1cc1SJoe Perches 108000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 109000d1cc1SJoe Perches $line =~ s/^\s*//g; 110000d1cc1SJoe Perches $line =~ s/\s+/ /g; 111000d1cc1SJoe Perches 112000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 113000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 114000d1cc1SJoe Perches 115000d1cc1SJoe Perches my @words = split(" ", $line); 116000d1cc1SJoe Perches foreach my $word (@words) { 117000d1cc1SJoe Perches last if ($word =~ m/^#/); 118000d1cc1SJoe Perches push (@conf_args, $word); 119000d1cc1SJoe Perches } 120000d1cc1SJoe Perches } 121000d1cc1SJoe Perches close($conffile); 122000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 123000d1cc1SJoe Perches} 124000d1cc1SJoe Perches 1250a920b5bSAndy WhitcroftGetOptions( 1266c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1270a920b5bSAndy Whitcroft 'tree!' => \$tree, 1280a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1290a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1306c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1318905a67cSAndy Whitcroft 'terse!' => \$terse, 13277f5b10aSHannes Eder 'f|file!' => \$file, 1336c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1346c72ffaaSAndy Whitcroft 'strict!' => \$check, 135000d1cc1SJoe Perches 'ignore=s' => \@ignore, 13691bfe484SJoe Perches 'types=s' => \@use, 137000d1cc1SJoe Perches 'show-types!' => \$show_types, 1386cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 13956193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1406c72ffaaSAndy Whitcroft 'root=s' => \$root, 1418905a67cSAndy Whitcroft 'summary!' => \$summary, 1428905a67cSAndy Whitcroft 'mailback!' => \$mailback, 14313214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1443705ce5bSJoe Perches 'fix!' => \$fix, 1459624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 146d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 147c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 148773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 14977f5b10aSHannes Eder 'h|help' => \$help, 15077f5b10aSHannes Eder 'version' => \$help 15177f5b10aSHannes Eder) or help(1); 15277f5b10aSHannes Eder 15377f5b10aSHannes Ederhelp(0) if ($help); 1540a920b5bSAndy Whitcroft 1559624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1562ac73b4fSJoe Perches$check_orig = $check; 1579624b8d6SJoe Perches 1580a920b5bSAndy Whitcroftmy $exit = 0; 1590a920b5bSAndy Whitcroft 160d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 161d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 162d62a201fSDave Hansen if (!$ignore_perl_version) { 163d62a201fSDave Hansen exit(1); 164d62a201fSDave Hansen } 165d62a201fSDave Hansen} 166d62a201fSDave Hansen 1670a920b5bSAndy Whitcroftif ($#ARGV < 0) { 16877f5b10aSHannes Eder print "$P: no input files\n"; 1690a920b5bSAndy Whitcroft exit(1); 1700a920b5bSAndy Whitcroft} 1710a920b5bSAndy Whitcroft 17291bfe484SJoe Perchessub hash_save_array_words { 17391bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 17491bfe484SJoe Perches 17591bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 17691bfe484SJoe Perches foreach my $word (@array) { 177000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 178000d1cc1SJoe Perches $word =~ s/^\s*//g; 179000d1cc1SJoe Perches $word =~ s/\s+/ /g; 180000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 181000d1cc1SJoe Perches 182000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 183000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 184000d1cc1SJoe Perches 18591bfe484SJoe Perches $hashRef->{$word}++; 186000d1cc1SJoe Perches } 18791bfe484SJoe Perches} 18891bfe484SJoe Perches 18991bfe484SJoe Perchessub hash_show_words { 19091bfe484SJoe Perches my ($hashRef, $prefix) = @_; 19191bfe484SJoe Perches 19258cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 19391bfe484SJoe Perches print "NOTE: $prefix message types:"; 19458cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 19591bfe484SJoe Perches print " $word"; 19691bfe484SJoe Perches } 19791bfe484SJoe Perches print "\n\n"; 19891bfe484SJoe Perches } 19991bfe484SJoe Perches} 20091bfe484SJoe Perches 20191bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 20291bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 203000d1cc1SJoe Perches 204c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 205c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2067429c690SAndy Whitcroftmy $dbg_type = 0; 207a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 208c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 20921caa13cSAndy Whitcroft ## no critic 21021caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 21121caa13cSAndy Whitcroft die "$@" if ($@); 212c2fdda0dSAndy Whitcroft} 213c2fdda0dSAndy Whitcroft 214d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 215d2c0a235SAndy Whitcroft 2168905a67cSAndy Whitcroftif ($terse) { 2178905a67cSAndy Whitcroft $emacs = 1; 2188905a67cSAndy Whitcroft $quiet++; 2198905a67cSAndy Whitcroft} 2208905a67cSAndy Whitcroft 2216c72ffaaSAndy Whitcroftif ($tree) { 2226c72ffaaSAndy Whitcroft if (defined $root) { 2236c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2246c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2256c72ffaaSAndy Whitcroft } 2266c72ffaaSAndy Whitcroft } else { 2276c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2286c72ffaaSAndy Whitcroft $root = '.'; 2296c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2306c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2316c72ffaaSAndy Whitcroft $root = $1; 2326c72ffaaSAndy Whitcroft } 2336c72ffaaSAndy Whitcroft } 2346c72ffaaSAndy Whitcroft 2356c72ffaaSAndy Whitcroft if (!defined $root) { 2360a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2370a920b5bSAndy Whitcroft exit(2); 2380a920b5bSAndy Whitcroft } 2396c72ffaaSAndy Whitcroft} 2406c72ffaaSAndy Whitcroft 2416c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2426c72ffaaSAndy Whitcroft 2432ceb532bSAndy Whitcroftour $Ident = qr{ 2442ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2452ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2462ceb532bSAndy Whitcroft }x; 2476c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2486c72ffaaSAndy Whitcroftour $Sparse = qr{ 2496c72ffaaSAndy Whitcroft __user| 2506c72ffaaSAndy Whitcroft __kernel| 2516c72ffaaSAndy Whitcroft __force| 2526c72ffaaSAndy Whitcroft __iomem| 2536c72ffaaSAndy Whitcroft __must_check| 2546c72ffaaSAndy Whitcroft __init_refok| 255417495edSAndy Whitcroft __kprobes| 256165e72a6SSven Eckelmann __ref| 257165e72a6SSven Eckelmann __rcu 2586c72ffaaSAndy Whitcroft }x; 259e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 260e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 261e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 262e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 263e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2648716de38SJoe Perches 26552131292SWolfram Sang# Notes to $Attribute: 26652131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2676c72ffaaSAndy Whitcroftour $Attribute = qr{ 2686c72ffaaSAndy Whitcroft const| 26903f1df7dSJoe Perches __percpu| 27003f1df7dSJoe Perches __nocast| 27103f1df7dSJoe Perches __safe| 27203f1df7dSJoe Perches __bitwise__| 27303f1df7dSJoe Perches __packed__| 27403f1df7dSJoe Perches __packed2__| 27503f1df7dSJoe Perches __naked| 27603f1df7dSJoe Perches __maybe_unused| 27703f1df7dSJoe Perches __always_unused| 27803f1df7dSJoe Perches __noreturn| 27903f1df7dSJoe Perches __used| 28003f1df7dSJoe Perches __cold| 28103f1df7dSJoe Perches __noclone| 28203f1df7dSJoe Perches __deprecated| 2836c72ffaaSAndy Whitcroft __read_mostly| 2846c72ffaaSAndy Whitcroft __kprobes| 2858716de38SJoe Perches $InitAttribute| 28624e1d81aSAndy Whitcroft ____cacheline_aligned| 28724e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2885fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2895fe3af11SAndy Whitcroft __weak 2906c72ffaaSAndy Whitcroft }x; 291c45dcabdSAndy Whitcroftour $Modifier; 29291cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 2936c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2946c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2956c72ffaaSAndy Whitcroft 29695e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 29795e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 29895e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 29995e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3002435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 301326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 302326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 303326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 30474349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3052435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 306326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 307447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 30823f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3096c72ffaaSAndy Whitcroftour $Operators = qr{ 3106c72ffaaSAndy Whitcroft <=|>=|==|!=| 3116c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 31223f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3136c72ffaaSAndy Whitcroft }x; 3146c72ffaaSAndy Whitcroft 31591cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 31691cb5195SJoe Perches 3178905a67cSAndy Whitcroftour $NonptrType; 3181813087dSJoe Perchesour $NonptrTypeMisordered; 3198716de38SJoe Perchesour $NonptrTypeWithAttr; 3208905a67cSAndy Whitcroftour $Type; 3211813087dSJoe Perchesour $TypeMisordered; 3228905a67cSAndy Whitcroftour $Declare; 3231813087dSJoe Perchesour $DeclareMisordered; 3248905a67cSAndy Whitcroft 32515662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 32615662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 327171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 328171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 329171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 330171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 331171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 332171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 333171ae1a4SAndy Whitcroft}x; 334171ae1a4SAndy Whitcroft 33515662b3eSJoe Perchesour $UTF8 = qr{ 33615662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 33715662b3eSJoe Perches | $NON_ASCII_UTF8 33815662b3eSJoe Perches}x; 33915662b3eSJoe Perches 3408ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 341fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3428ed22cadSAndy Whitcroft atomic_t 3438ed22cadSAndy Whitcroft)}; 3448ed22cadSAndy Whitcroft 345691e669bSJoe Perchesour $logFunctions = qr{(?x: 3466e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3477d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3486e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 349b0531722SJoe Perches panic| 35006668727SJoe Perches MODULE_[A-Z_]+| 35106668727SJoe Perches seq_vprintf|seq_printf|seq_puts 352691e669bSJoe Perches)}; 353691e669bSJoe Perches 35420112475SJoe Perchesour $signature_tags = qr{(?xi: 35520112475SJoe Perches Signed-off-by:| 35620112475SJoe Perches Acked-by:| 35720112475SJoe Perches Tested-by:| 35820112475SJoe Perches Reviewed-by:| 35920112475SJoe Perches Reported-by:| 3608543ae12SMugunthan V N Suggested-by:| 36120112475SJoe Perches To:| 36220112475SJoe Perches Cc: 36320112475SJoe Perches)}; 36420112475SJoe Perches 3651813087dSJoe Perchesour @typeListMisordered = ( 3661813087dSJoe Perches qr{char\s+(?:un)?signed}, 3671813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3681813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 3691813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 3701813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 3711813087dSJoe Perches qr{short\s+(?:un)?signed}, 3721813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 3731813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 3741813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 3751813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 3761813087dSJoe Perches qr{int\s+(?:un)?signed}, 3771813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 3781813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 3791813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 3801813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 3811813087dSJoe Perches qr{long\s+(?:un)?signed}, 3821813087dSJoe Perches); 3831813087dSJoe Perches 3848905a67cSAndy Whitcroftour @typeList = ( 3858905a67cSAndy Whitcroft qr{void}, 3860c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 3870c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 3880c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 3890c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 3900c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 3910c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 3920c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 3930c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 3940c773d9dSJoe Perches qr{(?:un)?signed}, 3958905a67cSAndy Whitcroft qr{float}, 3968905a67cSAndy Whitcroft qr{double}, 3978905a67cSAndy Whitcroft qr{bool}, 3988905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3998905a67cSAndy Whitcroft qr{union\s+$Ident}, 4008905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4018905a67cSAndy Whitcroft qr{${Ident}_t}, 4028905a67cSAndy Whitcroft qr{${Ident}_handler}, 4038905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4041813087dSJoe Perches @typeListMisordered, 4058905a67cSAndy Whitcroft); 4068716de38SJoe Perchesour @typeListWithAttr = ( 4078716de38SJoe Perches @typeList, 4088716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4098716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4108716de38SJoe Perches); 4118716de38SJoe Perches 412c45dcabdSAndy Whitcroftour @modifierList = ( 413c45dcabdSAndy Whitcroft qr{fastcall}, 414c45dcabdSAndy Whitcroft); 4158905a67cSAndy Whitcroft 4162435880fSJoe Perchesour @mode_permission_funcs = ( 4172435880fSJoe Perches ["module_param", 3], 4182435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4192435880fSJoe Perches ["module_param_array_named", 5], 4202435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4212435880fSJoe Perches ["proc_create(?:_data|)", 2], 4222435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4232435880fSJoe Perches); 4242435880fSJoe Perches 425515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 426515a235eSJoe Perchesour $mode_perms_search = ""; 427515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 428515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 429515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 430515a235eSJoe Perches} 431515a235eSJoe Perches 4327840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4337840a94cSWolfram Sang irq| 434cdcee686SSergey Ryazanov memory| 435cdcee686SSergey Ryazanov time| 436cdcee686SSergey Ryazanov reboot 4377840a94cSWolfram Sang)}; 4387840a94cSWolfram Sang# memory.h: ARM has a custom one 4397840a94cSWolfram Sang 44066b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 44166b47b4aSKees Cookmy $misspellings; 44266b47b4aSKees Cookmy %spelling_fix; 44336061e38SJoe Perches 44436061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 44536061e38SJoe Perches my @spelling_list; 44666b47b4aSKees Cook while (<$spelling>) { 44766b47b4aSKees Cook my $line = $_; 44866b47b4aSKees Cook 44966b47b4aSKees Cook $line =~ s/\s*\n?$//g; 45066b47b4aSKees Cook $line =~ s/^\s*//g; 45166b47b4aSKees Cook 45266b47b4aSKees Cook next if ($line =~ m/^\s*#/); 45366b47b4aSKees Cook next if ($line =~ m/^\s*$/); 45466b47b4aSKees Cook 45566b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 45666b47b4aSKees Cook 45766b47b4aSKees Cook push(@spelling_list, $suspect); 45866b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 45966b47b4aSKees Cook } 46066b47b4aSKees Cook close($spelling); 46166b47b4aSKees Cook $misspellings = join("|", @spelling_list); 46236061e38SJoe Perches} else { 46336061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 46436061e38SJoe Perches} 46566b47b4aSKees Cook 4668905a67cSAndy Whitcroftsub build_types { 467d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 468d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 4691813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 4708716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 471c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 4728905a67cSAndy Whitcroft $NonptrType = qr{ 473d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 474cf655043SAndy Whitcroft (?: 4756b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 4768ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 477c45dcabdSAndy Whitcroft (?:${all}\b) 478cf655043SAndy Whitcroft ) 479c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 4808905a67cSAndy Whitcroft }x; 4811813087dSJoe Perches $NonptrTypeMisordered = qr{ 4821813087dSJoe Perches (?:$Modifier\s+|const\s+)* 4831813087dSJoe Perches (?: 4841813087dSJoe Perches (?:${Misordered}\b) 4851813087dSJoe Perches ) 4861813087dSJoe Perches (?:\s+$Modifier|\s+const)* 4871813087dSJoe Perches }x; 4888716de38SJoe Perches $NonptrTypeWithAttr = qr{ 4898716de38SJoe Perches (?:$Modifier\s+|const\s+)* 4908716de38SJoe Perches (?: 4918716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 4928716de38SJoe Perches (?:$typeTypedefs\b)| 4938716de38SJoe Perches (?:${allWithAttr}\b) 4948716de38SJoe Perches ) 4958716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4968716de38SJoe Perches }x; 4978905a67cSAndy Whitcroft $Type = qr{ 498c45dcabdSAndy Whitcroft $NonptrType 4991574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 500c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5018905a67cSAndy Whitcroft }x; 5021813087dSJoe Perches $TypeMisordered = qr{ 5031813087dSJoe Perches $NonptrTypeMisordered 5041813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5051813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5061813087dSJoe Perches }x; 50791cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5081813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5098905a67cSAndy Whitcroft} 5108905a67cSAndy Whitcroftbuild_types(); 5116c72ffaaSAndy Whitcroft 5127d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 513d1fe9c09SJoe Perches 514d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 515d1fe9c09SJoe Perches# requires at least perl version v5.10.0 516d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 517d1fe9c09SJoe Perches 518d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5192435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 520d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 5217d2367afSJoe Perches 522f8422308SJoe Perchesour $declaration_macros = qr{(?x: 523f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 524f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 525f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 526f8422308SJoe Perches)}; 527f8422308SJoe Perches 5287d2367afSJoe Perchessub deparenthesize { 5297d2367afSJoe Perches my ($string) = @_; 5307d2367afSJoe Perches return "" if (!defined($string)); 5315b9553abSJoe Perches 5325b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5335b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5345b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5355b9553abSJoe Perches } 5365b9553abSJoe Perches 5377d2367afSJoe Perches $string =~ s@\s+@ @g; 5385b9553abSJoe Perches 5397d2367afSJoe Perches return $string; 5407d2367afSJoe Perches} 5417d2367afSJoe Perches 5423445686aSJoe Perchessub seed_camelcase_file { 5433445686aSJoe Perches my ($file) = @_; 5443445686aSJoe Perches 5453445686aSJoe Perches return if (!(-f $file)); 5463445686aSJoe Perches 5473445686aSJoe Perches local $/; 5483445686aSJoe Perches 5493445686aSJoe Perches open(my $include_file, '<', "$file") 5503445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 5513445686aSJoe Perches my $text = <$include_file>; 5523445686aSJoe Perches close($include_file); 5533445686aSJoe Perches 5543445686aSJoe Perches my @lines = split('\n', $text); 5553445686aSJoe Perches 5563445686aSJoe Perches foreach my $line (@lines) { 5573445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 5583445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 5593445686aSJoe Perches $camelcase{$1} = 1; 56011ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 56111ea516aSJoe Perches $camelcase{$1} = 1; 56211ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 5633445686aSJoe Perches $camelcase{$1} = 1; 5643445686aSJoe Perches } 5653445686aSJoe Perches } 5663445686aSJoe Perches} 5673445686aSJoe Perches 5683445686aSJoe Perchesmy $camelcase_seeded = 0; 5693445686aSJoe Perchessub seed_camelcase_includes { 5703445686aSJoe Perches return if ($camelcase_seeded); 5713445686aSJoe Perches 5723445686aSJoe Perches my $files; 573c707a81dSJoe Perches my $camelcase_cache = ""; 574c707a81dSJoe Perches my @include_files = (); 575c707a81dSJoe Perches 576c707a81dSJoe Perches $camelcase_seeded = 1; 577351b2a1fSJoe Perches 5783645e328SRichard Genoud if (-e ".git") { 579351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 580351b2a1fSJoe Perches chomp $git_last_include_commit; 581c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 582c707a81dSJoe Perches } else { 583c707a81dSJoe Perches my $last_mod_date = 0; 584c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 585c707a81dSJoe Perches @include_files = split('\n', $files); 586c707a81dSJoe Perches foreach my $file (@include_files) { 587c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 588c707a81dSJoe Perches localtime((stat $file)[9])); 589c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 590c707a81dSJoe Perches } 591c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 592c707a81dSJoe Perches } 593c707a81dSJoe Perches 594c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 595c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 596c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 597351b2a1fSJoe Perches while (<$camelcase_file>) { 598351b2a1fSJoe Perches chomp; 599351b2a1fSJoe Perches $camelcase{$_} = 1; 600351b2a1fSJoe Perches } 601351b2a1fSJoe Perches close($camelcase_file); 602351b2a1fSJoe Perches 603351b2a1fSJoe Perches return; 604351b2a1fSJoe Perches } 605c707a81dSJoe Perches 6063645e328SRichard Genoud if (-e ".git") { 607c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 608c707a81dSJoe Perches @include_files = split('\n', $files); 6093445686aSJoe Perches } 610c707a81dSJoe Perches 6113445686aSJoe Perches foreach my $file (@include_files) { 6123445686aSJoe Perches seed_camelcase_file($file); 6133445686aSJoe Perches } 614351b2a1fSJoe Perches 615c707a81dSJoe Perches if ($camelcase_cache ne "") { 616351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 617c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 618c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 619351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 620351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 621351b2a1fSJoe Perches } 622351b2a1fSJoe Perches close($camelcase_file); 623351b2a1fSJoe Perches } 6243445686aSJoe Perches} 6253445686aSJoe Perches 626d311cd44SJoe Perchessub git_commit_info { 627d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 628d311cd44SJoe Perches 629d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 630d311cd44SJoe Perches 631d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 632d311cd44SJoe Perches $output =~ s/^\s*//gm; 633d311cd44SJoe Perches my @lines = split("\n", $output); 634d311cd44SJoe Perches 635d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 636d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 637d311cd44SJoe Perches# all matching commit ids, but it's very slow... 638d311cd44SJoe Perches# 639d311cd44SJoe Perches# echo "checking commits $1..." 640d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 641d311cd44SJoe Perches# while read line ; do 642d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 643d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 644d311cd44SJoe Perches# done 645d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 646d311cd44SJoe Perches } else { 647d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 648d311cd44SJoe Perches $desc = substr($lines[0], 41); 649d311cd44SJoe Perches } 650d311cd44SJoe Perches 651d311cd44SJoe Perches return ($id, $desc); 652d311cd44SJoe Perches} 653d311cd44SJoe Perches 6546c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 6550a920b5bSAndy Whitcroft 65600df344fSAndy Whitcroftmy @rawlines = (); 657c2fdda0dSAndy Whitcroftmy @lines = (); 6583705ce5bSJoe Perchesmy @fixed = (); 659d752fcc8SJoe Perchesmy @fixed_inserted = (); 660d752fcc8SJoe Perchesmy @fixed_deleted = (); 661194f66fcSJoe Perchesmy $fixlinenr = -1; 662194f66fcSJoe Perches 663c2fdda0dSAndy Whitcroftmy $vname; 6646c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 66521caa13cSAndy Whitcroft my $FILE; 6666c72ffaaSAndy Whitcroft if ($file) { 66721caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 6686c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 66921caa13cSAndy Whitcroft } elsif ($filename eq '-') { 67021caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 6716c72ffaaSAndy Whitcroft } else { 67221caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 6736c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 6746c72ffaaSAndy Whitcroft } 675c2fdda0dSAndy Whitcroft if ($filename eq '-') { 676c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 677c2fdda0dSAndy Whitcroft } else { 678c2fdda0dSAndy Whitcroft $vname = $filename; 679c2fdda0dSAndy Whitcroft } 68021caa13cSAndy Whitcroft while (<$FILE>) { 6810a920b5bSAndy Whitcroft chomp; 68200df344fSAndy Whitcroft push(@rawlines, $_); 6836c72ffaaSAndy Whitcroft } 68421caa13cSAndy Whitcroft close($FILE); 685c2fdda0dSAndy Whitcroft if (!process($filename)) { 6860a920b5bSAndy Whitcroft $exit = 1; 6870a920b5bSAndy Whitcroft } 68800df344fSAndy Whitcroft @rawlines = (); 68913214adfSAndy Whitcroft @lines = (); 6903705ce5bSJoe Perches @fixed = (); 691d752fcc8SJoe Perches @fixed_inserted = (); 692d752fcc8SJoe Perches @fixed_deleted = (); 693194f66fcSJoe Perches $fixlinenr = -1; 6940a920b5bSAndy Whitcroft} 6950a920b5bSAndy Whitcroft 6960a920b5bSAndy Whitcroftexit($exit); 6970a920b5bSAndy Whitcroft 6980a920b5bSAndy Whitcroftsub top_of_kernel_tree { 6996c72ffaaSAndy Whitcroft my ($root) = @_; 7006c72ffaaSAndy Whitcroft 7016c72ffaaSAndy Whitcroft my @tree_check = ( 7026c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7036c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 7046c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 7056c72ffaaSAndy Whitcroft ); 7066c72ffaaSAndy Whitcroft 7076c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 7086c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 7090a920b5bSAndy Whitcroft return 0; 7100a920b5bSAndy Whitcroft } 7116c72ffaaSAndy Whitcroft } 7126c72ffaaSAndy Whitcroft return 1; 7136c72ffaaSAndy Whitcroft} 7140a920b5bSAndy Whitcroft 71520112475SJoe Perchessub parse_email { 71620112475SJoe Perches my ($formatted_email) = @_; 71720112475SJoe Perches 71820112475SJoe Perches my $name = ""; 71920112475SJoe Perches my $address = ""; 72020112475SJoe Perches my $comment = ""; 72120112475SJoe Perches 72220112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 72320112475SJoe Perches $name = $1; 72420112475SJoe Perches $address = $2; 72520112475SJoe Perches $comment = $3 if defined $3; 72620112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 72720112475SJoe Perches $address = $1; 72820112475SJoe Perches $comment = $2 if defined $2; 72920112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 73020112475SJoe Perches $address = $1; 73120112475SJoe Perches $comment = $2 if defined $2; 73220112475SJoe Perches $formatted_email =~ s/$address.*$//; 73320112475SJoe Perches $name = $formatted_email; 7343705ce5bSJoe Perches $name = trim($name); 73520112475SJoe Perches $name =~ s/^\"|\"$//g; 73620112475SJoe Perches # If there's a name left after stripping spaces and 73720112475SJoe Perches # leading quotes, and the address doesn't have both 73820112475SJoe Perches # leading and trailing angle brackets, the address 73920112475SJoe Perches # is invalid. ie: 74020112475SJoe Perches # "joe smith [email protected]" bad 74120112475SJoe Perches # "joe smith <[email protected]" bad 74220112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 74320112475SJoe Perches $name = ""; 74420112475SJoe Perches $address = ""; 74520112475SJoe Perches $comment = ""; 74620112475SJoe Perches } 74720112475SJoe Perches } 74820112475SJoe Perches 7493705ce5bSJoe Perches $name = trim($name); 75020112475SJoe Perches $name =~ s/^\"|\"$//g; 7513705ce5bSJoe Perches $address = trim($address); 75220112475SJoe Perches $address =~ s/^\<|\>$//g; 75320112475SJoe Perches 75420112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 75520112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 75620112475SJoe Perches $name = "\"$name\""; 75720112475SJoe Perches } 75820112475SJoe Perches 75920112475SJoe Perches return ($name, $address, $comment); 76020112475SJoe Perches} 76120112475SJoe Perches 76220112475SJoe Perchessub format_email { 76320112475SJoe Perches my ($name, $address) = @_; 76420112475SJoe Perches 76520112475SJoe Perches my $formatted_email; 76620112475SJoe Perches 7673705ce5bSJoe Perches $name = trim($name); 76820112475SJoe Perches $name =~ s/^\"|\"$//g; 7693705ce5bSJoe Perches $address = trim($address); 77020112475SJoe Perches 77120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 77220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 77320112475SJoe Perches $name = "\"$name\""; 77420112475SJoe Perches } 77520112475SJoe Perches 77620112475SJoe Perches if ("$name" eq "") { 77720112475SJoe Perches $formatted_email = "$address"; 77820112475SJoe Perches } else { 77920112475SJoe Perches $formatted_email = "$name <$address>"; 78020112475SJoe Perches } 78120112475SJoe Perches 78220112475SJoe Perches return $formatted_email; 78320112475SJoe Perches} 78420112475SJoe Perches 785d311cd44SJoe Perchessub which { 786d311cd44SJoe Perches my ($bin) = @_; 787d311cd44SJoe Perches 788d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 789d311cd44SJoe Perches if (-e "$path/$bin") { 790d311cd44SJoe Perches return "$path/$bin"; 791d311cd44SJoe Perches } 792d311cd44SJoe Perches } 793d311cd44SJoe Perches 794d311cd44SJoe Perches return ""; 795d311cd44SJoe Perches} 796d311cd44SJoe Perches 797000d1cc1SJoe Perchessub which_conf { 798000d1cc1SJoe Perches my ($conf) = @_; 799000d1cc1SJoe Perches 800000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 801000d1cc1SJoe Perches if (-e "$path/$conf") { 802000d1cc1SJoe Perches return "$path/$conf"; 803000d1cc1SJoe Perches } 804000d1cc1SJoe Perches } 805000d1cc1SJoe Perches 806000d1cc1SJoe Perches return ""; 807000d1cc1SJoe Perches} 808000d1cc1SJoe Perches 8090a920b5bSAndy Whitcroftsub expand_tabs { 8100a920b5bSAndy Whitcroft my ($str) = @_; 8110a920b5bSAndy Whitcroft 8120a920b5bSAndy Whitcroft my $res = ''; 8130a920b5bSAndy Whitcroft my $n = 0; 8140a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 8150a920b5bSAndy Whitcroft if ($c eq "\t") { 8160a920b5bSAndy Whitcroft $res .= ' '; 8170a920b5bSAndy Whitcroft $n++; 8180a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 8190a920b5bSAndy Whitcroft $res .= ' '; 8200a920b5bSAndy Whitcroft } 8210a920b5bSAndy Whitcroft next; 8220a920b5bSAndy Whitcroft } 8230a920b5bSAndy Whitcroft $res .= $c; 8240a920b5bSAndy Whitcroft $n++; 8250a920b5bSAndy Whitcroft } 8260a920b5bSAndy Whitcroft 8270a920b5bSAndy Whitcroft return $res; 8280a920b5bSAndy Whitcroft} 8296c72ffaaSAndy Whitcroftsub copy_spacing { 830773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 8316c72ffaaSAndy Whitcroft return $res; 8326c72ffaaSAndy Whitcroft} 8330a920b5bSAndy Whitcroft 8344a0df2efSAndy Whitcroftsub line_stats { 8354a0df2efSAndy Whitcroft my ($line) = @_; 8364a0df2efSAndy Whitcroft 8374a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 8384a0df2efSAndy Whitcroft $line =~ s/^.//; 8394a0df2efSAndy Whitcroft $line = expand_tabs($line); 8404a0df2efSAndy Whitcroft 8414a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 8424a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 8434a0df2efSAndy Whitcroft 8444a0df2efSAndy Whitcroft return (length($line), length($white)); 8454a0df2efSAndy Whitcroft} 8464a0df2efSAndy Whitcroft 847773647a0SAndy Whitcroftmy $sanitise_quote = ''; 848773647a0SAndy Whitcroft 849773647a0SAndy Whitcroftsub sanitise_line_reset { 850773647a0SAndy Whitcroft my ($in_comment) = @_; 851773647a0SAndy Whitcroft 852773647a0SAndy Whitcroft if ($in_comment) { 853773647a0SAndy Whitcroft $sanitise_quote = '*/'; 854773647a0SAndy Whitcroft } else { 855773647a0SAndy Whitcroft $sanitise_quote = ''; 856773647a0SAndy Whitcroft } 857773647a0SAndy Whitcroft} 85800df344fSAndy Whitcroftsub sanitise_line { 85900df344fSAndy Whitcroft my ($line) = @_; 86000df344fSAndy Whitcroft 86100df344fSAndy Whitcroft my $res = ''; 86200df344fSAndy Whitcroft my $l = ''; 86300df344fSAndy Whitcroft 864c2fdda0dSAndy Whitcroft my $qlen = 0; 865773647a0SAndy Whitcroft my $off = 0; 866773647a0SAndy Whitcroft my $c; 86700df344fSAndy Whitcroft 868773647a0SAndy Whitcroft # Always copy over the diff marker. 869773647a0SAndy Whitcroft $res = substr($line, 0, 1); 870773647a0SAndy Whitcroft 871773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 872773647a0SAndy Whitcroft $c = substr($line, $off, 1); 873773647a0SAndy Whitcroft 874773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 875773647a0SAndy Whitcroft # and end, all to $;. 876773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 877773647a0SAndy Whitcroft $sanitise_quote = '*/'; 878773647a0SAndy Whitcroft 879773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 880773647a0SAndy Whitcroft $off++; 88100df344fSAndy Whitcroft next; 882773647a0SAndy Whitcroft } 88381bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 884773647a0SAndy Whitcroft $sanitise_quote = ''; 885773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 886773647a0SAndy Whitcroft $off++; 887773647a0SAndy Whitcroft next; 888773647a0SAndy Whitcroft } 889113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 890113f04a8SDaniel Walker $sanitise_quote = '//'; 891113f04a8SDaniel Walker 892113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 893113f04a8SDaniel Walker $off++; 894113f04a8SDaniel Walker next; 895113f04a8SDaniel Walker } 896773647a0SAndy Whitcroft 897773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 898773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 899773647a0SAndy Whitcroft $c eq "\\") { 900773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 901773647a0SAndy Whitcroft $off++; 902773647a0SAndy Whitcroft next; 903773647a0SAndy Whitcroft } 904773647a0SAndy Whitcroft # Regular quotes. 905773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 906773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 907773647a0SAndy Whitcroft $sanitise_quote = $c; 908773647a0SAndy Whitcroft 909773647a0SAndy Whitcroft substr($res, $off, 1, $c); 910773647a0SAndy Whitcroft next; 911773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 912773647a0SAndy Whitcroft $sanitise_quote = ''; 91300df344fSAndy Whitcroft } 91400df344fSAndy Whitcroft } 915773647a0SAndy Whitcroft 916fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 917773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 918773647a0SAndy Whitcroft substr($res, $off, 1, $;); 919113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 920113f04a8SDaniel Walker substr($res, $off, 1, $;); 921773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 922773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 92300df344fSAndy Whitcroft } else { 924773647a0SAndy Whitcroft substr($res, $off, 1, $c); 92500df344fSAndy Whitcroft } 926c2fdda0dSAndy Whitcroft } 927c2fdda0dSAndy Whitcroft 928113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 929113f04a8SDaniel Walker $sanitise_quote = ''; 930113f04a8SDaniel Walker } 931113f04a8SDaniel Walker 932c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 933c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 934c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 935c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 936c2fdda0dSAndy Whitcroft 937c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 938c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 939c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 940c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 941c2fdda0dSAndy Whitcroft } 942c2fdda0dSAndy Whitcroft 94300df344fSAndy Whitcroft return $res; 94400df344fSAndy Whitcroft} 94500df344fSAndy Whitcroft 946a6962d72SJoe Perchessub get_quoted_string { 947a6962d72SJoe Perches my ($line, $rawline) = @_; 948a6962d72SJoe Perches 949a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 950a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 951a6962d72SJoe Perches} 952a6962d72SJoe Perches 9538905a67cSAndy Whitcroftsub ctx_statement_block { 9548905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 9558905a67cSAndy Whitcroft my $line = $linenr - 1; 9568905a67cSAndy Whitcroft my $blk = ''; 9578905a67cSAndy Whitcroft my $soff = $off; 9588905a67cSAndy Whitcroft my $coff = $off - 1; 959773647a0SAndy Whitcroft my $coff_set = 0; 9608905a67cSAndy Whitcroft 96113214adfSAndy Whitcroft my $loff = 0; 96213214adfSAndy Whitcroft 9638905a67cSAndy Whitcroft my $type = ''; 9648905a67cSAndy Whitcroft my $level = 0; 965a2750645SAndy Whitcroft my @stack = (); 966cf655043SAndy Whitcroft my $p; 9678905a67cSAndy Whitcroft my $c; 9688905a67cSAndy Whitcroft my $len = 0; 96913214adfSAndy Whitcroft 97013214adfSAndy Whitcroft my $remainder; 9718905a67cSAndy Whitcroft while (1) { 972a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 973a2750645SAndy Whitcroft 974773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 9758905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 9768905a67cSAndy Whitcroft # context. 9778905a67cSAndy Whitcroft if ($off >= $len) { 9788905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 979dea33496SAndy Whitcroft last if (!defined $lines[$line]); 980c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 9818905a67cSAndy Whitcroft $remain--; 98213214adfSAndy Whitcroft $loff = $len; 983c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 9848905a67cSAndy Whitcroft $len = length($blk); 9858905a67cSAndy Whitcroft $line++; 9868905a67cSAndy Whitcroft last; 9878905a67cSAndy Whitcroft } 9888905a67cSAndy Whitcroft # Bail if there is no further context. 9898905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 99013214adfSAndy Whitcroft if ($off >= $len) { 9918905a67cSAndy Whitcroft last; 9928905a67cSAndy Whitcroft } 993f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 994f74bd194SAndy Whitcroft $level++; 995f74bd194SAndy Whitcroft $type = '#'; 996f74bd194SAndy Whitcroft } 9978905a67cSAndy Whitcroft } 998cf655043SAndy Whitcroft $p = $c; 9998905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 100013214adfSAndy Whitcroft $remainder = substr($blk, $off); 10018905a67cSAndy Whitcroft 1002773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10034635f4fbSAndy Whitcroft 10044635f4fbSAndy Whitcroft # Handle nested #if/#else. 10054635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 10064635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 10074635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 10084635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 10094635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 10104635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 10114635f4fbSAndy Whitcroft } 10124635f4fbSAndy Whitcroft 10138905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 10148905a67cSAndy Whitcroft # outermost level. 10158905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 10168905a67cSAndy Whitcroft last; 10178905a67cSAndy Whitcroft } 10188905a67cSAndy Whitcroft 101913214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1020773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1021773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1022773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1023773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1024773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1025773647a0SAndy Whitcroft $coff_set = 1; 1026773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1027773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 102813214adfSAndy Whitcroft } 102913214adfSAndy Whitcroft 10308905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 10318905a67cSAndy Whitcroft $level++; 10328905a67cSAndy Whitcroft $type = '('; 10338905a67cSAndy Whitcroft } 10348905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 10358905a67cSAndy Whitcroft $level--; 10368905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 10378905a67cSAndy Whitcroft 10388905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 10398905a67cSAndy Whitcroft $coff = $off; 1040773647a0SAndy Whitcroft $coff_set = 1; 1041773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 10428905a67cSAndy Whitcroft } 10438905a67cSAndy Whitcroft } 10448905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 10458905a67cSAndy Whitcroft $level++; 10468905a67cSAndy Whitcroft $type = '{'; 10478905a67cSAndy Whitcroft } 10488905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 10498905a67cSAndy Whitcroft $level--; 10508905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 10518905a67cSAndy Whitcroft 10528905a67cSAndy Whitcroft if ($level == 0) { 1053b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1054b998e001SPatrick Pannuto $off++; 1055b998e001SPatrick Pannuto } 10568905a67cSAndy Whitcroft last; 10578905a67cSAndy Whitcroft } 10588905a67cSAndy Whitcroft } 1059f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1060f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1061f74bd194SAndy Whitcroft $level--; 1062f74bd194SAndy Whitcroft $type = ''; 1063f74bd194SAndy Whitcroft $off++; 1064f74bd194SAndy Whitcroft last; 1065f74bd194SAndy Whitcroft } 10668905a67cSAndy Whitcroft $off++; 10678905a67cSAndy Whitcroft } 1068a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 106913214adfSAndy Whitcroft if ($off == $len) { 1070a3bb97a7SAndy Whitcroft $loff = $len + 1; 107113214adfSAndy Whitcroft $line++; 107213214adfSAndy Whitcroft $remain--; 107313214adfSAndy Whitcroft } 10748905a67cSAndy Whitcroft 10758905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 10768905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 10778905a67cSAndy Whitcroft 10788905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 10798905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 10808905a67cSAndy Whitcroft 1081773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 108213214adfSAndy Whitcroft 108313214adfSAndy Whitcroft return ($statement, $condition, 108413214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 108513214adfSAndy Whitcroft} 108613214adfSAndy Whitcroft 1087cf655043SAndy Whitcroftsub statement_lines { 1088cf655043SAndy Whitcroft my ($stmt) = @_; 1089cf655043SAndy Whitcroft 1090cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1091cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1092cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1093cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1094cf655043SAndy Whitcroft 1095cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1096cf655043SAndy Whitcroft 1097cf655043SAndy Whitcroft return $#stmt_lines + 2; 1098cf655043SAndy Whitcroft} 1099cf655043SAndy Whitcroft 1100cf655043SAndy Whitcroftsub statement_rawlines { 1101cf655043SAndy Whitcroft my ($stmt) = @_; 1102cf655043SAndy Whitcroft 1103cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1104cf655043SAndy Whitcroft 1105cf655043SAndy Whitcroft return $#stmt_lines + 2; 1106cf655043SAndy Whitcroft} 1107cf655043SAndy Whitcroft 1108cf655043SAndy Whitcroftsub statement_block_size { 1109cf655043SAndy Whitcroft my ($stmt) = @_; 1110cf655043SAndy Whitcroft 1111cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1112cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1113cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1114cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1115cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1116cf655043SAndy Whitcroft 1117cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1118cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1119cf655043SAndy Whitcroft 1120cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1121cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1122cf655043SAndy Whitcroft 1123cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1124cf655043SAndy Whitcroft return $stmt_lines; 1125cf655043SAndy Whitcroft } else { 1126cf655043SAndy Whitcroft return $stmt_statements; 1127cf655043SAndy Whitcroft } 1128cf655043SAndy Whitcroft} 1129cf655043SAndy Whitcroft 113013214adfSAndy Whitcroftsub ctx_statement_full { 113113214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 113213214adfSAndy Whitcroft my ($statement, $condition, $level); 113313214adfSAndy Whitcroft 113413214adfSAndy Whitcroft my (@chunks); 113513214adfSAndy Whitcroft 1136cf655043SAndy Whitcroft # Grab the first conditional/block pair. 113713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 113813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1139773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 114013214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1141cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1142cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1143cf655043SAndy Whitcroft } 1144cf655043SAndy Whitcroft 1145cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1146cf655043SAndy Whitcroft # could continue the statement. 1147cf655043SAndy Whitcroft for (;;) { 114813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 114913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1150cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1151773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1152cf655043SAndy Whitcroft #print "C: push\n"; 1153cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 115413214adfSAndy Whitcroft } 115513214adfSAndy Whitcroft 115613214adfSAndy Whitcroft return ($level, $linenr, @chunks); 11578905a67cSAndy Whitcroft} 11588905a67cSAndy Whitcroft 11594a0df2efSAndy Whitcroftsub ctx_block_get { 1160f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 11614a0df2efSAndy Whitcroft my $line; 11624a0df2efSAndy Whitcroft my $start = $linenr - 1; 11634a0df2efSAndy Whitcroft my $blk = ''; 11644a0df2efSAndy Whitcroft my @o; 11654a0df2efSAndy Whitcroft my @c; 11664a0df2efSAndy Whitcroft my @res = (); 11674a0df2efSAndy Whitcroft 1168f0a594c1SAndy Whitcroft my $level = 0; 11694635f4fbSAndy Whitcroft my @stack = ($level); 117000df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 117100df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 117200df344fSAndy Whitcroft $remain--; 117300df344fSAndy Whitcroft 117400df344fSAndy Whitcroft $blk .= $rawlines[$line]; 11754635f4fbSAndy Whitcroft 11764635f4fbSAndy Whitcroft # Handle nested #if/#else. 117701464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 11784635f4fbSAndy Whitcroft push(@stack, $level); 117901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 11804635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 118101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 11824635f4fbSAndy Whitcroft $level = pop(@stack); 11834635f4fbSAndy Whitcroft } 11844635f4fbSAndy Whitcroft 118501464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1186f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1187f0a594c1SAndy Whitcroft if ($off > 0) { 1188f0a594c1SAndy Whitcroft $off--; 1189f0a594c1SAndy Whitcroft next; 1190f0a594c1SAndy Whitcroft } 11914a0df2efSAndy Whitcroft 1192f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1193f0a594c1SAndy Whitcroft $level--; 1194f0a594c1SAndy Whitcroft last if ($level == 0); 1195f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1196f0a594c1SAndy Whitcroft $level++; 1197f0a594c1SAndy Whitcroft } 1198f0a594c1SAndy Whitcroft } 11994a0df2efSAndy Whitcroft 1200f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 120100df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12024a0df2efSAndy Whitcroft } 12034a0df2efSAndy Whitcroft 1204f0a594c1SAndy Whitcroft last if ($level == 0); 12054a0df2efSAndy Whitcroft } 12064a0df2efSAndy Whitcroft 1207f0a594c1SAndy Whitcroft return ($level, @res); 12084a0df2efSAndy Whitcroft} 12094a0df2efSAndy Whitcroftsub ctx_block_outer { 12104a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12114a0df2efSAndy Whitcroft 1212f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1213f0a594c1SAndy Whitcroft return @r; 12144a0df2efSAndy Whitcroft} 12154a0df2efSAndy Whitcroftsub ctx_block { 12164a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12174a0df2efSAndy Whitcroft 1218f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1219f0a594c1SAndy Whitcroft return @r; 1220653d4876SAndy Whitcroft} 1221653d4876SAndy Whitcroftsub ctx_statement { 1222f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1223f0a594c1SAndy Whitcroft 1224f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1225f0a594c1SAndy Whitcroft return @r; 1226f0a594c1SAndy Whitcroft} 1227f0a594c1SAndy Whitcroftsub ctx_block_level { 1228653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1229653d4876SAndy Whitcroft 1230f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 12314a0df2efSAndy Whitcroft} 12329c0ca6f9SAndy Whitcroftsub ctx_statement_level { 12339c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 12349c0ca6f9SAndy Whitcroft 12359c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 12369c0ca6f9SAndy Whitcroft} 12374a0df2efSAndy Whitcroft 12384a0df2efSAndy Whitcroftsub ctx_locate_comment { 12394a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 12404a0df2efSAndy Whitcroft 12414a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1242beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 12434a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 12444a0df2efSAndy Whitcroft 12454a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 12464a0df2efSAndy Whitcroft # comment. 12474a0df2efSAndy Whitcroft my $in_comment = 0; 12484a0df2efSAndy Whitcroft $current_comment = ''; 12494a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 125000df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 125100df344fSAndy Whitcroft #warn " $line\n"; 12524a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 12534a0df2efSAndy Whitcroft $in_comment = 1; 12544a0df2efSAndy Whitcroft } 12554a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 12564a0df2efSAndy Whitcroft $in_comment = 1; 12574a0df2efSAndy Whitcroft } 12584a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 12594a0df2efSAndy Whitcroft $current_comment = ''; 12604a0df2efSAndy Whitcroft } 12614a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 12624a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 12634a0df2efSAndy Whitcroft $in_comment = 0; 12644a0df2efSAndy Whitcroft } 12654a0df2efSAndy Whitcroft } 12664a0df2efSAndy Whitcroft 12674a0df2efSAndy Whitcroft chomp($current_comment); 12684a0df2efSAndy Whitcroft return($current_comment); 12694a0df2efSAndy Whitcroft} 12704a0df2efSAndy Whitcroftsub ctx_has_comment { 12714a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 12724a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 12734a0df2efSAndy Whitcroft 127400df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 12754a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 12764a0df2efSAndy Whitcroft 12774a0df2efSAndy Whitcroft return ($cmt ne ''); 12784a0df2efSAndy Whitcroft} 12794a0df2efSAndy Whitcroft 12804d001e4dSAndy Whitcroftsub raw_line { 12814d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 12824d001e4dSAndy Whitcroft 12834d001e4dSAndy Whitcroft my $offset = $linenr - 1; 12844d001e4dSAndy Whitcroft $cnt++; 12854d001e4dSAndy Whitcroft 12864d001e4dSAndy Whitcroft my $line; 12874d001e4dSAndy Whitcroft while ($cnt) { 12884d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 12894d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 12904d001e4dSAndy Whitcroft $cnt--; 12914d001e4dSAndy Whitcroft } 12924d001e4dSAndy Whitcroft 12934d001e4dSAndy Whitcroft return $line; 12944d001e4dSAndy Whitcroft} 12954d001e4dSAndy Whitcroft 12960a920b5bSAndy Whitcroftsub cat_vet { 12970a920b5bSAndy Whitcroft my ($vet) = @_; 12989c0ca6f9SAndy Whitcroft my ($res, $coded); 12990a920b5bSAndy Whitcroft 13009c0ca6f9SAndy Whitcroft $res = ''; 13016c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13026c72ffaaSAndy Whitcroft $res .= $1; 13036c72ffaaSAndy Whitcroft if ($2 ne '') { 13049c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 13056c72ffaaSAndy Whitcroft $res .= $coded; 13066c72ffaaSAndy Whitcroft } 13079c0ca6f9SAndy Whitcroft } 13089c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 13090a920b5bSAndy Whitcroft 13109c0ca6f9SAndy Whitcroft return $res; 13110a920b5bSAndy Whitcroft} 13120a920b5bSAndy Whitcroft 1313c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1314cf655043SAndy Whitcroftmy $av_pending; 1315c2fdda0dSAndy Whitcroftmy @av_paren_type; 13161f65f947SAndy Whitcroftmy $av_pend_colon; 1317c2fdda0dSAndy Whitcroft 1318c2fdda0dSAndy Whitcroftsub annotate_reset { 1319c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1320cf655043SAndy Whitcroft $av_pending = '_'; 1321cf655043SAndy Whitcroft @av_paren_type = ('E'); 13221f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1323c2fdda0dSAndy Whitcroft} 1324c2fdda0dSAndy Whitcroft 13256c72ffaaSAndy Whitcroftsub annotate_values { 13266c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 13276c72ffaaSAndy Whitcroft 13286c72ffaaSAndy Whitcroft my $res; 13291f65f947SAndy Whitcroft my $var = '_' x length($stream); 13306c72ffaaSAndy Whitcroft my $cur = $stream; 13316c72ffaaSAndy Whitcroft 1332c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 13336c72ffaaSAndy Whitcroft 13346c72ffaaSAndy Whitcroft while (length($cur)) { 1335773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1336cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1337171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 13386c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1339c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1340c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1341cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1342c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 13436c72ffaaSAndy Whitcroft } 13446c72ffaaSAndy Whitcroft 1345c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 13469446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 13479446ef56SAndy Whitcroft push(@av_paren_type, $type); 1348addcdceaSAndy Whitcroft $type = 'c'; 13499446ef56SAndy Whitcroft 1350e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1351c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 13526c72ffaaSAndy Whitcroft $type = 'T'; 13536c72ffaaSAndy Whitcroft 1354389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1355389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1356389a2fe5SAndy Whitcroft $type = 'T'; 1357389a2fe5SAndy Whitcroft 1358c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1359171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1360c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1361171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1362171ae1a4SAndy Whitcroft if ($2 ne '') { 1363cf655043SAndy Whitcroft $av_pending = 'N'; 1364171ae1a4SAndy Whitcroft } 1365171ae1a4SAndy Whitcroft $type = 'E'; 1366171ae1a4SAndy Whitcroft 1367c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1368171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1369171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1370171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 13716c72ffaaSAndy Whitcroft 1372c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1373cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1374c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1375cf655043SAndy Whitcroft 1376cf655043SAndy Whitcroft push(@av_paren_type, $type); 1377cf655043SAndy Whitcroft push(@av_paren_type, $type); 1378171ae1a4SAndy Whitcroft $type = 'E'; 1379cf655043SAndy Whitcroft 1380c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1381cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1382cf655043SAndy Whitcroft $av_preprocessor = 1; 1383cf655043SAndy Whitcroft 1384cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1385cf655043SAndy Whitcroft 1386171ae1a4SAndy Whitcroft $type = 'E'; 1387cf655043SAndy Whitcroft 1388c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1389cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1390cf655043SAndy Whitcroft 1391cf655043SAndy Whitcroft $av_preprocessor = 1; 1392cf655043SAndy Whitcroft 1393cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1394cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1395cf655043SAndy Whitcroft pop(@av_paren_type); 1396cf655043SAndy Whitcroft push(@av_paren_type, $type); 1397171ae1a4SAndy Whitcroft $type = 'E'; 13986c72ffaaSAndy Whitcroft 13996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1400c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14016c72ffaaSAndy Whitcroft 1402171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1403171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1404171ae1a4SAndy Whitcroft $av_pending = $type; 1405171ae1a4SAndy Whitcroft $type = 'N'; 1406171ae1a4SAndy Whitcroft 14076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1408c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 14096c72ffaaSAndy Whitcroft if (defined $2) { 1410cf655043SAndy Whitcroft $av_pending = 'V'; 14116c72ffaaSAndy Whitcroft } 14126c72ffaaSAndy Whitcroft $type = 'N'; 14136c72ffaaSAndy Whitcroft 141414b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1415c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 141614b111c1SAndy Whitcroft $av_pending = 'E'; 14176c72ffaaSAndy Whitcroft $type = 'N'; 14186c72ffaaSAndy Whitcroft 14191f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 14201f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 14211f65f947SAndy Whitcroft $av_pend_colon = 'C'; 14221f65f947SAndy Whitcroft $type = 'N'; 14231f65f947SAndy Whitcroft 142414b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1425c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 14266c72ffaaSAndy Whitcroft $type = 'N'; 14276c72ffaaSAndy Whitcroft 14286c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1429c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1430cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1431cf655043SAndy Whitcroft $av_pending = '_'; 14326c72ffaaSAndy Whitcroft $type = 'N'; 14336c72ffaaSAndy Whitcroft 14346c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1435cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1436cf655043SAndy Whitcroft if ($new_type ne '_') { 1437cf655043SAndy Whitcroft $type = $new_type; 1438c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1439c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 14406c72ffaaSAndy Whitcroft } else { 1441c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 14426c72ffaaSAndy Whitcroft } 14436c72ffaaSAndy Whitcroft 1444c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1445c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1446c8cb2ca3SAndy Whitcroft $type = 'V'; 1447cf655043SAndy Whitcroft $av_pending = 'V'; 14486c72ffaaSAndy Whitcroft 14498e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 14508e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 14511f65f947SAndy Whitcroft $av_pend_colon = 'B'; 14528e761b04SAndy Whitcroft } elsif ($type eq 'E') { 14538e761b04SAndy Whitcroft $av_pend_colon = 'L'; 14541f65f947SAndy Whitcroft } 14551f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 14561f65f947SAndy Whitcroft $type = 'V'; 14571f65f947SAndy Whitcroft 14586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1459c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 14606c72ffaaSAndy Whitcroft $type = 'V'; 14616c72ffaaSAndy Whitcroft 14626c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1463c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 14646c72ffaaSAndy Whitcroft $type = 'N'; 14656c72ffaaSAndy Whitcroft 1466cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1467c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 146813214adfSAndy Whitcroft $type = 'E'; 14691f65f947SAndy Whitcroft $av_pend_colon = 'O'; 147013214adfSAndy Whitcroft 14718e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 14728e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 14738e761b04SAndy Whitcroft $type = 'C'; 14748e761b04SAndy Whitcroft 14751f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 14761f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 14771f65f947SAndy Whitcroft $type = 'N'; 14781f65f947SAndy Whitcroft 14791f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 14801f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 14811f65f947SAndy Whitcroft 14821f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 14831f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 14841f65f947SAndy Whitcroft $type = 'E'; 14851f65f947SAndy Whitcroft } else { 14861f65f947SAndy Whitcroft $type = 'N'; 14871f65f947SAndy Whitcroft } 14881f65f947SAndy Whitcroft $av_pend_colon = 'O'; 14891f65f947SAndy Whitcroft 14908e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 149113214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 14926c72ffaaSAndy Whitcroft $type = 'N'; 14936c72ffaaSAndy Whitcroft 14940d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 149574048ed8SAndy Whitcroft my $variant; 149674048ed8SAndy Whitcroft 149774048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 149874048ed8SAndy Whitcroft if ($type eq 'V') { 149974048ed8SAndy Whitcroft $variant = 'B'; 150074048ed8SAndy Whitcroft } else { 150174048ed8SAndy Whitcroft $variant = 'U'; 150274048ed8SAndy Whitcroft } 150374048ed8SAndy Whitcroft 150474048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 150574048ed8SAndy Whitcroft $type = 'N'; 150674048ed8SAndy Whitcroft 15076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1508c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 15096c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 15106c72ffaaSAndy Whitcroft $type = 'N'; 15116c72ffaaSAndy Whitcroft } 15126c72ffaaSAndy Whitcroft 15136c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1514c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 15156c72ffaaSAndy Whitcroft } 15166c72ffaaSAndy Whitcroft if (defined $1) { 15176c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 15186c72ffaaSAndy Whitcroft $res .= $type x length($1); 15196c72ffaaSAndy Whitcroft } 15206c72ffaaSAndy Whitcroft } 15216c72ffaaSAndy Whitcroft 15221f65f947SAndy Whitcroft return ($res, $var); 15236c72ffaaSAndy Whitcroft} 15246c72ffaaSAndy Whitcroft 15258905a67cSAndy Whitcroftsub possible { 152613214adfSAndy Whitcroft my ($possible, $line) = @_; 15279a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 15280776e594SAndy Whitcroft ^(?: 15290776e594SAndy Whitcroft $Modifier| 15300776e594SAndy Whitcroft $Storage| 15310776e594SAndy Whitcroft $Type| 15329a974fdbSAndy Whitcroft DEFINE_\S+ 15339a974fdbSAndy Whitcroft )$| 15349a974fdbSAndy Whitcroft ^(?: 15350776e594SAndy Whitcroft goto| 15360776e594SAndy Whitcroft return| 15370776e594SAndy Whitcroft case| 15380776e594SAndy Whitcroft else| 15390776e594SAndy Whitcroft asm|__asm__| 154089a88353SAndy Whitcroft do| 154189a88353SAndy Whitcroft \#| 154289a88353SAndy Whitcroft \#\#| 15439a974fdbSAndy Whitcroft )(?:\s|$)| 15440776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 15459a974fdbSAndy Whitcroft )}x; 15469a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 15479a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1548c45dcabdSAndy Whitcroft # Check for modifiers. 1549c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1550c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1551c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1552c45dcabdSAndy Whitcroft 1553c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1554c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1555d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 15569a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1557d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1558d2506586SAndy Whitcroft push(@modifierList, $modifier); 1559d2506586SAndy Whitcroft } 15609a974fdbSAndy Whitcroft } 1561c45dcabdSAndy Whitcroft 1562c45dcabdSAndy Whitcroft } else { 156313214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 15648905a67cSAndy Whitcroft push(@typeList, $possible); 1565c45dcabdSAndy Whitcroft } 15668905a67cSAndy Whitcroft build_types(); 15670776e594SAndy Whitcroft } else { 15680776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 15698905a67cSAndy Whitcroft } 15708905a67cSAndy Whitcroft} 15718905a67cSAndy Whitcroft 15726c72ffaaSAndy Whitcroftmy $prefix = ''; 15736c72ffaaSAndy Whitcroft 1574000d1cc1SJoe Perchessub show_type { 1575cbec18afSJoe Perches my ($type) = @_; 157691bfe484SJoe Perches 1577cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1578cbec18afSJoe Perches 1579cbec18afSJoe Perches return !defined $ignore_type{$type}; 1580000d1cc1SJoe Perches} 1581000d1cc1SJoe Perches 1582f0a594c1SAndy Whitcroftsub report { 1583cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1584cbec18afSJoe Perches 1585cbec18afSJoe Perches if (!show_type($type) || 1586cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1587773647a0SAndy Whitcroft return 0; 1588773647a0SAndy Whitcroft } 1589000d1cc1SJoe Perches my $line; 1590000d1cc1SJoe Perches if ($show_types) { 1591cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1592000d1cc1SJoe Perches } else { 1593cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1594000d1cc1SJoe Perches } 15958905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 15968905a67cSAndy Whitcroft 159713214adfSAndy Whitcroft push(our @report, $line); 1598773647a0SAndy Whitcroft 1599773647a0SAndy Whitcroft return 1; 1600f0a594c1SAndy Whitcroft} 1601cbec18afSJoe Perches 1602f0a594c1SAndy Whitcroftsub report_dump { 160313214adfSAndy Whitcroft our @report; 1604f0a594c1SAndy Whitcroft} 1605000d1cc1SJoe Perches 1606d752fcc8SJoe Perchessub fixup_current_range { 1607d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1608d752fcc8SJoe Perches 1609d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1610d752fcc8SJoe Perches my $o = $1; 1611d752fcc8SJoe Perches my $l = $2; 1612d752fcc8SJoe Perches my $no = $o + $offset; 1613d752fcc8SJoe Perches my $nl = $l + $length; 1614d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1615d752fcc8SJoe Perches } 1616d752fcc8SJoe Perches} 1617d752fcc8SJoe Perches 1618d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1619d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1620d752fcc8SJoe Perches 1621d752fcc8SJoe Perches my $range_last_linenr = 0; 1622d752fcc8SJoe Perches my $delta_offset = 0; 1623d752fcc8SJoe Perches 1624d752fcc8SJoe Perches my $old_linenr = 0; 1625d752fcc8SJoe Perches my $new_linenr = 0; 1626d752fcc8SJoe Perches 1627d752fcc8SJoe Perches my $next_insert = 0; 1628d752fcc8SJoe Perches my $next_delete = 0; 1629d752fcc8SJoe Perches 1630d752fcc8SJoe Perches my @lines = (); 1631d752fcc8SJoe Perches 1632d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1633d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1634d752fcc8SJoe Perches 1635d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1636d752fcc8SJoe Perches my $save_line = 1; 1637d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1638d752fcc8SJoe Perches if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename 1639d752fcc8SJoe Perches $delta_offset = 0; 1640d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1641d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1642d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1643d752fcc8SJoe Perches } 1644d752fcc8SJoe Perches 1645d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1646d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1647d752fcc8SJoe Perches $save_line = 0; 1648d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1649d752fcc8SJoe Perches } 1650d752fcc8SJoe Perches 1651d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1652d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1653d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1654d752fcc8SJoe Perches $new_linenr++; 1655d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1656d752fcc8SJoe Perches } 1657d752fcc8SJoe Perches 1658d752fcc8SJoe Perches if ($save_line) { 1659d752fcc8SJoe Perches push(@lines, $line); 1660d752fcc8SJoe Perches $new_linenr++; 1661d752fcc8SJoe Perches } 1662d752fcc8SJoe Perches 1663d752fcc8SJoe Perches $old_linenr++; 1664d752fcc8SJoe Perches } 1665d752fcc8SJoe Perches 1666d752fcc8SJoe Perches return @lines; 1667d752fcc8SJoe Perches} 1668d752fcc8SJoe Perches 1669f2d7e4d4SJoe Perchessub fix_insert_line { 1670f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1671f2d7e4d4SJoe Perches 1672f2d7e4d4SJoe Perches my $inserted = { 1673f2d7e4d4SJoe Perches LINENR => $linenr, 1674f2d7e4d4SJoe Perches LINE => $line, 1675f2d7e4d4SJoe Perches }; 1676f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1677f2d7e4d4SJoe Perches} 1678f2d7e4d4SJoe Perches 1679f2d7e4d4SJoe Perchessub fix_delete_line { 1680f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1681f2d7e4d4SJoe Perches 1682f2d7e4d4SJoe Perches my $deleted = { 1683f2d7e4d4SJoe Perches LINENR => $linenr, 1684f2d7e4d4SJoe Perches LINE => $line, 1685f2d7e4d4SJoe Perches }; 1686f2d7e4d4SJoe Perches 1687f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1688f2d7e4d4SJoe Perches} 1689f2d7e4d4SJoe Perches 1690de7d4f0eSAndy Whitcroftsub ERROR { 1691cbec18afSJoe Perches my ($type, $msg) = @_; 1692cbec18afSJoe Perches 1693cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1694de7d4f0eSAndy Whitcroft our $clean = 0; 16956c72ffaaSAndy Whitcroft our $cnt_error++; 16963705ce5bSJoe Perches return 1; 1697de7d4f0eSAndy Whitcroft } 16983705ce5bSJoe Perches return 0; 1699773647a0SAndy Whitcroft} 1700de7d4f0eSAndy Whitcroftsub WARN { 1701cbec18afSJoe Perches my ($type, $msg) = @_; 1702cbec18afSJoe Perches 1703cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1704de7d4f0eSAndy Whitcroft our $clean = 0; 17056c72ffaaSAndy Whitcroft our $cnt_warn++; 17063705ce5bSJoe Perches return 1; 1707de7d4f0eSAndy Whitcroft } 17083705ce5bSJoe Perches return 0; 1709773647a0SAndy Whitcroft} 1710de7d4f0eSAndy Whitcroftsub CHK { 1711cbec18afSJoe Perches my ($type, $msg) = @_; 1712cbec18afSJoe Perches 1713cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1714de7d4f0eSAndy Whitcroft our $clean = 0; 17156c72ffaaSAndy Whitcroft our $cnt_chk++; 17163705ce5bSJoe Perches return 1; 17176c72ffaaSAndy Whitcroft } 17183705ce5bSJoe Perches return 0; 1719de7d4f0eSAndy Whitcroft} 1720de7d4f0eSAndy Whitcroft 17216ecd9674SAndy Whitcroftsub check_absolute_file { 17226ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 17236ecd9674SAndy Whitcroft my $file = $absolute; 17246ecd9674SAndy Whitcroft 17256ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 17266ecd9674SAndy Whitcroft 17276ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 17286ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 17296ecd9674SAndy Whitcroft if (-f "$root/$file") { 17306ecd9674SAndy Whitcroft ##print "file<$file>\n"; 17316ecd9674SAndy Whitcroft last; 17326ecd9674SAndy Whitcroft } 17336ecd9674SAndy Whitcroft } 17346ecd9674SAndy Whitcroft if (! -f _) { 17356ecd9674SAndy Whitcroft return 0; 17366ecd9674SAndy Whitcroft } 17376ecd9674SAndy Whitcroft 17386ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 17396ecd9674SAndy Whitcroft my $prefix = $absolute; 17406ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 17416ecd9674SAndy Whitcroft 17426ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 17436ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1744000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1745000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 17466ecd9674SAndy Whitcroft } 17476ecd9674SAndy Whitcroft} 17486ecd9674SAndy Whitcroft 17493705ce5bSJoe Perchessub trim { 17503705ce5bSJoe Perches my ($string) = @_; 17513705ce5bSJoe Perches 1752b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1753b34c648bSJoe Perches 1754b34c648bSJoe Perches return $string; 1755b34c648bSJoe Perches} 1756b34c648bSJoe Perches 1757b34c648bSJoe Perchessub ltrim { 1758b34c648bSJoe Perches my ($string) = @_; 1759b34c648bSJoe Perches 1760b34c648bSJoe Perches $string =~ s/^\s+//; 1761b34c648bSJoe Perches 1762b34c648bSJoe Perches return $string; 1763b34c648bSJoe Perches} 1764b34c648bSJoe Perches 1765b34c648bSJoe Perchessub rtrim { 1766b34c648bSJoe Perches my ($string) = @_; 1767b34c648bSJoe Perches 1768b34c648bSJoe Perches $string =~ s/\s+$//; 17693705ce5bSJoe Perches 17703705ce5bSJoe Perches return $string; 17713705ce5bSJoe Perches} 17723705ce5bSJoe Perches 177352ea8506SJoe Perchessub string_find_replace { 177452ea8506SJoe Perches my ($string, $find, $replace) = @_; 177552ea8506SJoe Perches 177652ea8506SJoe Perches $string =~ s/$find/$replace/g; 177752ea8506SJoe Perches 177852ea8506SJoe Perches return $string; 177952ea8506SJoe Perches} 178052ea8506SJoe Perches 17813705ce5bSJoe Perchessub tabify { 17823705ce5bSJoe Perches my ($leading) = @_; 17833705ce5bSJoe Perches 17843705ce5bSJoe Perches my $source_indent = 8; 17853705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 17863705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 17873705ce5bSJoe Perches 17883705ce5bSJoe Perches #convert leading spaces to tabs 17893705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 17903705ce5bSJoe Perches #Remove spaces before a tab 17913705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 17923705ce5bSJoe Perches 17933705ce5bSJoe Perches return "$leading"; 17943705ce5bSJoe Perches} 17953705ce5bSJoe Perches 1796d1fe9c09SJoe Perchessub pos_last_openparen { 1797d1fe9c09SJoe Perches my ($line) = @_; 1798d1fe9c09SJoe Perches 1799d1fe9c09SJoe Perches my $pos = 0; 1800d1fe9c09SJoe Perches 1801d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1802d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1803d1fe9c09SJoe Perches 1804d1fe9c09SJoe Perches my $last_openparen = 0; 1805d1fe9c09SJoe Perches 1806d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1807d1fe9c09SJoe Perches return -1; 1808d1fe9c09SJoe Perches } 1809d1fe9c09SJoe Perches 1810d1fe9c09SJoe Perches my $len = length($line); 1811d1fe9c09SJoe Perches 1812d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1813d1fe9c09SJoe Perches my $string = substr($line, $pos); 1814d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1815d1fe9c09SJoe Perches $pos += length($1) - 1; 1816d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1817d1fe9c09SJoe Perches $last_openparen = $pos; 1818d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1819d1fe9c09SJoe Perches last; 1820d1fe9c09SJoe Perches } 1821d1fe9c09SJoe Perches } 1822d1fe9c09SJoe Perches 182391cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1824d1fe9c09SJoe Perches} 1825d1fe9c09SJoe Perches 18260a920b5bSAndy Whitcroftsub process { 18270a920b5bSAndy Whitcroft my $filename = shift; 18280a920b5bSAndy Whitcroft 18290a920b5bSAndy Whitcroft my $linenr=0; 18300a920b5bSAndy Whitcroft my $prevline=""; 1831c2fdda0dSAndy Whitcroft my $prevrawline=""; 18320a920b5bSAndy Whitcroft my $stashline=""; 1833c2fdda0dSAndy Whitcroft my $stashrawline=""; 18340a920b5bSAndy Whitcroft 18354a0df2efSAndy Whitcroft my $length; 18360a920b5bSAndy Whitcroft my $indent; 18370a920b5bSAndy Whitcroft my $previndent=0; 18380a920b5bSAndy Whitcroft my $stashindent=0; 18390a920b5bSAndy Whitcroft 1840de7d4f0eSAndy Whitcroft our $clean = 1; 18410a920b5bSAndy Whitcroft my $signoff = 0; 18420a920b5bSAndy Whitcroft my $is_patch = 0; 18430a920b5bSAndy Whitcroft 184429ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 184515662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 184613f1937eSJoe Perches my $reported_maintainer_file = 0; 1847fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1848fa64205dSPasi Savanainen 1849365dd4eaSJoe Perches my $last_blank_line = 0; 1850365dd4eaSJoe Perches 185113214adfSAndy Whitcroft our @report = (); 18526c72ffaaSAndy Whitcroft our $cnt_lines = 0; 18536c72ffaaSAndy Whitcroft our $cnt_error = 0; 18546c72ffaaSAndy Whitcroft our $cnt_warn = 0; 18556c72ffaaSAndy Whitcroft our $cnt_chk = 0; 18566c72ffaaSAndy Whitcroft 18570a920b5bSAndy Whitcroft # Trace the real file/line as we go. 18580a920b5bSAndy Whitcroft my $realfile = ''; 18590a920b5bSAndy Whitcroft my $realline = 0; 18600a920b5bSAndy Whitcroft my $realcnt = 0; 18610a920b5bSAndy Whitcroft my $here = ''; 18620a920b5bSAndy Whitcroft my $in_comment = 0; 1863c2fdda0dSAndy Whitcroft my $comment_edge = 0; 18640a920b5bSAndy Whitcroft my $first_line = 0; 18651e855726SWolfram Sang my $p1_prefix = ''; 18660a920b5bSAndy Whitcroft 186713214adfSAndy Whitcroft my $prev_values = 'E'; 186813214adfSAndy Whitcroft 186913214adfSAndy Whitcroft # suppression flags 1870773647a0SAndy Whitcroft my %suppress_ifbraces; 1871170d3a22SAndy Whitcroft my %suppress_whiletrailers; 18722b474a1aSAndy Whitcroft my %suppress_export; 18733e469cdcSAndy Whitcroft my $suppress_statement = 0; 1874653d4876SAndy Whitcroft 18757e51f197SJoe Perches my %signatures = (); 1876323c1260SJoe Perches 1877c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1878de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1879c2fdda0dSAndy Whitcroft # 1880de7d4f0eSAndy Whitcroft my @setup_docs = (); 1881de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1882773647a0SAndy Whitcroft 1883d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1884d8b07710SJoe Perches 1885773647a0SAndy Whitcroft sanitise_line_reset(); 1886c2fdda0dSAndy Whitcroft my $line; 1887c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1888773647a0SAndy Whitcroft $linenr++; 1889773647a0SAndy Whitcroft $line = $rawline; 1890c2fdda0dSAndy Whitcroft 18913705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 18923705ce5bSJoe Perches 1893773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1894de7d4f0eSAndy Whitcroft $setup_docs = 0; 1895de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1896de7d4f0eSAndy Whitcroft $setup_docs = 1; 1897de7d4f0eSAndy Whitcroft } 1898773647a0SAndy Whitcroft #next; 1899de7d4f0eSAndy Whitcroft } 1900773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1901773647a0SAndy Whitcroft $realline=$1-1; 1902773647a0SAndy Whitcroft if (defined $2) { 1903773647a0SAndy Whitcroft $realcnt=$3+1; 1904773647a0SAndy Whitcroft } else { 1905773647a0SAndy Whitcroft $realcnt=1+1; 1906773647a0SAndy Whitcroft } 1907c45dcabdSAndy Whitcroft $in_comment = 0; 1908773647a0SAndy Whitcroft 1909773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1910773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1911773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1912773647a0SAndy Whitcroft # at context start. 1913773647a0SAndy Whitcroft my $edge; 191401fa9147SAndy Whitcroft my $cnt = $realcnt; 191501fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 191601fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 191701fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 191801fa9147SAndy Whitcroft $cnt--; 191901fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1920721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1921fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1922fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1923fae17daeSAndy Whitcroft ($edge) = $1; 1924fae17daeSAndy Whitcroft last; 1925fae17daeSAndy Whitcroft } 1926773647a0SAndy Whitcroft } 1927773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1928773647a0SAndy Whitcroft $in_comment = 1; 1929773647a0SAndy Whitcroft } 1930773647a0SAndy Whitcroft 1931773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1932773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1933773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1934773647a0SAndy Whitcroft if (!defined $edge && 193583242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1936773647a0SAndy Whitcroft { 1937773647a0SAndy Whitcroft $in_comment = 1; 1938773647a0SAndy Whitcroft } 1939773647a0SAndy Whitcroft 1940773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1941773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1942773647a0SAndy Whitcroft 1943171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1944773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1945171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1946773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1947773647a0SAndy Whitcroft } 1948773647a0SAndy Whitcroft push(@lines, $line); 1949773647a0SAndy Whitcroft 1950773647a0SAndy Whitcroft if ($realcnt > 1) { 1951773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1952773647a0SAndy Whitcroft } else { 1953773647a0SAndy Whitcroft $realcnt = 0; 1954773647a0SAndy Whitcroft } 1955773647a0SAndy Whitcroft 1956773647a0SAndy Whitcroft #print "==>$rawline\n"; 1957773647a0SAndy Whitcroft #print "-->$line\n"; 1958de7d4f0eSAndy Whitcroft 1959de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1960de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1961de7d4f0eSAndy Whitcroft } 1962de7d4f0eSAndy Whitcroft } 1963de7d4f0eSAndy Whitcroft 19646c72ffaaSAndy Whitcroft $prefix = ''; 19656c72ffaaSAndy Whitcroft 1966773647a0SAndy Whitcroft $realcnt = 0; 1967773647a0SAndy Whitcroft $linenr = 0; 1968194f66fcSJoe Perches $fixlinenr = -1; 19690a920b5bSAndy Whitcroft foreach my $line (@lines) { 19700a920b5bSAndy Whitcroft $linenr++; 1971194f66fcSJoe Perches $fixlinenr++; 19721b5539b1SJoe Perches my $sline = $line; #copy of $line 19731b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 19740a920b5bSAndy Whitcroft 1975c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 19766c72ffaaSAndy Whitcroft 19770a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 19786c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 19790a920b5bSAndy Whitcroft $is_patch = 1; 19804a0df2efSAndy Whitcroft $first_line = $linenr + 1; 19810a920b5bSAndy Whitcroft $realline=$1-1; 19820a920b5bSAndy Whitcroft if (defined $2) { 19830a920b5bSAndy Whitcroft $realcnt=$3+1; 19840a920b5bSAndy Whitcroft } else { 19850a920b5bSAndy Whitcroft $realcnt=1+1; 19860a920b5bSAndy Whitcroft } 1987c2fdda0dSAndy Whitcroft annotate_reset(); 198813214adfSAndy Whitcroft $prev_values = 'E'; 198913214adfSAndy Whitcroft 1990773647a0SAndy Whitcroft %suppress_ifbraces = (); 1991170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 19922b474a1aSAndy Whitcroft %suppress_export = (); 19933e469cdcSAndy Whitcroft $suppress_statement = 0; 19940a920b5bSAndy Whitcroft next; 19950a920b5bSAndy Whitcroft 19964a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 19974a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 19984a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1999773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 20000a920b5bSAndy Whitcroft $realline++; 2001d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 20020a920b5bSAndy Whitcroft 20034a0df2efSAndy Whitcroft # Measure the line length and indent. 2004c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 20050a920b5bSAndy Whitcroft 20060a920b5bSAndy Whitcroft # Track the previous line. 20070a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 20080a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2009c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2010c2fdda0dSAndy Whitcroft 2011773647a0SAndy Whitcroft #warn "line<$line>\n"; 20126c72ffaaSAndy Whitcroft 2013d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2014d8aaf121SAndy Whitcroft $realcnt--; 20150a920b5bSAndy Whitcroft } 20160a920b5bSAndy Whitcroft 2017cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2018cc77cdcaSAndy Whitcroft 20190a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 2020773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 2021773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 2022773647a0SAndy Whitcroft 20236c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 20246c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2025773647a0SAndy Whitcroft 20262ac73b4fSJoe Perches my $found_file = 0; 2027773647a0SAndy Whitcroft # extract the filename as it passes 20283bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 20293bf9a009SRabin Vincent $realfile = $1; 20302b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2031270c49a0SJoe Perches $in_commit_log = 0; 20322ac73b4fSJoe Perches $found_file = 1; 20333bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2034773647a0SAndy Whitcroft $realfile = $1; 20352b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2036270c49a0SJoe Perches $in_commit_log = 0; 20371e855726SWolfram Sang 20381e855726SWolfram Sang $p1_prefix = $1; 2039e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2040e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2041000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2042000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 20431e855726SWolfram Sang } 2044773647a0SAndy Whitcroft 2045c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2046000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2047000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2048773647a0SAndy Whitcroft } 20492ac73b4fSJoe Perches $found_file = 1; 20502ac73b4fSJoe Perches } 20512ac73b4fSJoe Perches 20522ac73b4fSJoe Perches if ($found_file) { 20532ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 20542ac73b4fSJoe Perches $check = 1; 20552ac73b4fSJoe Perches } else { 20562ac73b4fSJoe Perches $check = $check_orig; 20572ac73b4fSJoe Perches } 2058773647a0SAndy Whitcroft next; 2059773647a0SAndy Whitcroft } 2060773647a0SAndy Whitcroft 2061389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 20620a920b5bSAndy Whitcroft 2063c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2064c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2065c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 20660a920b5bSAndy Whitcroft 20676c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 20686c72ffaaSAndy Whitcroft 20693bf9a009SRabin Vincent# Check for incorrect file permissions 20703bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 20713bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 207204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 207304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2074000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2075000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 20763bf9a009SRabin Vincent } 20773bf9a009SRabin Vincent } 20783bf9a009SRabin Vincent 207920112475SJoe Perches# Check the patch for a signoff: 2080d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 20814a0df2efSAndy Whitcroft $signoff++; 208215662b3eSJoe Perches $in_commit_log = 0; 20830a920b5bSAndy Whitcroft } 208420112475SJoe Perches 2085e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2086e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2087e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2088e0d975b1SJoe Perches $reported_maintainer_file = 1; 2089e0d975b1SJoe Perches } 2090e0d975b1SJoe Perches 209120112475SJoe Perches# Check signature styles 2092270c49a0SJoe Perches if (!$in_header_lines && 2093ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 209420112475SJoe Perches my $space_before = $1; 209520112475SJoe Perches my $sign_off = $2; 209620112475SJoe Perches my $space_after = $3; 209720112475SJoe Perches my $email = $4; 209820112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 209920112475SJoe Perches 2100ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2101ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2102ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2103ce0338dfSJoe Perches } 210420112475SJoe Perches if (defined $space_before && $space_before ne "") { 21053705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21063705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 21073705ce5bSJoe Perches $fix) { 2108194f66fcSJoe Perches $fixed[$fixlinenr] = 21093705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21103705ce5bSJoe Perches } 211120112475SJoe Perches } 211220112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 21133705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21143705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 21153705ce5bSJoe Perches $fix) { 2116194f66fcSJoe Perches $fixed[$fixlinenr] = 21173705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21183705ce5bSJoe Perches } 21193705ce5bSJoe Perches 212020112475SJoe Perches } 212120112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 21223705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21233705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 21243705ce5bSJoe Perches $fix) { 2125194f66fcSJoe Perches $fixed[$fixlinenr] = 21263705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21273705ce5bSJoe Perches } 212820112475SJoe Perches } 212920112475SJoe Perches 213020112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 213120112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 213220112475SJoe Perches if ($suggested_email eq "") { 2133000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2134000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 213520112475SJoe Perches } else { 213620112475SJoe Perches my $dequoted = $suggested_email; 213720112475SJoe Perches $dequoted =~ s/^"//; 213820112475SJoe Perches $dequoted =~ s/" </ </; 213920112475SJoe Perches # Don't force email to have quotes 214020112475SJoe Perches # Allow just an angle bracketed address 214120112475SJoe Perches if ("$dequoted$comment" ne $email && 214220112475SJoe Perches "<$email_address>$comment" ne $email && 214320112475SJoe Perches "$suggested_email$comment" ne $email) { 2144000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2145000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 214620112475SJoe Perches } 21470a920b5bSAndy Whitcroft } 21487e51f197SJoe Perches 21497e51f197SJoe Perches# Check for duplicate signatures 21507e51f197SJoe Perches my $sig_nospace = $line; 21517e51f197SJoe Perches $sig_nospace =~ s/\s//g; 21527e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 21537e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 21547e51f197SJoe Perches WARN("BAD_SIGN_OFF", 21557e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 21567e51f197SJoe Perches } else { 21577e51f197SJoe Perches $signatures{$sig_nospace} = 1; 21587e51f197SJoe Perches } 21590a920b5bSAndy Whitcroft } 21600a920b5bSAndy Whitcroft 21619b3189ebSJoe Perches# Check for old stable address 21629b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 21639b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 21649b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 21659b3189ebSJoe Perches } 21669b3189ebSJoe Perches 21677ebd05efSChristopher Covington# Check for unwanted Gerrit info 21687ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 21697ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 21707ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 21717ebd05efSChristopher Covington } 21727ebd05efSChristopher Covington 2173d311cd44SJoe Perches# Check for improperly formed commit descriptions 2174d311cd44SJoe Perches if ($in_commit_log && 2175d311cd44SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}/i && 217666881735SJoe Perches !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ || 217766881735SJoe Perches ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ && 217866881735SJoe Perches defined $rawlines[$linenr] && 217966881735SJoe Perches $rawlines[$linenr] =~ /^\s*\("/))) { 2180d311cd44SJoe Perches $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i; 2181d311cd44SJoe Perches my $init_char = $1; 2182d311cd44SJoe Perches my $orig_commit = lc($2); 2183d311cd44SJoe Perches my $id = '01234567890ab'; 2184d311cd44SJoe Perches my $desc = 'commit description'; 2185d311cd44SJoe Perches ($id, $desc) = git_commit_info($orig_commit, $id, $desc); 2186d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 21873f6316b4SJoe Perches "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr); 2188d311cd44SJoe Perches } 2189d311cd44SJoe Perches 219013f1937eSJoe Perches# Check for added, moved or deleted files 219113f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 219213f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 219313f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 219413f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 219513f1937eSJoe Perches (defined($1) || defined($2))))) { 219613f1937eSJoe Perches $reported_maintainer_file = 1; 219713f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 219813f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 219913f1937eSJoe Perches } 220013f1937eSJoe Perches 220100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 22028905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2203000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2204000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 22056c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2206de7d4f0eSAndy Whitcroft } 2207de7d4f0eSAndy Whitcroft 22086ecd9674SAndy Whitcroft# Check for absolute kernel paths. 22096ecd9674SAndy Whitcroft if ($tree) { 22106ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 22116ecd9674SAndy Whitcroft my $file = $1; 22126ecd9674SAndy Whitcroft 22136ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 22146ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 22156ecd9674SAndy Whitcroft # 22166ecd9674SAndy Whitcroft } else { 22176ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 22186ecd9674SAndy Whitcroft } 22196ecd9674SAndy Whitcroft } 22206ecd9674SAndy Whitcroft } 22216ecd9674SAndy Whitcroft 2222de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2223de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2224171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2225171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2226171ae1a4SAndy Whitcroft 2227171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2228171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2229171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2230171ae1a4SAndy Whitcroft 223134d99219SJoe Perches CHK("INVALID_UTF8", 2232000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 223300df344fSAndy Whitcroft } 22340a920b5bSAndy Whitcroft 223515662b3eSJoe Perches# Check if it's the start of a commit log 223615662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 223715662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 223829ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 223929ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 224015662b3eSJoe Perches $in_header_lines = 0; 224115662b3eSJoe Perches $in_commit_log = 1; 224215662b3eSJoe Perches } 224315662b3eSJoe Perches 2244fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2245fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2246fa64205dSPasi Savanainen if ($in_header_lines && 2247fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2248fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2249fa64205dSPasi Savanainen $non_utf8_charset = 1; 2250fa64205dSPasi Savanainen } 2251fa64205dSPasi Savanainen 2252fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 225315662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2254fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 225515662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 225615662b3eSJoe Perches } 225715662b3eSJoe Perches 225866b47b4aSKees Cook# Check for various typo / spelling mistakes 225936061e38SJoe Perches if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) { 226066b47b4aSKees Cook while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) { 226166b47b4aSKees Cook my $typo = $1; 226266b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 226366b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 226466b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 226566b47b4aSKees Cook my $msg_type = \&WARN; 226666b47b4aSKees Cook $msg_type = \&CHK if ($file); 226766b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 226866b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 226966b47b4aSKees Cook $fix) { 227066b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 227166b47b4aSKees Cook } 227266b47b4aSKees Cook } 227366b47b4aSKees Cook } 227466b47b4aSKees Cook 227530670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 227630670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 227700df344fSAndy Whitcroft 22780a920b5bSAndy Whitcroft#trailing whitespace 22799c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2280c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2281d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2282d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2283d5e616fcSJoe Perches $fix) { 2284194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2285d5e616fcSJoe Perches } 2286c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2287c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22883705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 22893705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 22903705ce5bSJoe Perches $fix) { 2291194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 22923705ce5bSJoe Perches } 22933705ce5bSJoe Perches 2294d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 22950a920b5bSAndy Whitcroft } 22965368df20SAndy Whitcroft 22974783f894SJosh Triplett# Check for FSF mailing addresses. 2298109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 22993e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 23003e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 23014783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23024783f894SJosh Triplett my $msg_type = \&ERROR; 23034783f894SJosh Triplett $msg_type = \&CHK if ($file); 23044783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 23054783f894SJosh 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) 23064783f894SJosh Triplett } 23074783f894SJosh Triplett 23083354957aSAndi Kleen# check for Kconfig help text having a real description 23099fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 23109fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 23113354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 23128d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 23133354957aSAndi Kleen my $length = 0; 23149fe287d7SAndy Whitcroft my $cnt = $realcnt; 23159fe287d7SAndy Whitcroft my $ln = $linenr + 1; 23169fe287d7SAndy Whitcroft my $f; 2317a1385803SAndy Whitcroft my $is_start = 0; 23189fe287d7SAndy Whitcroft my $is_end = 0; 2319a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 23209fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 23219fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 23229fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 23239fe287d7SAndy Whitcroft 23249fe287d7SAndy Whitcroft next if ($f =~ /^-/); 23258d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2326a1385803SAndy Whitcroft 23278d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2328a1385803SAndy Whitcroft $is_start = 1; 23298d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2330a1385803SAndy Whitcroft $length = -1; 2331a1385803SAndy Whitcroft } 2332a1385803SAndy Whitcroft 23339fe287d7SAndy Whitcroft $f =~ s/^.//; 23343354957aSAndi Kleen $f =~ s/#.*//; 23353354957aSAndi Kleen $f =~ s/^\s+//; 23363354957aSAndi Kleen next if ($f =~ /^$/); 23379fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 23389fe287d7SAndy Whitcroft $is_end = 1; 23399fe287d7SAndy Whitcroft last; 23409fe287d7SAndy Whitcroft } 23413354957aSAndi Kleen $length++; 23423354957aSAndi Kleen } 234356193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2344000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 234556193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 234656193274SVadim Bendebury } 2347a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 23483354957aSAndi Kleen } 23493354957aSAndi Kleen 23501ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 23511ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 23521ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 23531ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 23541ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 23551ba8dfd1SKees Cook } 23561ba8dfd1SKees Cook 2357c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2358c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2359c68e5878SArnaud Lacombe my $flag = $1; 2360c68e5878SArnaud Lacombe my $replacement = { 2361c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2362c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2363c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2364c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2365c68e5878SArnaud Lacombe }; 2366c68e5878SArnaud Lacombe 2367c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2368c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2369c68e5878SArnaud Lacombe } 2370c68e5878SArnaud Lacombe 2371bff5da43SRob Herring# check for DT compatible documentation 23727dd05b38SFlorian Vaussard if (defined $root && 23737dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 23747dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 23757dd05b38SFlorian Vaussard 2376bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2377bff5da43SRob Herring 2378cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2379cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2380cc93319bSFlorian Vaussard 2381bff5da43SRob Herring foreach my $compat (@compats) { 2382bff5da43SRob Herring my $compat2 = $compat; 2383185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2384185d566bSRob Herring my $compat3 = $compat; 2385185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2386185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2387bff5da43SRob Herring if ( $? >> 8 ) { 2388bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2389bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2390bff5da43SRob Herring } 2391bff5da43SRob Herring 23924fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 23934fbf32a6SFlorian Vaussard my $vendor = $1; 2394cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2395bff5da43SRob Herring if ( $? >> 8 ) { 2396bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2397cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2398bff5da43SRob Herring } 2399bff5da43SRob Herring } 2400bff5da43SRob Herring } 2401bff5da43SRob Herring 24025368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2403de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 24045368df20SAndy Whitcroft 24056cd7f386SJoe Perches#line length limit 2406c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2407f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 24080fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 24098bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 24106cd7f386SJoe Perches $length > $max_line_length) 2411c45dcabdSAndy Whitcroft { 2412000d1cc1SJoe Perches WARN("LONG_LINE", 24136cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 24140a920b5bSAndy Whitcroft } 24150a920b5bSAndy Whitcroft 2416ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 24178c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 24188c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 24198c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2420ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2421ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 24228c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2423ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2424ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2425ca56dc09SJosh Triplett } 2426ca56dc09SJosh Triplett 2427ece9659fSDan Carpenter# check for missing a space in a string concatination 2428ece9659fSDan Carpenter if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 2429ece9659fSDan Carpenter WARN('MISSING_SPACE', 2430ece9659fSDan Carpenter "break quoted strings at a space character\n" . $hereprev); 2431ece9659fSDan Carpenter } 2432ece9659fSDan Carpenter 24335e79d96eSJoe Perches# check for spaces before a quoted newline 24345e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 24353705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 24363705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 24373705ce5bSJoe Perches $fix) { 2438194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 24393705ce5bSJoe Perches } 24403705ce5bSJoe Perches 24415e79d96eSJoe Perches } 24425e79d96eSJoe Perches 24438905a67cSAndy Whitcroft# check for adding lines without a newline. 24448905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2445000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2446000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 24478905a67cSAndy Whitcroft } 24488905a67cSAndy Whitcroft 244942e41c54SMike Frysinger# Blackfin: use hi/lo macros 245042e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 245142e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 245242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2453000d1cc1SJoe Perches ERROR("LO_MACRO", 2454000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 245542e41c54SMike Frysinger } 245642e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 245742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2458000d1cc1SJoe Perches ERROR("HI_MACRO", 2459000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 246042e41c54SMike Frysinger } 246142e41c54SMike Frysinger } 246242e41c54SMike Frysinger 2463b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2464de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 24650a920b5bSAndy Whitcroft 24660a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 24670a920b5bSAndy Whitcroft# more than 8 must use tabs. 2468c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2469c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2470c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2471d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 24723705ce5bSJoe Perches if (ERROR("CODE_INDENT", 24733705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 24743705ce5bSJoe Perches $fix) { 2475194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 24763705ce5bSJoe Perches } 24770a920b5bSAndy Whitcroft } 24780a920b5bSAndy Whitcroft 247908e44365SAlberto Panizzo# check for space before tabs. 248008e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 248108e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24823705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 24833705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 24843705ce5bSJoe Perches $fix) { 2485194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2486d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2487194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2488c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 24893705ce5bSJoe Perches } 249008e44365SAlberto Panizzo } 249108e44365SAlberto Panizzo 2492d1fe9c09SJoe Perches# check for && or || at the start of a line 2493d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2494d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2495d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2496d1fe9c09SJoe Perches } 2497d1fe9c09SJoe Perches 2498d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2499d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 250091cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2501d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2502d1fe9c09SJoe Perches my $oldindent = $1; 2503d1fe9c09SJoe Perches my $rest = $2; 2504d1fe9c09SJoe Perches 2505d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2506d1fe9c09SJoe Perches if ($pos >= 0) { 2507b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2508b34a26f3SJoe Perches my $newindent = $2; 2509d1fe9c09SJoe Perches 2510d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2511d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2512d1fe9c09SJoe Perches " " x ($pos % 8); 2513d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2514d1fe9c09SJoe Perches 2515d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2516d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 25173705ce5bSJoe Perches 25183705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 25193705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 25203705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2521194f66fcSJoe Perches $fixed[$fixlinenr] =~ 25223705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 25233705ce5bSJoe Perches } 2524d1fe9c09SJoe Perches } 2525d1fe9c09SJoe Perches } 2526d1fe9c09SJoe Perches } 2527d1fe9c09SJoe Perches 252804941aa7SJoe Perches if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ && 252904941aa7SJoe Perches (!defined($1) || $1 !~ /sizeof\s*/)) { 25303705ce5bSJoe Perches if (CHK("SPACING", 2531f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 25323705ce5bSJoe Perches $fix) { 2533194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2534f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 25353705ce5bSJoe Perches } 2536aad4f614SJoe Perches } 2537aad4f614SJoe Perches 253805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2539fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 254085ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 254185ad978cSJoe Perches $realline > 2) { 254205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 254305880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 254405880600SJoe Perches } 254505880600SJoe Perches 254605880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2547a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2548a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 254961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2550a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2551a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2552a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2553a605e32eSJoe Perches } 2554a605e32eSJoe Perches 2555a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2556c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2557c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2558c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2559c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 256005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 256105880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 256205880600SJoe Perches } 256305880600SJoe Perches 25647f619191SJoe Perches# check for missing blank lines after struct/union declarations 25657f619191SJoe Perches# with exceptions for various attributes and macros 25667f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 25677f619191SJoe Perches $line =~ /^\+/ && 25687f619191SJoe Perches !($line =~ /^\+\s*$/ || 25697f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 25707f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 25717f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 25727f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 25737f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 25747f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 25757f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2576d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2577d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2578d752fcc8SJoe Perches $fix) { 2579f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2580d752fcc8SJoe Perches } 25817f619191SJoe Perches } 25827f619191SJoe Perches 2583365dd4eaSJoe Perches# check for multiple consecutive blank lines 2584365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2585365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2586365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2587d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2588d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2589d752fcc8SJoe Perches $fix) { 2590f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2591d752fcc8SJoe Perches } 2592d752fcc8SJoe Perches 2593365dd4eaSJoe Perches $last_blank_line = $linenr; 2594365dd4eaSJoe Perches } 2595365dd4eaSJoe Perches 25963b617e3bSJoe Perches# check for missing blank lines after declarations 25973f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 25983f7bac03SJoe Perches # actual declarations 25993f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 26005a4e1fd3SJoe Perches # function pointer declarations 26015a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 26023f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 26033f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 26043f7bac03SJoe Perches # known declaration macros 26053f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 26063f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 26073f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 26083f7bac03SJoe Perches # other possible extensions of declaration lines 26093f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 26103f7bac03SJoe Perches # not starting a section or a macro "\" extended line 26113f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 26123f7bac03SJoe Perches # looks like a declaration 26133f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 26145a4e1fd3SJoe Perches # function pointer declarations 26155a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 26163f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 26173f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 26183f7bac03SJoe Perches # known declaration macros 26193f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 26203f7bac03SJoe Perches # start of struct or union or enum 26213b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 26223f7bac03SJoe Perches # start or end of block or continuation of declaration 26233f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 26243f7bac03SJoe Perches # bitfield continuation 26253f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 26263f7bac03SJoe Perches # other possible extensions of declaration lines 26273f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 26283f7bac03SJoe Perches # indentation of previous and current line are the same 26293f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2630d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2631d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2632d752fcc8SJoe Perches $fix) { 2633f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2634d752fcc8SJoe Perches } 26353b617e3bSJoe Perches } 26363b617e3bSJoe Perches 26375f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 26386b4c5bebSAndy Whitcroft# Exceptions: 26396b4c5bebSAndy Whitcroft# 1) within comments 26406b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 26416b4c5bebSAndy Whitcroft# 3) hanging labels 26423705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 26435f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26443705ce5bSJoe Perches if (WARN("LEADING_SPACE", 26453705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 26463705ce5bSJoe Perches $fix) { 2647194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 26483705ce5bSJoe Perches } 26495f7ddae6SRaffaele Recalcati } 26505f7ddae6SRaffaele Recalcati 2651b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2652b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2653b9ea10d6SAndy Whitcroft 2654032a4c0fSJoe Perches# check indentation of any line with a bare else 2655840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2656032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2657032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2658032a4c0fSJoe Perches my $tabs = length($1) + 1; 2659840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2660840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2661840080a0SJoe Perches defined $lines[$linenr] && 2662840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2663032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2664032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2665032a4c0fSJoe Perches } 2666032a4c0fSJoe Perches } 2667032a4c0fSJoe Perches 2668c00df19aSJoe Perches# check indentation of a line with a break; 2669c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2670c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2671c00df19aSJoe Perches my $tabs = $1; 2672c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2673c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2674c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2675c00df19aSJoe Perches } 2676c00df19aSJoe Perches } 2677c00df19aSJoe Perches 26781ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 26791ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 26801ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 26811ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 26821ba8dfd1SKees Cook } 26831ba8dfd1SKees Cook 2684c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2685cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2686000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2687000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2688c2fdda0dSAndy Whitcroft } 268922f2a2efSAndy Whitcroft 269042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 269142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 269242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2693000d1cc1SJoe Perches ERROR("CSYNC", 2694000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 269542e41c54SMike Frysinger } 269642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 269742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2698000d1cc1SJoe Perches ERROR("SSYNC", 2699000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 270042e41c54SMike Frysinger } 270142e41c54SMike Frysinger 270256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 270356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 270456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 270556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 270656e77d70SJoe Perches } 270756e77d70SJoe Perches 27089c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 27092b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 27102b474a1aSAndy Whitcroft $realline_next); 27113e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 27123e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 27131b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2714170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2715f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2716171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2717171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2718171ae1a4SAndy Whitcroft 27193e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 27203e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 27213e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 27223e469cdcSAndy Whitcroft # until we hit end of it. 27233e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 27243e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 27253e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 27263e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 27273e469cdcSAndy Whitcroft } 2728f74bd194SAndy Whitcroft 27292b474a1aSAndy Whitcroft # Find the real next line. 27302b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 27312b474a1aSAndy Whitcroft if (defined $realline_next && 27322b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 27332b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 27342b474a1aSAndy Whitcroft $realline_next++; 27352b474a1aSAndy Whitcroft } 27362b474a1aSAndy Whitcroft 2737171ae1a4SAndy Whitcroft my $s = $stat; 2738171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2739cf655043SAndy Whitcroft 2740c2fdda0dSAndy Whitcroft # Ignore goto labels. 2741171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2742c2fdda0dSAndy Whitcroft 2743c2fdda0dSAndy Whitcroft # Ignore functions being called 2744171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2745c2fdda0dSAndy Whitcroft 2746463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2747463f2864SAndy Whitcroft 2748c45dcabdSAndy Whitcroft # declarations always start with types 2749d2506586SAndy 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) { 2750c45dcabdSAndy Whitcroft my $type = $1; 2751c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2752c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2753c45dcabdSAndy Whitcroft 27546c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2755a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2756c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2757c2fdda0dSAndy Whitcroft } 27588905a67cSAndy Whitcroft 27596c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 276065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2761c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 27629c0ca6f9SAndy Whitcroft } 27638905a67cSAndy Whitcroft 27648905a67cSAndy Whitcroft # Check for any sort of function declaration. 27658905a67cSAndy Whitcroft # int foo(something bar, other baz); 27668905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2767171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 27688905a67cSAndy Whitcroft my ($name_len) = length($1); 27698905a67cSAndy Whitcroft 2770cf655043SAndy Whitcroft my $ctx = $s; 2771773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 27728905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2773cf655043SAndy Whitcroft 27748905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2775c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 27768905a67cSAndy Whitcroft 2777c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 27788905a67cSAndy Whitcroft } 27798905a67cSAndy Whitcroft } 27808905a67cSAndy Whitcroft } 27818905a67cSAndy Whitcroft 27829c0ca6f9SAndy Whitcroft } 27839c0ca6f9SAndy Whitcroft 278400df344fSAndy Whitcroft# 278500df344fSAndy Whitcroft# Checks which may be anchored in the context. 278600df344fSAndy Whitcroft# 278700df344fSAndy Whitcroft 278800df344fSAndy Whitcroft# Check for switch () and associated case and default 278900df344fSAndy Whitcroft# statements should be at the same indent. 279000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 279100df344fSAndy Whitcroft my $err = ''; 279200df344fSAndy Whitcroft my $sep = ''; 279300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 279400df344fSAndy Whitcroft shift(@ctx); 279500df344fSAndy Whitcroft for my $ctx (@ctx) { 279600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 279700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 279800df344fSAndy Whitcroft $indent != $cindent) { 279900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 280000df344fSAndy Whitcroft $sep = ''; 280100df344fSAndy Whitcroft } else { 280200df344fSAndy Whitcroft $sep = "[...]\n"; 280300df344fSAndy Whitcroft } 280400df344fSAndy Whitcroft } 280500df344fSAndy Whitcroft if ($err ne '') { 2806000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2807000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2808de7d4f0eSAndy Whitcroft } 2809de7d4f0eSAndy Whitcroft } 2810de7d4f0eSAndy Whitcroft 2811de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2812de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 28130fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2814773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2815773647a0SAndy Whitcroft 28169c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 28178eef05ddSJoe Perches 28188eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 28198eef05ddSJoe Perches WARN("DEEP_INDENTATION", 28208eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 28218eef05ddSJoe Perches } 28228eef05ddSJoe Perches 2823de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2824de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2825de7d4f0eSAndy Whitcroft 2826548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2827548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2828de7d4f0eSAndy Whitcroft 2829548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2830548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2831548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2832548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2833548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2834773647a0SAndy Whitcroft $ctx_ln++; 2835773647a0SAndy Whitcroft } 2836548596d5SAndy Whitcroft 283753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 283853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2839773647a0SAndy Whitcroft 2840773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2841000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2842000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 284301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 284400df344fSAndy Whitcroft } 2845773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2846773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2847773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2848773647a0SAndy Whitcroft { 28499c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 28509c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2851000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2852000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 285301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 28549c0ca6f9SAndy Whitcroft } 28559c0ca6f9SAndy Whitcroft } 285600df344fSAndy Whitcroft } 285700df344fSAndy Whitcroft 28584d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 28590fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 28603e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 28613e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 28623e469cdcSAndy Whitcroft if (!defined $stat); 28634d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 28644d001e4dSAndy Whitcroft 28654d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 28664d001e4dSAndy Whitcroft 28674d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 28684d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 28694d001e4dSAndy Whitcroft # where necessary. 28704d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 28714d001e4dSAndy Whitcroft 28724d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 28736f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 28746f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 28754d001e4dSAndy Whitcroft 28764d001e4dSAndy Whitcroft # We want to check the first line inside the block 28774d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 28784d001e4dSAndy Whitcroft # 1) any blank line termination 28794d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 28804d001e4dSAndy Whitcroft # 3) any do (...) { 28814d001e4dSAndy Whitcroft my $continuation = 0; 28824d001e4dSAndy Whitcroft my $check = 0; 28834d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 28844d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 28854d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 28864d001e4dSAndy Whitcroft $continuation = 1; 28874d001e4dSAndy Whitcroft } 28889bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 28894d001e4dSAndy Whitcroft $check = 1; 28904d001e4dSAndy Whitcroft $cond_lines++; 28914d001e4dSAndy Whitcroft } 28924d001e4dSAndy Whitcroft 28934d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 28944d001e4dSAndy Whitcroft # preprocessor statement. 28954d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 28964d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 28974d001e4dSAndy Whitcroft $check = 0; 28984d001e4dSAndy Whitcroft } 28994d001e4dSAndy Whitcroft 29009bd49efeSAndy Whitcroft my $cond_ptr = -1; 2901740504c6SAndy Whitcroft $continuation = 0; 29029bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 29039bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 29044d001e4dSAndy Whitcroft 2905f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2906f16fa28fSAndy Whitcroft # is not linear. 2907f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2908f16fa28fSAndy Whitcroft $check = 0; 2909f16fa28fSAndy Whitcroft } 2910f16fa28fSAndy Whitcroft 29119bd49efeSAndy Whitcroft # Ignore: 29129bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 29139bd49efeSAndy Whitcroft # 2) preprocessor lines, and 29149bd49efeSAndy Whitcroft # 3) labels. 2915740504c6SAndy Whitcroft if ($continuation || 2916740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 29179bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 29189bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2919740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 292030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 29219bd49efeSAndy Whitcroft $cond_lines++; 29229bd49efeSAndy Whitcroft } 29234d001e4dSAndy Whitcroft } 292430dad6ebSAndy Whitcroft } 29254d001e4dSAndy Whitcroft 29264d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 29274d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 29284d001e4dSAndy Whitcroft 29294d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 29304d001e4dSAndy Whitcroft # this is not this patch's fault. 29314d001e4dSAndy Whitcroft if (!defined($stat_real) || 29324d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 29334d001e4dSAndy Whitcroft $check = 0; 29344d001e4dSAndy Whitcroft } 29354d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 29364d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 29374d001e4dSAndy Whitcroft } 29384d001e4dSAndy Whitcroft 29399bd49efeSAndy 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"; 29404d001e4dSAndy Whitcroft 29414d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 29424d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2943000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2944000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 29454d001e4dSAndy Whitcroft } 29464d001e4dSAndy Whitcroft } 29474d001e4dSAndy Whitcroft 29486c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 29496c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 29501f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 29511f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 29526c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2953c2fdda0dSAndy Whitcroft if ($dbg_values) { 2954c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2955cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2956cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 29571f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2958c2fdda0dSAndy Whitcroft } 29596c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 29606c72ffaaSAndy Whitcroft 296100df344fSAndy Whitcroft#ignore lines not being added 29623705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 296300df344fSAndy Whitcroft 2964653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 29657429c690SAndy Whitcroft if ($dbg_type) { 29667429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2967000d1cc1SJoe Perches ERROR("TEST_TYPE", 2968000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 29697429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2970000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2971000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 29727429c690SAndy Whitcroft } 2973653d4876SAndy Whitcroft next; 2974653d4876SAndy Whitcroft } 2975a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2976a1ef277eSAndy Whitcroft if ($dbg_attr) { 29779360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2978000d1cc1SJoe Perches ERROR("TEST_ATTR", 2979000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 29809360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2981000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2982000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2983a1ef277eSAndy Whitcroft } 2984a1ef277eSAndy Whitcroft next; 2985a1ef277eSAndy Whitcroft } 2986653d4876SAndy Whitcroft 2987f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 298899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 298999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2990d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 2991d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 2992f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 2993f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 2994f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2995d752fcc8SJoe Perches my $fixedline = $prevrawline; 2996d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 2997f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 2998d752fcc8SJoe Perches $fixedline = $line; 2999d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3000f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3001d752fcc8SJoe Perches } 3002f0a594c1SAndy Whitcroft } 3003f0a594c1SAndy Whitcroft 300400df344fSAndy Whitcroft# 300500df344fSAndy Whitcroft# Checks which are anchored on the added line. 300600df344fSAndy Whitcroft# 300700df344fSAndy Whitcroft 3008653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3009c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3010653d4876SAndy Whitcroft my $path = $1; 3011653d4876SAndy Whitcroft if ($path =~ m{//}) { 3012000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3013495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3014495e9d84SJoe Perches } 3015495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3016495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3017495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3018653d4876SAndy Whitcroft } 3019653d4876SAndy Whitcroft } 3020653d4876SAndy Whitcroft 302100df344fSAndy Whitcroft# no C99 // comments 302200df344fSAndy Whitcroft if ($line =~ m{//}) { 30233705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 30243705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 30253705ce5bSJoe Perches $fix) { 3026194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 30273705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 30283705ce5bSJoe Perches my $comment = trim($1); 3029194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 30303705ce5bSJoe Perches } 30313705ce5bSJoe Perches } 303200df344fSAndy Whitcroft } 303300df344fSAndy Whitcroft # Remove C99 comments. 30340a920b5bSAndy Whitcroft $line =~ s@//.*@@; 30356c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 30360a920b5bSAndy Whitcroft 30372b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 30382b474a1aSAndy Whitcroft# the whole statement. 30392b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 30402b474a1aSAndy Whitcroft if (defined $realline_next && 30412b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 30422b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 30432b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 30442b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 30453cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 30463cbf62dfSAndy Whitcroft # a prefix: 30473cbf62dfSAndy Whitcroft # XXX(foo); 30483cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3049653d4876SAndy Whitcroft my $name = $1; 305087a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 30513cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 30523cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 30533cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 30543cbf62dfSAndy Whitcroft 30553cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 30562b474a1aSAndy Whitcroft \n.}\s*$| 305748012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 305848012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 305948012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 30602b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 30612b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 306248012058SAndy Whitcroft )/x) { 30632b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 30642b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 30652b474a1aSAndy Whitcroft } else { 30662b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 30670a920b5bSAndy Whitcroft } 30680a920b5bSAndy Whitcroft } 30692b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 30702b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 30712b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 30722b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 30732b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 30742b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 30752b474a1aSAndy Whitcroft } 30762b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 30772b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3078000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3079000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 30802b474a1aSAndy Whitcroft } 30810a920b5bSAndy Whitcroft 30825150bda4SJoe Eloff# check for global initialisers. 3083d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 3084d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3085000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3086d5e616fcSJoe Perches $herecurr) && 3087d5e616fcSJoe Perches $fix) { 3088194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 3089d5e616fcSJoe Perches } 3090f0a594c1SAndy Whitcroft } 30910a920b5bSAndy Whitcroft# check for static initialisers. 3092d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3093d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3094000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3095d5e616fcSJoe Perches $herecurr) && 3096d5e616fcSJoe Perches $fix) { 3097194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3098d5e616fcSJoe Perches } 30990a920b5bSAndy Whitcroft } 31000a920b5bSAndy Whitcroft 31011813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 31021813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 31031813087dSJoe Perches my $tmp = trim($1); 31041813087dSJoe Perches WARN("MISORDERED_TYPE", 31051813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 31061813087dSJoe Perches } 31071813087dSJoe Perches 3108cb710ecaSJoe Perches# check for static const char * arrays. 3109cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3110000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3111000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3112cb710ecaSJoe Perches $herecurr); 3113cb710ecaSJoe Perches } 3114cb710ecaSJoe Perches 3115cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3116cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3117000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3118000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3119cb710ecaSJoe Perches $herecurr); 3120cb710ecaSJoe Perches } 3121cb710ecaSJoe Perches 31229b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 31239b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 31249b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 31259b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 31269b0fa60dSJoe Perches $herecurr); 31279b0fa60dSJoe Perches } 31289b0fa60dSJoe Perches 3129b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3130b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3131b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3132b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3133b36190c5SJoe Perches $fix) { 3134194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3135b36190c5SJoe Perches } 3136b36190c5SJoe Perches } 3137b36190c5SJoe Perches 313892e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 313992e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 314092e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 314192e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 314292e112fdSJoe Perches $fix) { 3143194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 314492e112fdSJoe Perches } 314593ed0e2dSJoe Perches } 314693ed0e2dSJoe Perches 3147653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3148653d4876SAndy Whitcroft# make sense. 3149653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 31508054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3151c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 31528ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3153653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3154000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3155000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 31560a920b5bSAndy Whitcroft } 31570a920b5bSAndy Whitcroft 31580a920b5bSAndy Whitcroft# * goes on variable not on type 315965863862SAndy Whitcroft # (char*[ const]) 3160bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3161bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 31623705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3163d8aaf121SAndy Whitcroft 316465863862SAndy Whitcroft # Should start with a space. 316565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 316665863862SAndy Whitcroft # Should not end with a space. 316765863862SAndy Whitcroft $to =~ s/\s+$//; 316865863862SAndy Whitcroft # '*'s should not have spaces between. 3169f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 317065863862SAndy Whitcroft } 3171d8aaf121SAndy Whitcroft 31723705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 317365863862SAndy Whitcroft if ($from ne $to) { 31743705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 31753705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 31763705ce5bSJoe Perches $fix) { 31773705ce5bSJoe Perches my $sub_from = $ident; 31783705ce5bSJoe Perches my $sub_to = $ident; 31793705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3180194f66fcSJoe Perches $fixed[$fixlinenr] =~ 31813705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 31823705ce5bSJoe Perches } 318365863862SAndy Whitcroft } 3184bfcb2cc7SAndy Whitcroft } 3185bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3186bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 31873705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3188d8aaf121SAndy Whitcroft 318965863862SAndy Whitcroft # Should start with a space. 319065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 319165863862SAndy Whitcroft # Should not end with a space. 319265863862SAndy Whitcroft $to =~ s/\s+$//; 319365863862SAndy Whitcroft # '*'s should not have spaces between. 3194f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 319565863862SAndy Whitcroft } 319665863862SAndy Whitcroft # Modifiers should have spaces. 319765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 319865863862SAndy Whitcroft 31993705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3200667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 32013705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 32023705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 32033705ce5bSJoe Perches $fix) { 32043705ce5bSJoe Perches 32053705ce5bSJoe Perches my $sub_from = $match; 32063705ce5bSJoe Perches my $sub_to = $match; 32073705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3208194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32093705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 32103705ce5bSJoe Perches } 321165863862SAndy Whitcroft } 32120a920b5bSAndy Whitcroft } 32130a920b5bSAndy Whitcroft 32140a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 32150a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 32160a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 32170a920b5bSAndy Whitcroft# print "$herecurr"; 32180a920b5bSAndy Whitcroft# $clean = 0; 32190a920b5bSAndy Whitcroft# } 32200a920b5bSAndy Whitcroft 32218905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3222000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3223000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 32248905a67cSAndy Whitcroft } 32258905a67cSAndy Whitcroft 322617441227SJoe Perches# check for uses of printk_ratelimit 322717441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3228000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3229000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 323017441227SJoe Perches } 323117441227SJoe Perches 323200df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 323300df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 323400df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 323525985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 323600df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3237f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 323800df344fSAndy Whitcroft my $ok = 0; 323900df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 324000df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 324125985edcSLucas De Marchi # we have a preceding printk if it ends 324200df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 324300df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 324400df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 324500df344fSAndy Whitcroft $ok = 1; 324600df344fSAndy Whitcroft } 324700df344fSAndy Whitcroft last; 324800df344fSAndy Whitcroft } 324900df344fSAndy Whitcroft } 325000df344fSAndy Whitcroft if ($ok == 0) { 3251000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3252000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 32530a920b5bSAndy Whitcroft } 325400df344fSAndy Whitcroft } 32550a920b5bSAndy Whitcroft 3256243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3257243f3803SJoe Perches my $orig = $1; 3258243f3803SJoe Perches my $level = lc($orig); 3259243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 32608f26b837SJoe Perches my $level2 = $level; 32618f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3262243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3263daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3264243f3803SJoe Perches } 3265243f3803SJoe Perches 3266243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3267d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3268d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3269d5e616fcSJoe Perches $fix) { 3270194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3271d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3272d5e616fcSJoe Perches } 3273243f3803SJoe Perches } 3274243f3803SJoe Perches 3275dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3276dc139313SJoe Perches my $orig = $1; 3277dc139313SJoe Perches my $level = lc($orig); 3278dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3279dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3280dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3281dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3282dc139313SJoe Perches } 3283dc139313SJoe Perches 3284653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3285653d4876SAndy Whitcroft# or if closed on same line 32868d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3287c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 32888d182478SJoe Perches if (ERROR("OPEN_BRACE", 32898d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 32908d182478SJoe Perches $fix) { 32918d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 32928d182478SJoe Perches my $fixed_line = $rawline; 32938d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 32948d182478SJoe Perches my $line1 = $1; 32958d182478SJoe Perches my $line2 = $2; 32968d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 32978d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 32988d182478SJoe Perches if ($line2 !~ /^\s*$/) { 32998d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 33008d182478SJoe Perches } 33018d182478SJoe Perches } 33020a920b5bSAndy Whitcroft } 3303653d4876SAndy Whitcroft 33048905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 33058905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 33068905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 33078d182478SJoe Perches if (ERROR("OPEN_BRACE", 33088d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 33098d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 33108d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 33118d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 33128d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 33138d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 33148d182478SJoe Perches $fixedline = $rawline; 33158d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 33168d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 33178d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 33188d182478SJoe Perches } 33198d182478SJoe Perches } 33208905a67cSAndy Whitcroft } 33218905a67cSAndy Whitcroft 33220c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 33233705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 33243705ce5bSJoe Perches if (WARN("SPACING", 33253705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 33263705ce5bSJoe Perches $fix) { 3327194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33283705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 33293705ce5bSJoe Perches } 33300c73b4ebSAndy Whitcroft } 33310c73b4ebSAndy Whitcroft 333231070b5dSJoe Perches# Function pointer declarations 333331070b5dSJoe Perches# check spacing between type, funcptr, and args 333431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 333591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 333631070b5dSJoe Perches my $declare = $1; 333731070b5dSJoe Perches my $pre_pointer_space = $2; 333831070b5dSJoe Perches my $post_pointer_space = $3; 333931070b5dSJoe Perches my $funcname = $4; 334031070b5dSJoe Perches my $post_funcname_space = $5; 334131070b5dSJoe Perches my $pre_args_space = $6; 334231070b5dSJoe Perches 334391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 334491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 334591f72e9cSJoe Perches# don't need a space so don't warn for those. 334691f72e9cSJoe Perches my $post_declare_space = ""; 334791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 334891f72e9cSJoe Perches $post_declare_space = $1; 334991f72e9cSJoe Perches $declare = rtrim($declare); 335091f72e9cSJoe Perches } 335191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 335231070b5dSJoe Perches WARN("SPACING", 335331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 335491f72e9cSJoe Perches $post_declare_space = " "; 335531070b5dSJoe Perches } 335631070b5dSJoe Perches 335731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 335891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 335991f72e9cSJoe Perches# equivalent to 336091f72e9cSJoe Perches# int foo(int bar, ...) 336191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 336291f72e9cSJoe Perches# 336391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 336491f72e9cSJoe Perches# WARN("SPACING", 336591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 336691f72e9cSJoe Perches# } 336731070b5dSJoe Perches 336831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 336931070b5dSJoe Perches if (defined $pre_pointer_space && 337031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 337131070b5dSJoe Perches WARN("SPACING", 337231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 337331070b5dSJoe Perches } 337431070b5dSJoe Perches 337531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 337631070b5dSJoe Perches if (defined $post_pointer_space && 337731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 337831070b5dSJoe Perches WARN("SPACING", 337931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 338031070b5dSJoe Perches } 338131070b5dSJoe Perches 338231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 338331070b5dSJoe Perches if (defined $post_funcname_space && 338431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 338531070b5dSJoe Perches WARN("SPACING", 338631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 338731070b5dSJoe Perches } 338831070b5dSJoe Perches 338931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 339031070b5dSJoe Perches if (defined $pre_args_space && 339131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 339231070b5dSJoe Perches WARN("SPACING", 339331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 339431070b5dSJoe Perches } 339531070b5dSJoe Perches 339631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3397194f66fcSJoe Perches $fixed[$fixlinenr] =~ 339891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 339931070b5dSJoe Perches } 340031070b5dSJoe Perches } 340131070b5dSJoe Perches 34028d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 34038d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3404fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3405fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 34068d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 34078d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 34088d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3409fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3410daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 34113705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 34123705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 34133705ce5bSJoe Perches $fix) { 3414194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34153705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 34163705ce5bSJoe Perches } 34178d31cfceSAndy Whitcroft } 34188d31cfceSAndy Whitcroft } 34198d31cfceSAndy Whitcroft 3420f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 34216c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3422c2fdda0dSAndy Whitcroft my $name = $1; 3423773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3424773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3425c2fdda0dSAndy Whitcroft 3426c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3427773647a0SAndy Whitcroft if ($name =~ /^(?: 3428773647a0SAndy Whitcroft if|for|while|switch|return|case| 3429773647a0SAndy Whitcroft volatile|__volatile__| 3430773647a0SAndy Whitcroft __attribute__|format|__extension__| 3431773647a0SAndy Whitcroft asm|__asm__)$/x) 3432773647a0SAndy Whitcroft { 3433c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3434c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3435c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3436c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3437773647a0SAndy Whitcroft 3438773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3439c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3440c2fdda0dSAndy Whitcroft 3441c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3442c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3443773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3444c2fdda0dSAndy Whitcroft 3445c2fdda0dSAndy Whitcroft } else { 34463705ce5bSJoe Perches if (WARN("SPACING", 34473705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 34483705ce5bSJoe Perches $fix) { 3449194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34503705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 34513705ce5bSJoe Perches } 3452f0a594c1SAndy Whitcroft } 34536c72ffaaSAndy Whitcroft } 34549a4cad4eSEric Nelson 3455653d4876SAndy Whitcroft# Check operator spacing. 34560a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 34573705ce5bSJoe Perches my $fixed_line = ""; 34583705ce5bSJoe Perches my $line_fixed = 0; 34593705ce5bSJoe Perches 34609c0ca6f9SAndy Whitcroft my $ops = qr{ 34619c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 34629c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 34639c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 34641f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 346584731623SJoe Perches \?:|\?|: 34669c0ca6f9SAndy Whitcroft }x; 3467cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 34683705ce5bSJoe Perches 34693705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 34703705ce5bSJoe Perches## foreach my $el (@elements) { 34713705ce5bSJoe Perches## print("el: <$el>\n"); 34723705ce5bSJoe Perches## } 34733705ce5bSJoe Perches 34743705ce5bSJoe Perches my @fix_elements = (); 347500df344fSAndy Whitcroft my $off = 0; 34766c72ffaaSAndy Whitcroft 34773705ce5bSJoe Perches foreach my $el (@elements) { 34783705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 34793705ce5bSJoe Perches $off += length($el); 34803705ce5bSJoe Perches } 34813705ce5bSJoe Perches 34823705ce5bSJoe Perches $off = 0; 34833705ce5bSJoe Perches 34846c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3485b34c648bSJoe Perches my $last_after = -1; 34866c72ffaaSAndy Whitcroft 34870a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 34883705ce5bSJoe Perches 34893705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 34903705ce5bSJoe Perches 34913705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 34923705ce5bSJoe Perches 34934a0df2efSAndy Whitcroft $off += length($elements[$n]); 34944a0df2efSAndy Whitcroft 349525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3496773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3497773647a0SAndy Whitcroft my $cc = ''; 3498773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3499773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3500773647a0SAndy Whitcroft } 3501773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3502773647a0SAndy Whitcroft 35034a0df2efSAndy Whitcroft my $a = ''; 35044a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 35054a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3506cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 35074a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 35084a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3509773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 35104a0df2efSAndy Whitcroft 35110a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 35124a0df2efSAndy Whitcroft 35134a0df2efSAndy Whitcroft my $c = ''; 35140a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 35154a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 35164a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3517cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 35184a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 35194a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 35208b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 35214a0df2efSAndy Whitcroft } else { 35224a0df2efSAndy Whitcroft $c = 'E'; 35230a920b5bSAndy Whitcroft } 35240a920b5bSAndy Whitcroft 35254a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 35264a0df2efSAndy Whitcroft 35274a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 35284a0df2efSAndy Whitcroft 35296c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3530de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 35310a920b5bSAndy Whitcroft 353274048ed8SAndy Whitcroft # Pull out the value of this operator. 35336c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 35340a920b5bSAndy Whitcroft 35351f65f947SAndy Whitcroft # Get the full operator variant. 35361f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 35371f65f947SAndy Whitcroft 353813214adfSAndy Whitcroft # Ignore operators passed as parameters. 353913214adfSAndy Whitcroft if ($op_type ne 'V' && 354013214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 354113214adfSAndy Whitcroft 3542cf655043SAndy Whitcroft# # Ignore comments 3543cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 354413214adfSAndy Whitcroft 3545d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 354613214adfSAndy Whitcroft } elsif ($op eq ';') { 3547cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3548cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 35493705ce5bSJoe Perches if (ERROR("SPACING", 35503705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3551b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 35523705ce5bSJoe Perches $line_fixed = 1; 35533705ce5bSJoe Perches } 3554d8aaf121SAndy Whitcroft } 3555d8aaf121SAndy Whitcroft 3556d8aaf121SAndy Whitcroft # // is a comment 3557d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 35580a920b5bSAndy Whitcroft 3559b00e4814SJoe Perches # : when part of a bitfield 3560b00e4814SJoe Perches } elsif ($opv eq ':B') { 3561b00e4814SJoe Perches # skip the bitfield test for now 3562b00e4814SJoe Perches 35631f65f947SAndy Whitcroft # No spaces for: 35641f65f947SAndy Whitcroft # -> 3565b00e4814SJoe Perches } elsif ($op eq '->') { 35664a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 35673705ce5bSJoe Perches if (ERROR("SPACING", 35683705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3569b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 35703705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 35713705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 35723705ce5bSJoe Perches } 3573b34c648bSJoe Perches $line_fixed = 1; 35743705ce5bSJoe Perches } 35750a920b5bSAndy Whitcroft } 35760a920b5bSAndy Whitcroft 35772381097bSJoe Perches # , must not have a space before and must have a space on the right. 35780a920b5bSAndy Whitcroft } elsif ($op eq ',') { 35792381097bSJoe Perches my $rtrim_before = 0; 35802381097bSJoe Perches my $space_after = 0; 35812381097bSJoe Perches if ($ctx =~ /Wx./) { 35822381097bSJoe Perches if (ERROR("SPACING", 35832381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 35842381097bSJoe Perches $line_fixed = 1; 35852381097bSJoe Perches $rtrim_before = 1; 35862381097bSJoe Perches } 35872381097bSJoe Perches } 3588cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 35893705ce5bSJoe Perches if (ERROR("SPACING", 35903705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 35913705ce5bSJoe Perches $line_fixed = 1; 3592b34c648bSJoe Perches $last_after = $n; 35932381097bSJoe Perches $space_after = 1; 35942381097bSJoe Perches } 35952381097bSJoe Perches } 35962381097bSJoe Perches if ($rtrim_before || $space_after) { 35972381097bSJoe Perches if ($rtrim_before) { 35982381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 35992381097bSJoe Perches } else { 36002381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 36012381097bSJoe Perches } 36022381097bSJoe Perches if ($space_after) { 36032381097bSJoe Perches $good .= " "; 36043705ce5bSJoe Perches } 36050a920b5bSAndy Whitcroft } 36060a920b5bSAndy Whitcroft 36079c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 360874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 36099c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 36109c0ca6f9SAndy Whitcroft 36119c0ca6f9SAndy Whitcroft # unary operators should have a space before and 36129c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 36139c0ca6f9SAndy Whitcroft # unary operator, or a cast 36149c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 361574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 36160d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3617cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 36183705ce5bSJoe Perches if (ERROR("SPACING", 36193705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3620b34c648bSJoe Perches if ($n != $last_after + 2) { 3621b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 36223705ce5bSJoe Perches $line_fixed = 1; 36233705ce5bSJoe Perches } 36240a920b5bSAndy Whitcroft } 3625b34c648bSJoe Perches } 3626a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3627171ae1a4SAndy Whitcroft # A unary '*' may be const 3628171ae1a4SAndy Whitcroft 3629171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 36303705ce5bSJoe Perches if (ERROR("SPACING", 36313705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3632b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 36333705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 36343705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 36353705ce5bSJoe Perches } 3636b34c648bSJoe Perches $line_fixed = 1; 36373705ce5bSJoe Perches } 36380a920b5bSAndy Whitcroft } 36390a920b5bSAndy Whitcroft 36400a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 36410a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3642773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 36433705ce5bSJoe Perches if (ERROR("SPACING", 36443705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3645b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 36463705ce5bSJoe Perches $line_fixed = 1; 36473705ce5bSJoe Perches } 36480a920b5bSAndy Whitcroft } 3649773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3650773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 36513705ce5bSJoe Perches if (ERROR("SPACING", 36523705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3653b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 36543705ce5bSJoe Perches $line_fixed = 1; 36553705ce5bSJoe Perches } 3656653d4876SAndy Whitcroft } 3657773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 36583705ce5bSJoe Perches if (ERROR("SPACING", 36593705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3660b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 36613705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 36623705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3663773647a0SAndy Whitcroft } 3664b34c648bSJoe Perches $line_fixed = 1; 36653705ce5bSJoe Perches } 36663705ce5bSJoe Perches } 36670a920b5bSAndy Whitcroft 36680a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 36699c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 36709c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 36719c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3672c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3673c2fdda0dSAndy Whitcroft $op eq '%') 36740a920b5bSAndy Whitcroft { 3675773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 36763705ce5bSJoe Perches if (ERROR("SPACING", 36773705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3678b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3679b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3680b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3681b34c648bSJoe Perches } 36823705ce5bSJoe Perches $line_fixed = 1; 36833705ce5bSJoe Perches } 36840a920b5bSAndy Whitcroft } 36850a920b5bSAndy Whitcroft 36861f65f947SAndy Whitcroft # A colon needs no spaces before when it is 36871f65f947SAndy Whitcroft # terminating a case value or a label. 36881f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 36891f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 36903705ce5bSJoe Perches if (ERROR("SPACING", 36913705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3692b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 36933705ce5bSJoe Perches $line_fixed = 1; 36943705ce5bSJoe Perches } 36951f65f947SAndy Whitcroft } 36961f65f947SAndy Whitcroft 36970a920b5bSAndy Whitcroft # All the others need spaces both sides. 3698cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 36991f65f947SAndy Whitcroft my $ok = 0; 37001f65f947SAndy Whitcroft 370122f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 37021f65f947SAndy Whitcroft if (($op eq '<' && 37031f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 37041f65f947SAndy Whitcroft ($op eq '>' && 37051f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 37061f65f947SAndy Whitcroft { 37071f65f947SAndy Whitcroft $ok = 1; 37081f65f947SAndy Whitcroft } 37091f65f947SAndy Whitcroft 371084731623SJoe Perches # messages are ERROR, but ?: are CHK 37111f65f947SAndy Whitcroft if ($ok == 0) { 371284731623SJoe Perches my $msg_type = \&ERROR; 371384731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 371484731623SJoe Perches 371584731623SJoe Perches if (&{$msg_type}("SPACING", 37163705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3717b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3718b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3719b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3720b34c648bSJoe Perches } 37213705ce5bSJoe Perches $line_fixed = 1; 37223705ce5bSJoe Perches } 37230a920b5bSAndy Whitcroft } 372422f2a2efSAndy Whitcroft } 37254a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 37263705ce5bSJoe Perches 37273705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 37283705ce5bSJoe Perches 37293705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 37300a920b5bSAndy Whitcroft } 37313705ce5bSJoe Perches 37323705ce5bSJoe Perches if (($#elements % 2) == 0) { 37333705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 37343705ce5bSJoe Perches } 37353705ce5bSJoe Perches 3736194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3737194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 37383705ce5bSJoe Perches } 37393705ce5bSJoe Perches 37403705ce5bSJoe Perches 37410a920b5bSAndy Whitcroft } 37420a920b5bSAndy Whitcroft 3743786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3744d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3745786b6326SJoe Perches if (WARN("SPACING", 3746786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3747786b6326SJoe Perches $fix) { 3748194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3749786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3750786b6326SJoe Perches } 3751786b6326SJoe Perches } 3752786b6326SJoe Perches 3753f0a594c1SAndy Whitcroft# check for multiple assignments 3754f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3755000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3756000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3757f0a594c1SAndy Whitcroft } 3758f0a594c1SAndy Whitcroft 375922f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 376022f2a2efSAndy Whitcroft## # continuation. 376122f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 376222f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 376322f2a2efSAndy Whitcroft## 376422f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 376522f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 376622f2a2efSAndy Whitcroft## my $ln = $line; 376722f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 376822f2a2efSAndy Whitcroft## } 376922f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3770000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3771000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 377222f2a2efSAndy Whitcroft## } 377322f2a2efSAndy Whitcroft## } 3774f0a594c1SAndy Whitcroft 37750a920b5bSAndy Whitcroft#need space before brace following if, while, etc 377622f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 377722f2a2efSAndy Whitcroft $line =~ /do{/) { 37783705ce5bSJoe Perches if (ERROR("SPACING", 37793705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 37803705ce5bSJoe Perches $fix) { 3781194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 37823705ce5bSJoe Perches } 3783de7d4f0eSAndy Whitcroft } 3784de7d4f0eSAndy Whitcroft 3785c4a62ef9SJoe Perches## # check for blank lines before declarations 3786c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3787c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3788c4a62ef9SJoe Perches## WARN("SPACING", 3789c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3790c4a62ef9SJoe Perches## } 3791c4a62ef9SJoe Perches## 3792c4a62ef9SJoe Perches 3793de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3794de7d4f0eSAndy Whitcroft# on the line 3795de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3796d5e616fcSJoe Perches if (ERROR("SPACING", 3797d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3798d5e616fcSJoe Perches $fix) { 3799194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3800d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3801d5e616fcSJoe Perches } 38020a920b5bSAndy Whitcroft } 38030a920b5bSAndy Whitcroft 380422f2a2efSAndy Whitcroft# check spacing on square brackets 380522f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 38063705ce5bSJoe Perches if (ERROR("SPACING", 38073705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 38083705ce5bSJoe Perches $fix) { 3809194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38103705ce5bSJoe Perches s/\[\s+/\[/; 38113705ce5bSJoe Perches } 381222f2a2efSAndy Whitcroft } 381322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 38143705ce5bSJoe Perches if (ERROR("SPACING", 38153705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 38163705ce5bSJoe Perches $fix) { 3817194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38183705ce5bSJoe Perches s/\s+\]/\]/; 38193705ce5bSJoe Perches } 382022f2a2efSAndy Whitcroft } 382122f2a2efSAndy Whitcroft 3822c45dcabdSAndy Whitcroft# check spacing on parentheses 38239c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 38249c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 38253705ce5bSJoe Perches if (ERROR("SPACING", 38263705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 38273705ce5bSJoe Perches $fix) { 3828194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38293705ce5bSJoe Perches s/\(\s+/\(/; 38303705ce5bSJoe Perches } 383122f2a2efSAndy Whitcroft } 383213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3833c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3834c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 38353705ce5bSJoe Perches if (ERROR("SPACING", 38363705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 38373705ce5bSJoe Perches $fix) { 3838194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38393705ce5bSJoe Perches s/\s+\)/\)/; 38403705ce5bSJoe Perches } 384122f2a2efSAndy Whitcroft } 384222f2a2efSAndy Whitcroft 3843e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 3844e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 3845e2826fd0SJoe Perches 3846e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 3847*ea4acbb1SJoe Perches my $var = $1; 3848*ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3849*ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 3850*ea4acbb1SJoe Perches $fix) { 3851*ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 3852*ea4acbb1SJoe Perches } 3853*ea4acbb1SJoe Perches } 3854*ea4acbb1SJoe Perches 3855*ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 3856*ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 3857*ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 3858*ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 3859*ea4acbb1SJoe Perches my $var = $2; 3860*ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3861*ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 3862*ea4acbb1SJoe Perches $fix) { 3863*ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 3864*ea4acbb1SJoe Perches $var2 =~ s/\s//g; 3865*ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 3866*ea4acbb1SJoe Perches } 3867e2826fd0SJoe Perches } 3868e2826fd0SJoe Perches 38690a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 38704a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 38710a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 38723705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 38733705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 38743705ce5bSJoe Perches $fix) { 3875194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38763705ce5bSJoe Perches s/^(.)\s+/$1/; 38773705ce5bSJoe Perches } 38780a920b5bSAndy Whitcroft } 38790a920b5bSAndy Whitcroft 38805b9553abSJoe Perches# return is not a function 3881507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3882c45dcabdSAndy Whitcroft my $spacing = $1; 3883507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 38845b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 38855b9553abSJoe Perches my $value = $1; 38865b9553abSJoe Perches $value = deparenthesize($value); 38875b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3888000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3889000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 38905b9553abSJoe Perches } 3891c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3892000d1cc1SJoe Perches ERROR("SPACING", 3893000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3894c45dcabdSAndy Whitcroft } 3895c45dcabdSAndy Whitcroft } 3896507e5141SJoe Perches 3897b43ae21bSJoe Perches# unnecessary return in a void function 3898b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 3899b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 3900b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 3901b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 3902b43ae21bSJoe Perches $linenr >= 3 && 3903b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 3904b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 39059819cf25SJoe Perches WARN("RETURN_VOID", 3906b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 39079819cf25SJoe Perches } 39089819cf25SJoe Perches 3909189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3910189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3911189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3912189248d8SJoe Perches my $openparens = $1; 3913189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3914189248d8SJoe Perches my $msg = ""; 3915189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3916189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3917189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3918189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 3919189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 3920189248d8SJoe Perches } 3921189248d8SJoe Perches } 3922189248d8SJoe Perches 392353a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 392453a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 392553a3c448SAndy Whitcroft my $name = $1; 392653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3927000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3928000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 392953a3c448SAndy Whitcroft } 393053a3c448SAndy Whitcroft } 3931c45dcabdSAndy Whitcroft 39320a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 39334a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 39343705ce5bSJoe Perches if (ERROR("SPACING", 39353705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 39363705ce5bSJoe Perches $fix) { 3937194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39383705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 39393705ce5bSJoe Perches } 39400a920b5bSAndy Whitcroft } 39410a920b5bSAndy Whitcroft 3942f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3943f5fe35ddSAndy Whitcroft# statements after the conditional. 3944170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 39453e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 39463e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 39473e469cdcSAndy Whitcroft if (!defined $stat); 3948170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3949170d3a22SAndy Whitcroft $remain_next, $off_next); 3950170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3951170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3952170d3a22SAndy Whitcroft 3953170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3954170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3955170d3a22SAndy Whitcroft # then count those as offsets. 3956170d3a22SAndy Whitcroft my ($whitespace) = 3957170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3958170d3a22SAndy Whitcroft my $offset = 3959170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3960170d3a22SAndy Whitcroft 3961170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3962170d3a22SAndy Whitcroft $offset} = 1; 3963170d3a22SAndy Whitcroft } 3964170d3a22SAndy Whitcroft } 3965170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3966c11230f4SJoe Perches defined($stat) && defined($cond) && 3967170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3968171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 39698905a67cSAndy Whitcroft 3970b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3971000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3972000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 39738905a67cSAndy Whitcroft } 39748905a67cSAndy Whitcroft 39758905a67cSAndy Whitcroft # Find out what is on the end of the line after the 39768905a67cSAndy Whitcroft # conditional. 3977773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 39788905a67cSAndy Whitcroft $s =~ s/\n.*//g; 397913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 398053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 398153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3982773647a0SAndy Whitcroft { 3983bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3984bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3985bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 398642bdf74cSHidetoshi Seto my $stat_real = ''; 3987bb44ad39SAndy Whitcroft 398842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 398942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3990bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3991bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3992bb44ad39SAndy Whitcroft } 3993bb44ad39SAndy Whitcroft 3994000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3995000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 39968905a67cSAndy Whitcroft } 39978905a67cSAndy Whitcroft } 39988905a67cSAndy Whitcroft 399913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 400013214adfSAndy Whitcroft if ($line =~ / 400113214adfSAndy Whitcroft (?: 400213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 400313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 400413214adfSAndy Whitcroft (?:\&\&|\|\|) 400513214adfSAndy Whitcroft | 400613214adfSAndy Whitcroft (?:\&\&|\|\|) 400713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 400813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 400913214adfSAndy Whitcroft )/x) 401013214adfSAndy Whitcroft { 4011000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4012000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 401313214adfSAndy Whitcroft } 401413214adfSAndy Whitcroft 40158905a67cSAndy Whitcroft# if and else should not have general statements after it 401613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 401713214adfSAndy Whitcroft my $s = $1; 401813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 401913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4020000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4021000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 40220a920b5bSAndy Whitcroft } 402313214adfSAndy Whitcroft } 402439667782SAndy Whitcroft# if should not continue a brace 402539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4026000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4027048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 402839667782SAndy Whitcroft $herecurr); 402939667782SAndy Whitcroft } 4030a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4031a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4032a1080bf8SAndy Whitcroft $line !~ /\G(?: 40333fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4034a1080bf8SAndy Whitcroft \s*return\s+ 4035a1080bf8SAndy Whitcroft )/xg) 4036a1080bf8SAndy Whitcroft { 4037000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4038000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4039a1080bf8SAndy Whitcroft } 40400a920b5bSAndy Whitcroft 40410a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 40420a920b5bSAndy Whitcroft # indent level to be relevant to each other. 40438b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 40440a920b5bSAndy Whitcroft $previndent == $indent) { 40458b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 40468b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 40478b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 40488b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 40498b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 40508b8856f4SJoe Perches my $fixedline = $prevrawline; 40518b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 40528b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 40538b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40548b8856f4SJoe Perches } 40558b8856f4SJoe Perches $fixedline = $rawline; 40568b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 40578b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40588b8856f4SJoe Perches } 40590a920b5bSAndy Whitcroft } 40600a920b5bSAndy Whitcroft 40618b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4062c2fdda0dSAndy Whitcroft $previndent == $indent) { 4063c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4064c2fdda0dSAndy Whitcroft 4065c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4066c2fdda0dSAndy Whitcroft # conditional. 4067773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4068c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4069c2fdda0dSAndy Whitcroft 4070c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 40718b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 40728b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 40738b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 40748b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 40758b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 40768b8856f4SJoe Perches my $fixedline = $prevrawline; 40778b8856f4SJoe Perches my $trailing = $rawline; 40788b8856f4SJoe Perches $trailing =~ s/^\+//; 40798b8856f4SJoe Perches $trailing = trim($trailing); 40808b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 40818b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 40828b8856f4SJoe Perches } 4083c2fdda0dSAndy Whitcroft } 4084c2fdda0dSAndy Whitcroft } 4085c2fdda0dSAndy Whitcroft 408695e2c602SJoe Perches#Specific variable tests 4087323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4088323c1260SJoe Perches my $var = $1; 408995e2c602SJoe Perches 409095e2c602SJoe Perches#gcc binary extension 409195e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4092d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4093d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4094d5e616fcSJoe Perches $fix) { 4095d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4096194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4097d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4098d5e616fcSJoe Perches } 409995e2c602SJoe Perches } 410095e2c602SJoe Perches 410195e2c602SJoe Perches#CamelCase 4102807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4103be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 410422735ce8SJoe Perches#Ignore Page<foo> variants 4105807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 410622735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 41073445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 41087e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 41097e781f67SJoe Perches my $word = $1; 41107e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4111d8b07710SJoe Perches if ($check) { 4112d8b07710SJoe Perches seed_camelcase_includes(); 4113d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4114d8b07710SJoe Perches seed_camelcase_file($realfile); 4115d8b07710SJoe Perches $camelcase_file_seeded = 1; 4116d8b07710SJoe Perches } 4117d8b07710SJoe Perches } 41187e781f67SJoe Perches if (!defined $camelcase{$word}) { 41197e781f67SJoe Perches $camelcase{$word} = 1; 4120be79794bSJoe Perches CHK("CAMELCASE", 41217e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 41227e781f67SJoe Perches } 4123323c1260SJoe Perches } 4124323c1260SJoe Perches } 41253445686aSJoe Perches } 41260a920b5bSAndy Whitcroft 41270a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4128d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4129d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4130d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4131d5e616fcSJoe Perches $fix) { 4132194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4133d5e616fcSJoe Perches } 41340a920b5bSAndy Whitcroft } 41350a920b5bSAndy Whitcroft 4136653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 4137c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4138e09dec48SAndy Whitcroft my $file = "$1.h"; 4139e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4140e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4141e09dec48SAndy Whitcroft $realfile ne $checkfile && 41427840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4143c45dcabdSAndy Whitcroft { 4144e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4145000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4146000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4147e09dec48SAndy Whitcroft } else { 4148000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4149000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4150e09dec48SAndy Whitcroft } 41510a920b5bSAndy Whitcroft } 41520a920b5bSAndy Whitcroft } 41530a920b5bSAndy Whitcroft 4154653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4155653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4156cf655043SAndy Whitcroft# in a known good container 4157b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4158b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4159d8aaf121SAndy Whitcroft my $ln = $linenr; 4160d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4161c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4162c45dcabdSAndy Whitcroft my $ctx = ''; 416308a2843eSJoe Perches my $has_flow_statement = 0; 416408a2843eSJoe Perches my $has_arg_concat = 0; 4165c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4166f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4167f74bd194SAndy Whitcroft $ctx = $dstat; 4168c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4169a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4170c45dcabdSAndy Whitcroft 417108a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 417208a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 417308a2843eSJoe Perches 4174f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4175292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4176c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4177c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4178c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4179c45dcabdSAndy Whitcroft 4180c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4181bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4182bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4183c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4184bf30d6edSAndy Whitcroft { 4185c45dcabdSAndy Whitcroft } 4186c45dcabdSAndy Whitcroft 4187e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 4188e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 4189e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 4190e45bab8eSAndy Whitcroft { 4191e45bab8eSAndy Whitcroft } 4192e45bab8eSAndy Whitcroft 4193c45dcabdSAndy Whitcroft my $exceptions = qr{ 4194c45dcabdSAndy Whitcroft $Declare| 4195c45dcabdSAndy Whitcroft module_param_named| 4196a0a0a7a9SKees Cook MODULE_PARM_DESC| 4197c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4198c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4199383099fdSAndy Whitcroft __typeof__\(| 420022fd2d3eSStefani Seibold union| 420122fd2d3eSStefani Seibold struct| 4202ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4203ea71a0a0SAndy Whitcroft ^\"|\"$ 4204c45dcabdSAndy Whitcroft }x; 42055eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4206f74bd194SAndy Whitcroft if ($dstat ne '' && 4207f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4208f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 42093cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4210356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4211f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4212f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4213e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 421472f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4215f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4216f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4217f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4218f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4219f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4220c45dcabdSAndy Whitcroft { 4221f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4222f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4223f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4224f74bd194SAndy Whitcroft 4225f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4226f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4227c45dcabdSAndy Whitcroft } 4228c45dcabdSAndy Whitcroft 4229f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4230f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4231f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4232f74bd194SAndy Whitcroft } else { 4233000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4234388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4235d8aaf121SAndy Whitcroft } 42360a920b5bSAndy Whitcroft } 42375023d347SJoe Perches 423808a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 423908a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 424008a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 424108a2843eSJoe Perches my $herectx = $here . "\n"; 424208a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 424308a2843eSJoe Perches 424408a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 424508a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 424608a2843eSJoe Perches } 424708a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 424808a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 424908a2843eSJoe Perches } 425008a2843eSJoe Perches 4251481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 42525023d347SJoe Perches 42535023d347SJoe Perches } else { 42545023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4255481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4256481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 42575023d347SJoe Perches $line =~ /^\+.*\\$/) { 42585023d347SJoe Perches WARN("LINE_CONTINUATIONS", 42595023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 42605023d347SJoe Perches } 4261653d4876SAndy Whitcroft } 42620a920b5bSAndy Whitcroft 4263b13edf7fSJoe Perches# do {} while (0) macro tests: 4264b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4265b13edf7fSJoe Perches# macro should not end with a semicolon 4266b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4267b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4268b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4269b13edf7fSJoe Perches my $ln = $linenr; 4270b13edf7fSJoe Perches my $cnt = $realcnt; 4271b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4272b13edf7fSJoe Perches my $ctx = ''; 4273b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4274b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4275b13edf7fSJoe Perches $ctx = $dstat; 4276b13edf7fSJoe Perches 4277b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 4278b13edf7fSJoe Perches 4279b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4280b13edf7fSJoe Perches my $stmts = $2; 4281b13edf7fSJoe Perches my $semis = $3; 4282b13edf7fSJoe Perches 4283b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4284b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4285b13edf7fSJoe Perches my $herectx = $here . "\n"; 4286b13edf7fSJoe Perches 4287b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4288b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4289b13edf7fSJoe Perches } 4290b13edf7fSJoe Perches 4291ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4292ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4293b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4294b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4295b13edf7fSJoe Perches } 4296b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4297b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4298b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4299b13edf7fSJoe Perches } 4300f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4301f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4302f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4303f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4304f5ef95b1SJoe Perches 4305f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4306f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4307f5ef95b1SJoe Perches } 4308f5ef95b1SJoe Perches 4309f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4310f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4311b13edf7fSJoe Perches } 4312b13edf7fSJoe Perches } 4313b13edf7fSJoe Perches 4314080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4315080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4316080ba929SMike Frysinger# . 4317080ba929SMike Frysinger# ALIGN(...) 4318080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4319080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4320000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4321000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4322080ba929SMike Frysinger } 4323080ba929SMike Frysinger 4324f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 432513214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 432613214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4327cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 432813214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4329cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4330cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4331aad4f614SJoe Perches my @allowed = (); 4332aad4f614SJoe Perches my $allow = 0; 433313214adfSAndy Whitcroft my $seen = 0; 4334773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4335cf655043SAndy Whitcroft my $ln = $linenr - 1; 433613214adfSAndy Whitcroft for my $chunk (@chunks) { 433713214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 433813214adfSAndy Whitcroft 4339773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4340773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4341773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4342773647a0SAndy Whitcroft 4343aad4f614SJoe Perches $allowed[$allow] = 0; 4344773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4345773647a0SAndy Whitcroft 4346773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4347773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4348773647a0SAndy Whitcroft 4349773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4350cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4351cf655043SAndy Whitcroft 4352773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 435313214adfSAndy Whitcroft 435413214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 435513214adfSAndy Whitcroft 4356aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4357cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4358cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4359aad4f614SJoe Perches $allowed[$allow] = 1; 436013214adfSAndy Whitcroft } 436113214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4362cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4363aad4f614SJoe Perches $allowed[$allow] = 1; 436413214adfSAndy Whitcroft } 4365cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4366cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4367aad4f614SJoe Perches $allowed[$allow] = 1; 436813214adfSAndy Whitcroft } 4369aad4f614SJoe Perches $allow++; 437013214adfSAndy Whitcroft } 4371aad4f614SJoe Perches if ($seen) { 4372aad4f614SJoe Perches my $sum_allowed = 0; 4373aad4f614SJoe Perches foreach (@allowed) { 4374aad4f614SJoe Perches $sum_allowed += $_; 4375aad4f614SJoe Perches } 4376aad4f614SJoe Perches if ($sum_allowed == 0) { 4377000d1cc1SJoe Perches WARN("BRACES", 4378000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4379aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4380aad4f614SJoe Perches $seen != $allow) { 4381aad4f614SJoe Perches CHK("BRACES", 4382aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4383aad4f614SJoe Perches } 438413214adfSAndy Whitcroft } 438513214adfSAndy Whitcroft } 438613214adfSAndy Whitcroft } 4387773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 438813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4389cf655043SAndy Whitcroft my $allowed = 0; 4390f0a594c1SAndy Whitcroft 4391cf655043SAndy Whitcroft # Check the pre-context. 4392cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4393cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4394cf655043SAndy Whitcroft $allowed = 1; 4395f0a594c1SAndy Whitcroft } 4396773647a0SAndy Whitcroft 4397773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4398773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4399773647a0SAndy Whitcroft 4400cf655043SAndy Whitcroft # Check the condition. 4401cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4402773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4403cf655043SAndy Whitcroft if (defined $cond) { 4404773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4405cf655043SAndy Whitcroft } 4406cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4407cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4408cf655043SAndy Whitcroft $allowed = 1; 4409cf655043SAndy Whitcroft } 4410cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4411cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4412cf655043SAndy Whitcroft $allowed = 1; 4413cf655043SAndy Whitcroft } 4414cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4415cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4416cf655043SAndy Whitcroft $allowed = 1; 4417cf655043SAndy Whitcroft } 4418cf655043SAndy Whitcroft # Check the post-context. 4419cf655043SAndy Whitcroft if (defined $chunks[1]) { 4420cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4421cf655043SAndy Whitcroft if (defined $cond) { 4422773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4423cf655043SAndy Whitcroft } 4424cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4425cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4426cf655043SAndy Whitcroft $allowed = 1; 4427cf655043SAndy Whitcroft } 4428cf655043SAndy Whitcroft } 4429cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 443069932487SJustin P. Mattock my $herectx = $here . "\n"; 4431f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4432cf655043SAndy Whitcroft 4433f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 443469932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4435cf655043SAndy Whitcroft } 4436cf655043SAndy Whitcroft 4437000d1cc1SJoe Perches WARN("BRACES", 4438000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4439f0a594c1SAndy Whitcroft } 4440f0a594c1SAndy Whitcroft } 4441f0a594c1SAndy Whitcroft 44420979ae66SJoe Perches# check for unnecessary blank lines around braces 444377b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 44440979ae66SJoe Perches CHK("BRACES", 44450979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 44460979ae66SJoe Perches } 444777b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 44480979ae66SJoe Perches CHK("BRACES", 44490979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 44500979ae66SJoe Perches } 44510979ae66SJoe Perches 44524a0df2efSAndy Whitcroft# no volatiles please 44536c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 44546c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4455000d1cc1SJoe Perches WARN("VOLATILE", 4456000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 44574a0df2efSAndy Whitcroft } 44584a0df2efSAndy Whitcroft 4459f17dba4fSJoe Perches# concatenated string without spaces between elements 4460f17dba4fSJoe Perches if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) { 4461f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4462f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4463f17dba4fSJoe Perches } 4464f17dba4fSJoe Perches 446500df344fSAndy Whitcroft# warn about #if 0 4466c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4467000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4468000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4469de7d4f0eSAndy Whitcroft $herecurr); 44704a0df2efSAndy Whitcroft } 44714a0df2efSAndy Whitcroft 447203df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 447303df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 447403df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 447503df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 447603df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 447715160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 44784c432a8fSGreg Kroah-Hartman } 44794c432a8fSGreg Kroah-Hartman } 4480f0a594c1SAndy Whitcroft 4481ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4482ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4483ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4484ebfdc409SJoe Perches (defined $1 || defined $3) && 4485ebfdc409SJoe Perches $linenr > 3) { 4486ebfdc409SJoe Perches my $testval = $2; 4487ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4488ebfdc409SJoe Perches 4489ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4490ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4491ebfdc409SJoe Perches 4492ebfdc409SJoe Perches if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) { 4493ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4494ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4495ebfdc409SJoe Perches } 4496ebfdc409SJoe Perches } 4497ebfdc409SJoe Perches 4498f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4499f78d98f6SJoe Perches if ($line !~ /printk\s*\(/ && 4500f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4501f78d98f6SJoe Perches my $level = $1; 4502f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4503f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4504f78d98f6SJoe Perches $fix) { 4505f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4506f78d98f6SJoe Perches } 4507f78d98f6SJoe Perches } 4508f78d98f6SJoe Perches 4509abb08a53SJoe Perches# check for mask then right shift without a parentheses 4510abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4511abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4512abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4513abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4514abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4515abb08a53SJoe Perches } 4516abb08a53SJoe Perches 45178716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 45188716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 45198716de38SJoe Perches my $attr = $1; 45208716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 45218716de38SJoe Perches my $ptr = $1; 45228716de38SJoe Perches my $var = $2; 45238716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 45248716de38SJoe Perches ERROR("MISPLACED_INIT", 45258716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 45268716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 45278716de38SJoe Perches WARN("MISPLACED_INIT", 45288716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 45298716de38SJoe Perches $fix) { 4530194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e; 45318716de38SJoe Perches } 45328716de38SJoe Perches } 45338716de38SJoe Perches } 45348716de38SJoe Perches 4535e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4536e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4537e970b884SJoe Perches my $attr = $1; 4538e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4539e970b884SJoe Perches my $attr_prefix = $1; 4540e970b884SJoe Perches my $attr_type = $2; 4541e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4542e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4543e970b884SJoe Perches $fix) { 4544194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4545e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4546e970b884SJoe Perches } 4547e970b884SJoe Perches } 4548e970b884SJoe Perches 4549e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4550e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4551e970b884SJoe Perches my $attr = $1; 4552e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4553e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4554e970b884SJoe Perches $fix) { 4555194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4556e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4557e970b884SJoe Perches $lead = rtrim($1); 4558e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4559e970b884SJoe Perches $lead = "${lead}const "; 4560194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4561e970b884SJoe Perches } 4562e970b884SJoe Perches } 4563e970b884SJoe Perches 4564fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4565fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4566fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4567fbdb8138SJoe Perches my $constant_func = $1; 4568fbdb8138SJoe Perches my $func = $constant_func; 4569fbdb8138SJoe Perches $func =~ s/^__constant_//; 4570fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4571fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4572fbdb8138SJoe Perches $fix) { 4573194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4574fbdb8138SJoe Perches } 4575fbdb8138SJoe Perches } 4576fbdb8138SJoe Perches 45771a15a250SPatrick Pannuto# prefer usleep_range over udelay 457837581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 457943c1d77cSJoe Perches my $delay = $1; 45801a15a250SPatrick Pannuto # ignore udelay's < 10, however 458143c1d77cSJoe Perches if (! ($delay < 10) ) { 4582000d1cc1SJoe Perches CHK("USLEEP_RANGE", 458343c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 458443c1d77cSJoe Perches } 458543c1d77cSJoe Perches if ($delay > 2000) { 458643c1d77cSJoe Perches WARN("LONG_UDELAY", 458743c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 45881a15a250SPatrick Pannuto } 45891a15a250SPatrick Pannuto } 45901a15a250SPatrick Pannuto 459109ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 459209ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 459309ef8725SPatrick Pannuto if ($1 < 20) { 4594000d1cc1SJoe Perches WARN("MSLEEP", 459543c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 459609ef8725SPatrick Pannuto } 459709ef8725SPatrick Pannuto } 459809ef8725SPatrick Pannuto 459936ec1939SJoe Perches# check for comparisons of jiffies 460036ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 460136ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 460236ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 460336ec1939SJoe Perches } 460436ec1939SJoe Perches 46059d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 46069d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 46079d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 46089d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 46099d7a34a5SJoe Perches } 46109d7a34a5SJoe Perches 461100df344fSAndy Whitcroft# warn about #ifdefs in C files 4612c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 461300df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 461400df344fSAndy Whitcroft# print "$herecurr"; 461500df344fSAndy Whitcroft# $clean = 0; 461600df344fSAndy Whitcroft# } 461700df344fSAndy Whitcroft 461822f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4619c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 46203705ce5bSJoe Perches if (ERROR("SPACING", 46213705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 46223705ce5bSJoe Perches $fix) { 4623194f66fcSJoe Perches $fixed[$fixlinenr] =~ 46243705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 46253705ce5bSJoe Perches } 46263705ce5bSJoe Perches 462722f2a2efSAndy Whitcroft } 462822f2a2efSAndy Whitcroft 46294a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4630171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4631171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 46324a0df2efSAndy Whitcroft my $which = $1; 46334a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4634000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4635000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 46364a0df2efSAndy Whitcroft } 46374a0df2efSAndy Whitcroft } 46384a0df2efSAndy Whitcroft# check for memory barriers without a comment. 46394a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 46404a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4641c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4642000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 46434a0df2efSAndy Whitcroft } 46444a0df2efSAndy Whitcroft } 46454a0df2efSAndy Whitcroft# check of hardware specific defines 4646c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4647000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4648000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 46490a920b5bSAndy Whitcroft } 4650653d4876SAndy Whitcroft 4651d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4652d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4653000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4654000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4655d4977c78STobias Klauser } 4656d4977c78STobias Klauser 4657de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4658de7d4f0eSAndy Whitcroft# storage class and type. 46599c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 46609c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4661000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4662000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4663de7d4f0eSAndy Whitcroft } 4664de7d4f0eSAndy Whitcroft 46658905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 46662b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 46672b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4668d5e616fcSJoe Perches if (WARN("INLINE", 4669d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4670d5e616fcSJoe Perches $fix) { 4671194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 4672d5e616fcSJoe Perches 4673d5e616fcSJoe Perches } 46748905a67cSAndy Whitcroft } 46758905a67cSAndy Whitcroft 46763d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 46772b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 46782b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4679000d1cc1SJoe Perches WARN("PREFER_PACKED", 4680000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 46813d130fd0SJoe Perches } 46823d130fd0SJoe Perches 468339b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 46842b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 46852b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4686000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4687000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 468839b7e287SJoe Perches } 468939b7e287SJoe Perches 46905f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 46912b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 46922b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4693d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4694d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4695d5e616fcSJoe Perches $fix) { 4696194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4697d5e616fcSJoe Perches 4698d5e616fcSJoe Perches } 46995f14d3bdSJoe Perches } 47005f14d3bdSJoe Perches 47016061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 47022b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 47032b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4704d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4705d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4706d5e616fcSJoe Perches $fix) { 4707194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4708d5e616fcSJoe Perches } 47096061d949SJoe Perches } 47106061d949SJoe Perches 4711619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 4712619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 4713619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 4714619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 4715619a908aSJoe Perches $line =~ /\b__weak\b/)) { 4716619a908aSJoe Perches ERROR("WEAK_DECLARATION", 4717619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 4718619a908aSJoe Perches } 4719619a908aSJoe Perches 47208f53a9b8SJoe Perches# check for sizeof(&) 47218f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4722000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4723000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 47248f53a9b8SJoe Perches } 47258f53a9b8SJoe Perches 472666c80b60SJoe Perches# check for sizeof without parenthesis 472766c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4728d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4729d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4730d5e616fcSJoe Perches $fix) { 4731194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4732d5e616fcSJoe Perches } 473366c80b60SJoe Perches } 473466c80b60SJoe Perches 4735428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 4736428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 4737000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 4738000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 4739428e2fdcSJoe Perches } 4740428e2fdcSJoe Perches 474188982feaSJoe Perches# check for struct spinlock declarations 474288982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 474388982feaSJoe Perches WARN("USE_SPINLOCK_T", 474488982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 474588982feaSJoe Perches } 474688982feaSJoe Perches 4747a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 474806668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4749a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 475006668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 4751d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4752d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4753d5e616fcSJoe Perches $fix) { 4754194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 4755d5e616fcSJoe Perches } 4756a6962d72SJoe Perches } 4757a6962d72SJoe Perches } 4758a6962d72SJoe Perches 4759554e165cSAndy Whitcroft# Check for misused memsets 4760d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4761d1fe9c09SJoe Perches defined $stat && 4762d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4763554e165cSAndy Whitcroft 4764d7c76ba7SJoe Perches my $ms_addr = $2; 4765d1fe9c09SJoe Perches my $ms_val = $7; 4766d1fe9c09SJoe Perches my $ms_size = $12; 4767d7c76ba7SJoe Perches 4768554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4769554e165cSAndy Whitcroft ERROR("MEMSET", 4770d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4771554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4772554e165cSAndy Whitcroft WARN("MEMSET", 4773d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4774d7c76ba7SJoe Perches } 4775d7c76ba7SJoe Perches } 4776d7c76ba7SJoe Perches 477798a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 477898a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 477998a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 478098a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 478198a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 478298a9bba5SJoe Perches $fix) { 4783194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 478498a9bba5SJoe Perches } 478598a9bba5SJoe Perches } 478698a9bba5SJoe Perches 4787d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4788d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4789d1fe9c09SJoe Perches defined $stat && 4790d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4791d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4792d7c76ba7SJoe Perches my $call = $1; 4793d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4794d7c76ba7SJoe Perches my $arg1 = $3; 4795d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4796d1fe9c09SJoe Perches my $arg2 = $8; 4797d7c76ba7SJoe Perches my $cast; 4798d7c76ba7SJoe Perches 4799d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4800d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4801d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4802d7c76ba7SJoe Perches $cast = $cast1; 4803d7c76ba7SJoe Perches } else { 4804d7c76ba7SJoe Perches $cast = $cast2; 4805d7c76ba7SJoe Perches } 4806d7c76ba7SJoe Perches WARN("MINMAX", 4807d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4808554e165cSAndy Whitcroft } 4809554e165cSAndy Whitcroft } 4810554e165cSAndy Whitcroft 48114a273195SJoe Perches# check usleep_range arguments 48124a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 48134a273195SJoe Perches defined $stat && 48144a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 48154a273195SJoe Perches my $min = $1; 48164a273195SJoe Perches my $max = $7; 48174a273195SJoe Perches if ($min eq $max) { 48184a273195SJoe Perches WARN("USLEEP_RANGE", 48194a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 48204a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 48214a273195SJoe Perches $min > $max) { 48224a273195SJoe Perches WARN("USLEEP_RANGE", 48234a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 48244a273195SJoe Perches } 48254a273195SJoe Perches } 48264a273195SJoe Perches 4827823b794cSJoe Perches# check for naked sscanf 4828823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4829823b794cSJoe Perches defined $stat && 48306c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 4831823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4832823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4833823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4834823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4835823b794cSJoe Perches $lc = $lc + $linenr; 4836823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4837823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4838823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4839823b794cSJoe Perches } 4840823b794cSJoe Perches WARN("NAKED_SSCANF", 4841823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4842823b794cSJoe Perches } 4843823b794cSJoe Perches 4844afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 4845afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 4846afc819abSJoe Perches defined $stat && 4847afc819abSJoe Perches $line =~ /\bsscanf\b/) { 4848afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 4849afc819abSJoe Perches $lc = $lc + $linenr; 4850afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 4851afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4852afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4853afc819abSJoe Perches } 4854afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 4855afc819abSJoe Perches my $format = $6; 4856afc819abSJoe Perches my $count = $format =~ tr@%@%@; 4857afc819abSJoe Perches if ($count == 1 && 4858afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 4859afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 4860afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 4861afc819abSJoe Perches } 4862afc819abSJoe Perches } 4863afc819abSJoe Perches } 4864afc819abSJoe Perches 486570dc8a48SJoe Perches# check for new externs in .h files. 486670dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 486770dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4868d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 486970dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 487070dc8a48SJoe Perches $fix) { 4871194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 487270dc8a48SJoe Perches } 487370dc8a48SJoe Perches } 487470dc8a48SJoe Perches 4875de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4876171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4877c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4878171ae1a4SAndy Whitcroft { 4879c45dcabdSAndy Whitcroft my $function_name = $1; 4880c45dcabdSAndy Whitcroft my $paren_space = $2; 4881171ae1a4SAndy Whitcroft 4882171ae1a4SAndy Whitcroft my $s = $stat; 4883171ae1a4SAndy Whitcroft if (defined $cond) { 4884171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4885171ae1a4SAndy Whitcroft } 4886c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4887c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4888c45dcabdSAndy Whitcroft { 4889000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4890000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4891de7d4f0eSAndy Whitcroft } 4892de7d4f0eSAndy Whitcroft 4893171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4894000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4895000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4896171ae1a4SAndy Whitcroft } 48979c9ba34eSAndy Whitcroft 48989c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 48999c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 49009c9ba34eSAndy Whitcroft { 4901000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4902000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4903171ae1a4SAndy Whitcroft } 4904171ae1a4SAndy Whitcroft 4905de7d4f0eSAndy Whitcroft# checks for new __setup's 4906de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4907de7d4f0eSAndy Whitcroft my $name = $1; 4908de7d4f0eSAndy Whitcroft 4909de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4910000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4911000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4912de7d4f0eSAndy Whitcroft } 4913653d4876SAndy Whitcroft } 49149c0ca6f9SAndy Whitcroft 49159c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4916caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4917000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4918000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 49199c0ca6f9SAndy Whitcroft } 492013214adfSAndy Whitcroft 4921a640d25cSJoe Perches# alloc style 4922a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4923a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4924a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4925a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4926a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4927a640d25cSJoe Perches } 4928a640d25cSJoe Perches 492960a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 493060a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 4931e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 493260a55369SJoe Perches my $oldfunc = $3; 493360a55369SJoe Perches my $a1 = $4; 493460a55369SJoe Perches my $a2 = $10; 493560a55369SJoe Perches my $newfunc = "kmalloc_array"; 493660a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 493760a55369SJoe Perches my $r1 = $a1; 493860a55369SJoe Perches my $r2 = $a2; 493960a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 494060a55369SJoe Perches $r1 = $a2; 494160a55369SJoe Perches $r2 = $a1; 494260a55369SJoe Perches } 4943e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 4944e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 4945e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 4946e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 4947e367455aSJoe Perches $fix) { 4948194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e; 494960a55369SJoe Perches 495060a55369SJoe Perches } 495160a55369SJoe Perches } 495260a55369SJoe Perches } 495360a55369SJoe Perches 4954972fdea2SJoe Perches# check for krealloc arg reuse 4955972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4956972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4957972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4958972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4959972fdea2SJoe Perches } 4960972fdea2SJoe Perches 49615ce59ae0SJoe Perches# check for alloc argument mismatch 49625ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 49635ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 49645ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 49655ce59ae0SJoe Perches } 49665ce59ae0SJoe Perches 4967caf2a54fSJoe Perches# check for multiple semicolons 4968caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4969d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4970d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4971d5e616fcSJoe Perches $fix) { 4972194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 4973d5e616fcSJoe Perches } 4974d1e2ad07SJoe Perches } 4975d1e2ad07SJoe Perches 4976e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 4977c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4978c34c09a8SJoe Perches my $has_break = 0; 4979c34c09a8SJoe Perches my $has_statement = 0; 4980c34c09a8SJoe Perches my $count = 0; 4981c34c09a8SJoe Perches my $prevline = $linenr; 4982e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 4983c34c09a8SJoe Perches $prevline--; 4984c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4985c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4986c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4987c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4988c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4989c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4990c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4991c34c09a8SJoe Perches $has_statement = 1; 4992c34c09a8SJoe Perches $count++; 4993c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4994c34c09a8SJoe Perches } 4995c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4996c34c09a8SJoe Perches WARN("MISSING_BREAK", 4997c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4998c34c09a8SJoe Perches } 4999c34c09a8SJoe Perches } 5000c34c09a8SJoe Perches 5001d1e2ad07SJoe Perches# check for switch/default statements without a break; 5002d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5003d1e2ad07SJoe Perches defined $stat && 5004d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5005d1e2ad07SJoe Perches my $ctx = ''; 5006d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5007d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5008d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5009d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5010d1e2ad07SJoe Perches } 5011d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5012d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5013caf2a54fSJoe Perches } 5014caf2a54fSJoe Perches 501513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5016d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5017d5e616fcSJoe Perches if (WARN("USE_FUNC", 5018d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5019d5e616fcSJoe Perches $fix) { 5020194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5021d5e616fcSJoe Perches } 502213214adfSAndy Whitcroft } 5023773647a0SAndy Whitcroft 50242c92488aSJoe Perches# check for use of yield() 50252c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 50262c92488aSJoe Perches WARN("YIELD", 50272c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 50282c92488aSJoe Perches } 50292c92488aSJoe Perches 5030179f8f40SJoe Perches# check for comparisons against true and false 5031179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5032179f8f40SJoe Perches my $lead = $1; 5033179f8f40SJoe Perches my $arg = $2; 5034179f8f40SJoe Perches my $test = $3; 5035179f8f40SJoe Perches my $otype = $4; 5036179f8f40SJoe Perches my $trail = $5; 5037179f8f40SJoe Perches my $op = "!"; 5038179f8f40SJoe Perches 5039179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5040179f8f40SJoe Perches 5041179f8f40SJoe Perches my $type = lc($otype); 5042179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5043179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5044179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5045179f8f40SJoe Perches $op = ""; 5046179f8f40SJoe Perches } 5047179f8f40SJoe Perches 5048179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5049179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5050179f8f40SJoe Perches 5051179f8f40SJoe Perches## maybe suggesting a correct construct would better 5052179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5053179f8f40SJoe Perches 5054179f8f40SJoe Perches } 5055179f8f40SJoe Perches } 5056179f8f40SJoe Perches 50574882720bSThomas Gleixner# check for semaphores initialized locked 50584882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5059000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5060000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5061773647a0SAndy Whitcroft } 50626712d858SJoe Perches 506367d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 506467d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5065000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 506667d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5067773647a0SAndy Whitcroft } 50686712d858SJoe Perches 5069ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5070f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5071000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5072ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5073f3db6639SMichael Ellerman } 50746712d858SJoe Perches 507579404849SEmese Revfy# check for various ops structs, ensure they are const. 507679404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 507779404849SEmese Revfy address_space_operations| 507879404849SEmese Revfy backlight_ops| 507979404849SEmese Revfy block_device_operations| 508079404849SEmese Revfy dentry_operations| 508179404849SEmese Revfy dev_pm_ops| 508279404849SEmese Revfy dma_map_ops| 508379404849SEmese Revfy extent_io_ops| 508479404849SEmese Revfy file_lock_operations| 508579404849SEmese Revfy file_operations| 508679404849SEmese Revfy hv_ops| 508779404849SEmese Revfy ide_dma_ops| 508879404849SEmese Revfy intel_dvo_dev_ops| 508979404849SEmese Revfy item_operations| 509079404849SEmese Revfy iwl_ops| 509179404849SEmese Revfy kgdb_arch| 509279404849SEmese Revfy kgdb_io| 509379404849SEmese Revfy kset_uevent_ops| 509479404849SEmese Revfy lock_manager_operations| 509579404849SEmese Revfy microcode_ops| 509679404849SEmese Revfy mtrr_ops| 509779404849SEmese Revfy neigh_ops| 509879404849SEmese Revfy nlmsvc_binding| 509979404849SEmese Revfy pci_raw_ops| 510079404849SEmese Revfy pipe_buf_operations| 510179404849SEmese Revfy platform_hibernation_ops| 510279404849SEmese Revfy platform_suspend_ops| 510379404849SEmese Revfy proto_ops| 510479404849SEmese Revfy rpc_pipe_ops| 510579404849SEmese Revfy seq_operations| 510679404849SEmese Revfy snd_ac97_build_ops| 510779404849SEmese Revfy soc_pcmcia_socket_ops| 510879404849SEmese Revfy stacktrace_ops| 510979404849SEmese Revfy sysfs_ops| 511079404849SEmese Revfy tty_operations| 511179404849SEmese Revfy usb_mon_operations| 511279404849SEmese Revfy wd_ops}x; 51136903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 511479404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 5115000d1cc1SJoe Perches WARN("CONST_STRUCT", 5116000d1cc1SJoe Perches "struct $1 should normally be const\n" . 51176903ffb2SAndy Whitcroft $herecurr); 51182b6db5cbSAndy Whitcroft } 5119773647a0SAndy Whitcroft 5120773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5121773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5122773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5123c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5124c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5125171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5126171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5127171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5128773647a0SAndy Whitcroft { 5129000d1cc1SJoe Perches WARN("NR_CPUS", 5130000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5131773647a0SAndy Whitcroft } 51329c9ba34eSAndy Whitcroft 513352ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 513452ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 513552ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 513652ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 513752ea8506SJoe Perches } 513852ea8506SJoe Perches 51399c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 51409c9ba34eSAndy Whitcroft my $string; 51419c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 51429c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 51432a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 51449c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 5145000d1cc1SJoe Perches WARN("PRINTF_L", 5146000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 51479c9ba34eSAndy Whitcroft last; 51489c9ba34eSAndy Whitcroft } 51499c9ba34eSAndy Whitcroft } 5150691d77b6SAndy Whitcroft 5151691d77b6SAndy Whitcroft# whine mightly about in_atomic 5152691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5153691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5154000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5155000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5156f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5157000d1cc1SJoe Perches WARN("IN_ATOMIC", 5158000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5159691d77b6SAndy Whitcroft } 5160691d77b6SAndy Whitcroft } 51611704f47bSPeter Zijlstra 51621704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 51631704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 51641704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 51651704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 51661704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 51671704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5168000d1cc1SJoe Perches ERROR("LOCKDEP", 5169000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 51701704f47bSPeter Zijlstra } 51711704f47bSPeter Zijlstra } 517288f8831cSDave Jones 517388f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 517488f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 5175000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5176000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 517788f8831cSDave Jones } 51782435880fSJoe Perches 5179515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5180515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5181515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5182515a235eSJoe Perches $line =~ /$mode_perms_search/) { 51832435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 51842435880fSJoe Perches my $func = $entry->[0]; 51852435880fSJoe Perches my $arg_pos = $entry->[1]; 51862435880fSJoe Perches 51872435880fSJoe Perches my $skip_args = ""; 51882435880fSJoe Perches if ($arg_pos > 1) { 51892435880fSJoe Perches $arg_pos--; 51902435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 51912435880fSJoe Perches } 51922435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5193515a235eSJoe Perches if ($line =~ /$test/) { 51942435880fSJoe Perches my $val = $1; 51952435880fSJoe Perches $val = $6 if ($skip_args ne ""); 51962435880fSJoe Perches 51971727cc70SJoe Perches if ($val !~ /^0$/ && 51981727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 51991727cc70SJoe Perches length($val) ne 4)) { 52002435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 52011727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 52022435880fSJoe Perches } 52032435880fSJoe Perches } 52042435880fSJoe Perches } 520513214adfSAndy Whitcroft } 5206515a235eSJoe Perches } 520713214adfSAndy Whitcroft 520813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 520913214adfSAndy Whitcroft # so just keep quiet. 521013214adfSAndy Whitcroft if ($#rawlines == -1) { 521113214adfSAndy Whitcroft exit(0); 52120a920b5bSAndy Whitcroft } 52130a920b5bSAndy Whitcroft 52148905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 52158905a67cSAndy Whitcroft # things that appear to be patches. 52168905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 52178905a67cSAndy Whitcroft exit(0); 52188905a67cSAndy Whitcroft } 52198905a67cSAndy Whitcroft 52208905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 52218905a67cSAndy Whitcroft # just keep quiet. 52228905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 52238905a67cSAndy Whitcroft exit(0); 52248905a67cSAndy Whitcroft } 52258905a67cSAndy Whitcroft 52268905a67cSAndy Whitcroft if (!$is_patch) { 5227000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5228000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 52290a920b5bSAndy Whitcroft } 52300a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 5231000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5232000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 52330a920b5bSAndy Whitcroft } 52340a920b5bSAndy Whitcroft 5235f0a594c1SAndy Whitcroft print report_dump(); 523613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 523713214adfSAndy Whitcroft print "$filename " if ($summary_file); 52386c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 52396c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 52406c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 52418905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 52426c72ffaaSAndy Whitcroft } 52438905a67cSAndy Whitcroft 5244d2c0a235SAndy Whitcroft if ($quiet == 0) { 5245d1fe9c09SJoe Perches 5246d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 5247d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 5248d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 5249d1fe9c09SJoe Perches } 5250d1fe9c09SJoe Perches 5251d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5252d2c0a235SAndy Whitcroft # then suggest that. 5253d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5254d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 5255d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 5256b0781216SMike Frysinger $rpt_cleaners = 0; 5257d2c0a235SAndy Whitcroft } 5258d2c0a235SAndy Whitcroft } 5259d2c0a235SAndy Whitcroft 526091bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 526191bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5262000d1cc1SJoe Perches 5263d752fcc8SJoe Perches if ($clean == 0 && $fix && 5264d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5265d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 52669624b8d6SJoe Perches my $newfile = $filename; 52679624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 52683705ce5bSJoe Perches my $linecount = 0; 52693705ce5bSJoe Perches my $f; 52703705ce5bSJoe Perches 5271d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5272d752fcc8SJoe Perches 52733705ce5bSJoe Perches open($f, '>', $newfile) 52743705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 52753705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 52763705ce5bSJoe Perches $linecount++; 52773705ce5bSJoe Perches if ($file) { 52783705ce5bSJoe Perches if ($linecount > 3) { 52793705ce5bSJoe Perches $fixed_line =~ s/^\+//; 52803705ce5bSJoe Perches print $f $fixed_line . "\n"; 52813705ce5bSJoe Perches } 52823705ce5bSJoe Perches } else { 52833705ce5bSJoe Perches print $f $fixed_line . "\n"; 52843705ce5bSJoe Perches } 52853705ce5bSJoe Perches } 52863705ce5bSJoe Perches close($f); 52873705ce5bSJoe Perches 52883705ce5bSJoe Perches if (!$quiet) { 52893705ce5bSJoe Perches print << "EOM"; 52903705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 52913705ce5bSJoe Perches 52923705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 52933705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 52943705ce5bSJoe Perches 52953705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 52963705ce5bSJoe PerchesNo warranties, expressed or implied... 52973705ce5bSJoe Perches 52983705ce5bSJoe PerchesEOM 52993705ce5bSJoe Perches } 53003705ce5bSJoe Perches } 53013705ce5bSJoe Perches 53020a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 5303c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 53040a920b5bSAndy Whitcroft } 53050a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 5306000d1cc1SJoe Perches print << "EOM"; 5307000d1cc1SJoe Perches$vname has style problems, please review. 5308000d1cc1SJoe Perches 5309000d1cc1SJoe PerchesIf any of these errors are false positives, please report 5310000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 5311000d1cc1SJoe PerchesEOM 53120a920b5bSAndy Whitcroft } 531313214adfSAndy Whitcroft 53140a920b5bSAndy Whitcroft return $clean; 53150a920b5bSAndy Whitcroft} 5316