10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 9c707a81dSJoe Perchesuse POSIX; 1036061e38SJoe Perchesuse File::Basename; 1136061e38SJoe Perchesuse Cwd 'abs_path'; 120a920b5bSAndy Whitcroft 130a920b5bSAndy Whitcroftmy $P = $0; 1436061e38SJoe Perchesmy $D = dirname(abs_path($P)); 150a920b5bSAndy Whitcroft 16000d1cc1SJoe Perchesmy $V = '0.32'; 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 190a920b5bSAndy Whitcroft 200a920b5bSAndy Whitcroftmy $quiet = 0; 210a920b5bSAndy Whitcroftmy $tree = 1; 220a920b5bSAndy Whitcroftmy $chk_signoff = 1; 230a920b5bSAndy Whitcroftmy $chk_patch = 1; 24773647a0SAndy Whitcroftmy $tst_only; 256c72ffaaSAndy Whitcroftmy $emacs = 0; 268905a67cSAndy Whitcroftmy $terse = 0; 276c72ffaaSAndy Whitcroftmy $file = 0; 286c72ffaaSAndy Whitcroftmy $check = 0; 292ac73b4fSJoe Perchesmy $check_orig = 0; 308905a67cSAndy Whitcroftmy $summary = 1; 318905a67cSAndy Whitcroftmy $mailback = 0; 3213214adfSAndy Whitcroftmy $summary_file = 0; 33000d1cc1SJoe Perchesmy $show_types = 0; 343705ce5bSJoe Perchesmy $fix = 0; 359624b8d6SJoe Perchesmy $fix_inplace = 0; 366c72ffaaSAndy Whitcroftmy $root; 37c2fdda0dSAndy Whitcroftmy %debug; 383445686aSJoe Perchesmy %camelcase = (); 3991bfe484SJoe Perchesmy %use_type = (); 4091bfe484SJoe Perchesmy @use = (); 4191bfe484SJoe Perchesmy %ignore_type = (); 42000d1cc1SJoe Perchesmy @ignore = (); 4377f5b10aSHannes Edermy $help = 0; 44000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 456cd7f386SJoe Perchesmy $max_line_length = 80; 46d62a201fSDave Hansenmy $ignore_perl_version = 0; 47d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4856193274SVadim Bendeburymy $min_conf_desc_length = 4; 4966b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 50ebfd7d62SJoe Perchesmy $codespell = 0; 51ebfd7d62SJoe Perchesmy $codespellfile = "/usr/local/share/codespell/dictionary.txt"; 5277f5b10aSHannes Eder 5377f5b10aSHannes Edersub help { 5477f5b10aSHannes Eder my ($exitcode) = @_; 5577f5b10aSHannes Eder 5677f5b10aSHannes Eder print << "EOM"; 5777f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5877f5b10aSHannes EderVersion: $V 5977f5b10aSHannes Eder 6077f5b10aSHannes EderOptions: 6177f5b10aSHannes Eder -q, --quiet quiet 6277f5b10aSHannes Eder --no-tree run without a kernel tree 6377f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 6477f5b10aSHannes Eder --patch treat FILE as patchfile (default) 6577f5b10aSHannes Eder --emacs emacs compile window format 6677f5b10aSHannes Eder --terse one line per report 6777f5b10aSHannes Eder -f, --file treat FILE as regular source file 6877f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6991bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 70000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 716cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 7256193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 73000d1cc1SJoe Perches --show-types show the message "types" in the output 7477f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 7577f5b10aSHannes Eder --no-summary suppress the per-file summary 7677f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 7777f5b10aSHannes Eder --summary-file include the filename in summary 7877f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7977f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 8077f5b10aSHannes Eder is all off) 8177f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 8277f5b10aSHannes Eder literally 833705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 843705ce5bSJoe Perches If correctable single-line errors exist, create 853705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 863705ce5bSJoe Perches with potential errors corrected to the preferred 873705ce5bSJoe Perches checkpatch style 889624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 899624b8d6SJoe Perches Is the same as --fix, but overwrites the input 909624b8d6SJoe Perches file. It's your fault if there's no backup or git 91d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 92d62a201fSDave Hansen runtime errors. 93ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 94ebfd7d62SJoe Perches (default:/usr/local/share/codespell/dictionary.txt) 95ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 9677f5b10aSHannes Eder -h, --help, --version display this help and exit 9777f5b10aSHannes Eder 9877f5b10aSHannes EderWhen FILE is - read standard input. 9977f5b10aSHannes EderEOM 10077f5b10aSHannes Eder 10177f5b10aSHannes Eder exit($exitcode); 10277f5b10aSHannes Eder} 10377f5b10aSHannes Eder 104000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 105000d1cc1SJoe Perchesif (-f $conf) { 106000d1cc1SJoe Perches my @conf_args; 107000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 108000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 109000d1cc1SJoe Perches 110000d1cc1SJoe Perches while (<$conffile>) { 111000d1cc1SJoe Perches my $line = $_; 112000d1cc1SJoe Perches 113000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 114000d1cc1SJoe Perches $line =~ s/^\s*//g; 115000d1cc1SJoe Perches $line =~ s/\s+/ /g; 116000d1cc1SJoe Perches 117000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 118000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 119000d1cc1SJoe Perches 120000d1cc1SJoe Perches my @words = split(" ", $line); 121000d1cc1SJoe Perches foreach my $word (@words) { 122000d1cc1SJoe Perches last if ($word =~ m/^#/); 123000d1cc1SJoe Perches push (@conf_args, $word); 124000d1cc1SJoe Perches } 125000d1cc1SJoe Perches } 126000d1cc1SJoe Perches close($conffile); 127000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 128000d1cc1SJoe Perches} 129000d1cc1SJoe Perches 1300a920b5bSAndy WhitcroftGetOptions( 1316c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1320a920b5bSAndy Whitcroft 'tree!' => \$tree, 1330a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1340a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1356c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1368905a67cSAndy Whitcroft 'terse!' => \$terse, 13777f5b10aSHannes Eder 'f|file!' => \$file, 1386c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1396c72ffaaSAndy Whitcroft 'strict!' => \$check, 140000d1cc1SJoe Perches 'ignore=s' => \@ignore, 14191bfe484SJoe Perches 'types=s' => \@use, 142000d1cc1SJoe Perches 'show-types!' => \$show_types, 1436cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 14456193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1456c72ffaaSAndy Whitcroft 'root=s' => \$root, 1468905a67cSAndy Whitcroft 'summary!' => \$summary, 1478905a67cSAndy Whitcroft 'mailback!' => \$mailback, 14813214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1493705ce5bSJoe Perches 'fix!' => \$fix, 1509624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 151d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 152c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 153773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 154ebfd7d62SJoe Perches 'codespell!' => \$codespell, 155ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 15677f5b10aSHannes Eder 'h|help' => \$help, 15777f5b10aSHannes Eder 'version' => \$help 15877f5b10aSHannes Eder) or help(1); 15977f5b10aSHannes Eder 16077f5b10aSHannes Ederhelp(0) if ($help); 1610a920b5bSAndy Whitcroft 1629624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1632ac73b4fSJoe Perches$check_orig = $check; 1649624b8d6SJoe Perches 1650a920b5bSAndy Whitcroftmy $exit = 0; 1660a920b5bSAndy Whitcroft 167d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 168d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 169d62a201fSDave Hansen if (!$ignore_perl_version) { 170d62a201fSDave Hansen exit(1); 171d62a201fSDave Hansen } 172d62a201fSDave Hansen} 173d62a201fSDave Hansen 1740a920b5bSAndy Whitcroftif ($#ARGV < 0) { 17577f5b10aSHannes Eder print "$P: no input files\n"; 1760a920b5bSAndy Whitcroft exit(1); 1770a920b5bSAndy Whitcroft} 1780a920b5bSAndy Whitcroft 17991bfe484SJoe Perchessub hash_save_array_words { 18091bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 18191bfe484SJoe Perches 18291bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 18391bfe484SJoe Perches foreach my $word (@array) { 184000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 185000d1cc1SJoe Perches $word =~ s/^\s*//g; 186000d1cc1SJoe Perches $word =~ s/\s+/ /g; 187000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 188000d1cc1SJoe Perches 189000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 190000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 191000d1cc1SJoe Perches 19291bfe484SJoe Perches $hashRef->{$word}++; 193000d1cc1SJoe Perches } 19491bfe484SJoe Perches} 19591bfe484SJoe Perches 19691bfe484SJoe Perchessub hash_show_words { 19791bfe484SJoe Perches my ($hashRef, $prefix) = @_; 19891bfe484SJoe Perches 19958cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 20091bfe484SJoe Perches print "NOTE: $prefix message types:"; 20158cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 20291bfe484SJoe Perches print " $word"; 20391bfe484SJoe Perches } 20491bfe484SJoe Perches print "\n\n"; 20591bfe484SJoe Perches } 20691bfe484SJoe Perches} 20791bfe484SJoe Perches 20891bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 20991bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 210000d1cc1SJoe Perches 211c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 212c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2137429c690SAndy Whitcroftmy $dbg_type = 0; 214a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 215c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 21621caa13cSAndy Whitcroft ## no critic 21721caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 21821caa13cSAndy Whitcroft die "$@" if ($@); 219c2fdda0dSAndy Whitcroft} 220c2fdda0dSAndy Whitcroft 221d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 222d2c0a235SAndy Whitcroft 2238905a67cSAndy Whitcroftif ($terse) { 2248905a67cSAndy Whitcroft $emacs = 1; 2258905a67cSAndy Whitcroft $quiet++; 2268905a67cSAndy Whitcroft} 2278905a67cSAndy Whitcroft 2286c72ffaaSAndy Whitcroftif ($tree) { 2296c72ffaaSAndy Whitcroft if (defined $root) { 2306c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2316c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2326c72ffaaSAndy Whitcroft } 2336c72ffaaSAndy Whitcroft } else { 2346c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2356c72ffaaSAndy Whitcroft $root = '.'; 2366c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2376c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2386c72ffaaSAndy Whitcroft $root = $1; 2396c72ffaaSAndy Whitcroft } 2406c72ffaaSAndy Whitcroft } 2416c72ffaaSAndy Whitcroft 2426c72ffaaSAndy Whitcroft if (!defined $root) { 2430a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2440a920b5bSAndy Whitcroft exit(2); 2450a920b5bSAndy Whitcroft } 2466c72ffaaSAndy Whitcroft} 2476c72ffaaSAndy Whitcroft 2486c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2496c72ffaaSAndy Whitcroft 2502ceb532bSAndy Whitcroftour $Ident = qr{ 2512ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2522ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2532ceb532bSAndy Whitcroft }x; 2546c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2556c72ffaaSAndy Whitcroftour $Sparse = qr{ 2566c72ffaaSAndy Whitcroft __user| 2576c72ffaaSAndy Whitcroft __kernel| 2586c72ffaaSAndy Whitcroft __force| 2596c72ffaaSAndy Whitcroft __iomem| 2606c72ffaaSAndy Whitcroft __must_check| 2616c72ffaaSAndy Whitcroft __init_refok| 262417495edSAndy Whitcroft __kprobes| 263165e72a6SSven Eckelmann __ref| 264165e72a6SSven Eckelmann __rcu 2656c72ffaaSAndy Whitcroft }x; 266e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 267e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 268e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 269e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 270e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2718716de38SJoe Perches 27252131292SWolfram Sang# Notes to $Attribute: 27352131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2746c72ffaaSAndy Whitcroftour $Attribute = qr{ 2756c72ffaaSAndy Whitcroft const| 27603f1df7dSJoe Perches __percpu| 27703f1df7dSJoe Perches __nocast| 27803f1df7dSJoe Perches __safe| 27903f1df7dSJoe Perches __bitwise__| 28003f1df7dSJoe Perches __packed__| 28103f1df7dSJoe Perches __packed2__| 28203f1df7dSJoe Perches __naked| 28303f1df7dSJoe Perches __maybe_unused| 28403f1df7dSJoe Perches __always_unused| 28503f1df7dSJoe Perches __noreturn| 28603f1df7dSJoe Perches __used| 28703f1df7dSJoe Perches __cold| 288e23ef1f3SJoe Perches __pure| 28903f1df7dSJoe Perches __noclone| 29003f1df7dSJoe Perches __deprecated| 2916c72ffaaSAndy Whitcroft __read_mostly| 2926c72ffaaSAndy Whitcroft __kprobes| 2938716de38SJoe Perches $InitAttribute| 29424e1d81aSAndy Whitcroft ____cacheline_aligned| 29524e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2965fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2975fe3af11SAndy Whitcroft __weak 2986c72ffaaSAndy Whitcroft }x; 299c45dcabdSAndy Whitcroftour $Modifier; 30091cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3016c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3026c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3036c72ffaaSAndy Whitcroft 30495e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 30595e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 30695e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 30795e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3082435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 309c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 310326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 311326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 312326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 31374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3142435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 315326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 316447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 31723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3186c72ffaaSAndy Whitcroftour $Operators = qr{ 3196c72ffaaSAndy Whitcroft <=|>=|==|!=| 3206c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 32123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3226c72ffaaSAndy Whitcroft }x; 3236c72ffaaSAndy Whitcroft 32491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 32591cb5195SJoe Perches 326ab7e23f3SJoe Perchesour $BasicType; 3278905a67cSAndy Whitcroftour $NonptrType; 3281813087dSJoe Perchesour $NonptrTypeMisordered; 3298716de38SJoe Perchesour $NonptrTypeWithAttr; 3308905a67cSAndy Whitcroftour $Type; 3311813087dSJoe Perchesour $TypeMisordered; 3328905a67cSAndy Whitcroftour $Declare; 3331813087dSJoe Perchesour $DeclareMisordered; 3348905a67cSAndy Whitcroft 33515662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 33615662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 337171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 338171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 339171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 340171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 341171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 342171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 343171ae1a4SAndy Whitcroft}x; 344171ae1a4SAndy Whitcroft 34515662b3eSJoe Perchesour $UTF8 = qr{ 34615662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 34715662b3eSJoe Perches | $NON_ASCII_UTF8 34815662b3eSJoe Perches}x; 34915662b3eSJoe Perches 350021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 351021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 352021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 353021158b4SJoe Perches)}; 354021158b4SJoe Perches 3558ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 356fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3578ed22cadSAndy Whitcroft atomic_t 3588ed22cadSAndy Whitcroft)}; 3598ed22cadSAndy Whitcroft 360691e669bSJoe Perchesour $logFunctions = qr{(?x: 3616e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3627d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3636e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 364b0531722SJoe Perches panic| 36506668727SJoe Perches MODULE_[A-Z_]+| 36606668727SJoe Perches seq_vprintf|seq_printf|seq_puts 367691e669bSJoe Perches)}; 368691e669bSJoe Perches 36920112475SJoe Perchesour $signature_tags = qr{(?xi: 37020112475SJoe Perches Signed-off-by:| 37120112475SJoe Perches Acked-by:| 37220112475SJoe Perches Tested-by:| 37320112475SJoe Perches Reviewed-by:| 37420112475SJoe Perches Reported-by:| 3758543ae12SMugunthan V N Suggested-by:| 37620112475SJoe Perches To:| 37720112475SJoe Perches Cc: 37820112475SJoe Perches)}; 37920112475SJoe Perches 3801813087dSJoe Perchesour @typeListMisordered = ( 3811813087dSJoe Perches qr{char\s+(?:un)?signed}, 3821813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3831813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 3841813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 3851813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 3861813087dSJoe Perches qr{short\s+(?:un)?signed}, 3871813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 3881813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 3891813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 3901813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 3911813087dSJoe Perches qr{int\s+(?:un)?signed}, 3921813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 3931813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 3941813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 3951813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 3961813087dSJoe Perches qr{long\s+(?:un)?signed}, 3971813087dSJoe Perches); 3981813087dSJoe Perches 3998905a67cSAndy Whitcroftour @typeList = ( 4008905a67cSAndy Whitcroft qr{void}, 4010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4040c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4050c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4060c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4070c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4080c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4090c773d9dSJoe Perches qr{(?:un)?signed}, 4108905a67cSAndy Whitcroft qr{float}, 4118905a67cSAndy Whitcroft qr{double}, 4128905a67cSAndy Whitcroft qr{bool}, 4138905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4148905a67cSAndy Whitcroft qr{union\s+$Ident}, 4158905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4168905a67cSAndy Whitcroft qr{${Ident}_t}, 4178905a67cSAndy Whitcroft qr{${Ident}_handler}, 4188905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4191813087dSJoe Perches @typeListMisordered, 4208905a67cSAndy Whitcroft); 4218716de38SJoe Perchesour @typeListWithAttr = ( 4228716de38SJoe Perches @typeList, 4238716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4248716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4258716de38SJoe Perches); 4268716de38SJoe Perches 427c45dcabdSAndy Whitcroftour @modifierList = ( 428c45dcabdSAndy Whitcroft qr{fastcall}, 429c45dcabdSAndy Whitcroft); 4308905a67cSAndy Whitcroft 4312435880fSJoe Perchesour @mode_permission_funcs = ( 4322435880fSJoe Perches ["module_param", 3], 4332435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4342435880fSJoe Perches ["module_param_array_named", 5], 4352435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4362435880fSJoe Perches ["proc_create(?:_data|)", 2], 4372435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4382435880fSJoe Perches); 4392435880fSJoe Perches 440515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 441515a235eSJoe Perchesour $mode_perms_search = ""; 442515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 443515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 444515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 445515a235eSJoe Perches} 446515a235eSJoe Perches 447b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 448b392c64fSJoe Perches S_IWUGO | 449b392c64fSJoe Perches S_IWOTH | 450b392c64fSJoe Perches S_IRWXUGO | 451b392c64fSJoe Perches S_IALLUGO | 452b392c64fSJoe Perches 0[0-7][0-7][2367] 453b392c64fSJoe Perches}x; 454b392c64fSJoe Perches 4557840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4567840a94cSWolfram Sang irq| 457cdcee686SSergey Ryazanov memory| 458cdcee686SSergey Ryazanov time| 459cdcee686SSergey Ryazanov reboot 4607840a94cSWolfram Sang)}; 4617840a94cSWolfram Sang# memory.h: ARM has a custom one 4627840a94cSWolfram Sang 46366b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 46466b47b4aSKees Cookmy $misspellings; 46566b47b4aSKees Cookmy %spelling_fix; 46636061e38SJoe Perches 46736061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 46866b47b4aSKees Cook while (<$spelling>) { 46966b47b4aSKees Cook my $line = $_; 47066b47b4aSKees Cook 47166b47b4aSKees Cook $line =~ s/\s*\n?$//g; 47266b47b4aSKees Cook $line =~ s/^\s*//g; 47366b47b4aSKees Cook 47466b47b4aSKees Cook next if ($line =~ m/^\s*#/); 47566b47b4aSKees Cook next if ($line =~ m/^\s*$/); 47666b47b4aSKees Cook 47766b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 47866b47b4aSKees Cook 47966b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 48066b47b4aSKees Cook } 48166b47b4aSKees Cook close($spelling); 48236061e38SJoe Perches} else { 48336061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 48436061e38SJoe Perches} 48566b47b4aSKees Cook 486ebfd7d62SJoe Perchesif ($codespell) { 487ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 488ebfd7d62SJoe Perches while (<$spelling>) { 489ebfd7d62SJoe Perches my $line = $_; 490ebfd7d62SJoe Perches 491ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 492ebfd7d62SJoe Perches $line =~ s/^\s*//g; 493ebfd7d62SJoe Perches 494ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 495ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 496ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 497ebfd7d62SJoe Perches 498ebfd7d62SJoe Perches $line =~ s/,.*$//; 499ebfd7d62SJoe Perches 500ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 501ebfd7d62SJoe Perches 502ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 503ebfd7d62SJoe Perches } 504ebfd7d62SJoe Perches close($spelling); 505ebfd7d62SJoe Perches } else { 506ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 507ebfd7d62SJoe Perches } 508ebfd7d62SJoe Perches} 509ebfd7d62SJoe Perches 510ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 511ebfd7d62SJoe Perches 5128905a67cSAndy Whitcroftsub build_types { 513d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 514d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 5151813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5168716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 517c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 518ab7e23f3SJoe Perches $BasicType = qr{ 519ab7e23f3SJoe Perches (?:$typeOtherOSTypedefs\b)| 520ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 521ab7e23f3SJoe Perches (?:${all}\b) 522ab7e23f3SJoe Perches }x; 5238905a67cSAndy Whitcroft $NonptrType = qr{ 524d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 525cf655043SAndy Whitcroft (?: 5266b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 527021158b4SJoe Perches (?:$typeOtherOSTypedefs\b)| 5288ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 529c45dcabdSAndy Whitcroft (?:${all}\b) 530cf655043SAndy Whitcroft ) 531c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5328905a67cSAndy Whitcroft }x; 5331813087dSJoe Perches $NonptrTypeMisordered = qr{ 5341813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5351813087dSJoe Perches (?: 5361813087dSJoe Perches (?:${Misordered}\b) 5371813087dSJoe Perches ) 5381813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5391813087dSJoe Perches }x; 5408716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5418716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5428716de38SJoe Perches (?: 5438716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5448716de38SJoe Perches (?:$typeTypedefs\b)| 545021158b4SJoe Perches (?:$typeOtherOSTypedefs\b)| 5468716de38SJoe Perches (?:${allWithAttr}\b) 5478716de38SJoe Perches ) 5488716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5498716de38SJoe Perches }x; 5508905a67cSAndy Whitcroft $Type = qr{ 551c45dcabdSAndy Whitcroft $NonptrType 5521574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 553c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5548905a67cSAndy Whitcroft }x; 5551813087dSJoe Perches $TypeMisordered = qr{ 5561813087dSJoe Perches $NonptrTypeMisordered 5571813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5581813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5591813087dSJoe Perches }x; 56091cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5611813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5628905a67cSAndy Whitcroft} 5638905a67cSAndy Whitcroftbuild_types(); 5646c72ffaaSAndy Whitcroft 5657d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 566d1fe9c09SJoe Perches 567d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 568d1fe9c09SJoe Perches# requires at least perl version v5.10.0 569d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 570d1fe9c09SJoe Perches 571d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5722435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 573c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 5747d2367afSJoe Perches 575f8422308SJoe Perchesour $declaration_macros = qr{(?x: 576f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 577f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 578f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 579f8422308SJoe Perches)}; 580f8422308SJoe Perches 5817d2367afSJoe Perchessub deparenthesize { 5827d2367afSJoe Perches my ($string) = @_; 5837d2367afSJoe Perches return "" if (!defined($string)); 5845b9553abSJoe Perches 5855b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5865b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5875b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5885b9553abSJoe Perches } 5895b9553abSJoe Perches 5907d2367afSJoe Perches $string =~ s@\s+@ @g; 5915b9553abSJoe Perches 5927d2367afSJoe Perches return $string; 5937d2367afSJoe Perches} 5947d2367afSJoe Perches 5953445686aSJoe Perchessub seed_camelcase_file { 5963445686aSJoe Perches my ($file) = @_; 5973445686aSJoe Perches 5983445686aSJoe Perches return if (!(-f $file)); 5993445686aSJoe Perches 6003445686aSJoe Perches local $/; 6013445686aSJoe Perches 6023445686aSJoe Perches open(my $include_file, '<', "$file") 6033445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6043445686aSJoe Perches my $text = <$include_file>; 6053445686aSJoe Perches close($include_file); 6063445686aSJoe Perches 6073445686aSJoe Perches my @lines = split('\n', $text); 6083445686aSJoe Perches 6093445686aSJoe Perches foreach my $line (@lines) { 6103445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6113445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6123445686aSJoe Perches $camelcase{$1} = 1; 61311ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 61411ea516aSJoe Perches $camelcase{$1} = 1; 61511ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6163445686aSJoe Perches $camelcase{$1} = 1; 6173445686aSJoe Perches } 6183445686aSJoe Perches } 6193445686aSJoe Perches} 6203445686aSJoe Perches 6213445686aSJoe Perchesmy $camelcase_seeded = 0; 6223445686aSJoe Perchessub seed_camelcase_includes { 6233445686aSJoe Perches return if ($camelcase_seeded); 6243445686aSJoe Perches 6253445686aSJoe Perches my $files; 626c707a81dSJoe Perches my $camelcase_cache = ""; 627c707a81dSJoe Perches my @include_files = (); 628c707a81dSJoe Perches 629c707a81dSJoe Perches $camelcase_seeded = 1; 630351b2a1fSJoe Perches 6313645e328SRichard Genoud if (-e ".git") { 632351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 633351b2a1fSJoe Perches chomp $git_last_include_commit; 634c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 635c707a81dSJoe Perches } else { 636c707a81dSJoe Perches my $last_mod_date = 0; 637c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 638c707a81dSJoe Perches @include_files = split('\n', $files); 639c707a81dSJoe Perches foreach my $file (@include_files) { 640c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 641c707a81dSJoe Perches localtime((stat $file)[9])); 642c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 643c707a81dSJoe Perches } 644c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 645c707a81dSJoe Perches } 646c707a81dSJoe Perches 647c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 648c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 649c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 650351b2a1fSJoe Perches while (<$camelcase_file>) { 651351b2a1fSJoe Perches chomp; 652351b2a1fSJoe Perches $camelcase{$_} = 1; 653351b2a1fSJoe Perches } 654351b2a1fSJoe Perches close($camelcase_file); 655351b2a1fSJoe Perches 656351b2a1fSJoe Perches return; 657351b2a1fSJoe Perches } 658c707a81dSJoe Perches 6593645e328SRichard Genoud if (-e ".git") { 660c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 661c707a81dSJoe Perches @include_files = split('\n', $files); 6623445686aSJoe Perches } 663c707a81dSJoe Perches 6643445686aSJoe Perches foreach my $file (@include_files) { 6653445686aSJoe Perches seed_camelcase_file($file); 6663445686aSJoe Perches } 667351b2a1fSJoe Perches 668c707a81dSJoe Perches if ($camelcase_cache ne "") { 669351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 670c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 671c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 672351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 673351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 674351b2a1fSJoe Perches } 675351b2a1fSJoe Perches close($camelcase_file); 676351b2a1fSJoe Perches } 6773445686aSJoe Perches} 6783445686aSJoe Perches 679d311cd44SJoe Perchessub git_commit_info { 680d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 681d311cd44SJoe Perches 682d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 683d311cd44SJoe Perches 684d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 685d311cd44SJoe Perches $output =~ s/^\s*//gm; 686d311cd44SJoe Perches my @lines = split("\n", $output); 687d311cd44SJoe Perches 6880d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 6890d7835fcSJoe Perches 690d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 691d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 692d311cd44SJoe Perches# all matching commit ids, but it's very slow... 693d311cd44SJoe Perches# 694d311cd44SJoe Perches# echo "checking commits $1..." 695d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 696d311cd44SJoe Perches# while read line ; do 697d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 698d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 699d311cd44SJoe Perches# done 700d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 701d311cd44SJoe Perches } else { 702d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 703d311cd44SJoe Perches $desc = substr($lines[0], 41); 704d311cd44SJoe Perches } 705d311cd44SJoe Perches 706d311cd44SJoe Perches return ($id, $desc); 707d311cd44SJoe Perches} 708d311cd44SJoe Perches 7096c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7100a920b5bSAndy Whitcroft 71100df344fSAndy Whitcroftmy @rawlines = (); 712c2fdda0dSAndy Whitcroftmy @lines = (); 7133705ce5bSJoe Perchesmy @fixed = (); 714d752fcc8SJoe Perchesmy @fixed_inserted = (); 715d752fcc8SJoe Perchesmy @fixed_deleted = (); 716194f66fcSJoe Perchesmy $fixlinenr = -1; 717194f66fcSJoe Perches 718c2fdda0dSAndy Whitcroftmy $vname; 7196c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 72021caa13cSAndy Whitcroft my $FILE; 7216c72ffaaSAndy Whitcroft if ($file) { 72221caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7236c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 72421caa13cSAndy Whitcroft } elsif ($filename eq '-') { 72521caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7266c72ffaaSAndy Whitcroft } else { 72721caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7286c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7296c72ffaaSAndy Whitcroft } 730c2fdda0dSAndy Whitcroft if ($filename eq '-') { 731c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 732c2fdda0dSAndy Whitcroft } else { 733c2fdda0dSAndy Whitcroft $vname = $filename; 734c2fdda0dSAndy Whitcroft } 73521caa13cSAndy Whitcroft while (<$FILE>) { 7360a920b5bSAndy Whitcroft chomp; 73700df344fSAndy Whitcroft push(@rawlines, $_); 7386c72ffaaSAndy Whitcroft } 73921caa13cSAndy Whitcroft close($FILE); 740c2fdda0dSAndy Whitcroft if (!process($filename)) { 7410a920b5bSAndy Whitcroft $exit = 1; 7420a920b5bSAndy Whitcroft } 74300df344fSAndy Whitcroft @rawlines = (); 74413214adfSAndy Whitcroft @lines = (); 7453705ce5bSJoe Perches @fixed = (); 746d752fcc8SJoe Perches @fixed_inserted = (); 747d752fcc8SJoe Perches @fixed_deleted = (); 748194f66fcSJoe Perches $fixlinenr = -1; 7490a920b5bSAndy Whitcroft} 7500a920b5bSAndy Whitcroft 7510a920b5bSAndy Whitcroftexit($exit); 7520a920b5bSAndy Whitcroft 7530a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7546c72ffaaSAndy Whitcroft my ($root) = @_; 7556c72ffaaSAndy Whitcroft 7566c72ffaaSAndy Whitcroft my @tree_check = ( 7576c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7586c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 7596c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 7606c72ffaaSAndy Whitcroft ); 7616c72ffaaSAndy Whitcroft 7626c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 7636c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 7640a920b5bSAndy Whitcroft return 0; 7650a920b5bSAndy Whitcroft } 7666c72ffaaSAndy Whitcroft } 7676c72ffaaSAndy Whitcroft return 1; 7686c72ffaaSAndy Whitcroft} 7690a920b5bSAndy Whitcroft 77020112475SJoe Perchessub parse_email { 77120112475SJoe Perches my ($formatted_email) = @_; 77220112475SJoe Perches 77320112475SJoe Perches my $name = ""; 77420112475SJoe Perches my $address = ""; 77520112475SJoe Perches my $comment = ""; 77620112475SJoe Perches 77720112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 77820112475SJoe Perches $name = $1; 77920112475SJoe Perches $address = $2; 78020112475SJoe Perches $comment = $3 if defined $3; 78120112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 78220112475SJoe Perches $address = $1; 78320112475SJoe Perches $comment = $2 if defined $2; 78420112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 78520112475SJoe Perches $address = $1; 78620112475SJoe Perches $comment = $2 if defined $2; 78720112475SJoe Perches $formatted_email =~ s/$address.*$//; 78820112475SJoe Perches $name = $formatted_email; 7893705ce5bSJoe Perches $name = trim($name); 79020112475SJoe Perches $name =~ s/^\"|\"$//g; 79120112475SJoe Perches # If there's a name left after stripping spaces and 79220112475SJoe Perches # leading quotes, and the address doesn't have both 79320112475SJoe Perches # leading and trailing angle brackets, the address 79420112475SJoe Perches # is invalid. ie: 79520112475SJoe Perches # "joe smith [email protected]" bad 79620112475SJoe Perches # "joe smith <[email protected]" bad 79720112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 79820112475SJoe Perches $name = ""; 79920112475SJoe Perches $address = ""; 80020112475SJoe Perches $comment = ""; 80120112475SJoe Perches } 80220112475SJoe Perches } 80320112475SJoe Perches 8043705ce5bSJoe Perches $name = trim($name); 80520112475SJoe Perches $name =~ s/^\"|\"$//g; 8063705ce5bSJoe Perches $address = trim($address); 80720112475SJoe Perches $address =~ s/^\<|\>$//g; 80820112475SJoe Perches 80920112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 81020112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 81120112475SJoe Perches $name = "\"$name\""; 81220112475SJoe Perches } 81320112475SJoe Perches 81420112475SJoe Perches return ($name, $address, $comment); 81520112475SJoe Perches} 81620112475SJoe Perches 81720112475SJoe Perchessub format_email { 81820112475SJoe Perches my ($name, $address) = @_; 81920112475SJoe Perches 82020112475SJoe Perches my $formatted_email; 82120112475SJoe Perches 8223705ce5bSJoe Perches $name = trim($name); 82320112475SJoe Perches $name =~ s/^\"|\"$//g; 8243705ce5bSJoe Perches $address = trim($address); 82520112475SJoe Perches 82620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 82720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 82820112475SJoe Perches $name = "\"$name\""; 82920112475SJoe Perches } 83020112475SJoe Perches 83120112475SJoe Perches if ("$name" eq "") { 83220112475SJoe Perches $formatted_email = "$address"; 83320112475SJoe Perches } else { 83420112475SJoe Perches $formatted_email = "$name <$address>"; 83520112475SJoe Perches } 83620112475SJoe Perches 83720112475SJoe Perches return $formatted_email; 83820112475SJoe Perches} 83920112475SJoe Perches 840d311cd44SJoe Perchessub which { 841d311cd44SJoe Perches my ($bin) = @_; 842d311cd44SJoe Perches 843d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 844d311cd44SJoe Perches if (-e "$path/$bin") { 845d311cd44SJoe Perches return "$path/$bin"; 846d311cd44SJoe Perches } 847d311cd44SJoe Perches } 848d311cd44SJoe Perches 849d311cd44SJoe Perches return ""; 850d311cd44SJoe Perches} 851d311cd44SJoe Perches 852000d1cc1SJoe Perchessub which_conf { 853000d1cc1SJoe Perches my ($conf) = @_; 854000d1cc1SJoe Perches 855000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 856000d1cc1SJoe Perches if (-e "$path/$conf") { 857000d1cc1SJoe Perches return "$path/$conf"; 858000d1cc1SJoe Perches } 859000d1cc1SJoe Perches } 860000d1cc1SJoe Perches 861000d1cc1SJoe Perches return ""; 862000d1cc1SJoe Perches} 863000d1cc1SJoe Perches 8640a920b5bSAndy Whitcroftsub expand_tabs { 8650a920b5bSAndy Whitcroft my ($str) = @_; 8660a920b5bSAndy Whitcroft 8670a920b5bSAndy Whitcroft my $res = ''; 8680a920b5bSAndy Whitcroft my $n = 0; 8690a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 8700a920b5bSAndy Whitcroft if ($c eq "\t") { 8710a920b5bSAndy Whitcroft $res .= ' '; 8720a920b5bSAndy Whitcroft $n++; 8730a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 8740a920b5bSAndy Whitcroft $res .= ' '; 8750a920b5bSAndy Whitcroft } 8760a920b5bSAndy Whitcroft next; 8770a920b5bSAndy Whitcroft } 8780a920b5bSAndy Whitcroft $res .= $c; 8790a920b5bSAndy Whitcroft $n++; 8800a920b5bSAndy Whitcroft } 8810a920b5bSAndy Whitcroft 8820a920b5bSAndy Whitcroft return $res; 8830a920b5bSAndy Whitcroft} 8846c72ffaaSAndy Whitcroftsub copy_spacing { 885773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 8866c72ffaaSAndy Whitcroft return $res; 8876c72ffaaSAndy Whitcroft} 8880a920b5bSAndy Whitcroft 8894a0df2efSAndy Whitcroftsub line_stats { 8904a0df2efSAndy Whitcroft my ($line) = @_; 8914a0df2efSAndy Whitcroft 8924a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 8934a0df2efSAndy Whitcroft $line =~ s/^.//; 8944a0df2efSAndy Whitcroft $line = expand_tabs($line); 8954a0df2efSAndy Whitcroft 8964a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 8974a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 8984a0df2efSAndy Whitcroft 8994a0df2efSAndy Whitcroft return (length($line), length($white)); 9004a0df2efSAndy Whitcroft} 9014a0df2efSAndy Whitcroft 902773647a0SAndy Whitcroftmy $sanitise_quote = ''; 903773647a0SAndy Whitcroft 904773647a0SAndy Whitcroftsub sanitise_line_reset { 905773647a0SAndy Whitcroft my ($in_comment) = @_; 906773647a0SAndy Whitcroft 907773647a0SAndy Whitcroft if ($in_comment) { 908773647a0SAndy Whitcroft $sanitise_quote = '*/'; 909773647a0SAndy Whitcroft } else { 910773647a0SAndy Whitcroft $sanitise_quote = ''; 911773647a0SAndy Whitcroft } 912773647a0SAndy Whitcroft} 91300df344fSAndy Whitcroftsub sanitise_line { 91400df344fSAndy Whitcroft my ($line) = @_; 91500df344fSAndy Whitcroft 91600df344fSAndy Whitcroft my $res = ''; 91700df344fSAndy Whitcroft my $l = ''; 91800df344fSAndy Whitcroft 919c2fdda0dSAndy Whitcroft my $qlen = 0; 920773647a0SAndy Whitcroft my $off = 0; 921773647a0SAndy Whitcroft my $c; 92200df344fSAndy Whitcroft 923773647a0SAndy Whitcroft # Always copy over the diff marker. 924773647a0SAndy Whitcroft $res = substr($line, 0, 1); 925773647a0SAndy Whitcroft 926773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 927773647a0SAndy Whitcroft $c = substr($line, $off, 1); 928773647a0SAndy Whitcroft 929773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 930773647a0SAndy Whitcroft # and end, all to $;. 931773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 932773647a0SAndy Whitcroft $sanitise_quote = '*/'; 933773647a0SAndy Whitcroft 934773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 935773647a0SAndy Whitcroft $off++; 93600df344fSAndy Whitcroft next; 937773647a0SAndy Whitcroft } 93881bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 939773647a0SAndy Whitcroft $sanitise_quote = ''; 940773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 941773647a0SAndy Whitcroft $off++; 942773647a0SAndy Whitcroft next; 943773647a0SAndy Whitcroft } 944113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 945113f04a8SDaniel Walker $sanitise_quote = '//'; 946113f04a8SDaniel Walker 947113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 948113f04a8SDaniel Walker $off++; 949113f04a8SDaniel Walker next; 950113f04a8SDaniel Walker } 951773647a0SAndy Whitcroft 952773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 953773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 954773647a0SAndy Whitcroft $c eq "\\") { 955773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 956773647a0SAndy Whitcroft $off++; 957773647a0SAndy Whitcroft next; 958773647a0SAndy Whitcroft } 959773647a0SAndy Whitcroft # Regular quotes. 960773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 961773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 962773647a0SAndy Whitcroft $sanitise_quote = $c; 963773647a0SAndy Whitcroft 964773647a0SAndy Whitcroft substr($res, $off, 1, $c); 965773647a0SAndy Whitcroft next; 966773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 967773647a0SAndy Whitcroft $sanitise_quote = ''; 96800df344fSAndy Whitcroft } 96900df344fSAndy Whitcroft } 970773647a0SAndy Whitcroft 971fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 972773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 973773647a0SAndy Whitcroft substr($res, $off, 1, $;); 974113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 975113f04a8SDaniel Walker substr($res, $off, 1, $;); 976773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 977773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 97800df344fSAndy Whitcroft } else { 979773647a0SAndy Whitcroft substr($res, $off, 1, $c); 98000df344fSAndy Whitcroft } 981c2fdda0dSAndy Whitcroft } 982c2fdda0dSAndy Whitcroft 983113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 984113f04a8SDaniel Walker $sanitise_quote = ''; 985113f04a8SDaniel Walker } 986113f04a8SDaniel Walker 987c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 988c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 989c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 990c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 991c2fdda0dSAndy Whitcroft 992c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 993c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 994c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 995c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 996c2fdda0dSAndy Whitcroft } 997c2fdda0dSAndy Whitcroft 99800df344fSAndy Whitcroft return $res; 99900df344fSAndy Whitcroft} 100000df344fSAndy Whitcroft 1001a6962d72SJoe Perchessub get_quoted_string { 1002a6962d72SJoe Perches my ($line, $rawline) = @_; 1003a6962d72SJoe Perches 10045e4f6ba5SJoe Perches return "" if ($line !~ m/(\"[X\t]+\")/g); 1005a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1006a6962d72SJoe Perches} 1007a6962d72SJoe Perches 10088905a67cSAndy Whitcroftsub ctx_statement_block { 10098905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10108905a67cSAndy Whitcroft my $line = $linenr - 1; 10118905a67cSAndy Whitcroft my $blk = ''; 10128905a67cSAndy Whitcroft my $soff = $off; 10138905a67cSAndy Whitcroft my $coff = $off - 1; 1014773647a0SAndy Whitcroft my $coff_set = 0; 10158905a67cSAndy Whitcroft 101613214adfSAndy Whitcroft my $loff = 0; 101713214adfSAndy Whitcroft 10188905a67cSAndy Whitcroft my $type = ''; 10198905a67cSAndy Whitcroft my $level = 0; 1020a2750645SAndy Whitcroft my @stack = (); 1021cf655043SAndy Whitcroft my $p; 10228905a67cSAndy Whitcroft my $c; 10238905a67cSAndy Whitcroft my $len = 0; 102413214adfSAndy Whitcroft 102513214adfSAndy Whitcroft my $remainder; 10268905a67cSAndy Whitcroft while (1) { 1027a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1028a2750645SAndy Whitcroft 1029773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10308905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10318905a67cSAndy Whitcroft # context. 10328905a67cSAndy Whitcroft if ($off >= $len) { 10338905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1034dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1035c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10368905a67cSAndy Whitcroft $remain--; 103713214adfSAndy Whitcroft $loff = $len; 1038c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10398905a67cSAndy Whitcroft $len = length($blk); 10408905a67cSAndy Whitcroft $line++; 10418905a67cSAndy Whitcroft last; 10428905a67cSAndy Whitcroft } 10438905a67cSAndy Whitcroft # Bail if there is no further context. 10448905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 104513214adfSAndy Whitcroft if ($off >= $len) { 10468905a67cSAndy Whitcroft last; 10478905a67cSAndy Whitcroft } 1048f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1049f74bd194SAndy Whitcroft $level++; 1050f74bd194SAndy Whitcroft $type = '#'; 1051f74bd194SAndy Whitcroft } 10528905a67cSAndy Whitcroft } 1053cf655043SAndy Whitcroft $p = $c; 10548905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 105513214adfSAndy Whitcroft $remainder = substr($blk, $off); 10568905a67cSAndy Whitcroft 1057773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10584635f4fbSAndy Whitcroft 10594635f4fbSAndy Whitcroft # Handle nested #if/#else. 10604635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 10614635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 10624635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 10634635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 10644635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 10654635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 10664635f4fbSAndy Whitcroft } 10674635f4fbSAndy Whitcroft 10688905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 10698905a67cSAndy Whitcroft # outermost level. 10708905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 10718905a67cSAndy Whitcroft last; 10728905a67cSAndy Whitcroft } 10738905a67cSAndy Whitcroft 107413214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1075773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1076773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1077773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1078773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1079773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1080773647a0SAndy Whitcroft $coff_set = 1; 1081773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1082773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 108313214adfSAndy Whitcroft } 108413214adfSAndy Whitcroft 10858905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 10868905a67cSAndy Whitcroft $level++; 10878905a67cSAndy Whitcroft $type = '('; 10888905a67cSAndy Whitcroft } 10898905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 10908905a67cSAndy Whitcroft $level--; 10918905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 10928905a67cSAndy Whitcroft 10938905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 10948905a67cSAndy Whitcroft $coff = $off; 1095773647a0SAndy Whitcroft $coff_set = 1; 1096773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 10978905a67cSAndy Whitcroft } 10988905a67cSAndy Whitcroft } 10998905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11008905a67cSAndy Whitcroft $level++; 11018905a67cSAndy Whitcroft $type = '{'; 11028905a67cSAndy Whitcroft } 11038905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11048905a67cSAndy Whitcroft $level--; 11058905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11068905a67cSAndy Whitcroft 11078905a67cSAndy Whitcroft if ($level == 0) { 1108b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1109b998e001SPatrick Pannuto $off++; 1110b998e001SPatrick Pannuto } 11118905a67cSAndy Whitcroft last; 11128905a67cSAndy Whitcroft } 11138905a67cSAndy Whitcroft } 1114f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1115f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1116f74bd194SAndy Whitcroft $level--; 1117f74bd194SAndy Whitcroft $type = ''; 1118f74bd194SAndy Whitcroft $off++; 1119f74bd194SAndy Whitcroft last; 1120f74bd194SAndy Whitcroft } 11218905a67cSAndy Whitcroft $off++; 11228905a67cSAndy Whitcroft } 1123a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 112413214adfSAndy Whitcroft if ($off == $len) { 1125a3bb97a7SAndy Whitcroft $loff = $len + 1; 112613214adfSAndy Whitcroft $line++; 112713214adfSAndy Whitcroft $remain--; 112813214adfSAndy Whitcroft } 11298905a67cSAndy Whitcroft 11308905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11318905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11328905a67cSAndy Whitcroft 11338905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11348905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11358905a67cSAndy Whitcroft 1136773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 113713214adfSAndy Whitcroft 113813214adfSAndy Whitcroft return ($statement, $condition, 113913214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 114013214adfSAndy Whitcroft} 114113214adfSAndy Whitcroft 1142cf655043SAndy Whitcroftsub statement_lines { 1143cf655043SAndy Whitcroft my ($stmt) = @_; 1144cf655043SAndy Whitcroft 1145cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1146cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1147cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1148cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1149cf655043SAndy Whitcroft 1150cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1151cf655043SAndy Whitcroft 1152cf655043SAndy Whitcroft return $#stmt_lines + 2; 1153cf655043SAndy Whitcroft} 1154cf655043SAndy Whitcroft 1155cf655043SAndy Whitcroftsub statement_rawlines { 1156cf655043SAndy Whitcroft my ($stmt) = @_; 1157cf655043SAndy Whitcroft 1158cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1159cf655043SAndy Whitcroft 1160cf655043SAndy Whitcroft return $#stmt_lines + 2; 1161cf655043SAndy Whitcroft} 1162cf655043SAndy Whitcroft 1163cf655043SAndy Whitcroftsub statement_block_size { 1164cf655043SAndy Whitcroft my ($stmt) = @_; 1165cf655043SAndy Whitcroft 1166cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1167cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1168cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1169cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1170cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1171cf655043SAndy Whitcroft 1172cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1173cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1174cf655043SAndy Whitcroft 1175cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1176cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1177cf655043SAndy Whitcroft 1178cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1179cf655043SAndy Whitcroft return $stmt_lines; 1180cf655043SAndy Whitcroft } else { 1181cf655043SAndy Whitcroft return $stmt_statements; 1182cf655043SAndy Whitcroft } 1183cf655043SAndy Whitcroft} 1184cf655043SAndy Whitcroft 118513214adfSAndy Whitcroftsub ctx_statement_full { 118613214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 118713214adfSAndy Whitcroft my ($statement, $condition, $level); 118813214adfSAndy Whitcroft 118913214adfSAndy Whitcroft my (@chunks); 119013214adfSAndy Whitcroft 1191cf655043SAndy Whitcroft # Grab the first conditional/block pair. 119213214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 119313214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1194773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 119513214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1196cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1197cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1198cf655043SAndy Whitcroft } 1199cf655043SAndy Whitcroft 1200cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1201cf655043SAndy Whitcroft # could continue the statement. 1202cf655043SAndy Whitcroft for (;;) { 120313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 120413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1205cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1206773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1207cf655043SAndy Whitcroft #print "C: push\n"; 1208cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 120913214adfSAndy Whitcroft } 121013214adfSAndy Whitcroft 121113214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12128905a67cSAndy Whitcroft} 12138905a67cSAndy Whitcroft 12144a0df2efSAndy Whitcroftsub ctx_block_get { 1215f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12164a0df2efSAndy Whitcroft my $line; 12174a0df2efSAndy Whitcroft my $start = $linenr - 1; 12184a0df2efSAndy Whitcroft my $blk = ''; 12194a0df2efSAndy Whitcroft my @o; 12204a0df2efSAndy Whitcroft my @c; 12214a0df2efSAndy Whitcroft my @res = (); 12224a0df2efSAndy Whitcroft 1223f0a594c1SAndy Whitcroft my $level = 0; 12244635f4fbSAndy Whitcroft my @stack = ($level); 122500df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 122600df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 122700df344fSAndy Whitcroft $remain--; 122800df344fSAndy Whitcroft 122900df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12304635f4fbSAndy Whitcroft 12314635f4fbSAndy Whitcroft # Handle nested #if/#else. 123201464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12334635f4fbSAndy Whitcroft push(@stack, $level); 123401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12354635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 123601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12374635f4fbSAndy Whitcroft $level = pop(@stack); 12384635f4fbSAndy Whitcroft } 12394635f4fbSAndy Whitcroft 124001464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1241f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1242f0a594c1SAndy Whitcroft if ($off > 0) { 1243f0a594c1SAndy Whitcroft $off--; 1244f0a594c1SAndy Whitcroft next; 1245f0a594c1SAndy Whitcroft } 12464a0df2efSAndy Whitcroft 1247f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1248f0a594c1SAndy Whitcroft $level--; 1249f0a594c1SAndy Whitcroft last if ($level == 0); 1250f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1251f0a594c1SAndy Whitcroft $level++; 1252f0a594c1SAndy Whitcroft } 1253f0a594c1SAndy Whitcroft } 12544a0df2efSAndy Whitcroft 1255f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 125600df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12574a0df2efSAndy Whitcroft } 12584a0df2efSAndy Whitcroft 1259f0a594c1SAndy Whitcroft last if ($level == 0); 12604a0df2efSAndy Whitcroft } 12614a0df2efSAndy Whitcroft 1262f0a594c1SAndy Whitcroft return ($level, @res); 12634a0df2efSAndy Whitcroft} 12644a0df2efSAndy Whitcroftsub ctx_block_outer { 12654a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12664a0df2efSAndy Whitcroft 1267f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1268f0a594c1SAndy Whitcroft return @r; 12694a0df2efSAndy Whitcroft} 12704a0df2efSAndy Whitcroftsub ctx_block { 12714a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12724a0df2efSAndy Whitcroft 1273f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1274f0a594c1SAndy Whitcroft return @r; 1275653d4876SAndy Whitcroft} 1276653d4876SAndy Whitcroftsub ctx_statement { 1277f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1278f0a594c1SAndy Whitcroft 1279f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1280f0a594c1SAndy Whitcroft return @r; 1281f0a594c1SAndy Whitcroft} 1282f0a594c1SAndy Whitcroftsub ctx_block_level { 1283653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1284653d4876SAndy Whitcroft 1285f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 12864a0df2efSAndy Whitcroft} 12879c0ca6f9SAndy Whitcroftsub ctx_statement_level { 12889c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 12899c0ca6f9SAndy Whitcroft 12909c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 12919c0ca6f9SAndy Whitcroft} 12924a0df2efSAndy Whitcroft 12934a0df2efSAndy Whitcroftsub ctx_locate_comment { 12944a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 12954a0df2efSAndy Whitcroft 12964a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1297beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 12984a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 12994a0df2efSAndy Whitcroft 13004a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13014a0df2efSAndy Whitcroft # comment. 13024a0df2efSAndy Whitcroft my $in_comment = 0; 13034a0df2efSAndy Whitcroft $current_comment = ''; 13044a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 130500df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 130600df344fSAndy Whitcroft #warn " $line\n"; 13074a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13084a0df2efSAndy Whitcroft $in_comment = 1; 13094a0df2efSAndy Whitcroft } 13104a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13114a0df2efSAndy Whitcroft $in_comment = 1; 13124a0df2efSAndy Whitcroft } 13134a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13144a0df2efSAndy Whitcroft $current_comment = ''; 13154a0df2efSAndy Whitcroft } 13164a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13174a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13184a0df2efSAndy Whitcroft $in_comment = 0; 13194a0df2efSAndy Whitcroft } 13204a0df2efSAndy Whitcroft } 13214a0df2efSAndy Whitcroft 13224a0df2efSAndy Whitcroft chomp($current_comment); 13234a0df2efSAndy Whitcroft return($current_comment); 13244a0df2efSAndy Whitcroft} 13254a0df2efSAndy Whitcroftsub ctx_has_comment { 13264a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13274a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13284a0df2efSAndy Whitcroft 132900df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13304a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13314a0df2efSAndy Whitcroft 13324a0df2efSAndy Whitcroft return ($cmt ne ''); 13334a0df2efSAndy Whitcroft} 13344a0df2efSAndy Whitcroft 13354d001e4dSAndy Whitcroftsub raw_line { 13364d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13374d001e4dSAndy Whitcroft 13384d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13394d001e4dSAndy Whitcroft $cnt++; 13404d001e4dSAndy Whitcroft 13414d001e4dSAndy Whitcroft my $line; 13424d001e4dSAndy Whitcroft while ($cnt) { 13434d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13444d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13454d001e4dSAndy Whitcroft $cnt--; 13464d001e4dSAndy Whitcroft } 13474d001e4dSAndy Whitcroft 13484d001e4dSAndy Whitcroft return $line; 13494d001e4dSAndy Whitcroft} 13504d001e4dSAndy Whitcroft 13510a920b5bSAndy Whitcroftsub cat_vet { 13520a920b5bSAndy Whitcroft my ($vet) = @_; 13539c0ca6f9SAndy Whitcroft my ($res, $coded); 13540a920b5bSAndy Whitcroft 13559c0ca6f9SAndy Whitcroft $res = ''; 13566c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13576c72ffaaSAndy Whitcroft $res .= $1; 13586c72ffaaSAndy Whitcroft if ($2 ne '') { 13599c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 13606c72ffaaSAndy Whitcroft $res .= $coded; 13616c72ffaaSAndy Whitcroft } 13629c0ca6f9SAndy Whitcroft } 13639c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 13640a920b5bSAndy Whitcroft 13659c0ca6f9SAndy Whitcroft return $res; 13660a920b5bSAndy Whitcroft} 13670a920b5bSAndy Whitcroft 1368c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1369cf655043SAndy Whitcroftmy $av_pending; 1370c2fdda0dSAndy Whitcroftmy @av_paren_type; 13711f65f947SAndy Whitcroftmy $av_pend_colon; 1372c2fdda0dSAndy Whitcroft 1373c2fdda0dSAndy Whitcroftsub annotate_reset { 1374c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1375cf655043SAndy Whitcroft $av_pending = '_'; 1376cf655043SAndy Whitcroft @av_paren_type = ('E'); 13771f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1378c2fdda0dSAndy Whitcroft} 1379c2fdda0dSAndy Whitcroft 13806c72ffaaSAndy Whitcroftsub annotate_values { 13816c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 13826c72ffaaSAndy Whitcroft 13836c72ffaaSAndy Whitcroft my $res; 13841f65f947SAndy Whitcroft my $var = '_' x length($stream); 13856c72ffaaSAndy Whitcroft my $cur = $stream; 13866c72ffaaSAndy Whitcroft 1387c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 13886c72ffaaSAndy Whitcroft 13896c72ffaaSAndy Whitcroft while (length($cur)) { 1390773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1391cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1392171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 13936c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1394c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1395c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1396cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1397c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 13986c72ffaaSAndy Whitcroft } 13996c72ffaaSAndy Whitcroft 1400c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14019446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14029446ef56SAndy Whitcroft push(@av_paren_type, $type); 1403addcdceaSAndy Whitcroft $type = 'c'; 14049446ef56SAndy Whitcroft 1405e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1406c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14076c72ffaaSAndy Whitcroft $type = 'T'; 14086c72ffaaSAndy Whitcroft 1409389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1410389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1411389a2fe5SAndy Whitcroft $type = 'T'; 1412389a2fe5SAndy Whitcroft 1413c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1414171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1415c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1416171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1417171ae1a4SAndy Whitcroft if ($2 ne '') { 1418cf655043SAndy Whitcroft $av_pending = 'N'; 1419171ae1a4SAndy Whitcroft } 1420171ae1a4SAndy Whitcroft $type = 'E'; 1421171ae1a4SAndy Whitcroft 1422c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1423171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1424171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1425171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14266c72ffaaSAndy Whitcroft 1427c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1428cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1429c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1430cf655043SAndy Whitcroft 1431cf655043SAndy Whitcroft push(@av_paren_type, $type); 1432cf655043SAndy Whitcroft push(@av_paren_type, $type); 1433171ae1a4SAndy Whitcroft $type = 'E'; 1434cf655043SAndy Whitcroft 1435c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1436cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1437cf655043SAndy Whitcroft $av_preprocessor = 1; 1438cf655043SAndy Whitcroft 1439cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1440cf655043SAndy Whitcroft 1441171ae1a4SAndy Whitcroft $type = 'E'; 1442cf655043SAndy Whitcroft 1443c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1444cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1445cf655043SAndy Whitcroft 1446cf655043SAndy Whitcroft $av_preprocessor = 1; 1447cf655043SAndy Whitcroft 1448cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1449cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1450cf655043SAndy Whitcroft pop(@av_paren_type); 1451cf655043SAndy Whitcroft push(@av_paren_type, $type); 1452171ae1a4SAndy Whitcroft $type = 'E'; 14536c72ffaaSAndy Whitcroft 14546c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1455c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14566c72ffaaSAndy Whitcroft 1457171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1458171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1459171ae1a4SAndy Whitcroft $av_pending = $type; 1460171ae1a4SAndy Whitcroft $type = 'N'; 1461171ae1a4SAndy Whitcroft 14626c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1463c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 14646c72ffaaSAndy Whitcroft if (defined $2) { 1465cf655043SAndy Whitcroft $av_pending = 'V'; 14666c72ffaaSAndy Whitcroft } 14676c72ffaaSAndy Whitcroft $type = 'N'; 14686c72ffaaSAndy Whitcroft 146914b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1470c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 147114b111c1SAndy Whitcroft $av_pending = 'E'; 14726c72ffaaSAndy Whitcroft $type = 'N'; 14736c72ffaaSAndy Whitcroft 14741f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 14751f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 14761f65f947SAndy Whitcroft $av_pend_colon = 'C'; 14771f65f947SAndy Whitcroft $type = 'N'; 14781f65f947SAndy Whitcroft 147914b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1480c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 14816c72ffaaSAndy Whitcroft $type = 'N'; 14826c72ffaaSAndy Whitcroft 14836c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1484c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1485cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1486cf655043SAndy Whitcroft $av_pending = '_'; 14876c72ffaaSAndy Whitcroft $type = 'N'; 14886c72ffaaSAndy Whitcroft 14896c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1490cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1491cf655043SAndy Whitcroft if ($new_type ne '_') { 1492cf655043SAndy Whitcroft $type = $new_type; 1493c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1494c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 14956c72ffaaSAndy Whitcroft } else { 1496c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 14976c72ffaaSAndy Whitcroft } 14986c72ffaaSAndy Whitcroft 1499c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1500c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1501c8cb2ca3SAndy Whitcroft $type = 'V'; 1502cf655043SAndy Whitcroft $av_pending = 'V'; 15036c72ffaaSAndy Whitcroft 15048e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15058e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15061f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15078e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15088e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15091f65f947SAndy Whitcroft } 15101f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15111f65f947SAndy Whitcroft $type = 'V'; 15121f65f947SAndy Whitcroft 15136c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1514c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15156c72ffaaSAndy Whitcroft $type = 'V'; 15166c72ffaaSAndy Whitcroft 15176c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1518c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15196c72ffaaSAndy Whitcroft $type = 'N'; 15206c72ffaaSAndy Whitcroft 1521cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1522c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 152313214adfSAndy Whitcroft $type = 'E'; 15241f65f947SAndy Whitcroft $av_pend_colon = 'O'; 152513214adfSAndy Whitcroft 15268e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15278e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15288e761b04SAndy Whitcroft $type = 'C'; 15298e761b04SAndy Whitcroft 15301f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15311f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15321f65f947SAndy Whitcroft $type = 'N'; 15331f65f947SAndy Whitcroft 15341f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15351f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15361f65f947SAndy Whitcroft 15371f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15381f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15391f65f947SAndy Whitcroft $type = 'E'; 15401f65f947SAndy Whitcroft } else { 15411f65f947SAndy Whitcroft $type = 'N'; 15421f65f947SAndy Whitcroft } 15431f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15441f65f947SAndy Whitcroft 15458e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 154613214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15476c72ffaaSAndy Whitcroft $type = 'N'; 15486c72ffaaSAndy Whitcroft 15490d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 155074048ed8SAndy Whitcroft my $variant; 155174048ed8SAndy Whitcroft 155274048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 155374048ed8SAndy Whitcroft if ($type eq 'V') { 155474048ed8SAndy Whitcroft $variant = 'B'; 155574048ed8SAndy Whitcroft } else { 155674048ed8SAndy Whitcroft $variant = 'U'; 155774048ed8SAndy Whitcroft } 155874048ed8SAndy Whitcroft 155974048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 156074048ed8SAndy Whitcroft $type = 'N'; 156174048ed8SAndy Whitcroft 15626c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1563c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 15646c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 15656c72ffaaSAndy Whitcroft $type = 'N'; 15666c72ffaaSAndy Whitcroft } 15676c72ffaaSAndy Whitcroft 15686c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1569c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 15706c72ffaaSAndy Whitcroft } 15716c72ffaaSAndy Whitcroft if (defined $1) { 15726c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 15736c72ffaaSAndy Whitcroft $res .= $type x length($1); 15746c72ffaaSAndy Whitcroft } 15756c72ffaaSAndy Whitcroft } 15766c72ffaaSAndy Whitcroft 15771f65f947SAndy Whitcroft return ($res, $var); 15786c72ffaaSAndy Whitcroft} 15796c72ffaaSAndy Whitcroft 15808905a67cSAndy Whitcroftsub possible { 158113214adfSAndy Whitcroft my ($possible, $line) = @_; 15829a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 15830776e594SAndy Whitcroft ^(?: 15840776e594SAndy Whitcroft $Modifier| 15850776e594SAndy Whitcroft $Storage| 15860776e594SAndy Whitcroft $Type| 15879a974fdbSAndy Whitcroft DEFINE_\S+ 15889a974fdbSAndy Whitcroft )$| 15899a974fdbSAndy Whitcroft ^(?: 15900776e594SAndy Whitcroft goto| 15910776e594SAndy Whitcroft return| 15920776e594SAndy Whitcroft case| 15930776e594SAndy Whitcroft else| 15940776e594SAndy Whitcroft asm|__asm__| 159589a88353SAndy Whitcroft do| 159689a88353SAndy Whitcroft \#| 159789a88353SAndy Whitcroft \#\#| 15989a974fdbSAndy Whitcroft )(?:\s|$)| 15990776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16009a974fdbSAndy Whitcroft )}x; 16019a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16029a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1603c45dcabdSAndy Whitcroft # Check for modifiers. 1604c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1605c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1606c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1607c45dcabdSAndy Whitcroft 1608c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1609c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1610d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16119a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1612d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1613d2506586SAndy Whitcroft push(@modifierList, $modifier); 1614d2506586SAndy Whitcroft } 16159a974fdbSAndy Whitcroft } 1616c45dcabdSAndy Whitcroft 1617c45dcabdSAndy Whitcroft } else { 161813214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 16198905a67cSAndy Whitcroft push(@typeList, $possible); 1620c45dcabdSAndy Whitcroft } 16218905a67cSAndy Whitcroft build_types(); 16220776e594SAndy Whitcroft } else { 16230776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16248905a67cSAndy Whitcroft } 16258905a67cSAndy Whitcroft} 16268905a67cSAndy Whitcroft 16276c72ffaaSAndy Whitcroftmy $prefix = ''; 16286c72ffaaSAndy Whitcroft 1629000d1cc1SJoe Perchessub show_type { 1630cbec18afSJoe Perches my ($type) = @_; 163191bfe484SJoe Perches 1632cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1633cbec18afSJoe Perches 1634cbec18afSJoe Perches return !defined $ignore_type{$type}; 1635000d1cc1SJoe Perches} 1636000d1cc1SJoe Perches 1637f0a594c1SAndy Whitcroftsub report { 1638cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1639cbec18afSJoe Perches 1640cbec18afSJoe Perches if (!show_type($type) || 1641cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1642773647a0SAndy Whitcroft return 0; 1643773647a0SAndy Whitcroft } 1644000d1cc1SJoe Perches my $line; 1645000d1cc1SJoe Perches if ($show_types) { 1646cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1647000d1cc1SJoe Perches } else { 1648cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1649000d1cc1SJoe Perches } 16508905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 16518905a67cSAndy Whitcroft 165213214adfSAndy Whitcroft push(our @report, $line); 1653773647a0SAndy Whitcroft 1654773647a0SAndy Whitcroft return 1; 1655f0a594c1SAndy Whitcroft} 1656cbec18afSJoe Perches 1657f0a594c1SAndy Whitcroftsub report_dump { 165813214adfSAndy Whitcroft our @report; 1659f0a594c1SAndy Whitcroft} 1660000d1cc1SJoe Perches 1661d752fcc8SJoe Perchessub fixup_current_range { 1662d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1663d752fcc8SJoe Perches 1664d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1665d752fcc8SJoe Perches my $o = $1; 1666d752fcc8SJoe Perches my $l = $2; 1667d752fcc8SJoe Perches my $no = $o + $offset; 1668d752fcc8SJoe Perches my $nl = $l + $length; 1669d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1670d752fcc8SJoe Perches } 1671d752fcc8SJoe Perches} 1672d752fcc8SJoe Perches 1673d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1674d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1675d752fcc8SJoe Perches 1676d752fcc8SJoe Perches my $range_last_linenr = 0; 1677d752fcc8SJoe Perches my $delta_offset = 0; 1678d752fcc8SJoe Perches 1679d752fcc8SJoe Perches my $old_linenr = 0; 1680d752fcc8SJoe Perches my $new_linenr = 0; 1681d752fcc8SJoe Perches 1682d752fcc8SJoe Perches my $next_insert = 0; 1683d752fcc8SJoe Perches my $next_delete = 0; 1684d752fcc8SJoe Perches 1685d752fcc8SJoe Perches my @lines = (); 1686d752fcc8SJoe Perches 1687d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1688d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1689d752fcc8SJoe Perches 1690d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1691d752fcc8SJoe Perches my $save_line = 1; 1692d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1693d752fcc8SJoe Perches if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename 1694d752fcc8SJoe Perches $delta_offset = 0; 1695d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1696d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1697d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1698d752fcc8SJoe Perches } 1699d752fcc8SJoe Perches 1700d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1701d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1702d752fcc8SJoe Perches $save_line = 0; 1703d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1704d752fcc8SJoe Perches } 1705d752fcc8SJoe Perches 1706d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1707d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1708d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1709d752fcc8SJoe Perches $new_linenr++; 1710d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1711d752fcc8SJoe Perches } 1712d752fcc8SJoe Perches 1713d752fcc8SJoe Perches if ($save_line) { 1714d752fcc8SJoe Perches push(@lines, $line); 1715d752fcc8SJoe Perches $new_linenr++; 1716d752fcc8SJoe Perches } 1717d752fcc8SJoe Perches 1718d752fcc8SJoe Perches $old_linenr++; 1719d752fcc8SJoe Perches } 1720d752fcc8SJoe Perches 1721d752fcc8SJoe Perches return @lines; 1722d752fcc8SJoe Perches} 1723d752fcc8SJoe Perches 1724f2d7e4d4SJoe Perchessub fix_insert_line { 1725f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1726f2d7e4d4SJoe Perches 1727f2d7e4d4SJoe Perches my $inserted = { 1728f2d7e4d4SJoe Perches LINENR => $linenr, 1729f2d7e4d4SJoe Perches LINE => $line, 1730f2d7e4d4SJoe Perches }; 1731f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1732f2d7e4d4SJoe Perches} 1733f2d7e4d4SJoe Perches 1734f2d7e4d4SJoe Perchessub fix_delete_line { 1735f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1736f2d7e4d4SJoe Perches 1737f2d7e4d4SJoe Perches my $deleted = { 1738f2d7e4d4SJoe Perches LINENR => $linenr, 1739f2d7e4d4SJoe Perches LINE => $line, 1740f2d7e4d4SJoe Perches }; 1741f2d7e4d4SJoe Perches 1742f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1743f2d7e4d4SJoe Perches} 1744f2d7e4d4SJoe Perches 1745de7d4f0eSAndy Whitcroftsub ERROR { 1746cbec18afSJoe Perches my ($type, $msg) = @_; 1747cbec18afSJoe Perches 1748cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1749de7d4f0eSAndy Whitcroft our $clean = 0; 17506c72ffaaSAndy Whitcroft our $cnt_error++; 17513705ce5bSJoe Perches return 1; 1752de7d4f0eSAndy Whitcroft } 17533705ce5bSJoe Perches return 0; 1754773647a0SAndy Whitcroft} 1755de7d4f0eSAndy Whitcroftsub WARN { 1756cbec18afSJoe Perches my ($type, $msg) = @_; 1757cbec18afSJoe Perches 1758cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1759de7d4f0eSAndy Whitcroft our $clean = 0; 17606c72ffaaSAndy Whitcroft our $cnt_warn++; 17613705ce5bSJoe Perches return 1; 1762de7d4f0eSAndy Whitcroft } 17633705ce5bSJoe Perches return 0; 1764773647a0SAndy Whitcroft} 1765de7d4f0eSAndy Whitcroftsub CHK { 1766cbec18afSJoe Perches my ($type, $msg) = @_; 1767cbec18afSJoe Perches 1768cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1769de7d4f0eSAndy Whitcroft our $clean = 0; 17706c72ffaaSAndy Whitcroft our $cnt_chk++; 17713705ce5bSJoe Perches return 1; 17726c72ffaaSAndy Whitcroft } 17733705ce5bSJoe Perches return 0; 1774de7d4f0eSAndy Whitcroft} 1775de7d4f0eSAndy Whitcroft 17766ecd9674SAndy Whitcroftsub check_absolute_file { 17776ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 17786ecd9674SAndy Whitcroft my $file = $absolute; 17796ecd9674SAndy Whitcroft 17806ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 17816ecd9674SAndy Whitcroft 17826ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 17836ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 17846ecd9674SAndy Whitcroft if (-f "$root/$file") { 17856ecd9674SAndy Whitcroft ##print "file<$file>\n"; 17866ecd9674SAndy Whitcroft last; 17876ecd9674SAndy Whitcroft } 17886ecd9674SAndy Whitcroft } 17896ecd9674SAndy Whitcroft if (! -f _) { 17906ecd9674SAndy Whitcroft return 0; 17916ecd9674SAndy Whitcroft } 17926ecd9674SAndy Whitcroft 17936ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 17946ecd9674SAndy Whitcroft my $prefix = $absolute; 17956ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 17966ecd9674SAndy Whitcroft 17976ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 17986ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1799000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1800000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18016ecd9674SAndy Whitcroft } 18026ecd9674SAndy Whitcroft} 18036ecd9674SAndy Whitcroft 18043705ce5bSJoe Perchessub trim { 18053705ce5bSJoe Perches my ($string) = @_; 18063705ce5bSJoe Perches 1807b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1808b34c648bSJoe Perches 1809b34c648bSJoe Perches return $string; 1810b34c648bSJoe Perches} 1811b34c648bSJoe Perches 1812b34c648bSJoe Perchessub ltrim { 1813b34c648bSJoe Perches my ($string) = @_; 1814b34c648bSJoe Perches 1815b34c648bSJoe Perches $string =~ s/^\s+//; 1816b34c648bSJoe Perches 1817b34c648bSJoe Perches return $string; 1818b34c648bSJoe Perches} 1819b34c648bSJoe Perches 1820b34c648bSJoe Perchessub rtrim { 1821b34c648bSJoe Perches my ($string) = @_; 1822b34c648bSJoe Perches 1823b34c648bSJoe Perches $string =~ s/\s+$//; 18243705ce5bSJoe Perches 18253705ce5bSJoe Perches return $string; 18263705ce5bSJoe Perches} 18273705ce5bSJoe Perches 182852ea8506SJoe Perchessub string_find_replace { 182952ea8506SJoe Perches my ($string, $find, $replace) = @_; 183052ea8506SJoe Perches 183152ea8506SJoe Perches $string =~ s/$find/$replace/g; 183252ea8506SJoe Perches 183352ea8506SJoe Perches return $string; 183452ea8506SJoe Perches} 183552ea8506SJoe Perches 18363705ce5bSJoe Perchessub tabify { 18373705ce5bSJoe Perches my ($leading) = @_; 18383705ce5bSJoe Perches 18393705ce5bSJoe Perches my $source_indent = 8; 18403705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 18413705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 18423705ce5bSJoe Perches 18433705ce5bSJoe Perches #convert leading spaces to tabs 18443705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 18453705ce5bSJoe Perches #Remove spaces before a tab 18463705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 18473705ce5bSJoe Perches 18483705ce5bSJoe Perches return "$leading"; 18493705ce5bSJoe Perches} 18503705ce5bSJoe Perches 1851d1fe9c09SJoe Perchessub pos_last_openparen { 1852d1fe9c09SJoe Perches my ($line) = @_; 1853d1fe9c09SJoe Perches 1854d1fe9c09SJoe Perches my $pos = 0; 1855d1fe9c09SJoe Perches 1856d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1857d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1858d1fe9c09SJoe Perches 1859d1fe9c09SJoe Perches my $last_openparen = 0; 1860d1fe9c09SJoe Perches 1861d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1862d1fe9c09SJoe Perches return -1; 1863d1fe9c09SJoe Perches } 1864d1fe9c09SJoe Perches 1865d1fe9c09SJoe Perches my $len = length($line); 1866d1fe9c09SJoe Perches 1867d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1868d1fe9c09SJoe Perches my $string = substr($line, $pos); 1869d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1870d1fe9c09SJoe Perches $pos += length($1) - 1; 1871d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1872d1fe9c09SJoe Perches $last_openparen = $pos; 1873d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1874d1fe9c09SJoe Perches last; 1875d1fe9c09SJoe Perches } 1876d1fe9c09SJoe Perches } 1877d1fe9c09SJoe Perches 187891cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1879d1fe9c09SJoe Perches} 1880d1fe9c09SJoe Perches 18810a920b5bSAndy Whitcroftsub process { 18820a920b5bSAndy Whitcroft my $filename = shift; 18830a920b5bSAndy Whitcroft 18840a920b5bSAndy Whitcroft my $linenr=0; 18850a920b5bSAndy Whitcroft my $prevline=""; 1886c2fdda0dSAndy Whitcroft my $prevrawline=""; 18870a920b5bSAndy Whitcroft my $stashline=""; 1888c2fdda0dSAndy Whitcroft my $stashrawline=""; 18890a920b5bSAndy Whitcroft 18904a0df2efSAndy Whitcroft my $length; 18910a920b5bSAndy Whitcroft my $indent; 18920a920b5bSAndy Whitcroft my $previndent=0; 18930a920b5bSAndy Whitcroft my $stashindent=0; 18940a920b5bSAndy Whitcroft 1895de7d4f0eSAndy Whitcroft our $clean = 1; 18960a920b5bSAndy Whitcroft my $signoff = 0; 18970a920b5bSAndy Whitcroft my $is_patch = 0; 18980a920b5bSAndy Whitcroft 189929ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 190015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 19012a076f40SJoe Perches my $commit_log_long_line = 0; 190213f1937eSJoe Perches my $reported_maintainer_file = 0; 1903fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1904fa64205dSPasi Savanainen 1905365dd4eaSJoe Perches my $last_blank_line = 0; 19065e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1907365dd4eaSJoe Perches 190813214adfSAndy Whitcroft our @report = (); 19096c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19106c72ffaaSAndy Whitcroft our $cnt_error = 0; 19116c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19126c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19136c72ffaaSAndy Whitcroft 19140a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19150a920b5bSAndy Whitcroft my $realfile = ''; 19160a920b5bSAndy Whitcroft my $realline = 0; 19170a920b5bSAndy Whitcroft my $realcnt = 0; 19180a920b5bSAndy Whitcroft my $here = ''; 19190a920b5bSAndy Whitcroft my $in_comment = 0; 1920c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19210a920b5bSAndy Whitcroft my $first_line = 0; 19221e855726SWolfram Sang my $p1_prefix = ''; 19230a920b5bSAndy Whitcroft 192413214adfSAndy Whitcroft my $prev_values = 'E'; 192513214adfSAndy Whitcroft 192613214adfSAndy Whitcroft # suppression flags 1927773647a0SAndy Whitcroft my %suppress_ifbraces; 1928170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19292b474a1aSAndy Whitcroft my %suppress_export; 19303e469cdcSAndy Whitcroft my $suppress_statement = 0; 1931653d4876SAndy Whitcroft 19327e51f197SJoe Perches my %signatures = (); 1933323c1260SJoe Perches 1934c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1935de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1936c2fdda0dSAndy Whitcroft # 1937de7d4f0eSAndy Whitcroft my @setup_docs = (); 1938de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1939773647a0SAndy Whitcroft 1940d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1941d8b07710SJoe Perches 1942773647a0SAndy Whitcroft sanitise_line_reset(); 1943c2fdda0dSAndy Whitcroft my $line; 1944c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1945773647a0SAndy Whitcroft $linenr++; 1946773647a0SAndy Whitcroft $line = $rawline; 1947c2fdda0dSAndy Whitcroft 19483705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 19493705ce5bSJoe Perches 1950773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1951de7d4f0eSAndy Whitcroft $setup_docs = 0; 1952de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1953de7d4f0eSAndy Whitcroft $setup_docs = 1; 1954de7d4f0eSAndy Whitcroft } 1955773647a0SAndy Whitcroft #next; 1956de7d4f0eSAndy Whitcroft } 1957773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1958773647a0SAndy Whitcroft $realline=$1-1; 1959773647a0SAndy Whitcroft if (defined $2) { 1960773647a0SAndy Whitcroft $realcnt=$3+1; 1961773647a0SAndy Whitcroft } else { 1962773647a0SAndy Whitcroft $realcnt=1+1; 1963773647a0SAndy Whitcroft } 1964c45dcabdSAndy Whitcroft $in_comment = 0; 1965773647a0SAndy Whitcroft 1966773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1967773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1968773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1969773647a0SAndy Whitcroft # at context start. 1970773647a0SAndy Whitcroft my $edge; 197101fa9147SAndy Whitcroft my $cnt = $realcnt; 197201fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 197301fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 197401fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 197501fa9147SAndy Whitcroft $cnt--; 197601fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1977721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1978fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1979fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1980fae17daeSAndy Whitcroft ($edge) = $1; 1981fae17daeSAndy Whitcroft last; 1982fae17daeSAndy Whitcroft } 1983773647a0SAndy Whitcroft } 1984773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1985773647a0SAndy Whitcroft $in_comment = 1; 1986773647a0SAndy Whitcroft } 1987773647a0SAndy Whitcroft 1988773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1989773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1990773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1991773647a0SAndy Whitcroft if (!defined $edge && 199283242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1993773647a0SAndy Whitcroft { 1994773647a0SAndy Whitcroft $in_comment = 1; 1995773647a0SAndy Whitcroft } 1996773647a0SAndy Whitcroft 1997773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1998773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1999773647a0SAndy Whitcroft 2000171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2001773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2002171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2003773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2004773647a0SAndy Whitcroft } 2005773647a0SAndy Whitcroft push(@lines, $line); 2006773647a0SAndy Whitcroft 2007773647a0SAndy Whitcroft if ($realcnt > 1) { 2008773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2009773647a0SAndy Whitcroft } else { 2010773647a0SAndy Whitcroft $realcnt = 0; 2011773647a0SAndy Whitcroft } 2012773647a0SAndy Whitcroft 2013773647a0SAndy Whitcroft #print "==>$rawline\n"; 2014773647a0SAndy Whitcroft #print "-->$line\n"; 2015de7d4f0eSAndy Whitcroft 2016de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2017de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2018de7d4f0eSAndy Whitcroft } 2019de7d4f0eSAndy Whitcroft } 2020de7d4f0eSAndy Whitcroft 20216c72ffaaSAndy Whitcroft $prefix = ''; 20226c72ffaaSAndy Whitcroft 2023773647a0SAndy Whitcroft $realcnt = 0; 2024773647a0SAndy Whitcroft $linenr = 0; 2025194f66fcSJoe Perches $fixlinenr = -1; 20260a920b5bSAndy Whitcroft foreach my $line (@lines) { 20270a920b5bSAndy Whitcroft $linenr++; 2028194f66fcSJoe Perches $fixlinenr++; 20291b5539b1SJoe Perches my $sline = $line; #copy of $line 20301b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20310a920b5bSAndy Whitcroft 2032c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20336c72ffaaSAndy Whitcroft 20340a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 20356c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20360a920b5bSAndy Whitcroft $is_patch = 1; 20374a0df2efSAndy Whitcroft $first_line = $linenr + 1; 20380a920b5bSAndy Whitcroft $realline=$1-1; 20390a920b5bSAndy Whitcroft if (defined $2) { 20400a920b5bSAndy Whitcroft $realcnt=$3+1; 20410a920b5bSAndy Whitcroft } else { 20420a920b5bSAndy Whitcroft $realcnt=1+1; 20430a920b5bSAndy Whitcroft } 2044c2fdda0dSAndy Whitcroft annotate_reset(); 204513214adfSAndy Whitcroft $prev_values = 'E'; 204613214adfSAndy Whitcroft 2047773647a0SAndy Whitcroft %suppress_ifbraces = (); 2048170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 20492b474a1aSAndy Whitcroft %suppress_export = (); 20503e469cdcSAndy Whitcroft $suppress_statement = 0; 20510a920b5bSAndy Whitcroft next; 20520a920b5bSAndy Whitcroft 20534a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 20544a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 20554a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2056773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 20570a920b5bSAndy Whitcroft $realline++; 2058d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 20590a920b5bSAndy Whitcroft 20604a0df2efSAndy Whitcroft # Measure the line length and indent. 2061c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 20620a920b5bSAndy Whitcroft 20630a920b5bSAndy Whitcroft # Track the previous line. 20640a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 20650a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2066c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2067c2fdda0dSAndy Whitcroft 2068773647a0SAndy Whitcroft #warn "line<$line>\n"; 20696c72ffaaSAndy Whitcroft 2070d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2071d8aaf121SAndy Whitcroft $realcnt--; 20720a920b5bSAndy Whitcroft } 20730a920b5bSAndy Whitcroft 2074cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2075cc77cdcaSAndy Whitcroft 20760a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 2077773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 2078773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 2079773647a0SAndy Whitcroft 20806c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 20816c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2082773647a0SAndy Whitcroft 20832ac73b4fSJoe Perches my $found_file = 0; 2084773647a0SAndy Whitcroft # extract the filename as it passes 20853bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 20863bf9a009SRabin Vincent $realfile = $1; 20872b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2088270c49a0SJoe Perches $in_commit_log = 0; 20892ac73b4fSJoe Perches $found_file = 1; 20903bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2091773647a0SAndy Whitcroft $realfile = $1; 20922b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2093270c49a0SJoe Perches $in_commit_log = 0; 20941e855726SWolfram Sang 20951e855726SWolfram Sang $p1_prefix = $1; 2096e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2097e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2098000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2099000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21001e855726SWolfram Sang } 2101773647a0SAndy Whitcroft 2102c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2103000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2104000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2105773647a0SAndy Whitcroft } 21062ac73b4fSJoe Perches $found_file = 1; 21072ac73b4fSJoe Perches } 21082ac73b4fSJoe Perches 21092ac73b4fSJoe Perches if ($found_file) { 21102ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 21112ac73b4fSJoe Perches $check = 1; 21122ac73b4fSJoe Perches } else { 21132ac73b4fSJoe Perches $check = $check_orig; 21142ac73b4fSJoe Perches } 2115773647a0SAndy Whitcroft next; 2116773647a0SAndy Whitcroft } 2117773647a0SAndy Whitcroft 2118389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21190a920b5bSAndy Whitcroft 2120c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2121c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2122c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21230a920b5bSAndy Whitcroft 21246c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21256c72ffaaSAndy Whitcroft 21263bf9a009SRabin Vincent# Check for incorrect file permissions 21273bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 21283bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 212904db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 213004db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2131000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2132000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 21333bf9a009SRabin Vincent } 21343bf9a009SRabin Vincent } 21353bf9a009SRabin Vincent 213620112475SJoe Perches# Check the patch for a signoff: 2137d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 21384a0df2efSAndy Whitcroft $signoff++; 213915662b3eSJoe Perches $in_commit_log = 0; 21400a920b5bSAndy Whitcroft } 214120112475SJoe Perches 2142e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2143e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2144e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2145e0d975b1SJoe Perches $reported_maintainer_file = 1; 2146e0d975b1SJoe Perches } 2147e0d975b1SJoe Perches 214820112475SJoe Perches# Check signature styles 2149270c49a0SJoe Perches if (!$in_header_lines && 2150ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 215120112475SJoe Perches my $space_before = $1; 215220112475SJoe Perches my $sign_off = $2; 215320112475SJoe Perches my $space_after = $3; 215420112475SJoe Perches my $email = $4; 215520112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 215620112475SJoe Perches 2157ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2158ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2159ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2160ce0338dfSJoe Perches } 216120112475SJoe Perches if (defined $space_before && $space_before ne "") { 21623705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21633705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 21643705ce5bSJoe Perches $fix) { 2165194f66fcSJoe Perches $fixed[$fixlinenr] = 21663705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21673705ce5bSJoe Perches } 216820112475SJoe Perches } 216920112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 21703705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21713705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 21723705ce5bSJoe Perches $fix) { 2173194f66fcSJoe Perches $fixed[$fixlinenr] = 21743705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21753705ce5bSJoe Perches } 21763705ce5bSJoe Perches 217720112475SJoe Perches } 217820112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 21793705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21803705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 21813705ce5bSJoe Perches $fix) { 2182194f66fcSJoe Perches $fixed[$fixlinenr] = 21833705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21843705ce5bSJoe Perches } 218520112475SJoe Perches } 218620112475SJoe Perches 218720112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 218820112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 218920112475SJoe Perches if ($suggested_email eq "") { 2190000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2191000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 219220112475SJoe Perches } else { 219320112475SJoe Perches my $dequoted = $suggested_email; 219420112475SJoe Perches $dequoted =~ s/^"//; 219520112475SJoe Perches $dequoted =~ s/" </ </; 219620112475SJoe Perches # Don't force email to have quotes 219720112475SJoe Perches # Allow just an angle bracketed address 219820112475SJoe Perches if ("$dequoted$comment" ne $email && 219920112475SJoe Perches "<$email_address>$comment" ne $email && 220020112475SJoe Perches "$suggested_email$comment" ne $email) { 2201000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2202000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 220320112475SJoe Perches } 22040a920b5bSAndy Whitcroft } 22057e51f197SJoe Perches 22067e51f197SJoe Perches# Check for duplicate signatures 22077e51f197SJoe Perches my $sig_nospace = $line; 22087e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22097e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22107e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22117e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22127e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22137e51f197SJoe Perches } else { 22147e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22157e51f197SJoe Perches } 22160a920b5bSAndy Whitcroft } 22170a920b5bSAndy Whitcroft 2218a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2219a2fe16b9SJoe Perches if ($in_header_lines && 2220a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2221a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2222a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2223a2fe16b9SJoe Perches } 2224a2fe16b9SJoe Perches 22259b3189ebSJoe Perches# Check for old stable address 22269b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 22279b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 22289b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 22299b3189ebSJoe Perches } 22309b3189ebSJoe Perches 22317ebd05efSChristopher Covington# Check for unwanted Gerrit info 22327ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 22337ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 22347ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 22357ebd05efSChristopher Covington } 22367ebd05efSChristopher Covington 22372a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 22382a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 22392a076f40SJoe Perches length($line) > 75) { 22402a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 22412a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 22422a076f40SJoe Perches $commit_log_long_line = 1; 22432a076f40SJoe Perches } 22442a076f40SJoe Perches 22450d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 22460d7835fcSJoe Perches if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) { 2247d311cd44SJoe Perches my $init_char = $1; 2248d311cd44SJoe Perches my $orig_commit = lc($2); 22490d7835fcSJoe Perches my $short = 1; 22500d7835fcSJoe Perches my $long = 0; 22510d7835fcSJoe Perches my $case = 1; 22520d7835fcSJoe Perches my $space = 1; 22530d7835fcSJoe Perches my $hasdesc = 0; 225419c146a6SJoe Perches my $hasparens = 0; 22550d7835fcSJoe Perches my $id = '0123456789ab'; 22560d7835fcSJoe Perches my $orig_desc = "commit description"; 22570d7835fcSJoe Perches my $description = ""; 22580d7835fcSJoe Perches 22590d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 22600d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 22610d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 22620d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 22630d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 22640d7835fcSJoe Perches $orig_desc = $1; 226519c146a6SJoe Perches $hasparens = 1; 22660d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 22670d7835fcSJoe Perches defined $rawlines[$linenr] && 22680d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 22690d7835fcSJoe Perches $orig_desc = $1; 227019c146a6SJoe Perches $hasparens = 1; 2271b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2272b671fde0SJoe Perches defined $rawlines[$linenr] && 2273b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2274b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2275b671fde0SJoe Perches $orig_desc = $1; 2276b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2277b671fde0SJoe Perches $orig_desc .= " " . $1; 227819c146a6SJoe Perches $hasparens = 1; 22790d7835fcSJoe Perches } 22800d7835fcSJoe Perches 22810d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 22820d7835fcSJoe Perches $id, $orig_desc); 22830d7835fcSJoe Perches 228419c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2285d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 22860d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 22870d7835fcSJoe Perches } 2288d311cd44SJoe Perches } 2289d311cd44SJoe Perches 229013f1937eSJoe Perches# Check for added, moved or deleted files 229113f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 229213f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 229313f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 229413f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 229513f1937eSJoe Perches (defined($1) || defined($2))))) { 229613f1937eSJoe Perches $reported_maintainer_file = 1; 229713f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 229813f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 229913f1937eSJoe Perches } 230013f1937eSJoe Perches 230100df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 23028905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2303000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2304000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 23056c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2306de7d4f0eSAndy Whitcroft } 2307de7d4f0eSAndy Whitcroft 23086ecd9674SAndy Whitcroft# Check for absolute kernel paths. 23096ecd9674SAndy Whitcroft if ($tree) { 23106ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 23116ecd9674SAndy Whitcroft my $file = $1; 23126ecd9674SAndy Whitcroft 23136ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 23146ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 23156ecd9674SAndy Whitcroft # 23166ecd9674SAndy Whitcroft } else { 23176ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 23186ecd9674SAndy Whitcroft } 23196ecd9674SAndy Whitcroft } 23206ecd9674SAndy Whitcroft } 23216ecd9674SAndy Whitcroft 2322de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2323de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2324171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2325171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2326171ae1a4SAndy Whitcroft 2327171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2328171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2329171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2330171ae1a4SAndy Whitcroft 233134d99219SJoe Perches CHK("INVALID_UTF8", 2332000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 233300df344fSAndy Whitcroft } 23340a920b5bSAndy Whitcroft 233515662b3eSJoe Perches# Check if it's the start of a commit log 233615662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 233715662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 233829ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 233929ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 234015662b3eSJoe Perches $in_header_lines = 0; 234115662b3eSJoe Perches $in_commit_log = 1; 234215662b3eSJoe Perches } 234315662b3eSJoe Perches 2344fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2345fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2346fa64205dSPasi Savanainen if ($in_header_lines && 2347fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2348fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2349fa64205dSPasi Savanainen $non_utf8_charset = 1; 2350fa64205dSPasi Savanainen } 2351fa64205dSPasi Savanainen 2352fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 235315662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2354fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 235515662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 235615662b3eSJoe Perches } 235715662b3eSJoe Perches 235866b47b4aSKees Cook# Check for various typo / spelling mistakes 235966d7a382SJoe Perches if (defined($misspellings) && 236066d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2361ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 236266b47b4aSKees Cook my $typo = $1; 236366b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 236466b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 236566b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 236666b47b4aSKees Cook my $msg_type = \&WARN; 236766b47b4aSKees Cook $msg_type = \&CHK if ($file); 236866b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 236966b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 237066b47b4aSKees Cook $fix) { 237166b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 237266b47b4aSKees Cook } 237366b47b4aSKees Cook } 237466b47b4aSKees Cook } 237566b47b4aSKees Cook 237630670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 237730670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 237800df344fSAndy Whitcroft 23790a920b5bSAndy Whitcroft#trailing whitespace 23809c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2381c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2382d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2383d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2384d5e616fcSJoe Perches $fix) { 2385194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2386d5e616fcSJoe Perches } 2387c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2388c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23893705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 23903705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 23913705ce5bSJoe Perches $fix) { 2392194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 23933705ce5bSJoe Perches } 23943705ce5bSJoe Perches 2395d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 23960a920b5bSAndy Whitcroft } 23975368df20SAndy Whitcroft 23984783f894SJosh Triplett# Check for FSF mailing addresses. 2399109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 24003e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 24013e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 24024783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24034783f894SJosh Triplett my $msg_type = \&ERROR; 24044783f894SJosh Triplett $msg_type = \&CHK if ($file); 24054783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 24064783f894SJosh 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) 24074783f894SJosh Triplett } 24084783f894SJosh Triplett 24093354957aSAndi Kleen# check for Kconfig help text having a real description 24109fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 24119fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 24123354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 24138d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 24143354957aSAndi Kleen my $length = 0; 24159fe287d7SAndy Whitcroft my $cnt = $realcnt; 24169fe287d7SAndy Whitcroft my $ln = $linenr + 1; 24179fe287d7SAndy Whitcroft my $f; 2418a1385803SAndy Whitcroft my $is_start = 0; 24199fe287d7SAndy Whitcroft my $is_end = 0; 2420a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 24219fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 24229fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 24239fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 24249fe287d7SAndy Whitcroft 24259fe287d7SAndy Whitcroft next if ($f =~ /^-/); 24268d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2427a1385803SAndy Whitcroft 24288d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2429a1385803SAndy Whitcroft $is_start = 1; 24308d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2431a1385803SAndy Whitcroft $length = -1; 2432a1385803SAndy Whitcroft } 2433a1385803SAndy Whitcroft 24349fe287d7SAndy Whitcroft $f =~ s/^.//; 24353354957aSAndi Kleen $f =~ s/#.*//; 24363354957aSAndi Kleen $f =~ s/^\s+//; 24373354957aSAndi Kleen next if ($f =~ /^$/); 24389fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 24399fe287d7SAndy Whitcroft $is_end = 1; 24409fe287d7SAndy Whitcroft last; 24419fe287d7SAndy Whitcroft } 24423354957aSAndi Kleen $length++; 24433354957aSAndi Kleen } 244456193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2445000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 244656193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 244756193274SVadim Bendebury } 2448a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 24493354957aSAndi Kleen } 24503354957aSAndi Kleen 24511ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 24521ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 24531ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 24541ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 24551ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 24561ba8dfd1SKees Cook } 24571ba8dfd1SKees Cook 2458327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2459327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2460327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2461327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2462327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2463327953e9SChristoph Jaeger } 2464327953e9SChristoph Jaeger 2465c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2466c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2467c68e5878SArnaud Lacombe my $flag = $1; 2468c68e5878SArnaud Lacombe my $replacement = { 2469c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2470c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2471c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2472c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2473c68e5878SArnaud Lacombe }; 2474c68e5878SArnaud Lacombe 2475c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2476c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2477c68e5878SArnaud Lacombe } 2478c68e5878SArnaud Lacombe 2479bff5da43SRob Herring# check for DT compatible documentation 24807dd05b38SFlorian Vaussard if (defined $root && 24817dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 24827dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 24837dd05b38SFlorian Vaussard 2484bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2485bff5da43SRob Herring 2486cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2487cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2488cc93319bSFlorian Vaussard 2489bff5da43SRob Herring foreach my $compat (@compats) { 2490bff5da43SRob Herring my $compat2 = $compat; 2491185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2492185d566bSRob Herring my $compat3 = $compat; 2493185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2494185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2495bff5da43SRob Herring if ( $? >> 8 ) { 2496bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2497bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2498bff5da43SRob Herring } 2499bff5da43SRob Herring 25004fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 25014fbf32a6SFlorian Vaussard my $vendor = $1; 2502cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2503bff5da43SRob Herring if ( $? >> 8 ) { 2504bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2505cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2506bff5da43SRob Herring } 2507bff5da43SRob Herring } 2508bff5da43SRob Herring } 2509bff5da43SRob Herring 25105368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2511de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 25125368df20SAndy Whitcroft 25136cd7f386SJoe Perches#line length limit 2514c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2515f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 251629a3c466SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?$String\s*(?:|,|\)\s*;)\s*$/ || 251729a3c466SJoe Perches $line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 251829a3c466SJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) && 25196cd7f386SJoe Perches $length > $max_line_length) 2520c45dcabdSAndy Whitcroft { 2521000d1cc1SJoe Perches WARN("LONG_LINE", 25226cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 25230a920b5bSAndy Whitcroft } 25240a920b5bSAndy Whitcroft 25258905a67cSAndy Whitcroft# check for adding lines without a newline. 25268905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2527000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2528000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 25298905a67cSAndy Whitcroft } 25308905a67cSAndy Whitcroft 253142e41c54SMike Frysinger# Blackfin: use hi/lo macros 253242e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 253342e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 253442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2535000d1cc1SJoe Perches ERROR("LO_MACRO", 2536000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 253742e41c54SMike Frysinger } 253842e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 253942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2540000d1cc1SJoe Perches ERROR("HI_MACRO", 2541000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 254242e41c54SMike Frysinger } 254342e41c54SMike Frysinger } 254442e41c54SMike Frysinger 2545b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2546de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 25470a920b5bSAndy Whitcroft 25480a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 25490a920b5bSAndy Whitcroft# more than 8 must use tabs. 2550c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2551c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2552c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2553d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25543705ce5bSJoe Perches if (ERROR("CODE_INDENT", 25553705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 25563705ce5bSJoe Perches $fix) { 2557194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 25583705ce5bSJoe Perches } 25590a920b5bSAndy Whitcroft } 25600a920b5bSAndy Whitcroft 256108e44365SAlberto Panizzo# check for space before tabs. 256208e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 256308e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25643705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 25653705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 25663705ce5bSJoe Perches $fix) { 2567194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2568d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2569194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2570c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 25713705ce5bSJoe Perches } 257208e44365SAlberto Panizzo } 257308e44365SAlberto Panizzo 2574d1fe9c09SJoe Perches# check for && or || at the start of a line 2575d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2576d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2577d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2578d1fe9c09SJoe Perches } 2579d1fe9c09SJoe Perches 2580d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2581d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 258291cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2583d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2584d1fe9c09SJoe Perches my $oldindent = $1; 2585d1fe9c09SJoe Perches my $rest = $2; 2586d1fe9c09SJoe Perches 2587d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2588d1fe9c09SJoe Perches if ($pos >= 0) { 2589b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2590b34a26f3SJoe Perches my $newindent = $2; 2591d1fe9c09SJoe Perches 2592d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2593d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2594d1fe9c09SJoe Perches " " x ($pos % 8); 2595d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2596d1fe9c09SJoe Perches 2597d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2598d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 25993705ce5bSJoe Perches 26003705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 26013705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 26023705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2603194f66fcSJoe Perches $fixed[$fixlinenr] =~ 26043705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 26053705ce5bSJoe Perches } 2606d1fe9c09SJoe Perches } 2607d1fe9c09SJoe Perches } 2608d1fe9c09SJoe Perches } 2609d1fe9c09SJoe Perches 26106ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 26116ab3a970SJoe Perches# avoid checking a few false positives: 26126ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 26136ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 26146ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 26156ab3a970SJoe Perches# multiline macros that define functions 26166ab3a970SJoe Perches# known attributes or the __attribute__ keyword 26176ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 26186ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 26193705ce5bSJoe Perches if (CHK("SPACING", 2620f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 26213705ce5bSJoe Perches $fix) { 2622194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2623f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 26243705ce5bSJoe Perches } 2625aad4f614SJoe Perches } 2626aad4f614SJoe Perches 262705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2628fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 262985ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 263085ad978cSJoe Perches $realline > 2) { 263105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 263205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 263305880600SJoe Perches } 263405880600SJoe Perches 263505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2636a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2637a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 263861135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2639a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2640a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2641a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2642a605e32eSJoe Perches } 2643a605e32eSJoe Perches 2644a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2645c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2646c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2647c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2648c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 264905880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 265005880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 265105880600SJoe Perches } 265205880600SJoe Perches 26537f619191SJoe Perches# check for missing blank lines after struct/union declarations 26547f619191SJoe Perches# with exceptions for various attributes and macros 26557f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 26567f619191SJoe Perches $line =~ /^\+/ && 26577f619191SJoe Perches !($line =~ /^\+\s*$/ || 26587f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 26597f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 26607f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 26617f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 26627f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 26637f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 26647f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2665d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2666d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2667d752fcc8SJoe Perches $fix) { 2668f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2669d752fcc8SJoe Perches } 26707f619191SJoe Perches } 26717f619191SJoe Perches 2672365dd4eaSJoe Perches# check for multiple consecutive blank lines 2673365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2674365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2675365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2676d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2677d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2678d752fcc8SJoe Perches $fix) { 2679f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2680d752fcc8SJoe Perches } 2681d752fcc8SJoe Perches 2682365dd4eaSJoe Perches $last_blank_line = $linenr; 2683365dd4eaSJoe Perches } 2684365dd4eaSJoe Perches 26853b617e3bSJoe Perches# check for missing blank lines after declarations 26863f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 26873f7bac03SJoe Perches # actual declarations 26883f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 26895a4e1fd3SJoe Perches # function pointer declarations 26905a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 26913f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 26923f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 26933f7bac03SJoe Perches # known declaration macros 26943f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 26953f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 26963f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 26973f7bac03SJoe Perches # other possible extensions of declaration lines 26983f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 26993f7bac03SJoe Perches # not starting a section or a macro "\" extended line 27003f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 27013f7bac03SJoe Perches # looks like a declaration 27023f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 27035a4e1fd3SJoe Perches # function pointer declarations 27045a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 27053f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 27063f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 27073f7bac03SJoe Perches # known declaration macros 27083f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 27093f7bac03SJoe Perches # start of struct or union or enum 27103b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 27113f7bac03SJoe Perches # start or end of block or continuation of declaration 27123f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 27133f7bac03SJoe Perches # bitfield continuation 27143f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 27153f7bac03SJoe Perches # other possible extensions of declaration lines 27163f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 27173f7bac03SJoe Perches # indentation of previous and current line are the same 27183f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2719d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2720d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2721d752fcc8SJoe Perches $fix) { 2722f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2723d752fcc8SJoe Perches } 27243b617e3bSJoe Perches } 27253b617e3bSJoe Perches 27265f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 27276b4c5bebSAndy Whitcroft# Exceptions: 27286b4c5bebSAndy Whitcroft# 1) within comments 27296b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 27306b4c5bebSAndy Whitcroft# 3) hanging labels 27313705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 27325f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27333705ce5bSJoe Perches if (WARN("LEADING_SPACE", 27343705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 27353705ce5bSJoe Perches $fix) { 2736194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27373705ce5bSJoe Perches } 27385f7ddae6SRaffaele Recalcati } 27395f7ddae6SRaffaele Recalcati 2740b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2741b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2742b9ea10d6SAndy Whitcroft 2743032a4c0fSJoe Perches# check indentation of any line with a bare else 2744840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2745032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2746032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2747032a4c0fSJoe Perches my $tabs = length($1) + 1; 2748840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2749840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2750840080a0SJoe Perches defined $lines[$linenr] && 2751840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2752032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2753032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2754032a4c0fSJoe Perches } 2755032a4c0fSJoe Perches } 2756032a4c0fSJoe Perches 2757c00df19aSJoe Perches# check indentation of a line with a break; 2758c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2759c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2760c00df19aSJoe Perches my $tabs = $1; 2761c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2762c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2763c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2764c00df19aSJoe Perches } 2765c00df19aSJoe Perches } 2766c00df19aSJoe Perches 27671ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 27681ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 27691ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 27701ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 27711ba8dfd1SKees Cook } 27721ba8dfd1SKees Cook 2773c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2774cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2775000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2776000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2777c2fdda0dSAndy Whitcroft } 277822f2a2efSAndy Whitcroft 277942e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 278042e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 278142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2782000d1cc1SJoe Perches ERROR("CSYNC", 2783000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 278442e41c54SMike Frysinger } 278542e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 278642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2787000d1cc1SJoe Perches ERROR("SSYNC", 2788000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 278942e41c54SMike Frysinger } 279042e41c54SMike Frysinger 279156e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 279256e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 279356e77d70SJoe Perches WARN("HOTPLUG_SECTION", 279456e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 279556e77d70SJoe Perches } 279656e77d70SJoe Perches 27979c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 27982b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 27992b474a1aSAndy Whitcroft $realline_next); 28003e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 28013e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 28021b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2803170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2804f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2805171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2806171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2807171ae1a4SAndy Whitcroft 28083e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 28093e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 28103e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 28113e469cdcSAndy Whitcroft # until we hit end of it. 28123e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 28133e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 28143e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 28153e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 28163e469cdcSAndy Whitcroft } 2817f74bd194SAndy Whitcroft 28182b474a1aSAndy Whitcroft # Find the real next line. 28192b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 28202b474a1aSAndy Whitcroft if (defined $realline_next && 28212b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 28222b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 28232b474a1aSAndy Whitcroft $realline_next++; 28242b474a1aSAndy Whitcroft } 28252b474a1aSAndy Whitcroft 2826171ae1a4SAndy Whitcroft my $s = $stat; 2827171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2828cf655043SAndy Whitcroft 2829c2fdda0dSAndy Whitcroft # Ignore goto labels. 2830171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2831c2fdda0dSAndy Whitcroft 2832c2fdda0dSAndy Whitcroft # Ignore functions being called 2833171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2834c2fdda0dSAndy Whitcroft 2835463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2836463f2864SAndy Whitcroft 2837c45dcabdSAndy Whitcroft # declarations always start with types 2838d2506586SAndy 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) { 2839c45dcabdSAndy Whitcroft my $type = $1; 2840c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2841c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2842c45dcabdSAndy Whitcroft 28436c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2844a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2845c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2846c2fdda0dSAndy Whitcroft } 28478905a67cSAndy Whitcroft 28486c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 284965863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2850c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 28519c0ca6f9SAndy Whitcroft } 28528905a67cSAndy Whitcroft 28538905a67cSAndy Whitcroft # Check for any sort of function declaration. 28548905a67cSAndy Whitcroft # int foo(something bar, other baz); 28558905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2856171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 28578905a67cSAndy Whitcroft my ($name_len) = length($1); 28588905a67cSAndy Whitcroft 2859cf655043SAndy Whitcroft my $ctx = $s; 2860773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 28618905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2862cf655043SAndy Whitcroft 28638905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2864c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 28658905a67cSAndy Whitcroft 2866c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 28678905a67cSAndy Whitcroft } 28688905a67cSAndy Whitcroft } 28698905a67cSAndy Whitcroft } 28708905a67cSAndy Whitcroft 28719c0ca6f9SAndy Whitcroft } 28729c0ca6f9SAndy Whitcroft 287300df344fSAndy Whitcroft# 287400df344fSAndy Whitcroft# Checks which may be anchored in the context. 287500df344fSAndy Whitcroft# 287600df344fSAndy Whitcroft 287700df344fSAndy Whitcroft# Check for switch () and associated case and default 287800df344fSAndy Whitcroft# statements should be at the same indent. 287900df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 288000df344fSAndy Whitcroft my $err = ''; 288100df344fSAndy Whitcroft my $sep = ''; 288200df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 288300df344fSAndy Whitcroft shift(@ctx); 288400df344fSAndy Whitcroft for my $ctx (@ctx) { 288500df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 288600df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 288700df344fSAndy Whitcroft $indent != $cindent) { 288800df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 288900df344fSAndy Whitcroft $sep = ''; 289000df344fSAndy Whitcroft } else { 289100df344fSAndy Whitcroft $sep = "[...]\n"; 289200df344fSAndy Whitcroft } 289300df344fSAndy Whitcroft } 289400df344fSAndy Whitcroft if ($err ne '') { 2895000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2896000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2897de7d4f0eSAndy Whitcroft } 2898de7d4f0eSAndy Whitcroft } 2899de7d4f0eSAndy Whitcroft 2900de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2901de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 29020fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2903773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2904773647a0SAndy Whitcroft 29059c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 29068eef05ddSJoe Perches 29078eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 29088eef05ddSJoe Perches WARN("DEEP_INDENTATION", 29098eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 29108eef05ddSJoe Perches } 29118eef05ddSJoe Perches 2912de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2913de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2914de7d4f0eSAndy Whitcroft 2915548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2916548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2917de7d4f0eSAndy Whitcroft 2918548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2919548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2920548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2921548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2922548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2923773647a0SAndy Whitcroft $ctx_ln++; 2924773647a0SAndy Whitcroft } 2925548596d5SAndy Whitcroft 292653210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 292753210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2928773647a0SAndy Whitcroft 2929773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2930000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2931000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 293201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 293300df344fSAndy Whitcroft } 2934773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2935773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2936773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2937773647a0SAndy Whitcroft { 29389c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 29399c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2940000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2941000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 294201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 29439c0ca6f9SAndy Whitcroft } 29449c0ca6f9SAndy Whitcroft } 294500df344fSAndy Whitcroft } 294600df344fSAndy Whitcroft 29474d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 29480fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 29493e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 29503e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 29513e469cdcSAndy Whitcroft if (!defined $stat); 29524d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 29534d001e4dSAndy Whitcroft 29544d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 29554d001e4dSAndy Whitcroft 29564d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 29574d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 29584d001e4dSAndy Whitcroft # where necessary. 29594d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 29604d001e4dSAndy Whitcroft 29614d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 29626f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 29636f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 29644d001e4dSAndy Whitcroft 29654d001e4dSAndy Whitcroft # We want to check the first line inside the block 29664d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 29674d001e4dSAndy Whitcroft # 1) any blank line termination 29684d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 29694d001e4dSAndy Whitcroft # 3) any do (...) { 29704d001e4dSAndy Whitcroft my $continuation = 0; 29714d001e4dSAndy Whitcroft my $check = 0; 29724d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 29734d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 29744d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 29754d001e4dSAndy Whitcroft $continuation = 1; 29764d001e4dSAndy Whitcroft } 29779bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 29784d001e4dSAndy Whitcroft $check = 1; 29794d001e4dSAndy Whitcroft $cond_lines++; 29804d001e4dSAndy Whitcroft } 29814d001e4dSAndy Whitcroft 29824d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 29834d001e4dSAndy Whitcroft # preprocessor statement. 29844d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 29854d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 29864d001e4dSAndy Whitcroft $check = 0; 29874d001e4dSAndy Whitcroft } 29884d001e4dSAndy Whitcroft 29899bd49efeSAndy Whitcroft my $cond_ptr = -1; 2990740504c6SAndy Whitcroft $continuation = 0; 29919bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 29929bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 29934d001e4dSAndy Whitcroft 2994f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2995f16fa28fSAndy Whitcroft # is not linear. 2996f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2997f16fa28fSAndy Whitcroft $check = 0; 2998f16fa28fSAndy Whitcroft } 2999f16fa28fSAndy Whitcroft 30009bd49efeSAndy Whitcroft # Ignore: 30019bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 30029bd49efeSAndy Whitcroft # 2) preprocessor lines, and 30039bd49efeSAndy Whitcroft # 3) labels. 3004740504c6SAndy Whitcroft if ($continuation || 3005740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 30069bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 30079bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3008740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 300930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 30109bd49efeSAndy Whitcroft $cond_lines++; 30119bd49efeSAndy Whitcroft } 30124d001e4dSAndy Whitcroft } 301330dad6ebSAndy Whitcroft } 30144d001e4dSAndy Whitcroft 30154d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 30164d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 30174d001e4dSAndy Whitcroft 30184d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 30194d001e4dSAndy Whitcroft # this is not this patch's fault. 30204d001e4dSAndy Whitcroft if (!defined($stat_real) || 30214d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 30224d001e4dSAndy Whitcroft $check = 0; 30234d001e4dSAndy Whitcroft } 30244d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 30254d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 30264d001e4dSAndy Whitcroft } 30274d001e4dSAndy Whitcroft 30289bd49efeSAndy 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"; 30294d001e4dSAndy Whitcroft 30304d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 30314d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 3032000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3033000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 30344d001e4dSAndy Whitcroft } 30354d001e4dSAndy Whitcroft } 30364d001e4dSAndy Whitcroft 30376c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 30386c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 30391f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 30401f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 30416c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3042c2fdda0dSAndy Whitcroft if ($dbg_values) { 3043c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3044cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3045cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 30461f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3047c2fdda0dSAndy Whitcroft } 30486c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 30496c72ffaaSAndy Whitcroft 305000df344fSAndy Whitcroft#ignore lines not being added 30513705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 305200df344fSAndy Whitcroft 3053653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 30547429c690SAndy Whitcroft if ($dbg_type) { 30557429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3056000d1cc1SJoe Perches ERROR("TEST_TYPE", 3057000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 30587429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3059000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3060000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 30617429c690SAndy Whitcroft } 3062653d4876SAndy Whitcroft next; 3063653d4876SAndy Whitcroft } 3064a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3065a1ef277eSAndy Whitcroft if ($dbg_attr) { 30669360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3067000d1cc1SJoe Perches ERROR("TEST_ATTR", 3068000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 30699360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3070000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3071000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3072a1ef277eSAndy Whitcroft } 3073a1ef277eSAndy Whitcroft next; 3074a1ef277eSAndy Whitcroft } 3075653d4876SAndy Whitcroft 3076f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 307799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 307899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3079d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3080d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3081f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3082f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3083f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3084d752fcc8SJoe Perches my $fixedline = $prevrawline; 3085d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3086f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3087d752fcc8SJoe Perches $fixedline = $line; 3088d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3089f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3090d752fcc8SJoe Perches } 3091f0a594c1SAndy Whitcroft } 3092f0a594c1SAndy Whitcroft 309300df344fSAndy Whitcroft# 309400df344fSAndy Whitcroft# Checks which are anchored on the added line. 309500df344fSAndy Whitcroft# 309600df344fSAndy Whitcroft 3097653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3098c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3099653d4876SAndy Whitcroft my $path = $1; 3100653d4876SAndy Whitcroft if ($path =~ m{//}) { 3101000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3102495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3103495e9d84SJoe Perches } 3104495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3105495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3106495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3107653d4876SAndy Whitcroft } 3108653d4876SAndy Whitcroft } 3109653d4876SAndy Whitcroft 311000df344fSAndy Whitcroft# no C99 // comments 311100df344fSAndy Whitcroft if ($line =~ m{//}) { 31123705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 31133705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 31143705ce5bSJoe Perches $fix) { 3115194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 31163705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 31173705ce5bSJoe Perches my $comment = trim($1); 3118194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 31193705ce5bSJoe Perches } 31203705ce5bSJoe Perches } 312100df344fSAndy Whitcroft } 312200df344fSAndy Whitcroft # Remove C99 comments. 31230a920b5bSAndy Whitcroft $line =~ s@//.*@@; 31246c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 31250a920b5bSAndy Whitcroft 31262b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 31272b474a1aSAndy Whitcroft# the whole statement. 31282b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 31292b474a1aSAndy Whitcroft if (defined $realline_next && 31302b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 31312b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 31322b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 31332b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 31343cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 31353cbf62dfSAndy Whitcroft # a prefix: 31363cbf62dfSAndy Whitcroft # XXX(foo); 31373cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3138653d4876SAndy Whitcroft my $name = $1; 313987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 31403cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 31413cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 31423cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 31433cbf62dfSAndy Whitcroft 31443cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 31452b474a1aSAndy Whitcroft \n.}\s*$| 314648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 314748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 314848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 31492b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 31502b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 315148012058SAndy Whitcroft )/x) { 31522b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 31532b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 31542b474a1aSAndy Whitcroft } else { 31552b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 31560a920b5bSAndy Whitcroft } 31570a920b5bSAndy Whitcroft } 31582b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 31592b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 31602b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 31612b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 31622b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 31632b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 31642b474a1aSAndy Whitcroft } 31652b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 31662b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3167000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3168000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 31692b474a1aSAndy Whitcroft } 31700a920b5bSAndy Whitcroft 31715150bda4SJoe Eloff# check for global initialisers. 3172d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 3173d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3174000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3175d5e616fcSJoe Perches $herecurr) && 3176d5e616fcSJoe Perches $fix) { 3177194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 3178d5e616fcSJoe Perches } 3179f0a594c1SAndy Whitcroft } 31800a920b5bSAndy Whitcroft# check for static initialisers. 3181d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3182d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3183000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3184d5e616fcSJoe Perches $herecurr) && 3185d5e616fcSJoe Perches $fix) { 3186194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3187d5e616fcSJoe Perches } 31880a920b5bSAndy Whitcroft } 31890a920b5bSAndy Whitcroft 31901813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 31911813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 31921813087dSJoe Perches my $tmp = trim($1); 31931813087dSJoe Perches WARN("MISORDERED_TYPE", 31941813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 31951813087dSJoe Perches } 31961813087dSJoe Perches 3197cb710ecaSJoe Perches# check for static const char * arrays. 3198cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3199000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3200000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3201cb710ecaSJoe Perches $herecurr); 3202cb710ecaSJoe Perches } 3203cb710ecaSJoe Perches 3204cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3205cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3206000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3207000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3208cb710ecaSJoe Perches $herecurr); 3209cb710ecaSJoe Perches } 3210cb710ecaSJoe Perches 3211ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3212ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3213ab7e23f3SJoe Perches my $found = $1; 3214ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3215ab7e23f3SJoe Perches WARN("CONST_CONST", 3216ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3217ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3218ab7e23f3SJoe Perches WARN("CONST_CONST", 3219ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3220ab7e23f3SJoe Perches } 3221ab7e23f3SJoe Perches } 3222ab7e23f3SJoe Perches 32239b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 32249b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 32259b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 32269b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 32279b0fa60dSJoe Perches $herecurr); 32289b0fa60dSJoe Perches } 32299b0fa60dSJoe Perches 3230b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3231b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3232b598b670SJoe Perches my $array = $1; 3233b598b670SJoe 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*\))@) { 3234b598b670SJoe Perches my $array_div = $1; 3235b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3236b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3237b598b670SJoe Perches $fix) { 3238b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3239b598b670SJoe Perches } 3240b598b670SJoe Perches } 3241b598b670SJoe Perches } 3242b598b670SJoe Perches 3243b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3244b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3245b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3246b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3247b36190c5SJoe Perches $fix) { 3248194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3249b36190c5SJoe Perches } 3250b36190c5SJoe Perches } 3251b36190c5SJoe Perches 325292e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 325392e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 325492e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 325592e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 325692e112fdSJoe Perches $fix) { 3257194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 325892e112fdSJoe Perches } 325993ed0e2dSJoe Perches } 326093ed0e2dSJoe Perches 3261653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3262653d4876SAndy Whitcroft# make sense. 3263653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 32648054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3265c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 32668ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3267021158b4SJoe Perches $line !~ /\b$typeOtherOSTypedefs\b/ && 3268653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3269000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3270000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 32710a920b5bSAndy Whitcroft } 32720a920b5bSAndy Whitcroft 32730a920b5bSAndy Whitcroft# * goes on variable not on type 327465863862SAndy Whitcroft # (char*[ const]) 3275bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3276bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 32773705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3278d8aaf121SAndy Whitcroft 327965863862SAndy Whitcroft # Should start with a space. 328065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 328165863862SAndy Whitcroft # Should not end with a space. 328265863862SAndy Whitcroft $to =~ s/\s+$//; 328365863862SAndy Whitcroft # '*'s should not have spaces between. 3284f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 328565863862SAndy Whitcroft } 3286d8aaf121SAndy Whitcroft 32873705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 328865863862SAndy Whitcroft if ($from ne $to) { 32893705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 32903705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 32913705ce5bSJoe Perches $fix) { 32923705ce5bSJoe Perches my $sub_from = $ident; 32933705ce5bSJoe Perches my $sub_to = $ident; 32943705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3295194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32963705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 32973705ce5bSJoe Perches } 329865863862SAndy Whitcroft } 3299bfcb2cc7SAndy Whitcroft } 3300bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3301bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 33023705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3303d8aaf121SAndy Whitcroft 330465863862SAndy Whitcroft # Should start with a space. 330565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 330665863862SAndy Whitcroft # Should not end with a space. 330765863862SAndy Whitcroft $to =~ s/\s+$//; 330865863862SAndy Whitcroft # '*'s should not have spaces between. 3309f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 331065863862SAndy Whitcroft } 331165863862SAndy Whitcroft # Modifiers should have spaces. 331265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 331365863862SAndy Whitcroft 33143705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3315667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 33163705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 33173705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 33183705ce5bSJoe Perches $fix) { 33193705ce5bSJoe Perches 33203705ce5bSJoe Perches my $sub_from = $match; 33213705ce5bSJoe Perches my $sub_to = $match; 33223705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3323194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33243705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 33253705ce5bSJoe Perches } 332665863862SAndy Whitcroft } 33270a920b5bSAndy Whitcroft } 33280a920b5bSAndy Whitcroft 33290a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 33300a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 33310a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 33320a920b5bSAndy Whitcroft# print "$herecurr"; 33330a920b5bSAndy Whitcroft# $clean = 0; 33340a920b5bSAndy Whitcroft# } 33350a920b5bSAndy Whitcroft 33368905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3337000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3338000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 33398905a67cSAndy Whitcroft } 33408905a67cSAndy Whitcroft 334117441227SJoe Perches# check for uses of printk_ratelimit 334217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3343000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3344000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 334517441227SJoe Perches } 334617441227SJoe Perches 334700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 334800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 334900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 335025985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 335100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3352f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 335300df344fSAndy Whitcroft my $ok = 0; 335400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 335500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 335625985edcSLucas De Marchi # we have a preceding printk if it ends 335700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 335800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 335900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 336000df344fSAndy Whitcroft $ok = 1; 336100df344fSAndy Whitcroft } 336200df344fSAndy Whitcroft last; 336300df344fSAndy Whitcroft } 336400df344fSAndy Whitcroft } 336500df344fSAndy Whitcroft if ($ok == 0) { 3366000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3367000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 33680a920b5bSAndy Whitcroft } 336900df344fSAndy Whitcroft } 33700a920b5bSAndy Whitcroft 3371243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3372243f3803SJoe Perches my $orig = $1; 3373243f3803SJoe Perches my $level = lc($orig); 3374243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 33758f26b837SJoe Perches my $level2 = $level; 33768f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3377243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3378daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3379243f3803SJoe Perches } 3380243f3803SJoe Perches 3381243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3382d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3383d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3384d5e616fcSJoe Perches $fix) { 3385194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3386d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3387d5e616fcSJoe Perches } 3388243f3803SJoe Perches } 3389243f3803SJoe Perches 3390dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3391dc139313SJoe Perches my $orig = $1; 3392dc139313SJoe Perches my $level = lc($orig); 3393dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3394dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3395dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3396dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3397dc139313SJoe Perches } 3398dc139313SJoe Perches 3399*91c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 3400*91c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 3401*91c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 3402*91c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 3403*91c9afafSAndy Lutomirski WARN("ENOSYS", 3404*91c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 3405*91c9afafSAndy Lutomirski } 3406*91c9afafSAndy Lutomirski 3407653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3408653d4876SAndy Whitcroft# or if closed on same line 34098d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3410c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 34118d182478SJoe Perches if (ERROR("OPEN_BRACE", 34128d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 34138d182478SJoe Perches $fix) { 34148d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 34158d182478SJoe Perches my $fixed_line = $rawline; 34168d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 34178d182478SJoe Perches my $line1 = $1; 34188d182478SJoe Perches my $line2 = $2; 34198d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 34208d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 34218d182478SJoe Perches if ($line2 !~ /^\s*$/) { 34228d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 34238d182478SJoe Perches } 34248d182478SJoe Perches } 34250a920b5bSAndy Whitcroft } 3426653d4876SAndy Whitcroft 34278905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 34288905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 34298905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 34308d182478SJoe Perches if (ERROR("OPEN_BRACE", 34318d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 34328d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 34338d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 34348d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 34358d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 34368d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 34378d182478SJoe Perches $fixedline = $rawline; 34388d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 34398d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 34408d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 34418d182478SJoe Perches } 34428d182478SJoe Perches } 34438905a67cSAndy Whitcroft } 34448905a67cSAndy Whitcroft 34450c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 34463705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 34473705ce5bSJoe Perches if (WARN("SPACING", 34483705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 34493705ce5bSJoe Perches $fix) { 3450194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34513705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 34523705ce5bSJoe Perches } 34530c73b4ebSAndy Whitcroft } 34540c73b4ebSAndy Whitcroft 345531070b5dSJoe Perches# Function pointer declarations 345631070b5dSJoe Perches# check spacing between type, funcptr, and args 345731070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 345891f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 345931070b5dSJoe Perches my $declare = $1; 346031070b5dSJoe Perches my $pre_pointer_space = $2; 346131070b5dSJoe Perches my $post_pointer_space = $3; 346231070b5dSJoe Perches my $funcname = $4; 346331070b5dSJoe Perches my $post_funcname_space = $5; 346431070b5dSJoe Perches my $pre_args_space = $6; 346531070b5dSJoe Perches 346691f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 346791f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 346891f72e9cSJoe Perches# don't need a space so don't warn for those. 346991f72e9cSJoe Perches my $post_declare_space = ""; 347091f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 347191f72e9cSJoe Perches $post_declare_space = $1; 347291f72e9cSJoe Perches $declare = rtrim($declare); 347391f72e9cSJoe Perches } 347491f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 347531070b5dSJoe Perches WARN("SPACING", 347631070b5dSJoe Perches "missing space after return type\n" . $herecurr); 347791f72e9cSJoe Perches $post_declare_space = " "; 347831070b5dSJoe Perches } 347931070b5dSJoe Perches 348031070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 348191f72e9cSJoe Perches# This test is not currently implemented because these declarations are 348291f72e9cSJoe Perches# equivalent to 348391f72e9cSJoe Perches# int foo(int bar, ...) 348491f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 348591f72e9cSJoe Perches# 348691f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 348791f72e9cSJoe Perches# WARN("SPACING", 348891f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 348991f72e9cSJoe Perches# } 349031070b5dSJoe Perches 349131070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 349231070b5dSJoe Perches if (defined $pre_pointer_space && 349331070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 349431070b5dSJoe Perches WARN("SPACING", 349531070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 349631070b5dSJoe Perches } 349731070b5dSJoe Perches 349831070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 349931070b5dSJoe Perches if (defined $post_pointer_space && 350031070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 350131070b5dSJoe Perches WARN("SPACING", 350231070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 350331070b5dSJoe Perches } 350431070b5dSJoe Perches 350531070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 350631070b5dSJoe Perches if (defined $post_funcname_space && 350731070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 350831070b5dSJoe Perches WARN("SPACING", 350931070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 351031070b5dSJoe Perches } 351131070b5dSJoe Perches 351231070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 351331070b5dSJoe Perches if (defined $pre_args_space && 351431070b5dSJoe Perches $pre_args_space =~ /^\s/) { 351531070b5dSJoe Perches WARN("SPACING", 351631070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 351731070b5dSJoe Perches } 351831070b5dSJoe Perches 351931070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3520194f66fcSJoe Perches $fixed[$fixlinenr] =~ 352191f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 352231070b5dSJoe Perches } 352331070b5dSJoe Perches } 352431070b5dSJoe Perches 35258d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 35268d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3527fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3528fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 35298d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 35308d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 35318d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3532fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3533daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 35343705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 35353705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 35363705ce5bSJoe Perches $fix) { 3537194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35383705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 35393705ce5bSJoe Perches } 35408d31cfceSAndy Whitcroft } 35418d31cfceSAndy Whitcroft } 35428d31cfceSAndy Whitcroft 3543f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 35446c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3545c2fdda0dSAndy Whitcroft my $name = $1; 3546773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3547773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3548c2fdda0dSAndy Whitcroft 3549c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3550773647a0SAndy Whitcroft if ($name =~ /^(?: 3551773647a0SAndy Whitcroft if|for|while|switch|return|case| 3552773647a0SAndy Whitcroft volatile|__volatile__| 3553773647a0SAndy Whitcroft __attribute__|format|__extension__| 3554773647a0SAndy Whitcroft asm|__asm__)$/x) 3555773647a0SAndy Whitcroft { 3556c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3557c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3558c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3559c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3560773647a0SAndy Whitcroft 3561773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3562c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3563c2fdda0dSAndy Whitcroft 3564c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3565c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3566773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3567c2fdda0dSAndy Whitcroft 3568c2fdda0dSAndy Whitcroft } else { 35693705ce5bSJoe Perches if (WARN("SPACING", 35703705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 35713705ce5bSJoe Perches $fix) { 3572194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35733705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 35743705ce5bSJoe Perches } 3575f0a594c1SAndy Whitcroft } 35766c72ffaaSAndy Whitcroft } 35779a4cad4eSEric Nelson 3578653d4876SAndy Whitcroft# Check operator spacing. 35790a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 35803705ce5bSJoe Perches my $fixed_line = ""; 35813705ce5bSJoe Perches my $line_fixed = 0; 35823705ce5bSJoe Perches 35839c0ca6f9SAndy Whitcroft my $ops = qr{ 35849c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 35859c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 35869c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 35871f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 358884731623SJoe Perches \?:|\?|: 35899c0ca6f9SAndy Whitcroft }x; 3590cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 35913705ce5bSJoe Perches 35923705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 35933705ce5bSJoe Perches## foreach my $el (@elements) { 35943705ce5bSJoe Perches## print("el: <$el>\n"); 35953705ce5bSJoe Perches## } 35963705ce5bSJoe Perches 35973705ce5bSJoe Perches my @fix_elements = (); 359800df344fSAndy Whitcroft my $off = 0; 35996c72ffaaSAndy Whitcroft 36003705ce5bSJoe Perches foreach my $el (@elements) { 36013705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 36023705ce5bSJoe Perches $off += length($el); 36033705ce5bSJoe Perches } 36043705ce5bSJoe Perches 36053705ce5bSJoe Perches $off = 0; 36063705ce5bSJoe Perches 36076c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3608b34c648bSJoe Perches my $last_after = -1; 36096c72ffaaSAndy Whitcroft 36100a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 36113705ce5bSJoe Perches 36123705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 36133705ce5bSJoe Perches 36143705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 36153705ce5bSJoe Perches 36164a0df2efSAndy Whitcroft $off += length($elements[$n]); 36174a0df2efSAndy Whitcroft 361825985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3619773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3620773647a0SAndy Whitcroft my $cc = ''; 3621773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3622773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3623773647a0SAndy Whitcroft } 3624773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3625773647a0SAndy Whitcroft 36264a0df2efSAndy Whitcroft my $a = ''; 36274a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 36284a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3629cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 36304a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 36314a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3632773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 36334a0df2efSAndy Whitcroft 36340a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 36354a0df2efSAndy Whitcroft 36364a0df2efSAndy Whitcroft my $c = ''; 36370a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 36384a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 36394a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3640cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 36414a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 36424a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 36438b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 36444a0df2efSAndy Whitcroft } else { 36454a0df2efSAndy Whitcroft $c = 'E'; 36460a920b5bSAndy Whitcroft } 36470a920b5bSAndy Whitcroft 36484a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 36494a0df2efSAndy Whitcroft 36504a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 36514a0df2efSAndy Whitcroft 36526c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3653de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 36540a920b5bSAndy Whitcroft 365574048ed8SAndy Whitcroft # Pull out the value of this operator. 36566c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 36570a920b5bSAndy Whitcroft 36581f65f947SAndy Whitcroft # Get the full operator variant. 36591f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 36601f65f947SAndy Whitcroft 366113214adfSAndy Whitcroft # Ignore operators passed as parameters. 366213214adfSAndy Whitcroft if ($op_type ne 'V' && 3663d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 366413214adfSAndy Whitcroft 3665cf655043SAndy Whitcroft# # Ignore comments 3666cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 366713214adfSAndy Whitcroft 3668d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 366913214adfSAndy Whitcroft } elsif ($op eq ';') { 3670cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3671cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 36723705ce5bSJoe Perches if (ERROR("SPACING", 36733705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3674b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 36753705ce5bSJoe Perches $line_fixed = 1; 36763705ce5bSJoe Perches } 3677d8aaf121SAndy Whitcroft } 3678d8aaf121SAndy Whitcroft 3679d8aaf121SAndy Whitcroft # // is a comment 3680d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 36810a920b5bSAndy Whitcroft 3682b00e4814SJoe Perches # : when part of a bitfield 3683b00e4814SJoe Perches } elsif ($opv eq ':B') { 3684b00e4814SJoe Perches # skip the bitfield test for now 3685b00e4814SJoe Perches 36861f65f947SAndy Whitcroft # No spaces for: 36871f65f947SAndy Whitcroft # -> 3688b00e4814SJoe Perches } elsif ($op eq '->') { 36894a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 36903705ce5bSJoe Perches if (ERROR("SPACING", 36913705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3692b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 36933705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 36943705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 36953705ce5bSJoe Perches } 3696b34c648bSJoe Perches $line_fixed = 1; 36973705ce5bSJoe Perches } 36980a920b5bSAndy Whitcroft } 36990a920b5bSAndy Whitcroft 37002381097bSJoe Perches # , must not have a space before and must have a space on the right. 37010a920b5bSAndy Whitcroft } elsif ($op eq ',') { 37022381097bSJoe Perches my $rtrim_before = 0; 37032381097bSJoe Perches my $space_after = 0; 37042381097bSJoe Perches if ($ctx =~ /Wx./) { 37052381097bSJoe Perches if (ERROR("SPACING", 37062381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 37072381097bSJoe Perches $line_fixed = 1; 37082381097bSJoe Perches $rtrim_before = 1; 37092381097bSJoe Perches } 37102381097bSJoe Perches } 3711cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 37123705ce5bSJoe Perches if (ERROR("SPACING", 37133705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 37143705ce5bSJoe Perches $line_fixed = 1; 3715b34c648bSJoe Perches $last_after = $n; 37162381097bSJoe Perches $space_after = 1; 37172381097bSJoe Perches } 37182381097bSJoe Perches } 37192381097bSJoe Perches if ($rtrim_before || $space_after) { 37202381097bSJoe Perches if ($rtrim_before) { 37212381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37222381097bSJoe Perches } else { 37232381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 37242381097bSJoe Perches } 37252381097bSJoe Perches if ($space_after) { 37262381097bSJoe Perches $good .= " "; 37273705ce5bSJoe Perches } 37280a920b5bSAndy Whitcroft } 37290a920b5bSAndy Whitcroft 37309c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 373174048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 37329c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 37339c0ca6f9SAndy Whitcroft 37349c0ca6f9SAndy Whitcroft # unary operators should have a space before and 37359c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 37369c0ca6f9SAndy Whitcroft # unary operator, or a cast 37379c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 373874048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 37390d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3740cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 37413705ce5bSJoe Perches if (ERROR("SPACING", 37423705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3743b34c648bSJoe Perches if ($n != $last_after + 2) { 3744b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 37453705ce5bSJoe Perches $line_fixed = 1; 37463705ce5bSJoe Perches } 37470a920b5bSAndy Whitcroft } 3748b34c648bSJoe Perches } 3749a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3750171ae1a4SAndy Whitcroft # A unary '*' may be const 3751171ae1a4SAndy Whitcroft 3752171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 37533705ce5bSJoe Perches if (ERROR("SPACING", 37543705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3755b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 37563705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37573705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 37583705ce5bSJoe Perches } 3759b34c648bSJoe Perches $line_fixed = 1; 37603705ce5bSJoe Perches } 37610a920b5bSAndy Whitcroft } 37620a920b5bSAndy Whitcroft 37630a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 37640a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3765773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 37663705ce5bSJoe Perches if (ERROR("SPACING", 37673705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3768b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 37693705ce5bSJoe Perches $line_fixed = 1; 37703705ce5bSJoe Perches } 37710a920b5bSAndy Whitcroft } 3772773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3773773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 37743705ce5bSJoe Perches if (ERROR("SPACING", 37753705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3776b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37773705ce5bSJoe Perches $line_fixed = 1; 37783705ce5bSJoe Perches } 3779653d4876SAndy Whitcroft } 3780773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 37813705ce5bSJoe Perches if (ERROR("SPACING", 37823705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3783b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 37843705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37853705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3786773647a0SAndy Whitcroft } 3787b34c648bSJoe Perches $line_fixed = 1; 37883705ce5bSJoe Perches } 37893705ce5bSJoe Perches } 37900a920b5bSAndy Whitcroft 37910a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 37929c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 37939c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 37949c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3795c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3796c2fdda0dSAndy Whitcroft $op eq '%') 37970a920b5bSAndy Whitcroft { 3798d2e025f3SJoe Perches if ($check) { 3799d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3800d2e025f3SJoe Perches if (CHK("SPACING", 3801d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3802d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3803d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3804d2e025f3SJoe Perches $line_fixed = 1; 3805d2e025f3SJoe Perches } 3806d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3807d2e025f3SJoe Perches if (CHK("SPACING", 3808d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3809d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3810d2e025f3SJoe Perches $line_fixed = 1; 3811d2e025f3SJoe Perches } 3812d2e025f3SJoe Perches } 3813d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 38143705ce5bSJoe Perches if (ERROR("SPACING", 38153705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3816b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3817b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3818b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3819b34c648bSJoe Perches } 38203705ce5bSJoe Perches $line_fixed = 1; 38213705ce5bSJoe Perches } 38220a920b5bSAndy Whitcroft } 38230a920b5bSAndy Whitcroft 38241f65f947SAndy Whitcroft # A colon needs no spaces before when it is 38251f65f947SAndy Whitcroft # terminating a case value or a label. 38261f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 38271f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 38283705ce5bSJoe Perches if (ERROR("SPACING", 38293705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3830b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38313705ce5bSJoe Perches $line_fixed = 1; 38323705ce5bSJoe Perches } 38331f65f947SAndy Whitcroft } 38341f65f947SAndy Whitcroft 38350a920b5bSAndy Whitcroft # All the others need spaces both sides. 3836cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 38371f65f947SAndy Whitcroft my $ok = 0; 38381f65f947SAndy Whitcroft 383922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 38401f65f947SAndy Whitcroft if (($op eq '<' && 38411f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 38421f65f947SAndy Whitcroft ($op eq '>' && 38431f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 38441f65f947SAndy Whitcroft { 38451f65f947SAndy Whitcroft $ok = 1; 38461f65f947SAndy Whitcroft } 38471f65f947SAndy Whitcroft 384884731623SJoe Perches # messages are ERROR, but ?: are CHK 38491f65f947SAndy Whitcroft if ($ok == 0) { 385084731623SJoe Perches my $msg_type = \&ERROR; 385184731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 385284731623SJoe Perches 385384731623SJoe Perches if (&{$msg_type}("SPACING", 38543705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3855b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3856b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3857b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3858b34c648bSJoe Perches } 38593705ce5bSJoe Perches $line_fixed = 1; 38603705ce5bSJoe Perches } 38610a920b5bSAndy Whitcroft } 386222f2a2efSAndy Whitcroft } 38634a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 38643705ce5bSJoe Perches 38653705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 38663705ce5bSJoe Perches 38673705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 38680a920b5bSAndy Whitcroft } 38693705ce5bSJoe Perches 38703705ce5bSJoe Perches if (($#elements % 2) == 0) { 38713705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 38723705ce5bSJoe Perches } 38733705ce5bSJoe Perches 3874194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3875194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 38763705ce5bSJoe Perches } 38773705ce5bSJoe Perches 38783705ce5bSJoe Perches 38790a920b5bSAndy Whitcroft } 38800a920b5bSAndy Whitcroft 3881786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3882d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3883786b6326SJoe Perches if (WARN("SPACING", 3884786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3885786b6326SJoe Perches $fix) { 3886194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3887786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3888786b6326SJoe Perches } 3889786b6326SJoe Perches } 3890786b6326SJoe Perches 3891f0a594c1SAndy Whitcroft# check for multiple assignments 3892f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3893000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3894000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3895f0a594c1SAndy Whitcroft } 3896f0a594c1SAndy Whitcroft 389722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 389822f2a2efSAndy Whitcroft## # continuation. 389922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 390022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 390122f2a2efSAndy Whitcroft## 390222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 390322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 390422f2a2efSAndy Whitcroft## my $ln = $line; 390522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 390622f2a2efSAndy Whitcroft## } 390722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3908000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3909000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 391022f2a2efSAndy Whitcroft## } 391122f2a2efSAndy Whitcroft## } 3912f0a594c1SAndy Whitcroft 39130a920b5bSAndy Whitcroft#need space before brace following if, while, etc 391422f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 391522f2a2efSAndy Whitcroft $line =~ /do{/) { 39163705ce5bSJoe Perches if (ERROR("SPACING", 39173705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 39183705ce5bSJoe Perches $fix) { 3919194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 39203705ce5bSJoe Perches } 3921de7d4f0eSAndy Whitcroft } 3922de7d4f0eSAndy Whitcroft 3923c4a62ef9SJoe Perches## # check for blank lines before declarations 3924c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3925c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3926c4a62ef9SJoe Perches## WARN("SPACING", 3927c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3928c4a62ef9SJoe Perches## } 3929c4a62ef9SJoe Perches## 3930c4a62ef9SJoe Perches 3931de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3932de7d4f0eSAndy Whitcroft# on the line 3933de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3934d5e616fcSJoe Perches if (ERROR("SPACING", 3935d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3936d5e616fcSJoe Perches $fix) { 3937194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3938d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3939d5e616fcSJoe Perches } 39400a920b5bSAndy Whitcroft } 39410a920b5bSAndy Whitcroft 394222f2a2efSAndy Whitcroft# check spacing on square brackets 394322f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 39443705ce5bSJoe Perches if (ERROR("SPACING", 39453705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 39463705ce5bSJoe Perches $fix) { 3947194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39483705ce5bSJoe Perches s/\[\s+/\[/; 39493705ce5bSJoe Perches } 395022f2a2efSAndy Whitcroft } 395122f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 39523705ce5bSJoe Perches if (ERROR("SPACING", 39533705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 39543705ce5bSJoe Perches $fix) { 3955194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39563705ce5bSJoe Perches s/\s+\]/\]/; 39573705ce5bSJoe Perches } 395822f2a2efSAndy Whitcroft } 395922f2a2efSAndy Whitcroft 3960c45dcabdSAndy Whitcroft# check spacing on parentheses 39619c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 39629c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 39633705ce5bSJoe Perches if (ERROR("SPACING", 39643705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 39653705ce5bSJoe Perches $fix) { 3966194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39673705ce5bSJoe Perches s/\(\s+/\(/; 39683705ce5bSJoe Perches } 396922f2a2efSAndy Whitcroft } 397013214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3971c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3972c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 39733705ce5bSJoe Perches if (ERROR("SPACING", 39743705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 39753705ce5bSJoe Perches $fix) { 3976194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39773705ce5bSJoe Perches s/\s+\)/\)/; 39783705ce5bSJoe Perches } 397922f2a2efSAndy Whitcroft } 398022f2a2efSAndy Whitcroft 3981e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 3982e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 3983e2826fd0SJoe Perches 3984e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 3985ea4acbb1SJoe Perches my $var = $1; 3986ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3987ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 3988ea4acbb1SJoe Perches $fix) { 3989ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 3990ea4acbb1SJoe Perches } 3991ea4acbb1SJoe Perches } 3992ea4acbb1SJoe Perches 3993ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 3994ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 3995ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 3996ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 3997ea4acbb1SJoe Perches my $var = $2; 3998ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3999ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4000ea4acbb1SJoe Perches $fix) { 4001ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4002ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4003ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4004ea4acbb1SJoe Perches } 4005e2826fd0SJoe Perches } 4006e2826fd0SJoe Perches 40070a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 40084a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 40090a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 40103705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 40113705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 40123705ce5bSJoe Perches $fix) { 4013194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40143705ce5bSJoe Perches s/^(.)\s+/$1/; 40153705ce5bSJoe Perches } 40160a920b5bSAndy Whitcroft } 40170a920b5bSAndy Whitcroft 40185b9553abSJoe Perches# return is not a function 4019507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4020c45dcabdSAndy Whitcroft my $spacing = $1; 4021507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 40225b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 40235b9553abSJoe Perches my $value = $1; 40245b9553abSJoe Perches $value = deparenthesize($value); 40255b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4026000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4027000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 40285b9553abSJoe Perches } 4029c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4030000d1cc1SJoe Perches ERROR("SPACING", 4031000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4032c45dcabdSAndy Whitcroft } 4033c45dcabdSAndy Whitcroft } 4034507e5141SJoe Perches 4035b43ae21bSJoe Perches# unnecessary return in a void function 4036b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4037b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4038b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4039b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4040b43ae21bSJoe Perches $linenr >= 3 && 4041b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4042b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 40439819cf25SJoe Perches WARN("RETURN_VOID", 4044b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 40459819cf25SJoe Perches } 40469819cf25SJoe Perches 4047189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4048189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4049189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4050189248d8SJoe Perches my $openparens = $1; 4051189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4052189248d8SJoe Perches my $msg = ""; 4053189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4054189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4055189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4056189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4057189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4058189248d8SJoe Perches } 4059189248d8SJoe Perches } 4060189248d8SJoe Perches 4061f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4062f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 406353a3c448SAndy Whitcroft my $name = $1; 406453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4065000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4066f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 406753a3c448SAndy Whitcroft } 406853a3c448SAndy Whitcroft } 4069c45dcabdSAndy Whitcroft 40700a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 40714a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 40723705ce5bSJoe Perches if (ERROR("SPACING", 40733705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 40743705ce5bSJoe Perches $fix) { 4075194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40763705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 40773705ce5bSJoe Perches } 40780a920b5bSAndy Whitcroft } 40790a920b5bSAndy Whitcroft 4080f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4081f5fe35ddSAndy Whitcroft# statements after the conditional. 4082170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 40833e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 40843e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 40853e469cdcSAndy Whitcroft if (!defined $stat); 4086170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4087170d3a22SAndy Whitcroft $remain_next, $off_next); 4088170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4089170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4090170d3a22SAndy Whitcroft 4091170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4092170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4093170d3a22SAndy Whitcroft # then count those as offsets. 4094170d3a22SAndy Whitcroft my ($whitespace) = 4095170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4096170d3a22SAndy Whitcroft my $offset = 4097170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4098170d3a22SAndy Whitcroft 4099170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4100170d3a22SAndy Whitcroft $offset} = 1; 4101170d3a22SAndy Whitcroft } 4102170d3a22SAndy Whitcroft } 4103170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4104c11230f4SJoe Perches defined($stat) && defined($cond) && 4105170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4106171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 41078905a67cSAndy Whitcroft 4108b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4109000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4110000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 41118905a67cSAndy Whitcroft } 41128905a67cSAndy Whitcroft 41138905a67cSAndy Whitcroft # Find out what is on the end of the line after the 41148905a67cSAndy Whitcroft # conditional. 4115773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 41168905a67cSAndy Whitcroft $s =~ s/\n.*//g; 411713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 411853210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 411953210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4120773647a0SAndy Whitcroft { 4121bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4122bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4123bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 412442bdf74cSHidetoshi Seto my $stat_real = ''; 4125bb44ad39SAndy Whitcroft 412642bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 412742bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4128bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4129bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4130bb44ad39SAndy Whitcroft } 4131bb44ad39SAndy Whitcroft 4132000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4133000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 41348905a67cSAndy Whitcroft } 41358905a67cSAndy Whitcroft } 41368905a67cSAndy Whitcroft 413713214adfSAndy Whitcroft# Check for bitwise tests written as boolean 413813214adfSAndy Whitcroft if ($line =~ / 413913214adfSAndy Whitcroft (?: 414013214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 414113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 414213214adfSAndy Whitcroft (?:\&\&|\|\|) 414313214adfSAndy Whitcroft | 414413214adfSAndy Whitcroft (?:\&\&|\|\|) 414513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 414613214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 414713214adfSAndy Whitcroft )/x) 414813214adfSAndy Whitcroft { 4149000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4150000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 415113214adfSAndy Whitcroft } 415213214adfSAndy Whitcroft 41538905a67cSAndy Whitcroft# if and else should not have general statements after it 415413214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 415513214adfSAndy Whitcroft my $s = $1; 415613214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 415713214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4158000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4159000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 41600a920b5bSAndy Whitcroft } 416113214adfSAndy Whitcroft } 416239667782SAndy Whitcroft# if should not continue a brace 416339667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4164000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4165048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 416639667782SAndy Whitcroft $herecurr); 416739667782SAndy Whitcroft } 4168a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4169a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4170a1080bf8SAndy Whitcroft $line !~ /\G(?: 41713fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4172a1080bf8SAndy Whitcroft \s*return\s+ 4173a1080bf8SAndy Whitcroft )/xg) 4174a1080bf8SAndy Whitcroft { 4175000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4176000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4177a1080bf8SAndy Whitcroft } 41780a920b5bSAndy Whitcroft 41790a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 41800a920b5bSAndy Whitcroft # indent level to be relevant to each other. 41818b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 41820a920b5bSAndy Whitcroft $previndent == $indent) { 41838b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 41848b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 41858b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 41868b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 41878b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 41888b8856f4SJoe Perches my $fixedline = $prevrawline; 41898b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 41908b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 41918b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41928b8856f4SJoe Perches } 41938b8856f4SJoe Perches $fixedline = $rawline; 41948b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 41958b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41968b8856f4SJoe Perches } 41970a920b5bSAndy Whitcroft } 41980a920b5bSAndy Whitcroft 41998b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4200c2fdda0dSAndy Whitcroft $previndent == $indent) { 4201c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4202c2fdda0dSAndy Whitcroft 4203c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4204c2fdda0dSAndy Whitcroft # conditional. 4205773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4206c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4207c2fdda0dSAndy Whitcroft 4208c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 42098b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 42108b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 42118b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42128b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42138b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 42148b8856f4SJoe Perches my $fixedline = $prevrawline; 42158b8856f4SJoe Perches my $trailing = $rawline; 42168b8856f4SJoe Perches $trailing =~ s/^\+//; 42178b8856f4SJoe Perches $trailing = trim($trailing); 42188b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 42198b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42208b8856f4SJoe Perches } 4221c2fdda0dSAndy Whitcroft } 4222c2fdda0dSAndy Whitcroft } 4223c2fdda0dSAndy Whitcroft 422495e2c602SJoe Perches#Specific variable tests 4225323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4226323c1260SJoe Perches my $var = $1; 422795e2c602SJoe Perches 422895e2c602SJoe Perches#gcc binary extension 422995e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4230d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4231d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4232d5e616fcSJoe Perches $fix) { 4233d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4234194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4235d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4236d5e616fcSJoe Perches } 423795e2c602SJoe Perches } 423895e2c602SJoe Perches 423995e2c602SJoe Perches#CamelCase 4240807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4241be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 424222735ce8SJoe Perches#Ignore Page<foo> variants 4243807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 424422735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4245f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4246f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4247f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 42487e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 42497e781f67SJoe Perches my $word = $1; 42507e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4251d8b07710SJoe Perches if ($check) { 4252d8b07710SJoe Perches seed_camelcase_includes(); 4253d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4254d8b07710SJoe Perches seed_camelcase_file($realfile); 4255d8b07710SJoe Perches $camelcase_file_seeded = 1; 4256d8b07710SJoe Perches } 4257d8b07710SJoe Perches } 42587e781f67SJoe Perches if (!defined $camelcase{$word}) { 42597e781f67SJoe Perches $camelcase{$word} = 1; 4260be79794bSJoe Perches CHK("CAMELCASE", 42617e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 42627e781f67SJoe Perches } 4263323c1260SJoe Perches } 4264323c1260SJoe Perches } 42653445686aSJoe Perches } 42660a920b5bSAndy Whitcroft 42670a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4268d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4269d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4270d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4271d5e616fcSJoe Perches $fix) { 4272194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4273d5e616fcSJoe Perches } 42740a920b5bSAndy Whitcroft } 42750a920b5bSAndy Whitcroft 42760e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 42770e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4278c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4279e09dec48SAndy Whitcroft my $file = "$1.h"; 4280e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4281e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4282e09dec48SAndy Whitcroft $realfile ne $checkfile && 42837840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4284c45dcabdSAndy Whitcroft { 42850e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 42860e212e0aSFabian Frederick if ($asminclude > 0) { 4287e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4288000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4289000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4290e09dec48SAndy Whitcroft } else { 4291000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4292000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4293e09dec48SAndy Whitcroft } 42940a920b5bSAndy Whitcroft } 42950a920b5bSAndy Whitcroft } 42960e212e0aSFabian Frederick } 42970a920b5bSAndy Whitcroft 4298653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4299653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4300cf655043SAndy Whitcroft# in a known good container 4301b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4302b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4303d8aaf121SAndy Whitcroft my $ln = $linenr; 4304d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4305c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4306c45dcabdSAndy Whitcroft my $ctx = ''; 430708a2843eSJoe Perches my $has_flow_statement = 0; 430808a2843eSJoe Perches my $has_arg_concat = 0; 4309c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4310f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4311f74bd194SAndy Whitcroft $ctx = $dstat; 4312c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4313a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4314c45dcabdSAndy Whitcroft 431508a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 431608a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 431708a2843eSJoe Perches 4318f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4319292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4320c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4321c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4322c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4323c45dcabdSAndy Whitcroft 4324c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4325bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4326bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4327c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4328bf30d6edSAndy Whitcroft { 4329c45dcabdSAndy Whitcroft } 4330c45dcabdSAndy Whitcroft 4331e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 4332e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 4333e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 4334e45bab8eSAndy Whitcroft { 4335e45bab8eSAndy Whitcroft } 4336e45bab8eSAndy Whitcroft 4337c45dcabdSAndy Whitcroft my $exceptions = qr{ 4338c45dcabdSAndy Whitcroft $Declare| 4339c45dcabdSAndy Whitcroft module_param_named| 4340a0a0a7a9SKees Cook MODULE_PARM_DESC| 4341c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4342c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4343383099fdSAndy Whitcroft __typeof__\(| 434422fd2d3eSStefani Seibold union| 434522fd2d3eSStefani Seibold struct| 4346ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4347ea71a0a0SAndy Whitcroft ^\"|\"$ 4348c45dcabdSAndy Whitcroft }x; 43495eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4350f74bd194SAndy Whitcroft if ($dstat ne '' && 4351f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4352f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 43533cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4354356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4355f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4356f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4357e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 435872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4359f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4360f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4361f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4362f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4363f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4364c45dcabdSAndy Whitcroft { 4365f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4366f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4367f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4368f74bd194SAndy Whitcroft 4369f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4370f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4371c45dcabdSAndy Whitcroft } 4372c45dcabdSAndy Whitcroft 4373f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4374f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4375f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4376f74bd194SAndy Whitcroft } else { 4377000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4378388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4379d8aaf121SAndy Whitcroft } 43800a920b5bSAndy Whitcroft } 43815023d347SJoe Perches 438208a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 438308a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 438408a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 438508a2843eSJoe Perches my $herectx = $here . "\n"; 438608a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 438708a2843eSJoe Perches 438808a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 438908a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 439008a2843eSJoe Perches } 439108a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 439208a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 439308a2843eSJoe Perches } 439408a2843eSJoe Perches 4395481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 43965023d347SJoe Perches 43975023d347SJoe Perches } else { 43985023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4399481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4400481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 44015023d347SJoe Perches $line =~ /^\+.*\\$/) { 44025023d347SJoe Perches WARN("LINE_CONTINUATIONS", 44035023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 44045023d347SJoe Perches } 4405653d4876SAndy Whitcroft } 44060a920b5bSAndy Whitcroft 4407b13edf7fSJoe Perches# do {} while (0) macro tests: 4408b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4409b13edf7fSJoe Perches# macro should not end with a semicolon 4410b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4411b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4412b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4413b13edf7fSJoe Perches my $ln = $linenr; 4414b13edf7fSJoe Perches my $cnt = $realcnt; 4415b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4416b13edf7fSJoe Perches my $ctx = ''; 4417b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4418b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4419b13edf7fSJoe Perches $ctx = $dstat; 4420b13edf7fSJoe Perches 4421b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 44221b36b201SJoe Perches $dstat =~ s/$;/ /g; 4423b13edf7fSJoe Perches 4424b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4425b13edf7fSJoe Perches my $stmts = $2; 4426b13edf7fSJoe Perches my $semis = $3; 4427b13edf7fSJoe Perches 4428b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4429b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4430b13edf7fSJoe Perches my $herectx = $here . "\n"; 4431b13edf7fSJoe Perches 4432b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4433b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4434b13edf7fSJoe Perches } 4435b13edf7fSJoe Perches 4436ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4437ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4438b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4439b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4440b13edf7fSJoe Perches } 4441b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4442b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4443b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4444b13edf7fSJoe Perches } 4445f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4446f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4447f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4448f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4449f5ef95b1SJoe Perches 4450f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4451f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4452f5ef95b1SJoe Perches } 4453f5ef95b1SJoe Perches 4454f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4455f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4456b13edf7fSJoe Perches } 4457b13edf7fSJoe Perches } 4458b13edf7fSJoe Perches 4459080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4460080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4461080ba929SMike Frysinger# . 4462080ba929SMike Frysinger# ALIGN(...) 4463080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4464080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4465000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4466000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4467080ba929SMike Frysinger } 4468080ba929SMike Frysinger 4469f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 447013214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 447113214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4472cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 447313214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4474cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4475cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4476aad4f614SJoe Perches my @allowed = (); 4477aad4f614SJoe Perches my $allow = 0; 447813214adfSAndy Whitcroft my $seen = 0; 4479773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4480cf655043SAndy Whitcroft my $ln = $linenr - 1; 448113214adfSAndy Whitcroft for my $chunk (@chunks) { 448213214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 448313214adfSAndy Whitcroft 4484773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4485773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4486773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4487773647a0SAndy Whitcroft 4488aad4f614SJoe Perches $allowed[$allow] = 0; 4489773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4490773647a0SAndy Whitcroft 4491773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4492773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4493773647a0SAndy Whitcroft 4494773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4495cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4496cf655043SAndy Whitcroft 4497773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 449813214adfSAndy Whitcroft 449913214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 450013214adfSAndy Whitcroft 4501aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4502cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4503cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4504aad4f614SJoe Perches $allowed[$allow] = 1; 450513214adfSAndy Whitcroft } 450613214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4507cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4508aad4f614SJoe Perches $allowed[$allow] = 1; 450913214adfSAndy Whitcroft } 4510cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4511cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4512aad4f614SJoe Perches $allowed[$allow] = 1; 451313214adfSAndy Whitcroft } 4514aad4f614SJoe Perches $allow++; 451513214adfSAndy Whitcroft } 4516aad4f614SJoe Perches if ($seen) { 4517aad4f614SJoe Perches my $sum_allowed = 0; 4518aad4f614SJoe Perches foreach (@allowed) { 4519aad4f614SJoe Perches $sum_allowed += $_; 4520aad4f614SJoe Perches } 4521aad4f614SJoe Perches if ($sum_allowed == 0) { 4522000d1cc1SJoe Perches WARN("BRACES", 4523000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4524aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4525aad4f614SJoe Perches $seen != $allow) { 4526aad4f614SJoe Perches CHK("BRACES", 4527aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4528aad4f614SJoe Perches } 452913214adfSAndy Whitcroft } 453013214adfSAndy Whitcroft } 453113214adfSAndy Whitcroft } 4532773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 453313214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4534cf655043SAndy Whitcroft my $allowed = 0; 4535f0a594c1SAndy Whitcroft 4536cf655043SAndy Whitcroft # Check the pre-context. 4537cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4538cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4539cf655043SAndy Whitcroft $allowed = 1; 4540f0a594c1SAndy Whitcroft } 4541773647a0SAndy Whitcroft 4542773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4543773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4544773647a0SAndy Whitcroft 4545cf655043SAndy Whitcroft # Check the condition. 4546cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4547773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4548cf655043SAndy Whitcroft if (defined $cond) { 4549773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4550cf655043SAndy Whitcroft } 4551cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4552cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4553cf655043SAndy Whitcroft $allowed = 1; 4554cf655043SAndy Whitcroft } 4555cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4556cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4557cf655043SAndy Whitcroft $allowed = 1; 4558cf655043SAndy Whitcroft } 4559cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4560cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4561cf655043SAndy Whitcroft $allowed = 1; 4562cf655043SAndy Whitcroft } 4563cf655043SAndy Whitcroft # Check the post-context. 4564cf655043SAndy Whitcroft if (defined $chunks[1]) { 4565cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4566cf655043SAndy Whitcroft if (defined $cond) { 4567773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4568cf655043SAndy Whitcroft } 4569cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4570cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4571cf655043SAndy Whitcroft $allowed = 1; 4572cf655043SAndy Whitcroft } 4573cf655043SAndy Whitcroft } 4574cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 457569932487SJustin P. Mattock my $herectx = $here . "\n"; 4576f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4577cf655043SAndy Whitcroft 4578f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 457969932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4580cf655043SAndy Whitcroft } 4581cf655043SAndy Whitcroft 4582000d1cc1SJoe Perches WARN("BRACES", 4583000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4584f0a594c1SAndy Whitcroft } 4585f0a594c1SAndy Whitcroft } 4586f0a594c1SAndy Whitcroft 45870979ae66SJoe Perches# check for unnecessary blank lines around braces 458877b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4589f8e58219SJoe Perches if (CHK("BRACES", 4590f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4591f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4592f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4593f8e58219SJoe Perches } 45940979ae66SJoe Perches } 459577b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4596f8e58219SJoe Perches if (CHK("BRACES", 4597f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4598f8e58219SJoe Perches $fix) { 4599f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4600f8e58219SJoe Perches } 46010979ae66SJoe Perches } 46020979ae66SJoe Perches 46034a0df2efSAndy Whitcroft# no volatiles please 46046c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 46056c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4606000d1cc1SJoe Perches WARN("VOLATILE", 4607000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 46084a0df2efSAndy Whitcroft } 46094a0df2efSAndy Whitcroft 46105e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 46115e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 46125e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 46135e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 46145e4f6ba5SJoe Perches if ($line =~ /^\+\s*"[X\t]*"/ && 46155e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 46165e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 46175e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 46185e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 46195e4f6ba5SJoe Perches $fix && 46205e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 46215e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 46225e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 46235e4f6ba5SJoe Perches my $comma_close = ""; 46245e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 46255e4f6ba5SJoe Perches $comma_close = $1; 46265e4f6ba5SJoe Perches } 46275e4f6ba5SJoe Perches 46285e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 46295e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 46305e4f6ba5SJoe Perches my $fixedline = $prevrawline; 46315e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 46325e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 46335e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 46345e4f6ba5SJoe Perches $fixedline = $rawline; 46355e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 46365e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 46375e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 46385e4f6ba5SJoe Perches } 46395e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 46405e4f6ba5SJoe Perches } 46415e4f6ba5SJoe Perches } 46425e4f6ba5SJoe Perches 46435e4f6ba5SJoe Perches# check for missing a space in a string concatenation 46445e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 46455e4f6ba5SJoe Perches WARN('MISSING_SPACE', 46465e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 46475e4f6ba5SJoe Perches } 46485e4f6ba5SJoe Perches 46495e4f6ba5SJoe Perches# check for spaces before a quoted newline 46505e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 46515e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 46525e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 46535e4f6ba5SJoe Perches $fix) { 46545e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 46555e4f6ba5SJoe Perches } 46565e4f6ba5SJoe Perches 46575e4f6ba5SJoe Perches } 46585e4f6ba5SJoe Perches 4659f17dba4fSJoe Perches# concatenated string without spaces between elements 4660f17dba4fSJoe Perches if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) { 4661f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4662f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4663f17dba4fSJoe Perches } 4664f17dba4fSJoe Perches 466590ad30e5SJoe Perches# uncoalesced string fragments 466690ad30e5SJoe Perches if ($line =~ /"X*"\s*"/) { 466790ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 466890ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 466990ad30e5SJoe Perches } 467090ad30e5SJoe Perches 46715e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 46725e4f6ba5SJoe Perches my $string; 46735e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 46745e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 46755e4f6ba5SJoe Perches $string =~ s/%%/__/g; 46765e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 46775e4f6ba5SJoe Perches WARN("PRINTF_L", 46785e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 46795e4f6ba5SJoe Perches last; 46805e4f6ba5SJoe Perches } 46815e4f6ba5SJoe Perches } 46825e4f6ba5SJoe Perches 46835e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 46845e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 46855e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 46865e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 46875e4f6ba5SJoe Perches } 46885e4f6ba5SJoe Perches 468900df344fSAndy Whitcroft# warn about #if 0 4690c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4691000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4692000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4693de7d4f0eSAndy Whitcroft $herecurr); 46944a0df2efSAndy Whitcroft } 46954a0df2efSAndy Whitcroft 469603df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 469703df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 469803df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 469903df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 470003df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 470115160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 47024c432a8fSGreg Kroah-Hartman } 47034c432a8fSGreg Kroah-Hartman } 4704f0a594c1SAndy Whitcroft 4705ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4706ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4707ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4708ebfdc409SJoe Perches (defined $1 || defined $3) && 4709ebfdc409SJoe Perches $linenr > 3) { 4710ebfdc409SJoe Perches my $testval = $2; 4711ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4712ebfdc409SJoe Perches 4713ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4714ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4715ebfdc409SJoe Perches 4716ebfdc409SJoe 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)/) { 4717ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4718ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4719ebfdc409SJoe Perches } 4720ebfdc409SJoe Perches } 4721ebfdc409SJoe Perches 4722f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4723dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4724f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4725f78d98f6SJoe Perches my $level = $1; 4726f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4727f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4728f78d98f6SJoe Perches $fix) { 4729f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4730f78d98f6SJoe Perches } 4731f78d98f6SJoe Perches } 4732f78d98f6SJoe Perches 4733abb08a53SJoe Perches# check for mask then right shift without a parentheses 4734abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4735abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4736abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4737abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4738abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4739abb08a53SJoe Perches } 4740abb08a53SJoe Perches 4741b75ac618SJoe Perches# check for pointer comparisons to NULL 4742b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4743b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4744b75ac618SJoe Perches my $val = $1; 4745b75ac618SJoe Perches my $equal = "!"; 4746b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4747b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4748b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4749b75ac618SJoe Perches $fix) { 4750b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4751b75ac618SJoe Perches } 4752b75ac618SJoe Perches } 4753b75ac618SJoe Perches } 4754b75ac618SJoe Perches 47558716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 47568716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 47578716de38SJoe Perches my $attr = $1; 47588716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 47598716de38SJoe Perches my $ptr = $1; 47608716de38SJoe Perches my $var = $2; 47618716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 47628716de38SJoe Perches ERROR("MISPLACED_INIT", 47638716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 47648716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 47658716de38SJoe Perches WARN("MISPLACED_INIT", 47668716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 47678716de38SJoe Perches $fix) { 4768194f66fcSJoe 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; 47698716de38SJoe Perches } 47708716de38SJoe Perches } 47718716de38SJoe Perches } 47728716de38SJoe Perches 4773e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4774e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4775e970b884SJoe Perches my $attr = $1; 4776e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4777e970b884SJoe Perches my $attr_prefix = $1; 4778e970b884SJoe Perches my $attr_type = $2; 4779e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4780e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4781e970b884SJoe Perches $fix) { 4782194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4783e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4784e970b884SJoe Perches } 4785e970b884SJoe Perches } 4786e970b884SJoe Perches 4787e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4788e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4789e970b884SJoe Perches my $attr = $1; 4790e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4791e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4792e970b884SJoe Perches $fix) { 4793194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4794e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4795e970b884SJoe Perches $lead = rtrim($1); 4796e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4797e970b884SJoe Perches $lead = "${lead}const "; 4798194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4799e970b884SJoe Perches } 4800e970b884SJoe Perches } 4801e970b884SJoe Perches 4802c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 4803c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 4804c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 4805c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 4806c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 4807c17893c7SJoe Perches $fix) { 4808c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 4809c17893c7SJoe Perches } 4810c17893c7SJoe Perches } 4811c17893c7SJoe Perches 4812fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4813fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4814fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4815fbdb8138SJoe Perches my $constant_func = $1; 4816fbdb8138SJoe Perches my $func = $constant_func; 4817fbdb8138SJoe Perches $func =~ s/^__constant_//; 4818fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4819fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4820fbdb8138SJoe Perches $fix) { 4821194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4822fbdb8138SJoe Perches } 4823fbdb8138SJoe Perches } 4824fbdb8138SJoe Perches 48251a15a250SPatrick Pannuto# prefer usleep_range over udelay 482637581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 482743c1d77cSJoe Perches my $delay = $1; 48281a15a250SPatrick Pannuto # ignore udelay's < 10, however 482943c1d77cSJoe Perches if (! ($delay < 10) ) { 4830000d1cc1SJoe Perches CHK("USLEEP_RANGE", 483143c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 483243c1d77cSJoe Perches } 483343c1d77cSJoe Perches if ($delay > 2000) { 483443c1d77cSJoe Perches WARN("LONG_UDELAY", 483543c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 48361a15a250SPatrick Pannuto } 48371a15a250SPatrick Pannuto } 48381a15a250SPatrick Pannuto 483909ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 484009ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 484109ef8725SPatrick Pannuto if ($1 < 20) { 4842000d1cc1SJoe Perches WARN("MSLEEP", 484343c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 484409ef8725SPatrick Pannuto } 484509ef8725SPatrick Pannuto } 484609ef8725SPatrick Pannuto 484736ec1939SJoe Perches# check for comparisons of jiffies 484836ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 484936ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 485036ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 485136ec1939SJoe Perches } 485236ec1939SJoe Perches 48539d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 48549d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 48559d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 48569d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 48579d7a34a5SJoe Perches } 48589d7a34a5SJoe Perches 485900df344fSAndy Whitcroft# warn about #ifdefs in C files 4860c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 486100df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 486200df344fSAndy Whitcroft# print "$herecurr"; 486300df344fSAndy Whitcroft# $clean = 0; 486400df344fSAndy Whitcroft# } 486500df344fSAndy Whitcroft 486622f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4867c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 48683705ce5bSJoe Perches if (ERROR("SPACING", 48693705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 48703705ce5bSJoe Perches $fix) { 4871194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48723705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 48733705ce5bSJoe Perches } 48743705ce5bSJoe Perches 487522f2a2efSAndy Whitcroft } 487622f2a2efSAndy Whitcroft 48774a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4878171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4879171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 48804a0df2efSAndy Whitcroft my $which = $1; 48814a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4882000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4883000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 48844a0df2efSAndy Whitcroft } 48854a0df2efSAndy Whitcroft } 48864a0df2efSAndy Whitcroft# check for memory barriers without a comment. 48874a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 48884a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4889c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4890000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 48914a0df2efSAndy Whitcroft } 48924a0df2efSAndy Whitcroft } 48934a0df2efSAndy Whitcroft# check of hardware specific defines 4894c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4895000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4896000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 48970a920b5bSAndy Whitcroft } 4898653d4876SAndy Whitcroft 4899d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4900d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4901000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4902000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4903d4977c78STobias Klauser } 4904d4977c78STobias Klauser 4905de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4906de7d4f0eSAndy Whitcroft# storage class and type. 49079c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 49089c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4909000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4910000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4911de7d4f0eSAndy Whitcroft } 4912de7d4f0eSAndy Whitcroft 49138905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 49142b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49152b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4916d5e616fcSJoe Perches if (WARN("INLINE", 4917d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4918d5e616fcSJoe Perches $fix) { 4919194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 4920d5e616fcSJoe Perches 4921d5e616fcSJoe Perches } 49228905a67cSAndy Whitcroft } 49238905a67cSAndy Whitcroft 49243d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 49252b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49262b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4927000d1cc1SJoe Perches WARN("PREFER_PACKED", 4928000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 49293d130fd0SJoe Perches } 49303d130fd0SJoe Perches 493139b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 49322b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49332b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4934000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4935000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 493639b7e287SJoe Perches } 493739b7e287SJoe Perches 49385f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 49392b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49402b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4941d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4942d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4943d5e616fcSJoe Perches $fix) { 4944194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4945d5e616fcSJoe Perches 4946d5e616fcSJoe Perches } 49475f14d3bdSJoe Perches } 49485f14d3bdSJoe Perches 49496061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 49502b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 49512b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4952d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4953d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4954d5e616fcSJoe Perches $fix) { 4955194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4956d5e616fcSJoe Perches } 49576061d949SJoe Perches } 49586061d949SJoe Perches 4959619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 4960619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 4961619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 4962619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 4963619a908aSJoe Perches $line =~ /\b__weak\b/)) { 4964619a908aSJoe Perches ERROR("WEAK_DECLARATION", 4965619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 4966619a908aSJoe Perches } 4967619a908aSJoe Perches 49688f53a9b8SJoe Perches# check for sizeof(&) 49698f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4970000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4971000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 49728f53a9b8SJoe Perches } 49738f53a9b8SJoe Perches 497466c80b60SJoe Perches# check for sizeof without parenthesis 497566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4976d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4977d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4978d5e616fcSJoe Perches $fix) { 4979194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4980d5e616fcSJoe Perches } 498166c80b60SJoe Perches } 498266c80b60SJoe Perches 498388982feaSJoe Perches# check for struct spinlock declarations 498488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 498588982feaSJoe Perches WARN("USE_SPINLOCK_T", 498688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 498788982feaSJoe Perches } 498888982feaSJoe Perches 4989a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 499006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4991a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 4992caac1d5fSHeba Aamer $fmt =~ s/%%//g; 4993caac1d5fSHeba Aamer if ($fmt !~ /%/) { 4994d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4995d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4996d5e616fcSJoe Perches $fix) { 4997194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 4998d5e616fcSJoe Perches } 4999a6962d72SJoe Perches } 5000a6962d72SJoe Perches } 5001a6962d72SJoe Perches 5002554e165cSAndy Whitcroft# Check for misused memsets 5003d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5004d1fe9c09SJoe Perches defined $stat && 5005d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 5006554e165cSAndy Whitcroft 5007d7c76ba7SJoe Perches my $ms_addr = $2; 5008d1fe9c09SJoe Perches my $ms_val = $7; 5009d1fe9c09SJoe Perches my $ms_size = $12; 5010d7c76ba7SJoe Perches 5011554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5012554e165cSAndy Whitcroft ERROR("MEMSET", 5013d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5014554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5015554e165cSAndy Whitcroft WARN("MEMSET", 5016d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5017d7c76ba7SJoe Perches } 5018d7c76ba7SJoe Perches } 5019d7c76ba7SJoe Perches 502098a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 502198a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 502298a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 502398a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 502498a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 502598a9bba5SJoe Perches $fix) { 5026194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 502798a9bba5SJoe Perches } 502898a9bba5SJoe Perches } 502998a9bba5SJoe Perches 5030d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5031d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5032d1fe9c09SJoe Perches defined $stat && 5033d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5034d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5035d7c76ba7SJoe Perches my $call = $1; 5036d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5037d7c76ba7SJoe Perches my $arg1 = $3; 5038d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5039d1fe9c09SJoe Perches my $arg2 = $8; 5040d7c76ba7SJoe Perches my $cast; 5041d7c76ba7SJoe Perches 5042d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5043d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5044d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5045d7c76ba7SJoe Perches $cast = $cast1; 5046d7c76ba7SJoe Perches } else { 5047d7c76ba7SJoe Perches $cast = $cast2; 5048d7c76ba7SJoe Perches } 5049d7c76ba7SJoe Perches WARN("MINMAX", 5050d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5051554e165cSAndy Whitcroft } 5052554e165cSAndy Whitcroft } 5053554e165cSAndy Whitcroft 50544a273195SJoe Perches# check usleep_range arguments 50554a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 50564a273195SJoe Perches defined $stat && 50574a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 50584a273195SJoe Perches my $min = $1; 50594a273195SJoe Perches my $max = $7; 50604a273195SJoe Perches if ($min eq $max) { 50614a273195SJoe Perches WARN("USLEEP_RANGE", 50624a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 50634a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 50644a273195SJoe Perches $min > $max) { 50654a273195SJoe Perches WARN("USLEEP_RANGE", 50664a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 50674a273195SJoe Perches } 50684a273195SJoe Perches } 50694a273195SJoe Perches 5070823b794cSJoe Perches# check for naked sscanf 5071823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5072823b794cSJoe Perches defined $stat && 50736c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5074823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5075823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5076823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5077823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5078823b794cSJoe Perches $lc = $lc + $linenr; 5079823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5080823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5081823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5082823b794cSJoe Perches } 5083823b794cSJoe Perches WARN("NAKED_SSCANF", 5084823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5085823b794cSJoe Perches } 5086823b794cSJoe Perches 5087afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5088afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5089afc819abSJoe Perches defined $stat && 5090afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5091afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5092afc819abSJoe Perches $lc = $lc + $linenr; 5093afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5094afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5095afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5096afc819abSJoe Perches } 5097afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5098afc819abSJoe Perches my $format = $6; 5099afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5100afc819abSJoe Perches if ($count == 1 && 5101afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5102afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5103afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5104afc819abSJoe Perches } 5105afc819abSJoe Perches } 5106afc819abSJoe Perches } 5107afc819abSJoe Perches 510870dc8a48SJoe Perches# check for new externs in .h files. 510970dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 511070dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5111d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 511270dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 511370dc8a48SJoe Perches $fix) { 5114194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 511570dc8a48SJoe Perches } 511670dc8a48SJoe Perches } 511770dc8a48SJoe Perches 5118de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5119171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5120c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5121171ae1a4SAndy Whitcroft { 5122c45dcabdSAndy Whitcroft my $function_name = $1; 5123c45dcabdSAndy Whitcroft my $paren_space = $2; 5124171ae1a4SAndy Whitcroft 5125171ae1a4SAndy Whitcroft my $s = $stat; 5126171ae1a4SAndy Whitcroft if (defined $cond) { 5127171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5128171ae1a4SAndy Whitcroft } 5129c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5130c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5131c45dcabdSAndy Whitcroft { 5132000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5133000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5134de7d4f0eSAndy Whitcroft } 5135de7d4f0eSAndy Whitcroft 5136171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5137000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5138000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5139171ae1a4SAndy Whitcroft } 51409c9ba34eSAndy Whitcroft 51419c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 51429c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 51439c9ba34eSAndy Whitcroft { 5144000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5145000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5146171ae1a4SAndy Whitcroft } 5147171ae1a4SAndy Whitcroft 5148de7d4f0eSAndy Whitcroft# checks for new __setup's 5149de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5150de7d4f0eSAndy Whitcroft my $name = $1; 5151de7d4f0eSAndy Whitcroft 5152de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5153000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5154000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5155de7d4f0eSAndy Whitcroft } 5156653d4876SAndy Whitcroft } 51579c0ca6f9SAndy Whitcroft 51589c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5159caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5160000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5161000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 51629c0ca6f9SAndy Whitcroft } 516313214adfSAndy Whitcroft 5164a640d25cSJoe Perches# alloc style 5165a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5166a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5167a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5168a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5169a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5170a640d25cSJoe Perches } 5171a640d25cSJoe Perches 517260a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 517360a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5174e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 517560a55369SJoe Perches my $oldfunc = $3; 517660a55369SJoe Perches my $a1 = $4; 517760a55369SJoe Perches my $a2 = $10; 517860a55369SJoe Perches my $newfunc = "kmalloc_array"; 517960a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 518060a55369SJoe Perches my $r1 = $a1; 518160a55369SJoe Perches my $r2 = $a2; 518260a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 518360a55369SJoe Perches $r1 = $a2; 518460a55369SJoe Perches $r2 = $a1; 518560a55369SJoe Perches } 5186e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5187e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5188e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5189e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5190e367455aSJoe Perches $fix) { 5191194f66fcSJoe 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; 519260a55369SJoe Perches 519360a55369SJoe Perches } 519460a55369SJoe Perches } 519560a55369SJoe Perches } 519660a55369SJoe Perches 5197972fdea2SJoe Perches# check for krealloc arg reuse 5198972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5199972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5200972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5201972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5202972fdea2SJoe Perches } 5203972fdea2SJoe Perches 52045ce59ae0SJoe Perches# check for alloc argument mismatch 52055ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 52065ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 52075ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 52085ce59ae0SJoe Perches } 52095ce59ae0SJoe Perches 5210caf2a54fSJoe Perches# check for multiple semicolons 5211caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5212d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5213d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5214d5e616fcSJoe Perches $fix) { 5215194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5216d5e616fcSJoe Perches } 5217d1e2ad07SJoe Perches } 5218d1e2ad07SJoe Perches 52190ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 52200ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 52210ab90191SJoe Perches my $ull = ""; 52220ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 52230ab90191SJoe Perches if (CHK("BIT_MACRO", 52240ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 52250ab90191SJoe Perches $fix) { 52260ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 52270ab90191SJoe Perches } 52280ab90191SJoe Perches } 52290ab90191SJoe Perches 5230e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5231c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5232c34c09a8SJoe Perches my $has_break = 0; 5233c34c09a8SJoe Perches my $has_statement = 0; 5234c34c09a8SJoe Perches my $count = 0; 5235c34c09a8SJoe Perches my $prevline = $linenr; 5236e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5237c34c09a8SJoe Perches $prevline--; 5238c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5239c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5240c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5241c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5242c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5243c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5244c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5245c34c09a8SJoe Perches $has_statement = 1; 5246c34c09a8SJoe Perches $count++; 5247c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5248c34c09a8SJoe Perches } 5249c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5250c34c09a8SJoe Perches WARN("MISSING_BREAK", 5251c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5252c34c09a8SJoe Perches } 5253c34c09a8SJoe Perches } 5254c34c09a8SJoe Perches 5255d1e2ad07SJoe Perches# check for switch/default statements without a break; 5256d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5257d1e2ad07SJoe Perches defined $stat && 5258d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5259d1e2ad07SJoe Perches my $ctx = ''; 5260d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5261d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5262d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5263d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5264d1e2ad07SJoe Perches } 5265d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5266d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5267caf2a54fSJoe Perches } 5268caf2a54fSJoe Perches 526913214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5270d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5271d5e616fcSJoe Perches if (WARN("USE_FUNC", 5272d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5273d5e616fcSJoe Perches $fix) { 5274194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5275d5e616fcSJoe Perches } 527613214adfSAndy Whitcroft } 5277773647a0SAndy Whitcroft 527862ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 527962ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 528062ec818fSJoe Perches ERROR("DATE_TIME", 528162ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 528262ec818fSJoe Perches } 528362ec818fSJoe Perches 52842c92488aSJoe Perches# check for use of yield() 52852c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 52862c92488aSJoe Perches WARN("YIELD", 52872c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 52882c92488aSJoe Perches } 52892c92488aSJoe Perches 5290179f8f40SJoe Perches# check for comparisons against true and false 5291179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5292179f8f40SJoe Perches my $lead = $1; 5293179f8f40SJoe Perches my $arg = $2; 5294179f8f40SJoe Perches my $test = $3; 5295179f8f40SJoe Perches my $otype = $4; 5296179f8f40SJoe Perches my $trail = $5; 5297179f8f40SJoe Perches my $op = "!"; 5298179f8f40SJoe Perches 5299179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5300179f8f40SJoe Perches 5301179f8f40SJoe Perches my $type = lc($otype); 5302179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5303179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5304179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5305179f8f40SJoe Perches $op = ""; 5306179f8f40SJoe Perches } 5307179f8f40SJoe Perches 5308179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5309179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5310179f8f40SJoe Perches 5311179f8f40SJoe Perches## maybe suggesting a correct construct would better 5312179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5313179f8f40SJoe Perches 5314179f8f40SJoe Perches } 5315179f8f40SJoe Perches } 5316179f8f40SJoe Perches 53174882720bSThomas Gleixner# check for semaphores initialized locked 53184882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5319000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5320000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5321773647a0SAndy Whitcroft } 53226712d858SJoe Perches 532367d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 532467d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5325000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 532667d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5327773647a0SAndy Whitcroft } 53286712d858SJoe Perches 5329ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5330f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5331000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5332ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5333f3db6639SMichael Ellerman } 53346712d858SJoe Perches 53350f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 53360f3c5aabSJoe Perches my $const_structs = qr{ 53370f3c5aabSJoe Perches acpi_dock_ops| 533879404849SEmese Revfy address_space_operations| 533979404849SEmese Revfy backlight_ops| 534079404849SEmese Revfy block_device_operations| 534179404849SEmese Revfy dentry_operations| 534279404849SEmese Revfy dev_pm_ops| 534379404849SEmese Revfy dma_map_ops| 534479404849SEmese Revfy extent_io_ops| 534579404849SEmese Revfy file_lock_operations| 534679404849SEmese Revfy file_operations| 534779404849SEmese Revfy hv_ops| 534879404849SEmese Revfy ide_dma_ops| 534979404849SEmese Revfy intel_dvo_dev_ops| 535079404849SEmese Revfy item_operations| 535179404849SEmese Revfy iwl_ops| 535279404849SEmese Revfy kgdb_arch| 535379404849SEmese Revfy kgdb_io| 535479404849SEmese Revfy kset_uevent_ops| 535579404849SEmese Revfy lock_manager_operations| 535679404849SEmese Revfy microcode_ops| 535779404849SEmese Revfy mtrr_ops| 535879404849SEmese Revfy neigh_ops| 535979404849SEmese Revfy nlmsvc_binding| 53600f3c5aabSJoe Perches of_device_id| 536179404849SEmese Revfy pci_raw_ops| 536279404849SEmese Revfy pipe_buf_operations| 536379404849SEmese Revfy platform_hibernation_ops| 536479404849SEmese Revfy platform_suspend_ops| 536579404849SEmese Revfy proto_ops| 536679404849SEmese Revfy rpc_pipe_ops| 536779404849SEmese Revfy seq_operations| 536879404849SEmese Revfy snd_ac97_build_ops| 536979404849SEmese Revfy soc_pcmcia_socket_ops| 537079404849SEmese Revfy stacktrace_ops| 537179404849SEmese Revfy sysfs_ops| 537279404849SEmese Revfy tty_operations| 53736d07d01bSJoe Perches uart_ops| 537479404849SEmese Revfy usb_mon_operations| 537579404849SEmese Revfy wd_ops}x; 53766903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 53770f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5378000d1cc1SJoe Perches WARN("CONST_STRUCT", 5379000d1cc1SJoe Perches "struct $1 should normally be const\n" . 53806903ffb2SAndy Whitcroft $herecurr); 53812b6db5cbSAndy Whitcroft } 5382773647a0SAndy Whitcroft 5383773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5384773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5385773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5386c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5387c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5388171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5389171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5390171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5391773647a0SAndy Whitcroft { 5392000d1cc1SJoe Perches WARN("NR_CPUS", 5393000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5394773647a0SAndy Whitcroft } 53959c9ba34eSAndy Whitcroft 539652ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 539752ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 539852ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 539952ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 540052ea8506SJoe Perches } 540152ea8506SJoe Perches 5402acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5403acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5404acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5405acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5406acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5407acd9362cSJoe Perches } 5408acd9362cSJoe Perches 5409691d77b6SAndy Whitcroft# whine mightly about in_atomic 5410691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5411691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5412000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5413000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5414f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5415000d1cc1SJoe Perches WARN("IN_ATOMIC", 5416000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5417691d77b6SAndy Whitcroft } 5418691d77b6SAndy Whitcroft } 54191704f47bSPeter Zijlstra 54201704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 54211704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 54221704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 54231704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 54241704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 54251704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5426000d1cc1SJoe Perches ERROR("LOCKDEP", 5427000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 54281704f47bSPeter Zijlstra } 54291704f47bSPeter Zijlstra } 543088f8831cSDave Jones 5431b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5432b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5433000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5434000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 543588f8831cSDave Jones } 54362435880fSJoe Perches 5437515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5438515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5439515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5440515a235eSJoe Perches $line =~ /$mode_perms_search/) { 54412435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 54422435880fSJoe Perches my $func = $entry->[0]; 54432435880fSJoe Perches my $arg_pos = $entry->[1]; 54442435880fSJoe Perches 54452435880fSJoe Perches my $skip_args = ""; 54462435880fSJoe Perches if ($arg_pos > 1) { 54472435880fSJoe Perches $arg_pos--; 54482435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 54492435880fSJoe Perches } 54502435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5451515a235eSJoe Perches if ($line =~ /$test/) { 54522435880fSJoe Perches my $val = $1; 54532435880fSJoe Perches $val = $6 if ($skip_args ne ""); 54542435880fSJoe Perches 54551727cc70SJoe Perches if ($val !~ /^0$/ && 54561727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 54571727cc70SJoe Perches length($val) ne 4)) { 54582435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 54591727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5460c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5461c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5462c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 54632435880fSJoe Perches } 54642435880fSJoe Perches } 54652435880fSJoe Perches } 546613214adfSAndy Whitcroft } 5467515a235eSJoe Perches } 546813214adfSAndy Whitcroft 546913214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 547013214adfSAndy Whitcroft # so just keep quiet. 547113214adfSAndy Whitcroft if ($#rawlines == -1) { 547213214adfSAndy Whitcroft exit(0); 54730a920b5bSAndy Whitcroft } 54740a920b5bSAndy Whitcroft 54758905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 54768905a67cSAndy Whitcroft # things that appear to be patches. 54778905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 54788905a67cSAndy Whitcroft exit(0); 54798905a67cSAndy Whitcroft } 54808905a67cSAndy Whitcroft 54818905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 54828905a67cSAndy Whitcroft # just keep quiet. 54838905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 54848905a67cSAndy Whitcroft exit(0); 54858905a67cSAndy Whitcroft } 54868905a67cSAndy Whitcroft 54878905a67cSAndy Whitcroft if (!$is_patch) { 5488000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5489000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 54900a920b5bSAndy Whitcroft } 54910a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 5492000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5493000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 54940a920b5bSAndy Whitcroft } 54950a920b5bSAndy Whitcroft 5496f0a594c1SAndy Whitcroft print report_dump(); 549713214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 549813214adfSAndy Whitcroft print "$filename " if ($summary_file); 54996c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 55006c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 55016c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 55028905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 55036c72ffaaSAndy Whitcroft } 55048905a67cSAndy Whitcroft 5505d2c0a235SAndy Whitcroft if ($quiet == 0) { 5506d1fe9c09SJoe Perches 5507d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 5508d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 5509d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 5510d1fe9c09SJoe Perches } 5511d1fe9c09SJoe Perches 5512d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5513d2c0a235SAndy Whitcroft # then suggest that. 5514d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5515d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 5516d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 5517b0781216SMike Frysinger $rpt_cleaners = 0; 5518d2c0a235SAndy Whitcroft } 5519d2c0a235SAndy Whitcroft } 5520d2c0a235SAndy Whitcroft 552191bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 552291bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5523000d1cc1SJoe Perches 5524d752fcc8SJoe Perches if ($clean == 0 && $fix && 5525d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5526d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 55279624b8d6SJoe Perches my $newfile = $filename; 55289624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 55293705ce5bSJoe Perches my $linecount = 0; 55303705ce5bSJoe Perches my $f; 55313705ce5bSJoe Perches 5532d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5533d752fcc8SJoe Perches 55343705ce5bSJoe Perches open($f, '>', $newfile) 55353705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 55363705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 55373705ce5bSJoe Perches $linecount++; 55383705ce5bSJoe Perches if ($file) { 55393705ce5bSJoe Perches if ($linecount > 3) { 55403705ce5bSJoe Perches $fixed_line =~ s/^\+//; 55413705ce5bSJoe Perches print $f $fixed_line . "\n"; 55423705ce5bSJoe Perches } 55433705ce5bSJoe Perches } else { 55443705ce5bSJoe Perches print $f $fixed_line . "\n"; 55453705ce5bSJoe Perches } 55463705ce5bSJoe Perches } 55473705ce5bSJoe Perches close($f); 55483705ce5bSJoe Perches 55493705ce5bSJoe Perches if (!$quiet) { 55503705ce5bSJoe Perches print << "EOM"; 55513705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 55523705ce5bSJoe Perches 55533705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 55543705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 55553705ce5bSJoe Perches 55563705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 55573705ce5bSJoe PerchesNo warranties, expressed or implied... 55583705ce5bSJoe Perches 55593705ce5bSJoe PerchesEOM 55603705ce5bSJoe Perches } 55613705ce5bSJoe Perches } 55623705ce5bSJoe Perches 55630a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 5564c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 55650a920b5bSAndy Whitcroft } 55660a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 5567000d1cc1SJoe Perches print << "EOM"; 5568000d1cc1SJoe Perches$vname has style problems, please review. 5569000d1cc1SJoe Perches 5570000d1cc1SJoe PerchesIf any of these errors are false positives, please report 5571000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 5572000d1cc1SJoe PerchesEOM 55730a920b5bSAndy Whitcroft } 557413214adfSAndy Whitcroft 55750a920b5bSAndy Whitcroft return $clean; 55760a920b5bSAndy Whitcroft} 5577