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) { 200*d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 20158cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 20291bfe484SJoe Perches print " $word"; 20391bfe484SJoe Perches } 204*d8469f16SJoe Perches print "\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 350e6176fa4SJoe 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)}; 355e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 356fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3578ed22cadSAndy Whitcroft atomic_t 3588ed22cadSAndy Whitcroft)}; 359e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 360e6176fa4SJoe Perches $typeC99Typedefs\b| 361e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 362e6176fa4SJoe Perches $typeKernelTypedefs\b 363e6176fa4SJoe 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); 426485ff23eSAlex Dowadour @typeListFile = (); 4278716de38SJoe Perchesour @typeListWithAttr = ( 4288716de38SJoe Perches @typeList, 4298716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4308716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4318716de38SJoe Perches); 4328716de38SJoe Perches 433c45dcabdSAndy Whitcroftour @modifierList = ( 434c45dcabdSAndy Whitcroft qr{fastcall}, 435c45dcabdSAndy Whitcroft); 436485ff23eSAlex Dowadour @modifierListFile = (); 4378905a67cSAndy Whitcroft 4382435880fSJoe Perchesour @mode_permission_funcs = ( 4392435880fSJoe Perches ["module_param", 3], 4402435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4412435880fSJoe Perches ["module_param_array_named", 5], 4422435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4432435880fSJoe Perches ["proc_create(?:_data|)", 2], 4442435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4452435880fSJoe Perches); 4462435880fSJoe Perches 447515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 448515a235eSJoe Perchesour $mode_perms_search = ""; 449515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 450515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 451515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 452515a235eSJoe Perches} 453515a235eSJoe Perches 454b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 455b392c64fSJoe Perches S_IWUGO | 456b392c64fSJoe Perches S_IWOTH | 457b392c64fSJoe Perches S_IRWXUGO | 458b392c64fSJoe Perches S_IALLUGO | 459b392c64fSJoe Perches 0[0-7][0-7][2367] 460b392c64fSJoe Perches}x; 461b392c64fSJoe Perches 4627840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4637840a94cSWolfram Sang irq| 464cdcee686SSergey Ryazanov memory| 465cdcee686SSergey Ryazanov time| 466cdcee686SSergey Ryazanov reboot 4677840a94cSWolfram Sang)}; 4687840a94cSWolfram Sang# memory.h: ARM has a custom one 4697840a94cSWolfram Sang 47066b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 47166b47b4aSKees Cookmy $misspellings; 47266b47b4aSKees Cookmy %spelling_fix; 47336061e38SJoe Perches 47436061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 47566b47b4aSKees Cook while (<$spelling>) { 47666b47b4aSKees Cook my $line = $_; 47766b47b4aSKees Cook 47866b47b4aSKees Cook $line =~ s/\s*\n?$//g; 47966b47b4aSKees Cook $line =~ s/^\s*//g; 48066b47b4aSKees Cook 48166b47b4aSKees Cook next if ($line =~ m/^\s*#/); 48266b47b4aSKees Cook next if ($line =~ m/^\s*$/); 48366b47b4aSKees Cook 48466b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 48566b47b4aSKees Cook 48666b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 48766b47b4aSKees Cook } 48866b47b4aSKees Cook close($spelling); 48936061e38SJoe Perches} else { 49036061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 49136061e38SJoe Perches} 49266b47b4aSKees Cook 493ebfd7d62SJoe Perchesif ($codespell) { 494ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 495ebfd7d62SJoe Perches while (<$spelling>) { 496ebfd7d62SJoe Perches my $line = $_; 497ebfd7d62SJoe Perches 498ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 499ebfd7d62SJoe Perches $line =~ s/^\s*//g; 500ebfd7d62SJoe Perches 501ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 502ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 503ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 504ebfd7d62SJoe Perches 505ebfd7d62SJoe Perches $line =~ s/,.*$//; 506ebfd7d62SJoe Perches 507ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 508ebfd7d62SJoe Perches 509ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 510ebfd7d62SJoe Perches } 511ebfd7d62SJoe Perches close($spelling); 512ebfd7d62SJoe Perches } else { 513ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 514ebfd7d62SJoe Perches } 515ebfd7d62SJoe Perches} 516ebfd7d62SJoe Perches 517ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 518ebfd7d62SJoe Perches 5198905a67cSAndy Whitcroftsub build_types { 520485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 521485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 5221813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5238716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 524c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 525ab7e23f3SJoe Perches $BasicType = qr{ 526ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 527ab7e23f3SJoe Perches (?:${all}\b) 528ab7e23f3SJoe Perches }x; 5298905a67cSAndy Whitcroft $NonptrType = qr{ 530d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 531cf655043SAndy Whitcroft (?: 5326b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 5338ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 534c45dcabdSAndy Whitcroft (?:${all}\b) 535cf655043SAndy Whitcroft ) 536c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5378905a67cSAndy Whitcroft }x; 5381813087dSJoe Perches $NonptrTypeMisordered = qr{ 5391813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5401813087dSJoe Perches (?: 5411813087dSJoe Perches (?:${Misordered}\b) 5421813087dSJoe Perches ) 5431813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5441813087dSJoe Perches }x; 5458716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5468716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5478716de38SJoe Perches (?: 5488716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5498716de38SJoe Perches (?:$typeTypedefs\b)| 5508716de38SJoe Perches (?:${allWithAttr}\b) 5518716de38SJoe Perches ) 5528716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5538716de38SJoe Perches }x; 5548905a67cSAndy Whitcroft $Type = qr{ 555c45dcabdSAndy Whitcroft $NonptrType 5561574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 557c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5588905a67cSAndy Whitcroft }x; 5591813087dSJoe Perches $TypeMisordered = qr{ 5601813087dSJoe Perches $NonptrTypeMisordered 5611813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5621813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5631813087dSJoe Perches }x; 56491cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5651813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5668905a67cSAndy Whitcroft} 5678905a67cSAndy Whitcroftbuild_types(); 5686c72ffaaSAndy Whitcroft 5697d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 570d1fe9c09SJoe Perches 571d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 572d1fe9c09SJoe Perches# requires at least perl version v5.10.0 573d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 574d1fe9c09SJoe Perches 575d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5762435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 577c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 5787d2367afSJoe Perches 579f8422308SJoe Perchesour $declaration_macros = qr{(?x: 580f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 581f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 582f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 583f8422308SJoe Perches)}; 584f8422308SJoe Perches 5857d2367afSJoe Perchessub deparenthesize { 5867d2367afSJoe Perches my ($string) = @_; 5877d2367afSJoe Perches return "" if (!defined($string)); 5885b9553abSJoe Perches 5895b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5905b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5915b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5925b9553abSJoe Perches } 5935b9553abSJoe Perches 5947d2367afSJoe Perches $string =~ s@\s+@ @g; 5955b9553abSJoe Perches 5967d2367afSJoe Perches return $string; 5977d2367afSJoe Perches} 5987d2367afSJoe Perches 5993445686aSJoe Perchessub seed_camelcase_file { 6003445686aSJoe Perches my ($file) = @_; 6013445686aSJoe Perches 6023445686aSJoe Perches return if (!(-f $file)); 6033445686aSJoe Perches 6043445686aSJoe Perches local $/; 6053445686aSJoe Perches 6063445686aSJoe Perches open(my $include_file, '<', "$file") 6073445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6083445686aSJoe Perches my $text = <$include_file>; 6093445686aSJoe Perches close($include_file); 6103445686aSJoe Perches 6113445686aSJoe Perches my @lines = split('\n', $text); 6123445686aSJoe Perches 6133445686aSJoe Perches foreach my $line (@lines) { 6143445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6153445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6163445686aSJoe Perches $camelcase{$1} = 1; 61711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 61811ea516aSJoe Perches $camelcase{$1} = 1; 61911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6203445686aSJoe Perches $camelcase{$1} = 1; 6213445686aSJoe Perches } 6223445686aSJoe Perches } 6233445686aSJoe Perches} 6243445686aSJoe Perches 6253445686aSJoe Perchesmy $camelcase_seeded = 0; 6263445686aSJoe Perchessub seed_camelcase_includes { 6273445686aSJoe Perches return if ($camelcase_seeded); 6283445686aSJoe Perches 6293445686aSJoe Perches my $files; 630c707a81dSJoe Perches my $camelcase_cache = ""; 631c707a81dSJoe Perches my @include_files = (); 632c707a81dSJoe Perches 633c707a81dSJoe Perches $camelcase_seeded = 1; 634351b2a1fSJoe Perches 6353645e328SRichard Genoud if (-e ".git") { 636351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 637351b2a1fSJoe Perches chomp $git_last_include_commit; 638c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 639c707a81dSJoe Perches } else { 640c707a81dSJoe Perches my $last_mod_date = 0; 641c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 642c707a81dSJoe Perches @include_files = split('\n', $files); 643c707a81dSJoe Perches foreach my $file (@include_files) { 644c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 645c707a81dSJoe Perches localtime((stat $file)[9])); 646c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 647c707a81dSJoe Perches } 648c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 649c707a81dSJoe Perches } 650c707a81dSJoe Perches 651c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 652c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 653c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 654351b2a1fSJoe Perches while (<$camelcase_file>) { 655351b2a1fSJoe Perches chomp; 656351b2a1fSJoe Perches $camelcase{$_} = 1; 657351b2a1fSJoe Perches } 658351b2a1fSJoe Perches close($camelcase_file); 659351b2a1fSJoe Perches 660351b2a1fSJoe Perches return; 661351b2a1fSJoe Perches } 662c707a81dSJoe Perches 6633645e328SRichard Genoud if (-e ".git") { 664c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 665c707a81dSJoe Perches @include_files = split('\n', $files); 6663445686aSJoe Perches } 667c707a81dSJoe Perches 6683445686aSJoe Perches foreach my $file (@include_files) { 6693445686aSJoe Perches seed_camelcase_file($file); 6703445686aSJoe Perches } 671351b2a1fSJoe Perches 672c707a81dSJoe Perches if ($camelcase_cache ne "") { 673351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 674c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 675c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 676351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 677351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 678351b2a1fSJoe Perches } 679351b2a1fSJoe Perches close($camelcase_file); 680351b2a1fSJoe Perches } 6813445686aSJoe Perches} 6823445686aSJoe Perches 683d311cd44SJoe Perchessub git_commit_info { 684d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 685d311cd44SJoe Perches 686d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 687d311cd44SJoe Perches 688d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 689d311cd44SJoe Perches $output =~ s/^\s*//gm; 690d311cd44SJoe Perches my @lines = split("\n", $output); 691d311cd44SJoe Perches 6920d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 6930d7835fcSJoe Perches 694d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 695d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 696d311cd44SJoe Perches# all matching commit ids, but it's very slow... 697d311cd44SJoe Perches# 698d311cd44SJoe Perches# echo "checking commits $1..." 699d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 700d311cd44SJoe Perches# while read line ; do 701d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 702d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 703d311cd44SJoe Perches# done 704d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 705d311cd44SJoe Perches } else { 706d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 707d311cd44SJoe Perches $desc = substr($lines[0], 41); 708d311cd44SJoe Perches } 709d311cd44SJoe Perches 710d311cd44SJoe Perches return ($id, $desc); 711d311cd44SJoe Perches} 712d311cd44SJoe Perches 7136c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7140a920b5bSAndy Whitcroft 71500df344fSAndy Whitcroftmy @rawlines = (); 716c2fdda0dSAndy Whitcroftmy @lines = (); 7173705ce5bSJoe Perchesmy @fixed = (); 718d752fcc8SJoe Perchesmy @fixed_inserted = (); 719d752fcc8SJoe Perchesmy @fixed_deleted = (); 720194f66fcSJoe Perchesmy $fixlinenr = -1; 721194f66fcSJoe Perches 722c2fdda0dSAndy Whitcroftmy $vname; 7236c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 72421caa13cSAndy Whitcroft my $FILE; 7256c72ffaaSAndy Whitcroft if ($file) { 72621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7276c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 72821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 72921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7306c72ffaaSAndy Whitcroft } else { 73121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7326c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7336c72ffaaSAndy Whitcroft } 734c2fdda0dSAndy Whitcroft if ($filename eq '-') { 735c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 736c2fdda0dSAndy Whitcroft } else { 737c2fdda0dSAndy Whitcroft $vname = $filename; 738c2fdda0dSAndy Whitcroft } 73921caa13cSAndy Whitcroft while (<$FILE>) { 7400a920b5bSAndy Whitcroft chomp; 74100df344fSAndy Whitcroft push(@rawlines, $_); 7426c72ffaaSAndy Whitcroft } 74321caa13cSAndy Whitcroft close($FILE); 744*d8469f16SJoe Perches 745*d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 746*d8469f16SJoe Perches print '-' x length($vname) . "\n"; 747*d8469f16SJoe Perches print "$vname\n"; 748*d8469f16SJoe Perches print '-' x length($vname) . "\n"; 749*d8469f16SJoe Perches } 750*d8469f16SJoe Perches 751c2fdda0dSAndy Whitcroft if (!process($filename)) { 7520a920b5bSAndy Whitcroft $exit = 1; 7530a920b5bSAndy Whitcroft } 75400df344fSAndy Whitcroft @rawlines = (); 75513214adfSAndy Whitcroft @lines = (); 7563705ce5bSJoe Perches @fixed = (); 757d752fcc8SJoe Perches @fixed_inserted = (); 758d752fcc8SJoe Perches @fixed_deleted = (); 759194f66fcSJoe Perches $fixlinenr = -1; 760485ff23eSAlex Dowad @modifierListFile = (); 761485ff23eSAlex Dowad @typeListFile = (); 762485ff23eSAlex Dowad build_types(); 7630a920b5bSAndy Whitcroft} 7640a920b5bSAndy Whitcroft 765*d8469f16SJoe Perchesif (!$quiet) { 766*d8469f16SJoe Perches if ($^V lt 5.10.0) { 767*d8469f16SJoe Perches print << "EOM" 768*d8469f16SJoe Perches 769*d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 770*d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 771*d8469f16SJoe PerchesEOM 772*d8469f16SJoe Perches } 773*d8469f16SJoe Perches if ($exit) { 774*d8469f16SJoe Perches print << "EOM" 775*d8469f16SJoe Perches 776*d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 777*d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 778*d8469f16SJoe PerchesEOM 779*d8469f16SJoe Perches } 780*d8469f16SJoe Perches} 781*d8469f16SJoe Perches 7820a920b5bSAndy Whitcroftexit($exit); 7830a920b5bSAndy Whitcroft 7840a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7856c72ffaaSAndy Whitcroft my ($root) = @_; 7866c72ffaaSAndy Whitcroft 7876c72ffaaSAndy Whitcroft my @tree_check = ( 7886c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7896c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 7906c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 7916c72ffaaSAndy Whitcroft ); 7926c72ffaaSAndy Whitcroft 7936c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 7946c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 7950a920b5bSAndy Whitcroft return 0; 7960a920b5bSAndy Whitcroft } 7976c72ffaaSAndy Whitcroft } 7986c72ffaaSAndy Whitcroft return 1; 7996c72ffaaSAndy Whitcroft} 8000a920b5bSAndy Whitcroft 80120112475SJoe Perchessub parse_email { 80220112475SJoe Perches my ($formatted_email) = @_; 80320112475SJoe Perches 80420112475SJoe Perches my $name = ""; 80520112475SJoe Perches my $address = ""; 80620112475SJoe Perches my $comment = ""; 80720112475SJoe Perches 80820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 80920112475SJoe Perches $name = $1; 81020112475SJoe Perches $address = $2; 81120112475SJoe Perches $comment = $3 if defined $3; 81220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 81320112475SJoe Perches $address = $1; 81420112475SJoe Perches $comment = $2 if defined $2; 81520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 81620112475SJoe Perches $address = $1; 81720112475SJoe Perches $comment = $2 if defined $2; 81820112475SJoe Perches $formatted_email =~ s/$address.*$//; 81920112475SJoe Perches $name = $formatted_email; 8203705ce5bSJoe Perches $name = trim($name); 82120112475SJoe Perches $name =~ s/^\"|\"$//g; 82220112475SJoe Perches # If there's a name left after stripping spaces and 82320112475SJoe Perches # leading quotes, and the address doesn't have both 82420112475SJoe Perches # leading and trailing angle brackets, the address 82520112475SJoe Perches # is invalid. ie: 82620112475SJoe Perches # "joe smith [email protected]" bad 82720112475SJoe Perches # "joe smith <[email protected]" bad 82820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 82920112475SJoe Perches $name = ""; 83020112475SJoe Perches $address = ""; 83120112475SJoe Perches $comment = ""; 83220112475SJoe Perches } 83320112475SJoe Perches } 83420112475SJoe Perches 8353705ce5bSJoe Perches $name = trim($name); 83620112475SJoe Perches $name =~ s/^\"|\"$//g; 8373705ce5bSJoe Perches $address = trim($address); 83820112475SJoe Perches $address =~ s/^\<|\>$//g; 83920112475SJoe Perches 84020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 84120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 84220112475SJoe Perches $name = "\"$name\""; 84320112475SJoe Perches } 84420112475SJoe Perches 84520112475SJoe Perches return ($name, $address, $comment); 84620112475SJoe Perches} 84720112475SJoe Perches 84820112475SJoe Perchessub format_email { 84920112475SJoe Perches my ($name, $address) = @_; 85020112475SJoe Perches 85120112475SJoe Perches my $formatted_email; 85220112475SJoe Perches 8533705ce5bSJoe Perches $name = trim($name); 85420112475SJoe Perches $name =~ s/^\"|\"$//g; 8553705ce5bSJoe Perches $address = trim($address); 85620112475SJoe Perches 85720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 85820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 85920112475SJoe Perches $name = "\"$name\""; 86020112475SJoe Perches } 86120112475SJoe Perches 86220112475SJoe Perches if ("$name" eq "") { 86320112475SJoe Perches $formatted_email = "$address"; 86420112475SJoe Perches } else { 86520112475SJoe Perches $formatted_email = "$name <$address>"; 86620112475SJoe Perches } 86720112475SJoe Perches 86820112475SJoe Perches return $formatted_email; 86920112475SJoe Perches} 87020112475SJoe Perches 871d311cd44SJoe Perchessub which { 872d311cd44SJoe Perches my ($bin) = @_; 873d311cd44SJoe Perches 874d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 875d311cd44SJoe Perches if (-e "$path/$bin") { 876d311cd44SJoe Perches return "$path/$bin"; 877d311cd44SJoe Perches } 878d311cd44SJoe Perches } 879d311cd44SJoe Perches 880d311cd44SJoe Perches return ""; 881d311cd44SJoe Perches} 882d311cd44SJoe Perches 883000d1cc1SJoe Perchessub which_conf { 884000d1cc1SJoe Perches my ($conf) = @_; 885000d1cc1SJoe Perches 886000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 887000d1cc1SJoe Perches if (-e "$path/$conf") { 888000d1cc1SJoe Perches return "$path/$conf"; 889000d1cc1SJoe Perches } 890000d1cc1SJoe Perches } 891000d1cc1SJoe Perches 892000d1cc1SJoe Perches return ""; 893000d1cc1SJoe Perches} 894000d1cc1SJoe Perches 8950a920b5bSAndy Whitcroftsub expand_tabs { 8960a920b5bSAndy Whitcroft my ($str) = @_; 8970a920b5bSAndy Whitcroft 8980a920b5bSAndy Whitcroft my $res = ''; 8990a920b5bSAndy Whitcroft my $n = 0; 9000a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 9010a920b5bSAndy Whitcroft if ($c eq "\t") { 9020a920b5bSAndy Whitcroft $res .= ' '; 9030a920b5bSAndy Whitcroft $n++; 9040a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 9050a920b5bSAndy Whitcroft $res .= ' '; 9060a920b5bSAndy Whitcroft } 9070a920b5bSAndy Whitcroft next; 9080a920b5bSAndy Whitcroft } 9090a920b5bSAndy Whitcroft $res .= $c; 9100a920b5bSAndy Whitcroft $n++; 9110a920b5bSAndy Whitcroft } 9120a920b5bSAndy Whitcroft 9130a920b5bSAndy Whitcroft return $res; 9140a920b5bSAndy Whitcroft} 9156c72ffaaSAndy Whitcroftsub copy_spacing { 916773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 9176c72ffaaSAndy Whitcroft return $res; 9186c72ffaaSAndy Whitcroft} 9190a920b5bSAndy Whitcroft 9204a0df2efSAndy Whitcroftsub line_stats { 9214a0df2efSAndy Whitcroft my ($line) = @_; 9224a0df2efSAndy Whitcroft 9234a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 9244a0df2efSAndy Whitcroft $line =~ s/^.//; 9254a0df2efSAndy Whitcroft $line = expand_tabs($line); 9264a0df2efSAndy Whitcroft 9274a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 9284a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9294a0df2efSAndy Whitcroft 9304a0df2efSAndy Whitcroft return (length($line), length($white)); 9314a0df2efSAndy Whitcroft} 9324a0df2efSAndy Whitcroft 933773647a0SAndy Whitcroftmy $sanitise_quote = ''; 934773647a0SAndy Whitcroft 935773647a0SAndy Whitcroftsub sanitise_line_reset { 936773647a0SAndy Whitcroft my ($in_comment) = @_; 937773647a0SAndy Whitcroft 938773647a0SAndy Whitcroft if ($in_comment) { 939773647a0SAndy Whitcroft $sanitise_quote = '*/'; 940773647a0SAndy Whitcroft } else { 941773647a0SAndy Whitcroft $sanitise_quote = ''; 942773647a0SAndy Whitcroft } 943773647a0SAndy Whitcroft} 94400df344fSAndy Whitcroftsub sanitise_line { 94500df344fSAndy Whitcroft my ($line) = @_; 94600df344fSAndy Whitcroft 94700df344fSAndy Whitcroft my $res = ''; 94800df344fSAndy Whitcroft my $l = ''; 94900df344fSAndy Whitcroft 950c2fdda0dSAndy Whitcroft my $qlen = 0; 951773647a0SAndy Whitcroft my $off = 0; 952773647a0SAndy Whitcroft my $c; 95300df344fSAndy Whitcroft 954773647a0SAndy Whitcroft # Always copy over the diff marker. 955773647a0SAndy Whitcroft $res = substr($line, 0, 1); 956773647a0SAndy Whitcroft 957773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 958773647a0SAndy Whitcroft $c = substr($line, $off, 1); 959773647a0SAndy Whitcroft 960773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 961773647a0SAndy Whitcroft # and end, all to $;. 962773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 963773647a0SAndy Whitcroft $sanitise_quote = '*/'; 964773647a0SAndy Whitcroft 965773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 966773647a0SAndy Whitcroft $off++; 96700df344fSAndy Whitcroft next; 968773647a0SAndy Whitcroft } 96981bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 970773647a0SAndy Whitcroft $sanitise_quote = ''; 971773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 972773647a0SAndy Whitcroft $off++; 973773647a0SAndy Whitcroft next; 974773647a0SAndy Whitcroft } 975113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 976113f04a8SDaniel Walker $sanitise_quote = '//'; 977113f04a8SDaniel Walker 978113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 979113f04a8SDaniel Walker $off++; 980113f04a8SDaniel Walker next; 981113f04a8SDaniel Walker } 982773647a0SAndy Whitcroft 983773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 984773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 985773647a0SAndy Whitcroft $c eq "\\") { 986773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 987773647a0SAndy Whitcroft $off++; 988773647a0SAndy Whitcroft next; 989773647a0SAndy Whitcroft } 990773647a0SAndy Whitcroft # Regular quotes. 991773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 992773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 993773647a0SAndy Whitcroft $sanitise_quote = $c; 994773647a0SAndy Whitcroft 995773647a0SAndy Whitcroft substr($res, $off, 1, $c); 996773647a0SAndy Whitcroft next; 997773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 998773647a0SAndy Whitcroft $sanitise_quote = ''; 99900df344fSAndy Whitcroft } 100000df344fSAndy Whitcroft } 1001773647a0SAndy Whitcroft 1002fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1003773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1004773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1005113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1006113f04a8SDaniel Walker substr($res, $off, 1, $;); 1007773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1008773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 100900df344fSAndy Whitcroft } else { 1010773647a0SAndy Whitcroft substr($res, $off, 1, $c); 101100df344fSAndy Whitcroft } 1012c2fdda0dSAndy Whitcroft } 1013c2fdda0dSAndy Whitcroft 1014113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1015113f04a8SDaniel Walker $sanitise_quote = ''; 1016113f04a8SDaniel Walker } 1017113f04a8SDaniel Walker 1018c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1019c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1020c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1021c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1022c2fdda0dSAndy Whitcroft 1023c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1024c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1025c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1026c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1027c2fdda0dSAndy Whitcroft } 1028c2fdda0dSAndy Whitcroft 102900df344fSAndy Whitcroft return $res; 103000df344fSAndy Whitcroft} 103100df344fSAndy Whitcroft 1032a6962d72SJoe Perchessub get_quoted_string { 1033a6962d72SJoe Perches my ($line, $rawline) = @_; 1034a6962d72SJoe Perches 103533acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1036a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1037a6962d72SJoe Perches} 1038a6962d72SJoe Perches 10398905a67cSAndy Whitcroftsub ctx_statement_block { 10408905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10418905a67cSAndy Whitcroft my $line = $linenr - 1; 10428905a67cSAndy Whitcroft my $blk = ''; 10438905a67cSAndy Whitcroft my $soff = $off; 10448905a67cSAndy Whitcroft my $coff = $off - 1; 1045773647a0SAndy Whitcroft my $coff_set = 0; 10468905a67cSAndy Whitcroft 104713214adfSAndy Whitcroft my $loff = 0; 104813214adfSAndy Whitcroft 10498905a67cSAndy Whitcroft my $type = ''; 10508905a67cSAndy Whitcroft my $level = 0; 1051a2750645SAndy Whitcroft my @stack = (); 1052cf655043SAndy Whitcroft my $p; 10538905a67cSAndy Whitcroft my $c; 10548905a67cSAndy Whitcroft my $len = 0; 105513214adfSAndy Whitcroft 105613214adfSAndy Whitcroft my $remainder; 10578905a67cSAndy Whitcroft while (1) { 1058a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1059a2750645SAndy Whitcroft 1060773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10618905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10628905a67cSAndy Whitcroft # context. 10638905a67cSAndy Whitcroft if ($off >= $len) { 10648905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1065dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1066c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10678905a67cSAndy Whitcroft $remain--; 106813214adfSAndy Whitcroft $loff = $len; 1069c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10708905a67cSAndy Whitcroft $len = length($blk); 10718905a67cSAndy Whitcroft $line++; 10728905a67cSAndy Whitcroft last; 10738905a67cSAndy Whitcroft } 10748905a67cSAndy Whitcroft # Bail if there is no further context. 10758905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 107613214adfSAndy Whitcroft if ($off >= $len) { 10778905a67cSAndy Whitcroft last; 10788905a67cSAndy Whitcroft } 1079f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1080f74bd194SAndy Whitcroft $level++; 1081f74bd194SAndy Whitcroft $type = '#'; 1082f74bd194SAndy Whitcroft } 10838905a67cSAndy Whitcroft } 1084cf655043SAndy Whitcroft $p = $c; 10858905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 108613214adfSAndy Whitcroft $remainder = substr($blk, $off); 10878905a67cSAndy Whitcroft 1088773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10894635f4fbSAndy Whitcroft 10904635f4fbSAndy Whitcroft # Handle nested #if/#else. 10914635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 10924635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 10934635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 10944635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 10954635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 10964635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 10974635f4fbSAndy Whitcroft } 10984635f4fbSAndy Whitcroft 10998905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 11008905a67cSAndy Whitcroft # outermost level. 11018905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 11028905a67cSAndy Whitcroft last; 11038905a67cSAndy Whitcroft } 11048905a67cSAndy Whitcroft 110513214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1106773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1107773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1108773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1109773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1110773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1111773647a0SAndy Whitcroft $coff_set = 1; 1112773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1113773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 111413214adfSAndy Whitcroft } 111513214adfSAndy Whitcroft 11168905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 11178905a67cSAndy Whitcroft $level++; 11188905a67cSAndy Whitcroft $type = '('; 11198905a67cSAndy Whitcroft } 11208905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 11218905a67cSAndy Whitcroft $level--; 11228905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 11238905a67cSAndy Whitcroft 11248905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 11258905a67cSAndy Whitcroft $coff = $off; 1126773647a0SAndy Whitcroft $coff_set = 1; 1127773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 11288905a67cSAndy Whitcroft } 11298905a67cSAndy Whitcroft } 11308905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11318905a67cSAndy Whitcroft $level++; 11328905a67cSAndy Whitcroft $type = '{'; 11338905a67cSAndy Whitcroft } 11348905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11358905a67cSAndy Whitcroft $level--; 11368905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11378905a67cSAndy Whitcroft 11388905a67cSAndy Whitcroft if ($level == 0) { 1139b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1140b998e001SPatrick Pannuto $off++; 1141b998e001SPatrick Pannuto } 11428905a67cSAndy Whitcroft last; 11438905a67cSAndy Whitcroft } 11448905a67cSAndy Whitcroft } 1145f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1146f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1147f74bd194SAndy Whitcroft $level--; 1148f74bd194SAndy Whitcroft $type = ''; 1149f74bd194SAndy Whitcroft $off++; 1150f74bd194SAndy Whitcroft last; 1151f74bd194SAndy Whitcroft } 11528905a67cSAndy Whitcroft $off++; 11538905a67cSAndy Whitcroft } 1154a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 115513214adfSAndy Whitcroft if ($off == $len) { 1156a3bb97a7SAndy Whitcroft $loff = $len + 1; 115713214adfSAndy Whitcroft $line++; 115813214adfSAndy Whitcroft $remain--; 115913214adfSAndy Whitcroft } 11608905a67cSAndy Whitcroft 11618905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11628905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11638905a67cSAndy Whitcroft 11648905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11658905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11668905a67cSAndy Whitcroft 1167773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 116813214adfSAndy Whitcroft 116913214adfSAndy Whitcroft return ($statement, $condition, 117013214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 117113214adfSAndy Whitcroft} 117213214adfSAndy Whitcroft 1173cf655043SAndy Whitcroftsub statement_lines { 1174cf655043SAndy Whitcroft my ($stmt) = @_; 1175cf655043SAndy Whitcroft 1176cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1177cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1178cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1179cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1180cf655043SAndy Whitcroft 1181cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1182cf655043SAndy Whitcroft 1183cf655043SAndy Whitcroft return $#stmt_lines + 2; 1184cf655043SAndy Whitcroft} 1185cf655043SAndy Whitcroft 1186cf655043SAndy Whitcroftsub statement_rawlines { 1187cf655043SAndy Whitcroft my ($stmt) = @_; 1188cf655043SAndy Whitcroft 1189cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1190cf655043SAndy Whitcroft 1191cf655043SAndy Whitcroft return $#stmt_lines + 2; 1192cf655043SAndy Whitcroft} 1193cf655043SAndy Whitcroft 1194cf655043SAndy Whitcroftsub statement_block_size { 1195cf655043SAndy Whitcroft my ($stmt) = @_; 1196cf655043SAndy Whitcroft 1197cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1198cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1199cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1200cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1201cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1202cf655043SAndy Whitcroft 1203cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1204cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1205cf655043SAndy Whitcroft 1206cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1207cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1208cf655043SAndy Whitcroft 1209cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1210cf655043SAndy Whitcroft return $stmt_lines; 1211cf655043SAndy Whitcroft } else { 1212cf655043SAndy Whitcroft return $stmt_statements; 1213cf655043SAndy Whitcroft } 1214cf655043SAndy Whitcroft} 1215cf655043SAndy Whitcroft 121613214adfSAndy Whitcroftsub ctx_statement_full { 121713214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 121813214adfSAndy Whitcroft my ($statement, $condition, $level); 121913214adfSAndy Whitcroft 122013214adfSAndy Whitcroft my (@chunks); 122113214adfSAndy Whitcroft 1222cf655043SAndy Whitcroft # Grab the first conditional/block pair. 122313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 122413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1225773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 122613214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1227cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1228cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1229cf655043SAndy Whitcroft } 1230cf655043SAndy Whitcroft 1231cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1232cf655043SAndy Whitcroft # could continue the statement. 1233cf655043SAndy Whitcroft for (;;) { 123413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 123513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1236cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1237773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1238cf655043SAndy Whitcroft #print "C: push\n"; 1239cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 124013214adfSAndy Whitcroft } 124113214adfSAndy Whitcroft 124213214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12438905a67cSAndy Whitcroft} 12448905a67cSAndy Whitcroft 12454a0df2efSAndy Whitcroftsub ctx_block_get { 1246f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12474a0df2efSAndy Whitcroft my $line; 12484a0df2efSAndy Whitcroft my $start = $linenr - 1; 12494a0df2efSAndy Whitcroft my $blk = ''; 12504a0df2efSAndy Whitcroft my @o; 12514a0df2efSAndy Whitcroft my @c; 12524a0df2efSAndy Whitcroft my @res = (); 12534a0df2efSAndy Whitcroft 1254f0a594c1SAndy Whitcroft my $level = 0; 12554635f4fbSAndy Whitcroft my @stack = ($level); 125600df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 125700df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 125800df344fSAndy Whitcroft $remain--; 125900df344fSAndy Whitcroft 126000df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12614635f4fbSAndy Whitcroft 12624635f4fbSAndy Whitcroft # Handle nested #if/#else. 126301464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12644635f4fbSAndy Whitcroft push(@stack, $level); 126501464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12664635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 126701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12684635f4fbSAndy Whitcroft $level = pop(@stack); 12694635f4fbSAndy Whitcroft } 12704635f4fbSAndy Whitcroft 127101464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1272f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1273f0a594c1SAndy Whitcroft if ($off > 0) { 1274f0a594c1SAndy Whitcroft $off--; 1275f0a594c1SAndy Whitcroft next; 1276f0a594c1SAndy Whitcroft } 12774a0df2efSAndy Whitcroft 1278f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1279f0a594c1SAndy Whitcroft $level--; 1280f0a594c1SAndy Whitcroft last if ($level == 0); 1281f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1282f0a594c1SAndy Whitcroft $level++; 1283f0a594c1SAndy Whitcroft } 1284f0a594c1SAndy Whitcroft } 12854a0df2efSAndy Whitcroft 1286f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 128700df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12884a0df2efSAndy Whitcroft } 12894a0df2efSAndy Whitcroft 1290f0a594c1SAndy Whitcroft last if ($level == 0); 12914a0df2efSAndy Whitcroft } 12924a0df2efSAndy Whitcroft 1293f0a594c1SAndy Whitcroft return ($level, @res); 12944a0df2efSAndy Whitcroft} 12954a0df2efSAndy Whitcroftsub ctx_block_outer { 12964a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12974a0df2efSAndy Whitcroft 1298f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1299f0a594c1SAndy Whitcroft return @r; 13004a0df2efSAndy Whitcroft} 13014a0df2efSAndy Whitcroftsub ctx_block { 13024a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13034a0df2efSAndy Whitcroft 1304f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1305f0a594c1SAndy Whitcroft return @r; 1306653d4876SAndy Whitcroft} 1307653d4876SAndy Whitcroftsub ctx_statement { 1308f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1309f0a594c1SAndy Whitcroft 1310f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1311f0a594c1SAndy Whitcroft return @r; 1312f0a594c1SAndy Whitcroft} 1313f0a594c1SAndy Whitcroftsub ctx_block_level { 1314653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1315653d4876SAndy Whitcroft 1316f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 13174a0df2efSAndy Whitcroft} 13189c0ca6f9SAndy Whitcroftsub ctx_statement_level { 13199c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 13209c0ca6f9SAndy Whitcroft 13219c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 13229c0ca6f9SAndy Whitcroft} 13234a0df2efSAndy Whitcroft 13244a0df2efSAndy Whitcroftsub ctx_locate_comment { 13254a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13264a0df2efSAndy Whitcroft 13274a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1328beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13294a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13304a0df2efSAndy Whitcroft 13314a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13324a0df2efSAndy Whitcroft # comment. 13334a0df2efSAndy Whitcroft my $in_comment = 0; 13344a0df2efSAndy Whitcroft $current_comment = ''; 13354a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 133600df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 133700df344fSAndy Whitcroft #warn " $line\n"; 13384a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13394a0df2efSAndy Whitcroft $in_comment = 1; 13404a0df2efSAndy Whitcroft } 13414a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13424a0df2efSAndy Whitcroft $in_comment = 1; 13434a0df2efSAndy Whitcroft } 13444a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13454a0df2efSAndy Whitcroft $current_comment = ''; 13464a0df2efSAndy Whitcroft } 13474a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13484a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13494a0df2efSAndy Whitcroft $in_comment = 0; 13504a0df2efSAndy Whitcroft } 13514a0df2efSAndy Whitcroft } 13524a0df2efSAndy Whitcroft 13534a0df2efSAndy Whitcroft chomp($current_comment); 13544a0df2efSAndy Whitcroft return($current_comment); 13554a0df2efSAndy Whitcroft} 13564a0df2efSAndy Whitcroftsub ctx_has_comment { 13574a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13584a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13594a0df2efSAndy Whitcroft 136000df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13614a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13624a0df2efSAndy Whitcroft 13634a0df2efSAndy Whitcroft return ($cmt ne ''); 13644a0df2efSAndy Whitcroft} 13654a0df2efSAndy Whitcroft 13664d001e4dSAndy Whitcroftsub raw_line { 13674d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13684d001e4dSAndy Whitcroft 13694d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13704d001e4dSAndy Whitcroft $cnt++; 13714d001e4dSAndy Whitcroft 13724d001e4dSAndy Whitcroft my $line; 13734d001e4dSAndy Whitcroft while ($cnt) { 13744d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13754d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13764d001e4dSAndy Whitcroft $cnt--; 13774d001e4dSAndy Whitcroft } 13784d001e4dSAndy Whitcroft 13794d001e4dSAndy Whitcroft return $line; 13804d001e4dSAndy Whitcroft} 13814d001e4dSAndy Whitcroft 13820a920b5bSAndy Whitcroftsub cat_vet { 13830a920b5bSAndy Whitcroft my ($vet) = @_; 13849c0ca6f9SAndy Whitcroft my ($res, $coded); 13850a920b5bSAndy Whitcroft 13869c0ca6f9SAndy Whitcroft $res = ''; 13876c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13886c72ffaaSAndy Whitcroft $res .= $1; 13896c72ffaaSAndy Whitcroft if ($2 ne '') { 13909c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 13916c72ffaaSAndy Whitcroft $res .= $coded; 13926c72ffaaSAndy Whitcroft } 13939c0ca6f9SAndy Whitcroft } 13949c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 13950a920b5bSAndy Whitcroft 13969c0ca6f9SAndy Whitcroft return $res; 13970a920b5bSAndy Whitcroft} 13980a920b5bSAndy Whitcroft 1399c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1400cf655043SAndy Whitcroftmy $av_pending; 1401c2fdda0dSAndy Whitcroftmy @av_paren_type; 14021f65f947SAndy Whitcroftmy $av_pend_colon; 1403c2fdda0dSAndy Whitcroft 1404c2fdda0dSAndy Whitcroftsub annotate_reset { 1405c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1406cf655043SAndy Whitcroft $av_pending = '_'; 1407cf655043SAndy Whitcroft @av_paren_type = ('E'); 14081f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1409c2fdda0dSAndy Whitcroft} 1410c2fdda0dSAndy Whitcroft 14116c72ffaaSAndy Whitcroftsub annotate_values { 14126c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 14136c72ffaaSAndy Whitcroft 14146c72ffaaSAndy Whitcroft my $res; 14151f65f947SAndy Whitcroft my $var = '_' x length($stream); 14166c72ffaaSAndy Whitcroft my $cur = $stream; 14176c72ffaaSAndy Whitcroft 1418c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 14196c72ffaaSAndy Whitcroft 14206c72ffaaSAndy Whitcroft while (length($cur)) { 1421773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1422cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1423171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 14246c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1425c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1426c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1427cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1428c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14296c72ffaaSAndy Whitcroft } 14306c72ffaaSAndy Whitcroft 1431c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14329446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14339446ef56SAndy Whitcroft push(@av_paren_type, $type); 1434addcdceaSAndy Whitcroft $type = 'c'; 14359446ef56SAndy Whitcroft 1436e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1437c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14386c72ffaaSAndy Whitcroft $type = 'T'; 14396c72ffaaSAndy Whitcroft 1440389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1441389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1442389a2fe5SAndy Whitcroft $type = 'T'; 1443389a2fe5SAndy Whitcroft 1444c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1445171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1446c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1447171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1448171ae1a4SAndy Whitcroft if ($2 ne '') { 1449cf655043SAndy Whitcroft $av_pending = 'N'; 1450171ae1a4SAndy Whitcroft } 1451171ae1a4SAndy Whitcroft $type = 'E'; 1452171ae1a4SAndy Whitcroft 1453c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1454171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1455171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1456171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14576c72ffaaSAndy Whitcroft 1458c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1459cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1460c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1461cf655043SAndy Whitcroft 1462cf655043SAndy Whitcroft push(@av_paren_type, $type); 1463cf655043SAndy Whitcroft push(@av_paren_type, $type); 1464171ae1a4SAndy Whitcroft $type = 'E'; 1465cf655043SAndy Whitcroft 1466c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1467cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1468cf655043SAndy Whitcroft $av_preprocessor = 1; 1469cf655043SAndy Whitcroft 1470cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1471cf655043SAndy Whitcroft 1472171ae1a4SAndy Whitcroft $type = 'E'; 1473cf655043SAndy Whitcroft 1474c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1475cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1476cf655043SAndy Whitcroft 1477cf655043SAndy Whitcroft $av_preprocessor = 1; 1478cf655043SAndy Whitcroft 1479cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1480cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1481cf655043SAndy Whitcroft pop(@av_paren_type); 1482cf655043SAndy Whitcroft push(@av_paren_type, $type); 1483171ae1a4SAndy Whitcroft $type = 'E'; 14846c72ffaaSAndy Whitcroft 14856c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1486c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14876c72ffaaSAndy Whitcroft 1488171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1489171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1490171ae1a4SAndy Whitcroft $av_pending = $type; 1491171ae1a4SAndy Whitcroft $type = 'N'; 1492171ae1a4SAndy Whitcroft 14936c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1494c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 14956c72ffaaSAndy Whitcroft if (defined $2) { 1496cf655043SAndy Whitcroft $av_pending = 'V'; 14976c72ffaaSAndy Whitcroft } 14986c72ffaaSAndy Whitcroft $type = 'N'; 14996c72ffaaSAndy Whitcroft 150014b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1501c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 150214b111c1SAndy Whitcroft $av_pending = 'E'; 15036c72ffaaSAndy Whitcroft $type = 'N'; 15046c72ffaaSAndy Whitcroft 15051f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 15061f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 15071f65f947SAndy Whitcroft $av_pend_colon = 'C'; 15081f65f947SAndy Whitcroft $type = 'N'; 15091f65f947SAndy Whitcroft 151014b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1511c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 15126c72ffaaSAndy Whitcroft $type = 'N'; 15136c72ffaaSAndy Whitcroft 15146c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1515c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1516cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1517cf655043SAndy Whitcroft $av_pending = '_'; 15186c72ffaaSAndy Whitcroft $type = 'N'; 15196c72ffaaSAndy Whitcroft 15206c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1521cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1522cf655043SAndy Whitcroft if ($new_type ne '_') { 1523cf655043SAndy Whitcroft $type = $new_type; 1524c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1525c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 15266c72ffaaSAndy Whitcroft } else { 1527c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 15286c72ffaaSAndy Whitcroft } 15296c72ffaaSAndy Whitcroft 1530c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1531c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1532c8cb2ca3SAndy Whitcroft $type = 'V'; 1533cf655043SAndy Whitcroft $av_pending = 'V'; 15346c72ffaaSAndy Whitcroft 15358e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15368e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15371f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15388e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15398e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15401f65f947SAndy Whitcroft } 15411f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15421f65f947SAndy Whitcroft $type = 'V'; 15431f65f947SAndy Whitcroft 15446c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1545c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15466c72ffaaSAndy Whitcroft $type = 'V'; 15476c72ffaaSAndy Whitcroft 15486c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1549c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15506c72ffaaSAndy Whitcroft $type = 'N'; 15516c72ffaaSAndy Whitcroft 1552cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1553c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 155413214adfSAndy Whitcroft $type = 'E'; 15551f65f947SAndy Whitcroft $av_pend_colon = 'O'; 155613214adfSAndy Whitcroft 15578e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15588e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15598e761b04SAndy Whitcroft $type = 'C'; 15608e761b04SAndy Whitcroft 15611f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15621f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15631f65f947SAndy Whitcroft $type = 'N'; 15641f65f947SAndy Whitcroft 15651f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15661f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15671f65f947SAndy Whitcroft 15681f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15691f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15701f65f947SAndy Whitcroft $type = 'E'; 15711f65f947SAndy Whitcroft } else { 15721f65f947SAndy Whitcroft $type = 'N'; 15731f65f947SAndy Whitcroft } 15741f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15751f65f947SAndy Whitcroft 15768e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 157713214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15786c72ffaaSAndy Whitcroft $type = 'N'; 15796c72ffaaSAndy Whitcroft 15800d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 158174048ed8SAndy Whitcroft my $variant; 158274048ed8SAndy Whitcroft 158374048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 158474048ed8SAndy Whitcroft if ($type eq 'V') { 158574048ed8SAndy Whitcroft $variant = 'B'; 158674048ed8SAndy Whitcroft } else { 158774048ed8SAndy Whitcroft $variant = 'U'; 158874048ed8SAndy Whitcroft } 158974048ed8SAndy Whitcroft 159074048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 159174048ed8SAndy Whitcroft $type = 'N'; 159274048ed8SAndy Whitcroft 15936c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1594c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 15956c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 15966c72ffaaSAndy Whitcroft $type = 'N'; 15976c72ffaaSAndy Whitcroft } 15986c72ffaaSAndy Whitcroft 15996c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1600c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 16016c72ffaaSAndy Whitcroft } 16026c72ffaaSAndy Whitcroft if (defined $1) { 16036c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 16046c72ffaaSAndy Whitcroft $res .= $type x length($1); 16056c72ffaaSAndy Whitcroft } 16066c72ffaaSAndy Whitcroft } 16076c72ffaaSAndy Whitcroft 16081f65f947SAndy Whitcroft return ($res, $var); 16096c72ffaaSAndy Whitcroft} 16106c72ffaaSAndy Whitcroft 16118905a67cSAndy Whitcroftsub possible { 161213214adfSAndy Whitcroft my ($possible, $line) = @_; 16139a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 16140776e594SAndy Whitcroft ^(?: 16150776e594SAndy Whitcroft $Modifier| 16160776e594SAndy Whitcroft $Storage| 16170776e594SAndy Whitcroft $Type| 16189a974fdbSAndy Whitcroft DEFINE_\S+ 16199a974fdbSAndy Whitcroft )$| 16209a974fdbSAndy Whitcroft ^(?: 16210776e594SAndy Whitcroft goto| 16220776e594SAndy Whitcroft return| 16230776e594SAndy Whitcroft case| 16240776e594SAndy Whitcroft else| 16250776e594SAndy Whitcroft asm|__asm__| 162689a88353SAndy Whitcroft do| 162789a88353SAndy Whitcroft \#| 162889a88353SAndy Whitcroft \#\#| 16299a974fdbSAndy Whitcroft )(?:\s|$)| 16300776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16319a974fdbSAndy Whitcroft )}x; 16329a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16339a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1634c45dcabdSAndy Whitcroft # Check for modifiers. 1635c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1636c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1637c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1638c45dcabdSAndy Whitcroft 1639c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1640c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1641d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16429a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1643d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1644485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1645d2506586SAndy Whitcroft } 16469a974fdbSAndy Whitcroft } 1647c45dcabdSAndy Whitcroft 1648c45dcabdSAndy Whitcroft } else { 164913214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1650485ff23eSAlex Dowad push(@typeListFile, $possible); 1651c45dcabdSAndy Whitcroft } 16528905a67cSAndy Whitcroft build_types(); 16530776e594SAndy Whitcroft } else { 16540776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16558905a67cSAndy Whitcroft } 16568905a67cSAndy Whitcroft} 16578905a67cSAndy Whitcroft 16586c72ffaaSAndy Whitcroftmy $prefix = ''; 16596c72ffaaSAndy Whitcroft 1660000d1cc1SJoe Perchessub show_type { 1661cbec18afSJoe Perches my ($type) = @_; 166291bfe484SJoe Perches 1663cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1664cbec18afSJoe Perches 1665cbec18afSJoe Perches return !defined $ignore_type{$type}; 1666000d1cc1SJoe Perches} 1667000d1cc1SJoe Perches 1668f0a594c1SAndy Whitcroftsub report { 1669cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1670cbec18afSJoe Perches 1671cbec18afSJoe Perches if (!show_type($type) || 1672cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1673773647a0SAndy Whitcroft return 0; 1674773647a0SAndy Whitcroft } 1675000d1cc1SJoe Perches my $line; 1676000d1cc1SJoe Perches if ($show_types) { 1677cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1678000d1cc1SJoe Perches } else { 1679cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1680000d1cc1SJoe Perches } 16818905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 16828905a67cSAndy Whitcroft 168313214adfSAndy Whitcroft push(our @report, $line); 1684773647a0SAndy Whitcroft 1685773647a0SAndy Whitcroft return 1; 1686f0a594c1SAndy Whitcroft} 1687cbec18afSJoe Perches 1688f0a594c1SAndy Whitcroftsub report_dump { 168913214adfSAndy Whitcroft our @report; 1690f0a594c1SAndy Whitcroft} 1691000d1cc1SJoe Perches 1692d752fcc8SJoe Perchessub fixup_current_range { 1693d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1694d752fcc8SJoe Perches 1695d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1696d752fcc8SJoe Perches my $o = $1; 1697d752fcc8SJoe Perches my $l = $2; 1698d752fcc8SJoe Perches my $no = $o + $offset; 1699d752fcc8SJoe Perches my $nl = $l + $length; 1700d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1701d752fcc8SJoe Perches } 1702d752fcc8SJoe Perches} 1703d752fcc8SJoe Perches 1704d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1705d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1706d752fcc8SJoe Perches 1707d752fcc8SJoe Perches my $range_last_linenr = 0; 1708d752fcc8SJoe Perches my $delta_offset = 0; 1709d752fcc8SJoe Perches 1710d752fcc8SJoe Perches my $old_linenr = 0; 1711d752fcc8SJoe Perches my $new_linenr = 0; 1712d752fcc8SJoe Perches 1713d752fcc8SJoe Perches my $next_insert = 0; 1714d752fcc8SJoe Perches my $next_delete = 0; 1715d752fcc8SJoe Perches 1716d752fcc8SJoe Perches my @lines = (); 1717d752fcc8SJoe Perches 1718d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1719d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1720d752fcc8SJoe Perches 1721d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1722d752fcc8SJoe Perches my $save_line = 1; 1723d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1724323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1725d752fcc8SJoe Perches $delta_offset = 0; 1726d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1727d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1728d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1729d752fcc8SJoe Perches } 1730d752fcc8SJoe Perches 1731d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1732d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1733d752fcc8SJoe Perches $save_line = 0; 1734d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1735d752fcc8SJoe Perches } 1736d752fcc8SJoe Perches 1737d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1738d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1739d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1740d752fcc8SJoe Perches $new_linenr++; 1741d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1742d752fcc8SJoe Perches } 1743d752fcc8SJoe Perches 1744d752fcc8SJoe Perches if ($save_line) { 1745d752fcc8SJoe Perches push(@lines, $line); 1746d752fcc8SJoe Perches $new_linenr++; 1747d752fcc8SJoe Perches } 1748d752fcc8SJoe Perches 1749d752fcc8SJoe Perches $old_linenr++; 1750d752fcc8SJoe Perches } 1751d752fcc8SJoe Perches 1752d752fcc8SJoe Perches return @lines; 1753d752fcc8SJoe Perches} 1754d752fcc8SJoe Perches 1755f2d7e4d4SJoe Perchessub fix_insert_line { 1756f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1757f2d7e4d4SJoe Perches 1758f2d7e4d4SJoe Perches my $inserted = { 1759f2d7e4d4SJoe Perches LINENR => $linenr, 1760f2d7e4d4SJoe Perches LINE => $line, 1761f2d7e4d4SJoe Perches }; 1762f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1763f2d7e4d4SJoe Perches} 1764f2d7e4d4SJoe Perches 1765f2d7e4d4SJoe Perchessub fix_delete_line { 1766f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1767f2d7e4d4SJoe Perches 1768f2d7e4d4SJoe Perches my $deleted = { 1769f2d7e4d4SJoe Perches LINENR => $linenr, 1770f2d7e4d4SJoe Perches LINE => $line, 1771f2d7e4d4SJoe Perches }; 1772f2d7e4d4SJoe Perches 1773f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1774f2d7e4d4SJoe Perches} 1775f2d7e4d4SJoe Perches 1776de7d4f0eSAndy Whitcroftsub ERROR { 1777cbec18afSJoe Perches my ($type, $msg) = @_; 1778cbec18afSJoe Perches 1779cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1780de7d4f0eSAndy Whitcroft our $clean = 0; 17816c72ffaaSAndy Whitcroft our $cnt_error++; 17823705ce5bSJoe Perches return 1; 1783de7d4f0eSAndy Whitcroft } 17843705ce5bSJoe Perches return 0; 1785773647a0SAndy Whitcroft} 1786de7d4f0eSAndy Whitcroftsub WARN { 1787cbec18afSJoe Perches my ($type, $msg) = @_; 1788cbec18afSJoe Perches 1789cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1790de7d4f0eSAndy Whitcroft our $clean = 0; 17916c72ffaaSAndy Whitcroft our $cnt_warn++; 17923705ce5bSJoe Perches return 1; 1793de7d4f0eSAndy Whitcroft } 17943705ce5bSJoe Perches return 0; 1795773647a0SAndy Whitcroft} 1796de7d4f0eSAndy Whitcroftsub CHK { 1797cbec18afSJoe Perches my ($type, $msg) = @_; 1798cbec18afSJoe Perches 1799cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1800de7d4f0eSAndy Whitcroft our $clean = 0; 18016c72ffaaSAndy Whitcroft our $cnt_chk++; 18023705ce5bSJoe Perches return 1; 18036c72ffaaSAndy Whitcroft } 18043705ce5bSJoe Perches return 0; 1805de7d4f0eSAndy Whitcroft} 1806de7d4f0eSAndy Whitcroft 18076ecd9674SAndy Whitcroftsub check_absolute_file { 18086ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 18096ecd9674SAndy Whitcroft my $file = $absolute; 18106ecd9674SAndy Whitcroft 18116ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 18126ecd9674SAndy Whitcroft 18136ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 18146ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 18156ecd9674SAndy Whitcroft if (-f "$root/$file") { 18166ecd9674SAndy Whitcroft ##print "file<$file>\n"; 18176ecd9674SAndy Whitcroft last; 18186ecd9674SAndy Whitcroft } 18196ecd9674SAndy Whitcroft } 18206ecd9674SAndy Whitcroft if (! -f _) { 18216ecd9674SAndy Whitcroft return 0; 18226ecd9674SAndy Whitcroft } 18236ecd9674SAndy Whitcroft 18246ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 18256ecd9674SAndy Whitcroft my $prefix = $absolute; 18266ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 18276ecd9674SAndy Whitcroft 18286ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18296ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1830000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1831000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18326ecd9674SAndy Whitcroft } 18336ecd9674SAndy Whitcroft} 18346ecd9674SAndy Whitcroft 18353705ce5bSJoe Perchessub trim { 18363705ce5bSJoe Perches my ($string) = @_; 18373705ce5bSJoe Perches 1838b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1839b34c648bSJoe Perches 1840b34c648bSJoe Perches return $string; 1841b34c648bSJoe Perches} 1842b34c648bSJoe Perches 1843b34c648bSJoe Perchessub ltrim { 1844b34c648bSJoe Perches my ($string) = @_; 1845b34c648bSJoe Perches 1846b34c648bSJoe Perches $string =~ s/^\s+//; 1847b34c648bSJoe Perches 1848b34c648bSJoe Perches return $string; 1849b34c648bSJoe Perches} 1850b34c648bSJoe Perches 1851b34c648bSJoe Perchessub rtrim { 1852b34c648bSJoe Perches my ($string) = @_; 1853b34c648bSJoe Perches 1854b34c648bSJoe Perches $string =~ s/\s+$//; 18553705ce5bSJoe Perches 18563705ce5bSJoe Perches return $string; 18573705ce5bSJoe Perches} 18583705ce5bSJoe Perches 185952ea8506SJoe Perchessub string_find_replace { 186052ea8506SJoe Perches my ($string, $find, $replace) = @_; 186152ea8506SJoe Perches 186252ea8506SJoe Perches $string =~ s/$find/$replace/g; 186352ea8506SJoe Perches 186452ea8506SJoe Perches return $string; 186552ea8506SJoe Perches} 186652ea8506SJoe Perches 18673705ce5bSJoe Perchessub tabify { 18683705ce5bSJoe Perches my ($leading) = @_; 18693705ce5bSJoe Perches 18703705ce5bSJoe Perches my $source_indent = 8; 18713705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 18723705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 18733705ce5bSJoe Perches 18743705ce5bSJoe Perches #convert leading spaces to tabs 18753705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 18763705ce5bSJoe Perches #Remove spaces before a tab 18773705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 18783705ce5bSJoe Perches 18793705ce5bSJoe Perches return "$leading"; 18803705ce5bSJoe Perches} 18813705ce5bSJoe Perches 1882d1fe9c09SJoe Perchessub pos_last_openparen { 1883d1fe9c09SJoe Perches my ($line) = @_; 1884d1fe9c09SJoe Perches 1885d1fe9c09SJoe Perches my $pos = 0; 1886d1fe9c09SJoe Perches 1887d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1888d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1889d1fe9c09SJoe Perches 1890d1fe9c09SJoe Perches my $last_openparen = 0; 1891d1fe9c09SJoe Perches 1892d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1893d1fe9c09SJoe Perches return -1; 1894d1fe9c09SJoe Perches } 1895d1fe9c09SJoe Perches 1896d1fe9c09SJoe Perches my $len = length($line); 1897d1fe9c09SJoe Perches 1898d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1899d1fe9c09SJoe Perches my $string = substr($line, $pos); 1900d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1901d1fe9c09SJoe Perches $pos += length($1) - 1; 1902d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1903d1fe9c09SJoe Perches $last_openparen = $pos; 1904d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1905d1fe9c09SJoe Perches last; 1906d1fe9c09SJoe Perches } 1907d1fe9c09SJoe Perches } 1908d1fe9c09SJoe Perches 190991cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1910d1fe9c09SJoe Perches} 1911d1fe9c09SJoe Perches 19120a920b5bSAndy Whitcroftsub process { 19130a920b5bSAndy Whitcroft my $filename = shift; 19140a920b5bSAndy Whitcroft 19150a920b5bSAndy Whitcroft my $linenr=0; 19160a920b5bSAndy Whitcroft my $prevline=""; 1917c2fdda0dSAndy Whitcroft my $prevrawline=""; 19180a920b5bSAndy Whitcroft my $stashline=""; 1919c2fdda0dSAndy Whitcroft my $stashrawline=""; 19200a920b5bSAndy Whitcroft 19214a0df2efSAndy Whitcroft my $length; 19220a920b5bSAndy Whitcroft my $indent; 19230a920b5bSAndy Whitcroft my $previndent=0; 19240a920b5bSAndy Whitcroft my $stashindent=0; 19250a920b5bSAndy Whitcroft 1926de7d4f0eSAndy Whitcroft our $clean = 1; 19270a920b5bSAndy Whitcroft my $signoff = 0; 19280a920b5bSAndy Whitcroft my $is_patch = 0; 19290a920b5bSAndy Whitcroft 193029ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 193115662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 19322a076f40SJoe Perches my $commit_log_long_line = 0; 193313f1937eSJoe Perches my $reported_maintainer_file = 0; 1934fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1935fa64205dSPasi Savanainen 1936365dd4eaSJoe Perches my $last_blank_line = 0; 19375e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1938365dd4eaSJoe Perches 193913214adfSAndy Whitcroft our @report = (); 19406c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19416c72ffaaSAndy Whitcroft our $cnt_error = 0; 19426c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19436c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19446c72ffaaSAndy Whitcroft 19450a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19460a920b5bSAndy Whitcroft my $realfile = ''; 19470a920b5bSAndy Whitcroft my $realline = 0; 19480a920b5bSAndy Whitcroft my $realcnt = 0; 19490a920b5bSAndy Whitcroft my $here = ''; 19500a920b5bSAndy Whitcroft my $in_comment = 0; 1951c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19520a920b5bSAndy Whitcroft my $first_line = 0; 19531e855726SWolfram Sang my $p1_prefix = ''; 19540a920b5bSAndy Whitcroft 195513214adfSAndy Whitcroft my $prev_values = 'E'; 195613214adfSAndy Whitcroft 195713214adfSAndy Whitcroft # suppression flags 1958773647a0SAndy Whitcroft my %suppress_ifbraces; 1959170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19602b474a1aSAndy Whitcroft my %suppress_export; 19613e469cdcSAndy Whitcroft my $suppress_statement = 0; 1962653d4876SAndy Whitcroft 19637e51f197SJoe Perches my %signatures = (); 1964323c1260SJoe Perches 1965c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1966de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1967c2fdda0dSAndy Whitcroft # 1968de7d4f0eSAndy Whitcroft my @setup_docs = (); 1969de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1970773647a0SAndy Whitcroft 1971d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1972d8b07710SJoe Perches 1973773647a0SAndy Whitcroft sanitise_line_reset(); 1974c2fdda0dSAndy Whitcroft my $line; 1975c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1976773647a0SAndy Whitcroft $linenr++; 1977773647a0SAndy Whitcroft $line = $rawline; 1978c2fdda0dSAndy Whitcroft 19793705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 19803705ce5bSJoe Perches 1981773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1982de7d4f0eSAndy Whitcroft $setup_docs = 0; 1983de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1984de7d4f0eSAndy Whitcroft $setup_docs = 1; 1985de7d4f0eSAndy Whitcroft } 1986773647a0SAndy Whitcroft #next; 1987de7d4f0eSAndy Whitcroft } 1988773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1989773647a0SAndy Whitcroft $realline=$1-1; 1990773647a0SAndy Whitcroft if (defined $2) { 1991773647a0SAndy Whitcroft $realcnt=$3+1; 1992773647a0SAndy Whitcroft } else { 1993773647a0SAndy Whitcroft $realcnt=1+1; 1994773647a0SAndy Whitcroft } 1995c45dcabdSAndy Whitcroft $in_comment = 0; 1996773647a0SAndy Whitcroft 1997773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1998773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1999773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2000773647a0SAndy Whitcroft # at context start. 2001773647a0SAndy Whitcroft my $edge; 200201fa9147SAndy Whitcroft my $cnt = $realcnt; 200301fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 200401fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 200501fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 200601fa9147SAndy Whitcroft $cnt--; 200701fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2008721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2009fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2010fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2011fae17daeSAndy Whitcroft ($edge) = $1; 2012fae17daeSAndy Whitcroft last; 2013fae17daeSAndy Whitcroft } 2014773647a0SAndy Whitcroft } 2015773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2016773647a0SAndy Whitcroft $in_comment = 1; 2017773647a0SAndy Whitcroft } 2018773647a0SAndy Whitcroft 2019773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2020773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2021773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2022773647a0SAndy Whitcroft if (!defined $edge && 202383242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2024773647a0SAndy Whitcroft { 2025773647a0SAndy Whitcroft $in_comment = 1; 2026773647a0SAndy Whitcroft } 2027773647a0SAndy Whitcroft 2028773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2029773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2030773647a0SAndy Whitcroft 2031171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2032773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2033171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2034773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2035773647a0SAndy Whitcroft } 2036773647a0SAndy Whitcroft push(@lines, $line); 2037773647a0SAndy Whitcroft 2038773647a0SAndy Whitcroft if ($realcnt > 1) { 2039773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2040773647a0SAndy Whitcroft } else { 2041773647a0SAndy Whitcroft $realcnt = 0; 2042773647a0SAndy Whitcroft } 2043773647a0SAndy Whitcroft 2044773647a0SAndy Whitcroft #print "==>$rawline\n"; 2045773647a0SAndy Whitcroft #print "-->$line\n"; 2046de7d4f0eSAndy Whitcroft 2047de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2048de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2049de7d4f0eSAndy Whitcroft } 2050de7d4f0eSAndy Whitcroft } 2051de7d4f0eSAndy Whitcroft 20526c72ffaaSAndy Whitcroft $prefix = ''; 20536c72ffaaSAndy Whitcroft 2054773647a0SAndy Whitcroft $realcnt = 0; 2055773647a0SAndy Whitcroft $linenr = 0; 2056194f66fcSJoe Perches $fixlinenr = -1; 20570a920b5bSAndy Whitcroft foreach my $line (@lines) { 20580a920b5bSAndy Whitcroft $linenr++; 2059194f66fcSJoe Perches $fixlinenr++; 20601b5539b1SJoe Perches my $sline = $line; #copy of $line 20611b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20620a920b5bSAndy Whitcroft 2063c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20646c72ffaaSAndy Whitcroft 20650a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 20666c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20670a920b5bSAndy Whitcroft $is_patch = 1; 20684a0df2efSAndy Whitcroft $first_line = $linenr + 1; 20690a920b5bSAndy Whitcroft $realline=$1-1; 20700a920b5bSAndy Whitcroft if (defined $2) { 20710a920b5bSAndy Whitcroft $realcnt=$3+1; 20720a920b5bSAndy Whitcroft } else { 20730a920b5bSAndy Whitcroft $realcnt=1+1; 20740a920b5bSAndy Whitcroft } 2075c2fdda0dSAndy Whitcroft annotate_reset(); 207613214adfSAndy Whitcroft $prev_values = 'E'; 207713214adfSAndy Whitcroft 2078773647a0SAndy Whitcroft %suppress_ifbraces = (); 2079170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 20802b474a1aSAndy Whitcroft %suppress_export = (); 20813e469cdcSAndy Whitcroft $suppress_statement = 0; 20820a920b5bSAndy Whitcroft next; 20830a920b5bSAndy Whitcroft 20844a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 20854a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 20864a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2087773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 20880a920b5bSAndy Whitcroft $realline++; 2089d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 20900a920b5bSAndy Whitcroft 20914a0df2efSAndy Whitcroft # Measure the line length and indent. 2092c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 20930a920b5bSAndy Whitcroft 20940a920b5bSAndy Whitcroft # Track the previous line. 20950a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 20960a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2097c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2098c2fdda0dSAndy Whitcroft 2099773647a0SAndy Whitcroft #warn "line<$line>\n"; 21006c72ffaaSAndy Whitcroft 2101d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2102d8aaf121SAndy Whitcroft $realcnt--; 21030a920b5bSAndy Whitcroft } 21040a920b5bSAndy Whitcroft 2105cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2106cc77cdcaSAndy Whitcroft 21070a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 2108773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 2109773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 2110773647a0SAndy Whitcroft 21116c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 21126c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2113773647a0SAndy Whitcroft 21142ac73b4fSJoe Perches my $found_file = 0; 2115773647a0SAndy Whitcroft # extract the filename as it passes 21163bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 21173bf9a009SRabin Vincent $realfile = $1; 21182b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2119270c49a0SJoe Perches $in_commit_log = 0; 21202ac73b4fSJoe Perches $found_file = 1; 21213bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2122773647a0SAndy Whitcroft $realfile = $1; 21232b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2124270c49a0SJoe Perches $in_commit_log = 0; 21251e855726SWolfram Sang 21261e855726SWolfram Sang $p1_prefix = $1; 2127e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2128e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2129000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2130000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21311e855726SWolfram Sang } 2132773647a0SAndy Whitcroft 2133c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2134000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2135000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2136773647a0SAndy Whitcroft } 21372ac73b4fSJoe Perches $found_file = 1; 21382ac73b4fSJoe Perches } 21392ac73b4fSJoe Perches 21402ac73b4fSJoe Perches if ($found_file) { 21412ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 21422ac73b4fSJoe Perches $check = 1; 21432ac73b4fSJoe Perches } else { 21442ac73b4fSJoe Perches $check = $check_orig; 21452ac73b4fSJoe Perches } 2146773647a0SAndy Whitcroft next; 2147773647a0SAndy Whitcroft } 2148773647a0SAndy Whitcroft 2149389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21500a920b5bSAndy Whitcroft 2151c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2152c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2153c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21540a920b5bSAndy Whitcroft 21556c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21566c72ffaaSAndy Whitcroft 21573bf9a009SRabin Vincent# Check for incorrect file permissions 21583bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 21593bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 216004db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 216104db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2162000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2163000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 21643bf9a009SRabin Vincent } 21653bf9a009SRabin Vincent } 21663bf9a009SRabin Vincent 216720112475SJoe Perches# Check the patch for a signoff: 2168d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 21694a0df2efSAndy Whitcroft $signoff++; 217015662b3eSJoe Perches $in_commit_log = 0; 21710a920b5bSAndy Whitcroft } 217220112475SJoe Perches 2173e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2174e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2175e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2176e0d975b1SJoe Perches $reported_maintainer_file = 1; 2177e0d975b1SJoe Perches } 2178e0d975b1SJoe Perches 217920112475SJoe Perches# Check signature styles 2180270c49a0SJoe Perches if (!$in_header_lines && 2181ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 218220112475SJoe Perches my $space_before = $1; 218320112475SJoe Perches my $sign_off = $2; 218420112475SJoe Perches my $space_after = $3; 218520112475SJoe Perches my $email = $4; 218620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 218720112475SJoe Perches 2188ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2189ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2190ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2191ce0338dfSJoe Perches } 219220112475SJoe Perches if (defined $space_before && $space_before ne "") { 21933705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21943705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 21953705ce5bSJoe Perches $fix) { 2196194f66fcSJoe Perches $fixed[$fixlinenr] = 21973705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21983705ce5bSJoe Perches } 219920112475SJoe Perches } 220020112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22013705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22023705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22033705ce5bSJoe Perches $fix) { 2204194f66fcSJoe Perches $fixed[$fixlinenr] = 22053705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22063705ce5bSJoe Perches } 22073705ce5bSJoe Perches 220820112475SJoe Perches } 220920112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22103705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22113705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22123705ce5bSJoe Perches $fix) { 2213194f66fcSJoe Perches $fixed[$fixlinenr] = 22143705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22153705ce5bSJoe Perches } 221620112475SJoe Perches } 221720112475SJoe Perches 221820112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 221920112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 222020112475SJoe Perches if ($suggested_email eq "") { 2221000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2222000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 222320112475SJoe Perches } else { 222420112475SJoe Perches my $dequoted = $suggested_email; 222520112475SJoe Perches $dequoted =~ s/^"//; 222620112475SJoe Perches $dequoted =~ s/" </ </; 222720112475SJoe Perches # Don't force email to have quotes 222820112475SJoe Perches # Allow just an angle bracketed address 222920112475SJoe Perches if ("$dequoted$comment" ne $email && 223020112475SJoe Perches "<$email_address>$comment" ne $email && 223120112475SJoe Perches "$suggested_email$comment" ne $email) { 2232000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2233000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 223420112475SJoe Perches } 22350a920b5bSAndy Whitcroft } 22367e51f197SJoe Perches 22377e51f197SJoe Perches# Check for duplicate signatures 22387e51f197SJoe Perches my $sig_nospace = $line; 22397e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22407e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22417e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22427e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22437e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22447e51f197SJoe Perches } else { 22457e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22467e51f197SJoe Perches } 22470a920b5bSAndy Whitcroft } 22480a920b5bSAndy Whitcroft 2249a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2250a2fe16b9SJoe Perches if ($in_header_lines && 2251a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2252a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2253a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2254a2fe16b9SJoe Perches } 2255a2fe16b9SJoe Perches 22569b3189ebSJoe Perches# Check for old stable address 22579b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 22589b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 22599b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 22609b3189ebSJoe Perches } 22619b3189ebSJoe Perches 22627ebd05efSChristopher Covington# Check for unwanted Gerrit info 22637ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 22647ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 22657ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 22667ebd05efSChristopher Covington } 22677ebd05efSChristopher Covington 22682a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 22692a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 22702a076f40SJoe Perches length($line) > 75) { 22712a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 22722a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 22732a076f40SJoe Perches $commit_log_long_line = 1; 22742a076f40SJoe Perches } 22752a076f40SJoe Perches 22760d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 22770d7835fcSJoe Perches if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) { 2278d311cd44SJoe Perches my $init_char = $1; 2279d311cd44SJoe Perches my $orig_commit = lc($2); 22800d7835fcSJoe Perches my $short = 1; 22810d7835fcSJoe Perches my $long = 0; 22820d7835fcSJoe Perches my $case = 1; 22830d7835fcSJoe Perches my $space = 1; 22840d7835fcSJoe Perches my $hasdesc = 0; 228519c146a6SJoe Perches my $hasparens = 0; 22860d7835fcSJoe Perches my $id = '0123456789ab'; 22870d7835fcSJoe Perches my $orig_desc = "commit description"; 22880d7835fcSJoe Perches my $description = ""; 22890d7835fcSJoe Perches 22900d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 22910d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 22920d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 22930d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 22940d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 22950d7835fcSJoe Perches $orig_desc = $1; 229619c146a6SJoe Perches $hasparens = 1; 22970d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 22980d7835fcSJoe Perches defined $rawlines[$linenr] && 22990d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 23000d7835fcSJoe Perches $orig_desc = $1; 230119c146a6SJoe Perches $hasparens = 1; 2302b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2303b671fde0SJoe Perches defined $rawlines[$linenr] && 2304b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2305b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2306b671fde0SJoe Perches $orig_desc = $1; 2307b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2308b671fde0SJoe Perches $orig_desc .= " " . $1; 230919c146a6SJoe Perches $hasparens = 1; 23100d7835fcSJoe Perches } 23110d7835fcSJoe Perches 23120d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 23130d7835fcSJoe Perches $id, $orig_desc); 23140d7835fcSJoe Perches 231519c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2316d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 23170d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 23180d7835fcSJoe Perches } 2319d311cd44SJoe Perches } 2320d311cd44SJoe Perches 232113f1937eSJoe Perches# Check for added, moved or deleted files 232213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 232313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 232413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 232513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 232613f1937eSJoe Perches (defined($1) || defined($2))))) { 232713f1937eSJoe Perches $reported_maintainer_file = 1; 232813f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 232913f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 233013f1937eSJoe Perches } 233113f1937eSJoe Perches 233200df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 23338905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2334000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2335000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 23366c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2337de7d4f0eSAndy Whitcroft } 2338de7d4f0eSAndy Whitcroft 23396ecd9674SAndy Whitcroft# Check for absolute kernel paths. 23406ecd9674SAndy Whitcroft if ($tree) { 23416ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 23426ecd9674SAndy Whitcroft my $file = $1; 23436ecd9674SAndy Whitcroft 23446ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 23456ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 23466ecd9674SAndy Whitcroft # 23476ecd9674SAndy Whitcroft } else { 23486ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 23496ecd9674SAndy Whitcroft } 23506ecd9674SAndy Whitcroft } 23516ecd9674SAndy Whitcroft } 23526ecd9674SAndy Whitcroft 2353de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2354de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2355171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2356171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2357171ae1a4SAndy Whitcroft 2358171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2359171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2360171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2361171ae1a4SAndy Whitcroft 236234d99219SJoe Perches CHK("INVALID_UTF8", 2363000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 236400df344fSAndy Whitcroft } 23650a920b5bSAndy Whitcroft 236615662b3eSJoe Perches# Check if it's the start of a commit log 236715662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 236815662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 236929ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 237029ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 237115662b3eSJoe Perches $in_header_lines = 0; 237215662b3eSJoe Perches $in_commit_log = 1; 237315662b3eSJoe Perches } 237415662b3eSJoe Perches 2375fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2376fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2377fa64205dSPasi Savanainen if ($in_header_lines && 2378fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2379fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2380fa64205dSPasi Savanainen $non_utf8_charset = 1; 2381fa64205dSPasi Savanainen } 2382fa64205dSPasi Savanainen 2383fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 238415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2385fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 238615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 238715662b3eSJoe Perches } 238815662b3eSJoe Perches 238966b47b4aSKees Cook# Check for various typo / spelling mistakes 239066d7a382SJoe Perches if (defined($misspellings) && 239166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2392ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 239366b47b4aSKees Cook my $typo = $1; 239466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 239566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 239666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 239766b47b4aSKees Cook my $msg_type = \&WARN; 239866b47b4aSKees Cook $msg_type = \&CHK if ($file); 239966b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 240066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 240166b47b4aSKees Cook $fix) { 240266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 240366b47b4aSKees Cook } 240466b47b4aSKees Cook } 240566b47b4aSKees Cook } 240666b47b4aSKees Cook 240730670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 240830670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 240900df344fSAndy Whitcroft 24100a920b5bSAndy Whitcroft#trailing whitespace 24119c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2412c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2413d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2414d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2415d5e616fcSJoe Perches $fix) { 2416194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2417d5e616fcSJoe Perches } 2418c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2419c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24203705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 24213705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 24223705ce5bSJoe Perches $fix) { 2423194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 24243705ce5bSJoe Perches } 24253705ce5bSJoe Perches 2426d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 24270a920b5bSAndy Whitcroft } 24285368df20SAndy Whitcroft 24294783f894SJosh Triplett# Check for FSF mailing addresses. 2430109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 24313e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 24323e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 24334783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24344783f894SJosh Triplett my $msg_type = \&ERROR; 24354783f894SJosh Triplett $msg_type = \&CHK if ($file); 24364783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 24374783f894SJosh 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) 24384783f894SJosh Triplett } 24394783f894SJosh Triplett 24403354957aSAndi Kleen# check for Kconfig help text having a real description 24419fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 24429fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 24433354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 24448d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 24453354957aSAndi Kleen my $length = 0; 24469fe287d7SAndy Whitcroft my $cnt = $realcnt; 24479fe287d7SAndy Whitcroft my $ln = $linenr + 1; 24489fe287d7SAndy Whitcroft my $f; 2449a1385803SAndy Whitcroft my $is_start = 0; 24509fe287d7SAndy Whitcroft my $is_end = 0; 2451a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 24529fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 24539fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 24549fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 24559fe287d7SAndy Whitcroft 24569fe287d7SAndy Whitcroft next if ($f =~ /^-/); 24578d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2458a1385803SAndy Whitcroft 24598d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2460a1385803SAndy Whitcroft $is_start = 1; 24618d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2462a1385803SAndy Whitcroft $length = -1; 2463a1385803SAndy Whitcroft } 2464a1385803SAndy Whitcroft 24659fe287d7SAndy Whitcroft $f =~ s/^.//; 24663354957aSAndi Kleen $f =~ s/#.*//; 24673354957aSAndi Kleen $f =~ s/^\s+//; 24683354957aSAndi Kleen next if ($f =~ /^$/); 24699fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 24709fe287d7SAndy Whitcroft $is_end = 1; 24719fe287d7SAndy Whitcroft last; 24729fe287d7SAndy Whitcroft } 24733354957aSAndi Kleen $length++; 24743354957aSAndi Kleen } 247556193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2476000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 247756193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 247856193274SVadim Bendebury } 2479a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 24803354957aSAndi Kleen } 24813354957aSAndi Kleen 24821ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 24831ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 24841ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 24851ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 24861ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 24871ba8dfd1SKees Cook } 24881ba8dfd1SKees Cook 2489327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2490327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2491327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2492327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2493327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2494327953e9SChristoph Jaeger } 2495327953e9SChristoph Jaeger 2496c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2497c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2498c68e5878SArnaud Lacombe my $flag = $1; 2499c68e5878SArnaud Lacombe my $replacement = { 2500c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2501c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2502c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2503c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2504c68e5878SArnaud Lacombe }; 2505c68e5878SArnaud Lacombe 2506c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2507c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2508c68e5878SArnaud Lacombe } 2509c68e5878SArnaud Lacombe 2510bff5da43SRob Herring# check for DT compatible documentation 25117dd05b38SFlorian Vaussard if (defined $root && 25127dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 25137dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 25147dd05b38SFlorian Vaussard 2515bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2516bff5da43SRob Herring 2517cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2518cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2519cc93319bSFlorian Vaussard 2520bff5da43SRob Herring foreach my $compat (@compats) { 2521bff5da43SRob Herring my $compat2 = $compat; 2522185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2523185d566bSRob Herring my $compat3 = $compat; 2524185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2525185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2526bff5da43SRob Herring if ( $? >> 8 ) { 2527bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2528bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2529bff5da43SRob Herring } 2530bff5da43SRob Herring 25314fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 25324fbf32a6SFlorian Vaussard my $vendor = $1; 2533cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2534bff5da43SRob Herring if ( $? >> 8 ) { 2535bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2536cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2537bff5da43SRob Herring } 2538bff5da43SRob Herring } 2539bff5da43SRob Herring } 2540bff5da43SRob Herring 25415368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2542de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 25435368df20SAndy Whitcroft 254447e0c88bSJoe Perches# line length limit (with some exclusions) 254547e0c88bSJoe Perches# 254647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 254747e0c88bSJoe Perches# logging functions like pr_info that end in a string 254847e0c88bSJoe Perches# lines with a single string 254947e0c88bSJoe Perches# #defines that are a single string 255047e0c88bSJoe Perches# 255147e0c88bSJoe Perches# There are 3 different line length message types: 255247e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 255347e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 255447e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 255547e0c88bSJoe Perches# 255647e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 255747e0c88bSJoe Perches# 255847e0c88bSJoe Perches 255947e0c88bSJoe Perches if ($length > $max_line_length) { 256047e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 256147e0c88bSJoe Perches 256247e0c88bSJoe Perches # Check the allowed long line types first 256347e0c88bSJoe Perches 256447e0c88bSJoe Perches # logging functions that end in a string that starts 256547e0c88bSJoe Perches # before $max_line_length 256647e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 256747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 256847e0c88bSJoe Perches $msg_type = ""; 256947e0c88bSJoe Perches 257047e0c88bSJoe Perches # lines with only strings (w/ possible termination) 257147e0c88bSJoe Perches # #defines with only strings 257247e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 257347e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 257447e0c88bSJoe Perches $msg_type = ""; 257547e0c88bSJoe Perches 257647e0c88bSJoe Perches # Otherwise set the alternate message types 257747e0c88bSJoe Perches 257847e0c88bSJoe Perches # a comment starts before $max_line_length 257947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 258047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 258147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 258247e0c88bSJoe Perches 258347e0c88bSJoe Perches # a quoted string starts before $max_line_length 258447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 258547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 258647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 258747e0c88bSJoe Perches } 258847e0c88bSJoe Perches 258947e0c88bSJoe Perches if ($msg_type ne "" && 259047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 259147e0c88bSJoe Perches WARN($msg_type, 25926cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 25930a920b5bSAndy Whitcroft } 259447e0c88bSJoe Perches } 25950a920b5bSAndy Whitcroft 25968905a67cSAndy Whitcroft# check for adding lines without a newline. 25978905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2598000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2599000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 26008905a67cSAndy Whitcroft } 26018905a67cSAndy Whitcroft 260242e41c54SMike Frysinger# Blackfin: use hi/lo macros 260342e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 260442e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 260542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2606000d1cc1SJoe Perches ERROR("LO_MACRO", 2607000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 260842e41c54SMike Frysinger } 260942e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 261042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2611000d1cc1SJoe Perches ERROR("HI_MACRO", 2612000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 261342e41c54SMike Frysinger } 261442e41c54SMike Frysinger } 261542e41c54SMike Frysinger 2616b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2617de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 26180a920b5bSAndy Whitcroft 26190a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 26200a920b5bSAndy Whitcroft# more than 8 must use tabs. 2621c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2622c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2623c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2624d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26253705ce5bSJoe Perches if (ERROR("CODE_INDENT", 26263705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 26273705ce5bSJoe Perches $fix) { 2628194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 26293705ce5bSJoe Perches } 26300a920b5bSAndy Whitcroft } 26310a920b5bSAndy Whitcroft 263208e44365SAlberto Panizzo# check for space before tabs. 263308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 263408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26353705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 26363705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 26373705ce5bSJoe Perches $fix) { 2638194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2639d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2640194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2641c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 26423705ce5bSJoe Perches } 264308e44365SAlberto Panizzo } 264408e44365SAlberto Panizzo 2645d1fe9c09SJoe Perches# check for && or || at the start of a line 2646d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2647d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2648d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2649d1fe9c09SJoe Perches } 2650d1fe9c09SJoe Perches 2651d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2652d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 265391cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2654d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2655d1fe9c09SJoe Perches my $oldindent = $1; 2656d1fe9c09SJoe Perches my $rest = $2; 2657d1fe9c09SJoe Perches 2658d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2659d1fe9c09SJoe Perches if ($pos >= 0) { 2660b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2661b34a26f3SJoe Perches my $newindent = $2; 2662d1fe9c09SJoe Perches 2663d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2664d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2665d1fe9c09SJoe Perches " " x ($pos % 8); 2666d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2667d1fe9c09SJoe Perches 2668d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2669d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 26703705ce5bSJoe Perches 26713705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 26723705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 26733705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2674194f66fcSJoe Perches $fixed[$fixlinenr] =~ 26753705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 26763705ce5bSJoe Perches } 2677d1fe9c09SJoe Perches } 2678d1fe9c09SJoe Perches } 2679d1fe9c09SJoe Perches } 2680d1fe9c09SJoe Perches 26816ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 26826ab3a970SJoe Perches# avoid checking a few false positives: 26836ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 26846ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 26856ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 26866ab3a970SJoe Perches# multiline macros that define functions 26876ab3a970SJoe Perches# known attributes or the __attribute__ keyword 26886ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 26896ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 26903705ce5bSJoe Perches if (CHK("SPACING", 2691f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 26923705ce5bSJoe Perches $fix) { 2693194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2694f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 26953705ce5bSJoe Perches } 2696aad4f614SJoe Perches } 2697aad4f614SJoe Perches 269805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2699fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 270085ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 270185ad978cSJoe Perches $realline > 2) { 270205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 270305880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 270405880600SJoe Perches } 270505880600SJoe Perches 270605880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2707a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2708a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 270961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2710a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2711a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2712a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2713a605e32eSJoe Perches } 2714a605e32eSJoe Perches 2715a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2716c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2717c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2718c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2719c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 272005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 272105880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 272205880600SJoe Perches } 272305880600SJoe Perches 27247f619191SJoe Perches# check for missing blank lines after struct/union declarations 27257f619191SJoe Perches# with exceptions for various attributes and macros 27267f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 27277f619191SJoe Perches $line =~ /^\+/ && 27287f619191SJoe Perches !($line =~ /^\+\s*$/ || 27297f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 27307f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 27317f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 27327f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 27337f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 27347f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 27357f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2736d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2737d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2738d752fcc8SJoe Perches $fix) { 2739f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2740d752fcc8SJoe Perches } 27417f619191SJoe Perches } 27427f619191SJoe Perches 2743365dd4eaSJoe Perches# check for multiple consecutive blank lines 2744365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2745365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2746365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2747d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2748d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2749d752fcc8SJoe Perches $fix) { 2750f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2751d752fcc8SJoe Perches } 2752d752fcc8SJoe Perches 2753365dd4eaSJoe Perches $last_blank_line = $linenr; 2754365dd4eaSJoe Perches } 2755365dd4eaSJoe Perches 27563b617e3bSJoe Perches# check for missing blank lines after declarations 27573f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 27583f7bac03SJoe Perches # actual declarations 27593f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 27605a4e1fd3SJoe Perches # function pointer declarations 27615a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 27623f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 27633f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 27643f7bac03SJoe Perches # known declaration macros 27653f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 27663f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 27673f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 27683f7bac03SJoe Perches # other possible extensions of declaration lines 27693f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 27703f7bac03SJoe Perches # not starting a section or a macro "\" extended line 27713f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 27723f7bac03SJoe Perches # looks like a declaration 27733f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 27745a4e1fd3SJoe Perches # function pointer declarations 27755a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 27763f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 27773f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 27783f7bac03SJoe Perches # known declaration macros 27793f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 27803f7bac03SJoe Perches # start of struct or union or enum 27813b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 27823f7bac03SJoe Perches # start or end of block or continuation of declaration 27833f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 27843f7bac03SJoe Perches # bitfield continuation 27853f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 27863f7bac03SJoe Perches # other possible extensions of declaration lines 27873f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 27883f7bac03SJoe Perches # indentation of previous and current line are the same 27893f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2790d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2791d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2792d752fcc8SJoe Perches $fix) { 2793f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2794d752fcc8SJoe Perches } 27953b617e3bSJoe Perches } 27963b617e3bSJoe Perches 27975f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 27986b4c5bebSAndy Whitcroft# Exceptions: 27996b4c5bebSAndy Whitcroft# 1) within comments 28006b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 28016b4c5bebSAndy Whitcroft# 3) hanging labels 28023705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 28035f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28043705ce5bSJoe Perches if (WARN("LEADING_SPACE", 28053705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 28063705ce5bSJoe Perches $fix) { 2807194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28083705ce5bSJoe Perches } 28095f7ddae6SRaffaele Recalcati } 28105f7ddae6SRaffaele Recalcati 2811b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2812b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2813b9ea10d6SAndy Whitcroft 2814032a4c0fSJoe Perches# check indentation of any line with a bare else 2815840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2816032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2817032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2818032a4c0fSJoe Perches my $tabs = length($1) + 1; 2819840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2820840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2821840080a0SJoe Perches defined $lines[$linenr] && 2822840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2823032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2824032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2825032a4c0fSJoe Perches } 2826032a4c0fSJoe Perches } 2827032a4c0fSJoe Perches 2828c00df19aSJoe Perches# check indentation of a line with a break; 2829c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2830c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2831c00df19aSJoe Perches my $tabs = $1; 2832c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2833c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2834c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2835c00df19aSJoe Perches } 2836c00df19aSJoe Perches } 2837c00df19aSJoe Perches 28381ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 28391ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 28401ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 28411ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 28421ba8dfd1SKees Cook } 28431ba8dfd1SKees Cook 2844c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2845cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2846000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2847000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2848c2fdda0dSAndy Whitcroft } 284922f2a2efSAndy Whitcroft 285042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 285142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 285242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2853000d1cc1SJoe Perches ERROR("CSYNC", 2854000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 285542e41c54SMike Frysinger } 285642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 285742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2858000d1cc1SJoe Perches ERROR("SSYNC", 2859000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 286042e41c54SMike Frysinger } 286142e41c54SMike Frysinger 286256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 286356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 286456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 286556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 286656e77d70SJoe Perches } 286756e77d70SJoe Perches 28689c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 28692b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 28702b474a1aSAndy Whitcroft $realline_next); 28713e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 28723e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 28731b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2874170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2875f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2876171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2877171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2878171ae1a4SAndy Whitcroft 28793e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 28803e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 28813e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 28823e469cdcSAndy Whitcroft # until we hit end of it. 28833e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 28843e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 28853e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 28863e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 28873e469cdcSAndy Whitcroft } 2888f74bd194SAndy Whitcroft 28892b474a1aSAndy Whitcroft # Find the real next line. 28902b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 28912b474a1aSAndy Whitcroft if (defined $realline_next && 28922b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 28932b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 28942b474a1aSAndy Whitcroft $realline_next++; 28952b474a1aSAndy Whitcroft } 28962b474a1aSAndy Whitcroft 2897171ae1a4SAndy Whitcroft my $s = $stat; 2898171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2899cf655043SAndy Whitcroft 2900c2fdda0dSAndy Whitcroft # Ignore goto labels. 2901171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2902c2fdda0dSAndy Whitcroft 2903c2fdda0dSAndy Whitcroft # Ignore functions being called 2904171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2905c2fdda0dSAndy Whitcroft 2906463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2907463f2864SAndy Whitcroft 2908c45dcabdSAndy Whitcroft # declarations always start with types 2909d2506586SAndy 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) { 2910c45dcabdSAndy Whitcroft my $type = $1; 2911c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2912c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2913c45dcabdSAndy Whitcroft 29146c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2915a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2916c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2917c2fdda0dSAndy Whitcroft } 29188905a67cSAndy Whitcroft 29196c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 292065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2921c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 29229c0ca6f9SAndy Whitcroft } 29238905a67cSAndy Whitcroft 29248905a67cSAndy Whitcroft # Check for any sort of function declaration. 29258905a67cSAndy Whitcroft # int foo(something bar, other baz); 29268905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2927171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 29288905a67cSAndy Whitcroft my ($name_len) = length($1); 29298905a67cSAndy Whitcroft 2930cf655043SAndy Whitcroft my $ctx = $s; 2931773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 29328905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2933cf655043SAndy Whitcroft 29348905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2935c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 29368905a67cSAndy Whitcroft 2937c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 29388905a67cSAndy Whitcroft } 29398905a67cSAndy Whitcroft } 29408905a67cSAndy Whitcroft } 29418905a67cSAndy Whitcroft 29429c0ca6f9SAndy Whitcroft } 29439c0ca6f9SAndy Whitcroft 294400df344fSAndy Whitcroft# 294500df344fSAndy Whitcroft# Checks which may be anchored in the context. 294600df344fSAndy Whitcroft# 294700df344fSAndy Whitcroft 294800df344fSAndy Whitcroft# Check for switch () and associated case and default 294900df344fSAndy Whitcroft# statements should be at the same indent. 295000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 295100df344fSAndy Whitcroft my $err = ''; 295200df344fSAndy Whitcroft my $sep = ''; 295300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 295400df344fSAndy Whitcroft shift(@ctx); 295500df344fSAndy Whitcroft for my $ctx (@ctx) { 295600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 295700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 295800df344fSAndy Whitcroft $indent != $cindent) { 295900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 296000df344fSAndy Whitcroft $sep = ''; 296100df344fSAndy Whitcroft } else { 296200df344fSAndy Whitcroft $sep = "[...]\n"; 296300df344fSAndy Whitcroft } 296400df344fSAndy Whitcroft } 296500df344fSAndy Whitcroft if ($err ne '') { 2966000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2967000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2968de7d4f0eSAndy Whitcroft } 2969de7d4f0eSAndy Whitcroft } 2970de7d4f0eSAndy Whitcroft 2971de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2972de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 29730fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2974773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2975773647a0SAndy Whitcroft 29769c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 29778eef05ddSJoe Perches 29788eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 29798eef05ddSJoe Perches WARN("DEEP_INDENTATION", 29808eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 29818eef05ddSJoe Perches } 29828eef05ddSJoe Perches 2983de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2984de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2985de7d4f0eSAndy Whitcroft 2986548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2987548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2988de7d4f0eSAndy Whitcroft 2989548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2990548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2991548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2992548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2993548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2994773647a0SAndy Whitcroft $ctx_ln++; 2995773647a0SAndy Whitcroft } 2996548596d5SAndy Whitcroft 299753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 299853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2999773647a0SAndy Whitcroft 3000773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3001000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3002000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 300301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 300400df344fSAndy Whitcroft } 3005773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3006773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3007773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3008773647a0SAndy Whitcroft { 30099c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 30109c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3011000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3012000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 301301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 30149c0ca6f9SAndy Whitcroft } 30159c0ca6f9SAndy Whitcroft } 301600df344fSAndy Whitcroft } 301700df344fSAndy Whitcroft 30184d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 30190fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 30203e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 30213e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 30223e469cdcSAndy Whitcroft if (!defined $stat); 30234d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 30244d001e4dSAndy Whitcroft 30254d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 30264d001e4dSAndy Whitcroft 30274d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 30284d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 30294d001e4dSAndy Whitcroft # where necessary. 30304d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 30314d001e4dSAndy Whitcroft 30324d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 30336f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 30346f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 30354d001e4dSAndy Whitcroft 30364d001e4dSAndy Whitcroft # We want to check the first line inside the block 30374d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 30384d001e4dSAndy Whitcroft # 1) any blank line termination 30394d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 30404d001e4dSAndy Whitcroft # 3) any do (...) { 30414d001e4dSAndy Whitcroft my $continuation = 0; 30424d001e4dSAndy Whitcroft my $check = 0; 30434d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 30444d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 30454d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 30464d001e4dSAndy Whitcroft $continuation = 1; 30474d001e4dSAndy Whitcroft } 30489bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 30494d001e4dSAndy Whitcroft $check = 1; 30504d001e4dSAndy Whitcroft $cond_lines++; 30514d001e4dSAndy Whitcroft } 30524d001e4dSAndy Whitcroft 30534d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 30544d001e4dSAndy Whitcroft # preprocessor statement. 30554d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 30564d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 30574d001e4dSAndy Whitcroft $check = 0; 30584d001e4dSAndy Whitcroft } 30594d001e4dSAndy Whitcroft 30609bd49efeSAndy Whitcroft my $cond_ptr = -1; 3061740504c6SAndy Whitcroft $continuation = 0; 30629bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 30639bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 30644d001e4dSAndy Whitcroft 3065f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3066f16fa28fSAndy Whitcroft # is not linear. 3067f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3068f16fa28fSAndy Whitcroft $check = 0; 3069f16fa28fSAndy Whitcroft } 3070f16fa28fSAndy Whitcroft 30719bd49efeSAndy Whitcroft # Ignore: 30729bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 30739bd49efeSAndy Whitcroft # 2) preprocessor lines, and 30749bd49efeSAndy Whitcroft # 3) labels. 3075740504c6SAndy Whitcroft if ($continuation || 3076740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 30779bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 30789bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3079740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 308030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 30819bd49efeSAndy Whitcroft $cond_lines++; 30829bd49efeSAndy Whitcroft } 30834d001e4dSAndy Whitcroft } 308430dad6ebSAndy Whitcroft } 30854d001e4dSAndy Whitcroft 30864d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 30874d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 30884d001e4dSAndy Whitcroft 30894d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 30904d001e4dSAndy Whitcroft # this is not this patch's fault. 30914d001e4dSAndy Whitcroft if (!defined($stat_real) || 30924d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 30934d001e4dSAndy Whitcroft $check = 0; 30944d001e4dSAndy Whitcroft } 30954d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 30964d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 30974d001e4dSAndy Whitcroft } 30984d001e4dSAndy Whitcroft 30999bd49efeSAndy 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"; 31004d001e4dSAndy Whitcroft 31014d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 31024d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 3103000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3104000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 31054d001e4dSAndy Whitcroft } 31064d001e4dSAndy Whitcroft } 31074d001e4dSAndy Whitcroft 31086c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 31096c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 31101f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 31111f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 31126c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3113c2fdda0dSAndy Whitcroft if ($dbg_values) { 3114c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3115cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3116cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 31171f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3118c2fdda0dSAndy Whitcroft } 31196c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 31206c72ffaaSAndy Whitcroft 312100df344fSAndy Whitcroft#ignore lines not being added 31223705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 312300df344fSAndy Whitcroft 3124653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 31257429c690SAndy Whitcroft if ($dbg_type) { 31267429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3127000d1cc1SJoe Perches ERROR("TEST_TYPE", 3128000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 31297429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3130000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3131000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 31327429c690SAndy Whitcroft } 3133653d4876SAndy Whitcroft next; 3134653d4876SAndy Whitcroft } 3135a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3136a1ef277eSAndy Whitcroft if ($dbg_attr) { 31379360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3138000d1cc1SJoe Perches ERROR("TEST_ATTR", 3139000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 31409360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3141000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3142000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3143a1ef277eSAndy Whitcroft } 3144a1ef277eSAndy Whitcroft next; 3145a1ef277eSAndy Whitcroft } 3146653d4876SAndy Whitcroft 3147f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 314899423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 314999423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3150d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3151d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3152f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3153f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3154f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3155d752fcc8SJoe Perches my $fixedline = $prevrawline; 3156d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3157f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3158d752fcc8SJoe Perches $fixedline = $line; 3159d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3160f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3161d752fcc8SJoe Perches } 3162f0a594c1SAndy Whitcroft } 3163f0a594c1SAndy Whitcroft 316400df344fSAndy Whitcroft# 316500df344fSAndy Whitcroft# Checks which are anchored on the added line. 316600df344fSAndy Whitcroft# 316700df344fSAndy Whitcroft 3168653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3169c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3170653d4876SAndy Whitcroft my $path = $1; 3171653d4876SAndy Whitcroft if ($path =~ m{//}) { 3172000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3173495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3174495e9d84SJoe Perches } 3175495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3176495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3177495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3178653d4876SAndy Whitcroft } 3179653d4876SAndy Whitcroft } 3180653d4876SAndy Whitcroft 318100df344fSAndy Whitcroft# no C99 // comments 318200df344fSAndy Whitcroft if ($line =~ m{//}) { 31833705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 31843705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 31853705ce5bSJoe Perches $fix) { 3186194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 31873705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 31883705ce5bSJoe Perches my $comment = trim($1); 3189194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 31903705ce5bSJoe Perches } 31913705ce5bSJoe Perches } 319200df344fSAndy Whitcroft } 319300df344fSAndy Whitcroft # Remove C99 comments. 31940a920b5bSAndy Whitcroft $line =~ s@//.*@@; 31956c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 31960a920b5bSAndy Whitcroft 31972b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 31982b474a1aSAndy Whitcroft# the whole statement. 31992b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 32002b474a1aSAndy Whitcroft if (defined $realline_next && 32012b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 32022b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 32032b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32042b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32053cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 32063cbf62dfSAndy Whitcroft # a prefix: 32073cbf62dfSAndy Whitcroft # XXX(foo); 32083cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3209653d4876SAndy Whitcroft my $name = $1; 321087a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 32113cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 32123cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 32133cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 32143cbf62dfSAndy Whitcroft 32153cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 32162b474a1aSAndy Whitcroft \n.}\s*$| 321748012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 321848012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 321948012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 32202b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 32212b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 322248012058SAndy Whitcroft )/x) { 32232b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 32242b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 32252b474a1aSAndy Whitcroft } else { 32262b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 32270a920b5bSAndy Whitcroft } 32280a920b5bSAndy Whitcroft } 32292b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 32302b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 32312b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32322b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32332b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 32342b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 32352b474a1aSAndy Whitcroft } 32362b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 32372b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3238000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3239000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 32402b474a1aSAndy Whitcroft } 32410a920b5bSAndy Whitcroft 32425150bda4SJoe Eloff# check for global initialisers. 32435129e87cSJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) { 3244d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3245000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3246d5e616fcSJoe Perches $herecurr) && 3247d5e616fcSJoe Perches $fix) { 32485129e87cSJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/; 3249d5e616fcSJoe Perches } 3250f0a594c1SAndy Whitcroft } 32510a920b5bSAndy Whitcroft# check for static initialisers. 3252d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3253d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3254000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3255d5e616fcSJoe Perches $herecurr) && 3256d5e616fcSJoe Perches $fix) { 3257194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3258d5e616fcSJoe Perches } 32590a920b5bSAndy Whitcroft } 32600a920b5bSAndy Whitcroft 32611813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 32621813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 32631813087dSJoe Perches my $tmp = trim($1); 32641813087dSJoe Perches WARN("MISORDERED_TYPE", 32651813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 32661813087dSJoe Perches } 32671813087dSJoe Perches 3268cb710ecaSJoe Perches# check for static const char * arrays. 3269cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3270000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3271000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3272cb710ecaSJoe Perches $herecurr); 3273cb710ecaSJoe Perches } 3274cb710ecaSJoe Perches 3275cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3276cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3277000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3278000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3279cb710ecaSJoe Perches $herecurr); 3280cb710ecaSJoe Perches } 3281cb710ecaSJoe Perches 3282ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3283ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3284ab7e23f3SJoe Perches my $found = $1; 3285ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3286ab7e23f3SJoe Perches WARN("CONST_CONST", 3287ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3288ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3289ab7e23f3SJoe Perches WARN("CONST_CONST", 3290ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3291ab7e23f3SJoe Perches } 3292ab7e23f3SJoe Perches } 3293ab7e23f3SJoe Perches 32949b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 32959b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 32969b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 32979b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 32989b0fa60dSJoe Perches $herecurr); 32999b0fa60dSJoe Perches } 33009b0fa60dSJoe Perches 3301b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3302b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3303b598b670SJoe Perches my $array = $1; 3304b598b670SJoe 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*\))@) { 3305b598b670SJoe Perches my $array_div = $1; 3306b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3307b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3308b598b670SJoe Perches $fix) { 3309b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3310b598b670SJoe Perches } 3311b598b670SJoe Perches } 3312b598b670SJoe Perches } 3313b598b670SJoe Perches 3314b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3315b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3316b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3317b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3318b36190c5SJoe Perches $fix) { 3319194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3320b36190c5SJoe Perches } 3321b36190c5SJoe Perches } 3322b36190c5SJoe Perches 332392e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 332492e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 332592e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 332692e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 332792e112fdSJoe Perches $fix) { 3328194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 332992e112fdSJoe Perches } 333093ed0e2dSJoe Perches } 333193ed0e2dSJoe Perches 3332653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3333653d4876SAndy Whitcroft# make sense. 3334653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 33358054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3336c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 33378ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3338653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3339000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3340000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 33410a920b5bSAndy Whitcroft } 33420a920b5bSAndy Whitcroft 33430a920b5bSAndy Whitcroft# * goes on variable not on type 334465863862SAndy Whitcroft # (char*[ const]) 3345bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3346bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 33473705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3348d8aaf121SAndy Whitcroft 334965863862SAndy Whitcroft # Should start with a space. 335065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 335165863862SAndy Whitcroft # Should not end with a space. 335265863862SAndy Whitcroft $to =~ s/\s+$//; 335365863862SAndy Whitcroft # '*'s should not have spaces between. 3354f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 335565863862SAndy Whitcroft } 3356d8aaf121SAndy Whitcroft 33573705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 335865863862SAndy Whitcroft if ($from ne $to) { 33593705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 33603705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 33613705ce5bSJoe Perches $fix) { 33623705ce5bSJoe Perches my $sub_from = $ident; 33633705ce5bSJoe Perches my $sub_to = $ident; 33643705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3365194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33663705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 33673705ce5bSJoe Perches } 336865863862SAndy Whitcroft } 3369bfcb2cc7SAndy Whitcroft } 3370bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3371bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 33723705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3373d8aaf121SAndy Whitcroft 337465863862SAndy Whitcroft # Should start with a space. 337565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 337665863862SAndy Whitcroft # Should not end with a space. 337765863862SAndy Whitcroft $to =~ s/\s+$//; 337865863862SAndy Whitcroft # '*'s should not have spaces between. 3379f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 338065863862SAndy Whitcroft } 338165863862SAndy Whitcroft # Modifiers should have spaces. 338265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 338365863862SAndy Whitcroft 33843705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3385667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 33863705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 33873705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 33883705ce5bSJoe Perches $fix) { 33893705ce5bSJoe Perches 33903705ce5bSJoe Perches my $sub_from = $match; 33913705ce5bSJoe Perches my $sub_to = $match; 33923705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3393194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33943705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 33953705ce5bSJoe Perches } 339665863862SAndy Whitcroft } 33970a920b5bSAndy Whitcroft } 33980a920b5bSAndy Whitcroft 33990a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 34000a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 34010a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 34020a920b5bSAndy Whitcroft# print "$herecurr"; 34030a920b5bSAndy Whitcroft# $clean = 0; 34040a920b5bSAndy Whitcroft# } 34050a920b5bSAndy Whitcroft 34068905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3407000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3408000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 34098905a67cSAndy Whitcroft } 34108905a67cSAndy Whitcroft 341117441227SJoe Perches# check for uses of printk_ratelimit 341217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3413000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3414000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 341517441227SJoe Perches } 341617441227SJoe Perches 341700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 341800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 341900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 342025985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 342100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3422f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 342300df344fSAndy Whitcroft my $ok = 0; 342400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 342500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 342625985edcSLucas De Marchi # we have a preceding printk if it ends 342700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 342800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 342900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 343000df344fSAndy Whitcroft $ok = 1; 343100df344fSAndy Whitcroft } 343200df344fSAndy Whitcroft last; 343300df344fSAndy Whitcroft } 343400df344fSAndy Whitcroft } 343500df344fSAndy Whitcroft if ($ok == 0) { 3436000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3437000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 34380a920b5bSAndy Whitcroft } 343900df344fSAndy Whitcroft } 34400a920b5bSAndy Whitcroft 3441243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3442243f3803SJoe Perches my $orig = $1; 3443243f3803SJoe Perches my $level = lc($orig); 3444243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 34458f26b837SJoe Perches my $level2 = $level; 34468f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3447243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3448daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3449243f3803SJoe Perches } 3450243f3803SJoe Perches 3451243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3452d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3453d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3454d5e616fcSJoe Perches $fix) { 3455194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3456d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3457d5e616fcSJoe Perches } 3458243f3803SJoe Perches } 3459243f3803SJoe Perches 3460dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3461dc139313SJoe Perches my $orig = $1; 3462dc139313SJoe Perches my $level = lc($orig); 3463dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3464dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3465dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3466dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3467dc139313SJoe Perches } 3468dc139313SJoe Perches 346991c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 347091c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 347191c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 347291c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 347391c9afafSAndy Lutomirski WARN("ENOSYS", 347491c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 347591c9afafSAndy Lutomirski } 347691c9afafSAndy Lutomirski 3477653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3478653d4876SAndy Whitcroft# or if closed on same line 34798d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3480c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 34818d182478SJoe Perches if (ERROR("OPEN_BRACE", 34828d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 34838d182478SJoe Perches $fix) { 34848d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 34858d182478SJoe Perches my $fixed_line = $rawline; 34868d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 34878d182478SJoe Perches my $line1 = $1; 34888d182478SJoe Perches my $line2 = $2; 34898d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 34908d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 34918d182478SJoe Perches if ($line2 !~ /^\s*$/) { 34928d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 34938d182478SJoe Perches } 34948d182478SJoe Perches } 34950a920b5bSAndy Whitcroft } 3496653d4876SAndy Whitcroft 34978905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 34988905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 34998905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 35008d182478SJoe Perches if (ERROR("OPEN_BRACE", 35018d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 35028d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 35038d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 35048d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35058d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 35068d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35078d182478SJoe Perches $fixedline = $rawline; 35088d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 35098d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 35108d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35118d182478SJoe Perches } 35128d182478SJoe Perches } 35138905a67cSAndy Whitcroft } 35148905a67cSAndy Whitcroft 35150c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 35163705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 35173705ce5bSJoe Perches if (WARN("SPACING", 35183705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 35193705ce5bSJoe Perches $fix) { 3520194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35213705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 35223705ce5bSJoe Perches } 35230c73b4ebSAndy Whitcroft } 35240c73b4ebSAndy Whitcroft 352531070b5dSJoe Perches# Function pointer declarations 352631070b5dSJoe Perches# check spacing between type, funcptr, and args 352731070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 352891f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 352931070b5dSJoe Perches my $declare = $1; 353031070b5dSJoe Perches my $pre_pointer_space = $2; 353131070b5dSJoe Perches my $post_pointer_space = $3; 353231070b5dSJoe Perches my $funcname = $4; 353331070b5dSJoe Perches my $post_funcname_space = $5; 353431070b5dSJoe Perches my $pre_args_space = $6; 353531070b5dSJoe Perches 353691f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 353791f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 353891f72e9cSJoe Perches# don't need a space so don't warn for those. 353991f72e9cSJoe Perches my $post_declare_space = ""; 354091f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 354191f72e9cSJoe Perches $post_declare_space = $1; 354291f72e9cSJoe Perches $declare = rtrim($declare); 354391f72e9cSJoe Perches } 354491f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 354531070b5dSJoe Perches WARN("SPACING", 354631070b5dSJoe Perches "missing space after return type\n" . $herecurr); 354791f72e9cSJoe Perches $post_declare_space = " "; 354831070b5dSJoe Perches } 354931070b5dSJoe Perches 355031070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 355191f72e9cSJoe Perches# This test is not currently implemented because these declarations are 355291f72e9cSJoe Perches# equivalent to 355391f72e9cSJoe Perches# int foo(int bar, ...) 355491f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 355591f72e9cSJoe Perches# 355691f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 355791f72e9cSJoe Perches# WARN("SPACING", 355891f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 355991f72e9cSJoe Perches# } 356031070b5dSJoe Perches 356131070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 356231070b5dSJoe Perches if (defined $pre_pointer_space && 356331070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 356431070b5dSJoe Perches WARN("SPACING", 356531070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 356631070b5dSJoe Perches } 356731070b5dSJoe Perches 356831070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 356931070b5dSJoe Perches if (defined $post_pointer_space && 357031070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 357131070b5dSJoe Perches WARN("SPACING", 357231070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 357331070b5dSJoe Perches } 357431070b5dSJoe Perches 357531070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 357631070b5dSJoe Perches if (defined $post_funcname_space && 357731070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 357831070b5dSJoe Perches WARN("SPACING", 357931070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 358031070b5dSJoe Perches } 358131070b5dSJoe Perches 358231070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 358331070b5dSJoe Perches if (defined $pre_args_space && 358431070b5dSJoe Perches $pre_args_space =~ /^\s/) { 358531070b5dSJoe Perches WARN("SPACING", 358631070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 358731070b5dSJoe Perches } 358831070b5dSJoe Perches 358931070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3590194f66fcSJoe Perches $fixed[$fixlinenr] =~ 359191f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 359231070b5dSJoe Perches } 359331070b5dSJoe Perches } 359431070b5dSJoe Perches 35958d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 35968d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3597fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3598fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 35998d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 36008d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 36018d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3602fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3603daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 36043705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 36053705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 36063705ce5bSJoe Perches $fix) { 3607194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36083705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 36093705ce5bSJoe Perches } 36108d31cfceSAndy Whitcroft } 36118d31cfceSAndy Whitcroft } 36128d31cfceSAndy Whitcroft 3613f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 36146c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3615c2fdda0dSAndy Whitcroft my $name = $1; 3616773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3617773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3618c2fdda0dSAndy Whitcroft 3619c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3620773647a0SAndy Whitcroft if ($name =~ /^(?: 3621773647a0SAndy Whitcroft if|for|while|switch|return|case| 3622773647a0SAndy Whitcroft volatile|__volatile__| 3623773647a0SAndy Whitcroft __attribute__|format|__extension__| 3624773647a0SAndy Whitcroft asm|__asm__)$/x) 3625773647a0SAndy Whitcroft { 3626c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3627c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3628c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3629c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3630773647a0SAndy Whitcroft 3631773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3632c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3633c2fdda0dSAndy Whitcroft 3634c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3635c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3636773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3637c2fdda0dSAndy Whitcroft 3638c2fdda0dSAndy Whitcroft } else { 36393705ce5bSJoe Perches if (WARN("SPACING", 36403705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 36413705ce5bSJoe Perches $fix) { 3642194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36433705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 36443705ce5bSJoe Perches } 3645f0a594c1SAndy Whitcroft } 36466c72ffaaSAndy Whitcroft } 36479a4cad4eSEric Nelson 3648653d4876SAndy Whitcroft# Check operator spacing. 36490a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 36503705ce5bSJoe Perches my $fixed_line = ""; 36513705ce5bSJoe Perches my $line_fixed = 0; 36523705ce5bSJoe Perches 36539c0ca6f9SAndy Whitcroft my $ops = qr{ 36549c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 36559c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 36569c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 36571f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 365884731623SJoe Perches \?:|\?|: 36599c0ca6f9SAndy Whitcroft }x; 3660cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 36613705ce5bSJoe Perches 36623705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 36633705ce5bSJoe Perches## foreach my $el (@elements) { 36643705ce5bSJoe Perches## print("el: <$el>\n"); 36653705ce5bSJoe Perches## } 36663705ce5bSJoe Perches 36673705ce5bSJoe Perches my @fix_elements = (); 366800df344fSAndy Whitcroft my $off = 0; 36696c72ffaaSAndy Whitcroft 36703705ce5bSJoe Perches foreach my $el (@elements) { 36713705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 36723705ce5bSJoe Perches $off += length($el); 36733705ce5bSJoe Perches } 36743705ce5bSJoe Perches 36753705ce5bSJoe Perches $off = 0; 36763705ce5bSJoe Perches 36776c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3678b34c648bSJoe Perches my $last_after = -1; 36796c72ffaaSAndy Whitcroft 36800a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 36813705ce5bSJoe Perches 36823705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 36833705ce5bSJoe Perches 36843705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 36853705ce5bSJoe Perches 36864a0df2efSAndy Whitcroft $off += length($elements[$n]); 36874a0df2efSAndy Whitcroft 368825985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3689773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3690773647a0SAndy Whitcroft my $cc = ''; 3691773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3692773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3693773647a0SAndy Whitcroft } 3694773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3695773647a0SAndy Whitcroft 36964a0df2efSAndy Whitcroft my $a = ''; 36974a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 36984a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3699cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 37004a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 37014a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3702773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 37034a0df2efSAndy Whitcroft 37040a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 37054a0df2efSAndy Whitcroft 37064a0df2efSAndy Whitcroft my $c = ''; 37070a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 37084a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 37094a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3710cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 37114a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 37124a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 37138b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 37144a0df2efSAndy Whitcroft } else { 37154a0df2efSAndy Whitcroft $c = 'E'; 37160a920b5bSAndy Whitcroft } 37170a920b5bSAndy Whitcroft 37184a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 37194a0df2efSAndy Whitcroft 37204a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 37214a0df2efSAndy Whitcroft 37226c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3723de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 37240a920b5bSAndy Whitcroft 372574048ed8SAndy Whitcroft # Pull out the value of this operator. 37266c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 37270a920b5bSAndy Whitcroft 37281f65f947SAndy Whitcroft # Get the full operator variant. 37291f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 37301f65f947SAndy Whitcroft 373113214adfSAndy Whitcroft # Ignore operators passed as parameters. 373213214adfSAndy Whitcroft if ($op_type ne 'V' && 3733d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 373413214adfSAndy Whitcroft 3735cf655043SAndy Whitcroft# # Ignore comments 3736cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 373713214adfSAndy Whitcroft 3738d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 373913214adfSAndy Whitcroft } elsif ($op eq ';') { 3740cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3741cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 37423705ce5bSJoe Perches if (ERROR("SPACING", 37433705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3744b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 37453705ce5bSJoe Perches $line_fixed = 1; 37463705ce5bSJoe Perches } 3747d8aaf121SAndy Whitcroft } 3748d8aaf121SAndy Whitcroft 3749d8aaf121SAndy Whitcroft # // is a comment 3750d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 37510a920b5bSAndy Whitcroft 3752b00e4814SJoe Perches # : when part of a bitfield 3753b00e4814SJoe Perches } elsif ($opv eq ':B') { 3754b00e4814SJoe Perches # skip the bitfield test for now 3755b00e4814SJoe Perches 37561f65f947SAndy Whitcroft # No spaces for: 37571f65f947SAndy Whitcroft # -> 3758b00e4814SJoe Perches } elsif ($op eq '->') { 37594a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 37603705ce5bSJoe Perches if (ERROR("SPACING", 37613705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3762b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37633705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37643705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 37653705ce5bSJoe Perches } 3766b34c648bSJoe Perches $line_fixed = 1; 37673705ce5bSJoe Perches } 37680a920b5bSAndy Whitcroft } 37690a920b5bSAndy Whitcroft 37702381097bSJoe Perches # , must not have a space before and must have a space on the right. 37710a920b5bSAndy Whitcroft } elsif ($op eq ',') { 37722381097bSJoe Perches my $rtrim_before = 0; 37732381097bSJoe Perches my $space_after = 0; 37742381097bSJoe Perches if ($ctx =~ /Wx./) { 37752381097bSJoe Perches if (ERROR("SPACING", 37762381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 37772381097bSJoe Perches $line_fixed = 1; 37782381097bSJoe Perches $rtrim_before = 1; 37792381097bSJoe Perches } 37802381097bSJoe Perches } 3781cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 37823705ce5bSJoe Perches if (ERROR("SPACING", 37833705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 37843705ce5bSJoe Perches $line_fixed = 1; 3785b34c648bSJoe Perches $last_after = $n; 37862381097bSJoe Perches $space_after = 1; 37872381097bSJoe Perches } 37882381097bSJoe Perches } 37892381097bSJoe Perches if ($rtrim_before || $space_after) { 37902381097bSJoe Perches if ($rtrim_before) { 37912381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37922381097bSJoe Perches } else { 37932381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 37942381097bSJoe Perches } 37952381097bSJoe Perches if ($space_after) { 37962381097bSJoe Perches $good .= " "; 37973705ce5bSJoe Perches } 37980a920b5bSAndy Whitcroft } 37990a920b5bSAndy Whitcroft 38009c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 380174048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 38029c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 38039c0ca6f9SAndy Whitcroft 38049c0ca6f9SAndy Whitcroft # unary operators should have a space before and 38059c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 38069c0ca6f9SAndy Whitcroft # unary operator, or a cast 38079c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 380874048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 38090d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3810cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 38113705ce5bSJoe Perches if (ERROR("SPACING", 38123705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3813b34c648bSJoe Perches if ($n != $last_after + 2) { 3814b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 38153705ce5bSJoe Perches $line_fixed = 1; 38163705ce5bSJoe Perches } 38170a920b5bSAndy Whitcroft } 3818b34c648bSJoe Perches } 3819a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3820171ae1a4SAndy Whitcroft # A unary '*' may be const 3821171ae1a4SAndy Whitcroft 3822171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 38233705ce5bSJoe Perches if (ERROR("SPACING", 38243705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3825b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 38263705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38273705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38283705ce5bSJoe Perches } 3829b34c648bSJoe Perches $line_fixed = 1; 38303705ce5bSJoe Perches } 38310a920b5bSAndy Whitcroft } 38320a920b5bSAndy Whitcroft 38330a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 38340a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3835773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 38363705ce5bSJoe Perches if (ERROR("SPACING", 38373705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3838b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38393705ce5bSJoe Perches $line_fixed = 1; 38403705ce5bSJoe Perches } 38410a920b5bSAndy Whitcroft } 3842773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3843773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 38443705ce5bSJoe Perches if (ERROR("SPACING", 38453705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3846b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38473705ce5bSJoe Perches $line_fixed = 1; 38483705ce5bSJoe Perches } 3849653d4876SAndy Whitcroft } 3850773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 38513705ce5bSJoe Perches if (ERROR("SPACING", 38523705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3853b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38543705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38553705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3856773647a0SAndy Whitcroft } 3857b34c648bSJoe Perches $line_fixed = 1; 38583705ce5bSJoe Perches } 38593705ce5bSJoe Perches } 38600a920b5bSAndy Whitcroft 38610a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 38629c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 38639c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 38649c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3865c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3866c2fdda0dSAndy Whitcroft $op eq '%') 38670a920b5bSAndy Whitcroft { 3868d2e025f3SJoe Perches if ($check) { 3869d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3870d2e025f3SJoe Perches if (CHK("SPACING", 3871d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3872d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3873d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3874d2e025f3SJoe Perches $line_fixed = 1; 3875d2e025f3SJoe Perches } 3876d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3877d2e025f3SJoe Perches if (CHK("SPACING", 3878d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3879d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3880d2e025f3SJoe Perches $line_fixed = 1; 3881d2e025f3SJoe Perches } 3882d2e025f3SJoe Perches } 3883d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 38843705ce5bSJoe Perches if (ERROR("SPACING", 38853705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3886b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3887b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3888b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3889b34c648bSJoe Perches } 38903705ce5bSJoe Perches $line_fixed = 1; 38913705ce5bSJoe Perches } 38920a920b5bSAndy Whitcroft } 38930a920b5bSAndy Whitcroft 38941f65f947SAndy Whitcroft # A colon needs no spaces before when it is 38951f65f947SAndy Whitcroft # terminating a case value or a label. 38961f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 38971f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 38983705ce5bSJoe Perches if (ERROR("SPACING", 38993705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3900b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39013705ce5bSJoe Perches $line_fixed = 1; 39023705ce5bSJoe Perches } 39031f65f947SAndy Whitcroft } 39041f65f947SAndy Whitcroft 39050a920b5bSAndy Whitcroft # All the others need spaces both sides. 3906cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 39071f65f947SAndy Whitcroft my $ok = 0; 39081f65f947SAndy Whitcroft 390922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 39101f65f947SAndy Whitcroft if (($op eq '<' && 39111f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 39121f65f947SAndy Whitcroft ($op eq '>' && 39131f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 39141f65f947SAndy Whitcroft { 39151f65f947SAndy Whitcroft $ok = 1; 39161f65f947SAndy Whitcroft } 39171f65f947SAndy Whitcroft 3918e0df7e1fSJoe Perches # for asm volatile statements 3919e0df7e1fSJoe Perches # ignore a colon with another 3920e0df7e1fSJoe Perches # colon immediately before or after 3921e0df7e1fSJoe Perches if (($op eq ':') && 3922e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 3923e0df7e1fSJoe Perches $ok = 1; 3924e0df7e1fSJoe Perches } 3925e0df7e1fSJoe Perches 392684731623SJoe Perches # messages are ERROR, but ?: are CHK 39271f65f947SAndy Whitcroft if ($ok == 0) { 392884731623SJoe Perches my $msg_type = \&ERROR; 392984731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 393084731623SJoe Perches 393184731623SJoe Perches if (&{$msg_type}("SPACING", 39323705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3933b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3934b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3935b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3936b34c648bSJoe Perches } 39373705ce5bSJoe Perches $line_fixed = 1; 39383705ce5bSJoe Perches } 39390a920b5bSAndy Whitcroft } 394022f2a2efSAndy Whitcroft } 39414a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 39423705ce5bSJoe Perches 39433705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 39443705ce5bSJoe Perches 39453705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 39460a920b5bSAndy Whitcroft } 39473705ce5bSJoe Perches 39483705ce5bSJoe Perches if (($#elements % 2) == 0) { 39493705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 39503705ce5bSJoe Perches } 39513705ce5bSJoe Perches 3952194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3953194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 39543705ce5bSJoe Perches } 39553705ce5bSJoe Perches 39563705ce5bSJoe Perches 39570a920b5bSAndy Whitcroft } 39580a920b5bSAndy Whitcroft 3959786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3960d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3961786b6326SJoe Perches if (WARN("SPACING", 3962786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3963786b6326SJoe Perches $fix) { 3964194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3965786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3966786b6326SJoe Perches } 3967786b6326SJoe Perches } 3968786b6326SJoe Perches 3969f0a594c1SAndy Whitcroft# check for multiple assignments 3970f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3971000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3972000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3973f0a594c1SAndy Whitcroft } 3974f0a594c1SAndy Whitcroft 397522f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 397622f2a2efSAndy Whitcroft## # continuation. 397722f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 397822f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 397922f2a2efSAndy Whitcroft## 398022f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 398122f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 398222f2a2efSAndy Whitcroft## my $ln = $line; 398322f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 398422f2a2efSAndy Whitcroft## } 398522f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3986000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3987000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 398822f2a2efSAndy Whitcroft## } 398922f2a2efSAndy Whitcroft## } 3990f0a594c1SAndy Whitcroft 39910a920b5bSAndy Whitcroft#need space before brace following if, while, etc 399222f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 399322f2a2efSAndy Whitcroft $line =~ /do{/) { 39943705ce5bSJoe Perches if (ERROR("SPACING", 39953705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 39963705ce5bSJoe Perches $fix) { 3997194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 39983705ce5bSJoe Perches } 3999de7d4f0eSAndy Whitcroft } 4000de7d4f0eSAndy Whitcroft 4001c4a62ef9SJoe Perches## # check for blank lines before declarations 4002c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4003c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4004c4a62ef9SJoe Perches## WARN("SPACING", 4005c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4006c4a62ef9SJoe Perches## } 4007c4a62ef9SJoe Perches## 4008c4a62ef9SJoe Perches 4009de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4010de7d4f0eSAndy Whitcroft# on the line 4011de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4012d5e616fcSJoe Perches if (ERROR("SPACING", 4013d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4014d5e616fcSJoe Perches $fix) { 4015194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4016d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4017d5e616fcSJoe Perches } 40180a920b5bSAndy Whitcroft } 40190a920b5bSAndy Whitcroft 402022f2a2efSAndy Whitcroft# check spacing on square brackets 402122f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 40223705ce5bSJoe Perches if (ERROR("SPACING", 40233705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 40243705ce5bSJoe Perches $fix) { 4025194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40263705ce5bSJoe Perches s/\[\s+/\[/; 40273705ce5bSJoe Perches } 402822f2a2efSAndy Whitcroft } 402922f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 40303705ce5bSJoe Perches if (ERROR("SPACING", 40313705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 40323705ce5bSJoe Perches $fix) { 4033194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40343705ce5bSJoe Perches s/\s+\]/\]/; 40353705ce5bSJoe Perches } 403622f2a2efSAndy Whitcroft } 403722f2a2efSAndy Whitcroft 4038c45dcabdSAndy Whitcroft# check spacing on parentheses 40399c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 40409c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 40413705ce5bSJoe Perches if (ERROR("SPACING", 40423705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 40433705ce5bSJoe Perches $fix) { 4044194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40453705ce5bSJoe Perches s/\(\s+/\(/; 40463705ce5bSJoe Perches } 404722f2a2efSAndy Whitcroft } 404813214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4049c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4050c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 40513705ce5bSJoe Perches if (ERROR("SPACING", 40523705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 40533705ce5bSJoe Perches $fix) { 4054194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40553705ce5bSJoe Perches s/\s+\)/\)/; 40563705ce5bSJoe Perches } 405722f2a2efSAndy Whitcroft } 405822f2a2efSAndy Whitcroft 4059e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4060e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4061e2826fd0SJoe Perches 4062e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4063ea4acbb1SJoe Perches my $var = $1; 4064ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4065ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4066ea4acbb1SJoe Perches $fix) { 4067ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4068ea4acbb1SJoe Perches } 4069ea4acbb1SJoe Perches } 4070ea4acbb1SJoe Perches 4071ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4072ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4073ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4074ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4075ea4acbb1SJoe Perches my $var = $2; 4076ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4077ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4078ea4acbb1SJoe Perches $fix) { 4079ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4080ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4081ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4082ea4acbb1SJoe Perches } 4083e2826fd0SJoe Perches } 4084e2826fd0SJoe Perches 40850a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 40864a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 40870a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 40883705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 40893705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 40903705ce5bSJoe Perches $fix) { 4091194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40923705ce5bSJoe Perches s/^(.)\s+/$1/; 40933705ce5bSJoe Perches } 40940a920b5bSAndy Whitcroft } 40950a920b5bSAndy Whitcroft 40965b9553abSJoe Perches# return is not a function 4097507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4098c45dcabdSAndy Whitcroft my $spacing = $1; 4099507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 41005b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 41015b9553abSJoe Perches my $value = $1; 41025b9553abSJoe Perches $value = deparenthesize($value); 41035b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4104000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4105000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 41065b9553abSJoe Perches } 4107c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4108000d1cc1SJoe Perches ERROR("SPACING", 4109000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4110c45dcabdSAndy Whitcroft } 4111c45dcabdSAndy Whitcroft } 4112507e5141SJoe Perches 4113b43ae21bSJoe Perches# unnecessary return in a void function 4114b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4115b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4116b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4117b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4118b43ae21bSJoe Perches $linenr >= 3 && 4119b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4120b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 41219819cf25SJoe Perches WARN("RETURN_VOID", 4122b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 41239819cf25SJoe Perches } 41249819cf25SJoe Perches 4125189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4126189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4127189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4128189248d8SJoe Perches my $openparens = $1; 4129189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4130189248d8SJoe Perches my $msg = ""; 4131189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4132189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4133189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4134189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4135189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4136189248d8SJoe Perches } 4137189248d8SJoe Perches } 4138189248d8SJoe Perches 4139f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4140f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 414153a3c448SAndy Whitcroft my $name = $1; 414253a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4143000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4144f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 414553a3c448SAndy Whitcroft } 414653a3c448SAndy Whitcroft } 4147c45dcabdSAndy Whitcroft 41480a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 41494a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 41503705ce5bSJoe Perches if (ERROR("SPACING", 41513705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 41523705ce5bSJoe Perches $fix) { 4153194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41543705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 41553705ce5bSJoe Perches } 41560a920b5bSAndy Whitcroft } 41570a920b5bSAndy Whitcroft 4158f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4159f5fe35ddSAndy Whitcroft# statements after the conditional. 4160170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 41613e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 41623e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 41633e469cdcSAndy Whitcroft if (!defined $stat); 4164170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4165170d3a22SAndy Whitcroft $remain_next, $off_next); 4166170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4167170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4168170d3a22SAndy Whitcroft 4169170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4170170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4171170d3a22SAndy Whitcroft # then count those as offsets. 4172170d3a22SAndy Whitcroft my ($whitespace) = 4173170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4174170d3a22SAndy Whitcroft my $offset = 4175170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4176170d3a22SAndy Whitcroft 4177170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4178170d3a22SAndy Whitcroft $offset} = 1; 4179170d3a22SAndy Whitcroft } 4180170d3a22SAndy Whitcroft } 4181170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4182c11230f4SJoe Perches defined($stat) && defined($cond) && 4183170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4184171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 41858905a67cSAndy Whitcroft 4186b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4187000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4188000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 41898905a67cSAndy Whitcroft } 41908905a67cSAndy Whitcroft 41918905a67cSAndy Whitcroft # Find out what is on the end of the line after the 41928905a67cSAndy Whitcroft # conditional. 4193773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 41948905a67cSAndy Whitcroft $s =~ s/\n.*//g; 419513214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 419653210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 419753210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4198773647a0SAndy Whitcroft { 4199bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4200bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4201bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 420242bdf74cSHidetoshi Seto my $stat_real = ''; 4203bb44ad39SAndy Whitcroft 420442bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 420542bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4206bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4207bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4208bb44ad39SAndy Whitcroft } 4209bb44ad39SAndy Whitcroft 4210000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4211000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 42128905a67cSAndy Whitcroft } 42138905a67cSAndy Whitcroft } 42148905a67cSAndy Whitcroft 421513214adfSAndy Whitcroft# Check for bitwise tests written as boolean 421613214adfSAndy Whitcroft if ($line =~ / 421713214adfSAndy Whitcroft (?: 421813214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 421913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 422013214adfSAndy Whitcroft (?:\&\&|\|\|) 422113214adfSAndy Whitcroft | 422213214adfSAndy Whitcroft (?:\&\&|\|\|) 422313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 422413214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 422513214adfSAndy Whitcroft )/x) 422613214adfSAndy Whitcroft { 4227000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4228000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 422913214adfSAndy Whitcroft } 423013214adfSAndy Whitcroft 42318905a67cSAndy Whitcroft# if and else should not have general statements after it 423213214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 423313214adfSAndy Whitcroft my $s = $1; 423413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 423513214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4236000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4237000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 42380a920b5bSAndy Whitcroft } 423913214adfSAndy Whitcroft } 424039667782SAndy Whitcroft# if should not continue a brace 424139667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4242000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4243048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 424439667782SAndy Whitcroft $herecurr); 424539667782SAndy Whitcroft } 4246a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4247a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4248a1080bf8SAndy Whitcroft $line !~ /\G(?: 42493fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4250a1080bf8SAndy Whitcroft \s*return\s+ 4251a1080bf8SAndy Whitcroft )/xg) 4252a1080bf8SAndy Whitcroft { 4253000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4254000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4255a1080bf8SAndy Whitcroft } 42560a920b5bSAndy Whitcroft 42570a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 42580a920b5bSAndy Whitcroft # indent level to be relevant to each other. 42598b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 42600a920b5bSAndy Whitcroft $previndent == $indent) { 42618b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 42628b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 42638b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42648b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42658b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 42668b8856f4SJoe Perches my $fixedline = $prevrawline; 42678b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 42688b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 42698b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42708b8856f4SJoe Perches } 42718b8856f4SJoe Perches $fixedline = $rawline; 42728b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 42738b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42748b8856f4SJoe Perches } 42750a920b5bSAndy Whitcroft } 42760a920b5bSAndy Whitcroft 42778b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4278c2fdda0dSAndy Whitcroft $previndent == $indent) { 4279c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4280c2fdda0dSAndy Whitcroft 4281c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4282c2fdda0dSAndy Whitcroft # conditional. 4283773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4284c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4285c2fdda0dSAndy Whitcroft 4286c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 42878b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 42888b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 42898b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42908b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42918b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 42928b8856f4SJoe Perches my $fixedline = $prevrawline; 42938b8856f4SJoe Perches my $trailing = $rawline; 42948b8856f4SJoe Perches $trailing =~ s/^\+//; 42958b8856f4SJoe Perches $trailing = trim($trailing); 42968b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 42978b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42988b8856f4SJoe Perches } 4299c2fdda0dSAndy Whitcroft } 4300c2fdda0dSAndy Whitcroft } 4301c2fdda0dSAndy Whitcroft 430295e2c602SJoe Perches#Specific variable tests 4303323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4304323c1260SJoe Perches my $var = $1; 430595e2c602SJoe Perches 430695e2c602SJoe Perches#gcc binary extension 430795e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4308d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4309d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4310d5e616fcSJoe Perches $fix) { 4311d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4312194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4313d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4314d5e616fcSJoe Perches } 431595e2c602SJoe Perches } 431695e2c602SJoe Perches 431795e2c602SJoe Perches#CamelCase 4318807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4319be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 432022735ce8SJoe Perches#Ignore Page<foo> variants 4321807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 432222735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4323f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4324f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4325f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 43267e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 43277e781f67SJoe Perches my $word = $1; 43287e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4329d8b07710SJoe Perches if ($check) { 4330d8b07710SJoe Perches seed_camelcase_includes(); 4331d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4332d8b07710SJoe Perches seed_camelcase_file($realfile); 4333d8b07710SJoe Perches $camelcase_file_seeded = 1; 4334d8b07710SJoe Perches } 4335d8b07710SJoe Perches } 43367e781f67SJoe Perches if (!defined $camelcase{$word}) { 43377e781f67SJoe Perches $camelcase{$word} = 1; 4338be79794bSJoe Perches CHK("CAMELCASE", 43397e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 43407e781f67SJoe Perches } 4341323c1260SJoe Perches } 4342323c1260SJoe Perches } 43433445686aSJoe Perches } 43440a920b5bSAndy Whitcroft 43450a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4346d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4347d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4348d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4349d5e616fcSJoe Perches $fix) { 4350194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4351d5e616fcSJoe Perches } 43520a920b5bSAndy Whitcroft } 43530a920b5bSAndy Whitcroft 43540e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 43550e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4356c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4357e09dec48SAndy Whitcroft my $file = "$1.h"; 4358e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4359e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4360e09dec48SAndy Whitcroft $realfile ne $checkfile && 43617840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4362c45dcabdSAndy Whitcroft { 43630e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 43640e212e0aSFabian Frederick if ($asminclude > 0) { 4365e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4366000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4367000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4368e09dec48SAndy Whitcroft } else { 4369000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4370000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4371e09dec48SAndy Whitcroft } 43720a920b5bSAndy Whitcroft } 43730a920b5bSAndy Whitcroft } 43740e212e0aSFabian Frederick } 43750a920b5bSAndy Whitcroft 4376653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4377653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4378cf655043SAndy Whitcroft# in a known good container 4379b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4380b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4381d8aaf121SAndy Whitcroft my $ln = $linenr; 4382d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4383c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4384c45dcabdSAndy Whitcroft my $ctx = ''; 438508a2843eSJoe Perches my $has_flow_statement = 0; 438608a2843eSJoe Perches my $has_arg_concat = 0; 4387c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4388f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4389f74bd194SAndy Whitcroft $ctx = $dstat; 4390c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4391a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4392c45dcabdSAndy Whitcroft 439308a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 439408a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 439508a2843eSJoe Perches 4396f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4397292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4398c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4399c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4400c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4401c45dcabdSAndy Whitcroft 4402c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4403bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4404bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4405c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4406bf30d6edSAndy Whitcroft { 4407c45dcabdSAndy Whitcroft } 4408c45dcabdSAndy Whitcroft 4409e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 441033acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 441133acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4412e45bab8eSAndy Whitcroft { 4413e45bab8eSAndy Whitcroft } 4414e45bab8eSAndy Whitcroft 4415c45dcabdSAndy Whitcroft my $exceptions = qr{ 4416c45dcabdSAndy Whitcroft $Declare| 4417c45dcabdSAndy Whitcroft module_param_named| 4418a0a0a7a9SKees Cook MODULE_PARM_DESC| 4419c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4420c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4421383099fdSAndy Whitcroft __typeof__\(| 442222fd2d3eSStefani Seibold union| 442322fd2d3eSStefani Seibold struct| 4424ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4425ea71a0a0SAndy Whitcroft ^\"|\"$ 4426c45dcabdSAndy Whitcroft }x; 44275eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4428f74bd194SAndy Whitcroft if ($dstat ne '' && 4429f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4430f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 44313cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4432356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4433f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4434f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4435e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 443672f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4437f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4438f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4439f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4440f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4441f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4442c45dcabdSAndy Whitcroft { 4443f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4444f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4445f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4446f74bd194SAndy Whitcroft 4447f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4448f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4449c45dcabdSAndy Whitcroft } 4450c45dcabdSAndy Whitcroft 4451f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4452f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4453f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4454f74bd194SAndy Whitcroft } else { 4455000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4456388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4457d8aaf121SAndy Whitcroft } 44580a920b5bSAndy Whitcroft } 44595023d347SJoe Perches 446008a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 446108a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 446208a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 446308a2843eSJoe Perches my $herectx = $here . "\n"; 446408a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 446508a2843eSJoe Perches 446608a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 446708a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 446808a2843eSJoe Perches } 446908a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 447008a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 447108a2843eSJoe Perches } 447208a2843eSJoe Perches 4473481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 44745023d347SJoe Perches 44755023d347SJoe Perches } else { 44765023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4477481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4478481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 44795023d347SJoe Perches $line =~ /^\+.*\\$/) { 44805023d347SJoe Perches WARN("LINE_CONTINUATIONS", 44815023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 44825023d347SJoe Perches } 4483653d4876SAndy Whitcroft } 44840a920b5bSAndy Whitcroft 4485b13edf7fSJoe Perches# do {} while (0) macro tests: 4486b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4487b13edf7fSJoe Perches# macro should not end with a semicolon 4488b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4489b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4490b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4491b13edf7fSJoe Perches my $ln = $linenr; 4492b13edf7fSJoe Perches my $cnt = $realcnt; 4493b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4494b13edf7fSJoe Perches my $ctx = ''; 4495b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4496b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4497b13edf7fSJoe Perches $ctx = $dstat; 4498b13edf7fSJoe Perches 4499b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 45001b36b201SJoe Perches $dstat =~ s/$;/ /g; 4501b13edf7fSJoe Perches 4502b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4503b13edf7fSJoe Perches my $stmts = $2; 4504b13edf7fSJoe Perches my $semis = $3; 4505b13edf7fSJoe Perches 4506b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4507b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4508b13edf7fSJoe Perches my $herectx = $here . "\n"; 4509b13edf7fSJoe Perches 4510b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4511b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4512b13edf7fSJoe Perches } 4513b13edf7fSJoe Perches 4514ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4515ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4516b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4517b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4518b13edf7fSJoe Perches } 4519b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4520b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4521b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4522b13edf7fSJoe Perches } 4523f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4524f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4525f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4526f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4527f5ef95b1SJoe Perches 4528f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4529f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4530f5ef95b1SJoe Perches } 4531f5ef95b1SJoe Perches 4532f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4533f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4534b13edf7fSJoe Perches } 4535b13edf7fSJoe Perches } 4536b13edf7fSJoe Perches 4537080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4538080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4539080ba929SMike Frysinger# . 4540080ba929SMike Frysinger# ALIGN(...) 4541080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4542080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4543000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4544000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4545080ba929SMike Frysinger } 4546080ba929SMike Frysinger 4547f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 454813214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 454913214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4550cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 455113214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4552cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4553cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4554aad4f614SJoe Perches my @allowed = (); 4555aad4f614SJoe Perches my $allow = 0; 455613214adfSAndy Whitcroft my $seen = 0; 4557773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4558cf655043SAndy Whitcroft my $ln = $linenr - 1; 455913214adfSAndy Whitcroft for my $chunk (@chunks) { 456013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 456113214adfSAndy Whitcroft 4562773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4563773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4564773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4565773647a0SAndy Whitcroft 4566aad4f614SJoe Perches $allowed[$allow] = 0; 4567773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4568773647a0SAndy Whitcroft 4569773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4570773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4571773647a0SAndy Whitcroft 4572773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4573cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4574cf655043SAndy Whitcroft 4575773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 457613214adfSAndy Whitcroft 457713214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 457813214adfSAndy Whitcroft 4579aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4580cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4581cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4582aad4f614SJoe Perches $allowed[$allow] = 1; 458313214adfSAndy Whitcroft } 458413214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4585cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4586aad4f614SJoe Perches $allowed[$allow] = 1; 458713214adfSAndy Whitcroft } 4588cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4589cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4590aad4f614SJoe Perches $allowed[$allow] = 1; 459113214adfSAndy Whitcroft } 4592aad4f614SJoe Perches $allow++; 459313214adfSAndy Whitcroft } 4594aad4f614SJoe Perches if ($seen) { 4595aad4f614SJoe Perches my $sum_allowed = 0; 4596aad4f614SJoe Perches foreach (@allowed) { 4597aad4f614SJoe Perches $sum_allowed += $_; 4598aad4f614SJoe Perches } 4599aad4f614SJoe Perches if ($sum_allowed == 0) { 4600000d1cc1SJoe Perches WARN("BRACES", 4601000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4602aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4603aad4f614SJoe Perches $seen != $allow) { 4604aad4f614SJoe Perches CHK("BRACES", 4605aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4606aad4f614SJoe Perches } 460713214adfSAndy Whitcroft } 460813214adfSAndy Whitcroft } 460913214adfSAndy Whitcroft } 4610773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 461113214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4612cf655043SAndy Whitcroft my $allowed = 0; 4613f0a594c1SAndy Whitcroft 4614cf655043SAndy Whitcroft # Check the pre-context. 4615cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4616cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4617cf655043SAndy Whitcroft $allowed = 1; 4618f0a594c1SAndy Whitcroft } 4619773647a0SAndy Whitcroft 4620773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4621773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4622773647a0SAndy Whitcroft 4623cf655043SAndy Whitcroft # Check the condition. 4624cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4625773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4626cf655043SAndy Whitcroft if (defined $cond) { 4627773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4628cf655043SAndy Whitcroft } 4629cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4630cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4631cf655043SAndy Whitcroft $allowed = 1; 4632cf655043SAndy Whitcroft } 4633cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4634cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4635cf655043SAndy Whitcroft $allowed = 1; 4636cf655043SAndy Whitcroft } 4637cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4638cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4639cf655043SAndy Whitcroft $allowed = 1; 4640cf655043SAndy Whitcroft } 4641cf655043SAndy Whitcroft # Check the post-context. 4642cf655043SAndy Whitcroft if (defined $chunks[1]) { 4643cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4644cf655043SAndy Whitcroft if (defined $cond) { 4645773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4646cf655043SAndy Whitcroft } 4647cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4648cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4649cf655043SAndy Whitcroft $allowed = 1; 4650cf655043SAndy Whitcroft } 4651cf655043SAndy Whitcroft } 4652cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 465369932487SJustin P. Mattock my $herectx = $here . "\n"; 4654f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4655cf655043SAndy Whitcroft 4656f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 465769932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4658cf655043SAndy Whitcroft } 4659cf655043SAndy Whitcroft 4660000d1cc1SJoe Perches WARN("BRACES", 4661000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4662f0a594c1SAndy Whitcroft } 4663f0a594c1SAndy Whitcroft } 4664f0a594c1SAndy Whitcroft 46650979ae66SJoe Perches# check for unnecessary blank lines around braces 466677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4667f8e58219SJoe Perches if (CHK("BRACES", 4668f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4669f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4670f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4671f8e58219SJoe Perches } 46720979ae66SJoe Perches } 467377b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4674f8e58219SJoe Perches if (CHK("BRACES", 4675f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4676f8e58219SJoe Perches $fix) { 4677f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4678f8e58219SJoe Perches } 46790979ae66SJoe Perches } 46800979ae66SJoe Perches 46814a0df2efSAndy Whitcroft# no volatiles please 46826c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 46836c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4684000d1cc1SJoe Perches WARN("VOLATILE", 4685000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 46864a0df2efSAndy Whitcroft } 46874a0df2efSAndy Whitcroft 46885e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 46895e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 46905e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 46915e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 469233acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 46935e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 46945e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 46955e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 46965e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 46975e4f6ba5SJoe Perches $fix && 46985e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 46995e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 47005e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 47015e4f6ba5SJoe Perches my $comma_close = ""; 47025e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 47035e4f6ba5SJoe Perches $comma_close = $1; 47045e4f6ba5SJoe Perches } 47055e4f6ba5SJoe Perches 47065e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47075e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 47085e4f6ba5SJoe Perches my $fixedline = $prevrawline; 47095e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 47105e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 47115e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 47125e4f6ba5SJoe Perches $fixedline = $rawline; 47135e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 47145e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 47155e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47165e4f6ba5SJoe Perches } 47175e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 47185e4f6ba5SJoe Perches } 47195e4f6ba5SJoe Perches } 47205e4f6ba5SJoe Perches 47215e4f6ba5SJoe Perches# check for missing a space in a string concatenation 47225e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 47235e4f6ba5SJoe Perches WARN('MISSING_SPACE', 47245e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 47255e4f6ba5SJoe Perches } 47265e4f6ba5SJoe Perches 47275e4f6ba5SJoe Perches# check for spaces before a quoted newline 47285e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 47295e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 47305e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 47315e4f6ba5SJoe Perches $fix) { 47325e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 47335e4f6ba5SJoe Perches } 47345e4f6ba5SJoe Perches 47355e4f6ba5SJoe Perches } 47365e4f6ba5SJoe Perches 4737f17dba4fSJoe Perches# concatenated string without spaces between elements 473833acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4739f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4740f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4741f17dba4fSJoe Perches } 4742f17dba4fSJoe Perches 474390ad30e5SJoe Perches# uncoalesced string fragments 474433acb54aSJoe Perches if ($line =~ /$String\s*"/) { 474590ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 474690ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 474790ad30e5SJoe Perches } 474890ad30e5SJoe Perches 47495e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 47505e4f6ba5SJoe Perches my $string; 47515e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 47525e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 47535e4f6ba5SJoe Perches $string =~ s/%%/__/g; 47545e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 47555e4f6ba5SJoe Perches WARN("PRINTF_L", 47565e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 47575e4f6ba5SJoe Perches last; 47585e4f6ba5SJoe Perches } 47595e4f6ba5SJoe Perches } 47605e4f6ba5SJoe Perches 47615e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 47625e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 47635e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 47645e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 47655e4f6ba5SJoe Perches } 47665e4f6ba5SJoe Perches 476700df344fSAndy Whitcroft# warn about #if 0 4768c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4769000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4770000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4771de7d4f0eSAndy Whitcroft $herecurr); 47724a0df2efSAndy Whitcroft } 47734a0df2efSAndy Whitcroft 477403df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 477503df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 477603df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 477703df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 477803df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 477915160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 47804c432a8fSGreg Kroah-Hartman } 47814c432a8fSGreg Kroah-Hartman } 4782f0a594c1SAndy Whitcroft 4783ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4784ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4785ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4786ebfdc409SJoe Perches (defined $1 || defined $3) && 4787ebfdc409SJoe Perches $linenr > 3) { 4788ebfdc409SJoe Perches my $testval = $2; 4789ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4790ebfdc409SJoe Perches 4791ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4792ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4793ebfdc409SJoe Perches 4794ebfdc409SJoe 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)/) { 4795ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4796ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4797ebfdc409SJoe Perches } 4798ebfdc409SJoe Perches } 4799ebfdc409SJoe Perches 4800f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4801dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4802f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4803f78d98f6SJoe Perches my $level = $1; 4804f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4805f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4806f78d98f6SJoe Perches $fix) { 4807f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4808f78d98f6SJoe Perches } 4809f78d98f6SJoe Perches } 4810f78d98f6SJoe Perches 4811abb08a53SJoe Perches# check for mask then right shift without a parentheses 4812abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4813abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4814abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4815abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4816abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4817abb08a53SJoe Perches } 4818abb08a53SJoe Perches 4819b75ac618SJoe Perches# check for pointer comparisons to NULL 4820b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4821b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4822b75ac618SJoe Perches my $val = $1; 4823b75ac618SJoe Perches my $equal = "!"; 4824b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4825b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4826b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4827b75ac618SJoe Perches $fix) { 4828b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4829b75ac618SJoe Perches } 4830b75ac618SJoe Perches } 4831b75ac618SJoe Perches } 4832b75ac618SJoe Perches 48338716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 48348716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 48358716de38SJoe Perches my $attr = $1; 48368716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 48378716de38SJoe Perches my $ptr = $1; 48388716de38SJoe Perches my $var = $2; 48398716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 48408716de38SJoe Perches ERROR("MISPLACED_INIT", 48418716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 48428716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 48438716de38SJoe Perches WARN("MISPLACED_INIT", 48448716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 48458716de38SJoe Perches $fix) { 4846194f66fcSJoe 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; 48478716de38SJoe Perches } 48488716de38SJoe Perches } 48498716de38SJoe Perches } 48508716de38SJoe Perches 4851e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4852e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4853e970b884SJoe Perches my $attr = $1; 4854e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4855e970b884SJoe Perches my $attr_prefix = $1; 4856e970b884SJoe Perches my $attr_type = $2; 4857e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4858e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4859e970b884SJoe Perches $fix) { 4860194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4861e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4862e970b884SJoe Perches } 4863e970b884SJoe Perches } 4864e970b884SJoe Perches 4865e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4866e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4867e970b884SJoe Perches my $attr = $1; 4868e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4869e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4870e970b884SJoe Perches $fix) { 4871194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4872e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4873e970b884SJoe Perches $lead = rtrim($1); 4874e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4875e970b884SJoe Perches $lead = "${lead}const "; 4876194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4877e970b884SJoe Perches } 4878e970b884SJoe Perches } 4879e970b884SJoe Perches 4880c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 4881c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 4882c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 4883c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 4884c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 4885c17893c7SJoe Perches $fix) { 4886c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 4887c17893c7SJoe Perches } 4888c17893c7SJoe Perches } 4889c17893c7SJoe Perches 4890fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4891fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4892fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4893fbdb8138SJoe Perches my $constant_func = $1; 4894fbdb8138SJoe Perches my $func = $constant_func; 4895fbdb8138SJoe Perches $func =~ s/^__constant_//; 4896fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4897fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4898fbdb8138SJoe Perches $fix) { 4899194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4900fbdb8138SJoe Perches } 4901fbdb8138SJoe Perches } 4902fbdb8138SJoe Perches 49031a15a250SPatrick Pannuto# prefer usleep_range over udelay 490437581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 490543c1d77cSJoe Perches my $delay = $1; 49061a15a250SPatrick Pannuto # ignore udelay's < 10, however 490743c1d77cSJoe Perches if (! ($delay < 10) ) { 4908000d1cc1SJoe Perches CHK("USLEEP_RANGE", 490943c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 491043c1d77cSJoe Perches } 491143c1d77cSJoe Perches if ($delay > 2000) { 491243c1d77cSJoe Perches WARN("LONG_UDELAY", 491343c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 49141a15a250SPatrick Pannuto } 49151a15a250SPatrick Pannuto } 49161a15a250SPatrick Pannuto 491709ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 491809ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 491909ef8725SPatrick Pannuto if ($1 < 20) { 4920000d1cc1SJoe Perches WARN("MSLEEP", 492143c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 492209ef8725SPatrick Pannuto } 492309ef8725SPatrick Pannuto } 492409ef8725SPatrick Pannuto 492536ec1939SJoe Perches# check for comparisons of jiffies 492636ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 492736ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 492836ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 492936ec1939SJoe Perches } 493036ec1939SJoe Perches 49319d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 49329d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 49339d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 49349d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 49359d7a34a5SJoe Perches } 49369d7a34a5SJoe Perches 493700df344fSAndy Whitcroft# warn about #ifdefs in C files 4938c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 493900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 494000df344fSAndy Whitcroft# print "$herecurr"; 494100df344fSAndy Whitcroft# $clean = 0; 494200df344fSAndy Whitcroft# } 494300df344fSAndy Whitcroft 494422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4945c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 49463705ce5bSJoe Perches if (ERROR("SPACING", 49473705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 49483705ce5bSJoe Perches $fix) { 4949194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49503705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 49513705ce5bSJoe Perches } 49523705ce5bSJoe Perches 495322f2a2efSAndy Whitcroft } 495422f2a2efSAndy Whitcroft 49554a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4956171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4957171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 49584a0df2efSAndy Whitcroft my $which = $1; 49594a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4960000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4961000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 49624a0df2efSAndy Whitcroft } 49634a0df2efSAndy Whitcroft } 49644a0df2efSAndy Whitcroft# check for memory barriers without a comment. 49654a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 49664a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4967c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4968000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 49694a0df2efSAndy Whitcroft } 49704a0df2efSAndy Whitcroft } 4971cb426e99SJoe Perches# check for waitqueue_active without a comment. 4972cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 4973cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 4974cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 4975cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 4976cb426e99SJoe Perches } 4977cb426e99SJoe Perches } 49784a0df2efSAndy Whitcroft# check of hardware specific defines 4979c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4980000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4981000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 49820a920b5bSAndy Whitcroft } 4983653d4876SAndy Whitcroft 4984d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4985d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4986000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4987000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4988d4977c78STobias Klauser } 4989d4977c78STobias Klauser 4990de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4991de7d4f0eSAndy Whitcroft# storage class and type. 49929c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 49939c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4994000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4995000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4996de7d4f0eSAndy Whitcroft } 4997de7d4f0eSAndy Whitcroft 49988905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 49992b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50002b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5001d5e616fcSJoe Perches if (WARN("INLINE", 5002d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5003d5e616fcSJoe Perches $fix) { 5004194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5005d5e616fcSJoe Perches 5006d5e616fcSJoe Perches } 50078905a67cSAndy Whitcroft } 50088905a67cSAndy Whitcroft 50093d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 50102b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50112b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5012000d1cc1SJoe Perches WARN("PREFER_PACKED", 5013000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 50143d130fd0SJoe Perches } 50153d130fd0SJoe Perches 501639b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 50172b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50182b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5019000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5020000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 502139b7e287SJoe Perches } 502239b7e287SJoe Perches 50235f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 50242b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50252b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5026d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5027d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5028d5e616fcSJoe Perches $fix) { 5029194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5030d5e616fcSJoe Perches 5031d5e616fcSJoe Perches } 50325f14d3bdSJoe Perches } 50335f14d3bdSJoe Perches 50346061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 50352b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50362b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5037d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5038d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5039d5e616fcSJoe Perches $fix) { 5040194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5041d5e616fcSJoe Perches } 50426061d949SJoe Perches } 50436061d949SJoe Perches 5044619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5045619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5046619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5047619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5048619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5049619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5050619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5051619a908aSJoe Perches } 5052619a908aSJoe Perches 5053e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5054e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5055e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5056e6176fa4SJoe Perches my $type = $1; 5057e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5058e6176fa4SJoe Perches $type = $1; 5059e6176fa4SJoe Perches my $kernel_type = 'u'; 5060e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5061e6176fa4SJoe Perches $type =~ /(\d+)/; 5062e6176fa4SJoe Perches $kernel_type .= $1; 5063e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5064e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5065e6176fa4SJoe Perches $fix) { 5066e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5067e6176fa4SJoe Perches } 5068e6176fa4SJoe Perches } 5069e6176fa4SJoe Perches } 5070e6176fa4SJoe Perches 50718f53a9b8SJoe Perches# check for sizeof(&) 50728f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5073000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5074000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 50758f53a9b8SJoe Perches } 50768f53a9b8SJoe Perches 507766c80b60SJoe Perches# check for sizeof without parenthesis 507866c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5079d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5080d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5081d5e616fcSJoe Perches $fix) { 5082194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5083d5e616fcSJoe Perches } 508466c80b60SJoe Perches } 508566c80b60SJoe Perches 508688982feaSJoe Perches# check for struct spinlock declarations 508788982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 508888982feaSJoe Perches WARN("USE_SPINLOCK_T", 508988982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 509088982feaSJoe Perches } 509188982feaSJoe Perches 5092a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 509306668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5094a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5095caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5096caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5097d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5098d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5099d5e616fcSJoe Perches $fix) { 5100194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5101d5e616fcSJoe Perches } 5102a6962d72SJoe Perches } 5103a6962d72SJoe Perches } 5104a6962d72SJoe Perches 5105554e165cSAndy Whitcroft# Check for misused memsets 5106d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5107d1fe9c09SJoe Perches defined $stat && 5108d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 5109554e165cSAndy Whitcroft 5110d7c76ba7SJoe Perches my $ms_addr = $2; 5111d1fe9c09SJoe Perches my $ms_val = $7; 5112d1fe9c09SJoe Perches my $ms_size = $12; 5113d7c76ba7SJoe Perches 5114554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5115554e165cSAndy Whitcroft ERROR("MEMSET", 5116d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5117554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5118554e165cSAndy Whitcroft WARN("MEMSET", 5119d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5120d7c76ba7SJoe Perches } 5121d7c76ba7SJoe Perches } 5122d7c76ba7SJoe Perches 512398a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 512498a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 512598a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 512698a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 512798a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 512898a9bba5SJoe Perches $fix) { 5129194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 513098a9bba5SJoe Perches } 513198a9bba5SJoe Perches } 513298a9bba5SJoe Perches 5133d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5134d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5135d1fe9c09SJoe Perches defined $stat && 5136d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5137d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5138d7c76ba7SJoe Perches my $call = $1; 5139d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5140d7c76ba7SJoe Perches my $arg1 = $3; 5141d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5142d1fe9c09SJoe Perches my $arg2 = $8; 5143d7c76ba7SJoe Perches my $cast; 5144d7c76ba7SJoe Perches 5145d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5146d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5147d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5148d7c76ba7SJoe Perches $cast = $cast1; 5149d7c76ba7SJoe Perches } else { 5150d7c76ba7SJoe Perches $cast = $cast2; 5151d7c76ba7SJoe Perches } 5152d7c76ba7SJoe Perches WARN("MINMAX", 5153d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5154554e165cSAndy Whitcroft } 5155554e165cSAndy Whitcroft } 5156554e165cSAndy Whitcroft 51574a273195SJoe Perches# check usleep_range arguments 51584a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 51594a273195SJoe Perches defined $stat && 51604a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 51614a273195SJoe Perches my $min = $1; 51624a273195SJoe Perches my $max = $7; 51634a273195SJoe Perches if ($min eq $max) { 51644a273195SJoe Perches WARN("USLEEP_RANGE", 51654a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 51664a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 51674a273195SJoe Perches $min > $max) { 51684a273195SJoe Perches WARN("USLEEP_RANGE", 51694a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 51704a273195SJoe Perches } 51714a273195SJoe Perches } 51724a273195SJoe Perches 5173823b794cSJoe Perches# check for naked sscanf 5174823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5175823b794cSJoe Perches defined $stat && 51766c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5177823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5178823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5179823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5180823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5181823b794cSJoe Perches $lc = $lc + $linenr; 5182823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5183823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5184823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5185823b794cSJoe Perches } 5186823b794cSJoe Perches WARN("NAKED_SSCANF", 5187823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5188823b794cSJoe Perches } 5189823b794cSJoe Perches 5190afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5191afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5192afc819abSJoe Perches defined $stat && 5193afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5194afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5195afc819abSJoe Perches $lc = $lc + $linenr; 5196afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5197afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5198afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5199afc819abSJoe Perches } 5200afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5201afc819abSJoe Perches my $format = $6; 5202afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5203afc819abSJoe Perches if ($count == 1 && 5204afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5205afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5206afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5207afc819abSJoe Perches } 5208afc819abSJoe Perches } 5209afc819abSJoe Perches } 5210afc819abSJoe Perches 521170dc8a48SJoe Perches# check for new externs in .h files. 521270dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 521370dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5214d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 521570dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 521670dc8a48SJoe Perches $fix) { 5217194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 521870dc8a48SJoe Perches } 521970dc8a48SJoe Perches } 522070dc8a48SJoe Perches 5221de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5222171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5223c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5224171ae1a4SAndy Whitcroft { 5225c45dcabdSAndy Whitcroft my $function_name = $1; 5226c45dcabdSAndy Whitcroft my $paren_space = $2; 5227171ae1a4SAndy Whitcroft 5228171ae1a4SAndy Whitcroft my $s = $stat; 5229171ae1a4SAndy Whitcroft if (defined $cond) { 5230171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5231171ae1a4SAndy Whitcroft } 5232c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5233c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5234c45dcabdSAndy Whitcroft { 5235000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5236000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5237de7d4f0eSAndy Whitcroft } 5238de7d4f0eSAndy Whitcroft 5239171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5240000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5241000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5242171ae1a4SAndy Whitcroft } 52439c9ba34eSAndy Whitcroft 52449c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 52459c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 52469c9ba34eSAndy Whitcroft { 5247000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5248000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5249171ae1a4SAndy Whitcroft } 5250171ae1a4SAndy Whitcroft 5251de7d4f0eSAndy Whitcroft# checks for new __setup's 5252de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5253de7d4f0eSAndy Whitcroft my $name = $1; 5254de7d4f0eSAndy Whitcroft 5255de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5256000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5257000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5258de7d4f0eSAndy Whitcroft } 5259653d4876SAndy Whitcroft } 52609c0ca6f9SAndy Whitcroft 52619c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5262caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5263000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5264000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 52659c0ca6f9SAndy Whitcroft } 526613214adfSAndy Whitcroft 5267a640d25cSJoe Perches# alloc style 5268a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5269a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5270a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5271a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5272a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5273a640d25cSJoe Perches } 5274a640d25cSJoe Perches 527560a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 527660a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5277e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 527860a55369SJoe Perches my $oldfunc = $3; 527960a55369SJoe Perches my $a1 = $4; 528060a55369SJoe Perches my $a2 = $10; 528160a55369SJoe Perches my $newfunc = "kmalloc_array"; 528260a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 528360a55369SJoe Perches my $r1 = $a1; 528460a55369SJoe Perches my $r2 = $a2; 528560a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 528660a55369SJoe Perches $r1 = $a2; 528760a55369SJoe Perches $r2 = $a1; 528860a55369SJoe Perches } 5289e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5290e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5291e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5292e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5293e367455aSJoe Perches $fix) { 5294194f66fcSJoe 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; 529560a55369SJoe Perches 529660a55369SJoe Perches } 529760a55369SJoe Perches } 529860a55369SJoe Perches } 529960a55369SJoe Perches 5300972fdea2SJoe Perches# check for krealloc arg reuse 5301972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5302972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5303972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5304972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5305972fdea2SJoe Perches } 5306972fdea2SJoe Perches 53075ce59ae0SJoe Perches# check for alloc argument mismatch 53085ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 53095ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 53105ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 53115ce59ae0SJoe Perches } 53125ce59ae0SJoe Perches 5313caf2a54fSJoe Perches# check for multiple semicolons 5314caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5315d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5316d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5317d5e616fcSJoe Perches $fix) { 5318194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5319d5e616fcSJoe Perches } 5320d1e2ad07SJoe Perches } 5321d1e2ad07SJoe Perches 53220ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 53230ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 53240ab90191SJoe Perches my $ull = ""; 53250ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 53260ab90191SJoe Perches if (CHK("BIT_MACRO", 53270ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 53280ab90191SJoe Perches $fix) { 53290ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 53300ab90191SJoe Perches } 53310ab90191SJoe Perches } 53320ab90191SJoe Perches 5333e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5334c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5335c34c09a8SJoe Perches my $has_break = 0; 5336c34c09a8SJoe Perches my $has_statement = 0; 5337c34c09a8SJoe Perches my $count = 0; 5338c34c09a8SJoe Perches my $prevline = $linenr; 5339e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5340c34c09a8SJoe Perches $prevline--; 5341c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5342c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5343c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5344c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5345c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5346c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5347c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5348c34c09a8SJoe Perches $has_statement = 1; 5349c34c09a8SJoe Perches $count++; 5350c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5351c34c09a8SJoe Perches } 5352c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5353c34c09a8SJoe Perches WARN("MISSING_BREAK", 5354c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5355c34c09a8SJoe Perches } 5356c34c09a8SJoe Perches } 5357c34c09a8SJoe Perches 5358d1e2ad07SJoe Perches# check for switch/default statements without a break; 5359d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5360d1e2ad07SJoe Perches defined $stat && 5361d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5362d1e2ad07SJoe Perches my $ctx = ''; 5363d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5364d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5365d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5366d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5367d1e2ad07SJoe Perches } 5368d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5369d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5370caf2a54fSJoe Perches } 5371caf2a54fSJoe Perches 537213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5373d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5374d5e616fcSJoe Perches if (WARN("USE_FUNC", 5375d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5376d5e616fcSJoe Perches $fix) { 5377194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5378d5e616fcSJoe Perches } 537913214adfSAndy Whitcroft } 5380773647a0SAndy Whitcroft 538162ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 538262ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 538362ec818fSJoe Perches ERROR("DATE_TIME", 538462ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 538562ec818fSJoe Perches } 538662ec818fSJoe Perches 53872c92488aSJoe Perches# check for use of yield() 53882c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 53892c92488aSJoe Perches WARN("YIELD", 53902c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 53912c92488aSJoe Perches } 53922c92488aSJoe Perches 5393179f8f40SJoe Perches# check for comparisons against true and false 5394179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5395179f8f40SJoe Perches my $lead = $1; 5396179f8f40SJoe Perches my $arg = $2; 5397179f8f40SJoe Perches my $test = $3; 5398179f8f40SJoe Perches my $otype = $4; 5399179f8f40SJoe Perches my $trail = $5; 5400179f8f40SJoe Perches my $op = "!"; 5401179f8f40SJoe Perches 5402179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5403179f8f40SJoe Perches 5404179f8f40SJoe Perches my $type = lc($otype); 5405179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5406179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5407179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5408179f8f40SJoe Perches $op = ""; 5409179f8f40SJoe Perches } 5410179f8f40SJoe Perches 5411179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5412179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5413179f8f40SJoe Perches 5414179f8f40SJoe Perches## maybe suggesting a correct construct would better 5415179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5416179f8f40SJoe Perches 5417179f8f40SJoe Perches } 5418179f8f40SJoe Perches } 5419179f8f40SJoe Perches 54204882720bSThomas Gleixner# check for semaphores initialized locked 54214882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5422000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5423000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5424773647a0SAndy Whitcroft } 54256712d858SJoe Perches 542667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 542767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5428000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 542967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5430773647a0SAndy Whitcroft } 54316712d858SJoe Perches 5432ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5433f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5434000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5435ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5436f3db6639SMichael Ellerman } 54376712d858SJoe Perches 54380f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 54390f3c5aabSJoe Perches my $const_structs = qr{ 54400f3c5aabSJoe Perches acpi_dock_ops| 544179404849SEmese Revfy address_space_operations| 544279404849SEmese Revfy backlight_ops| 544379404849SEmese Revfy block_device_operations| 544479404849SEmese Revfy dentry_operations| 544579404849SEmese Revfy dev_pm_ops| 544679404849SEmese Revfy dma_map_ops| 544779404849SEmese Revfy extent_io_ops| 544879404849SEmese Revfy file_lock_operations| 544979404849SEmese Revfy file_operations| 545079404849SEmese Revfy hv_ops| 545179404849SEmese Revfy ide_dma_ops| 545279404849SEmese Revfy intel_dvo_dev_ops| 545379404849SEmese Revfy item_operations| 545479404849SEmese Revfy iwl_ops| 545579404849SEmese Revfy kgdb_arch| 545679404849SEmese Revfy kgdb_io| 545779404849SEmese Revfy kset_uevent_ops| 545879404849SEmese Revfy lock_manager_operations| 545979404849SEmese Revfy microcode_ops| 546079404849SEmese Revfy mtrr_ops| 546179404849SEmese Revfy neigh_ops| 546279404849SEmese Revfy nlmsvc_binding| 54630f3c5aabSJoe Perches of_device_id| 546479404849SEmese Revfy pci_raw_ops| 546579404849SEmese Revfy pipe_buf_operations| 546679404849SEmese Revfy platform_hibernation_ops| 546779404849SEmese Revfy platform_suspend_ops| 546879404849SEmese Revfy proto_ops| 546979404849SEmese Revfy rpc_pipe_ops| 547079404849SEmese Revfy seq_operations| 547179404849SEmese Revfy snd_ac97_build_ops| 547279404849SEmese Revfy soc_pcmcia_socket_ops| 547379404849SEmese Revfy stacktrace_ops| 547479404849SEmese Revfy sysfs_ops| 547579404849SEmese Revfy tty_operations| 54766d07d01bSJoe Perches uart_ops| 547779404849SEmese Revfy usb_mon_operations| 547879404849SEmese Revfy wd_ops}x; 54796903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 54800f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5481000d1cc1SJoe Perches WARN("CONST_STRUCT", 5482000d1cc1SJoe Perches "struct $1 should normally be const\n" . 54836903ffb2SAndy Whitcroft $herecurr); 54842b6db5cbSAndy Whitcroft } 5485773647a0SAndy Whitcroft 5486773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5487773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5488773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5489c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5490c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5491171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5492171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5493171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5494773647a0SAndy Whitcroft { 5495000d1cc1SJoe Perches WARN("NR_CPUS", 5496000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5497773647a0SAndy Whitcroft } 54989c9ba34eSAndy Whitcroft 549952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 550052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 550152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 550252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 550352ea8506SJoe Perches } 550452ea8506SJoe Perches 5505acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5506acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5507acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5508acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5509acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5510acd9362cSJoe Perches } 5511acd9362cSJoe Perches 5512691d77b6SAndy Whitcroft# whine mightly about in_atomic 5513691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5514691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5515000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5516000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5517f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5518000d1cc1SJoe Perches WARN("IN_ATOMIC", 5519000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5520691d77b6SAndy Whitcroft } 5521691d77b6SAndy Whitcroft } 55221704f47bSPeter Zijlstra 55231704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 55241704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 55251704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 55261704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 55271704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 55281704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5529000d1cc1SJoe Perches ERROR("LOCKDEP", 5530000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 55311704f47bSPeter Zijlstra } 55321704f47bSPeter Zijlstra } 553388f8831cSDave Jones 5534b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5535b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5536000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5537000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 553888f8831cSDave Jones } 55392435880fSJoe Perches 5540515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5541515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5542515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5543515a235eSJoe Perches $line =~ /$mode_perms_search/) { 55442435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 55452435880fSJoe Perches my $func = $entry->[0]; 55462435880fSJoe Perches my $arg_pos = $entry->[1]; 55472435880fSJoe Perches 55482435880fSJoe Perches my $skip_args = ""; 55492435880fSJoe Perches if ($arg_pos > 1) { 55502435880fSJoe Perches $arg_pos--; 55512435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 55522435880fSJoe Perches } 55532435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5554515a235eSJoe Perches if ($line =~ /$test/) { 55552435880fSJoe Perches my $val = $1; 55562435880fSJoe Perches $val = $6 if ($skip_args ne ""); 55572435880fSJoe Perches 55581727cc70SJoe Perches if ($val !~ /^0$/ && 55591727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 55601727cc70SJoe Perches length($val) ne 4)) { 55612435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 55621727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5563c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5564c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5565c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 55662435880fSJoe Perches } 55672435880fSJoe Perches } 55682435880fSJoe Perches } 556913214adfSAndy Whitcroft } 5570515a235eSJoe Perches } 557113214adfSAndy Whitcroft 557213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 557313214adfSAndy Whitcroft # so just keep quiet. 557413214adfSAndy Whitcroft if ($#rawlines == -1) { 557513214adfSAndy Whitcroft exit(0); 55760a920b5bSAndy Whitcroft } 55770a920b5bSAndy Whitcroft 55788905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 55798905a67cSAndy Whitcroft # things that appear to be patches. 55808905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 55818905a67cSAndy Whitcroft exit(0); 55828905a67cSAndy Whitcroft } 55838905a67cSAndy Whitcroft 55848905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 55858905a67cSAndy Whitcroft # just keep quiet. 55868905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 55878905a67cSAndy Whitcroft exit(0); 55888905a67cSAndy Whitcroft } 55898905a67cSAndy Whitcroft 55908905a67cSAndy Whitcroft if (!$is_patch) { 5591000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5592000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 55930a920b5bSAndy Whitcroft } 55940a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 5595000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5596000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 55970a920b5bSAndy Whitcroft } 55980a920b5bSAndy Whitcroft 5599f0a594c1SAndy Whitcroft print report_dump(); 560013214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 560113214adfSAndy Whitcroft print "$filename " if ($summary_file); 56026c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 56036c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 56046c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 56056c72ffaaSAndy Whitcroft } 56068905a67cSAndy Whitcroft 5607d2c0a235SAndy Whitcroft if ($quiet == 0) { 5608d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5609d2c0a235SAndy Whitcroft # then suggest that. 5610d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5611b0781216SMike Frysinger $rpt_cleaners = 0; 5612*d8469f16SJoe Perches print << "EOM" 5613*d8469f16SJoe Perches 5614*d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5615*d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5616*d8469f16SJoe PerchesEOM 5617d2c0a235SAndy Whitcroft } 5618d2c0a235SAndy Whitcroft } 5619d2c0a235SAndy Whitcroft 562091bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 562191bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5622000d1cc1SJoe Perches 5623d752fcc8SJoe Perches if ($clean == 0 && $fix && 5624d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5625d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 56269624b8d6SJoe Perches my $newfile = $filename; 56279624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 56283705ce5bSJoe Perches my $linecount = 0; 56293705ce5bSJoe Perches my $f; 56303705ce5bSJoe Perches 5631d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5632d752fcc8SJoe Perches 56333705ce5bSJoe Perches open($f, '>', $newfile) 56343705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 56353705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 56363705ce5bSJoe Perches $linecount++; 56373705ce5bSJoe Perches if ($file) { 56383705ce5bSJoe Perches if ($linecount > 3) { 56393705ce5bSJoe Perches $fixed_line =~ s/^\+//; 56403705ce5bSJoe Perches print $f $fixed_line . "\n"; 56413705ce5bSJoe Perches } 56423705ce5bSJoe Perches } else { 56433705ce5bSJoe Perches print $f $fixed_line . "\n"; 56443705ce5bSJoe Perches } 56453705ce5bSJoe Perches } 56463705ce5bSJoe Perches close($f); 56473705ce5bSJoe Perches 56483705ce5bSJoe Perches if (!$quiet) { 56493705ce5bSJoe Perches print << "EOM"; 5650*d8469f16SJoe Perches 56513705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 56523705ce5bSJoe Perches 56533705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 56543705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 56553705ce5bSJoe Perches 56563705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 56573705ce5bSJoe PerchesNo warranties, expressed or implied... 56583705ce5bSJoe PerchesEOM 56593705ce5bSJoe Perches } 56603705ce5bSJoe Perches } 56613705ce5bSJoe Perches 5662*d8469f16SJoe Perches if ($quiet == 0) { 5663*d8469f16SJoe Perches print "\n"; 5664*d8469f16SJoe Perches if ($clean == 1) { 5665*d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5666*d8469f16SJoe Perches } else { 5667*d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 56680a920b5bSAndy Whitcroft } 56690a920b5bSAndy Whitcroft } 56700a920b5bSAndy Whitcroft return $clean; 56710a920b5bSAndy Whitcroft} 5672