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"; 50ebfd7d62SJoe Perchesmy $codespell = 0; 51ebfd7d62SJoe Perchesmy $codespellfile = "/usr/local/share/codespell/dictionary.txt"; 5277f5b10aSHannes Eder 5377f5b10aSHannes Edersub help { 5477f5b10aSHannes Eder my ($exitcode) = @_; 5577f5b10aSHannes Eder 5677f5b10aSHannes Eder print << "EOM"; 5777f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5877f5b10aSHannes EderVersion: $V 5977f5b10aSHannes Eder 6077f5b10aSHannes EderOptions: 6177f5b10aSHannes Eder -q, --quiet quiet 6277f5b10aSHannes Eder --no-tree run without a kernel tree 6377f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 6477f5b10aSHannes Eder --patch treat FILE as patchfile (default) 6577f5b10aSHannes Eder --emacs emacs compile window format 6677f5b10aSHannes Eder --terse one line per report 6777f5b10aSHannes Eder -f, --file treat FILE as regular source file 6877f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6991bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 70000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 716cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 7256193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 73000d1cc1SJoe Perches --show-types show the message "types" in the output 7477f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 7577f5b10aSHannes Eder --no-summary suppress the per-file summary 7677f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 7777f5b10aSHannes Eder --summary-file include the filename in summary 7877f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7977f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 8077f5b10aSHannes Eder is all off) 8177f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 8277f5b10aSHannes Eder literally 833705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 843705ce5bSJoe Perches If correctable single-line errors exist, create 853705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 863705ce5bSJoe Perches with potential errors corrected to the preferred 873705ce5bSJoe Perches checkpatch style 889624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 899624b8d6SJoe Perches Is the same as --fix, but overwrites the input 909624b8d6SJoe Perches file. It's your fault if there's no backup or git 91d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 92d62a201fSDave Hansen runtime errors. 93ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 94ebfd7d62SJoe Perches (default:/usr/local/share/codespell/dictionary.txt) 95ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 9677f5b10aSHannes Eder -h, --help, --version display this help and exit 9777f5b10aSHannes Eder 9877f5b10aSHannes EderWhen FILE is - read standard input. 9977f5b10aSHannes EderEOM 10077f5b10aSHannes Eder 10177f5b10aSHannes Eder exit($exitcode); 10277f5b10aSHannes Eder} 10377f5b10aSHannes Eder 104000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 105000d1cc1SJoe Perchesif (-f $conf) { 106000d1cc1SJoe Perches my @conf_args; 107000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 108000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 109000d1cc1SJoe Perches 110000d1cc1SJoe Perches while (<$conffile>) { 111000d1cc1SJoe Perches my $line = $_; 112000d1cc1SJoe Perches 113000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 114000d1cc1SJoe Perches $line =~ s/^\s*//g; 115000d1cc1SJoe Perches $line =~ s/\s+/ /g; 116000d1cc1SJoe Perches 117000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 118000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 119000d1cc1SJoe Perches 120000d1cc1SJoe Perches my @words = split(" ", $line); 121000d1cc1SJoe Perches foreach my $word (@words) { 122000d1cc1SJoe Perches last if ($word =~ m/^#/); 123000d1cc1SJoe Perches push (@conf_args, $word); 124000d1cc1SJoe Perches } 125000d1cc1SJoe Perches } 126000d1cc1SJoe Perches close($conffile); 127000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 128000d1cc1SJoe Perches} 129000d1cc1SJoe Perches 1300a920b5bSAndy WhitcroftGetOptions( 1316c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1320a920b5bSAndy Whitcroft 'tree!' => \$tree, 1330a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1340a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1356c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1368905a67cSAndy Whitcroft 'terse!' => \$terse, 13777f5b10aSHannes Eder 'f|file!' => \$file, 1386c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1396c72ffaaSAndy Whitcroft 'strict!' => \$check, 140000d1cc1SJoe Perches 'ignore=s' => \@ignore, 14191bfe484SJoe Perches 'types=s' => \@use, 142000d1cc1SJoe Perches 'show-types!' => \$show_types, 1436cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 14456193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1456c72ffaaSAndy Whitcroft 'root=s' => \$root, 1468905a67cSAndy Whitcroft 'summary!' => \$summary, 1478905a67cSAndy Whitcroft 'mailback!' => \$mailback, 14813214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1493705ce5bSJoe Perches 'fix!' => \$fix, 1509624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 151d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 152c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 153773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 154ebfd7d62SJoe Perches 'codespell!' => \$codespell, 155ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 15677f5b10aSHannes Eder 'h|help' => \$help, 15777f5b10aSHannes Eder 'version' => \$help 15877f5b10aSHannes Eder) or help(1); 15977f5b10aSHannes Eder 16077f5b10aSHannes Ederhelp(0) if ($help); 1610a920b5bSAndy Whitcroft 1629624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1632ac73b4fSJoe Perches$check_orig = $check; 1649624b8d6SJoe Perches 1650a920b5bSAndy Whitcroftmy $exit = 0; 1660a920b5bSAndy Whitcroft 167d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 168d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 169d62a201fSDave Hansen if (!$ignore_perl_version) { 170d62a201fSDave Hansen exit(1); 171d62a201fSDave Hansen } 172d62a201fSDave Hansen} 173d62a201fSDave Hansen 1740a920b5bSAndy Whitcroftif ($#ARGV < 0) { 17577f5b10aSHannes Eder print "$P: no input files\n"; 1760a920b5bSAndy Whitcroft exit(1); 1770a920b5bSAndy Whitcroft} 1780a920b5bSAndy Whitcroft 17991bfe484SJoe Perchessub hash_save_array_words { 18091bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 18191bfe484SJoe Perches 18291bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 18391bfe484SJoe Perches foreach my $word (@array) { 184000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 185000d1cc1SJoe Perches $word =~ s/^\s*//g; 186000d1cc1SJoe Perches $word =~ s/\s+/ /g; 187000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 188000d1cc1SJoe Perches 189000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 190000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 191000d1cc1SJoe Perches 19291bfe484SJoe Perches $hashRef->{$word}++; 193000d1cc1SJoe Perches } 19491bfe484SJoe Perches} 19591bfe484SJoe Perches 19691bfe484SJoe Perchessub hash_show_words { 19791bfe484SJoe Perches my ($hashRef, $prefix) = @_; 19891bfe484SJoe Perches 19958cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 20091bfe484SJoe Perches print "NOTE: $prefix message types:"; 20158cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 20291bfe484SJoe Perches print " $word"; 20391bfe484SJoe Perches } 20491bfe484SJoe Perches print "\n\n"; 20591bfe484SJoe Perches } 20691bfe484SJoe Perches} 20791bfe484SJoe Perches 20891bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 20991bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 210000d1cc1SJoe Perches 211c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 212c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2137429c690SAndy Whitcroftmy $dbg_type = 0; 214a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 215c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 21621caa13cSAndy Whitcroft ## no critic 21721caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 21821caa13cSAndy Whitcroft die "$@" if ($@); 219c2fdda0dSAndy Whitcroft} 220c2fdda0dSAndy Whitcroft 221d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 222d2c0a235SAndy Whitcroft 2238905a67cSAndy Whitcroftif ($terse) { 2248905a67cSAndy Whitcroft $emacs = 1; 2258905a67cSAndy Whitcroft $quiet++; 2268905a67cSAndy Whitcroft} 2278905a67cSAndy Whitcroft 2286c72ffaaSAndy Whitcroftif ($tree) { 2296c72ffaaSAndy Whitcroft if (defined $root) { 2306c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2316c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2326c72ffaaSAndy Whitcroft } 2336c72ffaaSAndy Whitcroft } else { 2346c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2356c72ffaaSAndy Whitcroft $root = '.'; 2366c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2376c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2386c72ffaaSAndy Whitcroft $root = $1; 2396c72ffaaSAndy Whitcroft } 2406c72ffaaSAndy Whitcroft } 2416c72ffaaSAndy Whitcroft 2426c72ffaaSAndy Whitcroft if (!defined $root) { 2430a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2440a920b5bSAndy Whitcroft exit(2); 2450a920b5bSAndy Whitcroft } 2466c72ffaaSAndy Whitcroft} 2476c72ffaaSAndy Whitcroft 2486c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2496c72ffaaSAndy Whitcroft 2502ceb532bSAndy Whitcroftour $Ident = qr{ 2512ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2522ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2532ceb532bSAndy Whitcroft }x; 2546c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2556c72ffaaSAndy Whitcroftour $Sparse = qr{ 2566c72ffaaSAndy Whitcroft __user| 2576c72ffaaSAndy Whitcroft __kernel| 2586c72ffaaSAndy Whitcroft __force| 2596c72ffaaSAndy Whitcroft __iomem| 2606c72ffaaSAndy Whitcroft __must_check| 2616c72ffaaSAndy Whitcroft __init_refok| 262417495edSAndy Whitcroft __kprobes| 263165e72a6SSven Eckelmann __ref| 264165e72a6SSven Eckelmann __rcu 2656c72ffaaSAndy Whitcroft }x; 266e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 267e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 268e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 269e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 270e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2718716de38SJoe Perches 27252131292SWolfram Sang# Notes to $Attribute: 27352131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2746c72ffaaSAndy Whitcroftour $Attribute = qr{ 2756c72ffaaSAndy Whitcroft const| 27603f1df7dSJoe Perches __percpu| 27703f1df7dSJoe Perches __nocast| 27803f1df7dSJoe Perches __safe| 27903f1df7dSJoe Perches __bitwise__| 28003f1df7dSJoe Perches __packed__| 28103f1df7dSJoe Perches __packed2__| 28203f1df7dSJoe Perches __naked| 28303f1df7dSJoe Perches __maybe_unused| 28403f1df7dSJoe Perches __always_unused| 28503f1df7dSJoe Perches __noreturn| 28603f1df7dSJoe Perches __used| 28703f1df7dSJoe Perches __cold| 288e23ef1f3SJoe Perches __pure| 28903f1df7dSJoe Perches __noclone| 29003f1df7dSJoe Perches __deprecated| 2916c72ffaaSAndy Whitcroft __read_mostly| 2926c72ffaaSAndy Whitcroft __kprobes| 2938716de38SJoe Perches $InitAttribute| 29424e1d81aSAndy Whitcroft ____cacheline_aligned| 29524e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2965fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2975fe3af11SAndy Whitcroft __weak 2986c72ffaaSAndy Whitcroft }x; 299c45dcabdSAndy Whitcroftour $Modifier; 30091cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3016c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3026c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3036c72ffaaSAndy Whitcroft 30495e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 30595e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 30695e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 30795e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3082435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 309c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 310326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 311326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 312326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 31374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3142435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 315326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 316447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 31723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3186c72ffaaSAndy Whitcroftour $Operators = qr{ 3196c72ffaaSAndy Whitcroft <=|>=|==|!=| 3206c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 32123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3226c72ffaaSAndy Whitcroft }x; 3236c72ffaaSAndy Whitcroft 32491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 32591cb5195SJoe Perches 326ab7e23f3SJoe Perchesour $BasicType; 3278905a67cSAndy Whitcroftour $NonptrType; 3281813087dSJoe Perchesour $NonptrTypeMisordered; 3298716de38SJoe Perchesour $NonptrTypeWithAttr; 3308905a67cSAndy Whitcroftour $Type; 3311813087dSJoe Perchesour $TypeMisordered; 3328905a67cSAndy Whitcroftour $Declare; 3331813087dSJoe Perchesour $DeclareMisordered; 3348905a67cSAndy Whitcroft 33515662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 33615662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 337171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 338171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 339171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 340171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 341171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 342171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 343171ae1a4SAndy Whitcroft}x; 344171ae1a4SAndy Whitcroft 34515662b3eSJoe Perchesour $UTF8 = qr{ 34615662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 34715662b3eSJoe Perches | $NON_ASCII_UTF8 34815662b3eSJoe Perches}x; 34915662b3eSJoe Perches 350*e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 351021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 352021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 353021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 354021158b4SJoe Perches)}; 355*e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 356fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3578ed22cadSAndy Whitcroft atomic_t 3588ed22cadSAndy Whitcroft)}; 359*e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 360*e6176fa4SJoe Perches $typeC99Typedefs\b| 361*e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 362*e6176fa4SJoe Perches $typeKernelTypedefs\b 363*e6176fa4SJoe Perches)}; 3648ed22cadSAndy Whitcroft 365691e669bSJoe Perchesour $logFunctions = qr{(?x: 3666e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3677d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3686e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 369b0531722SJoe Perches panic| 37006668727SJoe Perches MODULE_[A-Z_]+| 37106668727SJoe Perches seq_vprintf|seq_printf|seq_puts 372691e669bSJoe Perches)}; 373691e669bSJoe Perches 37420112475SJoe Perchesour $signature_tags = qr{(?xi: 37520112475SJoe Perches Signed-off-by:| 37620112475SJoe Perches Acked-by:| 37720112475SJoe Perches Tested-by:| 37820112475SJoe Perches Reviewed-by:| 37920112475SJoe Perches Reported-by:| 3808543ae12SMugunthan V N Suggested-by:| 38120112475SJoe Perches To:| 38220112475SJoe Perches Cc: 38320112475SJoe Perches)}; 38420112475SJoe Perches 3851813087dSJoe Perchesour @typeListMisordered = ( 3861813087dSJoe Perches qr{char\s+(?:un)?signed}, 3871813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3881813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 3891813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 3901813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 3911813087dSJoe Perches qr{short\s+(?:un)?signed}, 3921813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 3931813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 3941813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 3951813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 3961813087dSJoe Perches qr{int\s+(?:un)?signed}, 3971813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 3981813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 3991813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4001813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4011813087dSJoe Perches qr{long\s+(?:un)?signed}, 4021813087dSJoe Perches); 4031813087dSJoe Perches 4048905a67cSAndy Whitcroftour @typeList = ( 4058905a67cSAndy Whitcroft qr{void}, 4060c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4070c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4080c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4090c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4100c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4110c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4120c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4130c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4140c773d9dSJoe Perches qr{(?:un)?signed}, 4158905a67cSAndy Whitcroft qr{float}, 4168905a67cSAndy Whitcroft qr{double}, 4178905a67cSAndy Whitcroft qr{bool}, 4188905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4198905a67cSAndy Whitcroft qr{union\s+$Ident}, 4208905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4218905a67cSAndy Whitcroft qr{${Ident}_t}, 4228905a67cSAndy Whitcroft qr{${Ident}_handler}, 4238905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4241813087dSJoe Perches @typeListMisordered, 4258905a67cSAndy Whitcroft); 4268716de38SJoe Perchesour @typeListWithAttr = ( 4278716de38SJoe Perches @typeList, 4288716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4298716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4308716de38SJoe Perches); 4318716de38SJoe Perches 432c45dcabdSAndy Whitcroftour @modifierList = ( 433c45dcabdSAndy Whitcroft qr{fastcall}, 434c45dcabdSAndy Whitcroft); 4358905a67cSAndy Whitcroft 4362435880fSJoe Perchesour @mode_permission_funcs = ( 4372435880fSJoe Perches ["module_param", 3], 4382435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4392435880fSJoe Perches ["module_param_array_named", 5], 4402435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4412435880fSJoe Perches ["proc_create(?:_data|)", 2], 4422435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4432435880fSJoe Perches); 4442435880fSJoe Perches 445515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 446515a235eSJoe Perchesour $mode_perms_search = ""; 447515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 448515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 449515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 450515a235eSJoe Perches} 451515a235eSJoe Perches 452b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 453b392c64fSJoe Perches S_IWUGO | 454b392c64fSJoe Perches S_IWOTH | 455b392c64fSJoe Perches S_IRWXUGO | 456b392c64fSJoe Perches S_IALLUGO | 457b392c64fSJoe Perches 0[0-7][0-7][2367] 458b392c64fSJoe Perches}x; 459b392c64fSJoe Perches 4607840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4617840a94cSWolfram Sang irq| 462cdcee686SSergey Ryazanov memory| 463cdcee686SSergey Ryazanov time| 464cdcee686SSergey Ryazanov reboot 4657840a94cSWolfram Sang)}; 4667840a94cSWolfram Sang# memory.h: ARM has a custom one 4677840a94cSWolfram Sang 46866b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 46966b47b4aSKees Cookmy $misspellings; 47066b47b4aSKees Cookmy %spelling_fix; 47136061e38SJoe Perches 47236061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 47366b47b4aSKees Cook while (<$spelling>) { 47466b47b4aSKees Cook my $line = $_; 47566b47b4aSKees Cook 47666b47b4aSKees Cook $line =~ s/\s*\n?$//g; 47766b47b4aSKees Cook $line =~ s/^\s*//g; 47866b47b4aSKees Cook 47966b47b4aSKees Cook next if ($line =~ m/^\s*#/); 48066b47b4aSKees Cook next if ($line =~ m/^\s*$/); 48166b47b4aSKees Cook 48266b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 48366b47b4aSKees Cook 48466b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 48566b47b4aSKees Cook } 48666b47b4aSKees Cook close($spelling); 48736061e38SJoe Perches} else { 48836061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 48936061e38SJoe Perches} 49066b47b4aSKees Cook 491ebfd7d62SJoe Perchesif ($codespell) { 492ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 493ebfd7d62SJoe Perches while (<$spelling>) { 494ebfd7d62SJoe Perches my $line = $_; 495ebfd7d62SJoe Perches 496ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 497ebfd7d62SJoe Perches $line =~ s/^\s*//g; 498ebfd7d62SJoe Perches 499ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 500ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 501ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 502ebfd7d62SJoe Perches 503ebfd7d62SJoe Perches $line =~ s/,.*$//; 504ebfd7d62SJoe Perches 505ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 506ebfd7d62SJoe Perches 507ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 508ebfd7d62SJoe Perches } 509ebfd7d62SJoe Perches close($spelling); 510ebfd7d62SJoe Perches } else { 511ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 512ebfd7d62SJoe Perches } 513ebfd7d62SJoe Perches} 514ebfd7d62SJoe Perches 515ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 516ebfd7d62SJoe Perches 5178905a67cSAndy Whitcroftsub build_types { 518d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 519d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 5201813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5218716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 522c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 523ab7e23f3SJoe Perches $BasicType = qr{ 524ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 525ab7e23f3SJoe Perches (?:${all}\b) 526ab7e23f3SJoe Perches }x; 5278905a67cSAndy Whitcroft $NonptrType = qr{ 528d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 529cf655043SAndy Whitcroft (?: 5306b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 5318ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 532c45dcabdSAndy Whitcroft (?:${all}\b) 533cf655043SAndy Whitcroft ) 534c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5358905a67cSAndy Whitcroft }x; 5361813087dSJoe Perches $NonptrTypeMisordered = qr{ 5371813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5381813087dSJoe Perches (?: 5391813087dSJoe Perches (?:${Misordered}\b) 5401813087dSJoe Perches ) 5411813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5421813087dSJoe Perches }x; 5438716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5448716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5458716de38SJoe Perches (?: 5468716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5478716de38SJoe Perches (?:$typeTypedefs\b)| 5488716de38SJoe Perches (?:${allWithAttr}\b) 5498716de38SJoe Perches ) 5508716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5518716de38SJoe Perches }x; 5528905a67cSAndy Whitcroft $Type = qr{ 553c45dcabdSAndy Whitcroft $NonptrType 5541574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 555c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5568905a67cSAndy Whitcroft }x; 5571813087dSJoe Perches $TypeMisordered = qr{ 5581813087dSJoe Perches $NonptrTypeMisordered 5591813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5601813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5611813087dSJoe Perches }x; 56291cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5631813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5648905a67cSAndy Whitcroft} 5658905a67cSAndy Whitcroftbuild_types(); 5666c72ffaaSAndy Whitcroft 5677d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 568d1fe9c09SJoe Perches 569d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 570d1fe9c09SJoe Perches# requires at least perl version v5.10.0 571d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 572d1fe9c09SJoe Perches 573d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5742435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 575c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 5767d2367afSJoe Perches 577f8422308SJoe Perchesour $declaration_macros = qr{(?x: 578f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 579f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 580f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 581f8422308SJoe Perches)}; 582f8422308SJoe Perches 5837d2367afSJoe Perchessub deparenthesize { 5847d2367afSJoe Perches my ($string) = @_; 5857d2367afSJoe Perches return "" if (!defined($string)); 5865b9553abSJoe Perches 5875b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5885b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5895b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5905b9553abSJoe Perches } 5915b9553abSJoe Perches 5927d2367afSJoe Perches $string =~ s@\s+@ @g; 5935b9553abSJoe Perches 5947d2367afSJoe Perches return $string; 5957d2367afSJoe Perches} 5967d2367afSJoe Perches 5973445686aSJoe Perchessub seed_camelcase_file { 5983445686aSJoe Perches my ($file) = @_; 5993445686aSJoe Perches 6003445686aSJoe Perches return if (!(-f $file)); 6013445686aSJoe Perches 6023445686aSJoe Perches local $/; 6033445686aSJoe Perches 6043445686aSJoe Perches open(my $include_file, '<', "$file") 6053445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6063445686aSJoe Perches my $text = <$include_file>; 6073445686aSJoe Perches close($include_file); 6083445686aSJoe Perches 6093445686aSJoe Perches my @lines = split('\n', $text); 6103445686aSJoe Perches 6113445686aSJoe Perches foreach my $line (@lines) { 6123445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6133445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6143445686aSJoe Perches $camelcase{$1} = 1; 61511ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 61611ea516aSJoe Perches $camelcase{$1} = 1; 61711ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6183445686aSJoe Perches $camelcase{$1} = 1; 6193445686aSJoe Perches } 6203445686aSJoe Perches } 6213445686aSJoe Perches} 6223445686aSJoe Perches 6233445686aSJoe Perchesmy $camelcase_seeded = 0; 6243445686aSJoe Perchessub seed_camelcase_includes { 6253445686aSJoe Perches return if ($camelcase_seeded); 6263445686aSJoe Perches 6273445686aSJoe Perches my $files; 628c707a81dSJoe Perches my $camelcase_cache = ""; 629c707a81dSJoe Perches my @include_files = (); 630c707a81dSJoe Perches 631c707a81dSJoe Perches $camelcase_seeded = 1; 632351b2a1fSJoe Perches 6333645e328SRichard Genoud if (-e ".git") { 634351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 635351b2a1fSJoe Perches chomp $git_last_include_commit; 636c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 637c707a81dSJoe Perches } else { 638c707a81dSJoe Perches my $last_mod_date = 0; 639c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 640c707a81dSJoe Perches @include_files = split('\n', $files); 641c707a81dSJoe Perches foreach my $file (@include_files) { 642c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 643c707a81dSJoe Perches localtime((stat $file)[9])); 644c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 645c707a81dSJoe Perches } 646c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 647c707a81dSJoe Perches } 648c707a81dSJoe Perches 649c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 650c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 651c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 652351b2a1fSJoe Perches while (<$camelcase_file>) { 653351b2a1fSJoe Perches chomp; 654351b2a1fSJoe Perches $camelcase{$_} = 1; 655351b2a1fSJoe Perches } 656351b2a1fSJoe Perches close($camelcase_file); 657351b2a1fSJoe Perches 658351b2a1fSJoe Perches return; 659351b2a1fSJoe Perches } 660c707a81dSJoe Perches 6613645e328SRichard Genoud if (-e ".git") { 662c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 663c707a81dSJoe Perches @include_files = split('\n', $files); 6643445686aSJoe Perches } 665c707a81dSJoe Perches 6663445686aSJoe Perches foreach my $file (@include_files) { 6673445686aSJoe Perches seed_camelcase_file($file); 6683445686aSJoe Perches } 669351b2a1fSJoe Perches 670c707a81dSJoe Perches if ($camelcase_cache ne "") { 671351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 672c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 673c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 674351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 675351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 676351b2a1fSJoe Perches } 677351b2a1fSJoe Perches close($camelcase_file); 678351b2a1fSJoe Perches } 6793445686aSJoe Perches} 6803445686aSJoe Perches 681d311cd44SJoe Perchessub git_commit_info { 682d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 683d311cd44SJoe Perches 684d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 685d311cd44SJoe Perches 686d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 687d311cd44SJoe Perches $output =~ s/^\s*//gm; 688d311cd44SJoe Perches my @lines = split("\n", $output); 689d311cd44SJoe Perches 6900d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 6910d7835fcSJoe Perches 692d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 693d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 694d311cd44SJoe Perches# all matching commit ids, but it's very slow... 695d311cd44SJoe Perches# 696d311cd44SJoe Perches# echo "checking commits $1..." 697d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 698d311cd44SJoe Perches# while read line ; do 699d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 700d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 701d311cd44SJoe Perches# done 702d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 703d311cd44SJoe Perches } else { 704d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 705d311cd44SJoe Perches $desc = substr($lines[0], 41); 706d311cd44SJoe Perches } 707d311cd44SJoe Perches 708d311cd44SJoe Perches return ($id, $desc); 709d311cd44SJoe Perches} 710d311cd44SJoe Perches 7116c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7120a920b5bSAndy Whitcroft 71300df344fSAndy Whitcroftmy @rawlines = (); 714c2fdda0dSAndy Whitcroftmy @lines = (); 7153705ce5bSJoe Perchesmy @fixed = (); 716d752fcc8SJoe Perchesmy @fixed_inserted = (); 717d752fcc8SJoe Perchesmy @fixed_deleted = (); 718194f66fcSJoe Perchesmy $fixlinenr = -1; 719194f66fcSJoe Perches 720c2fdda0dSAndy Whitcroftmy $vname; 7216c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 72221caa13cSAndy Whitcroft my $FILE; 7236c72ffaaSAndy Whitcroft if ($file) { 72421caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7256c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 72621caa13cSAndy Whitcroft } elsif ($filename eq '-') { 72721caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7286c72ffaaSAndy Whitcroft } else { 72921caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7306c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7316c72ffaaSAndy Whitcroft } 732c2fdda0dSAndy Whitcroft if ($filename eq '-') { 733c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 734c2fdda0dSAndy Whitcroft } else { 735c2fdda0dSAndy Whitcroft $vname = $filename; 736c2fdda0dSAndy Whitcroft } 73721caa13cSAndy Whitcroft while (<$FILE>) { 7380a920b5bSAndy Whitcroft chomp; 73900df344fSAndy Whitcroft push(@rawlines, $_); 7406c72ffaaSAndy Whitcroft } 74121caa13cSAndy Whitcroft close($FILE); 742c2fdda0dSAndy Whitcroft if (!process($filename)) { 7430a920b5bSAndy Whitcroft $exit = 1; 7440a920b5bSAndy Whitcroft } 74500df344fSAndy Whitcroft @rawlines = (); 74613214adfSAndy Whitcroft @lines = (); 7473705ce5bSJoe Perches @fixed = (); 748d752fcc8SJoe Perches @fixed_inserted = (); 749d752fcc8SJoe Perches @fixed_deleted = (); 750194f66fcSJoe Perches $fixlinenr = -1; 7510a920b5bSAndy Whitcroft} 7520a920b5bSAndy Whitcroft 7530a920b5bSAndy Whitcroftexit($exit); 7540a920b5bSAndy Whitcroft 7550a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7566c72ffaaSAndy Whitcroft my ($root) = @_; 7576c72ffaaSAndy Whitcroft 7586c72ffaaSAndy Whitcroft my @tree_check = ( 7596c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7606c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 7616c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 7626c72ffaaSAndy Whitcroft ); 7636c72ffaaSAndy Whitcroft 7646c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 7656c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 7660a920b5bSAndy Whitcroft return 0; 7670a920b5bSAndy Whitcroft } 7686c72ffaaSAndy Whitcroft } 7696c72ffaaSAndy Whitcroft return 1; 7706c72ffaaSAndy Whitcroft} 7710a920b5bSAndy Whitcroft 77220112475SJoe Perchessub parse_email { 77320112475SJoe Perches my ($formatted_email) = @_; 77420112475SJoe Perches 77520112475SJoe Perches my $name = ""; 77620112475SJoe Perches my $address = ""; 77720112475SJoe Perches my $comment = ""; 77820112475SJoe Perches 77920112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 78020112475SJoe Perches $name = $1; 78120112475SJoe Perches $address = $2; 78220112475SJoe Perches $comment = $3 if defined $3; 78320112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 78420112475SJoe Perches $address = $1; 78520112475SJoe Perches $comment = $2 if defined $2; 78620112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 78720112475SJoe Perches $address = $1; 78820112475SJoe Perches $comment = $2 if defined $2; 78920112475SJoe Perches $formatted_email =~ s/$address.*$//; 79020112475SJoe Perches $name = $formatted_email; 7913705ce5bSJoe Perches $name = trim($name); 79220112475SJoe Perches $name =~ s/^\"|\"$//g; 79320112475SJoe Perches # If there's a name left after stripping spaces and 79420112475SJoe Perches # leading quotes, and the address doesn't have both 79520112475SJoe Perches # leading and trailing angle brackets, the address 79620112475SJoe Perches # is invalid. ie: 79720112475SJoe Perches # "joe smith [email protected]" bad 79820112475SJoe Perches # "joe smith <[email protected]" bad 79920112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 80020112475SJoe Perches $name = ""; 80120112475SJoe Perches $address = ""; 80220112475SJoe Perches $comment = ""; 80320112475SJoe Perches } 80420112475SJoe Perches } 80520112475SJoe Perches 8063705ce5bSJoe Perches $name = trim($name); 80720112475SJoe Perches $name =~ s/^\"|\"$//g; 8083705ce5bSJoe Perches $address = trim($address); 80920112475SJoe Perches $address =~ s/^\<|\>$//g; 81020112475SJoe Perches 81120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 81220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 81320112475SJoe Perches $name = "\"$name\""; 81420112475SJoe Perches } 81520112475SJoe Perches 81620112475SJoe Perches return ($name, $address, $comment); 81720112475SJoe Perches} 81820112475SJoe Perches 81920112475SJoe Perchessub format_email { 82020112475SJoe Perches my ($name, $address) = @_; 82120112475SJoe Perches 82220112475SJoe Perches my $formatted_email; 82320112475SJoe Perches 8243705ce5bSJoe Perches $name = trim($name); 82520112475SJoe Perches $name =~ s/^\"|\"$//g; 8263705ce5bSJoe Perches $address = trim($address); 82720112475SJoe Perches 82820112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 82920112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 83020112475SJoe Perches $name = "\"$name\""; 83120112475SJoe Perches } 83220112475SJoe Perches 83320112475SJoe Perches if ("$name" eq "") { 83420112475SJoe Perches $formatted_email = "$address"; 83520112475SJoe Perches } else { 83620112475SJoe Perches $formatted_email = "$name <$address>"; 83720112475SJoe Perches } 83820112475SJoe Perches 83920112475SJoe Perches return $formatted_email; 84020112475SJoe Perches} 84120112475SJoe Perches 842d311cd44SJoe Perchessub which { 843d311cd44SJoe Perches my ($bin) = @_; 844d311cd44SJoe Perches 845d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 846d311cd44SJoe Perches if (-e "$path/$bin") { 847d311cd44SJoe Perches return "$path/$bin"; 848d311cd44SJoe Perches } 849d311cd44SJoe Perches } 850d311cd44SJoe Perches 851d311cd44SJoe Perches return ""; 852d311cd44SJoe Perches} 853d311cd44SJoe Perches 854000d1cc1SJoe Perchessub which_conf { 855000d1cc1SJoe Perches my ($conf) = @_; 856000d1cc1SJoe Perches 857000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 858000d1cc1SJoe Perches if (-e "$path/$conf") { 859000d1cc1SJoe Perches return "$path/$conf"; 860000d1cc1SJoe Perches } 861000d1cc1SJoe Perches } 862000d1cc1SJoe Perches 863000d1cc1SJoe Perches return ""; 864000d1cc1SJoe Perches} 865000d1cc1SJoe Perches 8660a920b5bSAndy Whitcroftsub expand_tabs { 8670a920b5bSAndy Whitcroft my ($str) = @_; 8680a920b5bSAndy Whitcroft 8690a920b5bSAndy Whitcroft my $res = ''; 8700a920b5bSAndy Whitcroft my $n = 0; 8710a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 8720a920b5bSAndy Whitcroft if ($c eq "\t") { 8730a920b5bSAndy Whitcroft $res .= ' '; 8740a920b5bSAndy Whitcroft $n++; 8750a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 8760a920b5bSAndy Whitcroft $res .= ' '; 8770a920b5bSAndy Whitcroft } 8780a920b5bSAndy Whitcroft next; 8790a920b5bSAndy Whitcroft } 8800a920b5bSAndy Whitcroft $res .= $c; 8810a920b5bSAndy Whitcroft $n++; 8820a920b5bSAndy Whitcroft } 8830a920b5bSAndy Whitcroft 8840a920b5bSAndy Whitcroft return $res; 8850a920b5bSAndy Whitcroft} 8866c72ffaaSAndy Whitcroftsub copy_spacing { 887773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 8886c72ffaaSAndy Whitcroft return $res; 8896c72ffaaSAndy Whitcroft} 8900a920b5bSAndy Whitcroft 8914a0df2efSAndy Whitcroftsub line_stats { 8924a0df2efSAndy Whitcroft my ($line) = @_; 8934a0df2efSAndy Whitcroft 8944a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 8954a0df2efSAndy Whitcroft $line =~ s/^.//; 8964a0df2efSAndy Whitcroft $line = expand_tabs($line); 8974a0df2efSAndy Whitcroft 8984a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 8994a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9004a0df2efSAndy Whitcroft 9014a0df2efSAndy Whitcroft return (length($line), length($white)); 9024a0df2efSAndy Whitcroft} 9034a0df2efSAndy Whitcroft 904773647a0SAndy Whitcroftmy $sanitise_quote = ''; 905773647a0SAndy Whitcroft 906773647a0SAndy Whitcroftsub sanitise_line_reset { 907773647a0SAndy Whitcroft my ($in_comment) = @_; 908773647a0SAndy Whitcroft 909773647a0SAndy Whitcroft if ($in_comment) { 910773647a0SAndy Whitcroft $sanitise_quote = '*/'; 911773647a0SAndy Whitcroft } else { 912773647a0SAndy Whitcroft $sanitise_quote = ''; 913773647a0SAndy Whitcroft } 914773647a0SAndy Whitcroft} 91500df344fSAndy Whitcroftsub sanitise_line { 91600df344fSAndy Whitcroft my ($line) = @_; 91700df344fSAndy Whitcroft 91800df344fSAndy Whitcroft my $res = ''; 91900df344fSAndy Whitcroft my $l = ''; 92000df344fSAndy Whitcroft 921c2fdda0dSAndy Whitcroft my $qlen = 0; 922773647a0SAndy Whitcroft my $off = 0; 923773647a0SAndy Whitcroft my $c; 92400df344fSAndy Whitcroft 925773647a0SAndy Whitcroft # Always copy over the diff marker. 926773647a0SAndy Whitcroft $res = substr($line, 0, 1); 927773647a0SAndy Whitcroft 928773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 929773647a0SAndy Whitcroft $c = substr($line, $off, 1); 930773647a0SAndy Whitcroft 931773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 932773647a0SAndy Whitcroft # and end, all to $;. 933773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 934773647a0SAndy Whitcroft $sanitise_quote = '*/'; 935773647a0SAndy Whitcroft 936773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 937773647a0SAndy Whitcroft $off++; 93800df344fSAndy Whitcroft next; 939773647a0SAndy Whitcroft } 94081bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 941773647a0SAndy Whitcroft $sanitise_quote = ''; 942773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 943773647a0SAndy Whitcroft $off++; 944773647a0SAndy Whitcroft next; 945773647a0SAndy Whitcroft } 946113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 947113f04a8SDaniel Walker $sanitise_quote = '//'; 948113f04a8SDaniel Walker 949113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 950113f04a8SDaniel Walker $off++; 951113f04a8SDaniel Walker next; 952113f04a8SDaniel Walker } 953773647a0SAndy Whitcroft 954773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 955773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 956773647a0SAndy Whitcroft $c eq "\\") { 957773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 958773647a0SAndy Whitcroft $off++; 959773647a0SAndy Whitcroft next; 960773647a0SAndy Whitcroft } 961773647a0SAndy Whitcroft # Regular quotes. 962773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 963773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 964773647a0SAndy Whitcroft $sanitise_quote = $c; 965773647a0SAndy Whitcroft 966773647a0SAndy Whitcroft substr($res, $off, 1, $c); 967773647a0SAndy Whitcroft next; 968773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 969773647a0SAndy Whitcroft $sanitise_quote = ''; 97000df344fSAndy Whitcroft } 97100df344fSAndy Whitcroft } 972773647a0SAndy Whitcroft 973fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 974773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 975773647a0SAndy Whitcroft substr($res, $off, 1, $;); 976113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 977113f04a8SDaniel Walker substr($res, $off, 1, $;); 978773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 979773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 98000df344fSAndy Whitcroft } else { 981773647a0SAndy Whitcroft substr($res, $off, 1, $c); 98200df344fSAndy Whitcroft } 983c2fdda0dSAndy Whitcroft } 984c2fdda0dSAndy Whitcroft 985113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 986113f04a8SDaniel Walker $sanitise_quote = ''; 987113f04a8SDaniel Walker } 988113f04a8SDaniel Walker 989c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 990c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 991c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 992c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 993c2fdda0dSAndy Whitcroft 994c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 995c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 996c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 997c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 998c2fdda0dSAndy Whitcroft } 999c2fdda0dSAndy Whitcroft 100000df344fSAndy Whitcroft return $res; 100100df344fSAndy Whitcroft} 100200df344fSAndy Whitcroft 1003a6962d72SJoe Perchessub get_quoted_string { 1004a6962d72SJoe Perches my ($line, $rawline) = @_; 1005a6962d72SJoe Perches 10065e4f6ba5SJoe Perches return "" if ($line !~ m/(\"[X\t]+\")/g); 1007a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1008a6962d72SJoe Perches} 1009a6962d72SJoe Perches 10108905a67cSAndy Whitcroftsub ctx_statement_block { 10118905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10128905a67cSAndy Whitcroft my $line = $linenr - 1; 10138905a67cSAndy Whitcroft my $blk = ''; 10148905a67cSAndy Whitcroft my $soff = $off; 10158905a67cSAndy Whitcroft my $coff = $off - 1; 1016773647a0SAndy Whitcroft my $coff_set = 0; 10178905a67cSAndy Whitcroft 101813214adfSAndy Whitcroft my $loff = 0; 101913214adfSAndy Whitcroft 10208905a67cSAndy Whitcroft my $type = ''; 10218905a67cSAndy Whitcroft my $level = 0; 1022a2750645SAndy Whitcroft my @stack = (); 1023cf655043SAndy Whitcroft my $p; 10248905a67cSAndy Whitcroft my $c; 10258905a67cSAndy Whitcroft my $len = 0; 102613214adfSAndy Whitcroft 102713214adfSAndy Whitcroft my $remainder; 10288905a67cSAndy Whitcroft while (1) { 1029a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1030a2750645SAndy Whitcroft 1031773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10328905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10338905a67cSAndy Whitcroft # context. 10348905a67cSAndy Whitcroft if ($off >= $len) { 10358905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1036dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1037c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10388905a67cSAndy Whitcroft $remain--; 103913214adfSAndy Whitcroft $loff = $len; 1040c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10418905a67cSAndy Whitcroft $len = length($blk); 10428905a67cSAndy Whitcroft $line++; 10438905a67cSAndy Whitcroft last; 10448905a67cSAndy Whitcroft } 10458905a67cSAndy Whitcroft # Bail if there is no further context. 10468905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 104713214adfSAndy Whitcroft if ($off >= $len) { 10488905a67cSAndy Whitcroft last; 10498905a67cSAndy Whitcroft } 1050f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1051f74bd194SAndy Whitcroft $level++; 1052f74bd194SAndy Whitcroft $type = '#'; 1053f74bd194SAndy Whitcroft } 10548905a67cSAndy Whitcroft } 1055cf655043SAndy Whitcroft $p = $c; 10568905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 105713214adfSAndy Whitcroft $remainder = substr($blk, $off); 10588905a67cSAndy Whitcroft 1059773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10604635f4fbSAndy Whitcroft 10614635f4fbSAndy Whitcroft # Handle nested #if/#else. 10624635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 10634635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 10644635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 10654635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 10664635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 10674635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 10684635f4fbSAndy Whitcroft } 10694635f4fbSAndy Whitcroft 10708905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 10718905a67cSAndy Whitcroft # outermost level. 10728905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 10738905a67cSAndy Whitcroft last; 10748905a67cSAndy Whitcroft } 10758905a67cSAndy Whitcroft 107613214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1077773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1078773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1079773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1080773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1081773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1082773647a0SAndy Whitcroft $coff_set = 1; 1083773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1084773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 108513214adfSAndy Whitcroft } 108613214adfSAndy Whitcroft 10878905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 10888905a67cSAndy Whitcroft $level++; 10898905a67cSAndy Whitcroft $type = '('; 10908905a67cSAndy Whitcroft } 10918905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 10928905a67cSAndy Whitcroft $level--; 10938905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 10948905a67cSAndy Whitcroft 10958905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 10968905a67cSAndy Whitcroft $coff = $off; 1097773647a0SAndy Whitcroft $coff_set = 1; 1098773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 10998905a67cSAndy Whitcroft } 11008905a67cSAndy Whitcroft } 11018905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11028905a67cSAndy Whitcroft $level++; 11038905a67cSAndy Whitcroft $type = '{'; 11048905a67cSAndy Whitcroft } 11058905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11068905a67cSAndy Whitcroft $level--; 11078905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11088905a67cSAndy Whitcroft 11098905a67cSAndy Whitcroft if ($level == 0) { 1110b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1111b998e001SPatrick Pannuto $off++; 1112b998e001SPatrick Pannuto } 11138905a67cSAndy Whitcroft last; 11148905a67cSAndy Whitcroft } 11158905a67cSAndy Whitcroft } 1116f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1117f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1118f74bd194SAndy Whitcroft $level--; 1119f74bd194SAndy Whitcroft $type = ''; 1120f74bd194SAndy Whitcroft $off++; 1121f74bd194SAndy Whitcroft last; 1122f74bd194SAndy Whitcroft } 11238905a67cSAndy Whitcroft $off++; 11248905a67cSAndy Whitcroft } 1125a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 112613214adfSAndy Whitcroft if ($off == $len) { 1127a3bb97a7SAndy Whitcroft $loff = $len + 1; 112813214adfSAndy Whitcroft $line++; 112913214adfSAndy Whitcroft $remain--; 113013214adfSAndy Whitcroft } 11318905a67cSAndy Whitcroft 11328905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11338905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11348905a67cSAndy Whitcroft 11358905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11368905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11378905a67cSAndy Whitcroft 1138773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 113913214adfSAndy Whitcroft 114013214adfSAndy Whitcroft return ($statement, $condition, 114113214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 114213214adfSAndy Whitcroft} 114313214adfSAndy Whitcroft 1144cf655043SAndy Whitcroftsub statement_lines { 1145cf655043SAndy Whitcroft my ($stmt) = @_; 1146cf655043SAndy Whitcroft 1147cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1148cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1149cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1150cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1151cf655043SAndy Whitcroft 1152cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1153cf655043SAndy Whitcroft 1154cf655043SAndy Whitcroft return $#stmt_lines + 2; 1155cf655043SAndy Whitcroft} 1156cf655043SAndy Whitcroft 1157cf655043SAndy Whitcroftsub statement_rawlines { 1158cf655043SAndy Whitcroft my ($stmt) = @_; 1159cf655043SAndy Whitcroft 1160cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1161cf655043SAndy Whitcroft 1162cf655043SAndy Whitcroft return $#stmt_lines + 2; 1163cf655043SAndy Whitcroft} 1164cf655043SAndy Whitcroft 1165cf655043SAndy Whitcroftsub statement_block_size { 1166cf655043SAndy Whitcroft my ($stmt) = @_; 1167cf655043SAndy Whitcroft 1168cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1169cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1170cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1171cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1172cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1173cf655043SAndy Whitcroft 1174cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1175cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1176cf655043SAndy Whitcroft 1177cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1178cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1179cf655043SAndy Whitcroft 1180cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1181cf655043SAndy Whitcroft return $stmt_lines; 1182cf655043SAndy Whitcroft } else { 1183cf655043SAndy Whitcroft return $stmt_statements; 1184cf655043SAndy Whitcroft } 1185cf655043SAndy Whitcroft} 1186cf655043SAndy Whitcroft 118713214adfSAndy Whitcroftsub ctx_statement_full { 118813214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 118913214adfSAndy Whitcroft my ($statement, $condition, $level); 119013214adfSAndy Whitcroft 119113214adfSAndy Whitcroft my (@chunks); 119213214adfSAndy Whitcroft 1193cf655043SAndy Whitcroft # Grab the first conditional/block pair. 119413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 119513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1196773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 119713214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1198cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1199cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1200cf655043SAndy Whitcroft } 1201cf655043SAndy Whitcroft 1202cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1203cf655043SAndy Whitcroft # could continue the statement. 1204cf655043SAndy Whitcroft for (;;) { 120513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 120613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1207cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1208773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1209cf655043SAndy Whitcroft #print "C: push\n"; 1210cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 121113214adfSAndy Whitcroft } 121213214adfSAndy Whitcroft 121313214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12148905a67cSAndy Whitcroft} 12158905a67cSAndy Whitcroft 12164a0df2efSAndy Whitcroftsub ctx_block_get { 1217f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12184a0df2efSAndy Whitcroft my $line; 12194a0df2efSAndy Whitcroft my $start = $linenr - 1; 12204a0df2efSAndy Whitcroft my $blk = ''; 12214a0df2efSAndy Whitcroft my @o; 12224a0df2efSAndy Whitcroft my @c; 12234a0df2efSAndy Whitcroft my @res = (); 12244a0df2efSAndy Whitcroft 1225f0a594c1SAndy Whitcroft my $level = 0; 12264635f4fbSAndy Whitcroft my @stack = ($level); 122700df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 122800df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 122900df344fSAndy Whitcroft $remain--; 123000df344fSAndy Whitcroft 123100df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12324635f4fbSAndy Whitcroft 12334635f4fbSAndy Whitcroft # Handle nested #if/#else. 123401464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12354635f4fbSAndy Whitcroft push(@stack, $level); 123601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12374635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 123801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12394635f4fbSAndy Whitcroft $level = pop(@stack); 12404635f4fbSAndy Whitcroft } 12414635f4fbSAndy Whitcroft 124201464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1243f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1244f0a594c1SAndy Whitcroft if ($off > 0) { 1245f0a594c1SAndy Whitcroft $off--; 1246f0a594c1SAndy Whitcroft next; 1247f0a594c1SAndy Whitcroft } 12484a0df2efSAndy Whitcroft 1249f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1250f0a594c1SAndy Whitcroft $level--; 1251f0a594c1SAndy Whitcroft last if ($level == 0); 1252f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1253f0a594c1SAndy Whitcroft $level++; 1254f0a594c1SAndy Whitcroft } 1255f0a594c1SAndy Whitcroft } 12564a0df2efSAndy Whitcroft 1257f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 125800df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12594a0df2efSAndy Whitcroft } 12604a0df2efSAndy Whitcroft 1261f0a594c1SAndy Whitcroft last if ($level == 0); 12624a0df2efSAndy Whitcroft } 12634a0df2efSAndy Whitcroft 1264f0a594c1SAndy Whitcroft return ($level, @res); 12654a0df2efSAndy Whitcroft} 12664a0df2efSAndy Whitcroftsub ctx_block_outer { 12674a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12684a0df2efSAndy Whitcroft 1269f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1270f0a594c1SAndy Whitcroft return @r; 12714a0df2efSAndy Whitcroft} 12724a0df2efSAndy Whitcroftsub ctx_block { 12734a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12744a0df2efSAndy Whitcroft 1275f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1276f0a594c1SAndy Whitcroft return @r; 1277653d4876SAndy Whitcroft} 1278653d4876SAndy Whitcroftsub ctx_statement { 1279f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1280f0a594c1SAndy Whitcroft 1281f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1282f0a594c1SAndy Whitcroft return @r; 1283f0a594c1SAndy Whitcroft} 1284f0a594c1SAndy Whitcroftsub ctx_block_level { 1285653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1286653d4876SAndy Whitcroft 1287f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 12884a0df2efSAndy Whitcroft} 12899c0ca6f9SAndy Whitcroftsub ctx_statement_level { 12909c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 12919c0ca6f9SAndy Whitcroft 12929c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 12939c0ca6f9SAndy Whitcroft} 12944a0df2efSAndy Whitcroft 12954a0df2efSAndy Whitcroftsub ctx_locate_comment { 12964a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 12974a0df2efSAndy Whitcroft 12984a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1299beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13004a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13014a0df2efSAndy Whitcroft 13024a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13034a0df2efSAndy Whitcroft # comment. 13044a0df2efSAndy Whitcroft my $in_comment = 0; 13054a0df2efSAndy Whitcroft $current_comment = ''; 13064a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 130700df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 130800df344fSAndy Whitcroft #warn " $line\n"; 13094a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13104a0df2efSAndy Whitcroft $in_comment = 1; 13114a0df2efSAndy Whitcroft } 13124a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13134a0df2efSAndy Whitcroft $in_comment = 1; 13144a0df2efSAndy Whitcroft } 13154a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13164a0df2efSAndy Whitcroft $current_comment = ''; 13174a0df2efSAndy Whitcroft } 13184a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13194a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13204a0df2efSAndy Whitcroft $in_comment = 0; 13214a0df2efSAndy Whitcroft } 13224a0df2efSAndy Whitcroft } 13234a0df2efSAndy Whitcroft 13244a0df2efSAndy Whitcroft chomp($current_comment); 13254a0df2efSAndy Whitcroft return($current_comment); 13264a0df2efSAndy Whitcroft} 13274a0df2efSAndy Whitcroftsub ctx_has_comment { 13284a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13294a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13304a0df2efSAndy Whitcroft 133100df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13324a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13334a0df2efSAndy Whitcroft 13344a0df2efSAndy Whitcroft return ($cmt ne ''); 13354a0df2efSAndy Whitcroft} 13364a0df2efSAndy Whitcroft 13374d001e4dSAndy Whitcroftsub raw_line { 13384d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13394d001e4dSAndy Whitcroft 13404d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13414d001e4dSAndy Whitcroft $cnt++; 13424d001e4dSAndy Whitcroft 13434d001e4dSAndy Whitcroft my $line; 13444d001e4dSAndy Whitcroft while ($cnt) { 13454d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13464d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13474d001e4dSAndy Whitcroft $cnt--; 13484d001e4dSAndy Whitcroft } 13494d001e4dSAndy Whitcroft 13504d001e4dSAndy Whitcroft return $line; 13514d001e4dSAndy Whitcroft} 13524d001e4dSAndy Whitcroft 13530a920b5bSAndy Whitcroftsub cat_vet { 13540a920b5bSAndy Whitcroft my ($vet) = @_; 13559c0ca6f9SAndy Whitcroft my ($res, $coded); 13560a920b5bSAndy Whitcroft 13579c0ca6f9SAndy Whitcroft $res = ''; 13586c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13596c72ffaaSAndy Whitcroft $res .= $1; 13606c72ffaaSAndy Whitcroft if ($2 ne '') { 13619c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 13626c72ffaaSAndy Whitcroft $res .= $coded; 13636c72ffaaSAndy Whitcroft } 13649c0ca6f9SAndy Whitcroft } 13659c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 13660a920b5bSAndy Whitcroft 13679c0ca6f9SAndy Whitcroft return $res; 13680a920b5bSAndy Whitcroft} 13690a920b5bSAndy Whitcroft 1370c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1371cf655043SAndy Whitcroftmy $av_pending; 1372c2fdda0dSAndy Whitcroftmy @av_paren_type; 13731f65f947SAndy Whitcroftmy $av_pend_colon; 1374c2fdda0dSAndy Whitcroft 1375c2fdda0dSAndy Whitcroftsub annotate_reset { 1376c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1377cf655043SAndy Whitcroft $av_pending = '_'; 1378cf655043SAndy Whitcroft @av_paren_type = ('E'); 13791f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1380c2fdda0dSAndy Whitcroft} 1381c2fdda0dSAndy Whitcroft 13826c72ffaaSAndy Whitcroftsub annotate_values { 13836c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 13846c72ffaaSAndy Whitcroft 13856c72ffaaSAndy Whitcroft my $res; 13861f65f947SAndy Whitcroft my $var = '_' x length($stream); 13876c72ffaaSAndy Whitcroft my $cur = $stream; 13886c72ffaaSAndy Whitcroft 1389c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 13906c72ffaaSAndy Whitcroft 13916c72ffaaSAndy Whitcroft while (length($cur)) { 1392773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1393cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1394171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 13956c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1396c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1397c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1398cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1399c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14006c72ffaaSAndy Whitcroft } 14016c72ffaaSAndy Whitcroft 1402c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14039446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14049446ef56SAndy Whitcroft push(@av_paren_type, $type); 1405addcdceaSAndy Whitcroft $type = 'c'; 14069446ef56SAndy Whitcroft 1407e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1408c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14096c72ffaaSAndy Whitcroft $type = 'T'; 14106c72ffaaSAndy Whitcroft 1411389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1412389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1413389a2fe5SAndy Whitcroft $type = 'T'; 1414389a2fe5SAndy Whitcroft 1415c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1416171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1417c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1418171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1419171ae1a4SAndy Whitcroft if ($2 ne '') { 1420cf655043SAndy Whitcroft $av_pending = 'N'; 1421171ae1a4SAndy Whitcroft } 1422171ae1a4SAndy Whitcroft $type = 'E'; 1423171ae1a4SAndy Whitcroft 1424c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1425171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1426171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1427171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14286c72ffaaSAndy Whitcroft 1429c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1430cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1431c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1432cf655043SAndy Whitcroft 1433cf655043SAndy Whitcroft push(@av_paren_type, $type); 1434cf655043SAndy Whitcroft push(@av_paren_type, $type); 1435171ae1a4SAndy Whitcroft $type = 'E'; 1436cf655043SAndy Whitcroft 1437c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1438cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1439cf655043SAndy Whitcroft $av_preprocessor = 1; 1440cf655043SAndy Whitcroft 1441cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1442cf655043SAndy Whitcroft 1443171ae1a4SAndy Whitcroft $type = 'E'; 1444cf655043SAndy Whitcroft 1445c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1446cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1447cf655043SAndy Whitcroft 1448cf655043SAndy Whitcroft $av_preprocessor = 1; 1449cf655043SAndy Whitcroft 1450cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1451cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1452cf655043SAndy Whitcroft pop(@av_paren_type); 1453cf655043SAndy Whitcroft push(@av_paren_type, $type); 1454171ae1a4SAndy Whitcroft $type = 'E'; 14556c72ffaaSAndy Whitcroft 14566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1457c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14586c72ffaaSAndy Whitcroft 1459171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1460171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1461171ae1a4SAndy Whitcroft $av_pending = $type; 1462171ae1a4SAndy Whitcroft $type = 'N'; 1463171ae1a4SAndy Whitcroft 14646c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1465c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 14666c72ffaaSAndy Whitcroft if (defined $2) { 1467cf655043SAndy Whitcroft $av_pending = 'V'; 14686c72ffaaSAndy Whitcroft } 14696c72ffaaSAndy Whitcroft $type = 'N'; 14706c72ffaaSAndy Whitcroft 147114b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1472c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 147314b111c1SAndy Whitcroft $av_pending = 'E'; 14746c72ffaaSAndy Whitcroft $type = 'N'; 14756c72ffaaSAndy Whitcroft 14761f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 14771f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 14781f65f947SAndy Whitcroft $av_pend_colon = 'C'; 14791f65f947SAndy Whitcroft $type = 'N'; 14801f65f947SAndy Whitcroft 148114b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1482c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 14836c72ffaaSAndy Whitcroft $type = 'N'; 14846c72ffaaSAndy Whitcroft 14856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1486c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1487cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1488cf655043SAndy Whitcroft $av_pending = '_'; 14896c72ffaaSAndy Whitcroft $type = 'N'; 14906c72ffaaSAndy Whitcroft 14916c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1492cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1493cf655043SAndy Whitcroft if ($new_type ne '_') { 1494cf655043SAndy Whitcroft $type = $new_type; 1495c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1496c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 14976c72ffaaSAndy Whitcroft } else { 1498c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 14996c72ffaaSAndy Whitcroft } 15006c72ffaaSAndy Whitcroft 1501c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1502c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1503c8cb2ca3SAndy Whitcroft $type = 'V'; 1504cf655043SAndy Whitcroft $av_pending = 'V'; 15056c72ffaaSAndy Whitcroft 15068e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15078e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15081f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15098e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15108e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15111f65f947SAndy Whitcroft } 15121f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15131f65f947SAndy Whitcroft $type = 'V'; 15141f65f947SAndy Whitcroft 15156c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1516c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15176c72ffaaSAndy Whitcroft $type = 'V'; 15186c72ffaaSAndy Whitcroft 15196c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1520c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15216c72ffaaSAndy Whitcroft $type = 'N'; 15226c72ffaaSAndy Whitcroft 1523cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1524c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 152513214adfSAndy Whitcroft $type = 'E'; 15261f65f947SAndy Whitcroft $av_pend_colon = 'O'; 152713214adfSAndy Whitcroft 15288e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15298e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15308e761b04SAndy Whitcroft $type = 'C'; 15318e761b04SAndy Whitcroft 15321f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15331f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15341f65f947SAndy Whitcroft $type = 'N'; 15351f65f947SAndy Whitcroft 15361f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15371f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15381f65f947SAndy Whitcroft 15391f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15401f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15411f65f947SAndy Whitcroft $type = 'E'; 15421f65f947SAndy Whitcroft } else { 15431f65f947SAndy Whitcroft $type = 'N'; 15441f65f947SAndy Whitcroft } 15451f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15461f65f947SAndy Whitcroft 15478e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 154813214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15496c72ffaaSAndy Whitcroft $type = 'N'; 15506c72ffaaSAndy Whitcroft 15510d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 155274048ed8SAndy Whitcroft my $variant; 155374048ed8SAndy Whitcroft 155474048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 155574048ed8SAndy Whitcroft if ($type eq 'V') { 155674048ed8SAndy Whitcroft $variant = 'B'; 155774048ed8SAndy Whitcroft } else { 155874048ed8SAndy Whitcroft $variant = 'U'; 155974048ed8SAndy Whitcroft } 156074048ed8SAndy Whitcroft 156174048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 156274048ed8SAndy Whitcroft $type = 'N'; 156374048ed8SAndy Whitcroft 15646c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1565c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 15666c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 15676c72ffaaSAndy Whitcroft $type = 'N'; 15686c72ffaaSAndy Whitcroft } 15696c72ffaaSAndy Whitcroft 15706c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1571c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 15726c72ffaaSAndy Whitcroft } 15736c72ffaaSAndy Whitcroft if (defined $1) { 15746c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 15756c72ffaaSAndy Whitcroft $res .= $type x length($1); 15766c72ffaaSAndy Whitcroft } 15776c72ffaaSAndy Whitcroft } 15786c72ffaaSAndy Whitcroft 15791f65f947SAndy Whitcroft return ($res, $var); 15806c72ffaaSAndy Whitcroft} 15816c72ffaaSAndy Whitcroft 15828905a67cSAndy Whitcroftsub possible { 158313214adfSAndy Whitcroft my ($possible, $line) = @_; 15849a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 15850776e594SAndy Whitcroft ^(?: 15860776e594SAndy Whitcroft $Modifier| 15870776e594SAndy Whitcroft $Storage| 15880776e594SAndy Whitcroft $Type| 15899a974fdbSAndy Whitcroft DEFINE_\S+ 15909a974fdbSAndy Whitcroft )$| 15919a974fdbSAndy Whitcroft ^(?: 15920776e594SAndy Whitcroft goto| 15930776e594SAndy Whitcroft return| 15940776e594SAndy Whitcroft case| 15950776e594SAndy Whitcroft else| 15960776e594SAndy Whitcroft asm|__asm__| 159789a88353SAndy Whitcroft do| 159889a88353SAndy Whitcroft \#| 159989a88353SAndy Whitcroft \#\#| 16009a974fdbSAndy Whitcroft )(?:\s|$)| 16010776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16029a974fdbSAndy Whitcroft )}x; 16039a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16049a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1605c45dcabdSAndy Whitcroft # Check for modifiers. 1606c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1607c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1608c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1609c45dcabdSAndy Whitcroft 1610c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1611c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1612d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16139a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1614d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1615d2506586SAndy Whitcroft push(@modifierList, $modifier); 1616d2506586SAndy Whitcroft } 16179a974fdbSAndy Whitcroft } 1618c45dcabdSAndy Whitcroft 1619c45dcabdSAndy Whitcroft } else { 162013214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 16218905a67cSAndy Whitcroft push(@typeList, $possible); 1622c45dcabdSAndy Whitcroft } 16238905a67cSAndy Whitcroft build_types(); 16240776e594SAndy Whitcroft } else { 16250776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16268905a67cSAndy Whitcroft } 16278905a67cSAndy Whitcroft} 16288905a67cSAndy Whitcroft 16296c72ffaaSAndy Whitcroftmy $prefix = ''; 16306c72ffaaSAndy Whitcroft 1631000d1cc1SJoe Perchessub show_type { 1632cbec18afSJoe Perches my ($type) = @_; 163391bfe484SJoe Perches 1634cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1635cbec18afSJoe Perches 1636cbec18afSJoe Perches return !defined $ignore_type{$type}; 1637000d1cc1SJoe Perches} 1638000d1cc1SJoe Perches 1639f0a594c1SAndy Whitcroftsub report { 1640cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1641cbec18afSJoe Perches 1642cbec18afSJoe Perches if (!show_type($type) || 1643cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1644773647a0SAndy Whitcroft return 0; 1645773647a0SAndy Whitcroft } 1646000d1cc1SJoe Perches my $line; 1647000d1cc1SJoe Perches if ($show_types) { 1648cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1649000d1cc1SJoe Perches } else { 1650cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1651000d1cc1SJoe Perches } 16528905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 16538905a67cSAndy Whitcroft 165413214adfSAndy Whitcroft push(our @report, $line); 1655773647a0SAndy Whitcroft 1656773647a0SAndy Whitcroft return 1; 1657f0a594c1SAndy Whitcroft} 1658cbec18afSJoe Perches 1659f0a594c1SAndy Whitcroftsub report_dump { 166013214adfSAndy Whitcroft our @report; 1661f0a594c1SAndy Whitcroft} 1662000d1cc1SJoe Perches 1663d752fcc8SJoe Perchessub fixup_current_range { 1664d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1665d752fcc8SJoe Perches 1666d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1667d752fcc8SJoe Perches my $o = $1; 1668d752fcc8SJoe Perches my $l = $2; 1669d752fcc8SJoe Perches my $no = $o + $offset; 1670d752fcc8SJoe Perches my $nl = $l + $length; 1671d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1672d752fcc8SJoe Perches } 1673d752fcc8SJoe Perches} 1674d752fcc8SJoe Perches 1675d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1676d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1677d752fcc8SJoe Perches 1678d752fcc8SJoe Perches my $range_last_linenr = 0; 1679d752fcc8SJoe Perches my $delta_offset = 0; 1680d752fcc8SJoe Perches 1681d752fcc8SJoe Perches my $old_linenr = 0; 1682d752fcc8SJoe Perches my $new_linenr = 0; 1683d752fcc8SJoe Perches 1684d752fcc8SJoe Perches my $next_insert = 0; 1685d752fcc8SJoe Perches my $next_delete = 0; 1686d752fcc8SJoe Perches 1687d752fcc8SJoe Perches my @lines = (); 1688d752fcc8SJoe Perches 1689d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1690d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1691d752fcc8SJoe Perches 1692d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1693d752fcc8SJoe Perches my $save_line = 1; 1694d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1695323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1696d752fcc8SJoe Perches $delta_offset = 0; 1697d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1698d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1699d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1700d752fcc8SJoe Perches } 1701d752fcc8SJoe Perches 1702d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1703d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1704d752fcc8SJoe Perches $save_line = 0; 1705d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1706d752fcc8SJoe Perches } 1707d752fcc8SJoe Perches 1708d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1709d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1710d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1711d752fcc8SJoe Perches $new_linenr++; 1712d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1713d752fcc8SJoe Perches } 1714d752fcc8SJoe Perches 1715d752fcc8SJoe Perches if ($save_line) { 1716d752fcc8SJoe Perches push(@lines, $line); 1717d752fcc8SJoe Perches $new_linenr++; 1718d752fcc8SJoe Perches } 1719d752fcc8SJoe Perches 1720d752fcc8SJoe Perches $old_linenr++; 1721d752fcc8SJoe Perches } 1722d752fcc8SJoe Perches 1723d752fcc8SJoe Perches return @lines; 1724d752fcc8SJoe Perches} 1725d752fcc8SJoe Perches 1726f2d7e4d4SJoe Perchessub fix_insert_line { 1727f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1728f2d7e4d4SJoe Perches 1729f2d7e4d4SJoe Perches my $inserted = { 1730f2d7e4d4SJoe Perches LINENR => $linenr, 1731f2d7e4d4SJoe Perches LINE => $line, 1732f2d7e4d4SJoe Perches }; 1733f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1734f2d7e4d4SJoe Perches} 1735f2d7e4d4SJoe Perches 1736f2d7e4d4SJoe Perchessub fix_delete_line { 1737f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1738f2d7e4d4SJoe Perches 1739f2d7e4d4SJoe Perches my $deleted = { 1740f2d7e4d4SJoe Perches LINENR => $linenr, 1741f2d7e4d4SJoe Perches LINE => $line, 1742f2d7e4d4SJoe Perches }; 1743f2d7e4d4SJoe Perches 1744f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1745f2d7e4d4SJoe Perches} 1746f2d7e4d4SJoe Perches 1747de7d4f0eSAndy Whitcroftsub ERROR { 1748cbec18afSJoe Perches my ($type, $msg) = @_; 1749cbec18afSJoe Perches 1750cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1751de7d4f0eSAndy Whitcroft our $clean = 0; 17526c72ffaaSAndy Whitcroft our $cnt_error++; 17533705ce5bSJoe Perches return 1; 1754de7d4f0eSAndy Whitcroft } 17553705ce5bSJoe Perches return 0; 1756773647a0SAndy Whitcroft} 1757de7d4f0eSAndy Whitcroftsub WARN { 1758cbec18afSJoe Perches my ($type, $msg) = @_; 1759cbec18afSJoe Perches 1760cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1761de7d4f0eSAndy Whitcroft our $clean = 0; 17626c72ffaaSAndy Whitcroft our $cnt_warn++; 17633705ce5bSJoe Perches return 1; 1764de7d4f0eSAndy Whitcroft } 17653705ce5bSJoe Perches return 0; 1766773647a0SAndy Whitcroft} 1767de7d4f0eSAndy Whitcroftsub CHK { 1768cbec18afSJoe Perches my ($type, $msg) = @_; 1769cbec18afSJoe Perches 1770cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1771de7d4f0eSAndy Whitcroft our $clean = 0; 17726c72ffaaSAndy Whitcroft our $cnt_chk++; 17733705ce5bSJoe Perches return 1; 17746c72ffaaSAndy Whitcroft } 17753705ce5bSJoe Perches return 0; 1776de7d4f0eSAndy Whitcroft} 1777de7d4f0eSAndy Whitcroft 17786ecd9674SAndy Whitcroftsub check_absolute_file { 17796ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 17806ecd9674SAndy Whitcroft my $file = $absolute; 17816ecd9674SAndy Whitcroft 17826ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 17836ecd9674SAndy Whitcroft 17846ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 17856ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 17866ecd9674SAndy Whitcroft if (-f "$root/$file") { 17876ecd9674SAndy Whitcroft ##print "file<$file>\n"; 17886ecd9674SAndy Whitcroft last; 17896ecd9674SAndy Whitcroft } 17906ecd9674SAndy Whitcroft } 17916ecd9674SAndy Whitcroft if (! -f _) { 17926ecd9674SAndy Whitcroft return 0; 17936ecd9674SAndy Whitcroft } 17946ecd9674SAndy Whitcroft 17956ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 17966ecd9674SAndy Whitcroft my $prefix = $absolute; 17976ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 17986ecd9674SAndy Whitcroft 17996ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18006ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1801000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1802000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18036ecd9674SAndy Whitcroft } 18046ecd9674SAndy Whitcroft} 18056ecd9674SAndy Whitcroft 18063705ce5bSJoe Perchessub trim { 18073705ce5bSJoe Perches my ($string) = @_; 18083705ce5bSJoe Perches 1809b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1810b34c648bSJoe Perches 1811b34c648bSJoe Perches return $string; 1812b34c648bSJoe Perches} 1813b34c648bSJoe Perches 1814b34c648bSJoe Perchessub ltrim { 1815b34c648bSJoe Perches my ($string) = @_; 1816b34c648bSJoe Perches 1817b34c648bSJoe Perches $string =~ s/^\s+//; 1818b34c648bSJoe Perches 1819b34c648bSJoe Perches return $string; 1820b34c648bSJoe Perches} 1821b34c648bSJoe Perches 1822b34c648bSJoe Perchessub rtrim { 1823b34c648bSJoe Perches my ($string) = @_; 1824b34c648bSJoe Perches 1825b34c648bSJoe Perches $string =~ s/\s+$//; 18263705ce5bSJoe Perches 18273705ce5bSJoe Perches return $string; 18283705ce5bSJoe Perches} 18293705ce5bSJoe Perches 183052ea8506SJoe Perchessub string_find_replace { 183152ea8506SJoe Perches my ($string, $find, $replace) = @_; 183252ea8506SJoe Perches 183352ea8506SJoe Perches $string =~ s/$find/$replace/g; 183452ea8506SJoe Perches 183552ea8506SJoe Perches return $string; 183652ea8506SJoe Perches} 183752ea8506SJoe Perches 18383705ce5bSJoe Perchessub tabify { 18393705ce5bSJoe Perches my ($leading) = @_; 18403705ce5bSJoe Perches 18413705ce5bSJoe Perches my $source_indent = 8; 18423705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 18433705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 18443705ce5bSJoe Perches 18453705ce5bSJoe Perches #convert leading spaces to tabs 18463705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 18473705ce5bSJoe Perches #Remove spaces before a tab 18483705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 18493705ce5bSJoe Perches 18503705ce5bSJoe Perches return "$leading"; 18513705ce5bSJoe Perches} 18523705ce5bSJoe Perches 1853d1fe9c09SJoe Perchessub pos_last_openparen { 1854d1fe9c09SJoe Perches my ($line) = @_; 1855d1fe9c09SJoe Perches 1856d1fe9c09SJoe Perches my $pos = 0; 1857d1fe9c09SJoe Perches 1858d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1859d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1860d1fe9c09SJoe Perches 1861d1fe9c09SJoe Perches my $last_openparen = 0; 1862d1fe9c09SJoe Perches 1863d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1864d1fe9c09SJoe Perches return -1; 1865d1fe9c09SJoe Perches } 1866d1fe9c09SJoe Perches 1867d1fe9c09SJoe Perches my $len = length($line); 1868d1fe9c09SJoe Perches 1869d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1870d1fe9c09SJoe Perches my $string = substr($line, $pos); 1871d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1872d1fe9c09SJoe Perches $pos += length($1) - 1; 1873d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1874d1fe9c09SJoe Perches $last_openparen = $pos; 1875d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1876d1fe9c09SJoe Perches last; 1877d1fe9c09SJoe Perches } 1878d1fe9c09SJoe Perches } 1879d1fe9c09SJoe Perches 188091cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1881d1fe9c09SJoe Perches} 1882d1fe9c09SJoe Perches 18830a920b5bSAndy Whitcroftsub process { 18840a920b5bSAndy Whitcroft my $filename = shift; 18850a920b5bSAndy Whitcroft 18860a920b5bSAndy Whitcroft my $linenr=0; 18870a920b5bSAndy Whitcroft my $prevline=""; 1888c2fdda0dSAndy Whitcroft my $prevrawline=""; 18890a920b5bSAndy Whitcroft my $stashline=""; 1890c2fdda0dSAndy Whitcroft my $stashrawline=""; 18910a920b5bSAndy Whitcroft 18924a0df2efSAndy Whitcroft my $length; 18930a920b5bSAndy Whitcroft my $indent; 18940a920b5bSAndy Whitcroft my $previndent=0; 18950a920b5bSAndy Whitcroft my $stashindent=0; 18960a920b5bSAndy Whitcroft 1897de7d4f0eSAndy Whitcroft our $clean = 1; 18980a920b5bSAndy Whitcroft my $signoff = 0; 18990a920b5bSAndy Whitcroft my $is_patch = 0; 19000a920b5bSAndy Whitcroft 190129ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 190215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 19032a076f40SJoe Perches my $commit_log_long_line = 0; 190413f1937eSJoe Perches my $reported_maintainer_file = 0; 1905fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1906fa64205dSPasi Savanainen 1907365dd4eaSJoe Perches my $last_blank_line = 0; 19085e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1909365dd4eaSJoe Perches 191013214adfSAndy Whitcroft our @report = (); 19116c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19126c72ffaaSAndy Whitcroft our $cnt_error = 0; 19136c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19146c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19156c72ffaaSAndy Whitcroft 19160a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19170a920b5bSAndy Whitcroft my $realfile = ''; 19180a920b5bSAndy Whitcroft my $realline = 0; 19190a920b5bSAndy Whitcroft my $realcnt = 0; 19200a920b5bSAndy Whitcroft my $here = ''; 19210a920b5bSAndy Whitcroft my $in_comment = 0; 1922c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19230a920b5bSAndy Whitcroft my $first_line = 0; 19241e855726SWolfram Sang my $p1_prefix = ''; 19250a920b5bSAndy Whitcroft 192613214adfSAndy Whitcroft my $prev_values = 'E'; 192713214adfSAndy Whitcroft 192813214adfSAndy Whitcroft # suppression flags 1929773647a0SAndy Whitcroft my %suppress_ifbraces; 1930170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19312b474a1aSAndy Whitcroft my %suppress_export; 19323e469cdcSAndy Whitcroft my $suppress_statement = 0; 1933653d4876SAndy Whitcroft 19347e51f197SJoe Perches my %signatures = (); 1935323c1260SJoe Perches 1936c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1937de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1938c2fdda0dSAndy Whitcroft # 1939de7d4f0eSAndy Whitcroft my @setup_docs = (); 1940de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1941773647a0SAndy Whitcroft 1942d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1943d8b07710SJoe Perches 1944773647a0SAndy Whitcroft sanitise_line_reset(); 1945c2fdda0dSAndy Whitcroft my $line; 1946c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1947773647a0SAndy Whitcroft $linenr++; 1948773647a0SAndy Whitcroft $line = $rawline; 1949c2fdda0dSAndy Whitcroft 19503705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 19513705ce5bSJoe Perches 1952773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1953de7d4f0eSAndy Whitcroft $setup_docs = 0; 1954de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1955de7d4f0eSAndy Whitcroft $setup_docs = 1; 1956de7d4f0eSAndy Whitcroft } 1957773647a0SAndy Whitcroft #next; 1958de7d4f0eSAndy Whitcroft } 1959773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1960773647a0SAndy Whitcroft $realline=$1-1; 1961773647a0SAndy Whitcroft if (defined $2) { 1962773647a0SAndy Whitcroft $realcnt=$3+1; 1963773647a0SAndy Whitcroft } else { 1964773647a0SAndy Whitcroft $realcnt=1+1; 1965773647a0SAndy Whitcroft } 1966c45dcabdSAndy Whitcroft $in_comment = 0; 1967773647a0SAndy Whitcroft 1968773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1969773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1970773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1971773647a0SAndy Whitcroft # at context start. 1972773647a0SAndy Whitcroft my $edge; 197301fa9147SAndy Whitcroft my $cnt = $realcnt; 197401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 197501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 197601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 197701fa9147SAndy Whitcroft $cnt--; 197801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1979721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1980fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1981fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1982fae17daeSAndy Whitcroft ($edge) = $1; 1983fae17daeSAndy Whitcroft last; 1984fae17daeSAndy Whitcroft } 1985773647a0SAndy Whitcroft } 1986773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1987773647a0SAndy Whitcroft $in_comment = 1; 1988773647a0SAndy Whitcroft } 1989773647a0SAndy Whitcroft 1990773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1991773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1992773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1993773647a0SAndy Whitcroft if (!defined $edge && 199483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1995773647a0SAndy Whitcroft { 1996773647a0SAndy Whitcroft $in_comment = 1; 1997773647a0SAndy Whitcroft } 1998773647a0SAndy Whitcroft 1999773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2000773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2001773647a0SAndy Whitcroft 2002171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2003773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2004171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2005773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2006773647a0SAndy Whitcroft } 2007773647a0SAndy Whitcroft push(@lines, $line); 2008773647a0SAndy Whitcroft 2009773647a0SAndy Whitcroft if ($realcnt > 1) { 2010773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2011773647a0SAndy Whitcroft } else { 2012773647a0SAndy Whitcroft $realcnt = 0; 2013773647a0SAndy Whitcroft } 2014773647a0SAndy Whitcroft 2015773647a0SAndy Whitcroft #print "==>$rawline\n"; 2016773647a0SAndy Whitcroft #print "-->$line\n"; 2017de7d4f0eSAndy Whitcroft 2018de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2019de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2020de7d4f0eSAndy Whitcroft } 2021de7d4f0eSAndy Whitcroft } 2022de7d4f0eSAndy Whitcroft 20236c72ffaaSAndy Whitcroft $prefix = ''; 20246c72ffaaSAndy Whitcroft 2025773647a0SAndy Whitcroft $realcnt = 0; 2026773647a0SAndy Whitcroft $linenr = 0; 2027194f66fcSJoe Perches $fixlinenr = -1; 20280a920b5bSAndy Whitcroft foreach my $line (@lines) { 20290a920b5bSAndy Whitcroft $linenr++; 2030194f66fcSJoe Perches $fixlinenr++; 20311b5539b1SJoe Perches my $sline = $line; #copy of $line 20321b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20330a920b5bSAndy Whitcroft 2034c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20356c72ffaaSAndy Whitcroft 20360a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 20376c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20380a920b5bSAndy Whitcroft $is_patch = 1; 20394a0df2efSAndy Whitcroft $first_line = $linenr + 1; 20400a920b5bSAndy Whitcroft $realline=$1-1; 20410a920b5bSAndy Whitcroft if (defined $2) { 20420a920b5bSAndy Whitcroft $realcnt=$3+1; 20430a920b5bSAndy Whitcroft } else { 20440a920b5bSAndy Whitcroft $realcnt=1+1; 20450a920b5bSAndy Whitcroft } 2046c2fdda0dSAndy Whitcroft annotate_reset(); 204713214adfSAndy Whitcroft $prev_values = 'E'; 204813214adfSAndy Whitcroft 2049773647a0SAndy Whitcroft %suppress_ifbraces = (); 2050170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 20512b474a1aSAndy Whitcroft %suppress_export = (); 20523e469cdcSAndy Whitcroft $suppress_statement = 0; 20530a920b5bSAndy Whitcroft next; 20540a920b5bSAndy Whitcroft 20554a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 20564a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 20574a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2058773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 20590a920b5bSAndy Whitcroft $realline++; 2060d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 20610a920b5bSAndy Whitcroft 20624a0df2efSAndy Whitcroft # Measure the line length and indent. 2063c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 20640a920b5bSAndy Whitcroft 20650a920b5bSAndy Whitcroft # Track the previous line. 20660a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 20670a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2068c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2069c2fdda0dSAndy Whitcroft 2070773647a0SAndy Whitcroft #warn "line<$line>\n"; 20716c72ffaaSAndy Whitcroft 2072d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2073d8aaf121SAndy Whitcroft $realcnt--; 20740a920b5bSAndy Whitcroft } 20750a920b5bSAndy Whitcroft 2076cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2077cc77cdcaSAndy Whitcroft 20780a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 2079773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 2080773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 2081773647a0SAndy Whitcroft 20826c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 20836c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2084773647a0SAndy Whitcroft 20852ac73b4fSJoe Perches my $found_file = 0; 2086773647a0SAndy Whitcroft # extract the filename as it passes 20873bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 20883bf9a009SRabin Vincent $realfile = $1; 20892b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2090270c49a0SJoe Perches $in_commit_log = 0; 20912ac73b4fSJoe Perches $found_file = 1; 20923bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2093773647a0SAndy Whitcroft $realfile = $1; 20942b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2095270c49a0SJoe Perches $in_commit_log = 0; 20961e855726SWolfram Sang 20971e855726SWolfram Sang $p1_prefix = $1; 2098e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2099e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2100000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2101000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21021e855726SWolfram Sang } 2103773647a0SAndy Whitcroft 2104c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2105000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2106000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2107773647a0SAndy Whitcroft } 21082ac73b4fSJoe Perches $found_file = 1; 21092ac73b4fSJoe Perches } 21102ac73b4fSJoe Perches 21112ac73b4fSJoe Perches if ($found_file) { 21122ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 21132ac73b4fSJoe Perches $check = 1; 21142ac73b4fSJoe Perches } else { 21152ac73b4fSJoe Perches $check = $check_orig; 21162ac73b4fSJoe Perches } 2117773647a0SAndy Whitcroft next; 2118773647a0SAndy Whitcroft } 2119773647a0SAndy Whitcroft 2120389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21210a920b5bSAndy Whitcroft 2122c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2123c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2124c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21250a920b5bSAndy Whitcroft 21266c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21276c72ffaaSAndy Whitcroft 21283bf9a009SRabin Vincent# Check for incorrect file permissions 21293bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 21303bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 213104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 213204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2133000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2134000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 21353bf9a009SRabin Vincent } 21363bf9a009SRabin Vincent } 21373bf9a009SRabin Vincent 213820112475SJoe Perches# Check the patch for a signoff: 2139d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 21404a0df2efSAndy Whitcroft $signoff++; 214115662b3eSJoe Perches $in_commit_log = 0; 21420a920b5bSAndy Whitcroft } 214320112475SJoe Perches 2144e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2145e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2146e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2147e0d975b1SJoe Perches $reported_maintainer_file = 1; 2148e0d975b1SJoe Perches } 2149e0d975b1SJoe Perches 215020112475SJoe Perches# Check signature styles 2151270c49a0SJoe Perches if (!$in_header_lines && 2152ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 215320112475SJoe Perches my $space_before = $1; 215420112475SJoe Perches my $sign_off = $2; 215520112475SJoe Perches my $space_after = $3; 215620112475SJoe Perches my $email = $4; 215720112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 215820112475SJoe Perches 2159ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2160ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2161ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2162ce0338dfSJoe Perches } 216320112475SJoe Perches if (defined $space_before && $space_before ne "") { 21643705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21653705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 21663705ce5bSJoe Perches $fix) { 2167194f66fcSJoe Perches $fixed[$fixlinenr] = 21683705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21693705ce5bSJoe Perches } 217020112475SJoe Perches } 217120112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 21723705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21733705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 21743705ce5bSJoe Perches $fix) { 2175194f66fcSJoe Perches $fixed[$fixlinenr] = 21763705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21773705ce5bSJoe Perches } 21783705ce5bSJoe Perches 217920112475SJoe Perches } 218020112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 21813705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21823705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 21833705ce5bSJoe Perches $fix) { 2184194f66fcSJoe Perches $fixed[$fixlinenr] = 21853705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21863705ce5bSJoe Perches } 218720112475SJoe Perches } 218820112475SJoe Perches 218920112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 219020112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 219120112475SJoe Perches if ($suggested_email eq "") { 2192000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2193000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 219420112475SJoe Perches } else { 219520112475SJoe Perches my $dequoted = $suggested_email; 219620112475SJoe Perches $dequoted =~ s/^"//; 219720112475SJoe Perches $dequoted =~ s/" </ </; 219820112475SJoe Perches # Don't force email to have quotes 219920112475SJoe Perches # Allow just an angle bracketed address 220020112475SJoe Perches if ("$dequoted$comment" ne $email && 220120112475SJoe Perches "<$email_address>$comment" ne $email && 220220112475SJoe Perches "$suggested_email$comment" ne $email) { 2203000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2204000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 220520112475SJoe Perches } 22060a920b5bSAndy Whitcroft } 22077e51f197SJoe Perches 22087e51f197SJoe Perches# Check for duplicate signatures 22097e51f197SJoe Perches my $sig_nospace = $line; 22107e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22117e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22127e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22137e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22147e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22157e51f197SJoe Perches } else { 22167e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22177e51f197SJoe Perches } 22180a920b5bSAndy Whitcroft } 22190a920b5bSAndy Whitcroft 2220a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2221a2fe16b9SJoe Perches if ($in_header_lines && 2222a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2223a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2224a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2225a2fe16b9SJoe Perches } 2226a2fe16b9SJoe Perches 22279b3189ebSJoe Perches# Check for old stable address 22289b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 22299b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 22309b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 22319b3189ebSJoe Perches } 22329b3189ebSJoe Perches 22337ebd05efSChristopher Covington# Check for unwanted Gerrit info 22347ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 22357ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 22367ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 22377ebd05efSChristopher Covington } 22387ebd05efSChristopher Covington 22392a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 22402a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 22412a076f40SJoe Perches length($line) > 75) { 22422a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 22432a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 22442a076f40SJoe Perches $commit_log_long_line = 1; 22452a076f40SJoe Perches } 22462a076f40SJoe Perches 22470d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 22480d7835fcSJoe Perches if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) { 2249d311cd44SJoe Perches my $init_char = $1; 2250d311cd44SJoe Perches my $orig_commit = lc($2); 22510d7835fcSJoe Perches my $short = 1; 22520d7835fcSJoe Perches my $long = 0; 22530d7835fcSJoe Perches my $case = 1; 22540d7835fcSJoe Perches my $space = 1; 22550d7835fcSJoe Perches my $hasdesc = 0; 225619c146a6SJoe Perches my $hasparens = 0; 22570d7835fcSJoe Perches my $id = '0123456789ab'; 22580d7835fcSJoe Perches my $orig_desc = "commit description"; 22590d7835fcSJoe Perches my $description = ""; 22600d7835fcSJoe Perches 22610d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 22620d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 22630d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 22640d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 22650d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 22660d7835fcSJoe Perches $orig_desc = $1; 226719c146a6SJoe Perches $hasparens = 1; 22680d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 22690d7835fcSJoe Perches defined $rawlines[$linenr] && 22700d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 22710d7835fcSJoe Perches $orig_desc = $1; 227219c146a6SJoe Perches $hasparens = 1; 2273b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2274b671fde0SJoe Perches defined $rawlines[$linenr] && 2275b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2276b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2277b671fde0SJoe Perches $orig_desc = $1; 2278b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2279b671fde0SJoe Perches $orig_desc .= " " . $1; 228019c146a6SJoe Perches $hasparens = 1; 22810d7835fcSJoe Perches } 22820d7835fcSJoe Perches 22830d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 22840d7835fcSJoe Perches $id, $orig_desc); 22850d7835fcSJoe Perches 228619c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2287d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 22880d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 22890d7835fcSJoe Perches } 2290d311cd44SJoe Perches } 2291d311cd44SJoe Perches 229213f1937eSJoe Perches# Check for added, moved or deleted files 229313f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 229413f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 229513f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 229613f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 229713f1937eSJoe Perches (defined($1) || defined($2))))) { 229813f1937eSJoe Perches $reported_maintainer_file = 1; 229913f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 230013f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 230113f1937eSJoe Perches } 230213f1937eSJoe Perches 230300df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 23048905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2305000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2306000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 23076c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2308de7d4f0eSAndy Whitcroft } 2309de7d4f0eSAndy Whitcroft 23106ecd9674SAndy Whitcroft# Check for absolute kernel paths. 23116ecd9674SAndy Whitcroft if ($tree) { 23126ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 23136ecd9674SAndy Whitcroft my $file = $1; 23146ecd9674SAndy Whitcroft 23156ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 23166ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 23176ecd9674SAndy Whitcroft # 23186ecd9674SAndy Whitcroft } else { 23196ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 23206ecd9674SAndy Whitcroft } 23216ecd9674SAndy Whitcroft } 23226ecd9674SAndy Whitcroft } 23236ecd9674SAndy Whitcroft 2324de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2325de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2326171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2327171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2328171ae1a4SAndy Whitcroft 2329171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2330171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2331171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2332171ae1a4SAndy Whitcroft 233334d99219SJoe Perches CHK("INVALID_UTF8", 2334000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 233500df344fSAndy Whitcroft } 23360a920b5bSAndy Whitcroft 233715662b3eSJoe Perches# Check if it's the start of a commit log 233815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 233915662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 234029ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 234129ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 234215662b3eSJoe Perches $in_header_lines = 0; 234315662b3eSJoe Perches $in_commit_log = 1; 234415662b3eSJoe Perches } 234515662b3eSJoe Perches 2346fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2347fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2348fa64205dSPasi Savanainen if ($in_header_lines && 2349fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2350fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2351fa64205dSPasi Savanainen $non_utf8_charset = 1; 2352fa64205dSPasi Savanainen } 2353fa64205dSPasi Savanainen 2354fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 235515662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2356fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 235715662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 235815662b3eSJoe Perches } 235915662b3eSJoe Perches 236066b47b4aSKees Cook# Check for various typo / spelling mistakes 236166d7a382SJoe Perches if (defined($misspellings) && 236266d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2363ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 236466b47b4aSKees Cook my $typo = $1; 236566b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 236666b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 236766b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 236866b47b4aSKees Cook my $msg_type = \&WARN; 236966b47b4aSKees Cook $msg_type = \&CHK if ($file); 237066b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 237166b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 237266b47b4aSKees Cook $fix) { 237366b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 237466b47b4aSKees Cook } 237566b47b4aSKees Cook } 237666b47b4aSKees Cook } 237766b47b4aSKees Cook 237830670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 237930670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 238000df344fSAndy Whitcroft 23810a920b5bSAndy Whitcroft#trailing whitespace 23829c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2383c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2384d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2385d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2386d5e616fcSJoe Perches $fix) { 2387194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2388d5e616fcSJoe Perches } 2389c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2390c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23913705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 23923705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 23933705ce5bSJoe Perches $fix) { 2394194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 23953705ce5bSJoe Perches } 23963705ce5bSJoe Perches 2397d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 23980a920b5bSAndy Whitcroft } 23995368df20SAndy Whitcroft 24004783f894SJosh Triplett# Check for FSF mailing addresses. 2401109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 24023e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 24033e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 24044783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24054783f894SJosh Triplett my $msg_type = \&ERROR; 24064783f894SJosh Triplett $msg_type = \&CHK if ($file); 24074783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 24084783f894SJosh 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) 24094783f894SJosh Triplett } 24104783f894SJosh Triplett 24113354957aSAndi Kleen# check for Kconfig help text having a real description 24129fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 24139fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 24143354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 24158d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 24163354957aSAndi Kleen my $length = 0; 24179fe287d7SAndy Whitcroft my $cnt = $realcnt; 24189fe287d7SAndy Whitcroft my $ln = $linenr + 1; 24199fe287d7SAndy Whitcroft my $f; 2420a1385803SAndy Whitcroft my $is_start = 0; 24219fe287d7SAndy Whitcroft my $is_end = 0; 2422a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 24239fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 24249fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 24259fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 24269fe287d7SAndy Whitcroft 24279fe287d7SAndy Whitcroft next if ($f =~ /^-/); 24288d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2429a1385803SAndy Whitcroft 24308d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2431a1385803SAndy Whitcroft $is_start = 1; 24328d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2433a1385803SAndy Whitcroft $length = -1; 2434a1385803SAndy Whitcroft } 2435a1385803SAndy Whitcroft 24369fe287d7SAndy Whitcroft $f =~ s/^.//; 24373354957aSAndi Kleen $f =~ s/#.*//; 24383354957aSAndi Kleen $f =~ s/^\s+//; 24393354957aSAndi Kleen next if ($f =~ /^$/); 24409fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 24419fe287d7SAndy Whitcroft $is_end = 1; 24429fe287d7SAndy Whitcroft last; 24439fe287d7SAndy Whitcroft } 24443354957aSAndi Kleen $length++; 24453354957aSAndi Kleen } 244656193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2447000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 244856193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 244956193274SVadim Bendebury } 2450a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 24513354957aSAndi Kleen } 24523354957aSAndi Kleen 24531ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 24541ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 24551ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 24561ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 24571ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 24581ba8dfd1SKees Cook } 24591ba8dfd1SKees Cook 2460327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2461327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2462327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2463327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2464327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2465327953e9SChristoph Jaeger } 2466327953e9SChristoph Jaeger 2467c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2468c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2469c68e5878SArnaud Lacombe my $flag = $1; 2470c68e5878SArnaud Lacombe my $replacement = { 2471c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2472c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2473c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2474c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2475c68e5878SArnaud Lacombe }; 2476c68e5878SArnaud Lacombe 2477c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2478c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2479c68e5878SArnaud Lacombe } 2480c68e5878SArnaud Lacombe 2481bff5da43SRob Herring# check for DT compatible documentation 24827dd05b38SFlorian Vaussard if (defined $root && 24837dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 24847dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 24857dd05b38SFlorian Vaussard 2486bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2487bff5da43SRob Herring 2488cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2489cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2490cc93319bSFlorian Vaussard 2491bff5da43SRob Herring foreach my $compat (@compats) { 2492bff5da43SRob Herring my $compat2 = $compat; 2493185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2494185d566bSRob Herring my $compat3 = $compat; 2495185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2496185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2497bff5da43SRob Herring if ( $? >> 8 ) { 2498bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2499bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2500bff5da43SRob Herring } 2501bff5da43SRob Herring 25024fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 25034fbf32a6SFlorian Vaussard my $vendor = $1; 2504cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2505bff5da43SRob Herring if ( $? >> 8 ) { 2506bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2507cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2508bff5da43SRob Herring } 2509bff5da43SRob Herring } 2510bff5da43SRob Herring } 2511bff5da43SRob Herring 25125368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2513de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 25145368df20SAndy Whitcroft 25156cd7f386SJoe Perches#line length limit 2516c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2517f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 251829a3c466SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?$String\s*(?:|,|\)\s*;)\s*$/ || 251929a3c466SJoe Perches $line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 252029a3c466SJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) && 25216cd7f386SJoe Perches $length > $max_line_length) 2522c45dcabdSAndy Whitcroft { 2523000d1cc1SJoe Perches WARN("LONG_LINE", 25246cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 25250a920b5bSAndy Whitcroft } 25260a920b5bSAndy Whitcroft 25278905a67cSAndy Whitcroft# check for adding lines without a newline. 25288905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2529000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2530000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 25318905a67cSAndy Whitcroft } 25328905a67cSAndy Whitcroft 253342e41c54SMike Frysinger# Blackfin: use hi/lo macros 253442e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 253542e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 253642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2537000d1cc1SJoe Perches ERROR("LO_MACRO", 2538000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 253942e41c54SMike Frysinger } 254042e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 254142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2542000d1cc1SJoe Perches ERROR("HI_MACRO", 2543000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 254442e41c54SMike Frysinger } 254542e41c54SMike Frysinger } 254642e41c54SMike Frysinger 2547b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2548de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 25490a920b5bSAndy Whitcroft 25500a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 25510a920b5bSAndy Whitcroft# more than 8 must use tabs. 2552c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2553c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2554c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2555d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25563705ce5bSJoe Perches if (ERROR("CODE_INDENT", 25573705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 25583705ce5bSJoe Perches $fix) { 2559194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 25603705ce5bSJoe Perches } 25610a920b5bSAndy Whitcroft } 25620a920b5bSAndy Whitcroft 256308e44365SAlberto Panizzo# check for space before tabs. 256408e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 256508e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25663705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 25673705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 25683705ce5bSJoe Perches $fix) { 2569194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2570d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2571194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2572c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 25733705ce5bSJoe Perches } 257408e44365SAlberto Panizzo } 257508e44365SAlberto Panizzo 2576d1fe9c09SJoe Perches# check for && or || at the start of a line 2577d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2578d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2579d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2580d1fe9c09SJoe Perches } 2581d1fe9c09SJoe Perches 2582d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2583d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 258491cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2585d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2586d1fe9c09SJoe Perches my $oldindent = $1; 2587d1fe9c09SJoe Perches my $rest = $2; 2588d1fe9c09SJoe Perches 2589d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2590d1fe9c09SJoe Perches if ($pos >= 0) { 2591b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2592b34a26f3SJoe Perches my $newindent = $2; 2593d1fe9c09SJoe Perches 2594d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2595d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2596d1fe9c09SJoe Perches " " x ($pos % 8); 2597d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2598d1fe9c09SJoe Perches 2599d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2600d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 26013705ce5bSJoe Perches 26023705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 26033705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 26043705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2605194f66fcSJoe Perches $fixed[$fixlinenr] =~ 26063705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 26073705ce5bSJoe Perches } 2608d1fe9c09SJoe Perches } 2609d1fe9c09SJoe Perches } 2610d1fe9c09SJoe Perches } 2611d1fe9c09SJoe Perches 26126ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 26136ab3a970SJoe Perches# avoid checking a few false positives: 26146ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 26156ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 26166ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 26176ab3a970SJoe Perches# multiline macros that define functions 26186ab3a970SJoe Perches# known attributes or the __attribute__ keyword 26196ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 26206ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 26213705ce5bSJoe Perches if (CHK("SPACING", 2622f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 26233705ce5bSJoe Perches $fix) { 2624194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2625f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 26263705ce5bSJoe Perches } 2627aad4f614SJoe Perches } 2628aad4f614SJoe Perches 262905880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2630fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 263185ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 263285ad978cSJoe Perches $realline > 2) { 263305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 263405880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 263505880600SJoe Perches } 263605880600SJoe Perches 263705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2638a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2639a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 264061135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2641a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2642a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2643a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2644a605e32eSJoe Perches } 2645a605e32eSJoe Perches 2646a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2647c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2648c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2649c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2650c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 265105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 265205880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 265305880600SJoe Perches } 265405880600SJoe Perches 26557f619191SJoe Perches# check for missing blank lines after struct/union declarations 26567f619191SJoe Perches# with exceptions for various attributes and macros 26577f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 26587f619191SJoe Perches $line =~ /^\+/ && 26597f619191SJoe Perches !($line =~ /^\+\s*$/ || 26607f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 26617f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 26627f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 26637f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 26647f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 26657f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 26667f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2667d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2668d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2669d752fcc8SJoe Perches $fix) { 2670f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2671d752fcc8SJoe Perches } 26727f619191SJoe Perches } 26737f619191SJoe Perches 2674365dd4eaSJoe Perches# check for multiple consecutive blank lines 2675365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2676365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2677365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2678d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2679d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2680d752fcc8SJoe Perches $fix) { 2681f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2682d752fcc8SJoe Perches } 2683d752fcc8SJoe Perches 2684365dd4eaSJoe Perches $last_blank_line = $linenr; 2685365dd4eaSJoe Perches } 2686365dd4eaSJoe Perches 26873b617e3bSJoe Perches# check for missing blank lines after declarations 26883f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 26893f7bac03SJoe Perches # actual declarations 26903f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 26915a4e1fd3SJoe Perches # function pointer declarations 26925a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 26933f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 26943f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 26953f7bac03SJoe Perches # known declaration macros 26963f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 26973f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 26983f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 26993f7bac03SJoe Perches # other possible extensions of declaration lines 27003f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 27013f7bac03SJoe Perches # not starting a section or a macro "\" extended line 27023f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 27033f7bac03SJoe Perches # looks like a declaration 27043f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 27055a4e1fd3SJoe Perches # function pointer declarations 27065a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 27073f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 27083f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 27093f7bac03SJoe Perches # known declaration macros 27103f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 27113f7bac03SJoe Perches # start of struct or union or enum 27123b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 27133f7bac03SJoe Perches # start or end of block or continuation of declaration 27143f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 27153f7bac03SJoe Perches # bitfield continuation 27163f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 27173f7bac03SJoe Perches # other possible extensions of declaration lines 27183f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 27193f7bac03SJoe Perches # indentation of previous and current line are the same 27203f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2721d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2722d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2723d752fcc8SJoe Perches $fix) { 2724f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2725d752fcc8SJoe Perches } 27263b617e3bSJoe Perches } 27273b617e3bSJoe Perches 27285f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 27296b4c5bebSAndy Whitcroft# Exceptions: 27306b4c5bebSAndy Whitcroft# 1) within comments 27316b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 27326b4c5bebSAndy Whitcroft# 3) hanging labels 27333705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 27345f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27353705ce5bSJoe Perches if (WARN("LEADING_SPACE", 27363705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 27373705ce5bSJoe Perches $fix) { 2738194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27393705ce5bSJoe Perches } 27405f7ddae6SRaffaele Recalcati } 27415f7ddae6SRaffaele Recalcati 2742b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2743b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2744b9ea10d6SAndy Whitcroft 2745032a4c0fSJoe Perches# check indentation of any line with a bare else 2746840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2747032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2748032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2749032a4c0fSJoe Perches my $tabs = length($1) + 1; 2750840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2751840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2752840080a0SJoe Perches defined $lines[$linenr] && 2753840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2754032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2755032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2756032a4c0fSJoe Perches } 2757032a4c0fSJoe Perches } 2758032a4c0fSJoe Perches 2759c00df19aSJoe Perches# check indentation of a line with a break; 2760c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2761c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2762c00df19aSJoe Perches my $tabs = $1; 2763c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2764c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2765c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2766c00df19aSJoe Perches } 2767c00df19aSJoe Perches } 2768c00df19aSJoe Perches 27691ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 27701ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 27711ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 27721ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 27731ba8dfd1SKees Cook } 27741ba8dfd1SKees Cook 2775c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2776cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2777000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2778000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2779c2fdda0dSAndy Whitcroft } 278022f2a2efSAndy Whitcroft 278142e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 278242e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 278342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2784000d1cc1SJoe Perches ERROR("CSYNC", 2785000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 278642e41c54SMike Frysinger } 278742e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 278842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2789000d1cc1SJoe Perches ERROR("SSYNC", 2790000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 279142e41c54SMike Frysinger } 279242e41c54SMike Frysinger 279356e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 279456e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 279556e77d70SJoe Perches WARN("HOTPLUG_SECTION", 279656e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 279756e77d70SJoe Perches } 279856e77d70SJoe Perches 27999c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 28002b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 28012b474a1aSAndy Whitcroft $realline_next); 28023e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 28033e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 28041b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2805170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2806f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2807171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2808171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2809171ae1a4SAndy Whitcroft 28103e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 28113e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 28123e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 28133e469cdcSAndy Whitcroft # until we hit end of it. 28143e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 28153e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 28163e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 28173e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 28183e469cdcSAndy Whitcroft } 2819f74bd194SAndy Whitcroft 28202b474a1aSAndy Whitcroft # Find the real next line. 28212b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 28222b474a1aSAndy Whitcroft if (defined $realline_next && 28232b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 28242b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 28252b474a1aSAndy Whitcroft $realline_next++; 28262b474a1aSAndy Whitcroft } 28272b474a1aSAndy Whitcroft 2828171ae1a4SAndy Whitcroft my $s = $stat; 2829171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2830cf655043SAndy Whitcroft 2831c2fdda0dSAndy Whitcroft # Ignore goto labels. 2832171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2833c2fdda0dSAndy Whitcroft 2834c2fdda0dSAndy Whitcroft # Ignore functions being called 2835171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2836c2fdda0dSAndy Whitcroft 2837463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2838463f2864SAndy Whitcroft 2839c45dcabdSAndy Whitcroft # declarations always start with types 2840d2506586SAndy 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) { 2841c45dcabdSAndy Whitcroft my $type = $1; 2842c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2843c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2844c45dcabdSAndy Whitcroft 28456c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2846a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2847c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2848c2fdda0dSAndy Whitcroft } 28498905a67cSAndy Whitcroft 28506c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 285165863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2852c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 28539c0ca6f9SAndy Whitcroft } 28548905a67cSAndy Whitcroft 28558905a67cSAndy Whitcroft # Check for any sort of function declaration. 28568905a67cSAndy Whitcroft # int foo(something bar, other baz); 28578905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2858171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 28598905a67cSAndy Whitcroft my ($name_len) = length($1); 28608905a67cSAndy Whitcroft 2861cf655043SAndy Whitcroft my $ctx = $s; 2862773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 28638905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2864cf655043SAndy Whitcroft 28658905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2866c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 28678905a67cSAndy Whitcroft 2868c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 28698905a67cSAndy Whitcroft } 28708905a67cSAndy Whitcroft } 28718905a67cSAndy Whitcroft } 28728905a67cSAndy Whitcroft 28739c0ca6f9SAndy Whitcroft } 28749c0ca6f9SAndy Whitcroft 287500df344fSAndy Whitcroft# 287600df344fSAndy Whitcroft# Checks which may be anchored in the context. 287700df344fSAndy Whitcroft# 287800df344fSAndy Whitcroft 287900df344fSAndy Whitcroft# Check for switch () and associated case and default 288000df344fSAndy Whitcroft# statements should be at the same indent. 288100df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 288200df344fSAndy Whitcroft my $err = ''; 288300df344fSAndy Whitcroft my $sep = ''; 288400df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 288500df344fSAndy Whitcroft shift(@ctx); 288600df344fSAndy Whitcroft for my $ctx (@ctx) { 288700df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 288800df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 288900df344fSAndy Whitcroft $indent != $cindent) { 289000df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 289100df344fSAndy Whitcroft $sep = ''; 289200df344fSAndy Whitcroft } else { 289300df344fSAndy Whitcroft $sep = "[...]\n"; 289400df344fSAndy Whitcroft } 289500df344fSAndy Whitcroft } 289600df344fSAndy Whitcroft if ($err ne '') { 2897000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2898000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2899de7d4f0eSAndy Whitcroft } 2900de7d4f0eSAndy Whitcroft } 2901de7d4f0eSAndy Whitcroft 2902de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2903de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 29040fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2905773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2906773647a0SAndy Whitcroft 29079c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 29088eef05ddSJoe Perches 29098eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 29108eef05ddSJoe Perches WARN("DEEP_INDENTATION", 29118eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 29128eef05ddSJoe Perches } 29138eef05ddSJoe Perches 2914de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2915de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2916de7d4f0eSAndy Whitcroft 2917548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2918548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2919de7d4f0eSAndy Whitcroft 2920548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2921548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2922548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2923548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2924548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2925773647a0SAndy Whitcroft $ctx_ln++; 2926773647a0SAndy Whitcroft } 2927548596d5SAndy Whitcroft 292853210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 292953210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2930773647a0SAndy Whitcroft 2931773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2932000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2933000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 293401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 293500df344fSAndy Whitcroft } 2936773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2937773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2938773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2939773647a0SAndy Whitcroft { 29409c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 29419c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2942000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2943000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 294401464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 29459c0ca6f9SAndy Whitcroft } 29469c0ca6f9SAndy Whitcroft } 294700df344fSAndy Whitcroft } 294800df344fSAndy Whitcroft 29494d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 29500fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 29513e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 29523e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 29533e469cdcSAndy Whitcroft if (!defined $stat); 29544d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 29554d001e4dSAndy Whitcroft 29564d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 29574d001e4dSAndy Whitcroft 29584d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 29594d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 29604d001e4dSAndy Whitcroft # where necessary. 29614d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 29624d001e4dSAndy Whitcroft 29634d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 29646f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 29656f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 29664d001e4dSAndy Whitcroft 29674d001e4dSAndy Whitcroft # We want to check the first line inside the block 29684d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 29694d001e4dSAndy Whitcroft # 1) any blank line termination 29704d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 29714d001e4dSAndy Whitcroft # 3) any do (...) { 29724d001e4dSAndy Whitcroft my $continuation = 0; 29734d001e4dSAndy Whitcroft my $check = 0; 29744d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 29754d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 29764d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 29774d001e4dSAndy Whitcroft $continuation = 1; 29784d001e4dSAndy Whitcroft } 29799bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 29804d001e4dSAndy Whitcroft $check = 1; 29814d001e4dSAndy Whitcroft $cond_lines++; 29824d001e4dSAndy Whitcroft } 29834d001e4dSAndy Whitcroft 29844d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 29854d001e4dSAndy Whitcroft # preprocessor statement. 29864d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 29874d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 29884d001e4dSAndy Whitcroft $check = 0; 29894d001e4dSAndy Whitcroft } 29904d001e4dSAndy Whitcroft 29919bd49efeSAndy Whitcroft my $cond_ptr = -1; 2992740504c6SAndy Whitcroft $continuation = 0; 29939bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 29949bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 29954d001e4dSAndy Whitcroft 2996f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2997f16fa28fSAndy Whitcroft # is not linear. 2998f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2999f16fa28fSAndy Whitcroft $check = 0; 3000f16fa28fSAndy Whitcroft } 3001f16fa28fSAndy Whitcroft 30029bd49efeSAndy Whitcroft # Ignore: 30039bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 30049bd49efeSAndy Whitcroft # 2) preprocessor lines, and 30059bd49efeSAndy Whitcroft # 3) labels. 3006740504c6SAndy Whitcroft if ($continuation || 3007740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 30089bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 30099bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3010740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 301130dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 30129bd49efeSAndy Whitcroft $cond_lines++; 30139bd49efeSAndy Whitcroft } 30144d001e4dSAndy Whitcroft } 301530dad6ebSAndy Whitcroft } 30164d001e4dSAndy Whitcroft 30174d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 30184d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 30194d001e4dSAndy Whitcroft 30204d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 30214d001e4dSAndy Whitcroft # this is not this patch's fault. 30224d001e4dSAndy Whitcroft if (!defined($stat_real) || 30234d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 30244d001e4dSAndy Whitcroft $check = 0; 30254d001e4dSAndy Whitcroft } 30264d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 30274d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 30284d001e4dSAndy Whitcroft } 30294d001e4dSAndy Whitcroft 30309bd49efeSAndy 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"; 30314d001e4dSAndy Whitcroft 30324d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 30334d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 3034000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3035000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 30364d001e4dSAndy Whitcroft } 30374d001e4dSAndy Whitcroft } 30384d001e4dSAndy Whitcroft 30396c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 30406c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 30411f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 30421f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 30436c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3044c2fdda0dSAndy Whitcroft if ($dbg_values) { 3045c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3046cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3047cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 30481f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3049c2fdda0dSAndy Whitcroft } 30506c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 30516c72ffaaSAndy Whitcroft 305200df344fSAndy Whitcroft#ignore lines not being added 30533705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 305400df344fSAndy Whitcroft 3055653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 30567429c690SAndy Whitcroft if ($dbg_type) { 30577429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3058000d1cc1SJoe Perches ERROR("TEST_TYPE", 3059000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 30607429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3061000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3062000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 30637429c690SAndy Whitcroft } 3064653d4876SAndy Whitcroft next; 3065653d4876SAndy Whitcroft } 3066a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3067a1ef277eSAndy Whitcroft if ($dbg_attr) { 30689360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3069000d1cc1SJoe Perches ERROR("TEST_ATTR", 3070000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 30719360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3072000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3073000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3074a1ef277eSAndy Whitcroft } 3075a1ef277eSAndy Whitcroft next; 3076a1ef277eSAndy Whitcroft } 3077653d4876SAndy Whitcroft 3078f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 307999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 308099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3081d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3082d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3083f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3084f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3085f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3086d752fcc8SJoe Perches my $fixedline = $prevrawline; 3087d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3088f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3089d752fcc8SJoe Perches $fixedline = $line; 3090d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3091f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3092d752fcc8SJoe Perches } 3093f0a594c1SAndy Whitcroft } 3094f0a594c1SAndy Whitcroft 309500df344fSAndy Whitcroft# 309600df344fSAndy Whitcroft# Checks which are anchored on the added line. 309700df344fSAndy Whitcroft# 309800df344fSAndy Whitcroft 3099653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3100c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3101653d4876SAndy Whitcroft my $path = $1; 3102653d4876SAndy Whitcroft if ($path =~ m{//}) { 3103000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3104495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3105495e9d84SJoe Perches } 3106495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3107495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3108495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3109653d4876SAndy Whitcroft } 3110653d4876SAndy Whitcroft } 3111653d4876SAndy Whitcroft 311200df344fSAndy Whitcroft# no C99 // comments 311300df344fSAndy Whitcroft if ($line =~ m{//}) { 31143705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 31153705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 31163705ce5bSJoe Perches $fix) { 3117194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 31183705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 31193705ce5bSJoe Perches my $comment = trim($1); 3120194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 31213705ce5bSJoe Perches } 31223705ce5bSJoe Perches } 312300df344fSAndy Whitcroft } 312400df344fSAndy Whitcroft # Remove C99 comments. 31250a920b5bSAndy Whitcroft $line =~ s@//.*@@; 31266c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 31270a920b5bSAndy Whitcroft 31282b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 31292b474a1aSAndy Whitcroft# the whole statement. 31302b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 31312b474a1aSAndy Whitcroft if (defined $realline_next && 31322b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 31332b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 31342b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 31352b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 31363cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 31373cbf62dfSAndy Whitcroft # a prefix: 31383cbf62dfSAndy Whitcroft # XXX(foo); 31393cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3140653d4876SAndy Whitcroft my $name = $1; 314187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 31423cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 31433cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 31443cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 31453cbf62dfSAndy Whitcroft 31463cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 31472b474a1aSAndy Whitcroft \n.}\s*$| 314848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 314948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 315048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 31512b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 31522b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 315348012058SAndy Whitcroft )/x) { 31542b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 31552b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 31562b474a1aSAndy Whitcroft } else { 31572b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 31580a920b5bSAndy Whitcroft } 31590a920b5bSAndy Whitcroft } 31602b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 31612b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 31622b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 31632b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 31642b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 31652b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 31662b474a1aSAndy Whitcroft } 31672b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 31682b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3169000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3170000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 31712b474a1aSAndy Whitcroft } 31720a920b5bSAndy Whitcroft 31735150bda4SJoe Eloff# check for global initialisers. 31745129e87cSJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) { 3175d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3176000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3177d5e616fcSJoe Perches $herecurr) && 3178d5e616fcSJoe Perches $fix) { 31795129e87cSJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/; 3180d5e616fcSJoe Perches } 3181f0a594c1SAndy Whitcroft } 31820a920b5bSAndy Whitcroft# check for static initialisers. 3183d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3184d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3185000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3186d5e616fcSJoe Perches $herecurr) && 3187d5e616fcSJoe Perches $fix) { 3188194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3189d5e616fcSJoe Perches } 31900a920b5bSAndy Whitcroft } 31910a920b5bSAndy Whitcroft 31921813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 31931813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 31941813087dSJoe Perches my $tmp = trim($1); 31951813087dSJoe Perches WARN("MISORDERED_TYPE", 31961813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 31971813087dSJoe Perches } 31981813087dSJoe Perches 3199cb710ecaSJoe Perches# check for static const char * arrays. 3200cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3201000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3202000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3203cb710ecaSJoe Perches $herecurr); 3204cb710ecaSJoe Perches } 3205cb710ecaSJoe Perches 3206cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3207cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3208000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3209000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3210cb710ecaSJoe Perches $herecurr); 3211cb710ecaSJoe Perches } 3212cb710ecaSJoe Perches 3213ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3214ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3215ab7e23f3SJoe Perches my $found = $1; 3216ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3217ab7e23f3SJoe Perches WARN("CONST_CONST", 3218ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3219ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3220ab7e23f3SJoe Perches WARN("CONST_CONST", 3221ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3222ab7e23f3SJoe Perches } 3223ab7e23f3SJoe Perches } 3224ab7e23f3SJoe Perches 32259b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 32269b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 32279b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 32289b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 32299b0fa60dSJoe Perches $herecurr); 32309b0fa60dSJoe Perches } 32319b0fa60dSJoe Perches 3232b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3233b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3234b598b670SJoe Perches my $array = $1; 3235b598b670SJoe Perches if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) { 3236b598b670SJoe Perches my $array_div = $1; 3237b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3238b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3239b598b670SJoe Perches $fix) { 3240b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3241b598b670SJoe Perches } 3242b598b670SJoe Perches } 3243b598b670SJoe Perches } 3244b598b670SJoe Perches 3245b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3246b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3247b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3248b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3249b36190c5SJoe Perches $fix) { 3250194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3251b36190c5SJoe Perches } 3252b36190c5SJoe Perches } 3253b36190c5SJoe Perches 325492e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 325592e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 325692e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 325792e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 325892e112fdSJoe Perches $fix) { 3259194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 326092e112fdSJoe Perches } 326193ed0e2dSJoe Perches } 326293ed0e2dSJoe Perches 3263653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3264653d4876SAndy Whitcroft# make sense. 3265653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 32668054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3267c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 32688ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3269653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3270000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3271000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 32720a920b5bSAndy Whitcroft } 32730a920b5bSAndy Whitcroft 32740a920b5bSAndy Whitcroft# * goes on variable not on type 327565863862SAndy Whitcroft # (char*[ const]) 3276bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3277bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 32783705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3279d8aaf121SAndy Whitcroft 328065863862SAndy Whitcroft # Should start with a space. 328165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 328265863862SAndy Whitcroft # Should not end with a space. 328365863862SAndy Whitcroft $to =~ s/\s+$//; 328465863862SAndy Whitcroft # '*'s should not have spaces between. 3285f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 328665863862SAndy Whitcroft } 3287d8aaf121SAndy Whitcroft 32883705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 328965863862SAndy Whitcroft if ($from ne $to) { 32903705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 32913705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 32923705ce5bSJoe Perches $fix) { 32933705ce5bSJoe Perches my $sub_from = $ident; 32943705ce5bSJoe Perches my $sub_to = $ident; 32953705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3296194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32973705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 32983705ce5bSJoe Perches } 329965863862SAndy Whitcroft } 3300bfcb2cc7SAndy Whitcroft } 3301bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3302bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 33033705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3304d8aaf121SAndy Whitcroft 330565863862SAndy Whitcroft # Should start with a space. 330665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 330765863862SAndy Whitcroft # Should not end with a space. 330865863862SAndy Whitcroft $to =~ s/\s+$//; 330965863862SAndy Whitcroft # '*'s should not have spaces between. 3310f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 331165863862SAndy Whitcroft } 331265863862SAndy Whitcroft # Modifiers should have spaces. 331365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 331465863862SAndy Whitcroft 33153705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3316667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 33173705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 33183705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 33193705ce5bSJoe Perches $fix) { 33203705ce5bSJoe Perches 33213705ce5bSJoe Perches my $sub_from = $match; 33223705ce5bSJoe Perches my $sub_to = $match; 33233705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3324194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33253705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 33263705ce5bSJoe Perches } 332765863862SAndy Whitcroft } 33280a920b5bSAndy Whitcroft } 33290a920b5bSAndy Whitcroft 33300a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 33310a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 33320a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 33330a920b5bSAndy Whitcroft# print "$herecurr"; 33340a920b5bSAndy Whitcroft# $clean = 0; 33350a920b5bSAndy Whitcroft# } 33360a920b5bSAndy Whitcroft 33378905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3338000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3339000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 33408905a67cSAndy Whitcroft } 33418905a67cSAndy Whitcroft 334217441227SJoe Perches# check for uses of printk_ratelimit 334317441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3344000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3345000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 334617441227SJoe Perches } 334717441227SJoe Perches 334800df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 334900df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 335000df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 335125985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 335200df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3353f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 335400df344fSAndy Whitcroft my $ok = 0; 335500df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 335600df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 335725985edcSLucas De Marchi # we have a preceding printk if it ends 335800df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 335900df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 336000df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 336100df344fSAndy Whitcroft $ok = 1; 336200df344fSAndy Whitcroft } 336300df344fSAndy Whitcroft last; 336400df344fSAndy Whitcroft } 336500df344fSAndy Whitcroft } 336600df344fSAndy Whitcroft if ($ok == 0) { 3367000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3368000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 33690a920b5bSAndy Whitcroft } 337000df344fSAndy Whitcroft } 33710a920b5bSAndy Whitcroft 3372243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3373243f3803SJoe Perches my $orig = $1; 3374243f3803SJoe Perches my $level = lc($orig); 3375243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 33768f26b837SJoe Perches my $level2 = $level; 33778f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3378243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3379daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3380243f3803SJoe Perches } 3381243f3803SJoe Perches 3382243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3383d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3384d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3385d5e616fcSJoe Perches $fix) { 3386194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3387d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3388d5e616fcSJoe Perches } 3389243f3803SJoe Perches } 3390243f3803SJoe Perches 3391dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3392dc139313SJoe Perches my $orig = $1; 3393dc139313SJoe Perches my $level = lc($orig); 3394dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3395dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3396dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3397dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3398dc139313SJoe Perches } 3399dc139313SJoe Perches 340091c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 340191c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 340291c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 340391c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 340491c9afafSAndy Lutomirski WARN("ENOSYS", 340591c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 340691c9afafSAndy Lutomirski } 340791c9afafSAndy Lutomirski 3408653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3409653d4876SAndy Whitcroft# or if closed on same line 34108d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3411c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 34128d182478SJoe Perches if (ERROR("OPEN_BRACE", 34138d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 34148d182478SJoe Perches $fix) { 34158d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 34168d182478SJoe Perches my $fixed_line = $rawline; 34178d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 34188d182478SJoe Perches my $line1 = $1; 34198d182478SJoe Perches my $line2 = $2; 34208d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 34218d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 34228d182478SJoe Perches if ($line2 !~ /^\s*$/) { 34238d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 34248d182478SJoe Perches } 34258d182478SJoe Perches } 34260a920b5bSAndy Whitcroft } 3427653d4876SAndy Whitcroft 34288905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 34298905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 34308905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 34318d182478SJoe Perches if (ERROR("OPEN_BRACE", 34328d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 34338d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 34348d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 34358d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 34368d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 34378d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 34388d182478SJoe Perches $fixedline = $rawline; 34398d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 34408d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 34418d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 34428d182478SJoe Perches } 34438d182478SJoe Perches } 34448905a67cSAndy Whitcroft } 34458905a67cSAndy Whitcroft 34460c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 34473705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 34483705ce5bSJoe Perches if (WARN("SPACING", 34493705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 34503705ce5bSJoe Perches $fix) { 3451194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34523705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 34533705ce5bSJoe Perches } 34540c73b4ebSAndy Whitcroft } 34550c73b4ebSAndy Whitcroft 345631070b5dSJoe Perches# Function pointer declarations 345731070b5dSJoe Perches# check spacing between type, funcptr, and args 345831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 345991f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 346031070b5dSJoe Perches my $declare = $1; 346131070b5dSJoe Perches my $pre_pointer_space = $2; 346231070b5dSJoe Perches my $post_pointer_space = $3; 346331070b5dSJoe Perches my $funcname = $4; 346431070b5dSJoe Perches my $post_funcname_space = $5; 346531070b5dSJoe Perches my $pre_args_space = $6; 346631070b5dSJoe Perches 346791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 346891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 346991f72e9cSJoe Perches# don't need a space so don't warn for those. 347091f72e9cSJoe Perches my $post_declare_space = ""; 347191f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 347291f72e9cSJoe Perches $post_declare_space = $1; 347391f72e9cSJoe Perches $declare = rtrim($declare); 347491f72e9cSJoe Perches } 347591f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 347631070b5dSJoe Perches WARN("SPACING", 347731070b5dSJoe Perches "missing space after return type\n" . $herecurr); 347891f72e9cSJoe Perches $post_declare_space = " "; 347931070b5dSJoe Perches } 348031070b5dSJoe Perches 348131070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 348291f72e9cSJoe Perches# This test is not currently implemented because these declarations are 348391f72e9cSJoe Perches# equivalent to 348491f72e9cSJoe Perches# int foo(int bar, ...) 348591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 348691f72e9cSJoe Perches# 348791f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 348891f72e9cSJoe Perches# WARN("SPACING", 348991f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 349091f72e9cSJoe Perches# } 349131070b5dSJoe Perches 349231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 349331070b5dSJoe Perches if (defined $pre_pointer_space && 349431070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 349531070b5dSJoe Perches WARN("SPACING", 349631070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 349731070b5dSJoe Perches } 349831070b5dSJoe Perches 349931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 350031070b5dSJoe Perches if (defined $post_pointer_space && 350131070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 350231070b5dSJoe Perches WARN("SPACING", 350331070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 350431070b5dSJoe Perches } 350531070b5dSJoe Perches 350631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 350731070b5dSJoe Perches if (defined $post_funcname_space && 350831070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 350931070b5dSJoe Perches WARN("SPACING", 351031070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 351131070b5dSJoe Perches } 351231070b5dSJoe Perches 351331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 351431070b5dSJoe Perches if (defined $pre_args_space && 351531070b5dSJoe Perches $pre_args_space =~ /^\s/) { 351631070b5dSJoe Perches WARN("SPACING", 351731070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 351831070b5dSJoe Perches } 351931070b5dSJoe Perches 352031070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3521194f66fcSJoe Perches $fixed[$fixlinenr] =~ 352291f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 352331070b5dSJoe Perches } 352431070b5dSJoe Perches } 352531070b5dSJoe Perches 35268d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 35278d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3528fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3529fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 35308d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 35318d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 35328d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3533fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3534daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 35353705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 35363705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 35373705ce5bSJoe Perches $fix) { 3538194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35393705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 35403705ce5bSJoe Perches } 35418d31cfceSAndy Whitcroft } 35428d31cfceSAndy Whitcroft } 35438d31cfceSAndy Whitcroft 3544f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 35456c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3546c2fdda0dSAndy Whitcroft my $name = $1; 3547773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3548773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3549c2fdda0dSAndy Whitcroft 3550c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3551773647a0SAndy Whitcroft if ($name =~ /^(?: 3552773647a0SAndy Whitcroft if|for|while|switch|return|case| 3553773647a0SAndy Whitcroft volatile|__volatile__| 3554773647a0SAndy Whitcroft __attribute__|format|__extension__| 3555773647a0SAndy Whitcroft asm|__asm__)$/x) 3556773647a0SAndy Whitcroft { 3557c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3558c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3559c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3560c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3561773647a0SAndy Whitcroft 3562773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3563c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3564c2fdda0dSAndy Whitcroft 3565c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3566c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3567773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3568c2fdda0dSAndy Whitcroft 3569c2fdda0dSAndy Whitcroft } else { 35703705ce5bSJoe Perches if (WARN("SPACING", 35713705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 35723705ce5bSJoe Perches $fix) { 3573194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35743705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 35753705ce5bSJoe Perches } 3576f0a594c1SAndy Whitcroft } 35776c72ffaaSAndy Whitcroft } 35789a4cad4eSEric Nelson 3579653d4876SAndy Whitcroft# Check operator spacing. 35800a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 35813705ce5bSJoe Perches my $fixed_line = ""; 35823705ce5bSJoe Perches my $line_fixed = 0; 35833705ce5bSJoe Perches 35849c0ca6f9SAndy Whitcroft my $ops = qr{ 35859c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 35869c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 35879c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 35881f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 358984731623SJoe Perches \?:|\?|: 35909c0ca6f9SAndy Whitcroft }x; 3591cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 35923705ce5bSJoe Perches 35933705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 35943705ce5bSJoe Perches## foreach my $el (@elements) { 35953705ce5bSJoe Perches## print("el: <$el>\n"); 35963705ce5bSJoe Perches## } 35973705ce5bSJoe Perches 35983705ce5bSJoe Perches my @fix_elements = (); 359900df344fSAndy Whitcroft my $off = 0; 36006c72ffaaSAndy Whitcroft 36013705ce5bSJoe Perches foreach my $el (@elements) { 36023705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 36033705ce5bSJoe Perches $off += length($el); 36043705ce5bSJoe Perches } 36053705ce5bSJoe Perches 36063705ce5bSJoe Perches $off = 0; 36073705ce5bSJoe Perches 36086c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3609b34c648bSJoe Perches my $last_after = -1; 36106c72ffaaSAndy Whitcroft 36110a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 36123705ce5bSJoe Perches 36133705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 36143705ce5bSJoe Perches 36153705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 36163705ce5bSJoe Perches 36174a0df2efSAndy Whitcroft $off += length($elements[$n]); 36184a0df2efSAndy Whitcroft 361925985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3620773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3621773647a0SAndy Whitcroft my $cc = ''; 3622773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3623773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3624773647a0SAndy Whitcroft } 3625773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3626773647a0SAndy Whitcroft 36274a0df2efSAndy Whitcroft my $a = ''; 36284a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 36294a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3630cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 36314a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 36324a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3633773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 36344a0df2efSAndy Whitcroft 36350a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 36364a0df2efSAndy Whitcroft 36374a0df2efSAndy Whitcroft my $c = ''; 36380a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 36394a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 36404a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3641cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 36424a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 36434a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 36448b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 36454a0df2efSAndy Whitcroft } else { 36464a0df2efSAndy Whitcroft $c = 'E'; 36470a920b5bSAndy Whitcroft } 36480a920b5bSAndy Whitcroft 36494a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 36504a0df2efSAndy Whitcroft 36514a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 36524a0df2efSAndy Whitcroft 36536c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3654de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 36550a920b5bSAndy Whitcroft 365674048ed8SAndy Whitcroft # Pull out the value of this operator. 36576c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 36580a920b5bSAndy Whitcroft 36591f65f947SAndy Whitcroft # Get the full operator variant. 36601f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 36611f65f947SAndy Whitcroft 366213214adfSAndy Whitcroft # Ignore operators passed as parameters. 366313214adfSAndy Whitcroft if ($op_type ne 'V' && 3664d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 366513214adfSAndy Whitcroft 3666cf655043SAndy Whitcroft# # Ignore comments 3667cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 366813214adfSAndy Whitcroft 3669d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 367013214adfSAndy Whitcroft } elsif ($op eq ';') { 3671cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3672cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 36733705ce5bSJoe Perches if (ERROR("SPACING", 36743705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3675b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 36763705ce5bSJoe Perches $line_fixed = 1; 36773705ce5bSJoe Perches } 3678d8aaf121SAndy Whitcroft } 3679d8aaf121SAndy Whitcroft 3680d8aaf121SAndy Whitcroft # // is a comment 3681d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 36820a920b5bSAndy Whitcroft 3683b00e4814SJoe Perches # : when part of a bitfield 3684b00e4814SJoe Perches } elsif ($opv eq ':B') { 3685b00e4814SJoe Perches # skip the bitfield test for now 3686b00e4814SJoe Perches 36871f65f947SAndy Whitcroft # No spaces for: 36881f65f947SAndy Whitcroft # -> 3689b00e4814SJoe Perches } elsif ($op eq '->') { 36904a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 36913705ce5bSJoe Perches if (ERROR("SPACING", 36923705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3693b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 36943705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 36953705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 36963705ce5bSJoe Perches } 3697b34c648bSJoe Perches $line_fixed = 1; 36983705ce5bSJoe Perches } 36990a920b5bSAndy Whitcroft } 37000a920b5bSAndy Whitcroft 37012381097bSJoe Perches # , must not have a space before and must have a space on the right. 37020a920b5bSAndy Whitcroft } elsif ($op eq ',') { 37032381097bSJoe Perches my $rtrim_before = 0; 37042381097bSJoe Perches my $space_after = 0; 37052381097bSJoe Perches if ($ctx =~ /Wx./) { 37062381097bSJoe Perches if (ERROR("SPACING", 37072381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 37082381097bSJoe Perches $line_fixed = 1; 37092381097bSJoe Perches $rtrim_before = 1; 37102381097bSJoe Perches } 37112381097bSJoe Perches } 3712cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 37133705ce5bSJoe Perches if (ERROR("SPACING", 37143705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 37153705ce5bSJoe Perches $line_fixed = 1; 3716b34c648bSJoe Perches $last_after = $n; 37172381097bSJoe Perches $space_after = 1; 37182381097bSJoe Perches } 37192381097bSJoe Perches } 37202381097bSJoe Perches if ($rtrim_before || $space_after) { 37212381097bSJoe Perches if ($rtrim_before) { 37222381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37232381097bSJoe Perches } else { 37242381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 37252381097bSJoe Perches } 37262381097bSJoe Perches if ($space_after) { 37272381097bSJoe Perches $good .= " "; 37283705ce5bSJoe Perches } 37290a920b5bSAndy Whitcroft } 37300a920b5bSAndy Whitcroft 37319c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 373274048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 37339c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 37349c0ca6f9SAndy Whitcroft 37359c0ca6f9SAndy Whitcroft # unary operators should have a space before and 37369c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 37379c0ca6f9SAndy Whitcroft # unary operator, or a cast 37389c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 373974048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 37400d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3741cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 37423705ce5bSJoe Perches if (ERROR("SPACING", 37433705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3744b34c648bSJoe Perches if ($n != $last_after + 2) { 3745b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 37463705ce5bSJoe Perches $line_fixed = 1; 37473705ce5bSJoe Perches } 37480a920b5bSAndy Whitcroft } 3749b34c648bSJoe Perches } 3750a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3751171ae1a4SAndy Whitcroft # A unary '*' may be const 3752171ae1a4SAndy Whitcroft 3753171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 37543705ce5bSJoe Perches if (ERROR("SPACING", 37553705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3756b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 37573705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37583705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 37593705ce5bSJoe Perches } 3760b34c648bSJoe Perches $line_fixed = 1; 37613705ce5bSJoe Perches } 37620a920b5bSAndy Whitcroft } 37630a920b5bSAndy Whitcroft 37640a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 37650a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3766773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 37673705ce5bSJoe Perches if (ERROR("SPACING", 37683705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3769b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 37703705ce5bSJoe Perches $line_fixed = 1; 37713705ce5bSJoe Perches } 37720a920b5bSAndy Whitcroft } 3773773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3774773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 37753705ce5bSJoe Perches if (ERROR("SPACING", 37763705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3777b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37783705ce5bSJoe Perches $line_fixed = 1; 37793705ce5bSJoe Perches } 3780653d4876SAndy Whitcroft } 3781773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 37823705ce5bSJoe Perches if (ERROR("SPACING", 37833705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3784b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 37853705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37863705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3787773647a0SAndy Whitcroft } 3788b34c648bSJoe Perches $line_fixed = 1; 37893705ce5bSJoe Perches } 37903705ce5bSJoe Perches } 37910a920b5bSAndy Whitcroft 37920a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 37939c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 37949c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 37959c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3796c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3797c2fdda0dSAndy Whitcroft $op eq '%') 37980a920b5bSAndy Whitcroft { 3799d2e025f3SJoe Perches if ($check) { 3800d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3801d2e025f3SJoe Perches if (CHK("SPACING", 3802d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3803d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3804d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3805d2e025f3SJoe Perches $line_fixed = 1; 3806d2e025f3SJoe Perches } 3807d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3808d2e025f3SJoe Perches if (CHK("SPACING", 3809d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3810d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3811d2e025f3SJoe Perches $line_fixed = 1; 3812d2e025f3SJoe Perches } 3813d2e025f3SJoe Perches } 3814d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 38153705ce5bSJoe Perches if (ERROR("SPACING", 38163705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3817b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3818b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3819b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3820b34c648bSJoe Perches } 38213705ce5bSJoe Perches $line_fixed = 1; 38223705ce5bSJoe Perches } 38230a920b5bSAndy Whitcroft } 38240a920b5bSAndy Whitcroft 38251f65f947SAndy Whitcroft # A colon needs no spaces before when it is 38261f65f947SAndy Whitcroft # terminating a case value or a label. 38271f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 38281f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 38293705ce5bSJoe Perches if (ERROR("SPACING", 38303705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3831b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38323705ce5bSJoe Perches $line_fixed = 1; 38333705ce5bSJoe Perches } 38341f65f947SAndy Whitcroft } 38351f65f947SAndy Whitcroft 38360a920b5bSAndy Whitcroft # All the others need spaces both sides. 3837cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 38381f65f947SAndy Whitcroft my $ok = 0; 38391f65f947SAndy Whitcroft 384022f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 38411f65f947SAndy Whitcroft if (($op eq '<' && 38421f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 38431f65f947SAndy Whitcroft ($op eq '>' && 38441f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 38451f65f947SAndy Whitcroft { 38461f65f947SAndy Whitcroft $ok = 1; 38471f65f947SAndy Whitcroft } 38481f65f947SAndy Whitcroft 3849e0df7e1fSJoe Perches # for asm volatile statements 3850e0df7e1fSJoe Perches # ignore a colon with another 3851e0df7e1fSJoe Perches # colon immediately before or after 3852e0df7e1fSJoe Perches if (($op eq ':') && 3853e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 3854e0df7e1fSJoe Perches $ok = 1; 3855e0df7e1fSJoe Perches } 3856e0df7e1fSJoe Perches 385784731623SJoe Perches # messages are ERROR, but ?: are CHK 38581f65f947SAndy Whitcroft if ($ok == 0) { 385984731623SJoe Perches my $msg_type = \&ERROR; 386084731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 386184731623SJoe Perches 386284731623SJoe Perches if (&{$msg_type}("SPACING", 38633705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3864b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3865b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3866b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3867b34c648bSJoe Perches } 38683705ce5bSJoe Perches $line_fixed = 1; 38693705ce5bSJoe Perches } 38700a920b5bSAndy Whitcroft } 387122f2a2efSAndy Whitcroft } 38724a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 38733705ce5bSJoe Perches 38743705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 38753705ce5bSJoe Perches 38763705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 38770a920b5bSAndy Whitcroft } 38783705ce5bSJoe Perches 38793705ce5bSJoe Perches if (($#elements % 2) == 0) { 38803705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 38813705ce5bSJoe Perches } 38823705ce5bSJoe Perches 3883194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3884194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 38853705ce5bSJoe Perches } 38863705ce5bSJoe Perches 38873705ce5bSJoe Perches 38880a920b5bSAndy Whitcroft } 38890a920b5bSAndy Whitcroft 3890786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3891d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3892786b6326SJoe Perches if (WARN("SPACING", 3893786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3894786b6326SJoe Perches $fix) { 3895194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3896786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3897786b6326SJoe Perches } 3898786b6326SJoe Perches } 3899786b6326SJoe Perches 3900f0a594c1SAndy Whitcroft# check for multiple assignments 3901f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3902000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3903000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3904f0a594c1SAndy Whitcroft } 3905f0a594c1SAndy Whitcroft 390622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 390722f2a2efSAndy Whitcroft## # continuation. 390822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 390922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 391022f2a2efSAndy Whitcroft## 391122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 391222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 391322f2a2efSAndy Whitcroft## my $ln = $line; 391422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 391522f2a2efSAndy Whitcroft## } 391622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3917000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3918000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 391922f2a2efSAndy Whitcroft## } 392022f2a2efSAndy Whitcroft## } 3921f0a594c1SAndy Whitcroft 39220a920b5bSAndy Whitcroft#need space before brace following if, while, etc 392322f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 392422f2a2efSAndy Whitcroft $line =~ /do{/) { 39253705ce5bSJoe Perches if (ERROR("SPACING", 39263705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 39273705ce5bSJoe Perches $fix) { 3928194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 39293705ce5bSJoe Perches } 3930de7d4f0eSAndy Whitcroft } 3931de7d4f0eSAndy Whitcroft 3932c4a62ef9SJoe Perches## # check for blank lines before declarations 3933c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3934c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3935c4a62ef9SJoe Perches## WARN("SPACING", 3936c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3937c4a62ef9SJoe Perches## } 3938c4a62ef9SJoe Perches## 3939c4a62ef9SJoe Perches 3940de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3941de7d4f0eSAndy Whitcroft# on the line 3942de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3943d5e616fcSJoe Perches if (ERROR("SPACING", 3944d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3945d5e616fcSJoe Perches $fix) { 3946194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3947d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3948d5e616fcSJoe Perches } 39490a920b5bSAndy Whitcroft } 39500a920b5bSAndy Whitcroft 395122f2a2efSAndy Whitcroft# check spacing on square brackets 395222f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 39533705ce5bSJoe Perches if (ERROR("SPACING", 39543705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 39553705ce5bSJoe Perches $fix) { 3956194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39573705ce5bSJoe Perches s/\[\s+/\[/; 39583705ce5bSJoe Perches } 395922f2a2efSAndy Whitcroft } 396022f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 39613705ce5bSJoe Perches if (ERROR("SPACING", 39623705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 39633705ce5bSJoe Perches $fix) { 3964194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39653705ce5bSJoe Perches s/\s+\]/\]/; 39663705ce5bSJoe Perches } 396722f2a2efSAndy Whitcroft } 396822f2a2efSAndy Whitcroft 3969c45dcabdSAndy Whitcroft# check spacing on parentheses 39709c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 39719c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 39723705ce5bSJoe Perches if (ERROR("SPACING", 39733705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 39743705ce5bSJoe Perches $fix) { 3975194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39763705ce5bSJoe Perches s/\(\s+/\(/; 39773705ce5bSJoe Perches } 397822f2a2efSAndy Whitcroft } 397913214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3980c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3981c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 39823705ce5bSJoe Perches if (ERROR("SPACING", 39833705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 39843705ce5bSJoe Perches $fix) { 3985194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39863705ce5bSJoe Perches s/\s+\)/\)/; 39873705ce5bSJoe Perches } 398822f2a2efSAndy Whitcroft } 398922f2a2efSAndy Whitcroft 3990e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 3991e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 3992e2826fd0SJoe Perches 3993e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 3994ea4acbb1SJoe Perches my $var = $1; 3995ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3996ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 3997ea4acbb1SJoe Perches $fix) { 3998ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 3999ea4acbb1SJoe Perches } 4000ea4acbb1SJoe Perches } 4001ea4acbb1SJoe Perches 4002ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4003ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4004ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4005ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4006ea4acbb1SJoe Perches my $var = $2; 4007ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4008ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4009ea4acbb1SJoe Perches $fix) { 4010ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4011ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4012ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4013ea4acbb1SJoe Perches } 4014e2826fd0SJoe Perches } 4015e2826fd0SJoe Perches 40160a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 40174a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 40180a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 40193705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 40203705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 40213705ce5bSJoe Perches $fix) { 4022194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40233705ce5bSJoe Perches s/^(.)\s+/$1/; 40243705ce5bSJoe Perches } 40250a920b5bSAndy Whitcroft } 40260a920b5bSAndy Whitcroft 40275b9553abSJoe Perches# return is not a function 4028507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4029c45dcabdSAndy Whitcroft my $spacing = $1; 4030507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 40315b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 40325b9553abSJoe Perches my $value = $1; 40335b9553abSJoe Perches $value = deparenthesize($value); 40345b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4035000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4036000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 40375b9553abSJoe Perches } 4038c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4039000d1cc1SJoe Perches ERROR("SPACING", 4040000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4041c45dcabdSAndy Whitcroft } 4042c45dcabdSAndy Whitcroft } 4043507e5141SJoe Perches 4044b43ae21bSJoe Perches# unnecessary return in a void function 4045b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4046b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4047b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4048b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4049b43ae21bSJoe Perches $linenr >= 3 && 4050b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4051b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 40529819cf25SJoe Perches WARN("RETURN_VOID", 4053b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 40549819cf25SJoe Perches } 40559819cf25SJoe Perches 4056189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4057189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4058189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4059189248d8SJoe Perches my $openparens = $1; 4060189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4061189248d8SJoe Perches my $msg = ""; 4062189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4063189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4064189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4065189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4066189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4067189248d8SJoe Perches } 4068189248d8SJoe Perches } 4069189248d8SJoe Perches 4070f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4071f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 407253a3c448SAndy Whitcroft my $name = $1; 407353a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4074000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4075f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 407653a3c448SAndy Whitcroft } 407753a3c448SAndy Whitcroft } 4078c45dcabdSAndy Whitcroft 40790a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 40804a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 40813705ce5bSJoe Perches if (ERROR("SPACING", 40823705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 40833705ce5bSJoe Perches $fix) { 4084194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40853705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 40863705ce5bSJoe Perches } 40870a920b5bSAndy Whitcroft } 40880a920b5bSAndy Whitcroft 4089f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4090f5fe35ddSAndy Whitcroft# statements after the conditional. 4091170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 40923e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 40933e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 40943e469cdcSAndy Whitcroft if (!defined $stat); 4095170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4096170d3a22SAndy Whitcroft $remain_next, $off_next); 4097170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4098170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4099170d3a22SAndy Whitcroft 4100170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4101170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4102170d3a22SAndy Whitcroft # then count those as offsets. 4103170d3a22SAndy Whitcroft my ($whitespace) = 4104170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4105170d3a22SAndy Whitcroft my $offset = 4106170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4107170d3a22SAndy Whitcroft 4108170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4109170d3a22SAndy Whitcroft $offset} = 1; 4110170d3a22SAndy Whitcroft } 4111170d3a22SAndy Whitcroft } 4112170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4113c11230f4SJoe Perches defined($stat) && defined($cond) && 4114170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4115171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 41168905a67cSAndy Whitcroft 4117b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4118000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4119000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 41208905a67cSAndy Whitcroft } 41218905a67cSAndy Whitcroft 41228905a67cSAndy Whitcroft # Find out what is on the end of the line after the 41238905a67cSAndy Whitcroft # conditional. 4124773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 41258905a67cSAndy Whitcroft $s =~ s/\n.*//g; 412613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 412753210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 412853210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4129773647a0SAndy Whitcroft { 4130bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4131bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4132bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 413342bdf74cSHidetoshi Seto my $stat_real = ''; 4134bb44ad39SAndy Whitcroft 413542bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 413642bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4137bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4138bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4139bb44ad39SAndy Whitcroft } 4140bb44ad39SAndy Whitcroft 4141000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4142000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 41438905a67cSAndy Whitcroft } 41448905a67cSAndy Whitcroft } 41458905a67cSAndy Whitcroft 414613214adfSAndy Whitcroft# Check for bitwise tests written as boolean 414713214adfSAndy Whitcroft if ($line =~ / 414813214adfSAndy Whitcroft (?: 414913214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 415013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 415113214adfSAndy Whitcroft (?:\&\&|\|\|) 415213214adfSAndy Whitcroft | 415313214adfSAndy Whitcroft (?:\&\&|\|\|) 415413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 415513214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 415613214adfSAndy Whitcroft )/x) 415713214adfSAndy Whitcroft { 4158000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4159000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 416013214adfSAndy Whitcroft } 416113214adfSAndy Whitcroft 41628905a67cSAndy Whitcroft# if and else should not have general statements after it 416313214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 416413214adfSAndy Whitcroft my $s = $1; 416513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 416613214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4167000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4168000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 41690a920b5bSAndy Whitcroft } 417013214adfSAndy Whitcroft } 417139667782SAndy Whitcroft# if should not continue a brace 417239667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4173000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4174048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 417539667782SAndy Whitcroft $herecurr); 417639667782SAndy Whitcroft } 4177a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4178a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4179a1080bf8SAndy Whitcroft $line !~ /\G(?: 41803fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4181a1080bf8SAndy Whitcroft \s*return\s+ 4182a1080bf8SAndy Whitcroft )/xg) 4183a1080bf8SAndy Whitcroft { 4184000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4185000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4186a1080bf8SAndy Whitcroft } 41870a920b5bSAndy Whitcroft 41880a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 41890a920b5bSAndy Whitcroft # indent level to be relevant to each other. 41908b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 41910a920b5bSAndy Whitcroft $previndent == $indent) { 41928b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 41938b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 41948b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 41958b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 41968b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 41978b8856f4SJoe Perches my $fixedline = $prevrawline; 41988b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 41998b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 42008b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42018b8856f4SJoe Perches } 42028b8856f4SJoe Perches $fixedline = $rawline; 42038b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 42048b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42058b8856f4SJoe Perches } 42060a920b5bSAndy Whitcroft } 42070a920b5bSAndy Whitcroft 42088b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4209c2fdda0dSAndy Whitcroft $previndent == $indent) { 4210c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4211c2fdda0dSAndy Whitcroft 4212c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4213c2fdda0dSAndy Whitcroft # conditional. 4214773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4215c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4216c2fdda0dSAndy Whitcroft 4217c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 42188b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 42198b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 42208b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42218b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42228b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 42238b8856f4SJoe Perches my $fixedline = $prevrawline; 42248b8856f4SJoe Perches my $trailing = $rawline; 42258b8856f4SJoe Perches $trailing =~ s/^\+//; 42268b8856f4SJoe Perches $trailing = trim($trailing); 42278b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 42288b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42298b8856f4SJoe Perches } 4230c2fdda0dSAndy Whitcroft } 4231c2fdda0dSAndy Whitcroft } 4232c2fdda0dSAndy Whitcroft 423395e2c602SJoe Perches#Specific variable tests 4234323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4235323c1260SJoe Perches my $var = $1; 423695e2c602SJoe Perches 423795e2c602SJoe Perches#gcc binary extension 423895e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4239d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4240d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4241d5e616fcSJoe Perches $fix) { 4242d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4243194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4244d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4245d5e616fcSJoe Perches } 424695e2c602SJoe Perches } 424795e2c602SJoe Perches 424895e2c602SJoe Perches#CamelCase 4249807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4250be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 425122735ce8SJoe Perches#Ignore Page<foo> variants 4252807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 425322735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4254f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4255f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4256f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 42577e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 42587e781f67SJoe Perches my $word = $1; 42597e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4260d8b07710SJoe Perches if ($check) { 4261d8b07710SJoe Perches seed_camelcase_includes(); 4262d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4263d8b07710SJoe Perches seed_camelcase_file($realfile); 4264d8b07710SJoe Perches $camelcase_file_seeded = 1; 4265d8b07710SJoe Perches } 4266d8b07710SJoe Perches } 42677e781f67SJoe Perches if (!defined $camelcase{$word}) { 42687e781f67SJoe Perches $camelcase{$word} = 1; 4269be79794bSJoe Perches CHK("CAMELCASE", 42707e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 42717e781f67SJoe Perches } 4272323c1260SJoe Perches } 4273323c1260SJoe Perches } 42743445686aSJoe Perches } 42750a920b5bSAndy Whitcroft 42760a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4277d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4278d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4279d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4280d5e616fcSJoe Perches $fix) { 4281194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4282d5e616fcSJoe Perches } 42830a920b5bSAndy Whitcroft } 42840a920b5bSAndy Whitcroft 42850e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 42860e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4287c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4288e09dec48SAndy Whitcroft my $file = "$1.h"; 4289e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4290e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4291e09dec48SAndy Whitcroft $realfile ne $checkfile && 42927840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4293c45dcabdSAndy Whitcroft { 42940e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 42950e212e0aSFabian Frederick if ($asminclude > 0) { 4296e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4297000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4298000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4299e09dec48SAndy Whitcroft } else { 4300000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4301000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4302e09dec48SAndy Whitcroft } 43030a920b5bSAndy Whitcroft } 43040a920b5bSAndy Whitcroft } 43050e212e0aSFabian Frederick } 43060a920b5bSAndy Whitcroft 4307653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4308653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4309cf655043SAndy Whitcroft# in a known good container 4310b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4311b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4312d8aaf121SAndy Whitcroft my $ln = $linenr; 4313d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4314c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4315c45dcabdSAndy Whitcroft my $ctx = ''; 431608a2843eSJoe Perches my $has_flow_statement = 0; 431708a2843eSJoe Perches my $has_arg_concat = 0; 4318c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4319f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4320f74bd194SAndy Whitcroft $ctx = $dstat; 4321c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4322a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4323c45dcabdSAndy Whitcroft 432408a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 432508a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 432608a2843eSJoe Perches 4327f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4328292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4329c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4330c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4331c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4332c45dcabdSAndy Whitcroft 4333c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4334bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4335bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4336c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4337bf30d6edSAndy Whitcroft { 4338c45dcabdSAndy Whitcroft } 4339c45dcabdSAndy Whitcroft 4340e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 4341e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 4342e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 4343e45bab8eSAndy Whitcroft { 4344e45bab8eSAndy Whitcroft } 4345e45bab8eSAndy Whitcroft 4346c45dcabdSAndy Whitcroft my $exceptions = qr{ 4347c45dcabdSAndy Whitcroft $Declare| 4348c45dcabdSAndy Whitcroft module_param_named| 4349a0a0a7a9SKees Cook MODULE_PARM_DESC| 4350c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4351c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4352383099fdSAndy Whitcroft __typeof__\(| 435322fd2d3eSStefani Seibold union| 435422fd2d3eSStefani Seibold struct| 4355ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4356ea71a0a0SAndy Whitcroft ^\"|\"$ 4357c45dcabdSAndy Whitcroft }x; 43585eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4359f74bd194SAndy Whitcroft if ($dstat ne '' && 4360f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4361f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 43623cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4363356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4364f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4365f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4366e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 436772f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4368f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4369f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4370f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4371f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4372f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4373c45dcabdSAndy Whitcroft { 4374f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4375f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4376f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4377f74bd194SAndy Whitcroft 4378f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4379f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4380c45dcabdSAndy Whitcroft } 4381c45dcabdSAndy Whitcroft 4382f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4383f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4384f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4385f74bd194SAndy Whitcroft } else { 4386000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4387388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4388d8aaf121SAndy Whitcroft } 43890a920b5bSAndy Whitcroft } 43905023d347SJoe Perches 439108a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 439208a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 439308a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 439408a2843eSJoe Perches my $herectx = $here . "\n"; 439508a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 439608a2843eSJoe Perches 439708a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 439808a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 439908a2843eSJoe Perches } 440008a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 440108a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 440208a2843eSJoe Perches } 440308a2843eSJoe Perches 4404481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 44055023d347SJoe Perches 44065023d347SJoe Perches } else { 44075023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4408481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4409481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 44105023d347SJoe Perches $line =~ /^\+.*\\$/) { 44115023d347SJoe Perches WARN("LINE_CONTINUATIONS", 44125023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 44135023d347SJoe Perches } 4414653d4876SAndy Whitcroft } 44150a920b5bSAndy Whitcroft 4416b13edf7fSJoe Perches# do {} while (0) macro tests: 4417b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4418b13edf7fSJoe Perches# macro should not end with a semicolon 4419b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4420b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4421b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4422b13edf7fSJoe Perches my $ln = $linenr; 4423b13edf7fSJoe Perches my $cnt = $realcnt; 4424b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4425b13edf7fSJoe Perches my $ctx = ''; 4426b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4427b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4428b13edf7fSJoe Perches $ctx = $dstat; 4429b13edf7fSJoe Perches 4430b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 44311b36b201SJoe Perches $dstat =~ s/$;/ /g; 4432b13edf7fSJoe Perches 4433b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4434b13edf7fSJoe Perches my $stmts = $2; 4435b13edf7fSJoe Perches my $semis = $3; 4436b13edf7fSJoe Perches 4437b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4438b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4439b13edf7fSJoe Perches my $herectx = $here . "\n"; 4440b13edf7fSJoe Perches 4441b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4442b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4443b13edf7fSJoe Perches } 4444b13edf7fSJoe Perches 4445ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4446ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4447b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4448b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4449b13edf7fSJoe Perches } 4450b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4451b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4452b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4453b13edf7fSJoe Perches } 4454f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4455f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4456f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4457f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4458f5ef95b1SJoe Perches 4459f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4460f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4461f5ef95b1SJoe Perches } 4462f5ef95b1SJoe Perches 4463f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4464f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4465b13edf7fSJoe Perches } 4466b13edf7fSJoe Perches } 4467b13edf7fSJoe Perches 4468080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4469080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4470080ba929SMike Frysinger# . 4471080ba929SMike Frysinger# ALIGN(...) 4472080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4473080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4474000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4475000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4476080ba929SMike Frysinger } 4477080ba929SMike Frysinger 4478f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 447913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 448013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4481cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 448213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4483cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4484cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4485aad4f614SJoe Perches my @allowed = (); 4486aad4f614SJoe Perches my $allow = 0; 448713214adfSAndy Whitcroft my $seen = 0; 4488773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4489cf655043SAndy Whitcroft my $ln = $linenr - 1; 449013214adfSAndy Whitcroft for my $chunk (@chunks) { 449113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 449213214adfSAndy Whitcroft 4493773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4494773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4495773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4496773647a0SAndy Whitcroft 4497aad4f614SJoe Perches $allowed[$allow] = 0; 4498773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4499773647a0SAndy Whitcroft 4500773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4501773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4502773647a0SAndy Whitcroft 4503773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4504cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4505cf655043SAndy Whitcroft 4506773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 450713214adfSAndy Whitcroft 450813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 450913214adfSAndy Whitcroft 4510aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4511cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4512cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4513aad4f614SJoe Perches $allowed[$allow] = 1; 451413214adfSAndy Whitcroft } 451513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4516cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4517aad4f614SJoe Perches $allowed[$allow] = 1; 451813214adfSAndy Whitcroft } 4519cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4520cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4521aad4f614SJoe Perches $allowed[$allow] = 1; 452213214adfSAndy Whitcroft } 4523aad4f614SJoe Perches $allow++; 452413214adfSAndy Whitcroft } 4525aad4f614SJoe Perches if ($seen) { 4526aad4f614SJoe Perches my $sum_allowed = 0; 4527aad4f614SJoe Perches foreach (@allowed) { 4528aad4f614SJoe Perches $sum_allowed += $_; 4529aad4f614SJoe Perches } 4530aad4f614SJoe Perches if ($sum_allowed == 0) { 4531000d1cc1SJoe Perches WARN("BRACES", 4532000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4533aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4534aad4f614SJoe Perches $seen != $allow) { 4535aad4f614SJoe Perches CHK("BRACES", 4536aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4537aad4f614SJoe Perches } 453813214adfSAndy Whitcroft } 453913214adfSAndy Whitcroft } 454013214adfSAndy Whitcroft } 4541773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 454213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4543cf655043SAndy Whitcroft my $allowed = 0; 4544f0a594c1SAndy Whitcroft 4545cf655043SAndy Whitcroft # Check the pre-context. 4546cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4547cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4548cf655043SAndy Whitcroft $allowed = 1; 4549f0a594c1SAndy Whitcroft } 4550773647a0SAndy Whitcroft 4551773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4552773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4553773647a0SAndy Whitcroft 4554cf655043SAndy Whitcroft # Check the condition. 4555cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4556773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4557cf655043SAndy Whitcroft if (defined $cond) { 4558773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4559cf655043SAndy Whitcroft } 4560cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4561cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4562cf655043SAndy Whitcroft $allowed = 1; 4563cf655043SAndy Whitcroft } 4564cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4565cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4566cf655043SAndy Whitcroft $allowed = 1; 4567cf655043SAndy Whitcroft } 4568cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4569cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4570cf655043SAndy Whitcroft $allowed = 1; 4571cf655043SAndy Whitcroft } 4572cf655043SAndy Whitcroft # Check the post-context. 4573cf655043SAndy Whitcroft if (defined $chunks[1]) { 4574cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4575cf655043SAndy Whitcroft if (defined $cond) { 4576773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4577cf655043SAndy Whitcroft } 4578cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4579cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4580cf655043SAndy Whitcroft $allowed = 1; 4581cf655043SAndy Whitcroft } 4582cf655043SAndy Whitcroft } 4583cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 458469932487SJustin P. Mattock my $herectx = $here . "\n"; 4585f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4586cf655043SAndy Whitcroft 4587f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 458869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4589cf655043SAndy Whitcroft } 4590cf655043SAndy Whitcroft 4591000d1cc1SJoe Perches WARN("BRACES", 4592000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4593f0a594c1SAndy Whitcroft } 4594f0a594c1SAndy Whitcroft } 4595f0a594c1SAndy Whitcroft 45960979ae66SJoe Perches# check for unnecessary blank lines around braces 459777b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4598f8e58219SJoe Perches if (CHK("BRACES", 4599f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4600f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4601f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4602f8e58219SJoe Perches } 46030979ae66SJoe Perches } 460477b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4605f8e58219SJoe Perches if (CHK("BRACES", 4606f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4607f8e58219SJoe Perches $fix) { 4608f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4609f8e58219SJoe Perches } 46100979ae66SJoe Perches } 46110979ae66SJoe Perches 46124a0df2efSAndy Whitcroft# no volatiles please 46136c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 46146c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4615000d1cc1SJoe Perches WARN("VOLATILE", 4616000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 46174a0df2efSAndy Whitcroft } 46184a0df2efSAndy Whitcroft 46195e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 46205e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 46215e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 46225e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 46235e4f6ba5SJoe Perches if ($line =~ /^\+\s*"[X\t]*"/ && 46245e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 46255e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 46265e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 46275e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 46285e4f6ba5SJoe Perches $fix && 46295e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 46305e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 46315e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 46325e4f6ba5SJoe Perches my $comma_close = ""; 46335e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 46345e4f6ba5SJoe Perches $comma_close = $1; 46355e4f6ba5SJoe Perches } 46365e4f6ba5SJoe Perches 46375e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 46385e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 46395e4f6ba5SJoe Perches my $fixedline = $prevrawline; 46405e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 46415e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 46425e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 46435e4f6ba5SJoe Perches $fixedline = $rawline; 46445e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 46455e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 46465e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 46475e4f6ba5SJoe Perches } 46485e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 46495e4f6ba5SJoe Perches } 46505e4f6ba5SJoe Perches } 46515e4f6ba5SJoe Perches 46525e4f6ba5SJoe Perches# check for missing a space in a string concatenation 46535e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 46545e4f6ba5SJoe Perches WARN('MISSING_SPACE', 46555e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 46565e4f6ba5SJoe Perches } 46575e4f6ba5SJoe Perches 46585e4f6ba5SJoe Perches# check for spaces before a quoted newline 46595e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 46605e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 46615e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 46625e4f6ba5SJoe Perches $fix) { 46635e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 46645e4f6ba5SJoe Perches } 46655e4f6ba5SJoe Perches 46665e4f6ba5SJoe Perches } 46675e4f6ba5SJoe Perches 4668f17dba4fSJoe Perches# concatenated string without spaces between elements 4669f17dba4fSJoe Perches if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) { 4670f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4671f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4672f17dba4fSJoe Perches } 4673f17dba4fSJoe Perches 467490ad30e5SJoe Perches# uncoalesced string fragments 467590ad30e5SJoe Perches if ($line =~ /"X*"\s*"/) { 467690ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 467790ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 467890ad30e5SJoe Perches } 467990ad30e5SJoe Perches 46805e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 46815e4f6ba5SJoe Perches my $string; 46825e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 46835e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 46845e4f6ba5SJoe Perches $string =~ s/%%/__/g; 46855e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 46865e4f6ba5SJoe Perches WARN("PRINTF_L", 46875e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 46885e4f6ba5SJoe Perches last; 46895e4f6ba5SJoe Perches } 46905e4f6ba5SJoe Perches } 46915e4f6ba5SJoe Perches 46925e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 46935e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 46945e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 46955e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 46965e4f6ba5SJoe Perches } 46975e4f6ba5SJoe Perches 469800df344fSAndy Whitcroft# warn about #if 0 4699c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4700000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4701000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4702de7d4f0eSAndy Whitcroft $herecurr); 47034a0df2efSAndy Whitcroft } 47044a0df2efSAndy Whitcroft 470503df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 470603df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 470703df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 470803df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 470903df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 471015160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 47114c432a8fSGreg Kroah-Hartman } 47124c432a8fSGreg Kroah-Hartman } 4713f0a594c1SAndy Whitcroft 4714ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4715ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4716ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4717ebfdc409SJoe Perches (defined $1 || defined $3) && 4718ebfdc409SJoe Perches $linenr > 3) { 4719ebfdc409SJoe Perches my $testval = $2; 4720ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4721ebfdc409SJoe Perches 4722ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4723ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4724ebfdc409SJoe Perches 4725ebfdc409SJoe 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)/) { 4726ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4727ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4728ebfdc409SJoe Perches } 4729ebfdc409SJoe Perches } 4730ebfdc409SJoe Perches 4731f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4732dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4733f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4734f78d98f6SJoe Perches my $level = $1; 4735f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4736f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4737f78d98f6SJoe Perches $fix) { 4738f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4739f78d98f6SJoe Perches } 4740f78d98f6SJoe Perches } 4741f78d98f6SJoe Perches 4742abb08a53SJoe Perches# check for mask then right shift without a parentheses 4743abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4744abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4745abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4746abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4747abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4748abb08a53SJoe Perches } 4749abb08a53SJoe Perches 4750b75ac618SJoe Perches# check for pointer comparisons to NULL 4751b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4752b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4753b75ac618SJoe Perches my $val = $1; 4754b75ac618SJoe Perches my $equal = "!"; 4755b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4756b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4757b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4758b75ac618SJoe Perches $fix) { 4759b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4760b75ac618SJoe Perches } 4761b75ac618SJoe Perches } 4762b75ac618SJoe Perches } 4763b75ac618SJoe Perches 47648716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 47658716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 47668716de38SJoe Perches my $attr = $1; 47678716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 47688716de38SJoe Perches my $ptr = $1; 47698716de38SJoe Perches my $var = $2; 47708716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 47718716de38SJoe Perches ERROR("MISPLACED_INIT", 47728716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 47738716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 47748716de38SJoe Perches WARN("MISPLACED_INIT", 47758716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 47768716de38SJoe Perches $fix) { 4777194f66fcSJoe 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; 47788716de38SJoe Perches } 47798716de38SJoe Perches } 47808716de38SJoe Perches } 47818716de38SJoe Perches 4782e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4783e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4784e970b884SJoe Perches my $attr = $1; 4785e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4786e970b884SJoe Perches my $attr_prefix = $1; 4787e970b884SJoe Perches my $attr_type = $2; 4788e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4789e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4790e970b884SJoe Perches $fix) { 4791194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4792e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4793e970b884SJoe Perches } 4794e970b884SJoe Perches } 4795e970b884SJoe Perches 4796e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4797e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4798e970b884SJoe Perches my $attr = $1; 4799e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4800e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4801e970b884SJoe Perches $fix) { 4802194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4803e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4804e970b884SJoe Perches $lead = rtrim($1); 4805e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4806e970b884SJoe Perches $lead = "${lead}const "; 4807194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4808e970b884SJoe Perches } 4809e970b884SJoe Perches } 4810e970b884SJoe Perches 4811c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 4812c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 4813c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 4814c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 4815c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 4816c17893c7SJoe Perches $fix) { 4817c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 4818c17893c7SJoe Perches } 4819c17893c7SJoe Perches } 4820c17893c7SJoe Perches 4821fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4822fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4823fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4824fbdb8138SJoe Perches my $constant_func = $1; 4825fbdb8138SJoe Perches my $func = $constant_func; 4826fbdb8138SJoe Perches $func =~ s/^__constant_//; 4827fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4828fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4829fbdb8138SJoe Perches $fix) { 4830194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4831fbdb8138SJoe Perches } 4832fbdb8138SJoe Perches } 4833fbdb8138SJoe Perches 48341a15a250SPatrick Pannuto# prefer usleep_range over udelay 483537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 483643c1d77cSJoe Perches my $delay = $1; 48371a15a250SPatrick Pannuto # ignore udelay's < 10, however 483843c1d77cSJoe Perches if (! ($delay < 10) ) { 4839000d1cc1SJoe Perches CHK("USLEEP_RANGE", 484043c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 484143c1d77cSJoe Perches } 484243c1d77cSJoe Perches if ($delay > 2000) { 484343c1d77cSJoe Perches WARN("LONG_UDELAY", 484443c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 48451a15a250SPatrick Pannuto } 48461a15a250SPatrick Pannuto } 48471a15a250SPatrick Pannuto 484809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 484909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 485009ef8725SPatrick Pannuto if ($1 < 20) { 4851000d1cc1SJoe Perches WARN("MSLEEP", 485243c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 485309ef8725SPatrick Pannuto } 485409ef8725SPatrick Pannuto } 485509ef8725SPatrick Pannuto 485636ec1939SJoe Perches# check for comparisons of jiffies 485736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 485836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 485936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 486036ec1939SJoe Perches } 486136ec1939SJoe Perches 48629d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 48639d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 48649d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 48659d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 48669d7a34a5SJoe Perches } 48679d7a34a5SJoe Perches 486800df344fSAndy Whitcroft# warn about #ifdefs in C files 4869c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 487000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 487100df344fSAndy Whitcroft# print "$herecurr"; 487200df344fSAndy Whitcroft# $clean = 0; 487300df344fSAndy Whitcroft# } 487400df344fSAndy Whitcroft 487522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4876c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 48773705ce5bSJoe Perches if (ERROR("SPACING", 48783705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 48793705ce5bSJoe Perches $fix) { 4880194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48813705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 48823705ce5bSJoe Perches } 48833705ce5bSJoe Perches 488422f2a2efSAndy Whitcroft } 488522f2a2efSAndy Whitcroft 48864a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4887171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4888171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 48894a0df2efSAndy Whitcroft my $which = $1; 48904a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4891000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4892000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 48934a0df2efSAndy Whitcroft } 48944a0df2efSAndy Whitcroft } 48954a0df2efSAndy Whitcroft# check for memory barriers without a comment. 48964a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 48974a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4898c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4899000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 49004a0df2efSAndy Whitcroft } 49014a0df2efSAndy Whitcroft } 4902cb426e99SJoe Perches# check for waitqueue_active without a comment. 4903cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 4904cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 4905cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 4906cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 4907cb426e99SJoe Perches } 4908cb426e99SJoe Perches } 49094a0df2efSAndy Whitcroft# check of hardware specific defines 4910c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4911000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4912000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 49130a920b5bSAndy Whitcroft } 4914653d4876SAndy Whitcroft 4915d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4916d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4917000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4918000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4919d4977c78STobias Klauser } 4920d4977c78STobias Klauser 4921de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4922de7d4f0eSAndy Whitcroft# storage class and type. 49239c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 49249c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4925000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4926000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4927de7d4f0eSAndy Whitcroft } 4928de7d4f0eSAndy Whitcroft 49298905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 49302b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49312b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4932d5e616fcSJoe Perches if (WARN("INLINE", 4933d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4934d5e616fcSJoe Perches $fix) { 4935194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 4936d5e616fcSJoe Perches 4937d5e616fcSJoe Perches } 49388905a67cSAndy Whitcroft } 49398905a67cSAndy Whitcroft 49403d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 49412b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49422b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4943000d1cc1SJoe Perches WARN("PREFER_PACKED", 4944000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 49453d130fd0SJoe Perches } 49463d130fd0SJoe Perches 494739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 49482b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49492b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4950000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4951000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 495239b7e287SJoe Perches } 495339b7e287SJoe Perches 49545f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 49552b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49562b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4957d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4958d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4959d5e616fcSJoe Perches $fix) { 4960194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4961d5e616fcSJoe Perches 4962d5e616fcSJoe Perches } 49635f14d3bdSJoe Perches } 49645f14d3bdSJoe Perches 49656061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 49662b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49672b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4968d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4969d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4970d5e616fcSJoe Perches $fix) { 4971194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4972d5e616fcSJoe Perches } 49736061d949SJoe Perches } 49746061d949SJoe Perches 4975619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 4976619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 4977619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 4978619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 4979619a908aSJoe Perches $line =~ /\b__weak\b/)) { 4980619a908aSJoe Perches ERROR("WEAK_DECLARATION", 4981619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 4982619a908aSJoe Perches } 4983619a908aSJoe Perches 4984*e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 4985*e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 4986*e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 4987*e6176fa4SJoe Perches my $type = $1; 4988*e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 4989*e6176fa4SJoe Perches $type = $1; 4990*e6176fa4SJoe Perches my $kernel_type = 'u'; 4991*e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 4992*e6176fa4SJoe Perches $type =~ /(\d+)/; 4993*e6176fa4SJoe Perches $kernel_type .= $1; 4994*e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 4995*e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 4996*e6176fa4SJoe Perches $fix) { 4997*e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 4998*e6176fa4SJoe Perches } 4999*e6176fa4SJoe Perches } 5000*e6176fa4SJoe Perches } 5001*e6176fa4SJoe Perches 50028f53a9b8SJoe Perches# check for sizeof(&) 50038f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5004000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5005000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 50068f53a9b8SJoe Perches } 50078f53a9b8SJoe Perches 500866c80b60SJoe Perches# check for sizeof without parenthesis 500966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5010d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5011d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5012d5e616fcSJoe Perches $fix) { 5013194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5014d5e616fcSJoe Perches } 501566c80b60SJoe Perches } 501666c80b60SJoe Perches 501788982feaSJoe Perches# check for struct spinlock declarations 501888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 501988982feaSJoe Perches WARN("USE_SPINLOCK_T", 502088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 502188982feaSJoe Perches } 502288982feaSJoe Perches 5023a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 502406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5025a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5026caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5027caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5028d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5029d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5030d5e616fcSJoe Perches $fix) { 5031194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5032d5e616fcSJoe Perches } 5033a6962d72SJoe Perches } 5034a6962d72SJoe Perches } 5035a6962d72SJoe Perches 5036554e165cSAndy Whitcroft# Check for misused memsets 5037d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5038d1fe9c09SJoe Perches defined $stat && 5039d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 5040554e165cSAndy Whitcroft 5041d7c76ba7SJoe Perches my $ms_addr = $2; 5042d1fe9c09SJoe Perches my $ms_val = $7; 5043d1fe9c09SJoe Perches my $ms_size = $12; 5044d7c76ba7SJoe Perches 5045554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5046554e165cSAndy Whitcroft ERROR("MEMSET", 5047d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5048554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5049554e165cSAndy Whitcroft WARN("MEMSET", 5050d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5051d7c76ba7SJoe Perches } 5052d7c76ba7SJoe Perches } 5053d7c76ba7SJoe Perches 505498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 505598a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 505698a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 505798a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 505898a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 505998a9bba5SJoe Perches $fix) { 5060194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 506198a9bba5SJoe Perches } 506298a9bba5SJoe Perches } 506398a9bba5SJoe Perches 5064d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5065d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5066d1fe9c09SJoe Perches defined $stat && 5067d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5068d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5069d7c76ba7SJoe Perches my $call = $1; 5070d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5071d7c76ba7SJoe Perches my $arg1 = $3; 5072d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5073d1fe9c09SJoe Perches my $arg2 = $8; 5074d7c76ba7SJoe Perches my $cast; 5075d7c76ba7SJoe Perches 5076d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5077d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5078d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5079d7c76ba7SJoe Perches $cast = $cast1; 5080d7c76ba7SJoe Perches } else { 5081d7c76ba7SJoe Perches $cast = $cast2; 5082d7c76ba7SJoe Perches } 5083d7c76ba7SJoe Perches WARN("MINMAX", 5084d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5085554e165cSAndy Whitcroft } 5086554e165cSAndy Whitcroft } 5087554e165cSAndy Whitcroft 50884a273195SJoe Perches# check usleep_range arguments 50894a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 50904a273195SJoe Perches defined $stat && 50914a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 50924a273195SJoe Perches my $min = $1; 50934a273195SJoe Perches my $max = $7; 50944a273195SJoe Perches if ($min eq $max) { 50954a273195SJoe Perches WARN("USLEEP_RANGE", 50964a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 50974a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 50984a273195SJoe Perches $min > $max) { 50994a273195SJoe Perches WARN("USLEEP_RANGE", 51004a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 51014a273195SJoe Perches } 51024a273195SJoe Perches } 51034a273195SJoe Perches 5104823b794cSJoe Perches# check for naked sscanf 5105823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5106823b794cSJoe Perches defined $stat && 51076c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5108823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5109823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5110823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5111823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5112823b794cSJoe Perches $lc = $lc + $linenr; 5113823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5114823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5115823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5116823b794cSJoe Perches } 5117823b794cSJoe Perches WARN("NAKED_SSCANF", 5118823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5119823b794cSJoe Perches } 5120823b794cSJoe Perches 5121afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5122afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5123afc819abSJoe Perches defined $stat && 5124afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5125afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5126afc819abSJoe Perches $lc = $lc + $linenr; 5127afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5128afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5129afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5130afc819abSJoe Perches } 5131afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5132afc819abSJoe Perches my $format = $6; 5133afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5134afc819abSJoe Perches if ($count == 1 && 5135afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5136afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5137afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5138afc819abSJoe Perches } 5139afc819abSJoe Perches } 5140afc819abSJoe Perches } 5141afc819abSJoe Perches 514270dc8a48SJoe Perches# check for new externs in .h files. 514370dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 514470dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5145d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 514670dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 514770dc8a48SJoe Perches $fix) { 5148194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 514970dc8a48SJoe Perches } 515070dc8a48SJoe Perches } 515170dc8a48SJoe Perches 5152de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5153171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5154c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5155171ae1a4SAndy Whitcroft { 5156c45dcabdSAndy Whitcroft my $function_name = $1; 5157c45dcabdSAndy Whitcroft my $paren_space = $2; 5158171ae1a4SAndy Whitcroft 5159171ae1a4SAndy Whitcroft my $s = $stat; 5160171ae1a4SAndy Whitcroft if (defined $cond) { 5161171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5162171ae1a4SAndy Whitcroft } 5163c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5164c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5165c45dcabdSAndy Whitcroft { 5166000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5167000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5168de7d4f0eSAndy Whitcroft } 5169de7d4f0eSAndy Whitcroft 5170171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5171000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5172000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5173171ae1a4SAndy Whitcroft } 51749c9ba34eSAndy Whitcroft 51759c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 51769c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 51779c9ba34eSAndy Whitcroft { 5178000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5179000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5180171ae1a4SAndy Whitcroft } 5181171ae1a4SAndy Whitcroft 5182de7d4f0eSAndy Whitcroft# checks for new __setup's 5183de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5184de7d4f0eSAndy Whitcroft my $name = $1; 5185de7d4f0eSAndy Whitcroft 5186de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5187000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5188000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5189de7d4f0eSAndy Whitcroft } 5190653d4876SAndy Whitcroft } 51919c0ca6f9SAndy Whitcroft 51929c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5193caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5194000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5195000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 51969c0ca6f9SAndy Whitcroft } 519713214adfSAndy Whitcroft 5198a640d25cSJoe Perches# alloc style 5199a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5200a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5201a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5202a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5203a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5204a640d25cSJoe Perches } 5205a640d25cSJoe Perches 520660a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 520760a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5208e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 520960a55369SJoe Perches my $oldfunc = $3; 521060a55369SJoe Perches my $a1 = $4; 521160a55369SJoe Perches my $a2 = $10; 521260a55369SJoe Perches my $newfunc = "kmalloc_array"; 521360a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 521460a55369SJoe Perches my $r1 = $a1; 521560a55369SJoe Perches my $r2 = $a2; 521660a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 521760a55369SJoe Perches $r1 = $a2; 521860a55369SJoe Perches $r2 = $a1; 521960a55369SJoe Perches } 5220e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5221e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5222e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5223e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5224e367455aSJoe Perches $fix) { 5225194f66fcSJoe 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; 522660a55369SJoe Perches 522760a55369SJoe Perches } 522860a55369SJoe Perches } 522960a55369SJoe Perches } 523060a55369SJoe Perches 5231972fdea2SJoe Perches# check for krealloc arg reuse 5232972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5233972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5234972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5235972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5236972fdea2SJoe Perches } 5237972fdea2SJoe Perches 52385ce59ae0SJoe Perches# check for alloc argument mismatch 52395ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 52405ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 52415ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 52425ce59ae0SJoe Perches } 52435ce59ae0SJoe Perches 5244caf2a54fSJoe Perches# check for multiple semicolons 5245caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5246d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5247d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5248d5e616fcSJoe Perches $fix) { 5249194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5250d5e616fcSJoe Perches } 5251d1e2ad07SJoe Perches } 5252d1e2ad07SJoe Perches 52530ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 52540ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 52550ab90191SJoe Perches my $ull = ""; 52560ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 52570ab90191SJoe Perches if (CHK("BIT_MACRO", 52580ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 52590ab90191SJoe Perches $fix) { 52600ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 52610ab90191SJoe Perches } 52620ab90191SJoe Perches } 52630ab90191SJoe Perches 5264e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5265c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5266c34c09a8SJoe Perches my $has_break = 0; 5267c34c09a8SJoe Perches my $has_statement = 0; 5268c34c09a8SJoe Perches my $count = 0; 5269c34c09a8SJoe Perches my $prevline = $linenr; 5270e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5271c34c09a8SJoe Perches $prevline--; 5272c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5273c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5274c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5275c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5276c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5277c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5278c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5279c34c09a8SJoe Perches $has_statement = 1; 5280c34c09a8SJoe Perches $count++; 5281c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5282c34c09a8SJoe Perches } 5283c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5284c34c09a8SJoe Perches WARN("MISSING_BREAK", 5285c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5286c34c09a8SJoe Perches } 5287c34c09a8SJoe Perches } 5288c34c09a8SJoe Perches 5289d1e2ad07SJoe Perches# check for switch/default statements without a break; 5290d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5291d1e2ad07SJoe Perches defined $stat && 5292d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5293d1e2ad07SJoe Perches my $ctx = ''; 5294d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5295d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5296d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5297d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5298d1e2ad07SJoe Perches } 5299d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5300d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5301caf2a54fSJoe Perches } 5302caf2a54fSJoe Perches 530313214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5304d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5305d5e616fcSJoe Perches if (WARN("USE_FUNC", 5306d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5307d5e616fcSJoe Perches $fix) { 5308194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5309d5e616fcSJoe Perches } 531013214adfSAndy Whitcroft } 5311773647a0SAndy Whitcroft 531262ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 531362ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 531462ec818fSJoe Perches ERROR("DATE_TIME", 531562ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 531662ec818fSJoe Perches } 531762ec818fSJoe Perches 53182c92488aSJoe Perches# check for use of yield() 53192c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 53202c92488aSJoe Perches WARN("YIELD", 53212c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 53222c92488aSJoe Perches } 53232c92488aSJoe Perches 5324179f8f40SJoe Perches# check for comparisons against true and false 5325179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5326179f8f40SJoe Perches my $lead = $1; 5327179f8f40SJoe Perches my $arg = $2; 5328179f8f40SJoe Perches my $test = $3; 5329179f8f40SJoe Perches my $otype = $4; 5330179f8f40SJoe Perches my $trail = $5; 5331179f8f40SJoe Perches my $op = "!"; 5332179f8f40SJoe Perches 5333179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5334179f8f40SJoe Perches 5335179f8f40SJoe Perches my $type = lc($otype); 5336179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5337179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5338179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5339179f8f40SJoe Perches $op = ""; 5340179f8f40SJoe Perches } 5341179f8f40SJoe Perches 5342179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5343179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5344179f8f40SJoe Perches 5345179f8f40SJoe Perches## maybe suggesting a correct construct would better 5346179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5347179f8f40SJoe Perches 5348179f8f40SJoe Perches } 5349179f8f40SJoe Perches } 5350179f8f40SJoe Perches 53514882720bSThomas Gleixner# check for semaphores initialized locked 53524882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5353000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5354000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5355773647a0SAndy Whitcroft } 53566712d858SJoe Perches 535767d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 535867d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5359000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 536067d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5361773647a0SAndy Whitcroft } 53626712d858SJoe Perches 5363ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5364f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5365000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5366ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5367f3db6639SMichael Ellerman } 53686712d858SJoe Perches 53690f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 53700f3c5aabSJoe Perches my $const_structs = qr{ 53710f3c5aabSJoe Perches acpi_dock_ops| 537279404849SEmese Revfy address_space_operations| 537379404849SEmese Revfy backlight_ops| 537479404849SEmese Revfy block_device_operations| 537579404849SEmese Revfy dentry_operations| 537679404849SEmese Revfy dev_pm_ops| 537779404849SEmese Revfy dma_map_ops| 537879404849SEmese Revfy extent_io_ops| 537979404849SEmese Revfy file_lock_operations| 538079404849SEmese Revfy file_operations| 538179404849SEmese Revfy hv_ops| 538279404849SEmese Revfy ide_dma_ops| 538379404849SEmese Revfy intel_dvo_dev_ops| 538479404849SEmese Revfy item_operations| 538579404849SEmese Revfy iwl_ops| 538679404849SEmese Revfy kgdb_arch| 538779404849SEmese Revfy kgdb_io| 538879404849SEmese Revfy kset_uevent_ops| 538979404849SEmese Revfy lock_manager_operations| 539079404849SEmese Revfy microcode_ops| 539179404849SEmese Revfy mtrr_ops| 539279404849SEmese Revfy neigh_ops| 539379404849SEmese Revfy nlmsvc_binding| 53940f3c5aabSJoe Perches of_device_id| 539579404849SEmese Revfy pci_raw_ops| 539679404849SEmese Revfy pipe_buf_operations| 539779404849SEmese Revfy platform_hibernation_ops| 539879404849SEmese Revfy platform_suspend_ops| 539979404849SEmese Revfy proto_ops| 540079404849SEmese Revfy rpc_pipe_ops| 540179404849SEmese Revfy seq_operations| 540279404849SEmese Revfy snd_ac97_build_ops| 540379404849SEmese Revfy soc_pcmcia_socket_ops| 540479404849SEmese Revfy stacktrace_ops| 540579404849SEmese Revfy sysfs_ops| 540679404849SEmese Revfy tty_operations| 54076d07d01bSJoe Perches uart_ops| 540879404849SEmese Revfy usb_mon_operations| 540979404849SEmese Revfy wd_ops}x; 54106903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 54110f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5412000d1cc1SJoe Perches WARN("CONST_STRUCT", 5413000d1cc1SJoe Perches "struct $1 should normally be const\n" . 54146903ffb2SAndy Whitcroft $herecurr); 54152b6db5cbSAndy Whitcroft } 5416773647a0SAndy Whitcroft 5417773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5418773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5419773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5420c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5421c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5422171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5423171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5424171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5425773647a0SAndy Whitcroft { 5426000d1cc1SJoe Perches WARN("NR_CPUS", 5427000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5428773647a0SAndy Whitcroft } 54299c9ba34eSAndy Whitcroft 543052ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 543152ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 543252ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 543352ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 543452ea8506SJoe Perches } 543552ea8506SJoe Perches 5436acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5437acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5438acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5439acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5440acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5441acd9362cSJoe Perches } 5442acd9362cSJoe Perches 5443691d77b6SAndy Whitcroft# whine mightly about in_atomic 5444691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5445691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5446000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5447000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5448f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5449000d1cc1SJoe Perches WARN("IN_ATOMIC", 5450000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5451691d77b6SAndy Whitcroft } 5452691d77b6SAndy Whitcroft } 54531704f47bSPeter Zijlstra 54541704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 54551704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 54561704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 54571704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 54581704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 54591704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5460000d1cc1SJoe Perches ERROR("LOCKDEP", 5461000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 54621704f47bSPeter Zijlstra } 54631704f47bSPeter Zijlstra } 546488f8831cSDave Jones 5465b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5466b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5467000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5468000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 546988f8831cSDave Jones } 54702435880fSJoe Perches 5471515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5472515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5473515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5474515a235eSJoe Perches $line =~ /$mode_perms_search/) { 54752435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 54762435880fSJoe Perches my $func = $entry->[0]; 54772435880fSJoe Perches my $arg_pos = $entry->[1]; 54782435880fSJoe Perches 54792435880fSJoe Perches my $skip_args = ""; 54802435880fSJoe Perches if ($arg_pos > 1) { 54812435880fSJoe Perches $arg_pos--; 54822435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 54832435880fSJoe Perches } 54842435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5485515a235eSJoe Perches if ($line =~ /$test/) { 54862435880fSJoe Perches my $val = $1; 54872435880fSJoe Perches $val = $6 if ($skip_args ne ""); 54882435880fSJoe Perches 54891727cc70SJoe Perches if ($val !~ /^0$/ && 54901727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 54911727cc70SJoe Perches length($val) ne 4)) { 54922435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 54931727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5494c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5495c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5496c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 54972435880fSJoe Perches } 54982435880fSJoe Perches } 54992435880fSJoe Perches } 550013214adfSAndy Whitcroft } 5501515a235eSJoe Perches } 550213214adfSAndy Whitcroft 550313214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 550413214adfSAndy Whitcroft # so just keep quiet. 550513214adfSAndy Whitcroft if ($#rawlines == -1) { 550613214adfSAndy Whitcroft exit(0); 55070a920b5bSAndy Whitcroft } 55080a920b5bSAndy Whitcroft 55098905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 55108905a67cSAndy Whitcroft # things that appear to be patches. 55118905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 55128905a67cSAndy Whitcroft exit(0); 55138905a67cSAndy Whitcroft } 55148905a67cSAndy Whitcroft 55158905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 55168905a67cSAndy Whitcroft # just keep quiet. 55178905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 55188905a67cSAndy Whitcroft exit(0); 55198905a67cSAndy Whitcroft } 55208905a67cSAndy Whitcroft 55218905a67cSAndy Whitcroft if (!$is_patch) { 5522000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5523000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 55240a920b5bSAndy Whitcroft } 55250a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 5526000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5527000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 55280a920b5bSAndy Whitcroft } 55290a920b5bSAndy Whitcroft 5530f0a594c1SAndy Whitcroft print report_dump(); 553113214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 553213214adfSAndy Whitcroft print "$filename " if ($summary_file); 55336c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 55346c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 55356c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 55368905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 55376c72ffaaSAndy Whitcroft } 55388905a67cSAndy Whitcroft 5539d2c0a235SAndy Whitcroft if ($quiet == 0) { 5540d1fe9c09SJoe Perches 5541d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 5542d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 5543d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 5544d1fe9c09SJoe Perches } 5545d1fe9c09SJoe Perches 5546d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5547d2c0a235SAndy Whitcroft # then suggest that. 5548d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5549d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 5550d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 5551b0781216SMike Frysinger $rpt_cleaners = 0; 5552d2c0a235SAndy Whitcroft } 5553d2c0a235SAndy Whitcroft } 5554d2c0a235SAndy Whitcroft 555591bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 555691bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5557000d1cc1SJoe Perches 5558d752fcc8SJoe Perches if ($clean == 0 && $fix && 5559d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5560d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 55619624b8d6SJoe Perches my $newfile = $filename; 55629624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 55633705ce5bSJoe Perches my $linecount = 0; 55643705ce5bSJoe Perches my $f; 55653705ce5bSJoe Perches 5566d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5567d752fcc8SJoe Perches 55683705ce5bSJoe Perches open($f, '>', $newfile) 55693705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 55703705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 55713705ce5bSJoe Perches $linecount++; 55723705ce5bSJoe Perches if ($file) { 55733705ce5bSJoe Perches if ($linecount > 3) { 55743705ce5bSJoe Perches $fixed_line =~ s/^\+//; 55753705ce5bSJoe Perches print $f $fixed_line . "\n"; 55763705ce5bSJoe Perches } 55773705ce5bSJoe Perches } else { 55783705ce5bSJoe Perches print $f $fixed_line . "\n"; 55793705ce5bSJoe Perches } 55803705ce5bSJoe Perches } 55813705ce5bSJoe Perches close($f); 55823705ce5bSJoe Perches 55833705ce5bSJoe Perches if (!$quiet) { 55843705ce5bSJoe Perches print << "EOM"; 55853705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 55863705ce5bSJoe Perches 55873705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 55883705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 55893705ce5bSJoe Perches 55903705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 55913705ce5bSJoe PerchesNo warranties, expressed or implied... 55923705ce5bSJoe Perches 55933705ce5bSJoe PerchesEOM 55943705ce5bSJoe Perches } 55953705ce5bSJoe Perches } 55963705ce5bSJoe Perches 55970a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 5598c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 55990a920b5bSAndy Whitcroft } 56000a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 5601000d1cc1SJoe Perches print << "EOM"; 5602000d1cc1SJoe Perches$vname has style problems, please review. 5603000d1cc1SJoe Perches 5604000d1cc1SJoe PerchesIf any of these errors are false positives, please report 5605000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 5606000d1cc1SJoe PerchesEOM 56070a920b5bSAndy Whitcroft } 560813214adfSAndy Whitcroft 56090a920b5bSAndy Whitcroft return $clean; 56100a920b5bSAndy Whitcroft} 5611