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'; 1257230297SJoe Perchesuse Term::ANSIColor qw(:constants); 130a920b5bSAndy Whitcroft 140a920b5bSAndy Whitcroftmy $P = $0; 1536061e38SJoe Perchesmy $D = dirname(abs_path($P)); 160a920b5bSAndy Whitcroft 17000d1cc1SJoe Perchesmy $V = '0.32'; 180a920b5bSAndy Whitcroft 190a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 200a920b5bSAndy Whitcroft 210a920b5bSAndy Whitcroftmy $quiet = 0; 220a920b5bSAndy Whitcroftmy $tree = 1; 230a920b5bSAndy Whitcroftmy $chk_signoff = 1; 240a920b5bSAndy Whitcroftmy $chk_patch = 1; 25773647a0SAndy Whitcroftmy $tst_only; 266c72ffaaSAndy Whitcroftmy $emacs = 0; 278905a67cSAndy Whitcroftmy $terse = 0; 2834d8815fSJoe Perchesmy $showfile = 0; 296c72ffaaSAndy Whitcroftmy $file = 0; 306c72ffaaSAndy Whitcroftmy $check = 0; 312ac73b4fSJoe Perchesmy $check_orig = 0; 328905a67cSAndy Whitcroftmy $summary = 1; 338905a67cSAndy Whitcroftmy $mailback = 0; 3413214adfSAndy Whitcroftmy $summary_file = 0; 35000d1cc1SJoe Perchesmy $show_types = 0; 363705ce5bSJoe Perchesmy $fix = 0; 379624b8d6SJoe Perchesmy $fix_inplace = 0; 386c72ffaaSAndy Whitcroftmy $root; 39c2fdda0dSAndy Whitcroftmy %debug; 403445686aSJoe Perchesmy %camelcase = (); 4191bfe484SJoe Perchesmy %use_type = (); 4291bfe484SJoe Perchesmy @use = (); 4391bfe484SJoe Perchesmy %ignore_type = (); 44000d1cc1SJoe Perchesmy @ignore = (); 4577f5b10aSHannes Edermy $help = 0; 46000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 476cd7f386SJoe Perchesmy $max_line_length = 80; 48d62a201fSDave Hansenmy $ignore_perl_version = 0; 49d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5056193274SVadim Bendeburymy $min_conf_desc_length = 4; 5166b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 52ebfd7d62SJoe Perchesmy $codespell = 0; 53f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 5457230297SJoe Perchesmy $color = 1; 5577f5b10aSHannes Eder 5677f5b10aSHannes Edersub help { 5777f5b10aSHannes Eder my ($exitcode) = @_; 5877f5b10aSHannes Eder 5977f5b10aSHannes Eder print << "EOM"; 6077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 6177f5b10aSHannes EderVersion: $V 6277f5b10aSHannes Eder 6377f5b10aSHannes EderOptions: 6477f5b10aSHannes Eder -q, --quiet quiet 6577f5b10aSHannes Eder --no-tree run without a kernel tree 6677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 6777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 6877f5b10aSHannes Eder --emacs emacs compile window format 6977f5b10aSHannes Eder --terse one line per report 7034d8815fSJoe Perches --showfile emit diffed file position, not input file position 7177f5b10aSHannes Eder -f, --file treat FILE as regular source file 7277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 7391bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 74000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 756cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 7656193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 77000d1cc1SJoe Perches --show-types show the message "types" in the output 7877f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 7977f5b10aSHannes Eder --no-summary suppress the per-file summary 8077f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 8177f5b10aSHannes Eder --summary-file include the filename in summary 8277f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 8377f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 8477f5b10aSHannes Eder is all off) 8577f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 8677f5b10aSHannes Eder literally 873705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 883705ce5bSJoe Perches If correctable single-line errors exist, create 893705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 903705ce5bSJoe Perches with potential errors corrected to the preferred 913705ce5bSJoe Perches checkpatch style 929624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 939624b8d6SJoe Perches Is the same as --fix, but overwrites the input 949624b8d6SJoe Perches file. It's your fault if there's no backup or git 95d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 96d62a201fSDave Hansen runtime errors. 97ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 98f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 99ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 10057230297SJoe Perches --color Use colors when output is STDOUT (default: on) 10177f5b10aSHannes Eder -h, --help, --version display this help and exit 10277f5b10aSHannes Eder 10377f5b10aSHannes EderWhen FILE is - read standard input. 10477f5b10aSHannes EderEOM 10577f5b10aSHannes Eder 10677f5b10aSHannes Eder exit($exitcode); 10777f5b10aSHannes Eder} 10877f5b10aSHannes Eder 109000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 110000d1cc1SJoe Perchesif (-f $conf) { 111000d1cc1SJoe Perches my @conf_args; 112000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 113000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 114000d1cc1SJoe Perches 115000d1cc1SJoe Perches while (<$conffile>) { 116000d1cc1SJoe Perches my $line = $_; 117000d1cc1SJoe Perches 118000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 119000d1cc1SJoe Perches $line =~ s/^\s*//g; 120000d1cc1SJoe Perches $line =~ s/\s+/ /g; 121000d1cc1SJoe Perches 122000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 123000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 124000d1cc1SJoe Perches 125000d1cc1SJoe Perches my @words = split(" ", $line); 126000d1cc1SJoe Perches foreach my $word (@words) { 127000d1cc1SJoe Perches last if ($word =~ m/^#/); 128000d1cc1SJoe Perches push (@conf_args, $word); 129000d1cc1SJoe Perches } 130000d1cc1SJoe Perches } 131000d1cc1SJoe Perches close($conffile); 132000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 133000d1cc1SJoe Perches} 134000d1cc1SJoe Perches 1350a920b5bSAndy WhitcroftGetOptions( 1366c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1370a920b5bSAndy Whitcroft 'tree!' => \$tree, 1380a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1390a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1406c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1418905a67cSAndy Whitcroft 'terse!' => \$terse, 14234d8815fSJoe Perches 'showfile!' => \$showfile, 14377f5b10aSHannes Eder 'f|file!' => \$file, 1446c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1456c72ffaaSAndy Whitcroft 'strict!' => \$check, 146000d1cc1SJoe Perches 'ignore=s' => \@ignore, 14791bfe484SJoe Perches 'types=s' => \@use, 148000d1cc1SJoe Perches 'show-types!' => \$show_types, 1496cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 15056193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1516c72ffaaSAndy Whitcroft 'root=s' => \$root, 1528905a67cSAndy Whitcroft 'summary!' => \$summary, 1538905a67cSAndy Whitcroft 'mailback!' => \$mailback, 15413214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1553705ce5bSJoe Perches 'fix!' => \$fix, 1569624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 157d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 158c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 159773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 160ebfd7d62SJoe Perches 'codespell!' => \$codespell, 161ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 16257230297SJoe Perches 'color!' => \$color, 16377f5b10aSHannes Eder 'h|help' => \$help, 16477f5b10aSHannes Eder 'version' => \$help 16577f5b10aSHannes Eder) or help(1); 16677f5b10aSHannes Eder 16777f5b10aSHannes Ederhelp(0) if ($help); 1680a920b5bSAndy Whitcroft 1699624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1702ac73b4fSJoe Perches$check_orig = $check; 1719624b8d6SJoe Perches 1720a920b5bSAndy Whitcroftmy $exit = 0; 1730a920b5bSAndy Whitcroft 174d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 175d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 176d62a201fSDave Hansen if (!$ignore_perl_version) { 177d62a201fSDave Hansen exit(1); 178d62a201fSDave Hansen } 179d62a201fSDave Hansen} 180d62a201fSDave Hansen 1810a920b5bSAndy Whitcroftif ($#ARGV < 0) { 18277f5b10aSHannes Eder print "$P: no input files\n"; 1830a920b5bSAndy Whitcroft exit(1); 1840a920b5bSAndy Whitcroft} 1850a920b5bSAndy Whitcroft 18691bfe484SJoe Perchessub hash_save_array_words { 18791bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 18891bfe484SJoe Perches 18991bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 19091bfe484SJoe Perches foreach my $word (@array) { 191000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 192000d1cc1SJoe Perches $word =~ s/^\s*//g; 193000d1cc1SJoe Perches $word =~ s/\s+/ /g; 194000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 195000d1cc1SJoe Perches 196000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 197000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 198000d1cc1SJoe Perches 19991bfe484SJoe Perches $hashRef->{$word}++; 200000d1cc1SJoe Perches } 20191bfe484SJoe Perches} 20291bfe484SJoe Perches 20391bfe484SJoe Perchessub hash_show_words { 20491bfe484SJoe Perches my ($hashRef, $prefix) = @_; 20591bfe484SJoe Perches 2063c816e49SJoe Perches if (keys %$hashRef) { 207d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 20858cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 20991bfe484SJoe Perches print " $word"; 21091bfe484SJoe Perches } 211d8469f16SJoe Perches print "\n"; 21291bfe484SJoe Perches } 21391bfe484SJoe Perches} 21491bfe484SJoe Perches 21591bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 21691bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 217000d1cc1SJoe Perches 218c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 219c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2207429c690SAndy Whitcroftmy $dbg_type = 0; 221a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 222c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 22321caa13cSAndy Whitcroft ## no critic 22421caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 22521caa13cSAndy Whitcroft die "$@" if ($@); 226c2fdda0dSAndy Whitcroft} 227c2fdda0dSAndy Whitcroft 228d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 229d2c0a235SAndy Whitcroft 2308905a67cSAndy Whitcroftif ($terse) { 2318905a67cSAndy Whitcroft $emacs = 1; 2328905a67cSAndy Whitcroft $quiet++; 2338905a67cSAndy Whitcroft} 2348905a67cSAndy Whitcroft 2356c72ffaaSAndy Whitcroftif ($tree) { 2366c72ffaaSAndy Whitcroft if (defined $root) { 2376c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2386c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2396c72ffaaSAndy Whitcroft } 2406c72ffaaSAndy Whitcroft } else { 2416c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2426c72ffaaSAndy Whitcroft $root = '.'; 2436c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2446c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2456c72ffaaSAndy Whitcroft $root = $1; 2466c72ffaaSAndy Whitcroft } 2476c72ffaaSAndy Whitcroft } 2486c72ffaaSAndy Whitcroft 2496c72ffaaSAndy Whitcroft if (!defined $root) { 2500a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2510a920b5bSAndy Whitcroft exit(2); 2520a920b5bSAndy Whitcroft } 2536c72ffaaSAndy Whitcroft} 2546c72ffaaSAndy Whitcroft 2556c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2566c72ffaaSAndy Whitcroft 2572ceb532bSAndy Whitcroftour $Ident = qr{ 2582ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2592ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2602ceb532bSAndy Whitcroft }x; 2616c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2626c72ffaaSAndy Whitcroftour $Sparse = qr{ 2636c72ffaaSAndy Whitcroft __user| 2646c72ffaaSAndy Whitcroft __kernel| 2656c72ffaaSAndy Whitcroft __force| 2666c72ffaaSAndy Whitcroft __iomem| 26754507b51SJoe Perches __pmem| 2686c72ffaaSAndy Whitcroft __must_check| 2696c72ffaaSAndy Whitcroft __init_refok| 270417495edSAndy Whitcroft __kprobes| 271165e72a6SSven Eckelmann __ref| 272*ad315455SBoqun Feng __rcu| 273*ad315455SBoqun Feng __private 2746c72ffaaSAndy Whitcroft }x; 275e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 276e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 277e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 278e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 279e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2808716de38SJoe Perches 28152131292SWolfram Sang# Notes to $Attribute: 28252131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2836c72ffaaSAndy Whitcroftour $Attribute = qr{ 2846c72ffaaSAndy Whitcroft const| 28503f1df7dSJoe Perches __percpu| 28603f1df7dSJoe Perches __nocast| 28703f1df7dSJoe Perches __safe| 28803f1df7dSJoe Perches __bitwise__| 28903f1df7dSJoe Perches __packed__| 29003f1df7dSJoe Perches __packed2__| 29103f1df7dSJoe Perches __naked| 29203f1df7dSJoe Perches __maybe_unused| 29303f1df7dSJoe Perches __always_unused| 29403f1df7dSJoe Perches __noreturn| 29503f1df7dSJoe Perches __used| 29603f1df7dSJoe Perches __cold| 297e23ef1f3SJoe Perches __pure| 29803f1df7dSJoe Perches __noclone| 29903f1df7dSJoe Perches __deprecated| 3006c72ffaaSAndy Whitcroft __read_mostly| 3016c72ffaaSAndy Whitcroft __kprobes| 3028716de38SJoe Perches $InitAttribute| 30324e1d81aSAndy Whitcroft ____cacheline_aligned| 30424e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3055fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3065fe3af11SAndy Whitcroft __weak 3076c72ffaaSAndy Whitcroft }x; 308c45dcabdSAndy Whitcroftour $Modifier; 30991cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3106c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3116c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3126c72ffaaSAndy Whitcroft 31395e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 31495e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 31595e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 31695e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3172435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 318c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 319326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 320326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 321326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 32274349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3232435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 324326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 325447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 32623f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3276c72ffaaSAndy Whitcroftour $Operators = qr{ 3286c72ffaaSAndy Whitcroft <=|>=|==|!=| 3296c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 33023f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3316c72ffaaSAndy Whitcroft }x; 3326c72ffaaSAndy Whitcroft 33391cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 33491cb5195SJoe Perches 335ab7e23f3SJoe Perchesour $BasicType; 3368905a67cSAndy Whitcroftour $NonptrType; 3371813087dSJoe Perchesour $NonptrTypeMisordered; 3388716de38SJoe Perchesour $NonptrTypeWithAttr; 3398905a67cSAndy Whitcroftour $Type; 3401813087dSJoe Perchesour $TypeMisordered; 3418905a67cSAndy Whitcroftour $Declare; 3421813087dSJoe Perchesour $DeclareMisordered; 3438905a67cSAndy Whitcroft 34415662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 34515662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 346171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 347171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 348171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 349171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 350171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 351171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 352171ae1a4SAndy Whitcroft}x; 353171ae1a4SAndy Whitcroft 35415662b3eSJoe Perchesour $UTF8 = qr{ 35515662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 35615662b3eSJoe Perches | $NON_ASCII_UTF8 35715662b3eSJoe Perches}x; 35815662b3eSJoe Perches 359e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 360021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 361021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 362021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 363021158b4SJoe Perches)}; 364e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 365fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3668ed22cadSAndy Whitcroft atomic_t 3678ed22cadSAndy Whitcroft)}; 368e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 369e6176fa4SJoe Perches $typeC99Typedefs\b| 370e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 371e6176fa4SJoe Perches $typeKernelTypedefs\b 372e6176fa4SJoe Perches)}; 3738ed22cadSAndy Whitcroft 3746d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 3756d32f7a3SJoe Perches 376691e669bSJoe Perchesour $logFunctions = qr{(?x: 3776e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3787d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3796e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 380b0531722SJoe Perches panic| 38106668727SJoe Perches MODULE_[A-Z_]+| 38206668727SJoe Perches seq_vprintf|seq_printf|seq_puts 383691e669bSJoe Perches)}; 384691e669bSJoe Perches 38520112475SJoe Perchesour $signature_tags = qr{(?xi: 38620112475SJoe Perches Signed-off-by:| 38720112475SJoe Perches Acked-by:| 38820112475SJoe Perches Tested-by:| 38920112475SJoe Perches Reviewed-by:| 39020112475SJoe Perches Reported-by:| 3918543ae12SMugunthan V N Suggested-by:| 39220112475SJoe Perches To:| 39320112475SJoe Perches Cc: 39420112475SJoe Perches)}; 39520112475SJoe Perches 3961813087dSJoe Perchesour @typeListMisordered = ( 3971813087dSJoe Perches qr{char\s+(?:un)?signed}, 3981813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3991813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 4001813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4011813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4021813087dSJoe Perches qr{short\s+(?:un)?signed}, 4031813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4041813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4051813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4061813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4071813087dSJoe Perches qr{int\s+(?:un)?signed}, 4081813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4091813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4101813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4111813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4121813087dSJoe Perches qr{long\s+(?:un)?signed}, 4131813087dSJoe Perches); 4141813087dSJoe Perches 4158905a67cSAndy Whitcroftour @typeList = ( 4168905a67cSAndy Whitcroft qr{void}, 4170c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4180c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4190c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4200c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4210c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4220c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4230c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4240c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4250c773d9dSJoe Perches qr{(?:un)?signed}, 4268905a67cSAndy Whitcroft qr{float}, 4278905a67cSAndy Whitcroft qr{double}, 4288905a67cSAndy Whitcroft qr{bool}, 4298905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4308905a67cSAndy Whitcroft qr{union\s+$Ident}, 4318905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4328905a67cSAndy Whitcroft qr{${Ident}_t}, 4338905a67cSAndy Whitcroft qr{${Ident}_handler}, 4348905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4351813087dSJoe Perches @typeListMisordered, 4368905a67cSAndy Whitcroft); 437938224b5SJoe Perches 438938224b5SJoe Perchesour $C90_int_types = qr{(?x: 439938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 440938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 441938224b5SJoe Perches long\s+long\s+(?:un)?signed| 442938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 443938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 444938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 445938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 446938224b5SJoe Perches 447938224b5SJoe Perches long\s+int\s+(?:un)?signed| 448938224b5SJoe Perches long\s+(?:un)?signed\s+int| 449938224b5SJoe Perches long\s+(?:un)?signed| 450938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 451938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 452938224b5SJoe Perches int\s+long\s+(?:un)?signed| 453938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 454938224b5SJoe Perches 455938224b5SJoe Perches int\s+(?:un)?signed| 456938224b5SJoe Perches (?:(?:un)?signed\s+)?int 457938224b5SJoe Perches)}; 458938224b5SJoe Perches 459485ff23eSAlex Dowadour @typeListFile = (); 4608716de38SJoe Perchesour @typeListWithAttr = ( 4618716de38SJoe Perches @typeList, 4628716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4638716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4648716de38SJoe Perches); 4658716de38SJoe Perches 466c45dcabdSAndy Whitcroftour @modifierList = ( 467c45dcabdSAndy Whitcroft qr{fastcall}, 468c45dcabdSAndy Whitcroft); 469485ff23eSAlex Dowadour @modifierListFile = (); 4708905a67cSAndy Whitcroft 4712435880fSJoe Perchesour @mode_permission_funcs = ( 4722435880fSJoe Perches ["module_param", 3], 4732435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4742435880fSJoe Perches ["module_param_array_named", 5], 4752435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4762435880fSJoe Perches ["proc_create(?:_data|)", 2], 4772435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4782435880fSJoe Perches); 4792435880fSJoe Perches 480515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 481515a235eSJoe Perchesour $mode_perms_search = ""; 482515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 483515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 484515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 485515a235eSJoe Perches} 486515a235eSJoe Perches 487b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 488b392c64fSJoe Perches S_IWUGO | 489b392c64fSJoe Perches S_IWOTH | 490b392c64fSJoe Perches S_IRWXUGO | 491b392c64fSJoe Perches S_IALLUGO | 492b392c64fSJoe Perches 0[0-7][0-7][2367] 493b392c64fSJoe Perches}x; 494b392c64fSJoe Perches 4957840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4967840a94cSWolfram Sang irq| 497cdcee686SSergey Ryazanov memory| 498cdcee686SSergey Ryazanov time| 499cdcee686SSergey Ryazanov reboot 5007840a94cSWolfram Sang)}; 5017840a94cSWolfram Sang# memory.h: ARM has a custom one 5027840a94cSWolfram Sang 50366b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 50466b47b4aSKees Cookmy $misspellings; 50566b47b4aSKees Cookmy %spelling_fix; 50636061e38SJoe Perches 50736061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 50866b47b4aSKees Cook while (<$spelling>) { 50966b47b4aSKees Cook my $line = $_; 51066b47b4aSKees Cook 51166b47b4aSKees Cook $line =~ s/\s*\n?$//g; 51266b47b4aSKees Cook $line =~ s/^\s*//g; 51366b47b4aSKees Cook 51466b47b4aSKees Cook next if ($line =~ m/^\s*#/); 51566b47b4aSKees Cook next if ($line =~ m/^\s*$/); 51666b47b4aSKees Cook 51766b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 51866b47b4aSKees Cook 51966b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 52066b47b4aSKees Cook } 52166b47b4aSKees Cook close($spelling); 52236061e38SJoe Perches} else { 52336061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 52436061e38SJoe Perches} 52566b47b4aSKees Cook 526ebfd7d62SJoe Perchesif ($codespell) { 527ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 528ebfd7d62SJoe Perches while (<$spelling>) { 529ebfd7d62SJoe Perches my $line = $_; 530ebfd7d62SJoe Perches 531ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 532ebfd7d62SJoe Perches $line =~ s/^\s*//g; 533ebfd7d62SJoe Perches 534ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 535ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 536ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 537ebfd7d62SJoe Perches 538ebfd7d62SJoe Perches $line =~ s/,.*$//; 539ebfd7d62SJoe Perches 540ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 541ebfd7d62SJoe Perches 542ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 543ebfd7d62SJoe Perches } 544ebfd7d62SJoe Perches close($spelling); 545ebfd7d62SJoe Perches } else { 546ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 547ebfd7d62SJoe Perches } 548ebfd7d62SJoe Perches} 549ebfd7d62SJoe Perches 550ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 551ebfd7d62SJoe Perches 5528905a67cSAndy Whitcroftsub build_types { 553485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 554485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 5551813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5568716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 557c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 558ab7e23f3SJoe Perches $BasicType = qr{ 559ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 560ab7e23f3SJoe Perches (?:${all}\b) 561ab7e23f3SJoe Perches }x; 5628905a67cSAndy Whitcroft $NonptrType = qr{ 563d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 564cf655043SAndy Whitcroft (?: 5656b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 5668ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 567c45dcabdSAndy Whitcroft (?:${all}\b) 568cf655043SAndy Whitcroft ) 569c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5708905a67cSAndy Whitcroft }x; 5711813087dSJoe Perches $NonptrTypeMisordered = qr{ 5721813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5731813087dSJoe Perches (?: 5741813087dSJoe Perches (?:${Misordered}\b) 5751813087dSJoe Perches ) 5761813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5771813087dSJoe Perches }x; 5788716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5798716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5808716de38SJoe Perches (?: 5818716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5828716de38SJoe Perches (?:$typeTypedefs\b)| 5838716de38SJoe Perches (?:${allWithAttr}\b) 5848716de38SJoe Perches ) 5858716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5868716de38SJoe Perches }x; 5878905a67cSAndy Whitcroft $Type = qr{ 588c45dcabdSAndy Whitcroft $NonptrType 5891574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 590c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5918905a67cSAndy Whitcroft }x; 5921813087dSJoe Perches $TypeMisordered = qr{ 5931813087dSJoe Perches $NonptrTypeMisordered 5941813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5951813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5961813087dSJoe Perches }x; 59791cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5981813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5998905a67cSAndy Whitcroft} 6008905a67cSAndy Whitcroftbuild_types(); 6016c72ffaaSAndy Whitcroft 6027d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 603d1fe9c09SJoe Perches 604d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 605d1fe9c09SJoe Perches# requires at least perl version v5.10.0 606d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 607d1fe9c09SJoe Perches 608d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 6092435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 610c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 6117d2367afSJoe Perches 612f8422308SJoe Perchesour $declaration_macros = qr{(?x: 6133e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 614f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 615f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 616f8422308SJoe Perches)}; 617f8422308SJoe Perches 6187d2367afSJoe Perchessub deparenthesize { 6197d2367afSJoe Perches my ($string) = @_; 6207d2367afSJoe Perches return "" if (!defined($string)); 6215b9553abSJoe Perches 6225b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 6235b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 6245b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 6255b9553abSJoe Perches } 6265b9553abSJoe Perches 6277d2367afSJoe Perches $string =~ s@\s+@ @g; 6285b9553abSJoe Perches 6297d2367afSJoe Perches return $string; 6307d2367afSJoe Perches} 6317d2367afSJoe Perches 6323445686aSJoe Perchessub seed_camelcase_file { 6333445686aSJoe Perches my ($file) = @_; 6343445686aSJoe Perches 6353445686aSJoe Perches return if (!(-f $file)); 6363445686aSJoe Perches 6373445686aSJoe Perches local $/; 6383445686aSJoe Perches 6393445686aSJoe Perches open(my $include_file, '<', "$file") 6403445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6413445686aSJoe Perches my $text = <$include_file>; 6423445686aSJoe Perches close($include_file); 6433445686aSJoe Perches 6443445686aSJoe Perches my @lines = split('\n', $text); 6453445686aSJoe Perches 6463445686aSJoe Perches foreach my $line (@lines) { 6473445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6483445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6493445686aSJoe Perches $camelcase{$1} = 1; 65011ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 65111ea516aSJoe Perches $camelcase{$1} = 1; 65211ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6533445686aSJoe Perches $camelcase{$1} = 1; 6543445686aSJoe Perches } 6553445686aSJoe Perches } 6563445686aSJoe Perches} 6573445686aSJoe Perches 6583445686aSJoe Perchesmy $camelcase_seeded = 0; 6593445686aSJoe Perchessub seed_camelcase_includes { 6603445686aSJoe Perches return if ($camelcase_seeded); 6613445686aSJoe Perches 6623445686aSJoe Perches my $files; 663c707a81dSJoe Perches my $camelcase_cache = ""; 664c707a81dSJoe Perches my @include_files = (); 665c707a81dSJoe Perches 666c707a81dSJoe Perches $camelcase_seeded = 1; 667351b2a1fSJoe Perches 6683645e328SRichard Genoud if (-e ".git") { 669351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 670351b2a1fSJoe Perches chomp $git_last_include_commit; 671c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 672c707a81dSJoe Perches } else { 673c707a81dSJoe Perches my $last_mod_date = 0; 674c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 675c707a81dSJoe Perches @include_files = split('\n', $files); 676c707a81dSJoe Perches foreach my $file (@include_files) { 677c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 678c707a81dSJoe Perches localtime((stat $file)[9])); 679c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 680c707a81dSJoe Perches } 681c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 682c707a81dSJoe Perches } 683c707a81dSJoe Perches 684c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 685c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 686c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 687351b2a1fSJoe Perches while (<$camelcase_file>) { 688351b2a1fSJoe Perches chomp; 689351b2a1fSJoe Perches $camelcase{$_} = 1; 690351b2a1fSJoe Perches } 691351b2a1fSJoe Perches close($camelcase_file); 692351b2a1fSJoe Perches 693351b2a1fSJoe Perches return; 694351b2a1fSJoe Perches } 695c707a81dSJoe Perches 6963645e328SRichard Genoud if (-e ".git") { 697c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 698c707a81dSJoe Perches @include_files = split('\n', $files); 6993445686aSJoe Perches } 700c707a81dSJoe Perches 7013445686aSJoe Perches foreach my $file (@include_files) { 7023445686aSJoe Perches seed_camelcase_file($file); 7033445686aSJoe Perches } 704351b2a1fSJoe Perches 705c707a81dSJoe Perches if ($camelcase_cache ne "") { 706351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 707c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 708c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 709351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 710351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 711351b2a1fSJoe Perches } 712351b2a1fSJoe Perches close($camelcase_file); 713351b2a1fSJoe Perches } 7143445686aSJoe Perches} 7153445686aSJoe Perches 716d311cd44SJoe Perchessub git_commit_info { 717d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 718d311cd44SJoe Perches 719d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 720d311cd44SJoe Perches 721d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 722d311cd44SJoe Perches $output =~ s/^\s*//gm; 723d311cd44SJoe Perches my @lines = split("\n", $output); 724d311cd44SJoe Perches 7250d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 7260d7835fcSJoe Perches 727d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 728d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 729d311cd44SJoe Perches# all matching commit ids, but it's very slow... 730d311cd44SJoe Perches# 731d311cd44SJoe Perches# echo "checking commits $1..." 732d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 733d311cd44SJoe Perches# while read line ; do 734d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 735d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 736d311cd44SJoe Perches# done 737d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 738d311cd44SJoe Perches } else { 739d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 740d311cd44SJoe Perches $desc = substr($lines[0], 41); 741d311cd44SJoe Perches } 742d311cd44SJoe Perches 743d311cd44SJoe Perches return ($id, $desc); 744d311cd44SJoe Perches} 745d311cd44SJoe Perches 7466c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7470a920b5bSAndy Whitcroft 74800df344fSAndy Whitcroftmy @rawlines = (); 749c2fdda0dSAndy Whitcroftmy @lines = (); 7503705ce5bSJoe Perchesmy @fixed = (); 751d752fcc8SJoe Perchesmy @fixed_inserted = (); 752d752fcc8SJoe Perchesmy @fixed_deleted = (); 753194f66fcSJoe Perchesmy $fixlinenr = -1; 754194f66fcSJoe Perches 755c2fdda0dSAndy Whitcroftmy $vname; 7566c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 75721caa13cSAndy Whitcroft my $FILE; 7586c72ffaaSAndy Whitcroft if ($file) { 75921caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7606c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 76121caa13cSAndy Whitcroft } elsif ($filename eq '-') { 76221caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7636c72ffaaSAndy Whitcroft } else { 76421caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7656c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7666c72ffaaSAndy Whitcroft } 767c2fdda0dSAndy Whitcroft if ($filename eq '-') { 768c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 769c2fdda0dSAndy Whitcroft } else { 770c2fdda0dSAndy Whitcroft $vname = $filename; 771c2fdda0dSAndy Whitcroft } 77221caa13cSAndy Whitcroft while (<$FILE>) { 7730a920b5bSAndy Whitcroft chomp; 77400df344fSAndy Whitcroft push(@rawlines, $_); 7756c72ffaaSAndy Whitcroft } 77621caa13cSAndy Whitcroft close($FILE); 777d8469f16SJoe Perches 778d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 779d8469f16SJoe Perches print '-' x length($vname) . "\n"; 780d8469f16SJoe Perches print "$vname\n"; 781d8469f16SJoe Perches print '-' x length($vname) . "\n"; 782d8469f16SJoe Perches } 783d8469f16SJoe Perches 784c2fdda0dSAndy Whitcroft if (!process($filename)) { 7850a920b5bSAndy Whitcroft $exit = 1; 7860a920b5bSAndy Whitcroft } 78700df344fSAndy Whitcroft @rawlines = (); 78813214adfSAndy Whitcroft @lines = (); 7893705ce5bSJoe Perches @fixed = (); 790d752fcc8SJoe Perches @fixed_inserted = (); 791d752fcc8SJoe Perches @fixed_deleted = (); 792194f66fcSJoe Perches $fixlinenr = -1; 793485ff23eSAlex Dowad @modifierListFile = (); 794485ff23eSAlex Dowad @typeListFile = (); 795485ff23eSAlex Dowad build_types(); 7960a920b5bSAndy Whitcroft} 7970a920b5bSAndy Whitcroft 798d8469f16SJoe Perchesif (!$quiet) { 7993c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 8003c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 8013c816e49SJoe Perches 802d8469f16SJoe Perches if ($^V lt 5.10.0) { 803d8469f16SJoe Perches print << "EOM" 804d8469f16SJoe Perches 805d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 806d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 807d8469f16SJoe PerchesEOM 808d8469f16SJoe Perches } 809d8469f16SJoe Perches if ($exit) { 810d8469f16SJoe Perches print << "EOM" 811d8469f16SJoe Perches 812d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 813d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 814d8469f16SJoe PerchesEOM 815d8469f16SJoe Perches } 816d8469f16SJoe Perches} 817d8469f16SJoe Perches 8180a920b5bSAndy Whitcroftexit($exit); 8190a920b5bSAndy Whitcroft 8200a920b5bSAndy Whitcroftsub top_of_kernel_tree { 8216c72ffaaSAndy Whitcroft my ($root) = @_; 8226c72ffaaSAndy Whitcroft 8236c72ffaaSAndy Whitcroft my @tree_check = ( 8246c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 8256c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 8266c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 8276c72ffaaSAndy Whitcroft ); 8286c72ffaaSAndy Whitcroft 8296c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 8306c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 8310a920b5bSAndy Whitcroft return 0; 8320a920b5bSAndy Whitcroft } 8336c72ffaaSAndy Whitcroft } 8346c72ffaaSAndy Whitcroft return 1; 8356c72ffaaSAndy Whitcroft} 8360a920b5bSAndy Whitcroft 83720112475SJoe Perchessub parse_email { 83820112475SJoe Perches my ($formatted_email) = @_; 83920112475SJoe Perches 84020112475SJoe Perches my $name = ""; 84120112475SJoe Perches my $address = ""; 84220112475SJoe Perches my $comment = ""; 84320112475SJoe Perches 84420112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 84520112475SJoe Perches $name = $1; 84620112475SJoe Perches $address = $2; 84720112475SJoe Perches $comment = $3 if defined $3; 84820112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 84920112475SJoe Perches $address = $1; 85020112475SJoe Perches $comment = $2 if defined $2; 85120112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 85220112475SJoe Perches $address = $1; 85320112475SJoe Perches $comment = $2 if defined $2; 85420112475SJoe Perches $formatted_email =~ s/$address.*$//; 85520112475SJoe Perches $name = $formatted_email; 8563705ce5bSJoe Perches $name = trim($name); 85720112475SJoe Perches $name =~ s/^\"|\"$//g; 85820112475SJoe Perches # If there's a name left after stripping spaces and 85920112475SJoe Perches # leading quotes, and the address doesn't have both 86020112475SJoe Perches # leading and trailing angle brackets, the address 86120112475SJoe Perches # is invalid. ie: 86220112475SJoe Perches # "joe smith [email protected]" bad 86320112475SJoe Perches # "joe smith <[email protected]" bad 86420112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 86520112475SJoe Perches $name = ""; 86620112475SJoe Perches $address = ""; 86720112475SJoe Perches $comment = ""; 86820112475SJoe Perches } 86920112475SJoe Perches } 87020112475SJoe Perches 8713705ce5bSJoe Perches $name = trim($name); 87220112475SJoe Perches $name =~ s/^\"|\"$//g; 8733705ce5bSJoe Perches $address = trim($address); 87420112475SJoe Perches $address =~ s/^\<|\>$//g; 87520112475SJoe Perches 87620112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 87720112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 87820112475SJoe Perches $name = "\"$name\""; 87920112475SJoe Perches } 88020112475SJoe Perches 88120112475SJoe Perches return ($name, $address, $comment); 88220112475SJoe Perches} 88320112475SJoe Perches 88420112475SJoe Perchessub format_email { 88520112475SJoe Perches my ($name, $address) = @_; 88620112475SJoe Perches 88720112475SJoe Perches my $formatted_email; 88820112475SJoe Perches 8893705ce5bSJoe Perches $name = trim($name); 89020112475SJoe Perches $name =~ s/^\"|\"$//g; 8913705ce5bSJoe Perches $address = trim($address); 89220112475SJoe Perches 89320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 89420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 89520112475SJoe Perches $name = "\"$name\""; 89620112475SJoe Perches } 89720112475SJoe Perches 89820112475SJoe Perches if ("$name" eq "") { 89920112475SJoe Perches $formatted_email = "$address"; 90020112475SJoe Perches } else { 90120112475SJoe Perches $formatted_email = "$name <$address>"; 90220112475SJoe Perches } 90320112475SJoe Perches 90420112475SJoe Perches return $formatted_email; 90520112475SJoe Perches} 90620112475SJoe Perches 907d311cd44SJoe Perchessub which { 908d311cd44SJoe Perches my ($bin) = @_; 909d311cd44SJoe Perches 910d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 911d311cd44SJoe Perches if (-e "$path/$bin") { 912d311cd44SJoe Perches return "$path/$bin"; 913d311cd44SJoe Perches } 914d311cd44SJoe Perches } 915d311cd44SJoe Perches 916d311cd44SJoe Perches return ""; 917d311cd44SJoe Perches} 918d311cd44SJoe Perches 919000d1cc1SJoe Perchessub which_conf { 920000d1cc1SJoe Perches my ($conf) = @_; 921000d1cc1SJoe Perches 922000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 923000d1cc1SJoe Perches if (-e "$path/$conf") { 924000d1cc1SJoe Perches return "$path/$conf"; 925000d1cc1SJoe Perches } 926000d1cc1SJoe Perches } 927000d1cc1SJoe Perches 928000d1cc1SJoe Perches return ""; 929000d1cc1SJoe Perches} 930000d1cc1SJoe Perches 9310a920b5bSAndy Whitcroftsub expand_tabs { 9320a920b5bSAndy Whitcroft my ($str) = @_; 9330a920b5bSAndy Whitcroft 9340a920b5bSAndy Whitcroft my $res = ''; 9350a920b5bSAndy Whitcroft my $n = 0; 9360a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 9370a920b5bSAndy Whitcroft if ($c eq "\t") { 9380a920b5bSAndy Whitcroft $res .= ' '; 9390a920b5bSAndy Whitcroft $n++; 9400a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 9410a920b5bSAndy Whitcroft $res .= ' '; 9420a920b5bSAndy Whitcroft } 9430a920b5bSAndy Whitcroft next; 9440a920b5bSAndy Whitcroft } 9450a920b5bSAndy Whitcroft $res .= $c; 9460a920b5bSAndy Whitcroft $n++; 9470a920b5bSAndy Whitcroft } 9480a920b5bSAndy Whitcroft 9490a920b5bSAndy Whitcroft return $res; 9500a920b5bSAndy Whitcroft} 9516c72ffaaSAndy Whitcroftsub copy_spacing { 952773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 9536c72ffaaSAndy Whitcroft return $res; 9546c72ffaaSAndy Whitcroft} 9550a920b5bSAndy Whitcroft 9564a0df2efSAndy Whitcroftsub line_stats { 9574a0df2efSAndy Whitcroft my ($line) = @_; 9584a0df2efSAndy Whitcroft 9594a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 9604a0df2efSAndy Whitcroft $line =~ s/^.//; 9614a0df2efSAndy Whitcroft $line = expand_tabs($line); 9624a0df2efSAndy Whitcroft 9634a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 9644a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9654a0df2efSAndy Whitcroft 9664a0df2efSAndy Whitcroft return (length($line), length($white)); 9674a0df2efSAndy Whitcroft} 9684a0df2efSAndy Whitcroft 969773647a0SAndy Whitcroftmy $sanitise_quote = ''; 970773647a0SAndy Whitcroft 971773647a0SAndy Whitcroftsub sanitise_line_reset { 972773647a0SAndy Whitcroft my ($in_comment) = @_; 973773647a0SAndy Whitcroft 974773647a0SAndy Whitcroft if ($in_comment) { 975773647a0SAndy Whitcroft $sanitise_quote = '*/'; 976773647a0SAndy Whitcroft } else { 977773647a0SAndy Whitcroft $sanitise_quote = ''; 978773647a0SAndy Whitcroft } 979773647a0SAndy Whitcroft} 98000df344fSAndy Whitcroftsub sanitise_line { 98100df344fSAndy Whitcroft my ($line) = @_; 98200df344fSAndy Whitcroft 98300df344fSAndy Whitcroft my $res = ''; 98400df344fSAndy Whitcroft my $l = ''; 98500df344fSAndy Whitcroft 986c2fdda0dSAndy Whitcroft my $qlen = 0; 987773647a0SAndy Whitcroft my $off = 0; 988773647a0SAndy Whitcroft my $c; 98900df344fSAndy Whitcroft 990773647a0SAndy Whitcroft # Always copy over the diff marker. 991773647a0SAndy Whitcroft $res = substr($line, 0, 1); 992773647a0SAndy Whitcroft 993773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 994773647a0SAndy Whitcroft $c = substr($line, $off, 1); 995773647a0SAndy Whitcroft 996773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 997773647a0SAndy Whitcroft # and end, all to $;. 998773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 999773647a0SAndy Whitcroft $sanitise_quote = '*/'; 1000773647a0SAndy Whitcroft 1001773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1002773647a0SAndy Whitcroft $off++; 100300df344fSAndy Whitcroft next; 1004773647a0SAndy Whitcroft } 100581bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1006773647a0SAndy Whitcroft $sanitise_quote = ''; 1007773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1008773647a0SAndy Whitcroft $off++; 1009773647a0SAndy Whitcroft next; 1010773647a0SAndy Whitcroft } 1011113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1012113f04a8SDaniel Walker $sanitise_quote = '//'; 1013113f04a8SDaniel Walker 1014113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1015113f04a8SDaniel Walker $off++; 1016113f04a8SDaniel Walker next; 1017113f04a8SDaniel Walker } 1018773647a0SAndy Whitcroft 1019773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1020773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1021773647a0SAndy Whitcroft $c eq "\\") { 1022773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1023773647a0SAndy Whitcroft $off++; 1024773647a0SAndy Whitcroft next; 1025773647a0SAndy Whitcroft } 1026773647a0SAndy Whitcroft # Regular quotes. 1027773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1028773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1029773647a0SAndy Whitcroft $sanitise_quote = $c; 1030773647a0SAndy Whitcroft 1031773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1032773647a0SAndy Whitcroft next; 1033773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1034773647a0SAndy Whitcroft $sanitise_quote = ''; 103500df344fSAndy Whitcroft } 103600df344fSAndy Whitcroft } 1037773647a0SAndy Whitcroft 1038fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1039773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1040773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1041113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1042113f04a8SDaniel Walker substr($res, $off, 1, $;); 1043773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1044773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 104500df344fSAndy Whitcroft } else { 1046773647a0SAndy Whitcroft substr($res, $off, 1, $c); 104700df344fSAndy Whitcroft } 1048c2fdda0dSAndy Whitcroft } 1049c2fdda0dSAndy Whitcroft 1050113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1051113f04a8SDaniel Walker $sanitise_quote = ''; 1052113f04a8SDaniel Walker } 1053113f04a8SDaniel Walker 1054c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1055c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1056c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1057c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1058c2fdda0dSAndy Whitcroft 1059c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1060c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1061c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1062c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1063c2fdda0dSAndy Whitcroft } 1064c2fdda0dSAndy Whitcroft 106500df344fSAndy Whitcroft return $res; 106600df344fSAndy Whitcroft} 106700df344fSAndy Whitcroft 1068a6962d72SJoe Perchessub get_quoted_string { 1069a6962d72SJoe Perches my ($line, $rawline) = @_; 1070a6962d72SJoe Perches 107133acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1072a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1073a6962d72SJoe Perches} 1074a6962d72SJoe Perches 10758905a67cSAndy Whitcroftsub ctx_statement_block { 10768905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10778905a67cSAndy Whitcroft my $line = $linenr - 1; 10788905a67cSAndy Whitcroft my $blk = ''; 10798905a67cSAndy Whitcroft my $soff = $off; 10808905a67cSAndy Whitcroft my $coff = $off - 1; 1081773647a0SAndy Whitcroft my $coff_set = 0; 10828905a67cSAndy Whitcroft 108313214adfSAndy Whitcroft my $loff = 0; 108413214adfSAndy Whitcroft 10858905a67cSAndy Whitcroft my $type = ''; 10868905a67cSAndy Whitcroft my $level = 0; 1087a2750645SAndy Whitcroft my @stack = (); 1088cf655043SAndy Whitcroft my $p; 10898905a67cSAndy Whitcroft my $c; 10908905a67cSAndy Whitcroft my $len = 0; 109113214adfSAndy Whitcroft 109213214adfSAndy Whitcroft my $remainder; 10938905a67cSAndy Whitcroft while (1) { 1094a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1095a2750645SAndy Whitcroft 1096773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10978905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10988905a67cSAndy Whitcroft # context. 10998905a67cSAndy Whitcroft if ($off >= $len) { 11008905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1101dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1102c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 11038905a67cSAndy Whitcroft $remain--; 110413214adfSAndy Whitcroft $loff = $len; 1105c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 11068905a67cSAndy Whitcroft $len = length($blk); 11078905a67cSAndy Whitcroft $line++; 11088905a67cSAndy Whitcroft last; 11098905a67cSAndy Whitcroft } 11108905a67cSAndy Whitcroft # Bail if there is no further context. 11118905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 111213214adfSAndy Whitcroft if ($off >= $len) { 11138905a67cSAndy Whitcroft last; 11148905a67cSAndy Whitcroft } 1115f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1116f74bd194SAndy Whitcroft $level++; 1117f74bd194SAndy Whitcroft $type = '#'; 1118f74bd194SAndy Whitcroft } 11198905a67cSAndy Whitcroft } 1120cf655043SAndy Whitcroft $p = $c; 11218905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 112213214adfSAndy Whitcroft $remainder = substr($blk, $off); 11238905a67cSAndy Whitcroft 1124773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 11254635f4fbSAndy Whitcroft 11264635f4fbSAndy Whitcroft # Handle nested #if/#else. 11274635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 11284635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 11294635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 11304635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 11314635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 11324635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 11334635f4fbSAndy Whitcroft } 11344635f4fbSAndy Whitcroft 11358905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 11368905a67cSAndy Whitcroft # outermost level. 11378905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 11388905a67cSAndy Whitcroft last; 11398905a67cSAndy Whitcroft } 11408905a67cSAndy Whitcroft 114113214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1142773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1143773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1144773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1145773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1146773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1147773647a0SAndy Whitcroft $coff_set = 1; 1148773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1149773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 115013214adfSAndy Whitcroft } 115113214adfSAndy Whitcroft 11528905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 11538905a67cSAndy Whitcroft $level++; 11548905a67cSAndy Whitcroft $type = '('; 11558905a67cSAndy Whitcroft } 11568905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 11578905a67cSAndy Whitcroft $level--; 11588905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 11598905a67cSAndy Whitcroft 11608905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 11618905a67cSAndy Whitcroft $coff = $off; 1162773647a0SAndy Whitcroft $coff_set = 1; 1163773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 11648905a67cSAndy Whitcroft } 11658905a67cSAndy Whitcroft } 11668905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11678905a67cSAndy Whitcroft $level++; 11688905a67cSAndy Whitcroft $type = '{'; 11698905a67cSAndy Whitcroft } 11708905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11718905a67cSAndy Whitcroft $level--; 11728905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11738905a67cSAndy Whitcroft 11748905a67cSAndy Whitcroft if ($level == 0) { 1175b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1176b998e001SPatrick Pannuto $off++; 1177b998e001SPatrick Pannuto } 11788905a67cSAndy Whitcroft last; 11798905a67cSAndy Whitcroft } 11808905a67cSAndy Whitcroft } 1181f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1182f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1183f74bd194SAndy Whitcroft $level--; 1184f74bd194SAndy Whitcroft $type = ''; 1185f74bd194SAndy Whitcroft $off++; 1186f74bd194SAndy Whitcroft last; 1187f74bd194SAndy Whitcroft } 11888905a67cSAndy Whitcroft $off++; 11898905a67cSAndy Whitcroft } 1190a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 119113214adfSAndy Whitcroft if ($off == $len) { 1192a3bb97a7SAndy Whitcroft $loff = $len + 1; 119313214adfSAndy Whitcroft $line++; 119413214adfSAndy Whitcroft $remain--; 119513214adfSAndy Whitcroft } 11968905a67cSAndy Whitcroft 11978905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11988905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11998905a67cSAndy Whitcroft 12008905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 12018905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 12028905a67cSAndy Whitcroft 1203773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 120413214adfSAndy Whitcroft 120513214adfSAndy Whitcroft return ($statement, $condition, 120613214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 120713214adfSAndy Whitcroft} 120813214adfSAndy Whitcroft 1209cf655043SAndy Whitcroftsub statement_lines { 1210cf655043SAndy Whitcroft my ($stmt) = @_; 1211cf655043SAndy Whitcroft 1212cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1213cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1214cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1215cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1216cf655043SAndy Whitcroft 1217cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1218cf655043SAndy Whitcroft 1219cf655043SAndy Whitcroft return $#stmt_lines + 2; 1220cf655043SAndy Whitcroft} 1221cf655043SAndy Whitcroft 1222cf655043SAndy Whitcroftsub statement_rawlines { 1223cf655043SAndy Whitcroft my ($stmt) = @_; 1224cf655043SAndy Whitcroft 1225cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1226cf655043SAndy Whitcroft 1227cf655043SAndy Whitcroft return $#stmt_lines + 2; 1228cf655043SAndy Whitcroft} 1229cf655043SAndy Whitcroft 1230cf655043SAndy Whitcroftsub statement_block_size { 1231cf655043SAndy Whitcroft my ($stmt) = @_; 1232cf655043SAndy Whitcroft 1233cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1234cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1235cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1236cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1237cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1238cf655043SAndy Whitcroft 1239cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1240cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1241cf655043SAndy Whitcroft 1242cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1243cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1244cf655043SAndy Whitcroft 1245cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1246cf655043SAndy Whitcroft return $stmt_lines; 1247cf655043SAndy Whitcroft } else { 1248cf655043SAndy Whitcroft return $stmt_statements; 1249cf655043SAndy Whitcroft } 1250cf655043SAndy Whitcroft} 1251cf655043SAndy Whitcroft 125213214adfSAndy Whitcroftsub ctx_statement_full { 125313214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 125413214adfSAndy Whitcroft my ($statement, $condition, $level); 125513214adfSAndy Whitcroft 125613214adfSAndy Whitcroft my (@chunks); 125713214adfSAndy Whitcroft 1258cf655043SAndy Whitcroft # Grab the first conditional/block pair. 125913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 126013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1261773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 126213214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1263cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1264cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1265cf655043SAndy Whitcroft } 1266cf655043SAndy Whitcroft 1267cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1268cf655043SAndy Whitcroft # could continue the statement. 1269cf655043SAndy Whitcroft for (;;) { 127013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 127113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1272cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1273773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1274cf655043SAndy Whitcroft #print "C: push\n"; 1275cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 127613214adfSAndy Whitcroft } 127713214adfSAndy Whitcroft 127813214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12798905a67cSAndy Whitcroft} 12808905a67cSAndy Whitcroft 12814a0df2efSAndy Whitcroftsub ctx_block_get { 1282f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12834a0df2efSAndy Whitcroft my $line; 12844a0df2efSAndy Whitcroft my $start = $linenr - 1; 12854a0df2efSAndy Whitcroft my $blk = ''; 12864a0df2efSAndy Whitcroft my @o; 12874a0df2efSAndy Whitcroft my @c; 12884a0df2efSAndy Whitcroft my @res = (); 12894a0df2efSAndy Whitcroft 1290f0a594c1SAndy Whitcroft my $level = 0; 12914635f4fbSAndy Whitcroft my @stack = ($level); 129200df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 129300df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 129400df344fSAndy Whitcroft $remain--; 129500df344fSAndy Whitcroft 129600df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12974635f4fbSAndy Whitcroft 12984635f4fbSAndy Whitcroft # Handle nested #if/#else. 129901464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 13004635f4fbSAndy Whitcroft push(@stack, $level); 130101464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 13024635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 130301464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 13044635f4fbSAndy Whitcroft $level = pop(@stack); 13054635f4fbSAndy Whitcroft } 13064635f4fbSAndy Whitcroft 130701464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1308f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1309f0a594c1SAndy Whitcroft if ($off > 0) { 1310f0a594c1SAndy Whitcroft $off--; 1311f0a594c1SAndy Whitcroft next; 1312f0a594c1SAndy Whitcroft } 13134a0df2efSAndy Whitcroft 1314f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1315f0a594c1SAndy Whitcroft $level--; 1316f0a594c1SAndy Whitcroft last if ($level == 0); 1317f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1318f0a594c1SAndy Whitcroft $level++; 1319f0a594c1SAndy Whitcroft } 1320f0a594c1SAndy Whitcroft } 13214a0df2efSAndy Whitcroft 1322f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 132300df344fSAndy Whitcroft push(@res, $rawlines[$line]); 13244a0df2efSAndy Whitcroft } 13254a0df2efSAndy Whitcroft 1326f0a594c1SAndy Whitcroft last if ($level == 0); 13274a0df2efSAndy Whitcroft } 13284a0df2efSAndy Whitcroft 1329f0a594c1SAndy Whitcroft return ($level, @res); 13304a0df2efSAndy Whitcroft} 13314a0df2efSAndy Whitcroftsub ctx_block_outer { 13324a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13334a0df2efSAndy Whitcroft 1334f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1335f0a594c1SAndy Whitcroft return @r; 13364a0df2efSAndy Whitcroft} 13374a0df2efSAndy Whitcroftsub ctx_block { 13384a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13394a0df2efSAndy Whitcroft 1340f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1341f0a594c1SAndy Whitcroft return @r; 1342653d4876SAndy Whitcroft} 1343653d4876SAndy Whitcroftsub ctx_statement { 1344f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1345f0a594c1SAndy Whitcroft 1346f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1347f0a594c1SAndy Whitcroft return @r; 1348f0a594c1SAndy Whitcroft} 1349f0a594c1SAndy Whitcroftsub ctx_block_level { 1350653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1351653d4876SAndy Whitcroft 1352f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 13534a0df2efSAndy Whitcroft} 13549c0ca6f9SAndy Whitcroftsub ctx_statement_level { 13559c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 13569c0ca6f9SAndy Whitcroft 13579c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 13589c0ca6f9SAndy Whitcroft} 13594a0df2efSAndy Whitcroft 13604a0df2efSAndy Whitcroftsub ctx_locate_comment { 13614a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13624a0df2efSAndy Whitcroft 13634a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1364beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13654a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13664a0df2efSAndy Whitcroft 13674a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13684a0df2efSAndy Whitcroft # comment. 13694a0df2efSAndy Whitcroft my $in_comment = 0; 13704a0df2efSAndy Whitcroft $current_comment = ''; 13714a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 137200df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 137300df344fSAndy Whitcroft #warn " $line\n"; 13744a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13754a0df2efSAndy Whitcroft $in_comment = 1; 13764a0df2efSAndy Whitcroft } 13774a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13784a0df2efSAndy Whitcroft $in_comment = 1; 13794a0df2efSAndy Whitcroft } 13804a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13814a0df2efSAndy Whitcroft $current_comment = ''; 13824a0df2efSAndy Whitcroft } 13834a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13844a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13854a0df2efSAndy Whitcroft $in_comment = 0; 13864a0df2efSAndy Whitcroft } 13874a0df2efSAndy Whitcroft } 13884a0df2efSAndy Whitcroft 13894a0df2efSAndy Whitcroft chomp($current_comment); 13904a0df2efSAndy Whitcroft return($current_comment); 13914a0df2efSAndy Whitcroft} 13924a0df2efSAndy Whitcroftsub ctx_has_comment { 13934a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13944a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13954a0df2efSAndy Whitcroft 139600df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13974a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13984a0df2efSAndy Whitcroft 13994a0df2efSAndy Whitcroft return ($cmt ne ''); 14004a0df2efSAndy Whitcroft} 14014a0df2efSAndy Whitcroft 14024d001e4dSAndy Whitcroftsub raw_line { 14034d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 14044d001e4dSAndy Whitcroft 14054d001e4dSAndy Whitcroft my $offset = $linenr - 1; 14064d001e4dSAndy Whitcroft $cnt++; 14074d001e4dSAndy Whitcroft 14084d001e4dSAndy Whitcroft my $line; 14094d001e4dSAndy Whitcroft while ($cnt) { 14104d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 14114d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 14124d001e4dSAndy Whitcroft $cnt--; 14134d001e4dSAndy Whitcroft } 14144d001e4dSAndy Whitcroft 14154d001e4dSAndy Whitcroft return $line; 14164d001e4dSAndy Whitcroft} 14174d001e4dSAndy Whitcroft 14180a920b5bSAndy Whitcroftsub cat_vet { 14190a920b5bSAndy Whitcroft my ($vet) = @_; 14209c0ca6f9SAndy Whitcroft my ($res, $coded); 14210a920b5bSAndy Whitcroft 14229c0ca6f9SAndy Whitcroft $res = ''; 14236c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 14246c72ffaaSAndy Whitcroft $res .= $1; 14256c72ffaaSAndy Whitcroft if ($2 ne '') { 14269c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 14276c72ffaaSAndy Whitcroft $res .= $coded; 14286c72ffaaSAndy Whitcroft } 14299c0ca6f9SAndy Whitcroft } 14309c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 14310a920b5bSAndy Whitcroft 14329c0ca6f9SAndy Whitcroft return $res; 14330a920b5bSAndy Whitcroft} 14340a920b5bSAndy Whitcroft 1435c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1436cf655043SAndy Whitcroftmy $av_pending; 1437c2fdda0dSAndy Whitcroftmy @av_paren_type; 14381f65f947SAndy Whitcroftmy $av_pend_colon; 1439c2fdda0dSAndy Whitcroft 1440c2fdda0dSAndy Whitcroftsub annotate_reset { 1441c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1442cf655043SAndy Whitcroft $av_pending = '_'; 1443cf655043SAndy Whitcroft @av_paren_type = ('E'); 14441f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1445c2fdda0dSAndy Whitcroft} 1446c2fdda0dSAndy Whitcroft 14476c72ffaaSAndy Whitcroftsub annotate_values { 14486c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 14496c72ffaaSAndy Whitcroft 14506c72ffaaSAndy Whitcroft my $res; 14511f65f947SAndy Whitcroft my $var = '_' x length($stream); 14526c72ffaaSAndy Whitcroft my $cur = $stream; 14536c72ffaaSAndy Whitcroft 1454c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 14556c72ffaaSAndy Whitcroft 14566c72ffaaSAndy Whitcroft while (length($cur)) { 1457773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1458cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1459171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 14606c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1461c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1462c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1463cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1464c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14656c72ffaaSAndy Whitcroft } 14666c72ffaaSAndy Whitcroft 1467c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14689446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14699446ef56SAndy Whitcroft push(@av_paren_type, $type); 1470addcdceaSAndy Whitcroft $type = 'c'; 14719446ef56SAndy Whitcroft 1472e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1473c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14746c72ffaaSAndy Whitcroft $type = 'T'; 14756c72ffaaSAndy Whitcroft 1476389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1477389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1478389a2fe5SAndy Whitcroft $type = 'T'; 1479389a2fe5SAndy Whitcroft 1480c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1481171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1482c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1483171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1484171ae1a4SAndy Whitcroft if ($2 ne '') { 1485cf655043SAndy Whitcroft $av_pending = 'N'; 1486171ae1a4SAndy Whitcroft } 1487171ae1a4SAndy Whitcroft $type = 'E'; 1488171ae1a4SAndy Whitcroft 1489c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1490171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1491171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1492171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14936c72ffaaSAndy Whitcroft 1494c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1495cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1496c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1497cf655043SAndy Whitcroft 1498cf655043SAndy Whitcroft push(@av_paren_type, $type); 1499cf655043SAndy Whitcroft push(@av_paren_type, $type); 1500171ae1a4SAndy Whitcroft $type = 'E'; 1501cf655043SAndy Whitcroft 1502c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1503cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1504cf655043SAndy Whitcroft $av_preprocessor = 1; 1505cf655043SAndy Whitcroft 1506cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1507cf655043SAndy Whitcroft 1508171ae1a4SAndy Whitcroft $type = 'E'; 1509cf655043SAndy Whitcroft 1510c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1511cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1512cf655043SAndy Whitcroft 1513cf655043SAndy Whitcroft $av_preprocessor = 1; 1514cf655043SAndy Whitcroft 1515cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1516cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1517cf655043SAndy Whitcroft pop(@av_paren_type); 1518cf655043SAndy Whitcroft push(@av_paren_type, $type); 1519171ae1a4SAndy Whitcroft $type = 'E'; 15206c72ffaaSAndy Whitcroft 15216c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1522c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 15236c72ffaaSAndy Whitcroft 1524171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1525171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1526171ae1a4SAndy Whitcroft $av_pending = $type; 1527171ae1a4SAndy Whitcroft $type = 'N'; 1528171ae1a4SAndy Whitcroft 15296c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1530c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 15316c72ffaaSAndy Whitcroft if (defined $2) { 1532cf655043SAndy Whitcroft $av_pending = 'V'; 15336c72ffaaSAndy Whitcroft } 15346c72ffaaSAndy Whitcroft $type = 'N'; 15356c72ffaaSAndy Whitcroft 153614b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1537c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 153814b111c1SAndy Whitcroft $av_pending = 'E'; 15396c72ffaaSAndy Whitcroft $type = 'N'; 15406c72ffaaSAndy Whitcroft 15411f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 15421f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 15431f65f947SAndy Whitcroft $av_pend_colon = 'C'; 15441f65f947SAndy Whitcroft $type = 'N'; 15451f65f947SAndy Whitcroft 154614b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1547c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 15486c72ffaaSAndy Whitcroft $type = 'N'; 15496c72ffaaSAndy Whitcroft 15506c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1551c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1552cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1553cf655043SAndy Whitcroft $av_pending = '_'; 15546c72ffaaSAndy Whitcroft $type = 'N'; 15556c72ffaaSAndy Whitcroft 15566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1557cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1558cf655043SAndy Whitcroft if ($new_type ne '_') { 1559cf655043SAndy Whitcroft $type = $new_type; 1560c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1561c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 15626c72ffaaSAndy Whitcroft } else { 1563c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 15646c72ffaaSAndy Whitcroft } 15656c72ffaaSAndy Whitcroft 1566c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1567c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1568c8cb2ca3SAndy Whitcroft $type = 'V'; 1569cf655043SAndy Whitcroft $av_pending = 'V'; 15706c72ffaaSAndy Whitcroft 15718e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15728e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15731f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15748e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15758e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15761f65f947SAndy Whitcroft } 15771f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15781f65f947SAndy Whitcroft $type = 'V'; 15791f65f947SAndy Whitcroft 15806c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1581c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15826c72ffaaSAndy Whitcroft $type = 'V'; 15836c72ffaaSAndy Whitcroft 15846c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1585c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15866c72ffaaSAndy Whitcroft $type = 'N'; 15876c72ffaaSAndy Whitcroft 1588cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1589c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 159013214adfSAndy Whitcroft $type = 'E'; 15911f65f947SAndy Whitcroft $av_pend_colon = 'O'; 159213214adfSAndy Whitcroft 15938e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15948e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15958e761b04SAndy Whitcroft $type = 'C'; 15968e761b04SAndy Whitcroft 15971f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15981f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15991f65f947SAndy Whitcroft $type = 'N'; 16001f65f947SAndy Whitcroft 16011f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 16021f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 16031f65f947SAndy Whitcroft 16041f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 16051f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 16061f65f947SAndy Whitcroft $type = 'E'; 16071f65f947SAndy Whitcroft } else { 16081f65f947SAndy Whitcroft $type = 'N'; 16091f65f947SAndy Whitcroft } 16101f65f947SAndy Whitcroft $av_pend_colon = 'O'; 16111f65f947SAndy Whitcroft 16128e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 161313214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 16146c72ffaaSAndy Whitcroft $type = 'N'; 16156c72ffaaSAndy Whitcroft 16160d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 161774048ed8SAndy Whitcroft my $variant; 161874048ed8SAndy Whitcroft 161974048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 162074048ed8SAndy Whitcroft if ($type eq 'V') { 162174048ed8SAndy Whitcroft $variant = 'B'; 162274048ed8SAndy Whitcroft } else { 162374048ed8SAndy Whitcroft $variant = 'U'; 162474048ed8SAndy Whitcroft } 162574048ed8SAndy Whitcroft 162674048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 162774048ed8SAndy Whitcroft $type = 'N'; 162874048ed8SAndy Whitcroft 16296c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1630c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 16316c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 16326c72ffaaSAndy Whitcroft $type = 'N'; 16336c72ffaaSAndy Whitcroft } 16346c72ffaaSAndy Whitcroft 16356c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1636c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 16376c72ffaaSAndy Whitcroft } 16386c72ffaaSAndy Whitcroft if (defined $1) { 16396c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 16406c72ffaaSAndy Whitcroft $res .= $type x length($1); 16416c72ffaaSAndy Whitcroft } 16426c72ffaaSAndy Whitcroft } 16436c72ffaaSAndy Whitcroft 16441f65f947SAndy Whitcroft return ($res, $var); 16456c72ffaaSAndy Whitcroft} 16466c72ffaaSAndy Whitcroft 16478905a67cSAndy Whitcroftsub possible { 164813214adfSAndy Whitcroft my ($possible, $line) = @_; 16499a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 16500776e594SAndy Whitcroft ^(?: 16510776e594SAndy Whitcroft $Modifier| 16520776e594SAndy Whitcroft $Storage| 16530776e594SAndy Whitcroft $Type| 16549a974fdbSAndy Whitcroft DEFINE_\S+ 16559a974fdbSAndy Whitcroft )$| 16569a974fdbSAndy Whitcroft ^(?: 16570776e594SAndy Whitcroft goto| 16580776e594SAndy Whitcroft return| 16590776e594SAndy Whitcroft case| 16600776e594SAndy Whitcroft else| 16610776e594SAndy Whitcroft asm|__asm__| 166289a88353SAndy Whitcroft do| 166389a88353SAndy Whitcroft \#| 166489a88353SAndy Whitcroft \#\#| 16659a974fdbSAndy Whitcroft )(?:\s|$)| 16660776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16679a974fdbSAndy Whitcroft )}x; 16689a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16699a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1670c45dcabdSAndy Whitcroft # Check for modifiers. 1671c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1672c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1673c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1674c45dcabdSAndy Whitcroft 1675c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1676c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1677d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16789a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1679d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1680485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1681d2506586SAndy Whitcroft } 16829a974fdbSAndy Whitcroft } 1683c45dcabdSAndy Whitcroft 1684c45dcabdSAndy Whitcroft } else { 168513214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1686485ff23eSAlex Dowad push(@typeListFile, $possible); 1687c45dcabdSAndy Whitcroft } 16888905a67cSAndy Whitcroft build_types(); 16890776e594SAndy Whitcroft } else { 16900776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16918905a67cSAndy Whitcroft } 16928905a67cSAndy Whitcroft} 16938905a67cSAndy Whitcroft 16946c72ffaaSAndy Whitcroftmy $prefix = ''; 16956c72ffaaSAndy Whitcroft 1696000d1cc1SJoe Perchessub show_type { 1697cbec18afSJoe Perches my ($type) = @_; 169891bfe484SJoe Perches 1699cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1700cbec18afSJoe Perches 1701cbec18afSJoe Perches return !defined $ignore_type{$type}; 1702000d1cc1SJoe Perches} 1703000d1cc1SJoe Perches 1704f0a594c1SAndy Whitcroftsub report { 1705cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1706cbec18afSJoe Perches 1707cbec18afSJoe Perches if (!show_type($type) || 1708cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1709773647a0SAndy Whitcroft return 0; 1710773647a0SAndy Whitcroft } 171157230297SJoe Perches my $output = ''; 171257230297SJoe Perches if (-t STDOUT && $color) { 171357230297SJoe Perches if ($level eq 'ERROR') { 171457230297SJoe Perches $output .= RED; 171557230297SJoe Perches } elsif ($level eq 'WARNING') { 171657230297SJoe Perches $output .= YELLOW; 1717000d1cc1SJoe Perches } else { 171857230297SJoe Perches $output .= GREEN; 1719000d1cc1SJoe Perches } 172057230297SJoe Perches } 172157230297SJoe Perches $output .= $prefix . $level . ':'; 172257230297SJoe Perches if ($show_types) { 172357230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 172457230297SJoe Perches $output .= "$type:"; 172557230297SJoe Perches } 172657230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 172757230297SJoe Perches $output .= ' ' . $msg . "\n"; 172834d8815fSJoe Perches 172934d8815fSJoe Perches if ($showfile) { 173034d8815fSJoe Perches my @lines = split("\n", $output, -1); 173134d8815fSJoe Perches splice(@lines, 1, 1); 173234d8815fSJoe Perches $output = join("\n", @lines); 173334d8815fSJoe Perches } 173457230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 17358905a67cSAndy Whitcroft 173657230297SJoe Perches push(our @report, $output); 1737773647a0SAndy Whitcroft 1738773647a0SAndy Whitcroft return 1; 1739f0a594c1SAndy Whitcroft} 1740cbec18afSJoe Perches 1741f0a594c1SAndy Whitcroftsub report_dump { 174213214adfSAndy Whitcroft our @report; 1743f0a594c1SAndy Whitcroft} 1744000d1cc1SJoe Perches 1745d752fcc8SJoe Perchessub fixup_current_range { 1746d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1747d752fcc8SJoe Perches 1748d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1749d752fcc8SJoe Perches my $o = $1; 1750d752fcc8SJoe Perches my $l = $2; 1751d752fcc8SJoe Perches my $no = $o + $offset; 1752d752fcc8SJoe Perches my $nl = $l + $length; 1753d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1754d752fcc8SJoe Perches } 1755d752fcc8SJoe Perches} 1756d752fcc8SJoe Perches 1757d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1758d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1759d752fcc8SJoe Perches 1760d752fcc8SJoe Perches my $range_last_linenr = 0; 1761d752fcc8SJoe Perches my $delta_offset = 0; 1762d752fcc8SJoe Perches 1763d752fcc8SJoe Perches my $old_linenr = 0; 1764d752fcc8SJoe Perches my $new_linenr = 0; 1765d752fcc8SJoe Perches 1766d752fcc8SJoe Perches my $next_insert = 0; 1767d752fcc8SJoe Perches my $next_delete = 0; 1768d752fcc8SJoe Perches 1769d752fcc8SJoe Perches my @lines = (); 1770d752fcc8SJoe Perches 1771d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1772d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1773d752fcc8SJoe Perches 1774d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1775d752fcc8SJoe Perches my $save_line = 1; 1776d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1777323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1778d752fcc8SJoe Perches $delta_offset = 0; 1779d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1780d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1781d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1782d752fcc8SJoe Perches } 1783d752fcc8SJoe Perches 1784d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1785d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1786d752fcc8SJoe Perches $save_line = 0; 1787d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1788d752fcc8SJoe Perches } 1789d752fcc8SJoe Perches 1790d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1791d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1792d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1793d752fcc8SJoe Perches $new_linenr++; 1794d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1795d752fcc8SJoe Perches } 1796d752fcc8SJoe Perches 1797d752fcc8SJoe Perches if ($save_line) { 1798d752fcc8SJoe Perches push(@lines, $line); 1799d752fcc8SJoe Perches $new_linenr++; 1800d752fcc8SJoe Perches } 1801d752fcc8SJoe Perches 1802d752fcc8SJoe Perches $old_linenr++; 1803d752fcc8SJoe Perches } 1804d752fcc8SJoe Perches 1805d752fcc8SJoe Perches return @lines; 1806d752fcc8SJoe Perches} 1807d752fcc8SJoe Perches 1808f2d7e4d4SJoe Perchessub fix_insert_line { 1809f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1810f2d7e4d4SJoe Perches 1811f2d7e4d4SJoe Perches my $inserted = { 1812f2d7e4d4SJoe Perches LINENR => $linenr, 1813f2d7e4d4SJoe Perches LINE => $line, 1814f2d7e4d4SJoe Perches }; 1815f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1816f2d7e4d4SJoe Perches} 1817f2d7e4d4SJoe Perches 1818f2d7e4d4SJoe Perchessub fix_delete_line { 1819f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1820f2d7e4d4SJoe Perches 1821f2d7e4d4SJoe Perches my $deleted = { 1822f2d7e4d4SJoe Perches LINENR => $linenr, 1823f2d7e4d4SJoe Perches LINE => $line, 1824f2d7e4d4SJoe Perches }; 1825f2d7e4d4SJoe Perches 1826f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1827f2d7e4d4SJoe Perches} 1828f2d7e4d4SJoe Perches 1829de7d4f0eSAndy Whitcroftsub ERROR { 1830cbec18afSJoe Perches my ($type, $msg) = @_; 1831cbec18afSJoe Perches 1832cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1833de7d4f0eSAndy Whitcroft our $clean = 0; 18346c72ffaaSAndy Whitcroft our $cnt_error++; 18353705ce5bSJoe Perches return 1; 1836de7d4f0eSAndy Whitcroft } 18373705ce5bSJoe Perches return 0; 1838773647a0SAndy Whitcroft} 1839de7d4f0eSAndy Whitcroftsub WARN { 1840cbec18afSJoe Perches my ($type, $msg) = @_; 1841cbec18afSJoe Perches 1842cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1843de7d4f0eSAndy Whitcroft our $clean = 0; 18446c72ffaaSAndy Whitcroft our $cnt_warn++; 18453705ce5bSJoe Perches return 1; 1846de7d4f0eSAndy Whitcroft } 18473705ce5bSJoe Perches return 0; 1848773647a0SAndy Whitcroft} 1849de7d4f0eSAndy Whitcroftsub CHK { 1850cbec18afSJoe Perches my ($type, $msg) = @_; 1851cbec18afSJoe Perches 1852cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1853de7d4f0eSAndy Whitcroft our $clean = 0; 18546c72ffaaSAndy Whitcroft our $cnt_chk++; 18553705ce5bSJoe Perches return 1; 18566c72ffaaSAndy Whitcroft } 18573705ce5bSJoe Perches return 0; 1858de7d4f0eSAndy Whitcroft} 1859de7d4f0eSAndy Whitcroft 18606ecd9674SAndy Whitcroftsub check_absolute_file { 18616ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 18626ecd9674SAndy Whitcroft my $file = $absolute; 18636ecd9674SAndy Whitcroft 18646ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 18656ecd9674SAndy Whitcroft 18666ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 18676ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 18686ecd9674SAndy Whitcroft if (-f "$root/$file") { 18696ecd9674SAndy Whitcroft ##print "file<$file>\n"; 18706ecd9674SAndy Whitcroft last; 18716ecd9674SAndy Whitcroft } 18726ecd9674SAndy Whitcroft } 18736ecd9674SAndy Whitcroft if (! -f _) { 18746ecd9674SAndy Whitcroft return 0; 18756ecd9674SAndy Whitcroft } 18766ecd9674SAndy Whitcroft 18776ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 18786ecd9674SAndy Whitcroft my $prefix = $absolute; 18796ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 18806ecd9674SAndy Whitcroft 18816ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18826ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1883000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1884000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18856ecd9674SAndy Whitcroft } 18866ecd9674SAndy Whitcroft} 18876ecd9674SAndy Whitcroft 18883705ce5bSJoe Perchessub trim { 18893705ce5bSJoe Perches my ($string) = @_; 18903705ce5bSJoe Perches 1891b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1892b34c648bSJoe Perches 1893b34c648bSJoe Perches return $string; 1894b34c648bSJoe Perches} 1895b34c648bSJoe Perches 1896b34c648bSJoe Perchessub ltrim { 1897b34c648bSJoe Perches my ($string) = @_; 1898b34c648bSJoe Perches 1899b34c648bSJoe Perches $string =~ s/^\s+//; 1900b34c648bSJoe Perches 1901b34c648bSJoe Perches return $string; 1902b34c648bSJoe Perches} 1903b34c648bSJoe Perches 1904b34c648bSJoe Perchessub rtrim { 1905b34c648bSJoe Perches my ($string) = @_; 1906b34c648bSJoe Perches 1907b34c648bSJoe Perches $string =~ s/\s+$//; 19083705ce5bSJoe Perches 19093705ce5bSJoe Perches return $string; 19103705ce5bSJoe Perches} 19113705ce5bSJoe Perches 191252ea8506SJoe Perchessub string_find_replace { 191352ea8506SJoe Perches my ($string, $find, $replace) = @_; 191452ea8506SJoe Perches 191552ea8506SJoe Perches $string =~ s/$find/$replace/g; 191652ea8506SJoe Perches 191752ea8506SJoe Perches return $string; 191852ea8506SJoe Perches} 191952ea8506SJoe Perches 19203705ce5bSJoe Perchessub tabify { 19213705ce5bSJoe Perches my ($leading) = @_; 19223705ce5bSJoe Perches 19233705ce5bSJoe Perches my $source_indent = 8; 19243705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 19253705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 19263705ce5bSJoe Perches 19273705ce5bSJoe Perches #convert leading spaces to tabs 19283705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 19293705ce5bSJoe Perches #Remove spaces before a tab 19303705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 19313705ce5bSJoe Perches 19323705ce5bSJoe Perches return "$leading"; 19333705ce5bSJoe Perches} 19343705ce5bSJoe Perches 1935d1fe9c09SJoe Perchessub pos_last_openparen { 1936d1fe9c09SJoe Perches my ($line) = @_; 1937d1fe9c09SJoe Perches 1938d1fe9c09SJoe Perches my $pos = 0; 1939d1fe9c09SJoe Perches 1940d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1941d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1942d1fe9c09SJoe Perches 1943d1fe9c09SJoe Perches my $last_openparen = 0; 1944d1fe9c09SJoe Perches 1945d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1946d1fe9c09SJoe Perches return -1; 1947d1fe9c09SJoe Perches } 1948d1fe9c09SJoe Perches 1949d1fe9c09SJoe Perches my $len = length($line); 1950d1fe9c09SJoe Perches 1951d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1952d1fe9c09SJoe Perches my $string = substr($line, $pos); 1953d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1954d1fe9c09SJoe Perches $pos += length($1) - 1; 1955d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1956d1fe9c09SJoe Perches $last_openparen = $pos; 1957d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1958d1fe9c09SJoe Perches last; 1959d1fe9c09SJoe Perches } 1960d1fe9c09SJoe Perches } 1961d1fe9c09SJoe Perches 196291cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1963d1fe9c09SJoe Perches} 1964d1fe9c09SJoe Perches 19650a920b5bSAndy Whitcroftsub process { 19660a920b5bSAndy Whitcroft my $filename = shift; 19670a920b5bSAndy Whitcroft 19680a920b5bSAndy Whitcroft my $linenr=0; 19690a920b5bSAndy Whitcroft my $prevline=""; 1970c2fdda0dSAndy Whitcroft my $prevrawline=""; 19710a920b5bSAndy Whitcroft my $stashline=""; 1972c2fdda0dSAndy Whitcroft my $stashrawline=""; 19730a920b5bSAndy Whitcroft 19744a0df2efSAndy Whitcroft my $length; 19750a920b5bSAndy Whitcroft my $indent; 19760a920b5bSAndy Whitcroft my $previndent=0; 19770a920b5bSAndy Whitcroft my $stashindent=0; 19780a920b5bSAndy Whitcroft 1979de7d4f0eSAndy Whitcroft our $clean = 1; 19800a920b5bSAndy Whitcroft my $signoff = 0; 19810a920b5bSAndy Whitcroft my $is_patch = 0; 198229ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 198315662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 1984bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 19852a076f40SJoe Perches my $commit_log_long_line = 0; 1986e518e9a5SJoe Perches my $commit_log_has_diff = 0; 198713f1937eSJoe Perches my $reported_maintainer_file = 0; 1988fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1989fa64205dSPasi Savanainen 1990365dd4eaSJoe Perches my $last_blank_line = 0; 19915e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1992365dd4eaSJoe Perches 199313214adfSAndy Whitcroft our @report = (); 19946c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19956c72ffaaSAndy Whitcroft our $cnt_error = 0; 19966c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19976c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19986c72ffaaSAndy Whitcroft 19990a920b5bSAndy Whitcroft # Trace the real file/line as we go. 20000a920b5bSAndy Whitcroft my $realfile = ''; 20010a920b5bSAndy Whitcroft my $realline = 0; 20020a920b5bSAndy Whitcroft my $realcnt = 0; 20030a920b5bSAndy Whitcroft my $here = ''; 20040a920b5bSAndy Whitcroft my $in_comment = 0; 2005c2fdda0dSAndy Whitcroft my $comment_edge = 0; 20060a920b5bSAndy Whitcroft my $first_line = 0; 20071e855726SWolfram Sang my $p1_prefix = ''; 20080a920b5bSAndy Whitcroft 200913214adfSAndy Whitcroft my $prev_values = 'E'; 201013214adfSAndy Whitcroft 201113214adfSAndy Whitcroft # suppression flags 2012773647a0SAndy Whitcroft my %suppress_ifbraces; 2013170d3a22SAndy Whitcroft my %suppress_whiletrailers; 20142b474a1aSAndy Whitcroft my %suppress_export; 20153e469cdcSAndy Whitcroft my $suppress_statement = 0; 2016653d4876SAndy Whitcroft 20177e51f197SJoe Perches my %signatures = (); 2018323c1260SJoe Perches 2019c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2020de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2021c2fdda0dSAndy Whitcroft # 2022de7d4f0eSAndy Whitcroft my @setup_docs = (); 2023de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2024773647a0SAndy Whitcroft 2025d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2026d8b07710SJoe Perches 2027773647a0SAndy Whitcroft sanitise_line_reset(); 2028c2fdda0dSAndy Whitcroft my $line; 2029c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2030773647a0SAndy Whitcroft $linenr++; 2031773647a0SAndy Whitcroft $line = $rawline; 2032c2fdda0dSAndy Whitcroft 20333705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 20343705ce5bSJoe Perches 2035773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2036de7d4f0eSAndy Whitcroft $setup_docs = 0; 2037de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2038de7d4f0eSAndy Whitcroft $setup_docs = 1; 2039de7d4f0eSAndy Whitcroft } 2040773647a0SAndy Whitcroft #next; 2041de7d4f0eSAndy Whitcroft } 2042773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2043773647a0SAndy Whitcroft $realline=$1-1; 2044773647a0SAndy Whitcroft if (defined $2) { 2045773647a0SAndy Whitcroft $realcnt=$3+1; 2046773647a0SAndy Whitcroft } else { 2047773647a0SAndy Whitcroft $realcnt=1+1; 2048773647a0SAndy Whitcroft } 2049c45dcabdSAndy Whitcroft $in_comment = 0; 2050773647a0SAndy Whitcroft 2051773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2052773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2053773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2054773647a0SAndy Whitcroft # at context start. 2055773647a0SAndy Whitcroft my $edge; 205601fa9147SAndy Whitcroft my $cnt = $realcnt; 205701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 205801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 205901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 206001fa9147SAndy Whitcroft $cnt--; 206101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2062721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2063fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2064fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2065fae17daeSAndy Whitcroft ($edge) = $1; 2066fae17daeSAndy Whitcroft last; 2067fae17daeSAndy Whitcroft } 2068773647a0SAndy Whitcroft } 2069773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2070773647a0SAndy Whitcroft $in_comment = 1; 2071773647a0SAndy Whitcroft } 2072773647a0SAndy Whitcroft 2073773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2074773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2075773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2076773647a0SAndy Whitcroft if (!defined $edge && 207783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2078773647a0SAndy Whitcroft { 2079773647a0SAndy Whitcroft $in_comment = 1; 2080773647a0SAndy Whitcroft } 2081773647a0SAndy Whitcroft 2082773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2083773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2084773647a0SAndy Whitcroft 2085171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2086773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2087171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2088773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2089773647a0SAndy Whitcroft } 2090773647a0SAndy Whitcroft push(@lines, $line); 2091773647a0SAndy Whitcroft 2092773647a0SAndy Whitcroft if ($realcnt > 1) { 2093773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2094773647a0SAndy Whitcroft } else { 2095773647a0SAndy Whitcroft $realcnt = 0; 2096773647a0SAndy Whitcroft } 2097773647a0SAndy Whitcroft 2098773647a0SAndy Whitcroft #print "==>$rawline\n"; 2099773647a0SAndy Whitcroft #print "-->$line\n"; 2100de7d4f0eSAndy Whitcroft 2101de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2102de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2103de7d4f0eSAndy Whitcroft } 2104de7d4f0eSAndy Whitcroft } 2105de7d4f0eSAndy Whitcroft 21066c72ffaaSAndy Whitcroft $prefix = ''; 21076c72ffaaSAndy Whitcroft 2108773647a0SAndy Whitcroft $realcnt = 0; 2109773647a0SAndy Whitcroft $linenr = 0; 2110194f66fcSJoe Perches $fixlinenr = -1; 21110a920b5bSAndy Whitcroft foreach my $line (@lines) { 21120a920b5bSAndy Whitcroft $linenr++; 2113194f66fcSJoe Perches $fixlinenr++; 21141b5539b1SJoe Perches my $sline = $line; #copy of $line 21151b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 21160a920b5bSAndy Whitcroft 2117c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 21186c72ffaaSAndy Whitcroft 21190a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2120e518e9a5SJoe Perches if (!$in_commit_log && 2121e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 21220a920b5bSAndy Whitcroft $is_patch = 1; 21234a0df2efSAndy Whitcroft $first_line = $linenr + 1; 21240a920b5bSAndy Whitcroft $realline=$1-1; 21250a920b5bSAndy Whitcroft if (defined $2) { 21260a920b5bSAndy Whitcroft $realcnt=$3+1; 21270a920b5bSAndy Whitcroft } else { 21280a920b5bSAndy Whitcroft $realcnt=1+1; 21290a920b5bSAndy Whitcroft } 2130c2fdda0dSAndy Whitcroft annotate_reset(); 213113214adfSAndy Whitcroft $prev_values = 'E'; 213213214adfSAndy Whitcroft 2133773647a0SAndy Whitcroft %suppress_ifbraces = (); 2134170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 21352b474a1aSAndy Whitcroft %suppress_export = (); 21363e469cdcSAndy Whitcroft $suppress_statement = 0; 21370a920b5bSAndy Whitcroft next; 21380a920b5bSAndy Whitcroft 21394a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 21404a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 21414a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2142773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 21430a920b5bSAndy Whitcroft $realline++; 2144d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 21450a920b5bSAndy Whitcroft 21464a0df2efSAndy Whitcroft # Measure the line length and indent. 2147c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 21480a920b5bSAndy Whitcroft 21490a920b5bSAndy Whitcroft # Track the previous line. 21500a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 21510a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2152c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2153c2fdda0dSAndy Whitcroft 2154773647a0SAndy Whitcroft #warn "line<$line>\n"; 21556c72ffaaSAndy Whitcroft 2156d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2157d8aaf121SAndy Whitcroft $realcnt--; 21580a920b5bSAndy Whitcroft } 21590a920b5bSAndy Whitcroft 2160cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2161cc77cdcaSAndy Whitcroft 21626c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 21636c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2164773647a0SAndy Whitcroft 21652ac73b4fSJoe Perches my $found_file = 0; 2166773647a0SAndy Whitcroft # extract the filename as it passes 21673bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 21683bf9a009SRabin Vincent $realfile = $1; 21692b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2170270c49a0SJoe Perches $in_commit_log = 0; 21712ac73b4fSJoe Perches $found_file = 1; 21723bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2173773647a0SAndy Whitcroft $realfile = $1; 21742b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2175270c49a0SJoe Perches $in_commit_log = 0; 21761e855726SWolfram Sang 21771e855726SWolfram Sang $p1_prefix = $1; 2178e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2179e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2180000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2181000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21821e855726SWolfram Sang } 2183773647a0SAndy Whitcroft 2184c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2185000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2186000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2187773647a0SAndy Whitcroft } 21882ac73b4fSJoe Perches $found_file = 1; 21892ac73b4fSJoe Perches } 21902ac73b4fSJoe Perches 219134d8815fSJoe Perches#make up the handle for any error we report on this line 219234d8815fSJoe Perches if ($showfile) { 219334d8815fSJoe Perches $prefix = "$realfile:$realline: " 219434d8815fSJoe Perches } elsif ($emacs) { 21957d3a9f67SJoe Perches if ($file) { 21967d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 21977d3a9f67SJoe Perches } else { 219834d8815fSJoe Perches $prefix = "$filename:$linenr: "; 219934d8815fSJoe Perches } 22007d3a9f67SJoe Perches } 220134d8815fSJoe Perches 22022ac73b4fSJoe Perches if ($found_file) { 22037bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 22042ac73b4fSJoe Perches $check = 1; 22052ac73b4fSJoe Perches } else { 22062ac73b4fSJoe Perches $check = $check_orig; 22072ac73b4fSJoe Perches } 2208773647a0SAndy Whitcroft next; 2209773647a0SAndy Whitcroft } 2210773647a0SAndy Whitcroft 2211389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 22120a920b5bSAndy Whitcroft 2213c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2214c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2215c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 22160a920b5bSAndy Whitcroft 22176c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 22186c72ffaaSAndy Whitcroft 2219e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2220e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2221e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2222e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2223e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2224e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2225e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2226e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2227e518e9a5SJoe Perches $commit_log_has_diff = 1; 2228e518e9a5SJoe Perches } 2229e518e9a5SJoe Perches 22303bf9a009SRabin Vincent# Check for incorrect file permissions 22313bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 22323bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 223304db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 223404db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2235000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2236000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 22373bf9a009SRabin Vincent } 22383bf9a009SRabin Vincent } 22393bf9a009SRabin Vincent 224020112475SJoe Perches# Check the patch for a signoff: 2241d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 22424a0df2efSAndy Whitcroft $signoff++; 224315662b3eSJoe Perches $in_commit_log = 0; 22440a920b5bSAndy Whitcroft } 224520112475SJoe Perches 2246e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2247e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2248e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2249e0d975b1SJoe Perches $reported_maintainer_file = 1; 2250e0d975b1SJoe Perches } 2251e0d975b1SJoe Perches 225220112475SJoe Perches# Check signature styles 2253270c49a0SJoe Perches if (!$in_header_lines && 2254ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 225520112475SJoe Perches my $space_before = $1; 225620112475SJoe Perches my $sign_off = $2; 225720112475SJoe Perches my $space_after = $3; 225820112475SJoe Perches my $email = $4; 225920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 226020112475SJoe Perches 2261ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2262ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2263ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2264ce0338dfSJoe Perches } 226520112475SJoe Perches if (defined $space_before && $space_before ne "") { 22663705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22673705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 22683705ce5bSJoe Perches $fix) { 2269194f66fcSJoe Perches $fixed[$fixlinenr] = 22703705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22713705ce5bSJoe Perches } 227220112475SJoe Perches } 227320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22743705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22753705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22763705ce5bSJoe Perches $fix) { 2277194f66fcSJoe Perches $fixed[$fixlinenr] = 22783705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22793705ce5bSJoe Perches } 22803705ce5bSJoe Perches 228120112475SJoe Perches } 228220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22833705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22843705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22853705ce5bSJoe Perches $fix) { 2286194f66fcSJoe Perches $fixed[$fixlinenr] = 22873705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22883705ce5bSJoe Perches } 228920112475SJoe Perches } 229020112475SJoe Perches 229120112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 229220112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 229320112475SJoe Perches if ($suggested_email eq "") { 2294000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2295000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 229620112475SJoe Perches } else { 229720112475SJoe Perches my $dequoted = $suggested_email; 229820112475SJoe Perches $dequoted =~ s/^"//; 229920112475SJoe Perches $dequoted =~ s/" </ </; 230020112475SJoe Perches # Don't force email to have quotes 230120112475SJoe Perches # Allow just an angle bracketed address 230220112475SJoe Perches if ("$dequoted$comment" ne $email && 230320112475SJoe Perches "<$email_address>$comment" ne $email && 230420112475SJoe Perches "$suggested_email$comment" ne $email) { 2305000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2306000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 230720112475SJoe Perches } 23080a920b5bSAndy Whitcroft } 23097e51f197SJoe Perches 23107e51f197SJoe Perches# Check for duplicate signatures 23117e51f197SJoe Perches my $sig_nospace = $line; 23127e51f197SJoe Perches $sig_nospace =~ s/\s//g; 23137e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 23147e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 23157e51f197SJoe Perches WARN("BAD_SIGN_OFF", 23167e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 23177e51f197SJoe Perches } else { 23187e51f197SJoe Perches $signatures{$sig_nospace} = 1; 23197e51f197SJoe Perches } 23200a920b5bSAndy Whitcroft } 23210a920b5bSAndy Whitcroft 2322a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2323a2fe16b9SJoe Perches if ($in_header_lines && 2324a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2325a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2326a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2327a2fe16b9SJoe Perches } 2328a2fe16b9SJoe Perches 23299b3189ebSJoe Perches# Check for old stable address 23309b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 23319b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 23329b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 23339b3189ebSJoe Perches } 23349b3189ebSJoe Perches 23357ebd05efSChristopher Covington# Check for unwanted Gerrit info 23367ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 23377ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 23387ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 23397ebd05efSChristopher Covington } 23407ebd05efSChristopher Covington 2341369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2342369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2343369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2344369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2345369c8dd3SJoe Perches # timestamp 2346369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2347369c8dd3SJoe Perches # stack dump address 2348369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2349369c8dd3SJoe Perches } 2350369c8dd3SJoe Perches 23512a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 23522a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2353bf4daf12SJoe Perches length($line) > 75 && 2354bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2355bf4daf12SJoe Perches # file delta changes 2356bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2357bf4daf12SJoe Perches # filename then : 2358bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2359bf4daf12SJoe Perches # A Fixes: or Link: line 2360bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 23612a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 23622a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 23632a076f40SJoe Perches $commit_log_long_line = 1; 23642a076f40SJoe Perches } 23652a076f40SJoe Perches 2366bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2367bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2368bf4daf12SJoe Perches $line =~ /^\s*$/) { 2369bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2370bf4daf12SJoe Perches } 2371bf4daf12SJoe Perches 23720d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2373369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2374fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2375bf4daf12SJoe Perches ($line =~ /\b[0-9a-f]{12,40}\b/i && 2376369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2377bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2378fe043ea1SJoe Perches my $init_char = "c"; 2379fe043ea1SJoe Perches my $orig_commit = ""; 23800d7835fcSJoe Perches my $short = 1; 23810d7835fcSJoe Perches my $long = 0; 23820d7835fcSJoe Perches my $case = 1; 23830d7835fcSJoe Perches my $space = 1; 23840d7835fcSJoe Perches my $hasdesc = 0; 238519c146a6SJoe Perches my $hasparens = 0; 23860d7835fcSJoe Perches my $id = '0123456789ab'; 23870d7835fcSJoe Perches my $orig_desc = "commit description"; 23880d7835fcSJoe Perches my $description = ""; 23890d7835fcSJoe Perches 2390fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2391fe043ea1SJoe Perches $init_char = $1; 2392fe043ea1SJoe Perches $orig_commit = lc($2); 2393fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2394fe043ea1SJoe Perches $orig_commit = lc($1); 2395fe043ea1SJoe Perches } 2396fe043ea1SJoe Perches 23970d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23980d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23990d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 24000d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 24010d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 24020d7835fcSJoe Perches $orig_desc = $1; 240319c146a6SJoe Perches $hasparens = 1; 24040d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 24050d7835fcSJoe Perches defined $rawlines[$linenr] && 24060d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 24070d7835fcSJoe Perches $orig_desc = $1; 240819c146a6SJoe Perches $hasparens = 1; 2409b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2410b671fde0SJoe Perches defined $rawlines[$linenr] && 2411b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2412b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2413b671fde0SJoe Perches $orig_desc = $1; 2414b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2415b671fde0SJoe Perches $orig_desc .= " " . $1; 241619c146a6SJoe Perches $hasparens = 1; 24170d7835fcSJoe Perches } 24180d7835fcSJoe Perches 24190d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 24200d7835fcSJoe Perches $id, $orig_desc); 24210d7835fcSJoe Perches 242219c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2423d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 24240d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 24250d7835fcSJoe Perches } 2426d311cd44SJoe Perches } 2427d311cd44SJoe Perches 242813f1937eSJoe Perches# Check for added, moved or deleted files 242913f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 243013f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 243113f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 243213f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 243313f1937eSJoe Perches (defined($1) || defined($2))))) { 243413f1937eSJoe Perches $reported_maintainer_file = 1; 243513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 243613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 243713f1937eSJoe Perches } 243813f1937eSJoe Perches 243900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 24408905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2441000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2442000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 24436c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2444de7d4f0eSAndy Whitcroft } 2445de7d4f0eSAndy Whitcroft 24466ecd9674SAndy Whitcroft# Check for absolute kernel paths. 24476ecd9674SAndy Whitcroft if ($tree) { 24486ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 24496ecd9674SAndy Whitcroft my $file = $1; 24506ecd9674SAndy Whitcroft 24516ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 24526ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 24536ecd9674SAndy Whitcroft # 24546ecd9674SAndy Whitcroft } else { 24556ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 24566ecd9674SAndy Whitcroft } 24576ecd9674SAndy Whitcroft } 24586ecd9674SAndy Whitcroft } 24596ecd9674SAndy Whitcroft 2460de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2461de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2462171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2463171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2464171ae1a4SAndy Whitcroft 2465171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2466171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2467171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2468171ae1a4SAndy Whitcroft 246934d99219SJoe Perches CHK("INVALID_UTF8", 2470000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 247100df344fSAndy Whitcroft } 24720a920b5bSAndy Whitcroft 247315662b3eSJoe Perches# Check if it's the start of a commit log 247415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 247515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 247629ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 247729ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 247815662b3eSJoe Perches $in_header_lines = 0; 247915662b3eSJoe Perches $in_commit_log = 1; 248015662b3eSJoe Perches } 248115662b3eSJoe Perches 2482fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2483fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2484fa64205dSPasi Savanainen if ($in_header_lines && 2485fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2486fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2487fa64205dSPasi Savanainen $non_utf8_charset = 1; 2488fa64205dSPasi Savanainen } 2489fa64205dSPasi Savanainen 2490fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 249115662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2492fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 249315662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 249415662b3eSJoe Perches } 249515662b3eSJoe Perches 249666b47b4aSKees Cook# Check for various typo / spelling mistakes 249766d7a382SJoe Perches if (defined($misspellings) && 249866d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2499ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 250066b47b4aSKees Cook my $typo = $1; 250166b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 250266b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 250366b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 250466b47b4aSKees Cook my $msg_type = \&WARN; 250566b47b4aSKees Cook $msg_type = \&CHK if ($file); 250666b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 250766b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 250866b47b4aSKees Cook $fix) { 250966b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 251066b47b4aSKees Cook } 251166b47b4aSKees Cook } 251266b47b4aSKees Cook } 251366b47b4aSKees Cook 251430670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 251530670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 251600df344fSAndy Whitcroft 25170a920b5bSAndy Whitcroft#trailing whitespace 25189c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2519c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2520d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2521d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2522d5e616fcSJoe Perches $fix) { 2523194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2524d5e616fcSJoe Perches } 2525c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2526c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25273705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 25283705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 25293705ce5bSJoe Perches $fix) { 2530194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 25313705ce5bSJoe Perches } 25323705ce5bSJoe Perches 2533d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25340a920b5bSAndy Whitcroft } 25355368df20SAndy Whitcroft 25364783f894SJosh Triplett# Check for FSF mailing addresses. 2537109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 25383e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 25393e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 25404783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25414783f894SJosh Triplett my $msg_type = \&ERROR; 25424783f894SJosh Triplett $msg_type = \&CHK if ($file); 25434783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 25444783f894SJosh 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) 25454783f894SJosh Triplett } 25464783f894SJosh Triplett 25473354957aSAndi Kleen# check for Kconfig help text having a real description 25489fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 25499fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 25503354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 25518d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 25523354957aSAndi Kleen my $length = 0; 25539fe287d7SAndy Whitcroft my $cnt = $realcnt; 25549fe287d7SAndy Whitcroft my $ln = $linenr + 1; 25559fe287d7SAndy Whitcroft my $f; 2556a1385803SAndy Whitcroft my $is_start = 0; 25579fe287d7SAndy Whitcroft my $is_end = 0; 2558a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 25599fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 25609fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 25619fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 25629fe287d7SAndy Whitcroft 25639fe287d7SAndy Whitcroft next if ($f =~ /^-/); 25648d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2565a1385803SAndy Whitcroft 25668d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2567a1385803SAndy Whitcroft $is_start = 1; 25688d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2569a1385803SAndy Whitcroft $length = -1; 2570a1385803SAndy Whitcroft } 2571a1385803SAndy Whitcroft 25729fe287d7SAndy Whitcroft $f =~ s/^.//; 25733354957aSAndi Kleen $f =~ s/#.*//; 25743354957aSAndi Kleen $f =~ s/^\s+//; 25753354957aSAndi Kleen next if ($f =~ /^$/); 25769fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 25779fe287d7SAndy Whitcroft $is_end = 1; 25789fe287d7SAndy Whitcroft last; 25799fe287d7SAndy Whitcroft } 25803354957aSAndi Kleen $length++; 25813354957aSAndi Kleen } 258256193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2583000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 258456193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 258556193274SVadim Bendebury } 2586a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25873354957aSAndi Kleen } 25883354957aSAndi Kleen 25891ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25901ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25911ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25921ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25931ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25941ba8dfd1SKees Cook } 25951ba8dfd1SKees Cook 2596327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2597327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2598327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2599327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2600327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2601327953e9SChristoph Jaeger } 2602327953e9SChristoph Jaeger 2603c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2604c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2605c68e5878SArnaud Lacombe my $flag = $1; 2606c68e5878SArnaud Lacombe my $replacement = { 2607c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2608c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2609c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2610c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2611c68e5878SArnaud Lacombe }; 2612c68e5878SArnaud Lacombe 2613c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2614c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2615c68e5878SArnaud Lacombe } 2616c68e5878SArnaud Lacombe 2617bff5da43SRob Herring# check for DT compatible documentation 26187dd05b38SFlorian Vaussard if (defined $root && 26197dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 26207dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 26217dd05b38SFlorian Vaussard 2622bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2623bff5da43SRob Herring 2624cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2625cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2626cc93319bSFlorian Vaussard 2627bff5da43SRob Herring foreach my $compat (@compats) { 2628bff5da43SRob Herring my $compat2 = $compat; 2629185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2630185d566bSRob Herring my $compat3 = $compat; 2631185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2632185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2633bff5da43SRob Herring if ( $? >> 8 ) { 2634bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2635bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2636bff5da43SRob Herring } 2637bff5da43SRob Herring 26384fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 26394fbf32a6SFlorian Vaussard my $vendor = $1; 2640cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2641bff5da43SRob Herring if ( $? >> 8 ) { 2642bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2643cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2644bff5da43SRob Herring } 2645bff5da43SRob Herring } 2646bff5da43SRob Herring } 2647bff5da43SRob Herring 26485368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2649de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 26505368df20SAndy Whitcroft 265147e0c88bSJoe Perches# line length limit (with some exclusions) 265247e0c88bSJoe Perches# 265347e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 265447e0c88bSJoe Perches# logging functions like pr_info that end in a string 265547e0c88bSJoe Perches# lines with a single string 265647e0c88bSJoe Perches# #defines that are a single string 265747e0c88bSJoe Perches# 265847e0c88bSJoe Perches# There are 3 different line length message types: 265947e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 266047e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 266147e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 266247e0c88bSJoe Perches# 266347e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 266447e0c88bSJoe Perches# 266547e0c88bSJoe Perches 2666b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 266747e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 266847e0c88bSJoe Perches 266947e0c88bSJoe Perches # Check the allowed long line types first 267047e0c88bSJoe Perches 267147e0c88bSJoe Perches # logging functions that end in a string that starts 267247e0c88bSJoe Perches # before $max_line_length 267347e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 267447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 267547e0c88bSJoe Perches $msg_type = ""; 267647e0c88bSJoe Perches 267747e0c88bSJoe Perches # lines with only strings (w/ possible termination) 267847e0c88bSJoe Perches # #defines with only strings 267947e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 268047e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 268147e0c88bSJoe Perches $msg_type = ""; 268247e0c88bSJoe Perches 268347e0c88bSJoe Perches # Otherwise set the alternate message types 268447e0c88bSJoe Perches 268547e0c88bSJoe Perches # a comment starts before $max_line_length 268647e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 268747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 268847e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 268947e0c88bSJoe Perches 269047e0c88bSJoe Perches # a quoted string starts before $max_line_length 269147e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 269247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 269347e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 269447e0c88bSJoe Perches } 269547e0c88bSJoe Perches 269647e0c88bSJoe Perches if ($msg_type ne "" && 269747e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 269847e0c88bSJoe Perches WARN($msg_type, 26996cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 27000a920b5bSAndy Whitcroft } 270147e0c88bSJoe Perches } 27020a920b5bSAndy Whitcroft 27038905a67cSAndy Whitcroft# check for adding lines without a newline. 27048905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2705000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2706000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 27078905a67cSAndy Whitcroft } 27088905a67cSAndy Whitcroft 270942e41c54SMike Frysinger# Blackfin: use hi/lo macros 271042e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 271142e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 271242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2713000d1cc1SJoe Perches ERROR("LO_MACRO", 2714000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 271542e41c54SMike Frysinger } 271642e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 271742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2718000d1cc1SJoe Perches ERROR("HI_MACRO", 2719000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 272042e41c54SMike Frysinger } 272142e41c54SMike Frysinger } 272242e41c54SMike Frysinger 2723b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2724de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 27250a920b5bSAndy Whitcroft 27260a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 27270a920b5bSAndy Whitcroft# more than 8 must use tabs. 2728c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2729c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2730c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2731d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27323705ce5bSJoe Perches if (ERROR("CODE_INDENT", 27333705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 27343705ce5bSJoe Perches $fix) { 2735194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27363705ce5bSJoe Perches } 27370a920b5bSAndy Whitcroft } 27380a920b5bSAndy Whitcroft 273908e44365SAlberto Panizzo# check for space before tabs. 274008e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 274108e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27423705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 27433705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 27443705ce5bSJoe Perches $fix) { 2745194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2746d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2747194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2748c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 27493705ce5bSJoe Perches } 275008e44365SAlberto Panizzo } 275108e44365SAlberto Panizzo 2752d1fe9c09SJoe Perches# check for && or || at the start of a line 2753d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2754d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2755d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2756d1fe9c09SJoe Perches } 2757d1fe9c09SJoe Perches 2758d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2759d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 276091cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2761d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2762d1fe9c09SJoe Perches my $oldindent = $1; 2763d1fe9c09SJoe Perches my $rest = $2; 2764d1fe9c09SJoe Perches 2765d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2766d1fe9c09SJoe Perches if ($pos >= 0) { 2767b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2768b34a26f3SJoe Perches my $newindent = $2; 2769d1fe9c09SJoe Perches 2770d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2771d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2772d1fe9c09SJoe Perches " " x ($pos % 8); 2773d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2774d1fe9c09SJoe Perches 2775d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2776d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 27773705ce5bSJoe Perches 27783705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 27793705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27803705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2781194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27823705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27833705ce5bSJoe Perches } 2784d1fe9c09SJoe Perches } 2785d1fe9c09SJoe Perches } 2786d1fe9c09SJoe Perches } 2787d1fe9c09SJoe Perches 27886ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27896ab3a970SJoe Perches# avoid checking a few false positives: 27906ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27916ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27926ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27936ab3a970SJoe Perches# multiline macros that define functions 27946ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27956ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27966ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27973705ce5bSJoe Perches if (CHK("SPACING", 2798f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27993705ce5bSJoe Perches $fix) { 2800194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2801f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 28023705ce5bSJoe Perches } 2803aad4f614SJoe Perches } 2804aad4f614SJoe Perches 280586406b1cSJoe Perches# Block comment styles 280686406b1cSJoe Perches# Networking with an initial /* 280705880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2808fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 280985ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 281085ad978cSJoe Perches $realline > 2) { 281105880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 281205880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 281305880600SJoe Perches } 281405880600SJoe Perches 281586406b1cSJoe Perches# Block comments use * on subsequent lines 281686406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 281786406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2818a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 281961135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2820a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 282186406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 282286406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2823a605e32eSJoe Perches } 2824a605e32eSJoe Perches 282586406b1cSJoe Perches# Block comments use */ on trailing lines 282686406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2827c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2828c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2829c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 283086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 283186406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 283205880600SJoe Perches } 283305880600SJoe Perches 28347f619191SJoe Perches# check for missing blank lines after struct/union declarations 28357f619191SJoe Perches# with exceptions for various attributes and macros 28367f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 28377f619191SJoe Perches $line =~ /^\+/ && 28387f619191SJoe Perches !($line =~ /^\+\s*$/ || 28397f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 28407f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 28417f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 28427f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 28437f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 28447f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 28457f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2846d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2847d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2848d752fcc8SJoe Perches $fix) { 2849f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2850d752fcc8SJoe Perches } 28517f619191SJoe Perches } 28527f619191SJoe Perches 2853365dd4eaSJoe Perches# check for multiple consecutive blank lines 2854365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2855365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2856365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2857d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2858d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2859d752fcc8SJoe Perches $fix) { 2860f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2861d752fcc8SJoe Perches } 2862d752fcc8SJoe Perches 2863365dd4eaSJoe Perches $last_blank_line = $linenr; 2864365dd4eaSJoe Perches } 2865365dd4eaSJoe Perches 28663b617e3bSJoe Perches# check for missing blank lines after declarations 28673f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 28683f7bac03SJoe Perches # actual declarations 28693f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28705a4e1fd3SJoe Perches # function pointer declarations 28715a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28723f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28733f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28743f7bac03SJoe Perches # known declaration macros 28753f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 28763f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 28773f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 28783f7bac03SJoe Perches # other possible extensions of declaration lines 28793f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 28803f7bac03SJoe Perches # not starting a section or a macro "\" extended line 28813f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 28823f7bac03SJoe Perches # looks like a declaration 28833f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28845a4e1fd3SJoe Perches # function pointer declarations 28855a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28863f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28873f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28883f7bac03SJoe Perches # known declaration macros 28893f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28903f7bac03SJoe Perches # start of struct or union or enum 28913b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28923f7bac03SJoe Perches # start or end of block or continuation of declaration 28933f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28943f7bac03SJoe Perches # bitfield continuation 28953f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28963f7bac03SJoe Perches # other possible extensions of declaration lines 28973f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28983f7bac03SJoe Perches # indentation of previous and current line are the same 28993f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2900d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2901d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2902d752fcc8SJoe Perches $fix) { 2903f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2904d752fcc8SJoe Perches } 29053b617e3bSJoe Perches } 29063b617e3bSJoe Perches 29075f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 29086b4c5bebSAndy Whitcroft# Exceptions: 29096b4c5bebSAndy Whitcroft# 1) within comments 29106b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 29116b4c5bebSAndy Whitcroft# 3) hanging labels 29123705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 29135f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 29143705ce5bSJoe Perches if (WARN("LEADING_SPACE", 29153705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 29163705ce5bSJoe Perches $fix) { 2917194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 29183705ce5bSJoe Perches } 29195f7ddae6SRaffaele Recalcati } 29205f7ddae6SRaffaele Recalcati 2921b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2922b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2923b9ea10d6SAndy Whitcroft 2924032a4c0fSJoe Perches# check indentation of any line with a bare else 2925840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2926032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2927032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2928032a4c0fSJoe Perches my $tabs = length($1) + 1; 2929840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2930840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2931840080a0SJoe Perches defined $lines[$linenr] && 2932840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2933032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2934032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2935032a4c0fSJoe Perches } 2936032a4c0fSJoe Perches } 2937032a4c0fSJoe Perches 2938c00df19aSJoe Perches# check indentation of a line with a break; 2939c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2940c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2941c00df19aSJoe Perches my $tabs = $1; 2942c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2943c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2944c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2945c00df19aSJoe Perches } 2946c00df19aSJoe Perches } 2947c00df19aSJoe Perches 29481ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 29491ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 29501ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 29511ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 29521ba8dfd1SKees Cook } 29531ba8dfd1SKees Cook 2954c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2955cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2956000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2957000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2958c2fdda0dSAndy Whitcroft } 295922f2a2efSAndy Whitcroft 296042e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 296142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 296242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2963000d1cc1SJoe Perches ERROR("CSYNC", 2964000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 296542e41c54SMike Frysinger } 296642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 296742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2968000d1cc1SJoe Perches ERROR("SSYNC", 2969000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 297042e41c54SMike Frysinger } 297142e41c54SMike Frysinger 297256e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 297356e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 297456e77d70SJoe Perches WARN("HOTPLUG_SECTION", 297556e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 297656e77d70SJoe Perches } 297756e77d70SJoe Perches 29789c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 29792b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 29802b474a1aSAndy Whitcroft $realline_next); 29813e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 29823e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29831b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2984170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2985f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2986171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2987171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2988171ae1a4SAndy Whitcroft 29893e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29903e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29913e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29923e469cdcSAndy Whitcroft # until we hit end of it. 29933e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29943e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29953e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29963e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29973e469cdcSAndy Whitcroft } 2998f74bd194SAndy Whitcroft 29992b474a1aSAndy Whitcroft # Find the real next line. 30002b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 30012b474a1aSAndy Whitcroft if (defined $realline_next && 30022b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 30032b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 30042b474a1aSAndy Whitcroft $realline_next++; 30052b474a1aSAndy Whitcroft } 30062b474a1aSAndy Whitcroft 3007171ae1a4SAndy Whitcroft my $s = $stat; 3008171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3009cf655043SAndy Whitcroft 3010c2fdda0dSAndy Whitcroft # Ignore goto labels. 3011171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3012c2fdda0dSAndy Whitcroft 3013c2fdda0dSAndy Whitcroft # Ignore functions being called 3014171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3015c2fdda0dSAndy Whitcroft 3016463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3017463f2864SAndy Whitcroft 3018c45dcabdSAndy Whitcroft # declarations always start with types 3019d2506586SAndy 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) { 3020c45dcabdSAndy Whitcroft my $type = $1; 3021c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3022c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3023c45dcabdSAndy Whitcroft 30246c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3025a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3026c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3027c2fdda0dSAndy Whitcroft } 30288905a67cSAndy Whitcroft 30296c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 303065863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3031c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 30329c0ca6f9SAndy Whitcroft } 30338905a67cSAndy Whitcroft 30348905a67cSAndy Whitcroft # Check for any sort of function declaration. 30358905a67cSAndy Whitcroft # int foo(something bar, other baz); 30368905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3037171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 30388905a67cSAndy Whitcroft my ($name_len) = length($1); 30398905a67cSAndy Whitcroft 3040cf655043SAndy Whitcroft my $ctx = $s; 3041773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 30428905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3043cf655043SAndy Whitcroft 30448905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3045c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 30468905a67cSAndy Whitcroft 3047c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 30488905a67cSAndy Whitcroft } 30498905a67cSAndy Whitcroft } 30508905a67cSAndy Whitcroft } 30518905a67cSAndy Whitcroft 30529c0ca6f9SAndy Whitcroft } 30539c0ca6f9SAndy Whitcroft 305400df344fSAndy Whitcroft# 305500df344fSAndy Whitcroft# Checks which may be anchored in the context. 305600df344fSAndy Whitcroft# 305700df344fSAndy Whitcroft 305800df344fSAndy Whitcroft# Check for switch () and associated case and default 305900df344fSAndy Whitcroft# statements should be at the same indent. 306000df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 306100df344fSAndy Whitcroft my $err = ''; 306200df344fSAndy Whitcroft my $sep = ''; 306300df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 306400df344fSAndy Whitcroft shift(@ctx); 306500df344fSAndy Whitcroft for my $ctx (@ctx) { 306600df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 306700df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 306800df344fSAndy Whitcroft $indent != $cindent) { 306900df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 307000df344fSAndy Whitcroft $sep = ''; 307100df344fSAndy Whitcroft } else { 307200df344fSAndy Whitcroft $sep = "[...]\n"; 307300df344fSAndy Whitcroft } 307400df344fSAndy Whitcroft } 307500df344fSAndy Whitcroft if ($err ne '') { 3076000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3077000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3078de7d4f0eSAndy Whitcroft } 3079de7d4f0eSAndy Whitcroft } 3080de7d4f0eSAndy Whitcroft 3081de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3082de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30830fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3084773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3085773647a0SAndy Whitcroft 30869c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30878eef05ddSJoe Perches 30888eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30898eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30908eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30918eef05ddSJoe Perches } 30928eef05ddSJoe Perches 3093de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3094de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3095de7d4f0eSAndy Whitcroft 3096548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3097548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3098de7d4f0eSAndy Whitcroft 3099548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3100548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3101548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3102548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3103548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3104773647a0SAndy Whitcroft $ctx_ln++; 3105773647a0SAndy Whitcroft } 3106548596d5SAndy Whitcroft 310753210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 310853210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3109773647a0SAndy Whitcroft 3110773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3111000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3112000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 311301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 311400df344fSAndy Whitcroft } 3115773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3116773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3117773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3118773647a0SAndy Whitcroft { 31199c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 31209c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3121000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3122000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 312301464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 31249c0ca6f9SAndy Whitcroft } 31259c0ca6f9SAndy Whitcroft } 312600df344fSAndy Whitcroft } 312700df344fSAndy Whitcroft 31284d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 31290fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 31303e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 31313e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 31323e469cdcSAndy Whitcroft if (!defined $stat); 31334d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 31344d001e4dSAndy Whitcroft 31354d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 31364d001e4dSAndy Whitcroft 31379f5af480SJoe Perches # remove inline comments 31389f5af480SJoe Perches $s =~ s/$;/ /g; 31399f5af480SJoe Perches $c =~ s/$;/ /g; 31404d001e4dSAndy Whitcroft 31414d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 31426f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 31436f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 31444d001e4dSAndy Whitcroft 31459f5af480SJoe Perches # Make sure we remove the line prefixes as we have 31469f5af480SJoe Perches # none on the first line, and are going to readd them 31479f5af480SJoe Perches # where necessary. 31489f5af480SJoe Perches $s =~ s/\n./\n/gs; 31499f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 31509f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 31519f5af480SJoe Perches } 31529f5af480SJoe Perches 31534d001e4dSAndy Whitcroft # We want to check the first line inside the block 31544d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 31554d001e4dSAndy Whitcroft # 1) any blank line termination 31564d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 31574d001e4dSAndy Whitcroft # 3) any do (...) { 31584d001e4dSAndy Whitcroft my $continuation = 0; 31594d001e4dSAndy Whitcroft my $check = 0; 31604d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 31614d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 31624d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 31634d001e4dSAndy Whitcroft $continuation = 1; 31644d001e4dSAndy Whitcroft } 31659bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 31664d001e4dSAndy Whitcroft $check = 1; 31674d001e4dSAndy Whitcroft $cond_lines++; 31684d001e4dSAndy Whitcroft } 31694d001e4dSAndy Whitcroft 31704d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 31714d001e4dSAndy Whitcroft # preprocessor statement. 31724d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 31734d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 31744d001e4dSAndy Whitcroft $check = 0; 31754d001e4dSAndy Whitcroft } 31764d001e4dSAndy Whitcroft 31779bd49efeSAndy Whitcroft my $cond_ptr = -1; 3178740504c6SAndy Whitcroft $continuation = 0; 31799bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 31809bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 31814d001e4dSAndy Whitcroft 3182f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3183f16fa28fSAndy Whitcroft # is not linear. 3184f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3185f16fa28fSAndy Whitcroft $check = 0; 3186f16fa28fSAndy Whitcroft } 3187f16fa28fSAndy Whitcroft 31889bd49efeSAndy Whitcroft # Ignore: 31899bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31909bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31919bd49efeSAndy Whitcroft # 3) labels. 3192740504c6SAndy Whitcroft if ($continuation || 3193740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31949bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31959bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3196740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 319730dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31989bd49efeSAndy Whitcroft $cond_lines++; 31999bd49efeSAndy Whitcroft } 32004d001e4dSAndy Whitcroft } 320130dad6ebSAndy Whitcroft } 32024d001e4dSAndy Whitcroft 32034d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 32044d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 32054d001e4dSAndy Whitcroft 32064d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 32074d001e4dSAndy Whitcroft # this is not this patch's fault. 32084d001e4dSAndy Whitcroft if (!defined($stat_real) || 32094d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 32104d001e4dSAndy Whitcroft $check = 0; 32114d001e4dSAndy Whitcroft } 32124d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 32134d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 32144d001e4dSAndy Whitcroft } 32154d001e4dSAndy Whitcroft 32169bd49efeSAndy 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"; 32174d001e4dSAndy Whitcroft 32189f5af480SJoe Perches if ($check && $s ne '' && 32199f5af480SJoe Perches (($sindent % 8) != 0 || 32209f5af480SJoe Perches ($sindent < $indent) || 32219f5af480SJoe Perches ($sindent > $indent + 8))) { 3222000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3223000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 32244d001e4dSAndy Whitcroft } 32254d001e4dSAndy Whitcroft } 32264d001e4dSAndy Whitcroft 32276c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 32286c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 32291f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 32301f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 32316c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3232c2fdda0dSAndy Whitcroft if ($dbg_values) { 3233c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3234cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3235cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 32361f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3237c2fdda0dSAndy Whitcroft } 32386c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 32396c72ffaaSAndy Whitcroft 324000df344fSAndy Whitcroft#ignore lines not being added 32413705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 324200df344fSAndy Whitcroft 3243653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 32447429c690SAndy Whitcroft if ($dbg_type) { 32457429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3246000d1cc1SJoe Perches ERROR("TEST_TYPE", 3247000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 32487429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3249000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3250000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 32517429c690SAndy Whitcroft } 3252653d4876SAndy Whitcroft next; 3253653d4876SAndy Whitcroft } 3254a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3255a1ef277eSAndy Whitcroft if ($dbg_attr) { 32569360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3257000d1cc1SJoe Perches ERROR("TEST_ATTR", 3258000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 32599360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3260000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3261000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3262a1ef277eSAndy Whitcroft } 3263a1ef277eSAndy Whitcroft next; 3264a1ef277eSAndy Whitcroft } 3265653d4876SAndy Whitcroft 3266f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 326799423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 326899423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3269d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3270d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3271f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3272f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3273f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3274d752fcc8SJoe Perches my $fixedline = $prevrawline; 3275d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3276f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3277d752fcc8SJoe Perches $fixedline = $line; 3278d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3279f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3280d752fcc8SJoe Perches } 3281f0a594c1SAndy Whitcroft } 3282f0a594c1SAndy Whitcroft 328300df344fSAndy Whitcroft# 328400df344fSAndy Whitcroft# Checks which are anchored on the added line. 328500df344fSAndy Whitcroft# 328600df344fSAndy Whitcroft 3287653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3288c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3289653d4876SAndy Whitcroft my $path = $1; 3290653d4876SAndy Whitcroft if ($path =~ m{//}) { 3291000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3292495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3293495e9d84SJoe Perches } 3294495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3295495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3296495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3297653d4876SAndy Whitcroft } 3298653d4876SAndy Whitcroft } 3299653d4876SAndy Whitcroft 330000df344fSAndy Whitcroft# no C99 // comments 330100df344fSAndy Whitcroft if ($line =~ m{//}) { 33023705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 33033705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 33043705ce5bSJoe Perches $fix) { 3305194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 33063705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 33073705ce5bSJoe Perches my $comment = trim($1); 3308194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 33093705ce5bSJoe Perches } 33103705ce5bSJoe Perches } 331100df344fSAndy Whitcroft } 331200df344fSAndy Whitcroft # Remove C99 comments. 33130a920b5bSAndy Whitcroft $line =~ s@//.*@@; 33146c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 33150a920b5bSAndy Whitcroft 33162b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 33172b474a1aSAndy Whitcroft# the whole statement. 33182b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 33192b474a1aSAndy Whitcroft if (defined $realline_next && 33202b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 33212b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 33222b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33232b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33243cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 33253cbf62dfSAndy Whitcroft # a prefix: 33263cbf62dfSAndy Whitcroft # XXX(foo); 33273cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3328653d4876SAndy Whitcroft my $name = $1; 332987a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 33303cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 33313cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 33323cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 33333cbf62dfSAndy Whitcroft 33343cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 33352b474a1aSAndy Whitcroft \n.}\s*$| 333648012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 333748012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 333848012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 33392b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 33402b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 334148012058SAndy Whitcroft )/x) { 33422b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 33432b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 33442b474a1aSAndy Whitcroft } else { 33452b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 33460a920b5bSAndy Whitcroft } 33470a920b5bSAndy Whitcroft } 33482b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 33492b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 33502b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33512b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33522b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 33532b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 33542b474a1aSAndy Whitcroft } 33552b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 33562b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3357000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3358000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 33592b474a1aSAndy Whitcroft } 33600a920b5bSAndy Whitcroft 33615150bda4SJoe Eloff# check for global initialisers. 33626d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3363d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 33646d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3365d5e616fcSJoe Perches $fix) { 33666d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3367d5e616fcSJoe Perches } 3368f0a594c1SAndy Whitcroft } 33690a920b5bSAndy Whitcroft# check for static initialisers. 33706d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3371d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 33726d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3373d5e616fcSJoe Perches $herecurr) && 3374d5e616fcSJoe Perches $fix) { 33756d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3376d5e616fcSJoe Perches } 33770a920b5bSAndy Whitcroft } 33780a920b5bSAndy Whitcroft 33791813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 33801813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 33811813087dSJoe Perches my $tmp = trim($1); 33821813087dSJoe Perches WARN("MISORDERED_TYPE", 33831813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 33841813087dSJoe Perches } 33851813087dSJoe Perches 3386cb710ecaSJoe Perches# check for static const char * arrays. 3387cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3388000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3389000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3390cb710ecaSJoe Perches $herecurr); 3391cb710ecaSJoe Perches } 3392cb710ecaSJoe Perches 3393cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3394cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3395000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3396000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3397cb710ecaSJoe Perches $herecurr); 3398cb710ecaSJoe Perches } 3399cb710ecaSJoe Perches 3400ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3401ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3402ab7e23f3SJoe Perches my $found = $1; 3403ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3404ab7e23f3SJoe Perches WARN("CONST_CONST", 3405ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3406ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3407ab7e23f3SJoe Perches WARN("CONST_CONST", 3408ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3409ab7e23f3SJoe Perches } 3410ab7e23f3SJoe Perches } 3411ab7e23f3SJoe Perches 34129b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 34139b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 34149b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 34159b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 34169b0fa60dSJoe Perches $herecurr); 34179b0fa60dSJoe Perches } 34189b0fa60dSJoe Perches 3419b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3420b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3421b598b670SJoe Perches my $array = $1; 3422b598b670SJoe 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*\))@) { 3423b598b670SJoe Perches my $array_div = $1; 3424b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3425b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3426b598b670SJoe Perches $fix) { 3427b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3428b598b670SJoe Perches } 3429b598b670SJoe Perches } 3430b598b670SJoe Perches } 3431b598b670SJoe Perches 3432b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3433b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3434b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3435b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3436b36190c5SJoe Perches $fix) { 3437194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3438b36190c5SJoe Perches } 3439b36190c5SJoe Perches } 3440b36190c5SJoe Perches 344192e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 344292e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 344392e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 344492e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 344592e112fdSJoe Perches $fix) { 3446194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 344792e112fdSJoe Perches } 344893ed0e2dSJoe Perches } 344993ed0e2dSJoe Perches 3450653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3451653d4876SAndy Whitcroft# make sense. 3452653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 34538054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3454c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 34558ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3456653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3457000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3458000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 34590a920b5bSAndy Whitcroft } 34600a920b5bSAndy Whitcroft 34610a920b5bSAndy Whitcroft# * goes on variable not on type 346265863862SAndy Whitcroft # (char*[ const]) 3463bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3464bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 34653705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3466d8aaf121SAndy Whitcroft 346765863862SAndy Whitcroft # Should start with a space. 346865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 346965863862SAndy Whitcroft # Should not end with a space. 347065863862SAndy Whitcroft $to =~ s/\s+$//; 347165863862SAndy Whitcroft # '*'s should not have spaces between. 3472f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 347365863862SAndy Whitcroft } 3474d8aaf121SAndy Whitcroft 34753705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 347665863862SAndy Whitcroft if ($from ne $to) { 34773705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34783705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 34793705ce5bSJoe Perches $fix) { 34803705ce5bSJoe Perches my $sub_from = $ident; 34813705ce5bSJoe Perches my $sub_to = $ident; 34823705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3483194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34843705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34853705ce5bSJoe Perches } 348665863862SAndy Whitcroft } 3487bfcb2cc7SAndy Whitcroft } 3488bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3489bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 34903705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3491d8aaf121SAndy Whitcroft 349265863862SAndy Whitcroft # Should start with a space. 349365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 349465863862SAndy Whitcroft # Should not end with a space. 349565863862SAndy Whitcroft $to =~ s/\s+$//; 349665863862SAndy Whitcroft # '*'s should not have spaces between. 3497f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 349865863862SAndy Whitcroft } 349965863862SAndy Whitcroft # Modifiers should have spaces. 350065863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 350165863862SAndy Whitcroft 35023705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3503667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 35043705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 35053705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 35063705ce5bSJoe Perches $fix) { 35073705ce5bSJoe Perches 35083705ce5bSJoe Perches my $sub_from = $match; 35093705ce5bSJoe Perches my $sub_to = $match; 35103705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3511194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35123705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 35133705ce5bSJoe Perches } 351465863862SAndy Whitcroft } 35150a920b5bSAndy Whitcroft } 35160a920b5bSAndy Whitcroft 35179d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 35189d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 35199d3e3c70SJoe Perches my $msg_type = \&WARN; 35209d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 35219d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 35229d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 35239d3e3c70SJoe Perches } 35240a920b5bSAndy Whitcroft 35259d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 35268905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3527000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3528000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 35298905a67cSAndy Whitcroft } 35308905a67cSAndy Whitcroft 353117441227SJoe Perches# check for uses of printk_ratelimit 353217441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3533000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3534000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 353517441227SJoe Perches } 353617441227SJoe Perches 353700df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 353800df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 353900df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 354025985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 354100df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3542f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 354300df344fSAndy Whitcroft my $ok = 0; 354400df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 354500df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 354625985edcSLucas De Marchi # we have a preceding printk if it ends 354700df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 354800df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 354900df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 355000df344fSAndy Whitcroft $ok = 1; 355100df344fSAndy Whitcroft } 355200df344fSAndy Whitcroft last; 355300df344fSAndy Whitcroft } 355400df344fSAndy Whitcroft } 355500df344fSAndy Whitcroft if ($ok == 0) { 3556000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3557000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 35580a920b5bSAndy Whitcroft } 355900df344fSAndy Whitcroft } 35600a920b5bSAndy Whitcroft 3561243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3562243f3803SJoe Perches my $orig = $1; 3563243f3803SJoe Perches my $level = lc($orig); 3564243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 35658f26b837SJoe Perches my $level2 = $level; 35668f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3567243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3568daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3569243f3803SJoe Perches } 3570243f3803SJoe Perches 3571243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3572d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3573d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3574d5e616fcSJoe Perches $fix) { 3575194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3576d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3577d5e616fcSJoe Perches } 3578243f3803SJoe Perches } 3579243f3803SJoe Perches 3580dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3581dc139313SJoe Perches my $orig = $1; 3582dc139313SJoe Perches my $level = lc($orig); 3583dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3584dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3585dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3586dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3587dc139313SJoe Perches } 3588dc139313SJoe Perches 358991c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 359091c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 359191c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 359291c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 359391c9afafSAndy Lutomirski WARN("ENOSYS", 359491c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 359591c9afafSAndy Lutomirski } 359691c9afafSAndy Lutomirski 3597653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3598653d4876SAndy Whitcroft# or if closed on same line 35998d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 36004e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 36018d182478SJoe Perches if (ERROR("OPEN_BRACE", 36028d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 36038d182478SJoe Perches $fix) { 36048d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 36058d182478SJoe Perches my $fixed_line = $rawline; 36068d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 36078d182478SJoe Perches my $line1 = $1; 36088d182478SJoe Perches my $line2 = $2; 36098d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 36108d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 36118d182478SJoe Perches if ($line2 !~ /^\s*$/) { 36128d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 36138d182478SJoe Perches } 36148d182478SJoe Perches } 36150a920b5bSAndy Whitcroft } 3616653d4876SAndy Whitcroft 36178905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 36188905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 36198905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 36208d182478SJoe Perches if (ERROR("OPEN_BRACE", 36218d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 36228d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 36238d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 36248d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 36258d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 36268d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36278d182478SJoe Perches $fixedline = $rawline; 36288d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 36298d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 36308d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36318d182478SJoe Perches } 36328d182478SJoe Perches } 36338905a67cSAndy Whitcroft } 36348905a67cSAndy Whitcroft 36350c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 36363705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 36373705ce5bSJoe Perches if (WARN("SPACING", 36383705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 36393705ce5bSJoe Perches $fix) { 3640194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36413705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 36423705ce5bSJoe Perches } 36430c73b4ebSAndy Whitcroft } 36440c73b4ebSAndy Whitcroft 364531070b5dSJoe Perches# Function pointer declarations 364631070b5dSJoe Perches# check spacing between type, funcptr, and args 364731070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 364891f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 364931070b5dSJoe Perches my $declare = $1; 365031070b5dSJoe Perches my $pre_pointer_space = $2; 365131070b5dSJoe Perches my $post_pointer_space = $3; 365231070b5dSJoe Perches my $funcname = $4; 365331070b5dSJoe Perches my $post_funcname_space = $5; 365431070b5dSJoe Perches my $pre_args_space = $6; 365531070b5dSJoe Perches 365691f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 365791f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 365891f72e9cSJoe Perches# don't need a space so don't warn for those. 365991f72e9cSJoe Perches my $post_declare_space = ""; 366091f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 366191f72e9cSJoe Perches $post_declare_space = $1; 366291f72e9cSJoe Perches $declare = rtrim($declare); 366391f72e9cSJoe Perches } 366491f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 366531070b5dSJoe Perches WARN("SPACING", 366631070b5dSJoe Perches "missing space after return type\n" . $herecurr); 366791f72e9cSJoe Perches $post_declare_space = " "; 366831070b5dSJoe Perches } 366931070b5dSJoe Perches 367031070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 367191f72e9cSJoe Perches# This test is not currently implemented because these declarations are 367291f72e9cSJoe Perches# equivalent to 367391f72e9cSJoe Perches# int foo(int bar, ...) 367491f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 367591f72e9cSJoe Perches# 367691f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 367791f72e9cSJoe Perches# WARN("SPACING", 367891f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 367991f72e9cSJoe Perches# } 368031070b5dSJoe Perches 368131070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 368231070b5dSJoe Perches if (defined $pre_pointer_space && 368331070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 368431070b5dSJoe Perches WARN("SPACING", 368531070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 368631070b5dSJoe Perches } 368731070b5dSJoe Perches 368831070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 368931070b5dSJoe Perches if (defined $post_pointer_space && 369031070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 369131070b5dSJoe Perches WARN("SPACING", 369231070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 369331070b5dSJoe Perches } 369431070b5dSJoe Perches 369531070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 369631070b5dSJoe Perches if (defined $post_funcname_space && 369731070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 369831070b5dSJoe Perches WARN("SPACING", 369931070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 370031070b5dSJoe Perches } 370131070b5dSJoe Perches 370231070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 370331070b5dSJoe Perches if (defined $pre_args_space && 370431070b5dSJoe Perches $pre_args_space =~ /^\s/) { 370531070b5dSJoe Perches WARN("SPACING", 370631070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 370731070b5dSJoe Perches } 370831070b5dSJoe Perches 370931070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3710194f66fcSJoe Perches $fixed[$fixlinenr] =~ 371191f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 371231070b5dSJoe Perches } 371331070b5dSJoe Perches } 371431070b5dSJoe Perches 37158d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 37168d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3717fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3718fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 37198d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 37208d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 37218d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3722fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3723daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 37243705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 37253705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 37263705ce5bSJoe Perches $fix) { 3727194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37283705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 37293705ce5bSJoe Perches } 37308d31cfceSAndy Whitcroft } 37318d31cfceSAndy Whitcroft } 37328d31cfceSAndy Whitcroft 3733f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 37346c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3735c2fdda0dSAndy Whitcroft my $name = $1; 3736773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3737773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3738c2fdda0dSAndy Whitcroft 3739c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3740773647a0SAndy Whitcroft if ($name =~ /^(?: 3741773647a0SAndy Whitcroft if|for|while|switch|return|case| 3742773647a0SAndy Whitcroft volatile|__volatile__| 3743773647a0SAndy Whitcroft __attribute__|format|__extension__| 3744773647a0SAndy Whitcroft asm|__asm__)$/x) 3745773647a0SAndy Whitcroft { 3746c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3747c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3748c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3749c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3750773647a0SAndy Whitcroft 3751773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3752c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3753c2fdda0dSAndy Whitcroft 3754c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3755c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3756773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3757c2fdda0dSAndy Whitcroft 3758c2fdda0dSAndy Whitcroft } else { 37593705ce5bSJoe Perches if (WARN("SPACING", 37603705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 37613705ce5bSJoe Perches $fix) { 3762194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37633705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 37643705ce5bSJoe Perches } 3765f0a594c1SAndy Whitcroft } 37666c72ffaaSAndy Whitcroft } 37679a4cad4eSEric Nelson 3768653d4876SAndy Whitcroft# Check operator spacing. 37690a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 37703705ce5bSJoe Perches my $fixed_line = ""; 37713705ce5bSJoe Perches my $line_fixed = 0; 37723705ce5bSJoe Perches 37739c0ca6f9SAndy Whitcroft my $ops = qr{ 37749c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 37759c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 37769c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 37771f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 377884731623SJoe Perches \?:|\?|: 37799c0ca6f9SAndy Whitcroft }x; 3780cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 37813705ce5bSJoe Perches 37823705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 37833705ce5bSJoe Perches## foreach my $el (@elements) { 37843705ce5bSJoe Perches## print("el: <$el>\n"); 37853705ce5bSJoe Perches## } 37863705ce5bSJoe Perches 37873705ce5bSJoe Perches my @fix_elements = (); 378800df344fSAndy Whitcroft my $off = 0; 37896c72ffaaSAndy Whitcroft 37903705ce5bSJoe Perches foreach my $el (@elements) { 37913705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 37923705ce5bSJoe Perches $off += length($el); 37933705ce5bSJoe Perches } 37943705ce5bSJoe Perches 37953705ce5bSJoe Perches $off = 0; 37963705ce5bSJoe Perches 37976c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3798b34c648bSJoe Perches my $last_after = -1; 37996c72ffaaSAndy Whitcroft 38000a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 38013705ce5bSJoe Perches 38023705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 38033705ce5bSJoe Perches 38043705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 38053705ce5bSJoe Perches 38064a0df2efSAndy Whitcroft $off += length($elements[$n]); 38074a0df2efSAndy Whitcroft 380825985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3809773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3810773647a0SAndy Whitcroft my $cc = ''; 3811773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3812773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3813773647a0SAndy Whitcroft } 3814773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3815773647a0SAndy Whitcroft 38164a0df2efSAndy Whitcroft my $a = ''; 38174a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 38184a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3819cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 38204a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 38214a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3822773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 38234a0df2efSAndy Whitcroft 38240a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 38254a0df2efSAndy Whitcroft 38264a0df2efSAndy Whitcroft my $c = ''; 38270a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 38284a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 38294a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3830cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 38314a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 38324a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 38338b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 38344a0df2efSAndy Whitcroft } else { 38354a0df2efSAndy Whitcroft $c = 'E'; 38360a920b5bSAndy Whitcroft } 38370a920b5bSAndy Whitcroft 38384a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 38394a0df2efSAndy Whitcroft 38404a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 38414a0df2efSAndy Whitcroft 38426c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3843de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 38440a920b5bSAndy Whitcroft 384574048ed8SAndy Whitcroft # Pull out the value of this operator. 38466c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 38470a920b5bSAndy Whitcroft 38481f65f947SAndy Whitcroft # Get the full operator variant. 38491f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 38501f65f947SAndy Whitcroft 385113214adfSAndy Whitcroft # Ignore operators passed as parameters. 385213214adfSAndy Whitcroft if ($op_type ne 'V' && 3853d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 385413214adfSAndy Whitcroft 3855cf655043SAndy Whitcroft# # Ignore comments 3856cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 385713214adfSAndy Whitcroft 3858d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 385913214adfSAndy Whitcroft } elsif ($op eq ';') { 3860cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3861cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 38623705ce5bSJoe Perches if (ERROR("SPACING", 38633705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3864b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38653705ce5bSJoe Perches $line_fixed = 1; 38663705ce5bSJoe Perches } 3867d8aaf121SAndy Whitcroft } 3868d8aaf121SAndy Whitcroft 3869d8aaf121SAndy Whitcroft # // is a comment 3870d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 38710a920b5bSAndy Whitcroft 3872b00e4814SJoe Perches # : when part of a bitfield 3873b00e4814SJoe Perches } elsif ($opv eq ':B') { 3874b00e4814SJoe Perches # skip the bitfield test for now 3875b00e4814SJoe Perches 38761f65f947SAndy Whitcroft # No spaces for: 38771f65f947SAndy Whitcroft # -> 3878b00e4814SJoe Perches } elsif ($op eq '->') { 38794a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 38803705ce5bSJoe Perches if (ERROR("SPACING", 38813705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3882b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38833705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38843705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38853705ce5bSJoe Perches } 3886b34c648bSJoe Perches $line_fixed = 1; 38873705ce5bSJoe Perches } 38880a920b5bSAndy Whitcroft } 38890a920b5bSAndy Whitcroft 38902381097bSJoe Perches # , must not have a space before and must have a space on the right. 38910a920b5bSAndy Whitcroft } elsif ($op eq ',') { 38922381097bSJoe Perches my $rtrim_before = 0; 38932381097bSJoe Perches my $space_after = 0; 38942381097bSJoe Perches if ($ctx =~ /Wx./) { 38952381097bSJoe Perches if (ERROR("SPACING", 38962381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 38972381097bSJoe Perches $line_fixed = 1; 38982381097bSJoe Perches $rtrim_before = 1; 38992381097bSJoe Perches } 39002381097bSJoe Perches } 3901cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 39023705ce5bSJoe Perches if (ERROR("SPACING", 39033705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 39043705ce5bSJoe Perches $line_fixed = 1; 3905b34c648bSJoe Perches $last_after = $n; 39062381097bSJoe Perches $space_after = 1; 39072381097bSJoe Perches } 39082381097bSJoe Perches } 39092381097bSJoe Perches if ($rtrim_before || $space_after) { 39102381097bSJoe Perches if ($rtrim_before) { 39112381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39122381097bSJoe Perches } else { 39132381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39142381097bSJoe Perches } 39152381097bSJoe Perches if ($space_after) { 39162381097bSJoe Perches $good .= " "; 39173705ce5bSJoe Perches } 39180a920b5bSAndy Whitcroft } 39190a920b5bSAndy Whitcroft 39209c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 392174048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 39229c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 39239c0ca6f9SAndy Whitcroft 39249c0ca6f9SAndy Whitcroft # unary operators should have a space before and 39259c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 39269c0ca6f9SAndy Whitcroft # unary operator, or a cast 39279c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 392874048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 39290d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3930cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 39313705ce5bSJoe Perches if (ERROR("SPACING", 39323705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3933b34c648bSJoe Perches if ($n != $last_after + 2) { 3934b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 39353705ce5bSJoe Perches $line_fixed = 1; 39363705ce5bSJoe Perches } 39370a920b5bSAndy Whitcroft } 3938b34c648bSJoe Perches } 3939a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3940171ae1a4SAndy Whitcroft # A unary '*' may be const 3941171ae1a4SAndy Whitcroft 3942171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 39433705ce5bSJoe Perches if (ERROR("SPACING", 39443705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3945b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 39463705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39473705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 39483705ce5bSJoe Perches } 3949b34c648bSJoe Perches $line_fixed = 1; 39503705ce5bSJoe Perches } 39510a920b5bSAndy Whitcroft } 39520a920b5bSAndy Whitcroft 39530a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 39540a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3955773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 39563705ce5bSJoe Perches if (ERROR("SPACING", 39573705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3958b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39593705ce5bSJoe Perches $line_fixed = 1; 39603705ce5bSJoe Perches } 39610a920b5bSAndy Whitcroft } 3962773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3963773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 39643705ce5bSJoe Perches if (ERROR("SPACING", 39653705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3966b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39673705ce5bSJoe Perches $line_fixed = 1; 39683705ce5bSJoe Perches } 3969653d4876SAndy Whitcroft } 3970773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 39713705ce5bSJoe Perches if (ERROR("SPACING", 39723705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3973b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39743705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39753705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3976773647a0SAndy Whitcroft } 3977b34c648bSJoe Perches $line_fixed = 1; 39783705ce5bSJoe Perches } 39793705ce5bSJoe Perches } 39800a920b5bSAndy Whitcroft 39810a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 39829c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 39839c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 39849c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3985c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3986c2fdda0dSAndy Whitcroft $op eq '%') 39870a920b5bSAndy Whitcroft { 3988d2e025f3SJoe Perches if ($check) { 3989d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3990d2e025f3SJoe Perches if (CHK("SPACING", 3991d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3992d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3993d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3994d2e025f3SJoe Perches $line_fixed = 1; 3995d2e025f3SJoe Perches } 3996d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3997d2e025f3SJoe Perches if (CHK("SPACING", 3998d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3999d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4000d2e025f3SJoe Perches $line_fixed = 1; 4001d2e025f3SJoe Perches } 4002d2e025f3SJoe Perches } 4003d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 40043705ce5bSJoe Perches if (ERROR("SPACING", 40053705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4006b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4007b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4008b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4009b34c648bSJoe Perches } 40103705ce5bSJoe Perches $line_fixed = 1; 40113705ce5bSJoe Perches } 40120a920b5bSAndy Whitcroft } 40130a920b5bSAndy Whitcroft 40141f65f947SAndy Whitcroft # A colon needs no spaces before when it is 40151f65f947SAndy Whitcroft # terminating a case value or a label. 40161f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 40171f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 40183705ce5bSJoe Perches if (ERROR("SPACING", 40193705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4020b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40213705ce5bSJoe Perches $line_fixed = 1; 40223705ce5bSJoe Perches } 40231f65f947SAndy Whitcroft } 40241f65f947SAndy Whitcroft 40250a920b5bSAndy Whitcroft # All the others need spaces both sides. 4026cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 40271f65f947SAndy Whitcroft my $ok = 0; 40281f65f947SAndy Whitcroft 402922f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 40301f65f947SAndy Whitcroft if (($op eq '<' && 40311f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 40321f65f947SAndy Whitcroft ($op eq '>' && 40331f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 40341f65f947SAndy Whitcroft { 40351f65f947SAndy Whitcroft $ok = 1; 40361f65f947SAndy Whitcroft } 40371f65f947SAndy Whitcroft 4038e0df7e1fSJoe Perches # for asm volatile statements 4039e0df7e1fSJoe Perches # ignore a colon with another 4040e0df7e1fSJoe Perches # colon immediately before or after 4041e0df7e1fSJoe Perches if (($op eq ':') && 4042e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4043e0df7e1fSJoe Perches $ok = 1; 4044e0df7e1fSJoe Perches } 4045e0df7e1fSJoe Perches 404684731623SJoe Perches # messages are ERROR, but ?: are CHK 40471f65f947SAndy Whitcroft if ($ok == 0) { 404884731623SJoe Perches my $msg_type = \&ERROR; 404984731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 405084731623SJoe Perches 405184731623SJoe Perches if (&{$msg_type}("SPACING", 40523705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4053b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4054b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4055b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4056b34c648bSJoe Perches } 40573705ce5bSJoe Perches $line_fixed = 1; 40583705ce5bSJoe Perches } 40590a920b5bSAndy Whitcroft } 406022f2a2efSAndy Whitcroft } 40614a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 40623705ce5bSJoe Perches 40633705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 40643705ce5bSJoe Perches 40653705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 40660a920b5bSAndy Whitcroft } 40673705ce5bSJoe Perches 40683705ce5bSJoe Perches if (($#elements % 2) == 0) { 40693705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 40703705ce5bSJoe Perches } 40713705ce5bSJoe Perches 4072194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4073194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 40743705ce5bSJoe Perches } 40753705ce5bSJoe Perches 40763705ce5bSJoe Perches 40770a920b5bSAndy Whitcroft } 40780a920b5bSAndy Whitcroft 4079786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4080d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4081786b6326SJoe Perches if (WARN("SPACING", 4082786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4083786b6326SJoe Perches $fix) { 4084194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4085786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4086786b6326SJoe Perches } 4087786b6326SJoe Perches } 4088786b6326SJoe Perches 4089f0a594c1SAndy Whitcroft# check for multiple assignments 4090f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4091000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4092000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4093f0a594c1SAndy Whitcroft } 4094f0a594c1SAndy Whitcroft 409522f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 409622f2a2efSAndy Whitcroft## # continuation. 409722f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 409822f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 409922f2a2efSAndy Whitcroft## 410022f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 410122f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 410222f2a2efSAndy Whitcroft## my $ln = $line; 410322f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 410422f2a2efSAndy Whitcroft## } 410522f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4106000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4107000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 410822f2a2efSAndy Whitcroft## } 410922f2a2efSAndy Whitcroft## } 4110f0a594c1SAndy Whitcroft 41110a920b5bSAndy Whitcroft#need space before brace following if, while, etc 41124e5d56bdSEddie Kovsky if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\){/) || 41134e5d56bdSEddie Kovsky $line =~ /do\{/) { 41143705ce5bSJoe Perches if (ERROR("SPACING", 41153705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 41163705ce5bSJoe Perches $fix) { 4117194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 41183705ce5bSJoe Perches } 4119de7d4f0eSAndy Whitcroft } 4120de7d4f0eSAndy Whitcroft 4121c4a62ef9SJoe Perches## # check for blank lines before declarations 4122c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4123c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4124c4a62ef9SJoe Perches## WARN("SPACING", 4125c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4126c4a62ef9SJoe Perches## } 4127c4a62ef9SJoe Perches## 4128c4a62ef9SJoe Perches 4129de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4130de7d4f0eSAndy Whitcroft# on the line 4131de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4132d5e616fcSJoe Perches if (ERROR("SPACING", 4133d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4134d5e616fcSJoe Perches $fix) { 4135194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4136d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4137d5e616fcSJoe Perches } 41380a920b5bSAndy Whitcroft } 41390a920b5bSAndy Whitcroft 414022f2a2efSAndy Whitcroft# check spacing on square brackets 414122f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 41423705ce5bSJoe Perches if (ERROR("SPACING", 41433705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 41443705ce5bSJoe Perches $fix) { 4145194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41463705ce5bSJoe Perches s/\[\s+/\[/; 41473705ce5bSJoe Perches } 414822f2a2efSAndy Whitcroft } 414922f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 41503705ce5bSJoe Perches if (ERROR("SPACING", 41513705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 41523705ce5bSJoe Perches $fix) { 4153194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41543705ce5bSJoe Perches s/\s+\]/\]/; 41553705ce5bSJoe Perches } 415622f2a2efSAndy Whitcroft } 415722f2a2efSAndy Whitcroft 4158c45dcabdSAndy Whitcroft# check spacing on parentheses 41599c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 41609c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 41613705ce5bSJoe Perches if (ERROR("SPACING", 41623705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 41633705ce5bSJoe Perches $fix) { 4164194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41653705ce5bSJoe Perches s/\(\s+/\(/; 41663705ce5bSJoe Perches } 416722f2a2efSAndy Whitcroft } 416813214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4169c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4170c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 41713705ce5bSJoe Perches if (ERROR("SPACING", 41723705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 41733705ce5bSJoe Perches $fix) { 4174194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41753705ce5bSJoe Perches s/\s+\)/\)/; 41763705ce5bSJoe Perches } 417722f2a2efSAndy Whitcroft } 417822f2a2efSAndy Whitcroft 4179e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4180e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4181e2826fd0SJoe Perches 4182e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4183ea4acbb1SJoe Perches my $var = $1; 4184ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4185ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4186ea4acbb1SJoe Perches $fix) { 4187ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4188ea4acbb1SJoe Perches } 4189ea4acbb1SJoe Perches } 4190ea4acbb1SJoe Perches 4191ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4192ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4193ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4194ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4195ea4acbb1SJoe Perches my $var = $2; 4196ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4197ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4198ea4acbb1SJoe Perches $fix) { 4199ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4200ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4201ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4202ea4acbb1SJoe Perches } 4203e2826fd0SJoe Perches } 4204e2826fd0SJoe Perches 42050a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 42064a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 42070a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 42083705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 42093705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 42103705ce5bSJoe Perches $fix) { 4211194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42123705ce5bSJoe Perches s/^(.)\s+/$1/; 42133705ce5bSJoe Perches } 42140a920b5bSAndy Whitcroft } 42150a920b5bSAndy Whitcroft 42165b9553abSJoe Perches# return is not a function 4217507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4218c45dcabdSAndy Whitcroft my $spacing = $1; 4219507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 42205b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 42215b9553abSJoe Perches my $value = $1; 42225b9553abSJoe Perches $value = deparenthesize($value); 42235b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4224000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4225000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 42265b9553abSJoe Perches } 4227c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4228000d1cc1SJoe Perches ERROR("SPACING", 4229000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4230c45dcabdSAndy Whitcroft } 4231c45dcabdSAndy Whitcroft } 4232507e5141SJoe Perches 4233b43ae21bSJoe Perches# unnecessary return in a void function 4234b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4235b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4236b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4237b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4238b43ae21bSJoe Perches $linenr >= 3 && 4239b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4240b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 42419819cf25SJoe Perches WARN("RETURN_VOID", 4242b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 42439819cf25SJoe Perches } 42449819cf25SJoe Perches 4245189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4246189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4247189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4248189248d8SJoe Perches my $openparens = $1; 4249189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4250189248d8SJoe Perches my $msg = ""; 4251189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4252189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4253189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4254189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4255189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4256189248d8SJoe Perches } 4257189248d8SJoe Perches } 4258189248d8SJoe Perches 4259c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4260c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4261c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4262c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4263c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4264c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4265c5595fa2SJoe Perches my $lead = $1; 4266c5595fa2SJoe Perches my $const = $2; 4267c5595fa2SJoe Perches my $comp = $3; 4268c5595fa2SJoe Perches my $to = $4; 4269c5595fa2SJoe Perches my $newcomp = $comp; 4270c5595fa2SJoe Perches if ($lead !~ /$Operators\s*$/ && 4271c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4272c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4273c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4274c5595fa2SJoe Perches $fix) { 4275c5595fa2SJoe Perches if ($comp eq "<") { 4276c5595fa2SJoe Perches $newcomp = ">"; 4277c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4278c5595fa2SJoe Perches $newcomp = ">="; 4279c5595fa2SJoe Perches } elsif ($comp eq ">") { 4280c5595fa2SJoe Perches $newcomp = "<"; 4281c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4282c5595fa2SJoe Perches $newcomp = "<="; 4283c5595fa2SJoe Perches } 4284c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4285c5595fa2SJoe Perches } 4286c5595fa2SJoe Perches } 4287c5595fa2SJoe Perches 4288f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4289f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 429053a3c448SAndy Whitcroft my $name = $1; 429153a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4292000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4293f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 429453a3c448SAndy Whitcroft } 429553a3c448SAndy Whitcroft } 4296c45dcabdSAndy Whitcroft 42970a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 42984a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 42993705ce5bSJoe Perches if (ERROR("SPACING", 43003705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 43013705ce5bSJoe Perches $fix) { 4302194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43033705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 43043705ce5bSJoe Perches } 43050a920b5bSAndy Whitcroft } 43060a920b5bSAndy Whitcroft 4307f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4308f5fe35ddSAndy Whitcroft# statements after the conditional. 4309170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 43103e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 43113e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 43123e469cdcSAndy Whitcroft if (!defined $stat); 4313170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4314170d3a22SAndy Whitcroft $remain_next, $off_next); 4315170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4316170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4317170d3a22SAndy Whitcroft 4318170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4319170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4320170d3a22SAndy Whitcroft # then count those as offsets. 4321170d3a22SAndy Whitcroft my ($whitespace) = 4322170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4323170d3a22SAndy Whitcroft my $offset = 4324170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4325170d3a22SAndy Whitcroft 4326170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4327170d3a22SAndy Whitcroft $offset} = 1; 4328170d3a22SAndy Whitcroft } 4329170d3a22SAndy Whitcroft } 4330170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4331c11230f4SJoe Perches defined($stat) && defined($cond) && 4332170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4333171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 43348905a67cSAndy Whitcroft 4335b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4336000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4337000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 43388905a67cSAndy Whitcroft } 43398905a67cSAndy Whitcroft 43408905a67cSAndy Whitcroft # Find out what is on the end of the line after the 43418905a67cSAndy Whitcroft # conditional. 4342773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 43438905a67cSAndy Whitcroft $s =~ s/\n.*//g; 434413214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 434553210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 434653210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4347773647a0SAndy Whitcroft { 4348bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4349bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4350bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 435142bdf74cSHidetoshi Seto my $stat_real = ''; 4352bb44ad39SAndy Whitcroft 435342bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 435442bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4355bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4356bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4357bb44ad39SAndy Whitcroft } 4358bb44ad39SAndy Whitcroft 4359000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4360000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 43618905a67cSAndy Whitcroft } 43628905a67cSAndy Whitcroft } 43638905a67cSAndy Whitcroft 436413214adfSAndy Whitcroft# Check for bitwise tests written as boolean 436513214adfSAndy Whitcroft if ($line =~ / 436613214adfSAndy Whitcroft (?: 436713214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 436813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 436913214adfSAndy Whitcroft (?:\&\&|\|\|) 437013214adfSAndy Whitcroft | 437113214adfSAndy Whitcroft (?:\&\&|\|\|) 437213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 437313214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 437413214adfSAndy Whitcroft )/x) 437513214adfSAndy Whitcroft { 4376000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4377000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 437813214adfSAndy Whitcroft } 437913214adfSAndy Whitcroft 43808905a67cSAndy Whitcroft# if and else should not have general statements after it 438113214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 438213214adfSAndy Whitcroft my $s = $1; 438313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 438413214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4385000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4386000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 43870a920b5bSAndy Whitcroft } 438813214adfSAndy Whitcroft } 438939667782SAndy Whitcroft# if should not continue a brace 439039667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4391000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4392048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 439339667782SAndy Whitcroft $herecurr); 439439667782SAndy Whitcroft } 4395a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4396a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4397a1080bf8SAndy Whitcroft $line !~ /\G(?: 43983fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4399a1080bf8SAndy Whitcroft \s*return\s+ 4400a1080bf8SAndy Whitcroft )/xg) 4401a1080bf8SAndy Whitcroft { 4402000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4403000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4404a1080bf8SAndy Whitcroft } 44050a920b5bSAndy Whitcroft 44060a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 44070a920b5bSAndy Whitcroft # indent level to be relevant to each other. 44088b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 44090a920b5bSAndy Whitcroft $previndent == $indent) { 44108b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 44118b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 44128b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44138b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44148b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 44158b8856f4SJoe Perches my $fixedline = $prevrawline; 44168b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 44178b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 44188b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44198b8856f4SJoe Perches } 44208b8856f4SJoe Perches $fixedline = $rawline; 44218b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 44228b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44238b8856f4SJoe Perches } 44240a920b5bSAndy Whitcroft } 44250a920b5bSAndy Whitcroft 44268b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4427c2fdda0dSAndy Whitcroft $previndent == $indent) { 4428c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4429c2fdda0dSAndy Whitcroft 4430c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4431c2fdda0dSAndy Whitcroft # conditional. 4432773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4433c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4434c2fdda0dSAndy Whitcroft 4435c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 44368b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 44378b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 44388b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44398b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44408b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 44418b8856f4SJoe Perches my $fixedline = $prevrawline; 44428b8856f4SJoe Perches my $trailing = $rawline; 44438b8856f4SJoe Perches $trailing =~ s/^\+//; 44448b8856f4SJoe Perches $trailing = trim($trailing); 44458b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 44468b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44478b8856f4SJoe Perches } 4448c2fdda0dSAndy Whitcroft } 4449c2fdda0dSAndy Whitcroft } 4450c2fdda0dSAndy Whitcroft 445195e2c602SJoe Perches#Specific variable tests 4452323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4453323c1260SJoe Perches my $var = $1; 445495e2c602SJoe Perches 445595e2c602SJoe Perches#gcc binary extension 445695e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4457d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4458d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4459d5e616fcSJoe Perches $fix) { 4460d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4461194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4462d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4463d5e616fcSJoe Perches } 446495e2c602SJoe Perches } 446595e2c602SJoe Perches 446695e2c602SJoe Perches#CamelCase 4467807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4468be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 446922735ce8SJoe Perches#Ignore Page<foo> variants 4470807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 447122735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4472f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4473f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4474f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 44757e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 44767e781f67SJoe Perches my $word = $1; 44777e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4478d8b07710SJoe Perches if ($check) { 4479d8b07710SJoe Perches seed_camelcase_includes(); 4480d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4481d8b07710SJoe Perches seed_camelcase_file($realfile); 4482d8b07710SJoe Perches $camelcase_file_seeded = 1; 4483d8b07710SJoe Perches } 4484d8b07710SJoe Perches } 44857e781f67SJoe Perches if (!defined $camelcase{$word}) { 44867e781f67SJoe Perches $camelcase{$word} = 1; 4487be79794bSJoe Perches CHK("CAMELCASE", 44887e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 44897e781f67SJoe Perches } 4490323c1260SJoe Perches } 4491323c1260SJoe Perches } 44923445686aSJoe Perches } 44930a920b5bSAndy Whitcroft 44940a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4495d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4496d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4497d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4498d5e616fcSJoe Perches $fix) { 4499194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4500d5e616fcSJoe Perches } 45010a920b5bSAndy Whitcroft } 45020a920b5bSAndy Whitcroft 45030e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 45040e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4505c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4506e09dec48SAndy Whitcroft my $file = "$1.h"; 4507e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4508e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4509e09dec48SAndy Whitcroft $realfile ne $checkfile && 45107840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4511c45dcabdSAndy Whitcroft { 45120e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 45130e212e0aSFabian Frederick if ($asminclude > 0) { 4514e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4515000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4516000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4517e09dec48SAndy Whitcroft } else { 4518000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4519000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4520e09dec48SAndy Whitcroft } 45210a920b5bSAndy Whitcroft } 45220a920b5bSAndy Whitcroft } 45230e212e0aSFabian Frederick } 45240a920b5bSAndy Whitcroft 4525653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4526653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4527cf655043SAndy Whitcroft# in a known good container 4528b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4529b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4530d8aaf121SAndy Whitcroft my $ln = $linenr; 4531d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4532c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4533c45dcabdSAndy Whitcroft my $ctx = ''; 453408a2843eSJoe Perches my $has_flow_statement = 0; 453508a2843eSJoe Perches my $has_arg_concat = 0; 4536c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4537f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4538f74bd194SAndy Whitcroft $ctx = $dstat; 4539c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4540a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4541c45dcabdSAndy Whitcroft 454208a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 454362e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 454408a2843eSJoe Perches 4545f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4546292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4547c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4548c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4549c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4550c45dcabdSAndy Whitcroft 4551c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4552bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4553bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 45546b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4555bf30d6edSAndy Whitcroft { 4556c45dcabdSAndy Whitcroft } 4557c45dcabdSAndy Whitcroft 4558e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 455933acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 456033acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4561e45bab8eSAndy Whitcroft { 4562e45bab8eSAndy Whitcroft } 4563e45bab8eSAndy Whitcroft 4564c45dcabdSAndy Whitcroft my $exceptions = qr{ 4565c45dcabdSAndy Whitcroft $Declare| 4566c45dcabdSAndy Whitcroft module_param_named| 4567a0a0a7a9SKees Cook MODULE_PARM_DESC| 4568c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4569c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4570383099fdSAndy Whitcroft __typeof__\(| 457122fd2d3eSStefani Seibold union| 457222fd2d3eSStefani Seibold struct| 4573ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 45746b10df42SVladimir Zapolskiy ^\"|\"$| 45756b10df42SVladimir Zapolskiy ^\[ 4576c45dcabdSAndy Whitcroft }x; 45775eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4578f74bd194SAndy Whitcroft if ($dstat ne '' && 4579f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4580f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 45813cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4582356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4583f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4584f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4585e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 458672f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4587f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4588f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4589f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 45904e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4591f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4592c45dcabdSAndy Whitcroft { 4593f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4594f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4595f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4596f74bd194SAndy Whitcroft 4597f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4598f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4599c45dcabdSAndy Whitcroft } 4600c45dcabdSAndy Whitcroft 4601f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4602f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4603f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4604f74bd194SAndy Whitcroft } else { 4605000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4606388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4607d8aaf121SAndy Whitcroft } 46080a920b5bSAndy Whitcroft } 46095023d347SJoe Perches 461008a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 461108a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 461208a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 461308a2843eSJoe Perches my $herectx = $here . "\n"; 461408a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 461508a2843eSJoe Perches 461608a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 461708a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 461808a2843eSJoe Perches } 461908a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 462008a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 462108a2843eSJoe Perches } 462208a2843eSJoe Perches 4623481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 46245023d347SJoe Perches 46255023d347SJoe Perches } else { 46265023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4627481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4628481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 46295023d347SJoe Perches $line =~ /^\+.*\\$/) { 46305023d347SJoe Perches WARN("LINE_CONTINUATIONS", 46315023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 46325023d347SJoe Perches } 4633653d4876SAndy Whitcroft } 46340a920b5bSAndy Whitcroft 4635b13edf7fSJoe Perches# do {} while (0) macro tests: 4636b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4637b13edf7fSJoe Perches# macro should not end with a semicolon 4638b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4639b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4640b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4641b13edf7fSJoe Perches my $ln = $linenr; 4642b13edf7fSJoe Perches my $cnt = $realcnt; 4643b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4644b13edf7fSJoe Perches my $ctx = ''; 4645b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4646b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4647b13edf7fSJoe Perches $ctx = $dstat; 4648b13edf7fSJoe Perches 4649b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 46501b36b201SJoe Perches $dstat =~ s/$;/ /g; 4651b13edf7fSJoe Perches 4652b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4653b13edf7fSJoe Perches my $stmts = $2; 4654b13edf7fSJoe Perches my $semis = $3; 4655b13edf7fSJoe Perches 4656b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4657b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4658b13edf7fSJoe Perches my $herectx = $here . "\n"; 4659b13edf7fSJoe Perches 4660b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4661b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4662b13edf7fSJoe Perches } 4663b13edf7fSJoe Perches 4664ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4665ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4666b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4667b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4668b13edf7fSJoe Perches } 4669b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4670b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4671b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4672b13edf7fSJoe Perches } 4673f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4674f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4675f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4676f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4677f5ef95b1SJoe Perches 4678f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4679f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4680f5ef95b1SJoe Perches } 4681f5ef95b1SJoe Perches 4682f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4683f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4684b13edf7fSJoe Perches } 4685b13edf7fSJoe Perches } 4686b13edf7fSJoe Perches 4687080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4688080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4689080ba929SMike Frysinger# . 4690080ba929SMike Frysinger# ALIGN(...) 4691080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4692080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4693000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4694000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4695080ba929SMike Frysinger } 4696080ba929SMike Frysinger 4697f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 469813214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 469913214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4700cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 470113214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4702cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4703cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4704aad4f614SJoe Perches my @allowed = (); 4705aad4f614SJoe Perches my $allow = 0; 470613214adfSAndy Whitcroft my $seen = 0; 4707773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4708cf655043SAndy Whitcroft my $ln = $linenr - 1; 470913214adfSAndy Whitcroft for my $chunk (@chunks) { 471013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 471113214adfSAndy Whitcroft 4712773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4713773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4714773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4715773647a0SAndy Whitcroft 4716aad4f614SJoe Perches $allowed[$allow] = 0; 4717773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4718773647a0SAndy Whitcroft 4719773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4720773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4721773647a0SAndy Whitcroft 4722773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4723cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4724cf655043SAndy Whitcroft 4725773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 472613214adfSAndy Whitcroft 472713214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 472813214adfSAndy Whitcroft 4729aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4730cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4731cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4732aad4f614SJoe Perches $allowed[$allow] = 1; 473313214adfSAndy Whitcroft } 473413214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4735cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4736aad4f614SJoe Perches $allowed[$allow] = 1; 473713214adfSAndy Whitcroft } 4738cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4739cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4740aad4f614SJoe Perches $allowed[$allow] = 1; 474113214adfSAndy Whitcroft } 4742aad4f614SJoe Perches $allow++; 474313214adfSAndy Whitcroft } 4744aad4f614SJoe Perches if ($seen) { 4745aad4f614SJoe Perches my $sum_allowed = 0; 4746aad4f614SJoe Perches foreach (@allowed) { 4747aad4f614SJoe Perches $sum_allowed += $_; 4748aad4f614SJoe Perches } 4749aad4f614SJoe Perches if ($sum_allowed == 0) { 4750000d1cc1SJoe Perches WARN("BRACES", 4751000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4752aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4753aad4f614SJoe Perches $seen != $allow) { 4754aad4f614SJoe Perches CHK("BRACES", 4755aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4756aad4f614SJoe Perches } 475713214adfSAndy Whitcroft } 475813214adfSAndy Whitcroft } 475913214adfSAndy Whitcroft } 4760773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 476113214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4762cf655043SAndy Whitcroft my $allowed = 0; 4763f0a594c1SAndy Whitcroft 4764cf655043SAndy Whitcroft # Check the pre-context. 4765cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4766cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4767cf655043SAndy Whitcroft $allowed = 1; 4768f0a594c1SAndy Whitcroft } 4769773647a0SAndy Whitcroft 4770773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4771773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4772773647a0SAndy Whitcroft 4773cf655043SAndy Whitcroft # Check the condition. 4774cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4775773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4776cf655043SAndy Whitcroft if (defined $cond) { 4777773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4778cf655043SAndy Whitcroft } 4779cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4780cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4781cf655043SAndy Whitcroft $allowed = 1; 4782cf655043SAndy Whitcroft } 4783cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4784cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4785cf655043SAndy Whitcroft $allowed = 1; 4786cf655043SAndy Whitcroft } 4787cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4788cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4789cf655043SAndy Whitcroft $allowed = 1; 4790cf655043SAndy Whitcroft } 4791cf655043SAndy Whitcroft # Check the post-context. 4792cf655043SAndy Whitcroft if (defined $chunks[1]) { 4793cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4794cf655043SAndy Whitcroft if (defined $cond) { 4795773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4796cf655043SAndy Whitcroft } 4797cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4798cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4799cf655043SAndy Whitcroft $allowed = 1; 4800cf655043SAndy Whitcroft } 4801cf655043SAndy Whitcroft } 4802cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 480369932487SJustin P. Mattock my $herectx = $here . "\n"; 4804f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4805cf655043SAndy Whitcroft 4806f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 480769932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4808cf655043SAndy Whitcroft } 4809cf655043SAndy Whitcroft 4810000d1cc1SJoe Perches WARN("BRACES", 4811000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4812f0a594c1SAndy Whitcroft } 4813f0a594c1SAndy Whitcroft } 4814f0a594c1SAndy Whitcroft 48150979ae66SJoe Perches# check for unnecessary blank lines around braces 481677b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4817f8e58219SJoe Perches if (CHK("BRACES", 4818f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4819f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4820f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4821f8e58219SJoe Perches } 48220979ae66SJoe Perches } 482377b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4824f8e58219SJoe Perches if (CHK("BRACES", 4825f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4826f8e58219SJoe Perches $fix) { 4827f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4828f8e58219SJoe Perches } 48290979ae66SJoe Perches } 48300979ae66SJoe Perches 48314a0df2efSAndy Whitcroft# no volatiles please 48326c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 48336c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4834000d1cc1SJoe Perches WARN("VOLATILE", 4835000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 48364a0df2efSAndy Whitcroft } 48374a0df2efSAndy Whitcroft 48385e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 48395e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 48405e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 48415e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 484233acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 48435e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 48445e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 48455e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 48465e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 48475e4f6ba5SJoe Perches $fix && 48485e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 48495e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 48505e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 48515e4f6ba5SJoe Perches my $comma_close = ""; 48525e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 48535e4f6ba5SJoe Perches $comma_close = $1; 48545e4f6ba5SJoe Perches } 48555e4f6ba5SJoe Perches 48565e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48575e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 48585e4f6ba5SJoe Perches my $fixedline = $prevrawline; 48595e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 48605e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 48615e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 48625e4f6ba5SJoe Perches $fixedline = $rawline; 48635e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 48645e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 48655e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48665e4f6ba5SJoe Perches } 48675e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 48685e4f6ba5SJoe Perches } 48695e4f6ba5SJoe Perches } 48705e4f6ba5SJoe Perches 48715e4f6ba5SJoe Perches# check for missing a space in a string concatenation 48725e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 48735e4f6ba5SJoe Perches WARN('MISSING_SPACE', 48745e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 48755e4f6ba5SJoe Perches } 48765e4f6ba5SJoe Perches 48775e4f6ba5SJoe Perches# check for spaces before a quoted newline 48785e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 48795e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 48805e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 48815e4f6ba5SJoe Perches $fix) { 48825e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 48835e4f6ba5SJoe Perches } 48845e4f6ba5SJoe Perches 48855e4f6ba5SJoe Perches } 48865e4f6ba5SJoe Perches 4887f17dba4fSJoe Perches# concatenated string without spaces between elements 488833acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4889f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4890f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4891f17dba4fSJoe Perches } 4892f17dba4fSJoe Perches 489390ad30e5SJoe Perches# uncoalesced string fragments 489433acb54aSJoe Perches if ($line =~ /$String\s*"/) { 489590ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 489690ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 489790ad30e5SJoe Perches } 489890ad30e5SJoe Perches 48996e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 49005e4f6ba5SJoe Perches my $string; 49015e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 49025e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 49035e4f6ba5SJoe Perches $string =~ s/%%/__/g; 49046e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 49055e4f6ba5SJoe Perches WARN("PRINTF_L", 49065e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 49075e4f6ba5SJoe Perches last; 49085e4f6ba5SJoe Perches } 49096e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 49106e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 49116e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 49126e300757SJoe Perches } 49135e4f6ba5SJoe Perches } 49145e4f6ba5SJoe Perches 49155e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 49165e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 49175e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 49185e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 49195e4f6ba5SJoe Perches } 49205e4f6ba5SJoe Perches 492100df344fSAndy Whitcroft# warn about #if 0 4922c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4923000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4924000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4925de7d4f0eSAndy Whitcroft $herecurr); 49264a0df2efSAndy Whitcroft } 49274a0df2efSAndy Whitcroft 492803df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 492903df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 4930100425deSJoe Perches my $tested = quotemeta($1); 4931100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 4932100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 4933100425deSJoe Perches my $func = $1; 4934100425deSJoe Perches if (WARN('NEEDLESS_IF', 4935100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 4936100425deSJoe Perches $fix) { 4937100425deSJoe Perches my $do_fix = 1; 4938100425deSJoe Perches my $leading_tabs = ""; 4939100425deSJoe Perches my $new_leading_tabs = ""; 4940100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 4941100425deSJoe Perches $leading_tabs = $1; 4942100425deSJoe Perches } else { 4943100425deSJoe Perches $do_fix = 0; 4944100425deSJoe Perches } 4945100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 4946100425deSJoe Perches $new_leading_tabs = $1; 4947100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 4948100425deSJoe Perches $do_fix = 0; 4949100425deSJoe Perches } 4950100425deSJoe Perches } else { 4951100425deSJoe Perches $do_fix = 0; 4952100425deSJoe Perches } 4953100425deSJoe Perches if ($do_fix) { 4954100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4955100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 4956100425deSJoe Perches } 4957100425deSJoe Perches } 49584c432a8fSGreg Kroah-Hartman } 49594c432a8fSGreg Kroah-Hartman } 4960f0a594c1SAndy Whitcroft 4961ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4962ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4963ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4964ebfdc409SJoe Perches (defined $1 || defined $3) && 4965ebfdc409SJoe Perches $linenr > 3) { 4966ebfdc409SJoe Perches my $testval = $2; 4967ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4968ebfdc409SJoe Perches 4969ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4970ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4971ebfdc409SJoe Perches 4972ebfdc409SJoe 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)/) { 4973ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4974ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4975ebfdc409SJoe Perches } 4976ebfdc409SJoe Perches } 4977ebfdc409SJoe Perches 4978f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4979dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4980f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4981f78d98f6SJoe Perches my $level = $1; 4982f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4983f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4984f78d98f6SJoe Perches $fix) { 4985f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4986f78d98f6SJoe Perches } 4987f78d98f6SJoe Perches } 4988f78d98f6SJoe Perches 4989abb08a53SJoe Perches# check for mask then right shift without a parentheses 4990abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4991abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4992abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4993abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4994abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4995abb08a53SJoe Perches } 4996abb08a53SJoe Perches 4997b75ac618SJoe Perches# check for pointer comparisons to NULL 4998b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4999b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5000b75ac618SJoe Perches my $val = $1; 5001b75ac618SJoe Perches my $equal = "!"; 5002b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5003b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5004b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5005b75ac618SJoe Perches $fix) { 5006b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5007b75ac618SJoe Perches } 5008b75ac618SJoe Perches } 5009b75ac618SJoe Perches } 5010b75ac618SJoe Perches 50118716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 50128716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 50138716de38SJoe Perches my $attr = $1; 50148716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 50158716de38SJoe Perches my $ptr = $1; 50168716de38SJoe Perches my $var = $2; 50178716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 50188716de38SJoe Perches ERROR("MISPLACED_INIT", 50198716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 50208716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 50218716de38SJoe Perches WARN("MISPLACED_INIT", 50228716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 50238716de38SJoe Perches $fix) { 5024194f66fcSJoe 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; 50258716de38SJoe Perches } 50268716de38SJoe Perches } 50278716de38SJoe Perches } 50288716de38SJoe Perches 5029e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5030e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5031e970b884SJoe Perches my $attr = $1; 5032e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5033e970b884SJoe Perches my $attr_prefix = $1; 5034e970b884SJoe Perches my $attr_type = $2; 5035e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5036e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5037e970b884SJoe Perches $fix) { 5038194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5039e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5040e970b884SJoe Perches } 5041e970b884SJoe Perches } 5042e970b884SJoe Perches 5043e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5044e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5045e970b884SJoe Perches my $attr = $1; 5046e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5047e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5048e970b884SJoe Perches $fix) { 5049194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5050e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5051e970b884SJoe Perches $lead = rtrim($1); 5052e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5053e970b884SJoe Perches $lead = "${lead}const "; 5054194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5055e970b884SJoe Perches } 5056e970b884SJoe Perches } 5057e970b884SJoe Perches 5058c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5059c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5060c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5061c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5062c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5063c17893c7SJoe Perches $fix) { 5064c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5065c17893c7SJoe Perches } 5066c17893c7SJoe Perches } 5067c17893c7SJoe Perches 5068fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5069fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5070fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5071fbdb8138SJoe Perches my $constant_func = $1; 5072fbdb8138SJoe Perches my $func = $constant_func; 5073fbdb8138SJoe Perches $func =~ s/^__constant_//; 5074fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5075fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5076fbdb8138SJoe Perches $fix) { 5077194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5078fbdb8138SJoe Perches } 5079fbdb8138SJoe Perches } 5080fbdb8138SJoe Perches 50811a15a250SPatrick Pannuto# prefer usleep_range over udelay 508237581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 508343c1d77cSJoe Perches my $delay = $1; 50841a15a250SPatrick Pannuto # ignore udelay's < 10, however 508543c1d77cSJoe Perches if (! ($delay < 10) ) { 5086000d1cc1SJoe Perches CHK("USLEEP_RANGE", 508743c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 508843c1d77cSJoe Perches } 508943c1d77cSJoe Perches if ($delay > 2000) { 509043c1d77cSJoe Perches WARN("LONG_UDELAY", 509143c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 50921a15a250SPatrick Pannuto } 50931a15a250SPatrick Pannuto } 50941a15a250SPatrick Pannuto 509509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 509609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 509709ef8725SPatrick Pannuto if ($1 < 20) { 5098000d1cc1SJoe Perches WARN("MSLEEP", 509943c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 510009ef8725SPatrick Pannuto } 510109ef8725SPatrick Pannuto } 510209ef8725SPatrick Pannuto 510336ec1939SJoe Perches# check for comparisons of jiffies 510436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 510536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 510636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 510736ec1939SJoe Perches } 510836ec1939SJoe Perches 51099d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 51109d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 51119d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 51129d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 51139d7a34a5SJoe Perches } 51149d7a34a5SJoe Perches 511500df344fSAndy Whitcroft# warn about #ifdefs in C files 5116c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 511700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 511800df344fSAndy Whitcroft# print "$herecurr"; 511900df344fSAndy Whitcroft# $clean = 0; 512000df344fSAndy Whitcroft# } 512100df344fSAndy Whitcroft 512222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5123c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 51243705ce5bSJoe Perches if (ERROR("SPACING", 51253705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 51263705ce5bSJoe Perches $fix) { 5127194f66fcSJoe Perches $fixed[$fixlinenr] =~ 51283705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 51293705ce5bSJoe Perches } 51303705ce5bSJoe Perches 513122f2a2efSAndy Whitcroft } 513222f2a2efSAndy Whitcroft 51334a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5134171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5135171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 51364a0df2efSAndy Whitcroft my $which = $1; 51374a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5138000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5139000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 51404a0df2efSAndy Whitcroft } 51414a0df2efSAndy Whitcroft } 51424a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5143402c2553SMichael S. Tsirkin 5144402c2553SMichael S. Tsirkin my $barriers = qr{ 5145402c2553SMichael S. Tsirkin mb| 5146402c2553SMichael S. Tsirkin rmb| 5147402c2553SMichael S. Tsirkin wmb| 5148402c2553SMichael S. Tsirkin read_barrier_depends 5149402c2553SMichael S. Tsirkin }x; 5150402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5151402c2553SMichael S. Tsirkin mb__before_atomic| 5152402c2553SMichael S. Tsirkin mb__after_atomic| 5153402c2553SMichael S. Tsirkin store_release| 5154402c2553SMichael S. Tsirkin load_acquire| 5155402c2553SMichael S. Tsirkin store_mb| 5156402c2553SMichael S. Tsirkin (?:$barriers) 5157402c2553SMichael S. Tsirkin }x; 5158402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5159402c2553SMichael S. Tsirkin (?:$barriers)| 516043e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 516143e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5162402c2553SMichael S. Tsirkin }x; 5163402c2553SMichael S. Tsirkin 5164402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 51654a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5166c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5167000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 51684a0df2efSAndy Whitcroft } 51694a0df2efSAndy Whitcroft } 51703ad81779SPaul E. McKenney 5171f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5172f4073b0fSMichael S. Tsirkin 5173f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5174f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5175f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5176f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5177f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5178f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5179f4073b0fSMichael S. Tsirkin } 5180f4073b0fSMichael S. Tsirkin 5181cb426e99SJoe Perches# check for waitqueue_active without a comment. 5182cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5183cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5184cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5185cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5186cb426e99SJoe Perches } 5187cb426e99SJoe Perches } 51883ad81779SPaul E. McKenney 51893ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 51903ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 51913ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 51923ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 51933ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 51943ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 51953ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 51963ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 51973ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 51983ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 51993ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 52003ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 52013ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 52023ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 52033ad81779SPaul E. McKenney 52043ad81779SPaul E. McKenney } 52053ad81779SPaul E. McKenney 52064a0df2efSAndy Whitcroft# check of hardware specific defines 5207c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5208000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5209000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 52100a920b5bSAndy Whitcroft } 5211653d4876SAndy Whitcroft 5212d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5213d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5214000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5215000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5216d4977c78STobias Klauser } 5217d4977c78STobias Klauser 5218de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5219de7d4f0eSAndy Whitcroft# storage class and type. 52209c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 52219c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5222000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5223000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5224de7d4f0eSAndy Whitcroft } 5225de7d4f0eSAndy Whitcroft 52268905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 52272b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52282b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5229d5e616fcSJoe Perches if (WARN("INLINE", 5230d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5231d5e616fcSJoe Perches $fix) { 5232194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5233d5e616fcSJoe Perches 5234d5e616fcSJoe Perches } 52358905a67cSAndy Whitcroft } 52368905a67cSAndy Whitcroft 52373d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 52382b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52392b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5240000d1cc1SJoe Perches WARN("PREFER_PACKED", 5241000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 52423d130fd0SJoe Perches } 52433d130fd0SJoe Perches 524439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 52452b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52462b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5247000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5248000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 524939b7e287SJoe Perches } 525039b7e287SJoe Perches 52515f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 52522b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52532b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5254d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5255d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5256d5e616fcSJoe Perches $fix) { 5257194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5258d5e616fcSJoe Perches 5259d5e616fcSJoe Perches } 52605f14d3bdSJoe Perches } 52615f14d3bdSJoe Perches 52626061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 52632b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52642b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5265d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5266d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5267d5e616fcSJoe Perches $fix) { 5268194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5269d5e616fcSJoe Perches } 52706061d949SJoe Perches } 52716061d949SJoe Perches 5272619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5273619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5274619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5275619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5276619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5277619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5278619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5279619a908aSJoe Perches } 5280619a908aSJoe Perches 5281e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5282e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5283e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5284e6176fa4SJoe Perches my $type = $1; 5285e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5286e6176fa4SJoe Perches $type = $1; 5287e6176fa4SJoe Perches my $kernel_type = 'u'; 5288e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5289e6176fa4SJoe Perches $type =~ /(\d+)/; 5290e6176fa4SJoe Perches $kernel_type .= $1; 5291e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5292e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5293e6176fa4SJoe Perches $fix) { 5294e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5295e6176fa4SJoe Perches } 5296e6176fa4SJoe Perches } 5297e6176fa4SJoe Perches } 5298e6176fa4SJoe Perches 5299938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5300938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5301938224b5SJoe Perches my $cast = $1; 5302938224b5SJoe Perches my $const = $2; 5303938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5304938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5305938224b5SJoe Perches $fix) { 5306938224b5SJoe Perches my $suffix = ""; 5307938224b5SJoe Perches my $newconst = $const; 5308938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5309938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5310938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5311938224b5SJoe Perches $suffix .= 'LL'; 5312938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5313938224b5SJoe Perches $suffix .= 'L'; 5314938224b5SJoe Perches } 5315938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5316938224b5SJoe Perches } 5317938224b5SJoe Perches } 5318938224b5SJoe Perches 53198f53a9b8SJoe Perches# check for sizeof(&) 53208f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5321000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5322000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 53238f53a9b8SJoe Perches } 53248f53a9b8SJoe Perches 532566c80b60SJoe Perches# check for sizeof without parenthesis 532666c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5327d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5328d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5329d5e616fcSJoe Perches $fix) { 5330194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5331d5e616fcSJoe Perches } 533266c80b60SJoe Perches } 533366c80b60SJoe Perches 533488982feaSJoe Perches# check for struct spinlock declarations 533588982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 533688982feaSJoe Perches WARN("USE_SPINLOCK_T", 533788982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 533888982feaSJoe Perches } 533988982feaSJoe Perches 5340a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 534106668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5342a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5343caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5344caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5345d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5346d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5347d5e616fcSJoe Perches $fix) { 5348194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5349d5e616fcSJoe Perches } 5350a6962d72SJoe Perches } 5351a6962d72SJoe Perches } 5352a6962d72SJoe Perches 5353554e165cSAndy Whitcroft# Check for misused memsets 5354d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5355d1fe9c09SJoe Perches defined $stat && 53569e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5357554e165cSAndy Whitcroft 5358d7c76ba7SJoe Perches my $ms_addr = $2; 5359d1fe9c09SJoe Perches my $ms_val = $7; 5360d1fe9c09SJoe Perches my $ms_size = $12; 5361d7c76ba7SJoe Perches 5362554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5363554e165cSAndy Whitcroft ERROR("MEMSET", 5364d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5365554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5366554e165cSAndy Whitcroft WARN("MEMSET", 5367d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5368d7c76ba7SJoe Perches } 5369d7c76ba7SJoe Perches } 5370d7c76ba7SJoe Perches 537198a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 537298a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 537310895d2cSMateusz Kulikowski defined $stat && 537410895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 537598a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 537610895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 537798a9bba5SJoe Perches $fix) { 5378194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 537998a9bba5SJoe Perches } 538098a9bba5SJoe Perches } 538198a9bba5SJoe Perches 5382b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5383b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5384b6117d17SMateusz Kulikowski defined $stat && 5385b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5386b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5387b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5388b6117d17SMateusz Kulikowski } 5389b6117d17SMateusz Kulikowski 53908617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 53918617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 53928617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 53938617cd09SMateusz Kulikowski defined $stat && 53948617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 53958617cd09SMateusz Kulikowski 53968617cd09SMateusz Kulikowski my $ms_val = $7; 53978617cd09SMateusz Kulikowski 53988617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 53998617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 54008617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 54018617cd09SMateusz Kulikowski $fix) { 54028617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 54038617cd09SMateusz Kulikowski } 54048617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 54058617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 54068617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 54078617cd09SMateusz Kulikowski $fix) { 54088617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 54098617cd09SMateusz Kulikowski } 54108617cd09SMateusz Kulikowski } 54118617cd09SMateusz Kulikowski } 54128617cd09SMateusz Kulikowski 5413d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5414d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5415d1fe9c09SJoe Perches defined $stat && 5416d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5417d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5418d7c76ba7SJoe Perches my $call = $1; 5419d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5420d7c76ba7SJoe Perches my $arg1 = $3; 5421d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5422d1fe9c09SJoe Perches my $arg2 = $8; 5423d7c76ba7SJoe Perches my $cast; 5424d7c76ba7SJoe Perches 5425d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5426d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5427d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5428d7c76ba7SJoe Perches $cast = $cast1; 5429d7c76ba7SJoe Perches } else { 5430d7c76ba7SJoe Perches $cast = $cast2; 5431d7c76ba7SJoe Perches } 5432d7c76ba7SJoe Perches WARN("MINMAX", 5433d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5434554e165cSAndy Whitcroft } 5435554e165cSAndy Whitcroft } 5436554e165cSAndy Whitcroft 54374a273195SJoe Perches# check usleep_range arguments 54384a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 54394a273195SJoe Perches defined $stat && 54404a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 54414a273195SJoe Perches my $min = $1; 54424a273195SJoe Perches my $max = $7; 54434a273195SJoe Perches if ($min eq $max) { 54444a273195SJoe Perches WARN("USLEEP_RANGE", 54454a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 54464a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 54474a273195SJoe Perches $min > $max) { 54484a273195SJoe Perches WARN("USLEEP_RANGE", 54494a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 54504a273195SJoe Perches } 54514a273195SJoe Perches } 54524a273195SJoe Perches 5453823b794cSJoe Perches# check for naked sscanf 5454823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5455823b794cSJoe Perches defined $stat && 54566c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5457823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5458823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5459823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5460823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5461823b794cSJoe Perches $lc = $lc + $linenr; 5462823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5463823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5464823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5465823b794cSJoe Perches } 5466823b794cSJoe Perches WARN("NAKED_SSCANF", 5467823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5468823b794cSJoe Perches } 5469823b794cSJoe Perches 5470afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5471afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5472afc819abSJoe Perches defined $stat && 5473afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5474afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5475afc819abSJoe Perches $lc = $lc + $linenr; 5476afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5477afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5478afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5479afc819abSJoe Perches } 5480afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5481afc819abSJoe Perches my $format = $6; 5482afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5483afc819abSJoe Perches if ($count == 1 && 5484afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5485afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5486afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5487afc819abSJoe Perches } 5488afc819abSJoe Perches } 5489afc819abSJoe Perches } 5490afc819abSJoe Perches 549170dc8a48SJoe Perches# check for new externs in .h files. 549270dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 549370dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5494d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 549570dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 549670dc8a48SJoe Perches $fix) { 5497194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 549870dc8a48SJoe Perches } 549970dc8a48SJoe Perches } 550070dc8a48SJoe Perches 5501de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5502171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5503c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5504171ae1a4SAndy Whitcroft { 5505c45dcabdSAndy Whitcroft my $function_name = $1; 5506c45dcabdSAndy Whitcroft my $paren_space = $2; 5507171ae1a4SAndy Whitcroft 5508171ae1a4SAndy Whitcroft my $s = $stat; 5509171ae1a4SAndy Whitcroft if (defined $cond) { 5510171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5511171ae1a4SAndy Whitcroft } 5512c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5513c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5514c45dcabdSAndy Whitcroft { 5515000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5516000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5517de7d4f0eSAndy Whitcroft } 5518de7d4f0eSAndy Whitcroft 5519171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5520000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5521000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5522171ae1a4SAndy Whitcroft } 55239c9ba34eSAndy Whitcroft 55249c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 55259c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 55269c9ba34eSAndy Whitcroft { 5527000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5528000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5529171ae1a4SAndy Whitcroft } 5530171ae1a4SAndy Whitcroft 5531de7d4f0eSAndy Whitcroft# checks for new __setup's 5532de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5533de7d4f0eSAndy Whitcroft my $name = $1; 5534de7d4f0eSAndy Whitcroft 5535de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5536000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5537000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5538de7d4f0eSAndy Whitcroft } 5539653d4876SAndy Whitcroft } 55409c0ca6f9SAndy Whitcroft 55419c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5542caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5543000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5544000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 55459c0ca6f9SAndy Whitcroft } 554613214adfSAndy Whitcroft 5547a640d25cSJoe Perches# alloc style 5548a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5549a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5550a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5551a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5552a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5553a640d25cSJoe Perches } 5554a640d25cSJoe Perches 555560a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 555660a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5557e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 555860a55369SJoe Perches my $oldfunc = $3; 555960a55369SJoe Perches my $a1 = $4; 556060a55369SJoe Perches my $a2 = $10; 556160a55369SJoe Perches my $newfunc = "kmalloc_array"; 556260a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 556360a55369SJoe Perches my $r1 = $a1; 556460a55369SJoe Perches my $r2 = $a2; 556560a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 556660a55369SJoe Perches $r1 = $a2; 556760a55369SJoe Perches $r2 = $a1; 556860a55369SJoe Perches } 5569e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5570e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5571e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5572e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5573e367455aSJoe Perches $fix) { 5574194f66fcSJoe 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; 557560a55369SJoe Perches 557660a55369SJoe Perches } 557760a55369SJoe Perches } 557860a55369SJoe Perches } 557960a55369SJoe Perches 5580972fdea2SJoe Perches# check for krealloc arg reuse 5581972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5582972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5583972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5584972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5585972fdea2SJoe Perches } 5586972fdea2SJoe Perches 55875ce59ae0SJoe Perches# check for alloc argument mismatch 55885ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 55895ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 55905ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 55915ce59ae0SJoe Perches } 55925ce59ae0SJoe Perches 5593caf2a54fSJoe Perches# check for multiple semicolons 5594caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5595d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5596d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5597d5e616fcSJoe Perches $fix) { 5598194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5599d5e616fcSJoe Perches } 5600d1e2ad07SJoe Perches } 5601d1e2ad07SJoe Perches 56020ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 56030ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 56040ab90191SJoe Perches my $ull = ""; 56050ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 56060ab90191SJoe Perches if (CHK("BIT_MACRO", 56070ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 56080ab90191SJoe Perches $fix) { 56090ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 56100ab90191SJoe Perches } 56110ab90191SJoe Perches } 56120ab90191SJoe Perches 5613e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5614c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5615c34c09a8SJoe Perches my $has_break = 0; 5616c34c09a8SJoe Perches my $has_statement = 0; 5617c34c09a8SJoe Perches my $count = 0; 5618c34c09a8SJoe Perches my $prevline = $linenr; 5619e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5620c34c09a8SJoe Perches $prevline--; 5621c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5622c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5623c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5624c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5625c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5626c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5627c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5628c34c09a8SJoe Perches $has_statement = 1; 5629c34c09a8SJoe Perches $count++; 5630c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5631c34c09a8SJoe Perches } 5632c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5633c34c09a8SJoe Perches WARN("MISSING_BREAK", 5634c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5635c34c09a8SJoe Perches } 5636c34c09a8SJoe Perches } 5637c34c09a8SJoe Perches 5638d1e2ad07SJoe Perches# check for switch/default statements without a break; 5639d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5640d1e2ad07SJoe Perches defined $stat && 5641d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5642d1e2ad07SJoe Perches my $ctx = ''; 5643d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5644d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5645d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5646d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5647d1e2ad07SJoe Perches } 5648d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5649d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5650caf2a54fSJoe Perches } 5651caf2a54fSJoe Perches 565213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5653d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5654d5e616fcSJoe Perches if (WARN("USE_FUNC", 5655d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5656d5e616fcSJoe Perches $fix) { 5657194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5658d5e616fcSJoe Perches } 565913214adfSAndy Whitcroft } 5660773647a0SAndy Whitcroft 566162ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 566262ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 566362ec818fSJoe Perches ERROR("DATE_TIME", 566462ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 566562ec818fSJoe Perches } 566662ec818fSJoe Perches 56672c92488aSJoe Perches# check for use of yield() 56682c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 56692c92488aSJoe Perches WARN("YIELD", 56702c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 56712c92488aSJoe Perches } 56722c92488aSJoe Perches 5673179f8f40SJoe Perches# check for comparisons against true and false 5674179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5675179f8f40SJoe Perches my $lead = $1; 5676179f8f40SJoe Perches my $arg = $2; 5677179f8f40SJoe Perches my $test = $3; 5678179f8f40SJoe Perches my $otype = $4; 5679179f8f40SJoe Perches my $trail = $5; 5680179f8f40SJoe Perches my $op = "!"; 5681179f8f40SJoe Perches 5682179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5683179f8f40SJoe Perches 5684179f8f40SJoe Perches my $type = lc($otype); 5685179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5686179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5687179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5688179f8f40SJoe Perches $op = ""; 5689179f8f40SJoe Perches } 5690179f8f40SJoe Perches 5691179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5692179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5693179f8f40SJoe Perches 5694179f8f40SJoe Perches## maybe suggesting a correct construct would better 5695179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5696179f8f40SJoe Perches 5697179f8f40SJoe Perches } 5698179f8f40SJoe Perches } 5699179f8f40SJoe Perches 57004882720bSThomas Gleixner# check for semaphores initialized locked 57014882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5702000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5703000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5704773647a0SAndy Whitcroft } 57056712d858SJoe Perches 570667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 570767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5708000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 570967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5710773647a0SAndy Whitcroft } 57116712d858SJoe Perches 5712ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5713f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5714000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5715ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5716f3db6639SMichael Ellerman } 57176712d858SJoe Perches 57180f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 57190f3c5aabSJoe Perches my $const_structs = qr{ 57200f3c5aabSJoe Perches acpi_dock_ops| 572179404849SEmese Revfy address_space_operations| 572279404849SEmese Revfy backlight_ops| 572379404849SEmese Revfy block_device_operations| 572479404849SEmese Revfy dentry_operations| 572579404849SEmese Revfy dev_pm_ops| 572679404849SEmese Revfy dma_map_ops| 572779404849SEmese Revfy extent_io_ops| 572879404849SEmese Revfy file_lock_operations| 572979404849SEmese Revfy file_operations| 573079404849SEmese Revfy hv_ops| 573179404849SEmese Revfy ide_dma_ops| 573279404849SEmese Revfy intel_dvo_dev_ops| 573379404849SEmese Revfy item_operations| 573479404849SEmese Revfy iwl_ops| 573579404849SEmese Revfy kgdb_arch| 573679404849SEmese Revfy kgdb_io| 573779404849SEmese Revfy kset_uevent_ops| 573879404849SEmese Revfy lock_manager_operations| 573979404849SEmese Revfy microcode_ops| 574079404849SEmese Revfy mtrr_ops| 574179404849SEmese Revfy neigh_ops| 574279404849SEmese Revfy nlmsvc_binding| 57430f3c5aabSJoe Perches of_device_id| 574479404849SEmese Revfy pci_raw_ops| 574579404849SEmese Revfy pipe_buf_operations| 574679404849SEmese Revfy platform_hibernation_ops| 574779404849SEmese Revfy platform_suspend_ops| 574879404849SEmese Revfy proto_ops| 574979404849SEmese Revfy rpc_pipe_ops| 575079404849SEmese Revfy seq_operations| 575179404849SEmese Revfy snd_ac97_build_ops| 575279404849SEmese Revfy soc_pcmcia_socket_ops| 575379404849SEmese Revfy stacktrace_ops| 575479404849SEmese Revfy sysfs_ops| 575579404849SEmese Revfy tty_operations| 57566d07d01bSJoe Perches uart_ops| 575779404849SEmese Revfy usb_mon_operations| 575879404849SEmese Revfy wd_ops}x; 57596903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 57600f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5761000d1cc1SJoe Perches WARN("CONST_STRUCT", 5762000d1cc1SJoe Perches "struct $1 should normally be const\n" . 57636903ffb2SAndy Whitcroft $herecurr); 57642b6db5cbSAndy Whitcroft } 5765773647a0SAndy Whitcroft 5766773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5767773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5768773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5769c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5770c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5771171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5772171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5773171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5774773647a0SAndy Whitcroft { 5775000d1cc1SJoe Perches WARN("NR_CPUS", 5776000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5777773647a0SAndy Whitcroft } 57789c9ba34eSAndy Whitcroft 577952ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 578052ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 578152ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 578252ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 578352ea8506SJoe Perches } 578452ea8506SJoe Perches 5785acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5786acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5787acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5788acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5789acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5790acd9362cSJoe Perches } 5791acd9362cSJoe Perches 5792691d77b6SAndy Whitcroft# whine mightly about in_atomic 5793691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5794691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5795000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5796000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5797f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5798000d1cc1SJoe Perches WARN("IN_ATOMIC", 5799000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5800691d77b6SAndy Whitcroft } 5801691d77b6SAndy Whitcroft } 58021704f47bSPeter Zijlstra 58031704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 58041704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 58051704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 58061704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 58071704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 58081704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5809000d1cc1SJoe Perches ERROR("LOCKDEP", 5810000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 58111704f47bSPeter Zijlstra } 58121704f47bSPeter Zijlstra } 581388f8831cSDave Jones 5814b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5815b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5816000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5817000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 581888f8831cSDave Jones } 58192435880fSJoe Perches 5820515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5821515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5822515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5823515a235eSJoe Perches $line =~ /$mode_perms_search/) { 58242435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 58252435880fSJoe Perches my $func = $entry->[0]; 58262435880fSJoe Perches my $arg_pos = $entry->[1]; 58272435880fSJoe Perches 58282435880fSJoe Perches my $skip_args = ""; 58292435880fSJoe Perches if ($arg_pos > 1) { 58302435880fSJoe Perches $arg_pos--; 58312435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 58322435880fSJoe Perches } 58332435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5834515a235eSJoe Perches if ($line =~ /$test/) { 58352435880fSJoe Perches my $val = $1; 58362435880fSJoe Perches $val = $6 if ($skip_args ne ""); 58372435880fSJoe Perches 58381727cc70SJoe Perches if ($val !~ /^0$/ && 58391727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 58401727cc70SJoe Perches length($val) ne 4)) { 58412435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 58421727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5843c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5844c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5845c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 58462435880fSJoe Perches } 58472435880fSJoe Perches } 58482435880fSJoe Perches } 584913214adfSAndy Whitcroft } 58505a6d20ceSBjorn Andersson 58515a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 58525a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 58535a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 58545a6d20ceSBjorn Andersson my $valid_licenses = qr{ 58555a6d20ceSBjorn Andersson GPL| 58565a6d20ceSBjorn Andersson GPL\ v2| 58575a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 58585a6d20ceSBjorn Andersson Dual\ BSD/GPL| 58595a6d20ceSBjorn Andersson Dual\ MIT/GPL| 58605a6d20ceSBjorn Andersson Dual\ MPL/GPL| 58615a6d20ceSBjorn Andersson Proprietary 58625a6d20ceSBjorn Andersson }x; 58635a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 58645a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 58655a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 58665a6d20ceSBjorn Andersson } 58675a6d20ceSBjorn Andersson } 5868515a235eSJoe Perches } 586913214adfSAndy Whitcroft 587013214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 587113214adfSAndy Whitcroft # so just keep quiet. 587213214adfSAndy Whitcroft if ($#rawlines == -1) { 587313214adfSAndy Whitcroft exit(0); 58740a920b5bSAndy Whitcroft } 58750a920b5bSAndy Whitcroft 58768905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 58778905a67cSAndy Whitcroft # things that appear to be patches. 58788905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 58798905a67cSAndy Whitcroft exit(0); 58808905a67cSAndy Whitcroft } 58818905a67cSAndy Whitcroft 58828905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 58838905a67cSAndy Whitcroft # just keep quiet. 58848905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 58858905a67cSAndy Whitcroft exit(0); 58868905a67cSAndy Whitcroft } 58878905a67cSAndy Whitcroft 588806330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5889000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5890000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 58910a920b5bSAndy Whitcroft } 589234d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5893000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5894000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 58950a920b5bSAndy Whitcroft } 58960a920b5bSAndy Whitcroft 5897f0a594c1SAndy Whitcroft print report_dump(); 589813214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 589913214adfSAndy Whitcroft print "$filename " if ($summary_file); 59006c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 59016c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 59026c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 59036c72ffaaSAndy Whitcroft } 59048905a67cSAndy Whitcroft 5905d2c0a235SAndy Whitcroft if ($quiet == 0) { 5906d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5907d2c0a235SAndy Whitcroft # then suggest that. 5908d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5909b0781216SMike Frysinger $rpt_cleaners = 0; 5910d8469f16SJoe Perches print << "EOM" 5911d8469f16SJoe Perches 5912d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5913d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5914d8469f16SJoe PerchesEOM 5915d2c0a235SAndy Whitcroft } 5916d2c0a235SAndy Whitcroft } 5917d2c0a235SAndy Whitcroft 5918d752fcc8SJoe Perches if ($clean == 0 && $fix && 5919d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5920d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 59219624b8d6SJoe Perches my $newfile = $filename; 59229624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 59233705ce5bSJoe Perches my $linecount = 0; 59243705ce5bSJoe Perches my $f; 59253705ce5bSJoe Perches 5926d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5927d752fcc8SJoe Perches 59283705ce5bSJoe Perches open($f, '>', $newfile) 59293705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 59303705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 59313705ce5bSJoe Perches $linecount++; 59323705ce5bSJoe Perches if ($file) { 59333705ce5bSJoe Perches if ($linecount > 3) { 59343705ce5bSJoe Perches $fixed_line =~ s/^\+//; 59353705ce5bSJoe Perches print $f $fixed_line . "\n"; 59363705ce5bSJoe Perches } 59373705ce5bSJoe Perches } else { 59383705ce5bSJoe Perches print $f $fixed_line . "\n"; 59393705ce5bSJoe Perches } 59403705ce5bSJoe Perches } 59413705ce5bSJoe Perches close($f); 59423705ce5bSJoe Perches 59433705ce5bSJoe Perches if (!$quiet) { 59443705ce5bSJoe Perches print << "EOM"; 5945d8469f16SJoe Perches 59463705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 59473705ce5bSJoe Perches 59483705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 59493705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 59503705ce5bSJoe Perches 59513705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 59523705ce5bSJoe PerchesNo warranties, expressed or implied... 59533705ce5bSJoe PerchesEOM 59543705ce5bSJoe Perches } 59553705ce5bSJoe Perches } 59563705ce5bSJoe Perches 5957d8469f16SJoe Perches if ($quiet == 0) { 5958d8469f16SJoe Perches print "\n"; 5959d8469f16SJoe Perches if ($clean == 1) { 5960d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5961d8469f16SJoe Perches } else { 5962d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 59630a920b5bSAndy Whitcroft } 59640a920b5bSAndy Whitcroft } 59650a920b5bSAndy Whitcroft return $clean; 59660a920b5bSAndy Whitcroft} 5967