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| 272165e72a6SSven Eckelmann __rcu 2736c72ffaaSAndy Whitcroft }x; 274e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 275e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 276e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 277e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 278e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2798716de38SJoe Perches 28052131292SWolfram Sang# Notes to $Attribute: 28152131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2826c72ffaaSAndy Whitcroftour $Attribute = qr{ 2836c72ffaaSAndy Whitcroft const| 28403f1df7dSJoe Perches __percpu| 28503f1df7dSJoe Perches __nocast| 28603f1df7dSJoe Perches __safe| 28703f1df7dSJoe Perches __bitwise__| 28803f1df7dSJoe Perches __packed__| 28903f1df7dSJoe Perches __packed2__| 29003f1df7dSJoe Perches __naked| 29103f1df7dSJoe Perches __maybe_unused| 29203f1df7dSJoe Perches __always_unused| 29303f1df7dSJoe Perches __noreturn| 29403f1df7dSJoe Perches __used| 29503f1df7dSJoe Perches __cold| 296e23ef1f3SJoe Perches __pure| 29703f1df7dSJoe Perches __noclone| 29803f1df7dSJoe Perches __deprecated| 2996c72ffaaSAndy Whitcroft __read_mostly| 3006c72ffaaSAndy Whitcroft __kprobes| 3018716de38SJoe Perches $InitAttribute| 30224e1d81aSAndy Whitcroft ____cacheline_aligned| 30324e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3045fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3055fe3af11SAndy Whitcroft __weak 3066c72ffaaSAndy Whitcroft }x; 307c45dcabdSAndy Whitcroftour $Modifier; 30891cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3096c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3106c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3116c72ffaaSAndy Whitcroft 31295e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 31395e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 31495e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 31595e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3162435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 317c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 318326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 319326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 320326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 32174349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3222435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 323326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 324447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 32523f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3266c72ffaaSAndy Whitcroftour $Operators = qr{ 3276c72ffaaSAndy Whitcroft <=|>=|==|!=| 3286c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 32923f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3306c72ffaaSAndy Whitcroft }x; 3316c72ffaaSAndy Whitcroft 33291cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 33391cb5195SJoe Perches 334ab7e23f3SJoe Perchesour $BasicType; 3358905a67cSAndy Whitcroftour $NonptrType; 3361813087dSJoe Perchesour $NonptrTypeMisordered; 3378716de38SJoe Perchesour $NonptrTypeWithAttr; 3388905a67cSAndy Whitcroftour $Type; 3391813087dSJoe Perchesour $TypeMisordered; 3408905a67cSAndy Whitcroftour $Declare; 3411813087dSJoe Perchesour $DeclareMisordered; 3428905a67cSAndy Whitcroft 34315662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 34415662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 345171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 346171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 347171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 348171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 349171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 350171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 351171ae1a4SAndy Whitcroft}x; 352171ae1a4SAndy Whitcroft 35315662b3eSJoe Perchesour $UTF8 = qr{ 35415662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 35515662b3eSJoe Perches | $NON_ASCII_UTF8 35615662b3eSJoe Perches}x; 35715662b3eSJoe Perches 358e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 359021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 360021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 361021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 362021158b4SJoe Perches)}; 363e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 364fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3658ed22cadSAndy Whitcroft atomic_t 3668ed22cadSAndy Whitcroft)}; 367e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 368e6176fa4SJoe Perches $typeC99Typedefs\b| 369e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 370e6176fa4SJoe Perches $typeKernelTypedefs\b 371e6176fa4SJoe Perches)}; 3728ed22cadSAndy Whitcroft 3736d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 3746d32f7a3SJoe Perches 375691e669bSJoe Perchesour $logFunctions = qr{(?x: 3766e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3777d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3786e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 379b0531722SJoe Perches panic| 38006668727SJoe Perches MODULE_[A-Z_]+| 38106668727SJoe Perches seq_vprintf|seq_printf|seq_puts 382691e669bSJoe Perches)}; 383691e669bSJoe Perches 38420112475SJoe Perchesour $signature_tags = qr{(?xi: 38520112475SJoe Perches Signed-off-by:| 38620112475SJoe Perches Acked-by:| 38720112475SJoe Perches Tested-by:| 38820112475SJoe Perches Reviewed-by:| 38920112475SJoe Perches Reported-by:| 3908543ae12SMugunthan V N Suggested-by:| 39120112475SJoe Perches To:| 39220112475SJoe Perches Cc: 39320112475SJoe Perches)}; 39420112475SJoe Perches 3951813087dSJoe Perchesour @typeListMisordered = ( 3961813087dSJoe Perches qr{char\s+(?:un)?signed}, 3971813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3981813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 3991813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 4001813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 4011813087dSJoe Perches qr{short\s+(?:un)?signed}, 4021813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4031813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4041813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4051813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4061813087dSJoe Perches qr{int\s+(?:un)?signed}, 4071813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4081813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4091813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4101813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4111813087dSJoe Perches qr{long\s+(?:un)?signed}, 4121813087dSJoe Perches); 4131813087dSJoe Perches 4148905a67cSAndy Whitcroftour @typeList = ( 4158905a67cSAndy Whitcroft qr{void}, 4160c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4170c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4180c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4190c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4200c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4210c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4220c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4230c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4240c773d9dSJoe Perches qr{(?:un)?signed}, 4258905a67cSAndy Whitcroft qr{float}, 4268905a67cSAndy Whitcroft qr{double}, 4278905a67cSAndy Whitcroft qr{bool}, 4288905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4298905a67cSAndy Whitcroft qr{union\s+$Ident}, 4308905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4318905a67cSAndy Whitcroft qr{${Ident}_t}, 4328905a67cSAndy Whitcroft qr{${Ident}_handler}, 4338905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4341813087dSJoe Perches @typeListMisordered, 4358905a67cSAndy Whitcroft); 436938224b5SJoe Perches 437938224b5SJoe Perchesour $C90_int_types = qr{(?x: 438938224b5SJoe Perches long\s+long\s+int\s+(?:un)?signed| 439938224b5SJoe Perches long\s+long\s+(?:un)?signed\s+int| 440938224b5SJoe Perches long\s+long\s+(?:un)?signed| 441938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long\s+int| 442938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+long| 443938224b5SJoe Perches int\s+long\s+long\s+(?:un)?signed| 444938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long\s+long| 445938224b5SJoe Perches 446938224b5SJoe Perches long\s+int\s+(?:un)?signed| 447938224b5SJoe Perches long\s+(?:un)?signed\s+int| 448938224b5SJoe Perches long\s+(?:un)?signed| 449938224b5SJoe Perches (?:(?:un)?signed\s+)?long\s+int| 450938224b5SJoe Perches (?:(?:un)?signed\s+)?long| 451938224b5SJoe Perches int\s+long\s+(?:un)?signed| 452938224b5SJoe Perches int\s+(?:(?:un)?signed\s+)?long| 453938224b5SJoe Perches 454938224b5SJoe Perches int\s+(?:un)?signed| 455938224b5SJoe Perches (?:(?:un)?signed\s+)?int 456938224b5SJoe Perches)}; 457938224b5SJoe Perches 458485ff23eSAlex Dowadour @typeListFile = (); 4598716de38SJoe Perchesour @typeListWithAttr = ( 4608716de38SJoe Perches @typeList, 4618716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4628716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4638716de38SJoe Perches); 4648716de38SJoe Perches 465c45dcabdSAndy Whitcroftour @modifierList = ( 466c45dcabdSAndy Whitcroft qr{fastcall}, 467c45dcabdSAndy Whitcroft); 468485ff23eSAlex Dowadour @modifierListFile = (); 4698905a67cSAndy Whitcroft 4702435880fSJoe Perchesour @mode_permission_funcs = ( 4712435880fSJoe Perches ["module_param", 3], 4722435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4732435880fSJoe Perches ["module_param_array_named", 5], 4742435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4752435880fSJoe Perches ["proc_create(?:_data|)", 2], 4762435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4772435880fSJoe Perches); 4782435880fSJoe Perches 479515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 480515a235eSJoe Perchesour $mode_perms_search = ""; 481515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 482515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 483515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 484515a235eSJoe Perches} 485515a235eSJoe Perches 486b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 487b392c64fSJoe Perches S_IWUGO | 488b392c64fSJoe Perches S_IWOTH | 489b392c64fSJoe Perches S_IRWXUGO | 490b392c64fSJoe Perches S_IALLUGO | 491b392c64fSJoe Perches 0[0-7][0-7][2367] 492b392c64fSJoe Perches}x; 493b392c64fSJoe Perches 4947840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4957840a94cSWolfram Sang irq| 496cdcee686SSergey Ryazanov memory| 497cdcee686SSergey Ryazanov time| 498cdcee686SSergey Ryazanov reboot 4997840a94cSWolfram Sang)}; 5007840a94cSWolfram Sang# memory.h: ARM has a custom one 5017840a94cSWolfram Sang 50266b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 50366b47b4aSKees Cookmy $misspellings; 50466b47b4aSKees Cookmy %spelling_fix; 50536061e38SJoe Perches 50636061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 50766b47b4aSKees Cook while (<$spelling>) { 50866b47b4aSKees Cook my $line = $_; 50966b47b4aSKees Cook 51066b47b4aSKees Cook $line =~ s/\s*\n?$//g; 51166b47b4aSKees Cook $line =~ s/^\s*//g; 51266b47b4aSKees Cook 51366b47b4aSKees Cook next if ($line =~ m/^\s*#/); 51466b47b4aSKees Cook next if ($line =~ m/^\s*$/); 51566b47b4aSKees Cook 51666b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 51766b47b4aSKees Cook 51866b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 51966b47b4aSKees Cook } 52066b47b4aSKees Cook close($spelling); 52136061e38SJoe Perches} else { 52236061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 52336061e38SJoe Perches} 52466b47b4aSKees Cook 525ebfd7d62SJoe Perchesif ($codespell) { 526ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 527ebfd7d62SJoe Perches while (<$spelling>) { 528ebfd7d62SJoe Perches my $line = $_; 529ebfd7d62SJoe Perches 530ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 531ebfd7d62SJoe Perches $line =~ s/^\s*//g; 532ebfd7d62SJoe Perches 533ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 534ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 535ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 536ebfd7d62SJoe Perches 537ebfd7d62SJoe Perches $line =~ s/,.*$//; 538ebfd7d62SJoe Perches 539ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 540ebfd7d62SJoe Perches 541ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 542ebfd7d62SJoe Perches } 543ebfd7d62SJoe Perches close($spelling); 544ebfd7d62SJoe Perches } else { 545ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 546ebfd7d62SJoe Perches } 547ebfd7d62SJoe Perches} 548ebfd7d62SJoe Perches 549ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 550ebfd7d62SJoe Perches 5518905a67cSAndy Whitcroftsub build_types { 552485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 553485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 5541813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5558716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 556c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 557ab7e23f3SJoe Perches $BasicType = qr{ 558ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 559ab7e23f3SJoe Perches (?:${all}\b) 560ab7e23f3SJoe Perches }x; 5618905a67cSAndy Whitcroft $NonptrType = qr{ 562d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 563cf655043SAndy Whitcroft (?: 5646b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 5658ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 566c45dcabdSAndy Whitcroft (?:${all}\b) 567cf655043SAndy Whitcroft ) 568c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5698905a67cSAndy Whitcroft }x; 5701813087dSJoe Perches $NonptrTypeMisordered = qr{ 5711813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5721813087dSJoe Perches (?: 5731813087dSJoe Perches (?:${Misordered}\b) 5741813087dSJoe Perches ) 5751813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5761813087dSJoe Perches }x; 5778716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5788716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5798716de38SJoe Perches (?: 5808716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5818716de38SJoe Perches (?:$typeTypedefs\b)| 5828716de38SJoe Perches (?:${allWithAttr}\b) 5838716de38SJoe Perches ) 5848716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5858716de38SJoe Perches }x; 5868905a67cSAndy Whitcroft $Type = qr{ 587c45dcabdSAndy Whitcroft $NonptrType 5881574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 589c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5908905a67cSAndy Whitcroft }x; 5911813087dSJoe Perches $TypeMisordered = qr{ 5921813087dSJoe Perches $NonptrTypeMisordered 5931813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5941813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5951813087dSJoe Perches }x; 59691cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5971813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5988905a67cSAndy Whitcroft} 5998905a67cSAndy Whitcroftbuild_types(); 6006c72ffaaSAndy Whitcroft 6017d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 602d1fe9c09SJoe Perches 603d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 604d1fe9c09SJoe Perches# requires at least perl version v5.10.0 605d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 606d1fe9c09SJoe Perches 607d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 6082435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 609c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 6107d2367afSJoe Perches 611f8422308SJoe Perchesour $declaration_macros = qr{(?x: 6123e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 613f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 614f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 615f8422308SJoe Perches)}; 616f8422308SJoe Perches 6177d2367afSJoe Perchessub deparenthesize { 6187d2367afSJoe Perches my ($string) = @_; 6197d2367afSJoe Perches return "" if (!defined($string)); 6205b9553abSJoe Perches 6215b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 6225b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 6235b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 6245b9553abSJoe Perches } 6255b9553abSJoe Perches 6267d2367afSJoe Perches $string =~ s@\s+@ @g; 6275b9553abSJoe Perches 6287d2367afSJoe Perches return $string; 6297d2367afSJoe Perches} 6307d2367afSJoe Perches 6313445686aSJoe Perchessub seed_camelcase_file { 6323445686aSJoe Perches my ($file) = @_; 6333445686aSJoe Perches 6343445686aSJoe Perches return if (!(-f $file)); 6353445686aSJoe Perches 6363445686aSJoe Perches local $/; 6373445686aSJoe Perches 6383445686aSJoe Perches open(my $include_file, '<', "$file") 6393445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6403445686aSJoe Perches my $text = <$include_file>; 6413445686aSJoe Perches close($include_file); 6423445686aSJoe Perches 6433445686aSJoe Perches my @lines = split('\n', $text); 6443445686aSJoe Perches 6453445686aSJoe Perches foreach my $line (@lines) { 6463445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6473445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6483445686aSJoe Perches $camelcase{$1} = 1; 64911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 65011ea516aSJoe Perches $camelcase{$1} = 1; 65111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6523445686aSJoe Perches $camelcase{$1} = 1; 6533445686aSJoe Perches } 6543445686aSJoe Perches } 6553445686aSJoe Perches} 6563445686aSJoe Perches 6573445686aSJoe Perchesmy $camelcase_seeded = 0; 6583445686aSJoe Perchessub seed_camelcase_includes { 6593445686aSJoe Perches return if ($camelcase_seeded); 6603445686aSJoe Perches 6613445686aSJoe Perches my $files; 662c707a81dSJoe Perches my $camelcase_cache = ""; 663c707a81dSJoe Perches my @include_files = (); 664c707a81dSJoe Perches 665c707a81dSJoe Perches $camelcase_seeded = 1; 666351b2a1fSJoe Perches 6673645e328SRichard Genoud if (-e ".git") { 668351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 669351b2a1fSJoe Perches chomp $git_last_include_commit; 670c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 671c707a81dSJoe Perches } else { 672c707a81dSJoe Perches my $last_mod_date = 0; 673c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 674c707a81dSJoe Perches @include_files = split('\n', $files); 675c707a81dSJoe Perches foreach my $file (@include_files) { 676c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 677c707a81dSJoe Perches localtime((stat $file)[9])); 678c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 679c707a81dSJoe Perches } 680c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 681c707a81dSJoe Perches } 682c707a81dSJoe Perches 683c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 684c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 685c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 686351b2a1fSJoe Perches while (<$camelcase_file>) { 687351b2a1fSJoe Perches chomp; 688351b2a1fSJoe Perches $camelcase{$_} = 1; 689351b2a1fSJoe Perches } 690351b2a1fSJoe Perches close($camelcase_file); 691351b2a1fSJoe Perches 692351b2a1fSJoe Perches return; 693351b2a1fSJoe Perches } 694c707a81dSJoe Perches 6953645e328SRichard Genoud if (-e ".git") { 696c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 697c707a81dSJoe Perches @include_files = split('\n', $files); 6983445686aSJoe Perches } 699c707a81dSJoe Perches 7003445686aSJoe Perches foreach my $file (@include_files) { 7013445686aSJoe Perches seed_camelcase_file($file); 7023445686aSJoe Perches } 703351b2a1fSJoe Perches 704c707a81dSJoe Perches if ($camelcase_cache ne "") { 705351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 706c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 707c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 708351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 709351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 710351b2a1fSJoe Perches } 711351b2a1fSJoe Perches close($camelcase_file); 712351b2a1fSJoe Perches } 7133445686aSJoe Perches} 7143445686aSJoe Perches 715d311cd44SJoe Perchessub git_commit_info { 716d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 717d311cd44SJoe Perches 718d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 719d311cd44SJoe Perches 720d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 721d311cd44SJoe Perches $output =~ s/^\s*//gm; 722d311cd44SJoe Perches my @lines = split("\n", $output); 723d311cd44SJoe Perches 7240d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 7250d7835fcSJoe Perches 726d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 727d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 728d311cd44SJoe Perches# all matching commit ids, but it's very slow... 729d311cd44SJoe Perches# 730d311cd44SJoe Perches# echo "checking commits $1..." 731d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 732d311cd44SJoe Perches# while read line ; do 733d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 734d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 735d311cd44SJoe Perches# done 736d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 737d311cd44SJoe Perches } else { 738d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 739d311cd44SJoe Perches $desc = substr($lines[0], 41); 740d311cd44SJoe Perches } 741d311cd44SJoe Perches 742d311cd44SJoe Perches return ($id, $desc); 743d311cd44SJoe Perches} 744d311cd44SJoe Perches 7456c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7460a920b5bSAndy Whitcroft 74700df344fSAndy Whitcroftmy @rawlines = (); 748c2fdda0dSAndy Whitcroftmy @lines = (); 7493705ce5bSJoe Perchesmy @fixed = (); 750d752fcc8SJoe Perchesmy @fixed_inserted = (); 751d752fcc8SJoe Perchesmy @fixed_deleted = (); 752194f66fcSJoe Perchesmy $fixlinenr = -1; 753194f66fcSJoe Perches 754c2fdda0dSAndy Whitcroftmy $vname; 7556c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 75621caa13cSAndy Whitcroft my $FILE; 7576c72ffaaSAndy Whitcroft if ($file) { 75821caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7596c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 76021caa13cSAndy Whitcroft } elsif ($filename eq '-') { 76121caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7626c72ffaaSAndy Whitcroft } else { 76321caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7646c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7656c72ffaaSAndy Whitcroft } 766c2fdda0dSAndy Whitcroft if ($filename eq '-') { 767c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 768c2fdda0dSAndy Whitcroft } else { 769c2fdda0dSAndy Whitcroft $vname = $filename; 770c2fdda0dSAndy Whitcroft } 77121caa13cSAndy Whitcroft while (<$FILE>) { 7720a920b5bSAndy Whitcroft chomp; 77300df344fSAndy Whitcroft push(@rawlines, $_); 7746c72ffaaSAndy Whitcroft } 77521caa13cSAndy Whitcroft close($FILE); 776d8469f16SJoe Perches 777d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 778d8469f16SJoe Perches print '-' x length($vname) . "\n"; 779d8469f16SJoe Perches print "$vname\n"; 780d8469f16SJoe Perches print '-' x length($vname) . "\n"; 781d8469f16SJoe Perches } 782d8469f16SJoe Perches 783c2fdda0dSAndy Whitcroft if (!process($filename)) { 7840a920b5bSAndy Whitcroft $exit = 1; 7850a920b5bSAndy Whitcroft } 78600df344fSAndy Whitcroft @rawlines = (); 78713214adfSAndy Whitcroft @lines = (); 7883705ce5bSJoe Perches @fixed = (); 789d752fcc8SJoe Perches @fixed_inserted = (); 790d752fcc8SJoe Perches @fixed_deleted = (); 791194f66fcSJoe Perches $fixlinenr = -1; 792485ff23eSAlex Dowad @modifierListFile = (); 793485ff23eSAlex Dowad @typeListFile = (); 794485ff23eSAlex Dowad build_types(); 7950a920b5bSAndy Whitcroft} 7960a920b5bSAndy Whitcroft 797d8469f16SJoe Perchesif (!$quiet) { 7983c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 7993c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 8003c816e49SJoe Perches 801d8469f16SJoe Perches if ($^V lt 5.10.0) { 802d8469f16SJoe Perches print << "EOM" 803d8469f16SJoe Perches 804d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 805d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 806d8469f16SJoe PerchesEOM 807d8469f16SJoe Perches } 808d8469f16SJoe Perches if ($exit) { 809d8469f16SJoe Perches print << "EOM" 810d8469f16SJoe Perches 811d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 812d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 813d8469f16SJoe PerchesEOM 814d8469f16SJoe Perches } 815d8469f16SJoe Perches} 816d8469f16SJoe Perches 8170a920b5bSAndy Whitcroftexit($exit); 8180a920b5bSAndy Whitcroft 8190a920b5bSAndy Whitcroftsub top_of_kernel_tree { 8206c72ffaaSAndy Whitcroft my ($root) = @_; 8216c72ffaaSAndy Whitcroft 8226c72ffaaSAndy Whitcroft my @tree_check = ( 8236c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 8246c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 8256c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 8266c72ffaaSAndy Whitcroft ); 8276c72ffaaSAndy Whitcroft 8286c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 8296c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 8300a920b5bSAndy Whitcroft return 0; 8310a920b5bSAndy Whitcroft } 8326c72ffaaSAndy Whitcroft } 8336c72ffaaSAndy Whitcroft return 1; 8346c72ffaaSAndy Whitcroft} 8350a920b5bSAndy Whitcroft 83620112475SJoe Perchessub parse_email { 83720112475SJoe Perches my ($formatted_email) = @_; 83820112475SJoe Perches 83920112475SJoe Perches my $name = ""; 84020112475SJoe Perches my $address = ""; 84120112475SJoe Perches my $comment = ""; 84220112475SJoe Perches 84320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 84420112475SJoe Perches $name = $1; 84520112475SJoe Perches $address = $2; 84620112475SJoe Perches $comment = $3 if defined $3; 84720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 84820112475SJoe Perches $address = $1; 84920112475SJoe Perches $comment = $2 if defined $2; 85020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 85120112475SJoe Perches $address = $1; 85220112475SJoe Perches $comment = $2 if defined $2; 85320112475SJoe Perches $formatted_email =~ s/$address.*$//; 85420112475SJoe Perches $name = $formatted_email; 8553705ce5bSJoe Perches $name = trim($name); 85620112475SJoe Perches $name =~ s/^\"|\"$//g; 85720112475SJoe Perches # If there's a name left after stripping spaces and 85820112475SJoe Perches # leading quotes, and the address doesn't have both 85920112475SJoe Perches # leading and trailing angle brackets, the address 86020112475SJoe Perches # is invalid. ie: 86120112475SJoe Perches # "joe smith [email protected]" bad 86220112475SJoe Perches # "joe smith <[email protected]" bad 86320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 86420112475SJoe Perches $name = ""; 86520112475SJoe Perches $address = ""; 86620112475SJoe Perches $comment = ""; 86720112475SJoe Perches } 86820112475SJoe Perches } 86920112475SJoe Perches 8703705ce5bSJoe Perches $name = trim($name); 87120112475SJoe Perches $name =~ s/^\"|\"$//g; 8723705ce5bSJoe Perches $address = trim($address); 87320112475SJoe Perches $address =~ s/^\<|\>$//g; 87420112475SJoe Perches 87520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 87620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 87720112475SJoe Perches $name = "\"$name\""; 87820112475SJoe Perches } 87920112475SJoe Perches 88020112475SJoe Perches return ($name, $address, $comment); 88120112475SJoe Perches} 88220112475SJoe Perches 88320112475SJoe Perchessub format_email { 88420112475SJoe Perches my ($name, $address) = @_; 88520112475SJoe Perches 88620112475SJoe Perches my $formatted_email; 88720112475SJoe Perches 8883705ce5bSJoe Perches $name = trim($name); 88920112475SJoe Perches $name =~ s/^\"|\"$//g; 8903705ce5bSJoe Perches $address = trim($address); 89120112475SJoe Perches 89220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 89320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 89420112475SJoe Perches $name = "\"$name\""; 89520112475SJoe Perches } 89620112475SJoe Perches 89720112475SJoe Perches if ("$name" eq "") { 89820112475SJoe Perches $formatted_email = "$address"; 89920112475SJoe Perches } else { 90020112475SJoe Perches $formatted_email = "$name <$address>"; 90120112475SJoe Perches } 90220112475SJoe Perches 90320112475SJoe Perches return $formatted_email; 90420112475SJoe Perches} 90520112475SJoe Perches 906d311cd44SJoe Perchessub which { 907d311cd44SJoe Perches my ($bin) = @_; 908d311cd44SJoe Perches 909d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 910d311cd44SJoe Perches if (-e "$path/$bin") { 911d311cd44SJoe Perches return "$path/$bin"; 912d311cd44SJoe Perches } 913d311cd44SJoe Perches } 914d311cd44SJoe Perches 915d311cd44SJoe Perches return ""; 916d311cd44SJoe Perches} 917d311cd44SJoe Perches 918000d1cc1SJoe Perchessub which_conf { 919000d1cc1SJoe Perches my ($conf) = @_; 920000d1cc1SJoe Perches 921000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 922000d1cc1SJoe Perches if (-e "$path/$conf") { 923000d1cc1SJoe Perches return "$path/$conf"; 924000d1cc1SJoe Perches } 925000d1cc1SJoe Perches } 926000d1cc1SJoe Perches 927000d1cc1SJoe Perches return ""; 928000d1cc1SJoe Perches} 929000d1cc1SJoe Perches 9300a920b5bSAndy Whitcroftsub expand_tabs { 9310a920b5bSAndy Whitcroft my ($str) = @_; 9320a920b5bSAndy Whitcroft 9330a920b5bSAndy Whitcroft my $res = ''; 9340a920b5bSAndy Whitcroft my $n = 0; 9350a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 9360a920b5bSAndy Whitcroft if ($c eq "\t") { 9370a920b5bSAndy Whitcroft $res .= ' '; 9380a920b5bSAndy Whitcroft $n++; 9390a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 9400a920b5bSAndy Whitcroft $res .= ' '; 9410a920b5bSAndy Whitcroft } 9420a920b5bSAndy Whitcroft next; 9430a920b5bSAndy Whitcroft } 9440a920b5bSAndy Whitcroft $res .= $c; 9450a920b5bSAndy Whitcroft $n++; 9460a920b5bSAndy Whitcroft } 9470a920b5bSAndy Whitcroft 9480a920b5bSAndy Whitcroft return $res; 9490a920b5bSAndy Whitcroft} 9506c72ffaaSAndy Whitcroftsub copy_spacing { 951773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 9526c72ffaaSAndy Whitcroft return $res; 9536c72ffaaSAndy Whitcroft} 9540a920b5bSAndy Whitcroft 9554a0df2efSAndy Whitcroftsub line_stats { 9564a0df2efSAndy Whitcroft my ($line) = @_; 9574a0df2efSAndy Whitcroft 9584a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 9594a0df2efSAndy Whitcroft $line =~ s/^.//; 9604a0df2efSAndy Whitcroft $line = expand_tabs($line); 9614a0df2efSAndy Whitcroft 9624a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 9634a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9644a0df2efSAndy Whitcroft 9654a0df2efSAndy Whitcroft return (length($line), length($white)); 9664a0df2efSAndy Whitcroft} 9674a0df2efSAndy Whitcroft 968773647a0SAndy Whitcroftmy $sanitise_quote = ''; 969773647a0SAndy Whitcroft 970773647a0SAndy Whitcroftsub sanitise_line_reset { 971773647a0SAndy Whitcroft my ($in_comment) = @_; 972773647a0SAndy Whitcroft 973773647a0SAndy Whitcroft if ($in_comment) { 974773647a0SAndy Whitcroft $sanitise_quote = '*/'; 975773647a0SAndy Whitcroft } else { 976773647a0SAndy Whitcroft $sanitise_quote = ''; 977773647a0SAndy Whitcroft } 978773647a0SAndy Whitcroft} 97900df344fSAndy Whitcroftsub sanitise_line { 98000df344fSAndy Whitcroft my ($line) = @_; 98100df344fSAndy Whitcroft 98200df344fSAndy Whitcroft my $res = ''; 98300df344fSAndy Whitcroft my $l = ''; 98400df344fSAndy Whitcroft 985c2fdda0dSAndy Whitcroft my $qlen = 0; 986773647a0SAndy Whitcroft my $off = 0; 987773647a0SAndy Whitcroft my $c; 98800df344fSAndy Whitcroft 989773647a0SAndy Whitcroft # Always copy over the diff marker. 990773647a0SAndy Whitcroft $res = substr($line, 0, 1); 991773647a0SAndy Whitcroft 992773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 993773647a0SAndy Whitcroft $c = substr($line, $off, 1); 994773647a0SAndy Whitcroft 995773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 996773647a0SAndy Whitcroft # and end, all to $;. 997773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 998773647a0SAndy Whitcroft $sanitise_quote = '*/'; 999773647a0SAndy Whitcroft 1000773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1001773647a0SAndy Whitcroft $off++; 100200df344fSAndy Whitcroft next; 1003773647a0SAndy Whitcroft } 100481bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1005773647a0SAndy Whitcroft $sanitise_quote = ''; 1006773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 1007773647a0SAndy Whitcroft $off++; 1008773647a0SAndy Whitcroft next; 1009773647a0SAndy Whitcroft } 1010113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1011113f04a8SDaniel Walker $sanitise_quote = '//'; 1012113f04a8SDaniel Walker 1013113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 1014113f04a8SDaniel Walker $off++; 1015113f04a8SDaniel Walker next; 1016113f04a8SDaniel Walker } 1017773647a0SAndy Whitcroft 1018773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 1019773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1020773647a0SAndy Whitcroft $c eq "\\") { 1021773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1022773647a0SAndy Whitcroft $off++; 1023773647a0SAndy Whitcroft next; 1024773647a0SAndy Whitcroft } 1025773647a0SAndy Whitcroft # Regular quotes. 1026773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1027773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1028773647a0SAndy Whitcroft $sanitise_quote = $c; 1029773647a0SAndy Whitcroft 1030773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1031773647a0SAndy Whitcroft next; 1032773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1033773647a0SAndy Whitcroft $sanitise_quote = ''; 103400df344fSAndy Whitcroft } 103500df344fSAndy Whitcroft } 1036773647a0SAndy Whitcroft 1037fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1038773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1039773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1040113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1041113f04a8SDaniel Walker substr($res, $off, 1, $;); 1042773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1043773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 104400df344fSAndy Whitcroft } else { 1045773647a0SAndy Whitcroft substr($res, $off, 1, $c); 104600df344fSAndy Whitcroft } 1047c2fdda0dSAndy Whitcroft } 1048c2fdda0dSAndy Whitcroft 1049113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1050113f04a8SDaniel Walker $sanitise_quote = ''; 1051113f04a8SDaniel Walker } 1052113f04a8SDaniel Walker 1053c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1054c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1055c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1056c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1057c2fdda0dSAndy Whitcroft 1058c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1059c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1060c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1061c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1062c2fdda0dSAndy Whitcroft } 1063c2fdda0dSAndy Whitcroft 106400df344fSAndy Whitcroft return $res; 106500df344fSAndy Whitcroft} 106600df344fSAndy Whitcroft 1067a6962d72SJoe Perchessub get_quoted_string { 1068a6962d72SJoe Perches my ($line, $rawline) = @_; 1069a6962d72SJoe Perches 107033acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1071a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1072a6962d72SJoe Perches} 1073a6962d72SJoe Perches 10748905a67cSAndy Whitcroftsub ctx_statement_block { 10758905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10768905a67cSAndy Whitcroft my $line = $linenr - 1; 10778905a67cSAndy Whitcroft my $blk = ''; 10788905a67cSAndy Whitcroft my $soff = $off; 10798905a67cSAndy Whitcroft my $coff = $off - 1; 1080773647a0SAndy Whitcroft my $coff_set = 0; 10818905a67cSAndy Whitcroft 108213214adfSAndy Whitcroft my $loff = 0; 108313214adfSAndy Whitcroft 10848905a67cSAndy Whitcroft my $type = ''; 10858905a67cSAndy Whitcroft my $level = 0; 1086a2750645SAndy Whitcroft my @stack = (); 1087cf655043SAndy Whitcroft my $p; 10888905a67cSAndy Whitcroft my $c; 10898905a67cSAndy Whitcroft my $len = 0; 109013214adfSAndy Whitcroft 109113214adfSAndy Whitcroft my $remainder; 10928905a67cSAndy Whitcroft while (1) { 1093a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1094a2750645SAndy Whitcroft 1095773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10968905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10978905a67cSAndy Whitcroft # context. 10988905a67cSAndy Whitcroft if ($off >= $len) { 10998905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1100dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1101c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 11028905a67cSAndy Whitcroft $remain--; 110313214adfSAndy Whitcroft $loff = $len; 1104c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 11058905a67cSAndy Whitcroft $len = length($blk); 11068905a67cSAndy Whitcroft $line++; 11078905a67cSAndy Whitcroft last; 11088905a67cSAndy Whitcroft } 11098905a67cSAndy Whitcroft # Bail if there is no further context. 11108905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 111113214adfSAndy Whitcroft if ($off >= $len) { 11128905a67cSAndy Whitcroft last; 11138905a67cSAndy Whitcroft } 1114f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1115f74bd194SAndy Whitcroft $level++; 1116f74bd194SAndy Whitcroft $type = '#'; 1117f74bd194SAndy Whitcroft } 11188905a67cSAndy Whitcroft } 1119cf655043SAndy Whitcroft $p = $c; 11208905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 112113214adfSAndy Whitcroft $remainder = substr($blk, $off); 11228905a67cSAndy Whitcroft 1123773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 11244635f4fbSAndy Whitcroft 11254635f4fbSAndy Whitcroft # Handle nested #if/#else. 11264635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 11274635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 11284635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 11294635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 11304635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 11314635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 11324635f4fbSAndy Whitcroft } 11334635f4fbSAndy Whitcroft 11348905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 11358905a67cSAndy Whitcroft # outermost level. 11368905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 11378905a67cSAndy Whitcroft last; 11388905a67cSAndy Whitcroft } 11398905a67cSAndy Whitcroft 114013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1141773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1142773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1143773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1144773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1145773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1146773647a0SAndy Whitcroft $coff_set = 1; 1147773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1148773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 114913214adfSAndy Whitcroft } 115013214adfSAndy Whitcroft 11518905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 11528905a67cSAndy Whitcroft $level++; 11538905a67cSAndy Whitcroft $type = '('; 11548905a67cSAndy Whitcroft } 11558905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 11568905a67cSAndy Whitcroft $level--; 11578905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 11588905a67cSAndy Whitcroft 11598905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 11608905a67cSAndy Whitcroft $coff = $off; 1161773647a0SAndy Whitcroft $coff_set = 1; 1162773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 11638905a67cSAndy Whitcroft } 11648905a67cSAndy Whitcroft } 11658905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11668905a67cSAndy Whitcroft $level++; 11678905a67cSAndy Whitcroft $type = '{'; 11688905a67cSAndy Whitcroft } 11698905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11708905a67cSAndy Whitcroft $level--; 11718905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11728905a67cSAndy Whitcroft 11738905a67cSAndy Whitcroft if ($level == 0) { 1174b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1175b998e001SPatrick Pannuto $off++; 1176b998e001SPatrick Pannuto } 11778905a67cSAndy Whitcroft last; 11788905a67cSAndy Whitcroft } 11798905a67cSAndy Whitcroft } 1180f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1181f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1182f74bd194SAndy Whitcroft $level--; 1183f74bd194SAndy Whitcroft $type = ''; 1184f74bd194SAndy Whitcroft $off++; 1185f74bd194SAndy Whitcroft last; 1186f74bd194SAndy Whitcroft } 11878905a67cSAndy Whitcroft $off++; 11888905a67cSAndy Whitcroft } 1189a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 119013214adfSAndy Whitcroft if ($off == $len) { 1191a3bb97a7SAndy Whitcroft $loff = $len + 1; 119213214adfSAndy Whitcroft $line++; 119313214adfSAndy Whitcroft $remain--; 119413214adfSAndy Whitcroft } 11958905a67cSAndy Whitcroft 11968905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11978905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11988905a67cSAndy Whitcroft 11998905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 12008905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 12018905a67cSAndy Whitcroft 1202773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 120313214adfSAndy Whitcroft 120413214adfSAndy Whitcroft return ($statement, $condition, 120513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 120613214adfSAndy Whitcroft} 120713214adfSAndy Whitcroft 1208cf655043SAndy Whitcroftsub statement_lines { 1209cf655043SAndy Whitcroft my ($stmt) = @_; 1210cf655043SAndy Whitcroft 1211cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1212cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1213cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1214cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1215cf655043SAndy Whitcroft 1216cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1217cf655043SAndy Whitcroft 1218cf655043SAndy Whitcroft return $#stmt_lines + 2; 1219cf655043SAndy Whitcroft} 1220cf655043SAndy Whitcroft 1221cf655043SAndy Whitcroftsub statement_rawlines { 1222cf655043SAndy Whitcroft my ($stmt) = @_; 1223cf655043SAndy Whitcroft 1224cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1225cf655043SAndy Whitcroft 1226cf655043SAndy Whitcroft return $#stmt_lines + 2; 1227cf655043SAndy Whitcroft} 1228cf655043SAndy Whitcroft 1229cf655043SAndy Whitcroftsub statement_block_size { 1230cf655043SAndy Whitcroft my ($stmt) = @_; 1231cf655043SAndy Whitcroft 1232cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1233cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1234cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1235cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1236cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1237cf655043SAndy Whitcroft 1238cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1239cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1240cf655043SAndy Whitcroft 1241cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1242cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1243cf655043SAndy Whitcroft 1244cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1245cf655043SAndy Whitcroft return $stmt_lines; 1246cf655043SAndy Whitcroft } else { 1247cf655043SAndy Whitcroft return $stmt_statements; 1248cf655043SAndy Whitcroft } 1249cf655043SAndy Whitcroft} 1250cf655043SAndy Whitcroft 125113214adfSAndy Whitcroftsub ctx_statement_full { 125213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 125313214adfSAndy Whitcroft my ($statement, $condition, $level); 125413214adfSAndy Whitcroft 125513214adfSAndy Whitcroft my (@chunks); 125613214adfSAndy Whitcroft 1257cf655043SAndy Whitcroft # Grab the first conditional/block pair. 125813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 125913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1260773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 126113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1262cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1263cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1264cf655043SAndy Whitcroft } 1265cf655043SAndy Whitcroft 1266cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1267cf655043SAndy Whitcroft # could continue the statement. 1268cf655043SAndy Whitcroft for (;;) { 126913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 127013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1271cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1272773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1273cf655043SAndy Whitcroft #print "C: push\n"; 1274cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 127513214adfSAndy Whitcroft } 127613214adfSAndy Whitcroft 127713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12788905a67cSAndy Whitcroft} 12798905a67cSAndy Whitcroft 12804a0df2efSAndy Whitcroftsub ctx_block_get { 1281f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12824a0df2efSAndy Whitcroft my $line; 12834a0df2efSAndy Whitcroft my $start = $linenr - 1; 12844a0df2efSAndy Whitcroft my $blk = ''; 12854a0df2efSAndy Whitcroft my @o; 12864a0df2efSAndy Whitcroft my @c; 12874a0df2efSAndy Whitcroft my @res = (); 12884a0df2efSAndy Whitcroft 1289f0a594c1SAndy Whitcroft my $level = 0; 12904635f4fbSAndy Whitcroft my @stack = ($level); 129100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 129200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 129300df344fSAndy Whitcroft $remain--; 129400df344fSAndy Whitcroft 129500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12964635f4fbSAndy Whitcroft 12974635f4fbSAndy Whitcroft # Handle nested #if/#else. 129801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12994635f4fbSAndy Whitcroft push(@stack, $level); 130001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 13014635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 130201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 13034635f4fbSAndy Whitcroft $level = pop(@stack); 13044635f4fbSAndy Whitcroft } 13054635f4fbSAndy Whitcroft 130601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1307f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1308f0a594c1SAndy Whitcroft if ($off > 0) { 1309f0a594c1SAndy Whitcroft $off--; 1310f0a594c1SAndy Whitcroft next; 1311f0a594c1SAndy Whitcroft } 13124a0df2efSAndy Whitcroft 1313f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1314f0a594c1SAndy Whitcroft $level--; 1315f0a594c1SAndy Whitcroft last if ($level == 0); 1316f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1317f0a594c1SAndy Whitcroft $level++; 1318f0a594c1SAndy Whitcroft } 1319f0a594c1SAndy Whitcroft } 13204a0df2efSAndy Whitcroft 1321f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 132200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 13234a0df2efSAndy Whitcroft } 13244a0df2efSAndy Whitcroft 1325f0a594c1SAndy Whitcroft last if ($level == 0); 13264a0df2efSAndy Whitcroft } 13274a0df2efSAndy Whitcroft 1328f0a594c1SAndy Whitcroft return ($level, @res); 13294a0df2efSAndy Whitcroft} 13304a0df2efSAndy Whitcroftsub ctx_block_outer { 13314a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13324a0df2efSAndy Whitcroft 1333f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1334f0a594c1SAndy Whitcroft return @r; 13354a0df2efSAndy Whitcroft} 13364a0df2efSAndy Whitcroftsub ctx_block { 13374a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13384a0df2efSAndy Whitcroft 1339f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1340f0a594c1SAndy Whitcroft return @r; 1341653d4876SAndy Whitcroft} 1342653d4876SAndy Whitcroftsub ctx_statement { 1343f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1344f0a594c1SAndy Whitcroft 1345f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1346f0a594c1SAndy Whitcroft return @r; 1347f0a594c1SAndy Whitcroft} 1348f0a594c1SAndy Whitcroftsub ctx_block_level { 1349653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1350653d4876SAndy Whitcroft 1351f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 13524a0df2efSAndy Whitcroft} 13539c0ca6f9SAndy Whitcroftsub ctx_statement_level { 13549c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 13559c0ca6f9SAndy Whitcroft 13569c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 13579c0ca6f9SAndy Whitcroft} 13584a0df2efSAndy Whitcroft 13594a0df2efSAndy Whitcroftsub ctx_locate_comment { 13604a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13614a0df2efSAndy Whitcroft 13624a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1363beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13644a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13654a0df2efSAndy Whitcroft 13664a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13674a0df2efSAndy Whitcroft # comment. 13684a0df2efSAndy Whitcroft my $in_comment = 0; 13694a0df2efSAndy Whitcroft $current_comment = ''; 13704a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 137100df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 137200df344fSAndy Whitcroft #warn " $line\n"; 13734a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13744a0df2efSAndy Whitcroft $in_comment = 1; 13754a0df2efSAndy Whitcroft } 13764a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13774a0df2efSAndy Whitcroft $in_comment = 1; 13784a0df2efSAndy Whitcroft } 13794a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13804a0df2efSAndy Whitcroft $current_comment = ''; 13814a0df2efSAndy Whitcroft } 13824a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13834a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13844a0df2efSAndy Whitcroft $in_comment = 0; 13854a0df2efSAndy Whitcroft } 13864a0df2efSAndy Whitcroft } 13874a0df2efSAndy Whitcroft 13884a0df2efSAndy Whitcroft chomp($current_comment); 13894a0df2efSAndy Whitcroft return($current_comment); 13904a0df2efSAndy Whitcroft} 13914a0df2efSAndy Whitcroftsub ctx_has_comment { 13924a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13934a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13944a0df2efSAndy Whitcroft 139500df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13964a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13974a0df2efSAndy Whitcroft 13984a0df2efSAndy Whitcroft return ($cmt ne ''); 13994a0df2efSAndy Whitcroft} 14004a0df2efSAndy Whitcroft 14014d001e4dSAndy Whitcroftsub raw_line { 14024d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 14034d001e4dSAndy Whitcroft 14044d001e4dSAndy Whitcroft my $offset = $linenr - 1; 14054d001e4dSAndy Whitcroft $cnt++; 14064d001e4dSAndy Whitcroft 14074d001e4dSAndy Whitcroft my $line; 14084d001e4dSAndy Whitcroft while ($cnt) { 14094d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 14104d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 14114d001e4dSAndy Whitcroft $cnt--; 14124d001e4dSAndy Whitcroft } 14134d001e4dSAndy Whitcroft 14144d001e4dSAndy Whitcroft return $line; 14154d001e4dSAndy Whitcroft} 14164d001e4dSAndy Whitcroft 14170a920b5bSAndy Whitcroftsub cat_vet { 14180a920b5bSAndy Whitcroft my ($vet) = @_; 14199c0ca6f9SAndy Whitcroft my ($res, $coded); 14200a920b5bSAndy Whitcroft 14219c0ca6f9SAndy Whitcroft $res = ''; 14226c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 14236c72ffaaSAndy Whitcroft $res .= $1; 14246c72ffaaSAndy Whitcroft if ($2 ne '') { 14259c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 14266c72ffaaSAndy Whitcroft $res .= $coded; 14276c72ffaaSAndy Whitcroft } 14289c0ca6f9SAndy Whitcroft } 14299c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 14300a920b5bSAndy Whitcroft 14319c0ca6f9SAndy Whitcroft return $res; 14320a920b5bSAndy Whitcroft} 14330a920b5bSAndy Whitcroft 1434c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1435cf655043SAndy Whitcroftmy $av_pending; 1436c2fdda0dSAndy Whitcroftmy @av_paren_type; 14371f65f947SAndy Whitcroftmy $av_pend_colon; 1438c2fdda0dSAndy Whitcroft 1439c2fdda0dSAndy Whitcroftsub annotate_reset { 1440c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1441cf655043SAndy Whitcroft $av_pending = '_'; 1442cf655043SAndy Whitcroft @av_paren_type = ('E'); 14431f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1444c2fdda0dSAndy Whitcroft} 1445c2fdda0dSAndy Whitcroft 14466c72ffaaSAndy Whitcroftsub annotate_values { 14476c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 14486c72ffaaSAndy Whitcroft 14496c72ffaaSAndy Whitcroft my $res; 14501f65f947SAndy Whitcroft my $var = '_' x length($stream); 14516c72ffaaSAndy Whitcroft my $cur = $stream; 14526c72ffaaSAndy Whitcroft 1453c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 14546c72ffaaSAndy Whitcroft 14556c72ffaaSAndy Whitcroft while (length($cur)) { 1456773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1457cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1458171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 14596c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1460c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1461c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1462cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1463c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14646c72ffaaSAndy Whitcroft } 14656c72ffaaSAndy Whitcroft 1466c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14679446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14689446ef56SAndy Whitcroft push(@av_paren_type, $type); 1469addcdceaSAndy Whitcroft $type = 'c'; 14709446ef56SAndy Whitcroft 1471e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1472c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14736c72ffaaSAndy Whitcroft $type = 'T'; 14746c72ffaaSAndy Whitcroft 1475389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1476389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1477389a2fe5SAndy Whitcroft $type = 'T'; 1478389a2fe5SAndy Whitcroft 1479c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1480171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1481c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1482171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1483171ae1a4SAndy Whitcroft if ($2 ne '') { 1484cf655043SAndy Whitcroft $av_pending = 'N'; 1485171ae1a4SAndy Whitcroft } 1486171ae1a4SAndy Whitcroft $type = 'E'; 1487171ae1a4SAndy Whitcroft 1488c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1489171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1490171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1491171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14926c72ffaaSAndy Whitcroft 1493c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1494cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1495c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1496cf655043SAndy Whitcroft 1497cf655043SAndy Whitcroft push(@av_paren_type, $type); 1498cf655043SAndy Whitcroft push(@av_paren_type, $type); 1499171ae1a4SAndy Whitcroft $type = 'E'; 1500cf655043SAndy Whitcroft 1501c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1502cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1503cf655043SAndy Whitcroft $av_preprocessor = 1; 1504cf655043SAndy Whitcroft 1505cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1506cf655043SAndy Whitcroft 1507171ae1a4SAndy Whitcroft $type = 'E'; 1508cf655043SAndy Whitcroft 1509c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1510cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1511cf655043SAndy Whitcroft 1512cf655043SAndy Whitcroft $av_preprocessor = 1; 1513cf655043SAndy Whitcroft 1514cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1515cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1516cf655043SAndy Whitcroft pop(@av_paren_type); 1517cf655043SAndy Whitcroft push(@av_paren_type, $type); 1518171ae1a4SAndy Whitcroft $type = 'E'; 15196c72ffaaSAndy Whitcroft 15206c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1521c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 15226c72ffaaSAndy Whitcroft 1523171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1524171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1525171ae1a4SAndy Whitcroft $av_pending = $type; 1526171ae1a4SAndy Whitcroft $type = 'N'; 1527171ae1a4SAndy Whitcroft 15286c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1529c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 15306c72ffaaSAndy Whitcroft if (defined $2) { 1531cf655043SAndy Whitcroft $av_pending = 'V'; 15326c72ffaaSAndy Whitcroft } 15336c72ffaaSAndy Whitcroft $type = 'N'; 15346c72ffaaSAndy Whitcroft 153514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1536c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 153714b111c1SAndy Whitcroft $av_pending = 'E'; 15386c72ffaaSAndy Whitcroft $type = 'N'; 15396c72ffaaSAndy Whitcroft 15401f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 15411f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 15421f65f947SAndy Whitcroft $av_pend_colon = 'C'; 15431f65f947SAndy Whitcroft $type = 'N'; 15441f65f947SAndy Whitcroft 154514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1546c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 15476c72ffaaSAndy Whitcroft $type = 'N'; 15486c72ffaaSAndy Whitcroft 15496c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1550c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1551cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1552cf655043SAndy Whitcroft $av_pending = '_'; 15536c72ffaaSAndy Whitcroft $type = 'N'; 15546c72ffaaSAndy Whitcroft 15556c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1556cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1557cf655043SAndy Whitcroft if ($new_type ne '_') { 1558cf655043SAndy Whitcroft $type = $new_type; 1559c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1560c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 15616c72ffaaSAndy Whitcroft } else { 1562c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 15636c72ffaaSAndy Whitcroft } 15646c72ffaaSAndy Whitcroft 1565c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1566c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1567c8cb2ca3SAndy Whitcroft $type = 'V'; 1568cf655043SAndy Whitcroft $av_pending = 'V'; 15696c72ffaaSAndy Whitcroft 15708e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15718e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15721f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15738e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15748e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15751f65f947SAndy Whitcroft } 15761f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15771f65f947SAndy Whitcroft $type = 'V'; 15781f65f947SAndy Whitcroft 15796c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1580c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15816c72ffaaSAndy Whitcroft $type = 'V'; 15826c72ffaaSAndy Whitcroft 15836c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1584c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15856c72ffaaSAndy Whitcroft $type = 'N'; 15866c72ffaaSAndy Whitcroft 1587cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1588c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 158913214adfSAndy Whitcroft $type = 'E'; 15901f65f947SAndy Whitcroft $av_pend_colon = 'O'; 159113214adfSAndy Whitcroft 15928e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15938e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15948e761b04SAndy Whitcroft $type = 'C'; 15958e761b04SAndy Whitcroft 15961f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15971f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15981f65f947SAndy Whitcroft $type = 'N'; 15991f65f947SAndy Whitcroft 16001f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 16011f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 16021f65f947SAndy Whitcroft 16031f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 16041f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 16051f65f947SAndy Whitcroft $type = 'E'; 16061f65f947SAndy Whitcroft } else { 16071f65f947SAndy Whitcroft $type = 'N'; 16081f65f947SAndy Whitcroft } 16091f65f947SAndy Whitcroft $av_pend_colon = 'O'; 16101f65f947SAndy Whitcroft 16118e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 161213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 16136c72ffaaSAndy Whitcroft $type = 'N'; 16146c72ffaaSAndy Whitcroft 16150d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 161674048ed8SAndy Whitcroft my $variant; 161774048ed8SAndy Whitcroft 161874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 161974048ed8SAndy Whitcroft if ($type eq 'V') { 162074048ed8SAndy Whitcroft $variant = 'B'; 162174048ed8SAndy Whitcroft } else { 162274048ed8SAndy Whitcroft $variant = 'U'; 162374048ed8SAndy Whitcroft } 162474048ed8SAndy Whitcroft 162574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 162674048ed8SAndy Whitcroft $type = 'N'; 162774048ed8SAndy Whitcroft 16286c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1629c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 16306c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 16316c72ffaaSAndy Whitcroft $type = 'N'; 16326c72ffaaSAndy Whitcroft } 16336c72ffaaSAndy Whitcroft 16346c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1635c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 16366c72ffaaSAndy Whitcroft } 16376c72ffaaSAndy Whitcroft if (defined $1) { 16386c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 16396c72ffaaSAndy Whitcroft $res .= $type x length($1); 16406c72ffaaSAndy Whitcroft } 16416c72ffaaSAndy Whitcroft } 16426c72ffaaSAndy Whitcroft 16431f65f947SAndy Whitcroft return ($res, $var); 16446c72ffaaSAndy Whitcroft} 16456c72ffaaSAndy Whitcroft 16468905a67cSAndy Whitcroftsub possible { 164713214adfSAndy Whitcroft my ($possible, $line) = @_; 16489a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 16490776e594SAndy Whitcroft ^(?: 16500776e594SAndy Whitcroft $Modifier| 16510776e594SAndy Whitcroft $Storage| 16520776e594SAndy Whitcroft $Type| 16539a974fdbSAndy Whitcroft DEFINE_\S+ 16549a974fdbSAndy Whitcroft )$| 16559a974fdbSAndy Whitcroft ^(?: 16560776e594SAndy Whitcroft goto| 16570776e594SAndy Whitcroft return| 16580776e594SAndy Whitcroft case| 16590776e594SAndy Whitcroft else| 16600776e594SAndy Whitcroft asm|__asm__| 166189a88353SAndy Whitcroft do| 166289a88353SAndy Whitcroft \#| 166389a88353SAndy Whitcroft \#\#| 16649a974fdbSAndy Whitcroft )(?:\s|$)| 16650776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16669a974fdbSAndy Whitcroft )}x; 16679a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16689a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1669c45dcabdSAndy Whitcroft # Check for modifiers. 1670c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1671c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1672c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1673c45dcabdSAndy Whitcroft 1674c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1675c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1676d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16779a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1678d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1679485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1680d2506586SAndy Whitcroft } 16819a974fdbSAndy Whitcroft } 1682c45dcabdSAndy Whitcroft 1683c45dcabdSAndy Whitcroft } else { 168413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1685485ff23eSAlex Dowad push(@typeListFile, $possible); 1686c45dcabdSAndy Whitcroft } 16878905a67cSAndy Whitcroft build_types(); 16880776e594SAndy Whitcroft } else { 16890776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16908905a67cSAndy Whitcroft } 16918905a67cSAndy Whitcroft} 16928905a67cSAndy Whitcroft 16936c72ffaaSAndy Whitcroftmy $prefix = ''; 16946c72ffaaSAndy Whitcroft 1695000d1cc1SJoe Perchessub show_type { 1696cbec18afSJoe Perches my ($type) = @_; 169791bfe484SJoe Perches 1698cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1699cbec18afSJoe Perches 1700cbec18afSJoe Perches return !defined $ignore_type{$type}; 1701000d1cc1SJoe Perches} 1702000d1cc1SJoe Perches 1703f0a594c1SAndy Whitcroftsub report { 1704cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1705cbec18afSJoe Perches 1706cbec18afSJoe Perches if (!show_type($type) || 1707cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1708773647a0SAndy Whitcroft return 0; 1709773647a0SAndy Whitcroft } 171057230297SJoe Perches my $output = ''; 171157230297SJoe Perches if (-t STDOUT && $color) { 171257230297SJoe Perches if ($level eq 'ERROR') { 171357230297SJoe Perches $output .= RED; 171457230297SJoe Perches } elsif ($level eq 'WARNING') { 171557230297SJoe Perches $output .= YELLOW; 1716000d1cc1SJoe Perches } else { 171757230297SJoe Perches $output .= GREEN; 1718000d1cc1SJoe Perches } 171957230297SJoe Perches } 172057230297SJoe Perches $output .= $prefix . $level . ':'; 172157230297SJoe Perches if ($show_types) { 172257230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 172357230297SJoe Perches $output .= "$type:"; 172457230297SJoe Perches } 172557230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 172657230297SJoe Perches $output .= ' ' . $msg . "\n"; 172734d8815fSJoe Perches 172834d8815fSJoe Perches if ($showfile) { 172934d8815fSJoe Perches my @lines = split("\n", $output, -1); 173034d8815fSJoe Perches splice(@lines, 1, 1); 173134d8815fSJoe Perches $output = join("\n", @lines); 173234d8815fSJoe Perches } 173357230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 17348905a67cSAndy Whitcroft 173557230297SJoe Perches push(our @report, $output); 1736773647a0SAndy Whitcroft 1737773647a0SAndy Whitcroft return 1; 1738f0a594c1SAndy Whitcroft} 1739cbec18afSJoe Perches 1740f0a594c1SAndy Whitcroftsub report_dump { 174113214adfSAndy Whitcroft our @report; 1742f0a594c1SAndy Whitcroft} 1743000d1cc1SJoe Perches 1744d752fcc8SJoe Perchessub fixup_current_range { 1745d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1746d752fcc8SJoe Perches 1747d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1748d752fcc8SJoe Perches my $o = $1; 1749d752fcc8SJoe Perches my $l = $2; 1750d752fcc8SJoe Perches my $no = $o + $offset; 1751d752fcc8SJoe Perches my $nl = $l + $length; 1752d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1753d752fcc8SJoe Perches } 1754d752fcc8SJoe Perches} 1755d752fcc8SJoe Perches 1756d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1757d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1758d752fcc8SJoe Perches 1759d752fcc8SJoe Perches my $range_last_linenr = 0; 1760d752fcc8SJoe Perches my $delta_offset = 0; 1761d752fcc8SJoe Perches 1762d752fcc8SJoe Perches my $old_linenr = 0; 1763d752fcc8SJoe Perches my $new_linenr = 0; 1764d752fcc8SJoe Perches 1765d752fcc8SJoe Perches my $next_insert = 0; 1766d752fcc8SJoe Perches my $next_delete = 0; 1767d752fcc8SJoe Perches 1768d752fcc8SJoe Perches my @lines = (); 1769d752fcc8SJoe Perches 1770d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1771d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1772d752fcc8SJoe Perches 1773d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1774d752fcc8SJoe Perches my $save_line = 1; 1775d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1776323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1777d752fcc8SJoe Perches $delta_offset = 0; 1778d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1779d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1780d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1781d752fcc8SJoe Perches } 1782d752fcc8SJoe Perches 1783d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1784d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1785d752fcc8SJoe Perches $save_line = 0; 1786d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1787d752fcc8SJoe Perches } 1788d752fcc8SJoe Perches 1789d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1790d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1791d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1792d752fcc8SJoe Perches $new_linenr++; 1793d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1794d752fcc8SJoe Perches } 1795d752fcc8SJoe Perches 1796d752fcc8SJoe Perches if ($save_line) { 1797d752fcc8SJoe Perches push(@lines, $line); 1798d752fcc8SJoe Perches $new_linenr++; 1799d752fcc8SJoe Perches } 1800d752fcc8SJoe Perches 1801d752fcc8SJoe Perches $old_linenr++; 1802d752fcc8SJoe Perches } 1803d752fcc8SJoe Perches 1804d752fcc8SJoe Perches return @lines; 1805d752fcc8SJoe Perches} 1806d752fcc8SJoe Perches 1807f2d7e4d4SJoe Perchessub fix_insert_line { 1808f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1809f2d7e4d4SJoe Perches 1810f2d7e4d4SJoe Perches my $inserted = { 1811f2d7e4d4SJoe Perches LINENR => $linenr, 1812f2d7e4d4SJoe Perches LINE => $line, 1813f2d7e4d4SJoe Perches }; 1814f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1815f2d7e4d4SJoe Perches} 1816f2d7e4d4SJoe Perches 1817f2d7e4d4SJoe Perchessub fix_delete_line { 1818f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1819f2d7e4d4SJoe Perches 1820f2d7e4d4SJoe Perches my $deleted = { 1821f2d7e4d4SJoe Perches LINENR => $linenr, 1822f2d7e4d4SJoe Perches LINE => $line, 1823f2d7e4d4SJoe Perches }; 1824f2d7e4d4SJoe Perches 1825f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1826f2d7e4d4SJoe Perches} 1827f2d7e4d4SJoe Perches 1828de7d4f0eSAndy Whitcroftsub ERROR { 1829cbec18afSJoe Perches my ($type, $msg) = @_; 1830cbec18afSJoe Perches 1831cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1832de7d4f0eSAndy Whitcroft our $clean = 0; 18336c72ffaaSAndy Whitcroft our $cnt_error++; 18343705ce5bSJoe Perches return 1; 1835de7d4f0eSAndy Whitcroft } 18363705ce5bSJoe Perches return 0; 1837773647a0SAndy Whitcroft} 1838de7d4f0eSAndy Whitcroftsub WARN { 1839cbec18afSJoe Perches my ($type, $msg) = @_; 1840cbec18afSJoe Perches 1841cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1842de7d4f0eSAndy Whitcroft our $clean = 0; 18436c72ffaaSAndy Whitcroft our $cnt_warn++; 18443705ce5bSJoe Perches return 1; 1845de7d4f0eSAndy Whitcroft } 18463705ce5bSJoe Perches return 0; 1847773647a0SAndy Whitcroft} 1848de7d4f0eSAndy Whitcroftsub CHK { 1849cbec18afSJoe Perches my ($type, $msg) = @_; 1850cbec18afSJoe Perches 1851cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1852de7d4f0eSAndy Whitcroft our $clean = 0; 18536c72ffaaSAndy Whitcroft our $cnt_chk++; 18543705ce5bSJoe Perches return 1; 18556c72ffaaSAndy Whitcroft } 18563705ce5bSJoe Perches return 0; 1857de7d4f0eSAndy Whitcroft} 1858de7d4f0eSAndy Whitcroft 18596ecd9674SAndy Whitcroftsub check_absolute_file { 18606ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 18616ecd9674SAndy Whitcroft my $file = $absolute; 18626ecd9674SAndy Whitcroft 18636ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 18646ecd9674SAndy Whitcroft 18656ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 18666ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 18676ecd9674SAndy Whitcroft if (-f "$root/$file") { 18686ecd9674SAndy Whitcroft ##print "file<$file>\n"; 18696ecd9674SAndy Whitcroft last; 18706ecd9674SAndy Whitcroft } 18716ecd9674SAndy Whitcroft } 18726ecd9674SAndy Whitcroft if (! -f _) { 18736ecd9674SAndy Whitcroft return 0; 18746ecd9674SAndy Whitcroft } 18756ecd9674SAndy Whitcroft 18766ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 18776ecd9674SAndy Whitcroft my $prefix = $absolute; 18786ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 18796ecd9674SAndy Whitcroft 18806ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18816ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1882000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1883000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18846ecd9674SAndy Whitcroft } 18856ecd9674SAndy Whitcroft} 18866ecd9674SAndy Whitcroft 18873705ce5bSJoe Perchessub trim { 18883705ce5bSJoe Perches my ($string) = @_; 18893705ce5bSJoe Perches 1890b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1891b34c648bSJoe Perches 1892b34c648bSJoe Perches return $string; 1893b34c648bSJoe Perches} 1894b34c648bSJoe Perches 1895b34c648bSJoe Perchessub ltrim { 1896b34c648bSJoe Perches my ($string) = @_; 1897b34c648bSJoe Perches 1898b34c648bSJoe Perches $string =~ s/^\s+//; 1899b34c648bSJoe Perches 1900b34c648bSJoe Perches return $string; 1901b34c648bSJoe Perches} 1902b34c648bSJoe Perches 1903b34c648bSJoe Perchessub rtrim { 1904b34c648bSJoe Perches my ($string) = @_; 1905b34c648bSJoe Perches 1906b34c648bSJoe Perches $string =~ s/\s+$//; 19073705ce5bSJoe Perches 19083705ce5bSJoe Perches return $string; 19093705ce5bSJoe Perches} 19103705ce5bSJoe Perches 191152ea8506SJoe Perchessub string_find_replace { 191252ea8506SJoe Perches my ($string, $find, $replace) = @_; 191352ea8506SJoe Perches 191452ea8506SJoe Perches $string =~ s/$find/$replace/g; 191552ea8506SJoe Perches 191652ea8506SJoe Perches return $string; 191752ea8506SJoe Perches} 191852ea8506SJoe Perches 19193705ce5bSJoe Perchessub tabify { 19203705ce5bSJoe Perches my ($leading) = @_; 19213705ce5bSJoe Perches 19223705ce5bSJoe Perches my $source_indent = 8; 19233705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 19243705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 19253705ce5bSJoe Perches 19263705ce5bSJoe Perches #convert leading spaces to tabs 19273705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 19283705ce5bSJoe Perches #Remove spaces before a tab 19293705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 19303705ce5bSJoe Perches 19313705ce5bSJoe Perches return "$leading"; 19323705ce5bSJoe Perches} 19333705ce5bSJoe Perches 1934d1fe9c09SJoe Perchessub pos_last_openparen { 1935d1fe9c09SJoe Perches my ($line) = @_; 1936d1fe9c09SJoe Perches 1937d1fe9c09SJoe Perches my $pos = 0; 1938d1fe9c09SJoe Perches 1939d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1940d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1941d1fe9c09SJoe Perches 1942d1fe9c09SJoe Perches my $last_openparen = 0; 1943d1fe9c09SJoe Perches 1944d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1945d1fe9c09SJoe Perches return -1; 1946d1fe9c09SJoe Perches } 1947d1fe9c09SJoe Perches 1948d1fe9c09SJoe Perches my $len = length($line); 1949d1fe9c09SJoe Perches 1950d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1951d1fe9c09SJoe Perches my $string = substr($line, $pos); 1952d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1953d1fe9c09SJoe Perches $pos += length($1) - 1; 1954d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1955d1fe9c09SJoe Perches $last_openparen = $pos; 1956d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1957d1fe9c09SJoe Perches last; 1958d1fe9c09SJoe Perches } 1959d1fe9c09SJoe Perches } 1960d1fe9c09SJoe Perches 196191cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1962d1fe9c09SJoe Perches} 1963d1fe9c09SJoe Perches 19640a920b5bSAndy Whitcroftsub process { 19650a920b5bSAndy Whitcroft my $filename = shift; 19660a920b5bSAndy Whitcroft 19670a920b5bSAndy Whitcroft my $linenr=0; 19680a920b5bSAndy Whitcroft my $prevline=""; 1969c2fdda0dSAndy Whitcroft my $prevrawline=""; 19700a920b5bSAndy Whitcroft my $stashline=""; 1971c2fdda0dSAndy Whitcroft my $stashrawline=""; 19720a920b5bSAndy Whitcroft 19734a0df2efSAndy Whitcroft my $length; 19740a920b5bSAndy Whitcroft my $indent; 19750a920b5bSAndy Whitcroft my $previndent=0; 19760a920b5bSAndy Whitcroft my $stashindent=0; 19770a920b5bSAndy Whitcroft 1978de7d4f0eSAndy Whitcroft our $clean = 1; 19790a920b5bSAndy Whitcroft my $signoff = 0; 19800a920b5bSAndy Whitcroft my $is_patch = 0; 198129ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 198215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 1983bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 19842a076f40SJoe Perches my $commit_log_long_line = 0; 1985e518e9a5SJoe Perches my $commit_log_has_diff = 0; 198613f1937eSJoe Perches my $reported_maintainer_file = 0; 1987fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1988fa64205dSPasi Savanainen 1989365dd4eaSJoe Perches my $last_blank_line = 0; 19905e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1991365dd4eaSJoe Perches 199213214adfSAndy Whitcroft our @report = (); 19936c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19946c72ffaaSAndy Whitcroft our $cnt_error = 0; 19956c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19966c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19976c72ffaaSAndy Whitcroft 19980a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19990a920b5bSAndy Whitcroft my $realfile = ''; 20000a920b5bSAndy Whitcroft my $realline = 0; 20010a920b5bSAndy Whitcroft my $realcnt = 0; 20020a920b5bSAndy Whitcroft my $here = ''; 20030a920b5bSAndy Whitcroft my $in_comment = 0; 2004c2fdda0dSAndy Whitcroft my $comment_edge = 0; 20050a920b5bSAndy Whitcroft my $first_line = 0; 20061e855726SWolfram Sang my $p1_prefix = ''; 20070a920b5bSAndy Whitcroft 200813214adfSAndy Whitcroft my $prev_values = 'E'; 200913214adfSAndy Whitcroft 201013214adfSAndy Whitcroft # suppression flags 2011773647a0SAndy Whitcroft my %suppress_ifbraces; 2012170d3a22SAndy Whitcroft my %suppress_whiletrailers; 20132b474a1aSAndy Whitcroft my %suppress_export; 20143e469cdcSAndy Whitcroft my $suppress_statement = 0; 2015653d4876SAndy Whitcroft 20167e51f197SJoe Perches my %signatures = (); 2017323c1260SJoe Perches 2018c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 2019de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 2020c2fdda0dSAndy Whitcroft # 2021de7d4f0eSAndy Whitcroft my @setup_docs = (); 2022de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2023773647a0SAndy Whitcroft 2024d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2025d8b07710SJoe Perches 2026773647a0SAndy Whitcroft sanitise_line_reset(); 2027c2fdda0dSAndy Whitcroft my $line; 2028c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2029773647a0SAndy Whitcroft $linenr++; 2030773647a0SAndy Whitcroft $line = $rawline; 2031c2fdda0dSAndy Whitcroft 20323705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 20333705ce5bSJoe Perches 2034773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2035de7d4f0eSAndy Whitcroft $setup_docs = 0; 2036de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2037de7d4f0eSAndy Whitcroft $setup_docs = 1; 2038de7d4f0eSAndy Whitcroft } 2039773647a0SAndy Whitcroft #next; 2040de7d4f0eSAndy Whitcroft } 2041773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2042773647a0SAndy Whitcroft $realline=$1-1; 2043773647a0SAndy Whitcroft if (defined $2) { 2044773647a0SAndy Whitcroft $realcnt=$3+1; 2045773647a0SAndy Whitcroft } else { 2046773647a0SAndy Whitcroft $realcnt=1+1; 2047773647a0SAndy Whitcroft } 2048c45dcabdSAndy Whitcroft $in_comment = 0; 2049773647a0SAndy Whitcroft 2050773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2051773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2052773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2053773647a0SAndy Whitcroft # at context start. 2054773647a0SAndy Whitcroft my $edge; 205501fa9147SAndy Whitcroft my $cnt = $realcnt; 205601fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 205701fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 205801fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 205901fa9147SAndy Whitcroft $cnt--; 206001fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2061721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2062fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2063fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2064fae17daeSAndy Whitcroft ($edge) = $1; 2065fae17daeSAndy Whitcroft last; 2066fae17daeSAndy Whitcroft } 2067773647a0SAndy Whitcroft } 2068773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2069773647a0SAndy Whitcroft $in_comment = 1; 2070773647a0SAndy Whitcroft } 2071773647a0SAndy Whitcroft 2072773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2073773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2074773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2075773647a0SAndy Whitcroft if (!defined $edge && 207683242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2077773647a0SAndy Whitcroft { 2078773647a0SAndy Whitcroft $in_comment = 1; 2079773647a0SAndy Whitcroft } 2080773647a0SAndy Whitcroft 2081773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2082773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2083773647a0SAndy Whitcroft 2084171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2085773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2086171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2087773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2088773647a0SAndy Whitcroft } 2089773647a0SAndy Whitcroft push(@lines, $line); 2090773647a0SAndy Whitcroft 2091773647a0SAndy Whitcroft if ($realcnt > 1) { 2092773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2093773647a0SAndy Whitcroft } else { 2094773647a0SAndy Whitcroft $realcnt = 0; 2095773647a0SAndy Whitcroft } 2096773647a0SAndy Whitcroft 2097773647a0SAndy Whitcroft #print "==>$rawline\n"; 2098773647a0SAndy Whitcroft #print "-->$line\n"; 2099de7d4f0eSAndy Whitcroft 2100de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2101de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2102de7d4f0eSAndy Whitcroft } 2103de7d4f0eSAndy Whitcroft } 2104de7d4f0eSAndy Whitcroft 21056c72ffaaSAndy Whitcroft $prefix = ''; 21066c72ffaaSAndy Whitcroft 2107773647a0SAndy Whitcroft $realcnt = 0; 2108773647a0SAndy Whitcroft $linenr = 0; 2109194f66fcSJoe Perches $fixlinenr = -1; 21100a920b5bSAndy Whitcroft foreach my $line (@lines) { 21110a920b5bSAndy Whitcroft $linenr++; 2112194f66fcSJoe Perches $fixlinenr++; 21131b5539b1SJoe Perches my $sline = $line; #copy of $line 21141b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 21150a920b5bSAndy Whitcroft 2116c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 21176c72ffaaSAndy Whitcroft 21180a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2119e518e9a5SJoe Perches if (!$in_commit_log && 2120e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 21210a920b5bSAndy Whitcroft $is_patch = 1; 21224a0df2efSAndy Whitcroft $first_line = $linenr + 1; 21230a920b5bSAndy Whitcroft $realline=$1-1; 21240a920b5bSAndy Whitcroft if (defined $2) { 21250a920b5bSAndy Whitcroft $realcnt=$3+1; 21260a920b5bSAndy Whitcroft } else { 21270a920b5bSAndy Whitcroft $realcnt=1+1; 21280a920b5bSAndy Whitcroft } 2129c2fdda0dSAndy Whitcroft annotate_reset(); 213013214adfSAndy Whitcroft $prev_values = 'E'; 213113214adfSAndy Whitcroft 2132773647a0SAndy Whitcroft %suppress_ifbraces = (); 2133170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 21342b474a1aSAndy Whitcroft %suppress_export = (); 21353e469cdcSAndy Whitcroft $suppress_statement = 0; 21360a920b5bSAndy Whitcroft next; 21370a920b5bSAndy Whitcroft 21384a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 21394a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 21404a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2141773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 21420a920b5bSAndy Whitcroft $realline++; 2143d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 21440a920b5bSAndy Whitcroft 21454a0df2efSAndy Whitcroft # Measure the line length and indent. 2146c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 21470a920b5bSAndy Whitcroft 21480a920b5bSAndy Whitcroft # Track the previous line. 21490a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 21500a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2151c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2152c2fdda0dSAndy Whitcroft 2153773647a0SAndy Whitcroft #warn "line<$line>\n"; 21546c72ffaaSAndy Whitcroft 2155d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2156d8aaf121SAndy Whitcroft $realcnt--; 21570a920b5bSAndy Whitcroft } 21580a920b5bSAndy Whitcroft 2159cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2160cc77cdcaSAndy Whitcroft 21616c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 21626c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2163773647a0SAndy Whitcroft 21642ac73b4fSJoe Perches my $found_file = 0; 2165773647a0SAndy Whitcroft # extract the filename as it passes 21663bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 21673bf9a009SRabin Vincent $realfile = $1; 21682b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2169270c49a0SJoe Perches $in_commit_log = 0; 21702ac73b4fSJoe Perches $found_file = 1; 21713bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2172773647a0SAndy Whitcroft $realfile = $1; 21732b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2174270c49a0SJoe Perches $in_commit_log = 0; 21751e855726SWolfram Sang 21761e855726SWolfram Sang $p1_prefix = $1; 2177e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2178e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2179000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2180000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21811e855726SWolfram Sang } 2182773647a0SAndy Whitcroft 2183c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2184000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2185000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2186773647a0SAndy Whitcroft } 21872ac73b4fSJoe Perches $found_file = 1; 21882ac73b4fSJoe Perches } 21892ac73b4fSJoe Perches 219034d8815fSJoe Perches#make up the handle for any error we report on this line 219134d8815fSJoe Perches if ($showfile) { 219234d8815fSJoe Perches $prefix = "$realfile:$realline: " 219334d8815fSJoe Perches } elsif ($emacs) { 21947d3a9f67SJoe Perches if ($file) { 21957d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 21967d3a9f67SJoe Perches } else { 219734d8815fSJoe Perches $prefix = "$filename:$linenr: "; 219834d8815fSJoe Perches } 21997d3a9f67SJoe Perches } 220034d8815fSJoe Perches 22012ac73b4fSJoe Perches if ($found_file) { 22027bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 22032ac73b4fSJoe Perches $check = 1; 22042ac73b4fSJoe Perches } else { 22052ac73b4fSJoe Perches $check = $check_orig; 22062ac73b4fSJoe Perches } 2207773647a0SAndy Whitcroft next; 2208773647a0SAndy Whitcroft } 2209773647a0SAndy Whitcroft 2210389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 22110a920b5bSAndy Whitcroft 2212c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2213c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2214c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 22150a920b5bSAndy Whitcroft 22166c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 22176c72ffaaSAndy Whitcroft 2218e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2219e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2220e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2221e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2222e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2223e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2224e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2225e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2226e518e9a5SJoe Perches $commit_log_has_diff = 1; 2227e518e9a5SJoe Perches } 2228e518e9a5SJoe Perches 22293bf9a009SRabin Vincent# Check for incorrect file permissions 22303bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 22313bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 223204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 223304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2234000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2235000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 22363bf9a009SRabin Vincent } 22373bf9a009SRabin Vincent } 22383bf9a009SRabin Vincent 223920112475SJoe Perches# Check the patch for a signoff: 2240d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 22414a0df2efSAndy Whitcroft $signoff++; 224215662b3eSJoe Perches $in_commit_log = 0; 22430a920b5bSAndy Whitcroft } 224420112475SJoe Perches 2245e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2246e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2247e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2248e0d975b1SJoe Perches $reported_maintainer_file = 1; 2249e0d975b1SJoe Perches } 2250e0d975b1SJoe Perches 225120112475SJoe Perches# Check signature styles 2252270c49a0SJoe Perches if (!$in_header_lines && 2253ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 225420112475SJoe Perches my $space_before = $1; 225520112475SJoe Perches my $sign_off = $2; 225620112475SJoe Perches my $space_after = $3; 225720112475SJoe Perches my $email = $4; 225820112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 225920112475SJoe Perches 2260ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2261ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2262ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2263ce0338dfSJoe Perches } 226420112475SJoe Perches if (defined $space_before && $space_before ne "") { 22653705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22663705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 22673705ce5bSJoe Perches $fix) { 2268194f66fcSJoe Perches $fixed[$fixlinenr] = 22693705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22703705ce5bSJoe Perches } 227120112475SJoe Perches } 227220112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22733705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22743705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22753705ce5bSJoe Perches $fix) { 2276194f66fcSJoe Perches $fixed[$fixlinenr] = 22773705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22783705ce5bSJoe Perches } 22793705ce5bSJoe Perches 228020112475SJoe Perches } 228120112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22823705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22833705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22843705ce5bSJoe Perches $fix) { 2285194f66fcSJoe Perches $fixed[$fixlinenr] = 22863705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22873705ce5bSJoe Perches } 228820112475SJoe Perches } 228920112475SJoe Perches 229020112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 229120112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 229220112475SJoe Perches if ($suggested_email eq "") { 2293000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2294000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 229520112475SJoe Perches } else { 229620112475SJoe Perches my $dequoted = $suggested_email; 229720112475SJoe Perches $dequoted =~ s/^"//; 229820112475SJoe Perches $dequoted =~ s/" </ </; 229920112475SJoe Perches # Don't force email to have quotes 230020112475SJoe Perches # Allow just an angle bracketed address 230120112475SJoe Perches if ("$dequoted$comment" ne $email && 230220112475SJoe Perches "<$email_address>$comment" ne $email && 230320112475SJoe Perches "$suggested_email$comment" ne $email) { 2304000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2305000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 230620112475SJoe Perches } 23070a920b5bSAndy Whitcroft } 23087e51f197SJoe Perches 23097e51f197SJoe Perches# Check for duplicate signatures 23107e51f197SJoe Perches my $sig_nospace = $line; 23117e51f197SJoe Perches $sig_nospace =~ s/\s//g; 23127e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 23137e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 23147e51f197SJoe Perches WARN("BAD_SIGN_OFF", 23157e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 23167e51f197SJoe Perches } else { 23177e51f197SJoe Perches $signatures{$sig_nospace} = 1; 23187e51f197SJoe Perches } 23190a920b5bSAndy Whitcroft } 23200a920b5bSAndy Whitcroft 2321a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2322a2fe16b9SJoe Perches if ($in_header_lines && 2323a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2324a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2325a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2326a2fe16b9SJoe Perches } 2327a2fe16b9SJoe Perches 23289b3189ebSJoe Perches# Check for old stable address 23299b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 23309b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 23319b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 23329b3189ebSJoe Perches } 23339b3189ebSJoe Perches 23347ebd05efSChristopher Covington# Check for unwanted Gerrit info 23357ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 23367ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 23377ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 23387ebd05efSChristopher Covington } 23397ebd05efSChristopher Covington 2340369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2341369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2342369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2343369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2344369c8dd3SJoe Perches # timestamp 2345369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2346369c8dd3SJoe Perches # stack dump address 2347369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2348369c8dd3SJoe Perches } 2349369c8dd3SJoe Perches 23502a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 23512a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2352bf4daf12SJoe Perches length($line) > 75 && 2353bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2354bf4daf12SJoe Perches # file delta changes 2355bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2356bf4daf12SJoe Perches # filename then : 2357bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2358bf4daf12SJoe Perches # A Fixes: or Link: line 2359bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 23602a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 23612a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 23622a076f40SJoe Perches $commit_log_long_line = 1; 23632a076f40SJoe Perches } 23642a076f40SJoe Perches 2365bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2366bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2367bf4daf12SJoe Perches $line =~ /^\s*$/) { 2368bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2369bf4daf12SJoe Perches } 2370bf4daf12SJoe Perches 23710d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2372369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2373fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2374bf4daf12SJoe Perches ($line =~ /\b[0-9a-f]{12,40}\b/i && 2375369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2376bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2377fe043ea1SJoe Perches my $init_char = "c"; 2378fe043ea1SJoe Perches my $orig_commit = ""; 23790d7835fcSJoe Perches my $short = 1; 23800d7835fcSJoe Perches my $long = 0; 23810d7835fcSJoe Perches my $case = 1; 23820d7835fcSJoe Perches my $space = 1; 23830d7835fcSJoe Perches my $hasdesc = 0; 238419c146a6SJoe Perches my $hasparens = 0; 23850d7835fcSJoe Perches my $id = '0123456789ab'; 23860d7835fcSJoe Perches my $orig_desc = "commit description"; 23870d7835fcSJoe Perches my $description = ""; 23880d7835fcSJoe Perches 2389fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2390fe043ea1SJoe Perches $init_char = $1; 2391fe043ea1SJoe Perches $orig_commit = lc($2); 2392fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2393fe043ea1SJoe Perches $orig_commit = lc($1); 2394fe043ea1SJoe Perches } 2395fe043ea1SJoe Perches 23960d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23970d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23980d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 23990d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 24000d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 24010d7835fcSJoe Perches $orig_desc = $1; 240219c146a6SJoe Perches $hasparens = 1; 24030d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 24040d7835fcSJoe Perches defined $rawlines[$linenr] && 24050d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 24060d7835fcSJoe Perches $orig_desc = $1; 240719c146a6SJoe Perches $hasparens = 1; 2408b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2409b671fde0SJoe Perches defined $rawlines[$linenr] && 2410b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2411b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2412b671fde0SJoe Perches $orig_desc = $1; 2413b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2414b671fde0SJoe Perches $orig_desc .= " " . $1; 241519c146a6SJoe Perches $hasparens = 1; 24160d7835fcSJoe Perches } 24170d7835fcSJoe Perches 24180d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 24190d7835fcSJoe Perches $id, $orig_desc); 24200d7835fcSJoe Perches 242119c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2422d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 24230d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 24240d7835fcSJoe Perches } 2425d311cd44SJoe Perches } 2426d311cd44SJoe Perches 242713f1937eSJoe Perches# Check for added, moved or deleted files 242813f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 242913f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 243013f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 243113f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 243213f1937eSJoe Perches (defined($1) || defined($2))))) { 243313f1937eSJoe Perches $reported_maintainer_file = 1; 243413f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 243513f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 243613f1937eSJoe Perches } 243713f1937eSJoe Perches 243800df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 24398905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2440000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2441000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 24426c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2443de7d4f0eSAndy Whitcroft } 2444de7d4f0eSAndy Whitcroft 24456ecd9674SAndy Whitcroft# Check for absolute kernel paths. 24466ecd9674SAndy Whitcroft if ($tree) { 24476ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 24486ecd9674SAndy Whitcroft my $file = $1; 24496ecd9674SAndy Whitcroft 24506ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 24516ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 24526ecd9674SAndy Whitcroft # 24536ecd9674SAndy Whitcroft } else { 24546ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 24556ecd9674SAndy Whitcroft } 24566ecd9674SAndy Whitcroft } 24576ecd9674SAndy Whitcroft } 24586ecd9674SAndy Whitcroft 2459de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2460de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2461171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2462171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2463171ae1a4SAndy Whitcroft 2464171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2465171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2466171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2467171ae1a4SAndy Whitcroft 246834d99219SJoe Perches CHK("INVALID_UTF8", 2469000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 247000df344fSAndy Whitcroft } 24710a920b5bSAndy Whitcroft 247215662b3eSJoe Perches# Check if it's the start of a commit log 247315662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 247415662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 247529ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 247629ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 247715662b3eSJoe Perches $in_header_lines = 0; 247815662b3eSJoe Perches $in_commit_log = 1; 247915662b3eSJoe Perches } 248015662b3eSJoe Perches 2481fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2482fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2483fa64205dSPasi Savanainen if ($in_header_lines && 2484fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2485fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2486fa64205dSPasi Savanainen $non_utf8_charset = 1; 2487fa64205dSPasi Savanainen } 2488fa64205dSPasi Savanainen 2489fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 249015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2491fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 249215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 249315662b3eSJoe Perches } 249415662b3eSJoe Perches 249566b47b4aSKees Cook# Check for various typo / spelling mistakes 249666d7a382SJoe Perches if (defined($misspellings) && 249766d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2498ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 249966b47b4aSKees Cook my $typo = $1; 250066b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 250166b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 250266b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 250366b47b4aSKees Cook my $msg_type = \&WARN; 250466b47b4aSKees Cook $msg_type = \&CHK if ($file); 250566b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 250666b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 250766b47b4aSKees Cook $fix) { 250866b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 250966b47b4aSKees Cook } 251066b47b4aSKees Cook } 251166b47b4aSKees Cook } 251266b47b4aSKees Cook 251330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 251430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 251500df344fSAndy Whitcroft 25160a920b5bSAndy Whitcroft#trailing whitespace 25179c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2518c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2519d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2520d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2521d5e616fcSJoe Perches $fix) { 2522194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2523d5e616fcSJoe Perches } 2524c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2525c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25263705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 25273705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 25283705ce5bSJoe Perches $fix) { 2529194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 25303705ce5bSJoe Perches } 25313705ce5bSJoe Perches 2532d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25330a920b5bSAndy Whitcroft } 25345368df20SAndy Whitcroft 25354783f894SJosh Triplett# Check for FSF mailing addresses. 2536109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 25373e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 25383e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 25394783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25404783f894SJosh Triplett my $msg_type = \&ERROR; 25414783f894SJosh Triplett $msg_type = \&CHK if ($file); 25424783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 25434783f894SJosh 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) 25444783f894SJosh Triplett } 25454783f894SJosh Triplett 25463354957aSAndi Kleen# check for Kconfig help text having a real description 25479fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 25489fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 25493354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 25508d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 25513354957aSAndi Kleen my $length = 0; 25529fe287d7SAndy Whitcroft my $cnt = $realcnt; 25539fe287d7SAndy Whitcroft my $ln = $linenr + 1; 25549fe287d7SAndy Whitcroft my $f; 2555a1385803SAndy Whitcroft my $is_start = 0; 25569fe287d7SAndy Whitcroft my $is_end = 0; 2557a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 25589fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 25599fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 25609fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 25619fe287d7SAndy Whitcroft 25629fe287d7SAndy Whitcroft next if ($f =~ /^-/); 25638d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2564a1385803SAndy Whitcroft 25658d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2566a1385803SAndy Whitcroft $is_start = 1; 25678d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2568a1385803SAndy Whitcroft $length = -1; 2569a1385803SAndy Whitcroft } 2570a1385803SAndy Whitcroft 25719fe287d7SAndy Whitcroft $f =~ s/^.//; 25723354957aSAndi Kleen $f =~ s/#.*//; 25733354957aSAndi Kleen $f =~ s/^\s+//; 25743354957aSAndi Kleen next if ($f =~ /^$/); 25759fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 25769fe287d7SAndy Whitcroft $is_end = 1; 25779fe287d7SAndy Whitcroft last; 25789fe287d7SAndy Whitcroft } 25793354957aSAndi Kleen $length++; 25803354957aSAndi Kleen } 258156193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2582000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 258356193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 258456193274SVadim Bendebury } 2585a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25863354957aSAndi Kleen } 25873354957aSAndi Kleen 25881ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25891ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25901ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25911ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25921ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25931ba8dfd1SKees Cook } 25941ba8dfd1SKees Cook 2595327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2596327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2597327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2598327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2599327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2600327953e9SChristoph Jaeger } 2601327953e9SChristoph Jaeger 2602c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2603c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2604c68e5878SArnaud Lacombe my $flag = $1; 2605c68e5878SArnaud Lacombe my $replacement = { 2606c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2607c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2608c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2609c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2610c68e5878SArnaud Lacombe }; 2611c68e5878SArnaud Lacombe 2612c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2613c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2614c68e5878SArnaud Lacombe } 2615c68e5878SArnaud Lacombe 2616bff5da43SRob Herring# check for DT compatible documentation 26177dd05b38SFlorian Vaussard if (defined $root && 26187dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 26197dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 26207dd05b38SFlorian Vaussard 2621bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2622bff5da43SRob Herring 2623cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2624cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2625cc93319bSFlorian Vaussard 2626bff5da43SRob Herring foreach my $compat (@compats) { 2627bff5da43SRob Herring my $compat2 = $compat; 2628185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2629185d566bSRob Herring my $compat3 = $compat; 2630185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2631185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2632bff5da43SRob Herring if ( $? >> 8 ) { 2633bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2634bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2635bff5da43SRob Herring } 2636bff5da43SRob Herring 26374fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 26384fbf32a6SFlorian Vaussard my $vendor = $1; 2639cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2640bff5da43SRob Herring if ( $? >> 8 ) { 2641bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2642cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2643bff5da43SRob Herring } 2644bff5da43SRob Herring } 2645bff5da43SRob Herring } 2646bff5da43SRob Herring 26475368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2648de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 26495368df20SAndy Whitcroft 265047e0c88bSJoe Perches# line length limit (with some exclusions) 265147e0c88bSJoe Perches# 265247e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 265347e0c88bSJoe Perches# logging functions like pr_info that end in a string 265447e0c88bSJoe Perches# lines with a single string 265547e0c88bSJoe Perches# #defines that are a single string 265647e0c88bSJoe Perches# 265747e0c88bSJoe Perches# There are 3 different line length message types: 265847e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 265947e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 266047e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 266147e0c88bSJoe Perches# 266247e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 266347e0c88bSJoe Perches# 266447e0c88bSJoe Perches 2665b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 266647e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 266747e0c88bSJoe Perches 266847e0c88bSJoe Perches # Check the allowed long line types first 266947e0c88bSJoe Perches 267047e0c88bSJoe Perches # logging functions that end in a string that starts 267147e0c88bSJoe Perches # before $max_line_length 267247e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 267347e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 267447e0c88bSJoe Perches $msg_type = ""; 267547e0c88bSJoe Perches 267647e0c88bSJoe Perches # lines with only strings (w/ possible termination) 267747e0c88bSJoe Perches # #defines with only strings 267847e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 267947e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 268047e0c88bSJoe Perches $msg_type = ""; 268147e0c88bSJoe Perches 268247e0c88bSJoe Perches # Otherwise set the alternate message types 268347e0c88bSJoe Perches 268447e0c88bSJoe Perches # a comment starts before $max_line_length 268547e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 268647e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 268747e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 268847e0c88bSJoe Perches 268947e0c88bSJoe Perches # a quoted string starts before $max_line_length 269047e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 269147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 269247e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 269347e0c88bSJoe Perches } 269447e0c88bSJoe Perches 269547e0c88bSJoe Perches if ($msg_type ne "" && 269647e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 269747e0c88bSJoe Perches WARN($msg_type, 26986cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 26990a920b5bSAndy Whitcroft } 270047e0c88bSJoe Perches } 27010a920b5bSAndy Whitcroft 27028905a67cSAndy Whitcroft# check for adding lines without a newline. 27038905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2704000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2705000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 27068905a67cSAndy Whitcroft } 27078905a67cSAndy Whitcroft 270842e41c54SMike Frysinger# Blackfin: use hi/lo macros 270942e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 271042e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 271142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2712000d1cc1SJoe Perches ERROR("LO_MACRO", 2713000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 271442e41c54SMike Frysinger } 271542e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 271642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2717000d1cc1SJoe Perches ERROR("HI_MACRO", 2718000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 271942e41c54SMike Frysinger } 272042e41c54SMike Frysinger } 272142e41c54SMike Frysinger 2722b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2723de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 27240a920b5bSAndy Whitcroft 27250a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 27260a920b5bSAndy Whitcroft# more than 8 must use tabs. 2727c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2728c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2729c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2730d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27313705ce5bSJoe Perches if (ERROR("CODE_INDENT", 27323705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 27333705ce5bSJoe Perches $fix) { 2734194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27353705ce5bSJoe Perches } 27360a920b5bSAndy Whitcroft } 27370a920b5bSAndy Whitcroft 273808e44365SAlberto Panizzo# check for space before tabs. 273908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 274008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27413705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 27423705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 27433705ce5bSJoe Perches $fix) { 2744194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2745d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2746194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2747c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 27483705ce5bSJoe Perches } 274908e44365SAlberto Panizzo } 275008e44365SAlberto Panizzo 2751d1fe9c09SJoe Perches# check for && or || at the start of a line 2752d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2753d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2754d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2755d1fe9c09SJoe Perches } 2756d1fe9c09SJoe Perches 2757d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2758d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 275991cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2760d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2761d1fe9c09SJoe Perches my $oldindent = $1; 2762d1fe9c09SJoe Perches my $rest = $2; 2763d1fe9c09SJoe Perches 2764d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2765d1fe9c09SJoe Perches if ($pos >= 0) { 2766b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2767b34a26f3SJoe Perches my $newindent = $2; 2768d1fe9c09SJoe Perches 2769d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2770d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2771d1fe9c09SJoe Perches " " x ($pos % 8); 2772d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2773d1fe9c09SJoe Perches 2774d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2775d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 27763705ce5bSJoe Perches 27773705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 27783705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27793705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2780194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27813705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27823705ce5bSJoe Perches } 2783d1fe9c09SJoe Perches } 2784d1fe9c09SJoe Perches } 2785d1fe9c09SJoe Perches } 2786d1fe9c09SJoe Perches 27876ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27886ab3a970SJoe Perches# avoid checking a few false positives: 27896ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27906ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27916ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27926ab3a970SJoe Perches# multiline macros that define functions 27936ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27946ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27956ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27963705ce5bSJoe Perches if (CHK("SPACING", 2797f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27983705ce5bSJoe Perches $fix) { 2799194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2800f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 28013705ce5bSJoe Perches } 2802aad4f614SJoe Perches } 2803aad4f614SJoe Perches 280486406b1cSJoe Perches# Block comment styles 280586406b1cSJoe Perches# Networking with an initial /* 280605880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2807fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 280885ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 280985ad978cSJoe Perches $realline > 2) { 281005880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 281105880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 281205880600SJoe Perches } 281305880600SJoe Perches 281486406b1cSJoe Perches# Block comments use * on subsequent lines 281586406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 281686406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2817a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 281861135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2819a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 282086406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 282186406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2822a605e32eSJoe Perches } 2823a605e32eSJoe Perches 282486406b1cSJoe Perches# Block comments use */ on trailing lines 282586406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2826c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2827c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2828c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 282986406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 283086406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 283105880600SJoe Perches } 283205880600SJoe Perches 28337f619191SJoe Perches# check for missing blank lines after struct/union declarations 28347f619191SJoe Perches# with exceptions for various attributes and macros 28357f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 28367f619191SJoe Perches $line =~ /^\+/ && 28377f619191SJoe Perches !($line =~ /^\+\s*$/ || 28387f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 28397f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 28407f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 28417f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 28427f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 28437f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 28447f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2845d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2846d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2847d752fcc8SJoe Perches $fix) { 2848f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2849d752fcc8SJoe Perches } 28507f619191SJoe Perches } 28517f619191SJoe Perches 2852365dd4eaSJoe Perches# check for multiple consecutive blank lines 2853365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2854365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2855365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2856d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2857d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2858d752fcc8SJoe Perches $fix) { 2859f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2860d752fcc8SJoe Perches } 2861d752fcc8SJoe Perches 2862365dd4eaSJoe Perches $last_blank_line = $linenr; 2863365dd4eaSJoe Perches } 2864365dd4eaSJoe Perches 28653b617e3bSJoe Perches# check for missing blank lines after declarations 28663f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 28673f7bac03SJoe Perches # actual declarations 28683f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28695a4e1fd3SJoe Perches # function pointer declarations 28705a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28713f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28723f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28733f7bac03SJoe Perches # known declaration macros 28743f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 28753f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 28763f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 28773f7bac03SJoe Perches # other possible extensions of declaration lines 28783f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 28793f7bac03SJoe Perches # not starting a section or a macro "\" extended line 28803f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 28813f7bac03SJoe Perches # looks like a declaration 28823f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28835a4e1fd3SJoe Perches # function pointer declarations 28845a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28853f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28863f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28873f7bac03SJoe Perches # known declaration macros 28883f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28893f7bac03SJoe Perches # start of struct or union or enum 28903b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28913f7bac03SJoe Perches # start or end of block or continuation of declaration 28923f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28933f7bac03SJoe Perches # bitfield continuation 28943f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28953f7bac03SJoe Perches # other possible extensions of declaration lines 28963f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28973f7bac03SJoe Perches # indentation of previous and current line are the same 28983f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2899d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2900d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2901d752fcc8SJoe Perches $fix) { 2902f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2903d752fcc8SJoe Perches } 29043b617e3bSJoe Perches } 29053b617e3bSJoe Perches 29065f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 29076b4c5bebSAndy Whitcroft# Exceptions: 29086b4c5bebSAndy Whitcroft# 1) within comments 29096b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 29106b4c5bebSAndy Whitcroft# 3) hanging labels 29113705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 29125f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 29133705ce5bSJoe Perches if (WARN("LEADING_SPACE", 29143705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 29153705ce5bSJoe Perches $fix) { 2916194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 29173705ce5bSJoe Perches } 29185f7ddae6SRaffaele Recalcati } 29195f7ddae6SRaffaele Recalcati 2920b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2921b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2922b9ea10d6SAndy Whitcroft 2923032a4c0fSJoe Perches# check indentation of any line with a bare else 2924840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2925032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2926032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2927032a4c0fSJoe Perches my $tabs = length($1) + 1; 2928840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2929840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2930840080a0SJoe Perches defined $lines[$linenr] && 2931840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2932032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2933032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2934032a4c0fSJoe Perches } 2935032a4c0fSJoe Perches } 2936032a4c0fSJoe Perches 2937c00df19aSJoe Perches# check indentation of a line with a break; 2938c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2939c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2940c00df19aSJoe Perches my $tabs = $1; 2941c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2942c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2943c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2944c00df19aSJoe Perches } 2945c00df19aSJoe Perches } 2946c00df19aSJoe Perches 29471ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 29481ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 29491ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 29501ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 29511ba8dfd1SKees Cook } 29521ba8dfd1SKees Cook 2953c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2954cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2955000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2956000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2957c2fdda0dSAndy Whitcroft } 295822f2a2efSAndy Whitcroft 295942e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 296042e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 296142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2962000d1cc1SJoe Perches ERROR("CSYNC", 2963000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 296442e41c54SMike Frysinger } 296542e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 296642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2967000d1cc1SJoe Perches ERROR("SSYNC", 2968000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 296942e41c54SMike Frysinger } 297042e41c54SMike Frysinger 297156e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 297256e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 297356e77d70SJoe Perches WARN("HOTPLUG_SECTION", 297456e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 297556e77d70SJoe Perches } 297656e77d70SJoe Perches 29779c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 29782b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 29792b474a1aSAndy Whitcroft $realline_next); 29803e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 29813e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29821b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2983170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2984f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2985171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2986171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2987171ae1a4SAndy Whitcroft 29883e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29893e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29903e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29913e469cdcSAndy Whitcroft # until we hit end of it. 29923e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29933e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29943e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29953e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29963e469cdcSAndy Whitcroft } 2997f74bd194SAndy Whitcroft 29982b474a1aSAndy Whitcroft # Find the real next line. 29992b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 30002b474a1aSAndy Whitcroft if (defined $realline_next && 30012b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 30022b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 30032b474a1aSAndy Whitcroft $realline_next++; 30042b474a1aSAndy Whitcroft } 30052b474a1aSAndy Whitcroft 3006171ae1a4SAndy Whitcroft my $s = $stat; 3007171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 3008cf655043SAndy Whitcroft 3009c2fdda0dSAndy Whitcroft # Ignore goto labels. 3010171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 3011c2fdda0dSAndy Whitcroft 3012c2fdda0dSAndy Whitcroft # Ignore functions being called 3013171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3014c2fdda0dSAndy Whitcroft 3015463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 3016463f2864SAndy Whitcroft 3017c45dcabdSAndy Whitcroft # declarations always start with types 3018d2506586SAndy 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) { 3019c45dcabdSAndy Whitcroft my $type = $1; 3020c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 3021c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3022c45dcabdSAndy Whitcroft 30236c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3024a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3025c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3026c2fdda0dSAndy Whitcroft } 30278905a67cSAndy Whitcroft 30286c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 302965863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3030c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 30319c0ca6f9SAndy Whitcroft } 30328905a67cSAndy Whitcroft 30338905a67cSAndy Whitcroft # Check for any sort of function declaration. 30348905a67cSAndy Whitcroft # int foo(something bar, other baz); 30358905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3036171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 30378905a67cSAndy Whitcroft my ($name_len) = length($1); 30388905a67cSAndy Whitcroft 3039cf655043SAndy Whitcroft my $ctx = $s; 3040773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 30418905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3042cf655043SAndy Whitcroft 30438905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3044c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 30458905a67cSAndy Whitcroft 3046c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 30478905a67cSAndy Whitcroft } 30488905a67cSAndy Whitcroft } 30498905a67cSAndy Whitcroft } 30508905a67cSAndy Whitcroft 30519c0ca6f9SAndy Whitcroft } 30529c0ca6f9SAndy Whitcroft 305300df344fSAndy Whitcroft# 305400df344fSAndy Whitcroft# Checks which may be anchored in the context. 305500df344fSAndy Whitcroft# 305600df344fSAndy Whitcroft 305700df344fSAndy Whitcroft# Check for switch () and associated case and default 305800df344fSAndy Whitcroft# statements should be at the same indent. 305900df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 306000df344fSAndy Whitcroft my $err = ''; 306100df344fSAndy Whitcroft my $sep = ''; 306200df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 306300df344fSAndy Whitcroft shift(@ctx); 306400df344fSAndy Whitcroft for my $ctx (@ctx) { 306500df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 306600df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 306700df344fSAndy Whitcroft $indent != $cindent) { 306800df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 306900df344fSAndy Whitcroft $sep = ''; 307000df344fSAndy Whitcroft } else { 307100df344fSAndy Whitcroft $sep = "[...]\n"; 307200df344fSAndy Whitcroft } 307300df344fSAndy Whitcroft } 307400df344fSAndy Whitcroft if ($err ne '') { 3075000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3076000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3077de7d4f0eSAndy Whitcroft } 3078de7d4f0eSAndy Whitcroft } 3079de7d4f0eSAndy Whitcroft 3080de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3081de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30820fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3083773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3084773647a0SAndy Whitcroft 30859c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30868eef05ddSJoe Perches 30878eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30888eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30898eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30908eef05ddSJoe Perches } 30918eef05ddSJoe Perches 3092de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3093de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3094de7d4f0eSAndy Whitcroft 3095548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3096548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3097de7d4f0eSAndy Whitcroft 3098548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3099548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3100548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3101548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3102548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3103773647a0SAndy Whitcroft $ctx_ln++; 3104773647a0SAndy Whitcroft } 3105548596d5SAndy Whitcroft 310653210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 310753210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3108773647a0SAndy Whitcroft 3109773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3110000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3111000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 311201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 311300df344fSAndy Whitcroft } 3114773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3115773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3116773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3117773647a0SAndy Whitcroft { 31189c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 31199c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3120000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3121000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 312201464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 31239c0ca6f9SAndy Whitcroft } 31249c0ca6f9SAndy Whitcroft } 312500df344fSAndy Whitcroft } 312600df344fSAndy Whitcroft 31274d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 31280fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 31293e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 31303e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 31313e469cdcSAndy Whitcroft if (!defined $stat); 31324d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 31334d001e4dSAndy Whitcroft 31344d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 31354d001e4dSAndy Whitcroft 31369f5af480SJoe Perches # remove inline comments 31379f5af480SJoe Perches $s =~ s/$;/ /g; 31389f5af480SJoe Perches $c =~ s/$;/ /g; 31394d001e4dSAndy Whitcroft 31404d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 31416f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 31426f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 31434d001e4dSAndy Whitcroft 31449f5af480SJoe Perches # Make sure we remove the line prefixes as we have 31459f5af480SJoe Perches # none on the first line, and are going to readd them 31469f5af480SJoe Perches # where necessary. 31479f5af480SJoe Perches $s =~ s/\n./\n/gs; 31489f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 31499f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 31509f5af480SJoe Perches } 31519f5af480SJoe Perches 31524d001e4dSAndy Whitcroft # We want to check the first line inside the block 31534d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 31544d001e4dSAndy Whitcroft # 1) any blank line termination 31554d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 31564d001e4dSAndy Whitcroft # 3) any do (...) { 31574d001e4dSAndy Whitcroft my $continuation = 0; 31584d001e4dSAndy Whitcroft my $check = 0; 31594d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 31604d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 31614d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 31624d001e4dSAndy Whitcroft $continuation = 1; 31634d001e4dSAndy Whitcroft } 31649bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 31654d001e4dSAndy Whitcroft $check = 1; 31664d001e4dSAndy Whitcroft $cond_lines++; 31674d001e4dSAndy Whitcroft } 31684d001e4dSAndy Whitcroft 31694d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 31704d001e4dSAndy Whitcroft # preprocessor statement. 31714d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 31724d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 31734d001e4dSAndy Whitcroft $check = 0; 31744d001e4dSAndy Whitcroft } 31754d001e4dSAndy Whitcroft 31769bd49efeSAndy Whitcroft my $cond_ptr = -1; 3177740504c6SAndy Whitcroft $continuation = 0; 31789bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 31799bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 31804d001e4dSAndy Whitcroft 3181f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3182f16fa28fSAndy Whitcroft # is not linear. 3183f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3184f16fa28fSAndy Whitcroft $check = 0; 3185f16fa28fSAndy Whitcroft } 3186f16fa28fSAndy Whitcroft 31879bd49efeSAndy Whitcroft # Ignore: 31889bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31899bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31909bd49efeSAndy Whitcroft # 3) labels. 3191740504c6SAndy Whitcroft if ($continuation || 3192740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31939bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31949bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3195740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 319630dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31979bd49efeSAndy Whitcroft $cond_lines++; 31989bd49efeSAndy Whitcroft } 31994d001e4dSAndy Whitcroft } 320030dad6ebSAndy Whitcroft } 32014d001e4dSAndy Whitcroft 32024d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 32034d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 32044d001e4dSAndy Whitcroft 32054d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 32064d001e4dSAndy Whitcroft # this is not this patch's fault. 32074d001e4dSAndy Whitcroft if (!defined($stat_real) || 32084d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 32094d001e4dSAndy Whitcroft $check = 0; 32104d001e4dSAndy Whitcroft } 32114d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 32124d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 32134d001e4dSAndy Whitcroft } 32144d001e4dSAndy Whitcroft 32159bd49efeSAndy 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"; 32164d001e4dSAndy Whitcroft 32179f5af480SJoe Perches if ($check && $s ne '' && 32189f5af480SJoe Perches (($sindent % 8) != 0 || 32199f5af480SJoe Perches ($sindent < $indent) || 32209f5af480SJoe Perches ($sindent > $indent + 8))) { 3221000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3222000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 32234d001e4dSAndy Whitcroft } 32244d001e4dSAndy Whitcroft } 32254d001e4dSAndy Whitcroft 32266c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 32276c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 32281f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 32291f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 32306c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3231c2fdda0dSAndy Whitcroft if ($dbg_values) { 3232c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3233cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3234cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 32351f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3236c2fdda0dSAndy Whitcroft } 32376c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 32386c72ffaaSAndy Whitcroft 323900df344fSAndy Whitcroft#ignore lines not being added 32403705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 324100df344fSAndy Whitcroft 3242*a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int 3243*a1ce18e4SJoe Perches while ($line =~ m{($Declare++)\s*($Ident)\s*[=,;\[\)]}g) { 3244*a1ce18e4SJoe Perches my $type = $1; 3245*a1ce18e4SJoe Perches my $var = $2; 3246*a1ce18e4SJoe Perches if ($type =~ /^((?:un)?signed)((?:\s*\*)*)\s*$/) { 3247*a1ce18e4SJoe Perches my $sign = $1; 3248*a1ce18e4SJoe Perches my $pointer = $2; 3249*a1ce18e4SJoe Perches 3250*a1ce18e4SJoe Perches $pointer = "" if (!defined $pointer); 3251*a1ce18e4SJoe Perches 3252*a1ce18e4SJoe Perches if (WARN("UNSPECIFIED_INT", 3253*a1ce18e4SJoe Perches "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 3254*a1ce18e4SJoe Perches $fix) { 3255*a1ce18e4SJoe Perches my $decl = trim($sign) . " int "; 3256*a1ce18e4SJoe Perches $decl .= trim($pointer) if (rtrim($pointer) ne ""); 3257*a1ce18e4SJoe Perches $fixed[$fixlinenr] =~ s@\b\Q$type\E\s*$var\b@$decl$var@; 3258*a1ce18e4SJoe Perches } 3259*a1ce18e4SJoe Perches } 3260*a1ce18e4SJoe Perches } 3261*a1ce18e4SJoe Perches 3262653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 32637429c690SAndy Whitcroft if ($dbg_type) { 32647429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3265000d1cc1SJoe Perches ERROR("TEST_TYPE", 3266000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 32677429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3268000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3269000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 32707429c690SAndy Whitcroft } 3271653d4876SAndy Whitcroft next; 3272653d4876SAndy Whitcroft } 3273a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3274a1ef277eSAndy Whitcroft if ($dbg_attr) { 32759360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3276000d1cc1SJoe Perches ERROR("TEST_ATTR", 3277000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 32789360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3279000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3280000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3281a1ef277eSAndy Whitcroft } 3282a1ef277eSAndy Whitcroft next; 3283a1ef277eSAndy Whitcroft } 3284653d4876SAndy Whitcroft 3285f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 328699423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 328799423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3288d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3289d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3290f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3291f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3292f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3293d752fcc8SJoe Perches my $fixedline = $prevrawline; 3294d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3295f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3296d752fcc8SJoe Perches $fixedline = $line; 3297d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3298f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3299d752fcc8SJoe Perches } 3300f0a594c1SAndy Whitcroft } 3301f0a594c1SAndy Whitcroft 330200df344fSAndy Whitcroft# 330300df344fSAndy Whitcroft# Checks which are anchored on the added line. 330400df344fSAndy Whitcroft# 330500df344fSAndy Whitcroft 3306653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3307c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3308653d4876SAndy Whitcroft my $path = $1; 3309653d4876SAndy Whitcroft if ($path =~ m{//}) { 3310000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3311495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3312495e9d84SJoe Perches } 3313495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3314495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3315495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3316653d4876SAndy Whitcroft } 3317653d4876SAndy Whitcroft } 3318653d4876SAndy Whitcroft 331900df344fSAndy Whitcroft# no C99 // comments 332000df344fSAndy Whitcroft if ($line =~ m{//}) { 33213705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 33223705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 33233705ce5bSJoe Perches $fix) { 3324194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 33253705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 33263705ce5bSJoe Perches my $comment = trim($1); 3327194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 33283705ce5bSJoe Perches } 33293705ce5bSJoe Perches } 333000df344fSAndy Whitcroft } 333100df344fSAndy Whitcroft # Remove C99 comments. 33320a920b5bSAndy Whitcroft $line =~ s@//.*@@; 33336c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 33340a920b5bSAndy Whitcroft 33352b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 33362b474a1aSAndy Whitcroft# the whole statement. 33372b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 33382b474a1aSAndy Whitcroft if (defined $realline_next && 33392b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 33402b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 33412b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33422b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33433cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 33443cbf62dfSAndy Whitcroft # a prefix: 33453cbf62dfSAndy Whitcroft # XXX(foo); 33463cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3347653d4876SAndy Whitcroft my $name = $1; 334887a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 33493cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 33503cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 33513cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 33523cbf62dfSAndy Whitcroft 33533cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 33542b474a1aSAndy Whitcroft \n.}\s*$| 335548012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 335648012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 335748012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 33582b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 33592b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 336048012058SAndy Whitcroft )/x) { 33612b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 33622b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 33632b474a1aSAndy Whitcroft } else { 33642b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 33650a920b5bSAndy Whitcroft } 33660a920b5bSAndy Whitcroft } 33672b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 33682b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 33692b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33702b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33712b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 33722b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 33732b474a1aSAndy Whitcroft } 33742b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 33752b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3376000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3377000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 33782b474a1aSAndy Whitcroft } 33790a920b5bSAndy Whitcroft 33805150bda4SJoe Eloff# check for global initialisers. 33816d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3382d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 33836d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3384d5e616fcSJoe Perches $fix) { 33856d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3386d5e616fcSJoe Perches } 3387f0a594c1SAndy Whitcroft } 33880a920b5bSAndy Whitcroft# check for static initialisers. 33896d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3390d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 33916d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3392d5e616fcSJoe Perches $herecurr) && 3393d5e616fcSJoe Perches $fix) { 33946d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3395d5e616fcSJoe Perches } 33960a920b5bSAndy Whitcroft } 33970a920b5bSAndy Whitcroft 33981813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 33991813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 34001813087dSJoe Perches my $tmp = trim($1); 34011813087dSJoe Perches WARN("MISORDERED_TYPE", 34021813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 34031813087dSJoe Perches } 34041813087dSJoe Perches 3405cb710ecaSJoe Perches# check for static const char * arrays. 3406cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3407000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3408000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3409cb710ecaSJoe Perches $herecurr); 3410cb710ecaSJoe Perches } 3411cb710ecaSJoe Perches 3412cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3413cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3414000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3415000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3416cb710ecaSJoe Perches $herecurr); 3417cb710ecaSJoe Perches } 3418cb710ecaSJoe Perches 3419ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3420ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3421ab7e23f3SJoe Perches my $found = $1; 3422ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3423ab7e23f3SJoe Perches WARN("CONST_CONST", 3424ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3425ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3426ab7e23f3SJoe Perches WARN("CONST_CONST", 3427ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3428ab7e23f3SJoe Perches } 3429ab7e23f3SJoe Perches } 3430ab7e23f3SJoe Perches 34319b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 34329b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 34339b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 34349b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 34359b0fa60dSJoe Perches $herecurr); 34369b0fa60dSJoe Perches } 34379b0fa60dSJoe Perches 3438b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3439b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3440b598b670SJoe Perches my $array = $1; 3441b598b670SJoe 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*\))@) { 3442b598b670SJoe Perches my $array_div = $1; 3443b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3444b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3445b598b670SJoe Perches $fix) { 3446b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3447b598b670SJoe Perches } 3448b598b670SJoe Perches } 3449b598b670SJoe Perches } 3450b598b670SJoe Perches 3451b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3452b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3453b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3454b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3455b36190c5SJoe Perches $fix) { 3456194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3457b36190c5SJoe Perches } 3458b36190c5SJoe Perches } 3459b36190c5SJoe Perches 346092e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 346192e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 346292e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 346392e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 346492e112fdSJoe Perches $fix) { 3465194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 346692e112fdSJoe Perches } 346793ed0e2dSJoe Perches } 346893ed0e2dSJoe Perches 3469653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3470653d4876SAndy Whitcroft# make sense. 3471653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 34728054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3473c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 34748ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3475653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3476000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3477000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 34780a920b5bSAndy Whitcroft } 34790a920b5bSAndy Whitcroft 34800a920b5bSAndy Whitcroft# * goes on variable not on type 348165863862SAndy Whitcroft # (char*[ const]) 3482bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3483bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 34843705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3485d8aaf121SAndy Whitcroft 348665863862SAndy Whitcroft # Should start with a space. 348765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 348865863862SAndy Whitcroft # Should not end with a space. 348965863862SAndy Whitcroft $to =~ s/\s+$//; 349065863862SAndy Whitcroft # '*'s should not have spaces between. 3491f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 349265863862SAndy Whitcroft } 3493d8aaf121SAndy Whitcroft 34943705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 349565863862SAndy Whitcroft if ($from ne $to) { 34963705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34973705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 34983705ce5bSJoe Perches $fix) { 34993705ce5bSJoe Perches my $sub_from = $ident; 35003705ce5bSJoe Perches my $sub_to = $ident; 35013705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3502194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35033705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 35043705ce5bSJoe Perches } 350565863862SAndy Whitcroft } 3506bfcb2cc7SAndy Whitcroft } 3507bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3508bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 35093705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3510d8aaf121SAndy Whitcroft 351165863862SAndy Whitcroft # Should start with a space. 351265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 351365863862SAndy Whitcroft # Should not end with a space. 351465863862SAndy Whitcroft $to =~ s/\s+$//; 351565863862SAndy Whitcroft # '*'s should not have spaces between. 3516f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 351765863862SAndy Whitcroft } 351865863862SAndy Whitcroft # Modifiers should have spaces. 351965863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 352065863862SAndy Whitcroft 35213705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3522667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 35233705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 35243705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 35253705ce5bSJoe Perches $fix) { 35263705ce5bSJoe Perches 35273705ce5bSJoe Perches my $sub_from = $match; 35283705ce5bSJoe Perches my $sub_to = $match; 35293705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3530194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35313705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 35323705ce5bSJoe Perches } 353365863862SAndy Whitcroft } 35340a920b5bSAndy Whitcroft } 35350a920b5bSAndy Whitcroft 35369d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 35379d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 35389d3e3c70SJoe Perches my $msg_type = \&WARN; 35399d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 35409d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 35419d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 35429d3e3c70SJoe Perches } 35430a920b5bSAndy Whitcroft 35449d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 35458905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3546000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3547000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 35488905a67cSAndy Whitcroft } 35498905a67cSAndy Whitcroft 355017441227SJoe Perches# check for uses of printk_ratelimit 355117441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3552000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3553000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 355417441227SJoe Perches } 355517441227SJoe Perches 355600df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 355700df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 355800df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 355925985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 356000df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3561f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 356200df344fSAndy Whitcroft my $ok = 0; 356300df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 356400df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 356525985edcSLucas De Marchi # we have a preceding printk if it ends 356600df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 356700df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 356800df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 356900df344fSAndy Whitcroft $ok = 1; 357000df344fSAndy Whitcroft } 357100df344fSAndy Whitcroft last; 357200df344fSAndy Whitcroft } 357300df344fSAndy Whitcroft } 357400df344fSAndy Whitcroft if ($ok == 0) { 3575000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3576000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 35770a920b5bSAndy Whitcroft } 357800df344fSAndy Whitcroft } 35790a920b5bSAndy Whitcroft 3580243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3581243f3803SJoe Perches my $orig = $1; 3582243f3803SJoe Perches my $level = lc($orig); 3583243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 35848f26b837SJoe Perches my $level2 = $level; 35858f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3586243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3587daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3588243f3803SJoe Perches } 3589243f3803SJoe Perches 3590243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3591d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3592d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3593d5e616fcSJoe Perches $fix) { 3594194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3595d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3596d5e616fcSJoe Perches } 3597243f3803SJoe Perches } 3598243f3803SJoe Perches 3599dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3600dc139313SJoe Perches my $orig = $1; 3601dc139313SJoe Perches my $level = lc($orig); 3602dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3603dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3604dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3605dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3606dc139313SJoe Perches } 3607dc139313SJoe Perches 360891c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 360991c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 361091c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 361191c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 361291c9afafSAndy Lutomirski WARN("ENOSYS", 361391c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 361491c9afafSAndy Lutomirski } 361591c9afafSAndy Lutomirski 3616653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3617653d4876SAndy Whitcroft# or if closed on same line 36188d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 36194e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 36208d182478SJoe Perches if (ERROR("OPEN_BRACE", 36218d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 36228d182478SJoe Perches $fix) { 36238d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 36248d182478SJoe Perches my $fixed_line = $rawline; 36258d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 36268d182478SJoe Perches my $line1 = $1; 36278d182478SJoe Perches my $line2 = $2; 36288d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 36298d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 36308d182478SJoe Perches if ($line2 !~ /^\s*$/) { 36318d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 36328d182478SJoe Perches } 36338d182478SJoe Perches } 36340a920b5bSAndy Whitcroft } 3635653d4876SAndy Whitcroft 36368905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 36378905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 36388905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 36398d182478SJoe Perches if (ERROR("OPEN_BRACE", 36408d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 36418d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 36428d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 36438d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 36448d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 36458d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36468d182478SJoe Perches $fixedline = $rawline; 36478d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 36488d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 36498d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36508d182478SJoe Perches } 36518d182478SJoe Perches } 36528905a67cSAndy Whitcroft } 36538905a67cSAndy Whitcroft 36540c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 36553705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 36563705ce5bSJoe Perches if (WARN("SPACING", 36573705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 36583705ce5bSJoe Perches $fix) { 3659194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36603705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 36613705ce5bSJoe Perches } 36620c73b4ebSAndy Whitcroft } 36630c73b4ebSAndy Whitcroft 366431070b5dSJoe Perches# Function pointer declarations 366531070b5dSJoe Perches# check spacing between type, funcptr, and args 366631070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 366791f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 366831070b5dSJoe Perches my $declare = $1; 366931070b5dSJoe Perches my $pre_pointer_space = $2; 367031070b5dSJoe Perches my $post_pointer_space = $3; 367131070b5dSJoe Perches my $funcname = $4; 367231070b5dSJoe Perches my $post_funcname_space = $5; 367331070b5dSJoe Perches my $pre_args_space = $6; 367431070b5dSJoe Perches 367591f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 367691f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 367791f72e9cSJoe Perches# don't need a space so don't warn for those. 367891f72e9cSJoe Perches my $post_declare_space = ""; 367991f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 368091f72e9cSJoe Perches $post_declare_space = $1; 368191f72e9cSJoe Perches $declare = rtrim($declare); 368291f72e9cSJoe Perches } 368391f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 368431070b5dSJoe Perches WARN("SPACING", 368531070b5dSJoe Perches "missing space after return type\n" . $herecurr); 368691f72e9cSJoe Perches $post_declare_space = " "; 368731070b5dSJoe Perches } 368831070b5dSJoe Perches 368931070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 369091f72e9cSJoe Perches# This test is not currently implemented because these declarations are 369191f72e9cSJoe Perches# equivalent to 369291f72e9cSJoe Perches# int foo(int bar, ...) 369391f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 369491f72e9cSJoe Perches# 369591f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 369691f72e9cSJoe Perches# WARN("SPACING", 369791f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 369891f72e9cSJoe Perches# } 369931070b5dSJoe Perches 370031070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 370131070b5dSJoe Perches if (defined $pre_pointer_space && 370231070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 370331070b5dSJoe Perches WARN("SPACING", 370431070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 370531070b5dSJoe Perches } 370631070b5dSJoe Perches 370731070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 370831070b5dSJoe Perches if (defined $post_pointer_space && 370931070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 371031070b5dSJoe Perches WARN("SPACING", 371131070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 371231070b5dSJoe Perches } 371331070b5dSJoe Perches 371431070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 371531070b5dSJoe Perches if (defined $post_funcname_space && 371631070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 371731070b5dSJoe Perches WARN("SPACING", 371831070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 371931070b5dSJoe Perches } 372031070b5dSJoe Perches 372131070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 372231070b5dSJoe Perches if (defined $pre_args_space && 372331070b5dSJoe Perches $pre_args_space =~ /^\s/) { 372431070b5dSJoe Perches WARN("SPACING", 372531070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 372631070b5dSJoe Perches } 372731070b5dSJoe Perches 372831070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3729194f66fcSJoe Perches $fixed[$fixlinenr] =~ 373091f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 373131070b5dSJoe Perches } 373231070b5dSJoe Perches } 373331070b5dSJoe Perches 37348d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 37358d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3736fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3737fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 37388d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 37398d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 37408d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3741fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3742daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 37433705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 37443705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 37453705ce5bSJoe Perches $fix) { 3746194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37473705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 37483705ce5bSJoe Perches } 37498d31cfceSAndy Whitcroft } 37508d31cfceSAndy Whitcroft } 37518d31cfceSAndy Whitcroft 3752f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 37536c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3754c2fdda0dSAndy Whitcroft my $name = $1; 3755773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3756773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3757c2fdda0dSAndy Whitcroft 3758c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3759773647a0SAndy Whitcroft if ($name =~ /^(?: 3760773647a0SAndy Whitcroft if|for|while|switch|return|case| 3761773647a0SAndy Whitcroft volatile|__volatile__| 3762773647a0SAndy Whitcroft __attribute__|format|__extension__| 3763773647a0SAndy Whitcroft asm|__asm__)$/x) 3764773647a0SAndy Whitcroft { 3765c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3766c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3767c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3768c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3769773647a0SAndy Whitcroft 3770773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3771c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3772c2fdda0dSAndy Whitcroft 3773c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3774c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3775773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3776c2fdda0dSAndy Whitcroft 3777c2fdda0dSAndy Whitcroft } else { 37783705ce5bSJoe Perches if (WARN("SPACING", 37793705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 37803705ce5bSJoe Perches $fix) { 3781194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37823705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 37833705ce5bSJoe Perches } 3784f0a594c1SAndy Whitcroft } 37856c72ffaaSAndy Whitcroft } 37869a4cad4eSEric Nelson 3787653d4876SAndy Whitcroft# Check operator spacing. 37880a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 37893705ce5bSJoe Perches my $fixed_line = ""; 37903705ce5bSJoe Perches my $line_fixed = 0; 37913705ce5bSJoe Perches 37929c0ca6f9SAndy Whitcroft my $ops = qr{ 37939c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 37949c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 37959c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 37961f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 379784731623SJoe Perches \?:|\?|: 37989c0ca6f9SAndy Whitcroft }x; 3799cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 38003705ce5bSJoe Perches 38013705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 38023705ce5bSJoe Perches## foreach my $el (@elements) { 38033705ce5bSJoe Perches## print("el: <$el>\n"); 38043705ce5bSJoe Perches## } 38053705ce5bSJoe Perches 38063705ce5bSJoe Perches my @fix_elements = (); 380700df344fSAndy Whitcroft my $off = 0; 38086c72ffaaSAndy Whitcroft 38093705ce5bSJoe Perches foreach my $el (@elements) { 38103705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 38113705ce5bSJoe Perches $off += length($el); 38123705ce5bSJoe Perches } 38133705ce5bSJoe Perches 38143705ce5bSJoe Perches $off = 0; 38153705ce5bSJoe Perches 38166c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3817b34c648bSJoe Perches my $last_after = -1; 38186c72ffaaSAndy Whitcroft 38190a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 38203705ce5bSJoe Perches 38213705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 38223705ce5bSJoe Perches 38233705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 38243705ce5bSJoe Perches 38254a0df2efSAndy Whitcroft $off += length($elements[$n]); 38264a0df2efSAndy Whitcroft 382725985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3828773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3829773647a0SAndy Whitcroft my $cc = ''; 3830773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3831773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3832773647a0SAndy Whitcroft } 3833773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3834773647a0SAndy Whitcroft 38354a0df2efSAndy Whitcroft my $a = ''; 38364a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 38374a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3838cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 38394a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 38404a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3841773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 38424a0df2efSAndy Whitcroft 38430a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 38444a0df2efSAndy Whitcroft 38454a0df2efSAndy Whitcroft my $c = ''; 38460a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 38474a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 38484a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3849cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 38504a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 38514a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 38528b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 38534a0df2efSAndy Whitcroft } else { 38544a0df2efSAndy Whitcroft $c = 'E'; 38550a920b5bSAndy Whitcroft } 38560a920b5bSAndy Whitcroft 38574a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 38584a0df2efSAndy Whitcroft 38594a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 38604a0df2efSAndy Whitcroft 38616c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3862de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 38630a920b5bSAndy Whitcroft 386474048ed8SAndy Whitcroft # Pull out the value of this operator. 38656c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 38660a920b5bSAndy Whitcroft 38671f65f947SAndy Whitcroft # Get the full operator variant. 38681f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 38691f65f947SAndy Whitcroft 387013214adfSAndy Whitcroft # Ignore operators passed as parameters. 387113214adfSAndy Whitcroft if ($op_type ne 'V' && 3872d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 387313214adfSAndy Whitcroft 3874cf655043SAndy Whitcroft# # Ignore comments 3875cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 387613214adfSAndy Whitcroft 3877d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 387813214adfSAndy Whitcroft } elsif ($op eq ';') { 3879cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3880cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 38813705ce5bSJoe Perches if (ERROR("SPACING", 38823705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3883b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38843705ce5bSJoe Perches $line_fixed = 1; 38853705ce5bSJoe Perches } 3886d8aaf121SAndy Whitcroft } 3887d8aaf121SAndy Whitcroft 3888d8aaf121SAndy Whitcroft # // is a comment 3889d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 38900a920b5bSAndy Whitcroft 3891b00e4814SJoe Perches # : when part of a bitfield 3892b00e4814SJoe Perches } elsif ($opv eq ':B') { 3893b00e4814SJoe Perches # skip the bitfield test for now 3894b00e4814SJoe Perches 38951f65f947SAndy Whitcroft # No spaces for: 38961f65f947SAndy Whitcroft # -> 3897b00e4814SJoe Perches } elsif ($op eq '->') { 38984a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 38993705ce5bSJoe Perches if (ERROR("SPACING", 39003705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3901b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39023705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39033705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 39043705ce5bSJoe Perches } 3905b34c648bSJoe Perches $line_fixed = 1; 39063705ce5bSJoe Perches } 39070a920b5bSAndy Whitcroft } 39080a920b5bSAndy Whitcroft 39092381097bSJoe Perches # , must not have a space before and must have a space on the right. 39100a920b5bSAndy Whitcroft } elsif ($op eq ',') { 39112381097bSJoe Perches my $rtrim_before = 0; 39122381097bSJoe Perches my $space_after = 0; 39132381097bSJoe Perches if ($ctx =~ /Wx./) { 39142381097bSJoe Perches if (ERROR("SPACING", 39152381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 39162381097bSJoe Perches $line_fixed = 1; 39172381097bSJoe Perches $rtrim_before = 1; 39182381097bSJoe Perches } 39192381097bSJoe Perches } 3920cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 39213705ce5bSJoe Perches if (ERROR("SPACING", 39223705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 39233705ce5bSJoe Perches $line_fixed = 1; 3924b34c648bSJoe Perches $last_after = $n; 39252381097bSJoe Perches $space_after = 1; 39262381097bSJoe Perches } 39272381097bSJoe Perches } 39282381097bSJoe Perches if ($rtrim_before || $space_after) { 39292381097bSJoe Perches if ($rtrim_before) { 39302381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39312381097bSJoe Perches } else { 39322381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39332381097bSJoe Perches } 39342381097bSJoe Perches if ($space_after) { 39352381097bSJoe Perches $good .= " "; 39363705ce5bSJoe Perches } 39370a920b5bSAndy Whitcroft } 39380a920b5bSAndy Whitcroft 39399c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 394074048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 39419c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 39429c0ca6f9SAndy Whitcroft 39439c0ca6f9SAndy Whitcroft # unary operators should have a space before and 39449c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 39459c0ca6f9SAndy Whitcroft # unary operator, or a cast 39469c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 394774048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 39480d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3949cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 39503705ce5bSJoe Perches if (ERROR("SPACING", 39513705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3952b34c648bSJoe Perches if ($n != $last_after + 2) { 3953b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 39543705ce5bSJoe Perches $line_fixed = 1; 39553705ce5bSJoe Perches } 39560a920b5bSAndy Whitcroft } 3957b34c648bSJoe Perches } 3958a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3959171ae1a4SAndy Whitcroft # A unary '*' may be const 3960171ae1a4SAndy Whitcroft 3961171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 39623705ce5bSJoe Perches if (ERROR("SPACING", 39633705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3964b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 39653705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39663705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 39673705ce5bSJoe Perches } 3968b34c648bSJoe Perches $line_fixed = 1; 39693705ce5bSJoe Perches } 39700a920b5bSAndy Whitcroft } 39710a920b5bSAndy Whitcroft 39720a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 39730a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3974773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 39753705ce5bSJoe Perches if (ERROR("SPACING", 39763705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3977b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39783705ce5bSJoe Perches $line_fixed = 1; 39793705ce5bSJoe Perches } 39800a920b5bSAndy Whitcroft } 3981773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3982773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 39833705ce5bSJoe Perches if (ERROR("SPACING", 39843705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3985b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39863705ce5bSJoe Perches $line_fixed = 1; 39873705ce5bSJoe Perches } 3988653d4876SAndy Whitcroft } 3989773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 39903705ce5bSJoe Perches if (ERROR("SPACING", 39913705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3992b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39933705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39943705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3995773647a0SAndy Whitcroft } 3996b34c648bSJoe Perches $line_fixed = 1; 39973705ce5bSJoe Perches } 39983705ce5bSJoe Perches } 39990a920b5bSAndy Whitcroft 40000a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 40019c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 40029c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 40039c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 4004c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 4005c2fdda0dSAndy Whitcroft $op eq '%') 40060a920b5bSAndy Whitcroft { 4007d2e025f3SJoe Perches if ($check) { 4008d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 4009d2e025f3SJoe Perches if (CHK("SPACING", 4010d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 4011d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4012d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4013d2e025f3SJoe Perches $line_fixed = 1; 4014d2e025f3SJoe Perches } 4015d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 4016d2e025f3SJoe Perches if (CHK("SPACING", 4017d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 4018d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 4019d2e025f3SJoe Perches $line_fixed = 1; 4020d2e025f3SJoe Perches } 4021d2e025f3SJoe Perches } 4022d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 40233705ce5bSJoe Perches if (ERROR("SPACING", 40243705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 4025b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4026b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4027b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4028b34c648bSJoe Perches } 40293705ce5bSJoe Perches $line_fixed = 1; 40303705ce5bSJoe Perches } 40310a920b5bSAndy Whitcroft } 40320a920b5bSAndy Whitcroft 40331f65f947SAndy Whitcroft # A colon needs no spaces before when it is 40341f65f947SAndy Whitcroft # terminating a case value or a label. 40351f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 40361f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 40373705ce5bSJoe Perches if (ERROR("SPACING", 40383705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 4039b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 40403705ce5bSJoe Perches $line_fixed = 1; 40413705ce5bSJoe Perches } 40421f65f947SAndy Whitcroft } 40431f65f947SAndy Whitcroft 40440a920b5bSAndy Whitcroft # All the others need spaces both sides. 4045cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 40461f65f947SAndy Whitcroft my $ok = 0; 40471f65f947SAndy Whitcroft 404822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 40491f65f947SAndy Whitcroft if (($op eq '<' && 40501f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 40511f65f947SAndy Whitcroft ($op eq '>' && 40521f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 40531f65f947SAndy Whitcroft { 40541f65f947SAndy Whitcroft $ok = 1; 40551f65f947SAndy Whitcroft } 40561f65f947SAndy Whitcroft 4057e0df7e1fSJoe Perches # for asm volatile statements 4058e0df7e1fSJoe Perches # ignore a colon with another 4059e0df7e1fSJoe Perches # colon immediately before or after 4060e0df7e1fSJoe Perches if (($op eq ':') && 4061e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4062e0df7e1fSJoe Perches $ok = 1; 4063e0df7e1fSJoe Perches } 4064e0df7e1fSJoe Perches 406584731623SJoe Perches # messages are ERROR, but ?: are CHK 40661f65f947SAndy Whitcroft if ($ok == 0) { 406784731623SJoe Perches my $msg_type = \&ERROR; 406884731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 406984731623SJoe Perches 407084731623SJoe Perches if (&{$msg_type}("SPACING", 40713705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4072b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4073b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4074b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4075b34c648bSJoe Perches } 40763705ce5bSJoe Perches $line_fixed = 1; 40773705ce5bSJoe Perches } 40780a920b5bSAndy Whitcroft } 407922f2a2efSAndy Whitcroft } 40804a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 40813705ce5bSJoe Perches 40823705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 40833705ce5bSJoe Perches 40843705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 40850a920b5bSAndy Whitcroft } 40863705ce5bSJoe Perches 40873705ce5bSJoe Perches if (($#elements % 2) == 0) { 40883705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 40893705ce5bSJoe Perches } 40903705ce5bSJoe Perches 4091194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4092194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 40933705ce5bSJoe Perches } 40943705ce5bSJoe Perches 40953705ce5bSJoe Perches 40960a920b5bSAndy Whitcroft } 40970a920b5bSAndy Whitcroft 4098786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4099d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4100786b6326SJoe Perches if (WARN("SPACING", 4101786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4102786b6326SJoe Perches $fix) { 4103194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4104786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4105786b6326SJoe Perches } 4106786b6326SJoe Perches } 4107786b6326SJoe Perches 4108f0a594c1SAndy Whitcroft# check for multiple assignments 4109f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4110000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4111000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4112f0a594c1SAndy Whitcroft } 4113f0a594c1SAndy Whitcroft 411422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 411522f2a2efSAndy Whitcroft## # continuation. 411622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 411722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 411822f2a2efSAndy Whitcroft## 411922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 412022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 412122f2a2efSAndy Whitcroft## my $ln = $line; 412222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 412322f2a2efSAndy Whitcroft## } 412422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4125000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4126000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 412722f2a2efSAndy Whitcroft## } 412822f2a2efSAndy Whitcroft## } 4129f0a594c1SAndy Whitcroft 41300a920b5bSAndy Whitcroft#need space before brace following if, while, etc 41314e5d56bdSEddie Kovsky if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\){/) || 41324e5d56bdSEddie Kovsky $line =~ /do\{/) { 41333705ce5bSJoe Perches if (ERROR("SPACING", 41343705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 41353705ce5bSJoe Perches $fix) { 4136194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 41373705ce5bSJoe Perches } 4138de7d4f0eSAndy Whitcroft } 4139de7d4f0eSAndy Whitcroft 4140c4a62ef9SJoe Perches## # check for blank lines before declarations 4141c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4142c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4143c4a62ef9SJoe Perches## WARN("SPACING", 4144c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4145c4a62ef9SJoe Perches## } 4146c4a62ef9SJoe Perches## 4147c4a62ef9SJoe Perches 4148de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4149de7d4f0eSAndy Whitcroft# on the line 4150de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4151d5e616fcSJoe Perches if (ERROR("SPACING", 4152d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4153d5e616fcSJoe Perches $fix) { 4154194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4155d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4156d5e616fcSJoe Perches } 41570a920b5bSAndy Whitcroft } 41580a920b5bSAndy Whitcroft 415922f2a2efSAndy Whitcroft# check spacing on square brackets 416022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 41613705ce5bSJoe Perches if (ERROR("SPACING", 41623705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 41633705ce5bSJoe Perches $fix) { 4164194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41653705ce5bSJoe Perches s/\[\s+/\[/; 41663705ce5bSJoe Perches } 416722f2a2efSAndy Whitcroft } 416822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 41693705ce5bSJoe Perches if (ERROR("SPACING", 41703705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 41713705ce5bSJoe Perches $fix) { 4172194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41733705ce5bSJoe Perches s/\s+\]/\]/; 41743705ce5bSJoe Perches } 417522f2a2efSAndy Whitcroft } 417622f2a2efSAndy Whitcroft 4177c45dcabdSAndy Whitcroft# check spacing on parentheses 41789c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 41799c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 41803705ce5bSJoe Perches if (ERROR("SPACING", 41813705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 41823705ce5bSJoe Perches $fix) { 4183194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41843705ce5bSJoe Perches s/\(\s+/\(/; 41853705ce5bSJoe Perches } 418622f2a2efSAndy Whitcroft } 418713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4188c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4189c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 41903705ce5bSJoe Perches if (ERROR("SPACING", 41913705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 41923705ce5bSJoe Perches $fix) { 4193194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41943705ce5bSJoe Perches s/\s+\)/\)/; 41953705ce5bSJoe Perches } 419622f2a2efSAndy Whitcroft } 419722f2a2efSAndy Whitcroft 4198e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4199e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4200e2826fd0SJoe Perches 4201e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4202ea4acbb1SJoe Perches my $var = $1; 4203ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4204ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4205ea4acbb1SJoe Perches $fix) { 4206ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4207ea4acbb1SJoe Perches } 4208ea4acbb1SJoe Perches } 4209ea4acbb1SJoe Perches 4210ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4211ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4212ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4213ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4214ea4acbb1SJoe Perches my $var = $2; 4215ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4216ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4217ea4acbb1SJoe Perches $fix) { 4218ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4219ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4220ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4221ea4acbb1SJoe Perches } 4222e2826fd0SJoe Perches } 4223e2826fd0SJoe Perches 42240a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 42254a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 42260a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 42273705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 42283705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 42293705ce5bSJoe Perches $fix) { 4230194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42313705ce5bSJoe Perches s/^(.)\s+/$1/; 42323705ce5bSJoe Perches } 42330a920b5bSAndy Whitcroft } 42340a920b5bSAndy Whitcroft 42355b9553abSJoe Perches# return is not a function 4236507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4237c45dcabdSAndy Whitcroft my $spacing = $1; 4238507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 42395b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 42405b9553abSJoe Perches my $value = $1; 42415b9553abSJoe Perches $value = deparenthesize($value); 42425b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4243000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4244000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 42455b9553abSJoe Perches } 4246c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4247000d1cc1SJoe Perches ERROR("SPACING", 4248000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4249c45dcabdSAndy Whitcroft } 4250c45dcabdSAndy Whitcroft } 4251507e5141SJoe Perches 4252b43ae21bSJoe Perches# unnecessary return in a void function 4253b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4254b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4255b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4256b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4257b43ae21bSJoe Perches $linenr >= 3 && 4258b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4259b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 42609819cf25SJoe Perches WARN("RETURN_VOID", 4261b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 42629819cf25SJoe Perches } 42639819cf25SJoe Perches 4264189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4265189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4266189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4267189248d8SJoe Perches my $openparens = $1; 4268189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4269189248d8SJoe Perches my $msg = ""; 4270189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4271189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4272189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4273189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4274189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4275189248d8SJoe Perches } 4276189248d8SJoe Perches } 4277189248d8SJoe Perches 4278c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4279c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4280c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4281c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4282c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4283c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4284c5595fa2SJoe Perches my $lead = $1; 4285c5595fa2SJoe Perches my $const = $2; 4286c5595fa2SJoe Perches my $comp = $3; 4287c5595fa2SJoe Perches my $to = $4; 4288c5595fa2SJoe Perches my $newcomp = $comp; 4289c5595fa2SJoe Perches if ($lead !~ /$Operators\s*$/ && 4290c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4291c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4292c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4293c5595fa2SJoe Perches $fix) { 4294c5595fa2SJoe Perches if ($comp eq "<") { 4295c5595fa2SJoe Perches $newcomp = ">"; 4296c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4297c5595fa2SJoe Perches $newcomp = ">="; 4298c5595fa2SJoe Perches } elsif ($comp eq ">") { 4299c5595fa2SJoe Perches $newcomp = "<"; 4300c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4301c5595fa2SJoe Perches $newcomp = "<="; 4302c5595fa2SJoe Perches } 4303c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4304c5595fa2SJoe Perches } 4305c5595fa2SJoe Perches } 4306c5595fa2SJoe Perches 4307f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4308f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 430953a3c448SAndy Whitcroft my $name = $1; 431053a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4311000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4312f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 431353a3c448SAndy Whitcroft } 431453a3c448SAndy Whitcroft } 4315c45dcabdSAndy Whitcroft 43160a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 43174a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 43183705ce5bSJoe Perches if (ERROR("SPACING", 43193705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 43203705ce5bSJoe Perches $fix) { 4321194f66fcSJoe Perches $fixed[$fixlinenr] =~ 43223705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 43233705ce5bSJoe Perches } 43240a920b5bSAndy Whitcroft } 43250a920b5bSAndy Whitcroft 4326f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4327f5fe35ddSAndy Whitcroft# statements after the conditional. 4328170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 43293e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 43303e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 43313e469cdcSAndy Whitcroft if (!defined $stat); 4332170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4333170d3a22SAndy Whitcroft $remain_next, $off_next); 4334170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4335170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4336170d3a22SAndy Whitcroft 4337170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4338170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4339170d3a22SAndy Whitcroft # then count those as offsets. 4340170d3a22SAndy Whitcroft my ($whitespace) = 4341170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4342170d3a22SAndy Whitcroft my $offset = 4343170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4344170d3a22SAndy Whitcroft 4345170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4346170d3a22SAndy Whitcroft $offset} = 1; 4347170d3a22SAndy Whitcroft } 4348170d3a22SAndy Whitcroft } 4349170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4350c11230f4SJoe Perches defined($stat) && defined($cond) && 4351170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4352171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 43538905a67cSAndy Whitcroft 4354b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4355000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4356000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 43578905a67cSAndy Whitcroft } 43588905a67cSAndy Whitcroft 43598905a67cSAndy Whitcroft # Find out what is on the end of the line after the 43608905a67cSAndy Whitcroft # conditional. 4361773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 43628905a67cSAndy Whitcroft $s =~ s/\n.*//g; 436313214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 436453210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 436553210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4366773647a0SAndy Whitcroft { 4367bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4368bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4369bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 437042bdf74cSHidetoshi Seto my $stat_real = ''; 4371bb44ad39SAndy Whitcroft 437242bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 437342bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4374bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4375bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4376bb44ad39SAndy Whitcroft } 4377bb44ad39SAndy Whitcroft 4378000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4379000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 43808905a67cSAndy Whitcroft } 43818905a67cSAndy Whitcroft } 43828905a67cSAndy Whitcroft 438313214adfSAndy Whitcroft# Check for bitwise tests written as boolean 438413214adfSAndy Whitcroft if ($line =~ / 438513214adfSAndy Whitcroft (?: 438613214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 438713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 438813214adfSAndy Whitcroft (?:\&\&|\|\|) 438913214adfSAndy Whitcroft | 439013214adfSAndy Whitcroft (?:\&\&|\|\|) 439113214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 439213214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 439313214adfSAndy Whitcroft )/x) 439413214adfSAndy Whitcroft { 4395000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4396000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 439713214adfSAndy Whitcroft } 439813214adfSAndy Whitcroft 43998905a67cSAndy Whitcroft# if and else should not have general statements after it 440013214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 440113214adfSAndy Whitcroft my $s = $1; 440213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 440313214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4404000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4405000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 44060a920b5bSAndy Whitcroft } 440713214adfSAndy Whitcroft } 440839667782SAndy Whitcroft# if should not continue a brace 440939667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4410000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4411048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 441239667782SAndy Whitcroft $herecurr); 441339667782SAndy Whitcroft } 4414a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4415a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4416a1080bf8SAndy Whitcroft $line !~ /\G(?: 44173fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4418a1080bf8SAndy Whitcroft \s*return\s+ 4419a1080bf8SAndy Whitcroft )/xg) 4420a1080bf8SAndy Whitcroft { 4421000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4422000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4423a1080bf8SAndy Whitcroft } 44240a920b5bSAndy Whitcroft 44250a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 44260a920b5bSAndy Whitcroft # indent level to be relevant to each other. 44278b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 44280a920b5bSAndy Whitcroft $previndent == $indent) { 44298b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 44308b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 44318b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44328b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44338b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 44348b8856f4SJoe Perches my $fixedline = $prevrawline; 44358b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 44368b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 44378b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44388b8856f4SJoe Perches } 44398b8856f4SJoe Perches $fixedline = $rawline; 44408b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 44418b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44428b8856f4SJoe Perches } 44430a920b5bSAndy Whitcroft } 44440a920b5bSAndy Whitcroft 44458b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4446c2fdda0dSAndy Whitcroft $previndent == $indent) { 4447c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4448c2fdda0dSAndy Whitcroft 4449c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4450c2fdda0dSAndy Whitcroft # conditional. 4451773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4452c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4453c2fdda0dSAndy Whitcroft 4454c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 44558b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 44568b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 44578b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44588b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44598b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 44608b8856f4SJoe Perches my $fixedline = $prevrawline; 44618b8856f4SJoe Perches my $trailing = $rawline; 44628b8856f4SJoe Perches $trailing =~ s/^\+//; 44638b8856f4SJoe Perches $trailing = trim($trailing); 44648b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 44658b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44668b8856f4SJoe Perches } 4467c2fdda0dSAndy Whitcroft } 4468c2fdda0dSAndy Whitcroft } 4469c2fdda0dSAndy Whitcroft 447095e2c602SJoe Perches#Specific variable tests 4471323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4472323c1260SJoe Perches my $var = $1; 447395e2c602SJoe Perches 447495e2c602SJoe Perches#gcc binary extension 447595e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4476d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4477d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4478d5e616fcSJoe Perches $fix) { 4479d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4480194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4481d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4482d5e616fcSJoe Perches } 448395e2c602SJoe Perches } 448495e2c602SJoe Perches 448595e2c602SJoe Perches#CamelCase 4486807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4487be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 448822735ce8SJoe Perches#Ignore Page<foo> variants 4489807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 449022735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4491f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4492f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4493f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 44947e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 44957e781f67SJoe Perches my $word = $1; 44967e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4497d8b07710SJoe Perches if ($check) { 4498d8b07710SJoe Perches seed_camelcase_includes(); 4499d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4500d8b07710SJoe Perches seed_camelcase_file($realfile); 4501d8b07710SJoe Perches $camelcase_file_seeded = 1; 4502d8b07710SJoe Perches } 4503d8b07710SJoe Perches } 45047e781f67SJoe Perches if (!defined $camelcase{$word}) { 45057e781f67SJoe Perches $camelcase{$word} = 1; 4506be79794bSJoe Perches CHK("CAMELCASE", 45077e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 45087e781f67SJoe Perches } 4509323c1260SJoe Perches } 4510323c1260SJoe Perches } 45113445686aSJoe Perches } 45120a920b5bSAndy Whitcroft 45130a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4514d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4515d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4516d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4517d5e616fcSJoe Perches $fix) { 4518194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4519d5e616fcSJoe Perches } 45200a920b5bSAndy Whitcroft } 45210a920b5bSAndy Whitcroft 45220e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 45230e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4524c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4525e09dec48SAndy Whitcroft my $file = "$1.h"; 4526e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4527e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4528e09dec48SAndy Whitcroft $realfile ne $checkfile && 45297840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4530c45dcabdSAndy Whitcroft { 45310e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 45320e212e0aSFabian Frederick if ($asminclude > 0) { 4533e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4534000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4535000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4536e09dec48SAndy Whitcroft } else { 4537000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4538000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4539e09dec48SAndy Whitcroft } 45400a920b5bSAndy Whitcroft } 45410a920b5bSAndy Whitcroft } 45420e212e0aSFabian Frederick } 45430a920b5bSAndy Whitcroft 4544653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4545653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4546cf655043SAndy Whitcroft# in a known good container 4547b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4548b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4549d8aaf121SAndy Whitcroft my $ln = $linenr; 4550d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4551c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4552c45dcabdSAndy Whitcroft my $ctx = ''; 455308a2843eSJoe Perches my $has_flow_statement = 0; 455408a2843eSJoe Perches my $has_arg_concat = 0; 4555c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4556f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4557f74bd194SAndy Whitcroft $ctx = $dstat; 4558c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4559a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4560c45dcabdSAndy Whitcroft 456108a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 456262e15a6dSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 456308a2843eSJoe Perches 4564f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4565292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4566c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4567c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4568c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4569c45dcabdSAndy Whitcroft 4570c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4571bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4572bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 45736b10df42SVladimir Zapolskiy $dstat =~ s/.\[[^\[\]]*\]/1/) 4574bf30d6edSAndy Whitcroft { 4575c45dcabdSAndy Whitcroft } 4576c45dcabdSAndy Whitcroft 4577e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 457833acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 457933acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4580e45bab8eSAndy Whitcroft { 4581e45bab8eSAndy Whitcroft } 4582e45bab8eSAndy Whitcroft 458342e15293SJoe Perches # Make asm volatile uses seem like a generic function 458442e15293SJoe Perches $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 458542e15293SJoe Perches 4586c45dcabdSAndy Whitcroft my $exceptions = qr{ 4587c45dcabdSAndy Whitcroft $Declare| 4588c45dcabdSAndy Whitcroft module_param_named| 4589a0a0a7a9SKees Cook MODULE_PARM_DESC| 4590c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4591c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4592383099fdSAndy Whitcroft __typeof__\(| 459322fd2d3eSStefani Seibold union| 459422fd2d3eSStefani Seibold struct| 4595ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 45966b10df42SVladimir Zapolskiy ^\"|\"$| 45976b10df42SVladimir Zapolskiy ^\[ 4598c45dcabdSAndy Whitcroft }x; 45995eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4600f74bd194SAndy Whitcroft if ($dstat ne '' && 4601f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4602f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 46033cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4604356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4605f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4606f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4607e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 460872f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4609f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4610f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4611f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 46124e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4613f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4614c45dcabdSAndy Whitcroft { 4615f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4616f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4617f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4618f74bd194SAndy Whitcroft 4619f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4620f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4621c45dcabdSAndy Whitcroft } 4622c45dcabdSAndy Whitcroft 4623f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4624f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4625f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4626f74bd194SAndy Whitcroft } else { 4627000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4628388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4629d8aaf121SAndy Whitcroft } 46300a920b5bSAndy Whitcroft } 46315023d347SJoe Perches 463208a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 463308a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 463408a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 463508a2843eSJoe Perches my $herectx = $here . "\n"; 463608a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 463708a2843eSJoe Perches 463808a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 463908a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 464008a2843eSJoe Perches } 464108a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 464208a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 464308a2843eSJoe Perches } 464408a2843eSJoe Perches 4645481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 46465023d347SJoe Perches 46475023d347SJoe Perches } else { 46485023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4649481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4650481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 46515023d347SJoe Perches $line =~ /^\+.*\\$/) { 46525023d347SJoe Perches WARN("LINE_CONTINUATIONS", 46535023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 46545023d347SJoe Perches } 4655653d4876SAndy Whitcroft } 46560a920b5bSAndy Whitcroft 4657b13edf7fSJoe Perches# do {} while (0) macro tests: 4658b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4659b13edf7fSJoe Perches# macro should not end with a semicolon 4660b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4661b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4662b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4663b13edf7fSJoe Perches my $ln = $linenr; 4664b13edf7fSJoe Perches my $cnt = $realcnt; 4665b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4666b13edf7fSJoe Perches my $ctx = ''; 4667b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4668b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4669b13edf7fSJoe Perches $ctx = $dstat; 4670b13edf7fSJoe Perches 4671b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 46721b36b201SJoe Perches $dstat =~ s/$;/ /g; 4673b13edf7fSJoe Perches 4674b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4675b13edf7fSJoe Perches my $stmts = $2; 4676b13edf7fSJoe Perches my $semis = $3; 4677b13edf7fSJoe Perches 4678b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4679b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4680b13edf7fSJoe Perches my $herectx = $here . "\n"; 4681b13edf7fSJoe Perches 4682b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4683b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4684b13edf7fSJoe Perches } 4685b13edf7fSJoe Perches 4686ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4687ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4688b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4689b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4690b13edf7fSJoe Perches } 4691b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4692b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4693b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4694b13edf7fSJoe Perches } 4695f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4696f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4697f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4698f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4699f5ef95b1SJoe Perches 4700f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4701f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4702f5ef95b1SJoe Perches } 4703f5ef95b1SJoe Perches 4704f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4705f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4706b13edf7fSJoe Perches } 4707b13edf7fSJoe Perches } 4708b13edf7fSJoe Perches 4709080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4710080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4711080ba929SMike Frysinger# . 4712080ba929SMike Frysinger# ALIGN(...) 4713080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4714080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4715000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4716000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4717080ba929SMike Frysinger } 4718080ba929SMike Frysinger 4719f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 472013214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 472113214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4722cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 472313214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4724cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4725cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4726aad4f614SJoe Perches my @allowed = (); 4727aad4f614SJoe Perches my $allow = 0; 472813214adfSAndy Whitcroft my $seen = 0; 4729773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4730cf655043SAndy Whitcroft my $ln = $linenr - 1; 473113214adfSAndy Whitcroft for my $chunk (@chunks) { 473213214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 473313214adfSAndy Whitcroft 4734773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4735773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4736773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4737773647a0SAndy Whitcroft 4738aad4f614SJoe Perches $allowed[$allow] = 0; 4739773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4740773647a0SAndy Whitcroft 4741773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4742773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4743773647a0SAndy Whitcroft 4744773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4745cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4746cf655043SAndy Whitcroft 4747773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 474813214adfSAndy Whitcroft 474913214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 475013214adfSAndy Whitcroft 4751aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4752cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4753cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4754aad4f614SJoe Perches $allowed[$allow] = 1; 475513214adfSAndy Whitcroft } 475613214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4757cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4758aad4f614SJoe Perches $allowed[$allow] = 1; 475913214adfSAndy Whitcroft } 4760cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4761cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4762aad4f614SJoe Perches $allowed[$allow] = 1; 476313214adfSAndy Whitcroft } 4764aad4f614SJoe Perches $allow++; 476513214adfSAndy Whitcroft } 4766aad4f614SJoe Perches if ($seen) { 4767aad4f614SJoe Perches my $sum_allowed = 0; 4768aad4f614SJoe Perches foreach (@allowed) { 4769aad4f614SJoe Perches $sum_allowed += $_; 4770aad4f614SJoe Perches } 4771aad4f614SJoe Perches if ($sum_allowed == 0) { 4772000d1cc1SJoe Perches WARN("BRACES", 4773000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4774aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4775aad4f614SJoe Perches $seen != $allow) { 4776aad4f614SJoe Perches CHK("BRACES", 4777aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4778aad4f614SJoe Perches } 477913214adfSAndy Whitcroft } 478013214adfSAndy Whitcroft } 478113214adfSAndy Whitcroft } 4782773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 478313214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4784cf655043SAndy Whitcroft my $allowed = 0; 4785f0a594c1SAndy Whitcroft 4786cf655043SAndy Whitcroft # Check the pre-context. 4787cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4788cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4789cf655043SAndy Whitcroft $allowed = 1; 4790f0a594c1SAndy Whitcroft } 4791773647a0SAndy Whitcroft 4792773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4793773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4794773647a0SAndy Whitcroft 4795cf655043SAndy Whitcroft # Check the condition. 4796cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4797773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4798cf655043SAndy Whitcroft if (defined $cond) { 4799773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4800cf655043SAndy Whitcroft } 4801cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4802cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4803cf655043SAndy Whitcroft $allowed = 1; 4804cf655043SAndy Whitcroft } 4805cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4806cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4807cf655043SAndy Whitcroft $allowed = 1; 4808cf655043SAndy Whitcroft } 4809cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4810cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4811cf655043SAndy Whitcroft $allowed = 1; 4812cf655043SAndy Whitcroft } 4813cf655043SAndy Whitcroft # Check the post-context. 4814cf655043SAndy Whitcroft if (defined $chunks[1]) { 4815cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4816cf655043SAndy Whitcroft if (defined $cond) { 4817773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4818cf655043SAndy Whitcroft } 4819cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4820cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4821cf655043SAndy Whitcroft $allowed = 1; 4822cf655043SAndy Whitcroft } 4823cf655043SAndy Whitcroft } 4824cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 482569932487SJustin P. Mattock my $herectx = $here . "\n"; 4826f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4827cf655043SAndy Whitcroft 4828f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 482969932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4830cf655043SAndy Whitcroft } 4831cf655043SAndy Whitcroft 4832000d1cc1SJoe Perches WARN("BRACES", 4833000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4834f0a594c1SAndy Whitcroft } 4835f0a594c1SAndy Whitcroft } 4836f0a594c1SAndy Whitcroft 48370979ae66SJoe Perches# check for unnecessary blank lines around braces 483877b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4839f8e58219SJoe Perches if (CHK("BRACES", 4840f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4841f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4842f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4843f8e58219SJoe Perches } 48440979ae66SJoe Perches } 484577b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4846f8e58219SJoe Perches if (CHK("BRACES", 4847f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4848f8e58219SJoe Perches $fix) { 4849f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4850f8e58219SJoe Perches } 48510979ae66SJoe Perches } 48520979ae66SJoe Perches 48534a0df2efSAndy Whitcroft# no volatiles please 48546c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 48556c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4856000d1cc1SJoe Perches WARN("VOLATILE", 4857000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 48584a0df2efSAndy Whitcroft } 48594a0df2efSAndy Whitcroft 48605e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 48615e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 48625e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 48635e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 486433acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 48655e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 48665e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 48675e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 48685e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 48695e4f6ba5SJoe Perches $fix && 48705e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 48715e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 48725e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 48735e4f6ba5SJoe Perches my $comma_close = ""; 48745e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 48755e4f6ba5SJoe Perches $comma_close = $1; 48765e4f6ba5SJoe Perches } 48775e4f6ba5SJoe Perches 48785e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48795e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 48805e4f6ba5SJoe Perches my $fixedline = $prevrawline; 48815e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 48825e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 48835e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 48845e4f6ba5SJoe Perches $fixedline = $rawline; 48855e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 48865e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 48875e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48885e4f6ba5SJoe Perches } 48895e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 48905e4f6ba5SJoe Perches } 48915e4f6ba5SJoe Perches } 48925e4f6ba5SJoe Perches 48935e4f6ba5SJoe Perches# check for missing a space in a string concatenation 48945e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 48955e4f6ba5SJoe Perches WARN('MISSING_SPACE', 48965e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 48975e4f6ba5SJoe Perches } 48985e4f6ba5SJoe Perches 48995e4f6ba5SJoe Perches# check for spaces before a quoted newline 49005e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 49015e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 49025e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 49035e4f6ba5SJoe Perches $fix) { 49045e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 49055e4f6ba5SJoe Perches } 49065e4f6ba5SJoe Perches 49075e4f6ba5SJoe Perches } 49085e4f6ba5SJoe Perches 4909f17dba4fSJoe Perches# concatenated string without spaces between elements 491033acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4911f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4912f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4913f17dba4fSJoe Perches } 4914f17dba4fSJoe Perches 491590ad30e5SJoe Perches# uncoalesced string fragments 491633acb54aSJoe Perches if ($line =~ /$String\s*"/) { 491790ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 491890ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 491990ad30e5SJoe Perches } 492090ad30e5SJoe Perches 49216e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 49225e4f6ba5SJoe Perches my $string; 49235e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 49245e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 49255e4f6ba5SJoe Perches $string =~ s/%%/__/g; 49266e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 49275e4f6ba5SJoe Perches WARN("PRINTF_L", 49285e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 49295e4f6ba5SJoe Perches last; 49305e4f6ba5SJoe Perches } 49316e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 49326e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 49336e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 49346e300757SJoe Perches } 49355e4f6ba5SJoe Perches } 49365e4f6ba5SJoe Perches 49375e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 49385e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 49395e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 49405e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 49415e4f6ba5SJoe Perches } 49425e4f6ba5SJoe Perches 494300df344fSAndy Whitcroft# warn about #if 0 4944c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4945000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4946000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4947de7d4f0eSAndy Whitcroft $herecurr); 49484a0df2efSAndy Whitcroft } 49494a0df2efSAndy Whitcroft 495003df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 495103df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 4952100425deSJoe Perches my $tested = quotemeta($1); 4953100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 4954100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 4955100425deSJoe Perches my $func = $1; 4956100425deSJoe Perches if (WARN('NEEDLESS_IF', 4957100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 4958100425deSJoe Perches $fix) { 4959100425deSJoe Perches my $do_fix = 1; 4960100425deSJoe Perches my $leading_tabs = ""; 4961100425deSJoe Perches my $new_leading_tabs = ""; 4962100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 4963100425deSJoe Perches $leading_tabs = $1; 4964100425deSJoe Perches } else { 4965100425deSJoe Perches $do_fix = 0; 4966100425deSJoe Perches } 4967100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 4968100425deSJoe Perches $new_leading_tabs = $1; 4969100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 4970100425deSJoe Perches $do_fix = 0; 4971100425deSJoe Perches } 4972100425deSJoe Perches } else { 4973100425deSJoe Perches $do_fix = 0; 4974100425deSJoe Perches } 4975100425deSJoe Perches if ($do_fix) { 4976100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4977100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 4978100425deSJoe Perches } 4979100425deSJoe Perches } 49804c432a8fSGreg Kroah-Hartman } 49814c432a8fSGreg Kroah-Hartman } 4982f0a594c1SAndy Whitcroft 4983ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4984ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4985ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4986ebfdc409SJoe Perches (defined $1 || defined $3) && 4987ebfdc409SJoe Perches $linenr > 3) { 4988ebfdc409SJoe Perches my $testval = $2; 4989ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4990ebfdc409SJoe Perches 4991ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4992ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4993ebfdc409SJoe Perches 4994ebfdc409SJoe 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)/) { 4995ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4996ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4997ebfdc409SJoe Perches } 4998ebfdc409SJoe Perches } 4999ebfdc409SJoe Perches 5000f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 5001dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 5002f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 5003f78d98f6SJoe Perches my $level = $1; 5004f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 5005f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 5006f78d98f6SJoe Perches $fix) { 5007f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 5008f78d98f6SJoe Perches } 5009f78d98f6SJoe Perches } 5010f78d98f6SJoe Perches 5011abb08a53SJoe Perches# check for mask then right shift without a parentheses 5012abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 5013abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 5014abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 5015abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 5016abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 5017abb08a53SJoe Perches } 5018abb08a53SJoe Perches 5019b75ac618SJoe Perches# check for pointer comparisons to NULL 5020b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 5021b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 5022b75ac618SJoe Perches my $val = $1; 5023b75ac618SJoe Perches my $equal = "!"; 5024b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 5025b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 5026b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 5027b75ac618SJoe Perches $fix) { 5028b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 5029b75ac618SJoe Perches } 5030b75ac618SJoe Perches } 5031b75ac618SJoe Perches } 5032b75ac618SJoe Perches 50338716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 50348716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 50358716de38SJoe Perches my $attr = $1; 50368716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 50378716de38SJoe Perches my $ptr = $1; 50388716de38SJoe Perches my $var = $2; 50398716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 50408716de38SJoe Perches ERROR("MISPLACED_INIT", 50418716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 50428716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 50438716de38SJoe Perches WARN("MISPLACED_INIT", 50448716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 50458716de38SJoe Perches $fix) { 5046194f66fcSJoe 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; 50478716de38SJoe Perches } 50488716de38SJoe Perches } 50498716de38SJoe Perches } 50508716de38SJoe Perches 5051e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5052e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5053e970b884SJoe Perches my $attr = $1; 5054e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5055e970b884SJoe Perches my $attr_prefix = $1; 5056e970b884SJoe Perches my $attr_type = $2; 5057e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5058e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5059e970b884SJoe Perches $fix) { 5060194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5061e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5062e970b884SJoe Perches } 5063e970b884SJoe Perches } 5064e970b884SJoe Perches 5065e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5066e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5067e970b884SJoe Perches my $attr = $1; 5068e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5069e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5070e970b884SJoe Perches $fix) { 5071194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5072e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5073e970b884SJoe Perches $lead = rtrim($1); 5074e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5075e970b884SJoe Perches $lead = "${lead}const "; 5076194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5077e970b884SJoe Perches } 5078e970b884SJoe Perches } 5079e970b884SJoe Perches 5080c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5081c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5082c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5083c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5084c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5085c17893c7SJoe Perches $fix) { 5086c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5087c17893c7SJoe Perches } 5088c17893c7SJoe Perches } 5089c17893c7SJoe Perches 5090fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5091fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5092fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5093fbdb8138SJoe Perches my $constant_func = $1; 5094fbdb8138SJoe Perches my $func = $constant_func; 5095fbdb8138SJoe Perches $func =~ s/^__constant_//; 5096fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5097fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5098fbdb8138SJoe Perches $fix) { 5099194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5100fbdb8138SJoe Perches } 5101fbdb8138SJoe Perches } 5102fbdb8138SJoe Perches 51031a15a250SPatrick Pannuto# prefer usleep_range over udelay 510437581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 510543c1d77cSJoe Perches my $delay = $1; 51061a15a250SPatrick Pannuto # ignore udelay's < 10, however 510743c1d77cSJoe Perches if (! ($delay < 10) ) { 5108000d1cc1SJoe Perches CHK("USLEEP_RANGE", 510943c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 511043c1d77cSJoe Perches } 511143c1d77cSJoe Perches if ($delay > 2000) { 511243c1d77cSJoe Perches WARN("LONG_UDELAY", 511343c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 51141a15a250SPatrick Pannuto } 51151a15a250SPatrick Pannuto } 51161a15a250SPatrick Pannuto 511709ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 511809ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 511909ef8725SPatrick Pannuto if ($1 < 20) { 5120000d1cc1SJoe Perches WARN("MSLEEP", 512143c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 512209ef8725SPatrick Pannuto } 512309ef8725SPatrick Pannuto } 512409ef8725SPatrick Pannuto 512536ec1939SJoe Perches# check for comparisons of jiffies 512636ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 512736ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 512836ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 512936ec1939SJoe Perches } 513036ec1939SJoe Perches 51319d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 51329d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 51339d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 51349d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 51359d7a34a5SJoe Perches } 51369d7a34a5SJoe Perches 513700df344fSAndy Whitcroft# warn about #ifdefs in C files 5138c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 513900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 514000df344fSAndy Whitcroft# print "$herecurr"; 514100df344fSAndy Whitcroft# $clean = 0; 514200df344fSAndy Whitcroft# } 514300df344fSAndy Whitcroft 514422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5145c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 51463705ce5bSJoe Perches if (ERROR("SPACING", 51473705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 51483705ce5bSJoe Perches $fix) { 5149194f66fcSJoe Perches $fixed[$fixlinenr] =~ 51503705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 51513705ce5bSJoe Perches } 51523705ce5bSJoe Perches 515322f2a2efSAndy Whitcroft } 515422f2a2efSAndy Whitcroft 51554a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5156171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5157171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 51584a0df2efSAndy Whitcroft my $which = $1; 51594a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5160000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5161000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 51624a0df2efSAndy Whitcroft } 51634a0df2efSAndy Whitcroft } 51644a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5165402c2553SMichael S. Tsirkin 5166402c2553SMichael S. Tsirkin my $barriers = qr{ 5167402c2553SMichael S. Tsirkin mb| 5168402c2553SMichael S. Tsirkin rmb| 5169402c2553SMichael S. Tsirkin wmb| 5170402c2553SMichael S. Tsirkin read_barrier_depends 5171402c2553SMichael S. Tsirkin }x; 5172402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5173402c2553SMichael S. Tsirkin mb__before_atomic| 5174402c2553SMichael S. Tsirkin mb__after_atomic| 5175402c2553SMichael S. Tsirkin store_release| 5176402c2553SMichael S. Tsirkin load_acquire| 5177402c2553SMichael S. Tsirkin store_mb| 5178402c2553SMichael S. Tsirkin (?:$barriers) 5179402c2553SMichael S. Tsirkin }x; 5180402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5181402c2553SMichael S. Tsirkin (?:$barriers)| 518243e361f2SMichael S. Tsirkin smp_(?:$barrier_stems)| 518343e361f2SMichael S. Tsirkin virt_(?:$barrier_stems) 5184402c2553SMichael S. Tsirkin }x; 5185402c2553SMichael S. Tsirkin 5186402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 51874a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5188c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5189000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 51904a0df2efSAndy Whitcroft } 51914a0df2efSAndy Whitcroft } 51923ad81779SPaul E. McKenney 5193f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5194f4073b0fSMichael S. Tsirkin 5195f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5196f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5197f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5198f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5199f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5200f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5201f4073b0fSMichael S. Tsirkin } 5202f4073b0fSMichael S. Tsirkin 5203cb426e99SJoe Perches# check for waitqueue_active without a comment. 5204cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5205cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5206cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5207cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5208cb426e99SJoe Perches } 5209cb426e99SJoe Perches } 52103ad81779SPaul E. McKenney 52113ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 52123ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 52133ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 52143ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 52153ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 52163ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 52173ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 52183ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 52193ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 52203ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 52213ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 52223ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 52233ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 52243ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 52253ad81779SPaul E. McKenney 52263ad81779SPaul E. McKenney } 52273ad81779SPaul E. McKenney 52284a0df2efSAndy Whitcroft# check of hardware specific defines 5229c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5230000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5231000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 52320a920b5bSAndy Whitcroft } 5233653d4876SAndy Whitcroft 5234d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5235d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5236000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5237000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5238d4977c78STobias Klauser } 5239d4977c78STobias Klauser 5240de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5241de7d4f0eSAndy Whitcroft# storage class and type. 52429c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 52439c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5244000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5245000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5246de7d4f0eSAndy Whitcroft } 5247de7d4f0eSAndy Whitcroft 52488905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 52492b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52502b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5251d5e616fcSJoe Perches if (WARN("INLINE", 5252d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5253d5e616fcSJoe Perches $fix) { 5254194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5255d5e616fcSJoe Perches 5256d5e616fcSJoe Perches } 52578905a67cSAndy Whitcroft } 52588905a67cSAndy Whitcroft 52593d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 52602b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52612b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5262000d1cc1SJoe Perches WARN("PREFER_PACKED", 5263000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 52643d130fd0SJoe Perches } 52653d130fd0SJoe Perches 526639b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 52672b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52682b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5269000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5270000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 527139b7e287SJoe Perches } 527239b7e287SJoe Perches 52735f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 52742b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52752b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5276d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5277d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5278d5e616fcSJoe Perches $fix) { 5279194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5280d5e616fcSJoe Perches 5281d5e616fcSJoe Perches } 52825f14d3bdSJoe Perches } 52835f14d3bdSJoe Perches 52846061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 52852b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52862b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5287d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5288d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5289d5e616fcSJoe Perches $fix) { 5290194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5291d5e616fcSJoe Perches } 52926061d949SJoe Perches } 52936061d949SJoe Perches 5294619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5295619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5296619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5297619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5298619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5299619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5300619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5301619a908aSJoe Perches } 5302619a908aSJoe Perches 5303e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5304e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5305e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5306e6176fa4SJoe Perches my $type = $1; 5307e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5308e6176fa4SJoe Perches $type = $1; 5309e6176fa4SJoe Perches my $kernel_type = 'u'; 5310e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5311e6176fa4SJoe Perches $type =~ /(\d+)/; 5312e6176fa4SJoe Perches $kernel_type .= $1; 5313e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5314e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5315e6176fa4SJoe Perches $fix) { 5316e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5317e6176fa4SJoe Perches } 5318e6176fa4SJoe Perches } 5319e6176fa4SJoe Perches } 5320e6176fa4SJoe Perches 5321938224b5SJoe Perches# check for cast of C90 native int or longer types constants 5322938224b5SJoe Perches if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 5323938224b5SJoe Perches my $cast = $1; 5324938224b5SJoe Perches my $const = $2; 5325938224b5SJoe Perches if (WARN("TYPECAST_INT_CONSTANT", 5326938224b5SJoe Perches "Unnecessary typecast of c90 int constant\n" . $herecurr) && 5327938224b5SJoe Perches $fix) { 5328938224b5SJoe Perches my $suffix = ""; 5329938224b5SJoe Perches my $newconst = $const; 5330938224b5SJoe Perches $newconst =~ s/${Int_type}$//; 5331938224b5SJoe Perches $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 5332938224b5SJoe Perches if ($cast =~ /\blong\s+long\b/) { 5333938224b5SJoe Perches $suffix .= 'LL'; 5334938224b5SJoe Perches } elsif ($cast =~ /\blong\b/) { 5335938224b5SJoe Perches $suffix .= 'L'; 5336938224b5SJoe Perches } 5337938224b5SJoe Perches $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 5338938224b5SJoe Perches } 5339938224b5SJoe Perches } 5340938224b5SJoe Perches 53418f53a9b8SJoe Perches# check for sizeof(&) 53428f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5343000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5344000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 53458f53a9b8SJoe Perches } 53468f53a9b8SJoe Perches 534766c80b60SJoe Perches# check for sizeof without parenthesis 534866c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5349d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5350d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5351d5e616fcSJoe Perches $fix) { 5352194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5353d5e616fcSJoe Perches } 535466c80b60SJoe Perches } 535566c80b60SJoe Perches 535688982feaSJoe Perches# check for struct spinlock declarations 535788982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 535888982feaSJoe Perches WARN("USE_SPINLOCK_T", 535988982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 536088982feaSJoe Perches } 536188982feaSJoe Perches 5362a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 536306668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5364a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5365caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5366caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5367d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5368d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5369d5e616fcSJoe Perches $fix) { 5370194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5371d5e616fcSJoe Perches } 5372a6962d72SJoe Perches } 5373a6962d72SJoe Perches } 5374a6962d72SJoe Perches 5375554e165cSAndy Whitcroft# Check for misused memsets 5376d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5377d1fe9c09SJoe Perches defined $stat && 53789e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5379554e165cSAndy Whitcroft 5380d7c76ba7SJoe Perches my $ms_addr = $2; 5381d1fe9c09SJoe Perches my $ms_val = $7; 5382d1fe9c09SJoe Perches my $ms_size = $12; 5383d7c76ba7SJoe Perches 5384554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5385554e165cSAndy Whitcroft ERROR("MEMSET", 5386d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5387554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5388554e165cSAndy Whitcroft WARN("MEMSET", 5389d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5390d7c76ba7SJoe Perches } 5391d7c76ba7SJoe Perches } 5392d7c76ba7SJoe Perches 539398a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 539498a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 539510895d2cSMateusz Kulikowski defined $stat && 539610895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 539798a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 539810895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 539998a9bba5SJoe Perches $fix) { 5400194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 540198a9bba5SJoe Perches } 540298a9bba5SJoe Perches } 540398a9bba5SJoe Perches 5404b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5405b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5406b6117d17SMateusz Kulikowski defined $stat && 5407b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5408b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5409b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5410b6117d17SMateusz Kulikowski } 5411b6117d17SMateusz Kulikowski 54128617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 54138617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 54148617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 54158617cd09SMateusz Kulikowski defined $stat && 54168617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 54178617cd09SMateusz Kulikowski 54188617cd09SMateusz Kulikowski my $ms_val = $7; 54198617cd09SMateusz Kulikowski 54208617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 54218617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 54228617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 54238617cd09SMateusz Kulikowski $fix) { 54248617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 54258617cd09SMateusz Kulikowski } 54268617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 54278617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 54288617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 54298617cd09SMateusz Kulikowski $fix) { 54308617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 54318617cd09SMateusz Kulikowski } 54328617cd09SMateusz Kulikowski } 54338617cd09SMateusz Kulikowski } 54348617cd09SMateusz Kulikowski 5435d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5436d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5437d1fe9c09SJoe Perches defined $stat && 5438d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5439d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5440d7c76ba7SJoe Perches my $call = $1; 5441d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5442d7c76ba7SJoe Perches my $arg1 = $3; 5443d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5444d1fe9c09SJoe Perches my $arg2 = $8; 5445d7c76ba7SJoe Perches my $cast; 5446d7c76ba7SJoe Perches 5447d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5448d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5449d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5450d7c76ba7SJoe Perches $cast = $cast1; 5451d7c76ba7SJoe Perches } else { 5452d7c76ba7SJoe Perches $cast = $cast2; 5453d7c76ba7SJoe Perches } 5454d7c76ba7SJoe Perches WARN("MINMAX", 5455d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5456554e165cSAndy Whitcroft } 5457554e165cSAndy Whitcroft } 5458554e165cSAndy Whitcroft 54594a273195SJoe Perches# check usleep_range arguments 54604a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 54614a273195SJoe Perches defined $stat && 54624a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 54634a273195SJoe Perches my $min = $1; 54644a273195SJoe Perches my $max = $7; 54654a273195SJoe Perches if ($min eq $max) { 54664a273195SJoe Perches WARN("USLEEP_RANGE", 54674a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 54684a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 54694a273195SJoe Perches $min > $max) { 54704a273195SJoe Perches WARN("USLEEP_RANGE", 54714a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 54724a273195SJoe Perches } 54734a273195SJoe Perches } 54744a273195SJoe Perches 5475823b794cSJoe Perches# check for naked sscanf 5476823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5477823b794cSJoe Perches defined $stat && 54786c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5479823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5480823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5481823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5482823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5483823b794cSJoe Perches $lc = $lc + $linenr; 5484823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5485823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5486823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5487823b794cSJoe Perches } 5488823b794cSJoe Perches WARN("NAKED_SSCANF", 5489823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5490823b794cSJoe Perches } 5491823b794cSJoe Perches 5492afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5493afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5494afc819abSJoe Perches defined $stat && 5495afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5496afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5497afc819abSJoe Perches $lc = $lc + $linenr; 5498afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5499afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5500afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5501afc819abSJoe Perches } 5502afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5503afc819abSJoe Perches my $format = $6; 5504afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5505afc819abSJoe Perches if ($count == 1 && 5506afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5507afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5508afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5509afc819abSJoe Perches } 5510afc819abSJoe Perches } 5511afc819abSJoe Perches } 5512afc819abSJoe Perches 551370dc8a48SJoe Perches# check for new externs in .h files. 551470dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 551570dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5516d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 551770dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 551870dc8a48SJoe Perches $fix) { 5519194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 552070dc8a48SJoe Perches } 552170dc8a48SJoe Perches } 552270dc8a48SJoe Perches 5523de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5524171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5525c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5526171ae1a4SAndy Whitcroft { 5527c45dcabdSAndy Whitcroft my $function_name = $1; 5528c45dcabdSAndy Whitcroft my $paren_space = $2; 5529171ae1a4SAndy Whitcroft 5530171ae1a4SAndy Whitcroft my $s = $stat; 5531171ae1a4SAndy Whitcroft if (defined $cond) { 5532171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5533171ae1a4SAndy Whitcroft } 5534c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5535c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5536c45dcabdSAndy Whitcroft { 5537000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5538000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5539de7d4f0eSAndy Whitcroft } 5540de7d4f0eSAndy Whitcroft 5541171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5542000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5543000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5544171ae1a4SAndy Whitcroft } 55459c9ba34eSAndy Whitcroft 55469c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 55479c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 55489c9ba34eSAndy Whitcroft { 5549000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5550000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5551171ae1a4SAndy Whitcroft } 5552171ae1a4SAndy Whitcroft 5553de7d4f0eSAndy Whitcroft# checks for new __setup's 5554de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5555de7d4f0eSAndy Whitcroft my $name = $1; 5556de7d4f0eSAndy Whitcroft 5557de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5558000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5559000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5560de7d4f0eSAndy Whitcroft } 5561653d4876SAndy Whitcroft } 55629c0ca6f9SAndy Whitcroft 55639c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5564caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5565000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5566000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 55679c0ca6f9SAndy Whitcroft } 556813214adfSAndy Whitcroft 5569a640d25cSJoe Perches# alloc style 5570a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5571a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5572a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5573a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5574a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5575a640d25cSJoe Perches } 5576a640d25cSJoe Perches 557760a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 557860a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5579e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 558060a55369SJoe Perches my $oldfunc = $3; 558160a55369SJoe Perches my $a1 = $4; 558260a55369SJoe Perches my $a2 = $10; 558360a55369SJoe Perches my $newfunc = "kmalloc_array"; 558460a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 558560a55369SJoe Perches my $r1 = $a1; 558660a55369SJoe Perches my $r2 = $a2; 558760a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 558860a55369SJoe Perches $r1 = $a2; 558960a55369SJoe Perches $r2 = $a1; 559060a55369SJoe Perches } 5591e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5592e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5593e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5594e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5595e367455aSJoe Perches $fix) { 5596194f66fcSJoe 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; 559760a55369SJoe Perches 559860a55369SJoe Perches } 559960a55369SJoe Perches } 560060a55369SJoe Perches } 560160a55369SJoe Perches 5602972fdea2SJoe Perches# check for krealloc arg reuse 5603972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5604972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5605972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5606972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5607972fdea2SJoe Perches } 5608972fdea2SJoe Perches 56095ce59ae0SJoe Perches# check for alloc argument mismatch 56105ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 56115ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 56125ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 56135ce59ae0SJoe Perches } 56145ce59ae0SJoe Perches 5615caf2a54fSJoe Perches# check for multiple semicolons 5616caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5617d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5618d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5619d5e616fcSJoe Perches $fix) { 5620194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5621d5e616fcSJoe Perches } 5622d1e2ad07SJoe Perches } 5623d1e2ad07SJoe Perches 56240ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 56250ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 56260ab90191SJoe Perches my $ull = ""; 56270ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 56280ab90191SJoe Perches if (CHK("BIT_MACRO", 56290ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 56300ab90191SJoe Perches $fix) { 56310ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 56320ab90191SJoe Perches } 56330ab90191SJoe Perches } 56340ab90191SJoe Perches 5635e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5636c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5637c34c09a8SJoe Perches my $has_break = 0; 5638c34c09a8SJoe Perches my $has_statement = 0; 5639c34c09a8SJoe Perches my $count = 0; 5640c34c09a8SJoe Perches my $prevline = $linenr; 5641e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5642c34c09a8SJoe Perches $prevline--; 5643c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5644c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5645c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5646c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5647c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5648c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5649c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5650c34c09a8SJoe Perches $has_statement = 1; 5651c34c09a8SJoe Perches $count++; 5652c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5653c34c09a8SJoe Perches } 5654c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5655c34c09a8SJoe Perches WARN("MISSING_BREAK", 5656c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5657c34c09a8SJoe Perches } 5658c34c09a8SJoe Perches } 5659c34c09a8SJoe Perches 5660d1e2ad07SJoe Perches# check for switch/default statements without a break; 5661d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5662d1e2ad07SJoe Perches defined $stat && 5663d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5664d1e2ad07SJoe Perches my $ctx = ''; 5665d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5666d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5667d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5668d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5669d1e2ad07SJoe Perches } 5670d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5671d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5672caf2a54fSJoe Perches } 5673caf2a54fSJoe Perches 567413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5675d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5676d5e616fcSJoe Perches if (WARN("USE_FUNC", 5677d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5678d5e616fcSJoe Perches $fix) { 5679194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5680d5e616fcSJoe Perches } 568113214adfSAndy Whitcroft } 5682773647a0SAndy Whitcroft 568362ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 568462ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 568562ec818fSJoe Perches ERROR("DATE_TIME", 568662ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 568762ec818fSJoe Perches } 568862ec818fSJoe Perches 56892c92488aSJoe Perches# check for use of yield() 56902c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 56912c92488aSJoe Perches WARN("YIELD", 56922c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 56932c92488aSJoe Perches } 56942c92488aSJoe Perches 5695179f8f40SJoe Perches# check for comparisons against true and false 5696179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5697179f8f40SJoe Perches my $lead = $1; 5698179f8f40SJoe Perches my $arg = $2; 5699179f8f40SJoe Perches my $test = $3; 5700179f8f40SJoe Perches my $otype = $4; 5701179f8f40SJoe Perches my $trail = $5; 5702179f8f40SJoe Perches my $op = "!"; 5703179f8f40SJoe Perches 5704179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5705179f8f40SJoe Perches 5706179f8f40SJoe Perches my $type = lc($otype); 5707179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5708179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5709179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5710179f8f40SJoe Perches $op = ""; 5711179f8f40SJoe Perches } 5712179f8f40SJoe Perches 5713179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5714179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5715179f8f40SJoe Perches 5716179f8f40SJoe Perches## maybe suggesting a correct construct would better 5717179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5718179f8f40SJoe Perches 5719179f8f40SJoe Perches } 5720179f8f40SJoe Perches } 5721179f8f40SJoe Perches 57224882720bSThomas Gleixner# check for semaphores initialized locked 57234882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5724000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5725000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5726773647a0SAndy Whitcroft } 57276712d858SJoe Perches 572867d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 572967d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5730000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 573167d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5732773647a0SAndy Whitcroft } 57336712d858SJoe Perches 5734ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5735f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5736000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5737ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5738f3db6639SMichael Ellerman } 57396712d858SJoe Perches 57400f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 57410f3c5aabSJoe Perches my $const_structs = qr{ 57420f3c5aabSJoe Perches acpi_dock_ops| 574379404849SEmese Revfy address_space_operations| 574479404849SEmese Revfy backlight_ops| 574579404849SEmese Revfy block_device_operations| 574679404849SEmese Revfy dentry_operations| 574779404849SEmese Revfy dev_pm_ops| 574879404849SEmese Revfy dma_map_ops| 574979404849SEmese Revfy extent_io_ops| 575079404849SEmese Revfy file_lock_operations| 575179404849SEmese Revfy file_operations| 575279404849SEmese Revfy hv_ops| 575379404849SEmese Revfy ide_dma_ops| 575479404849SEmese Revfy intel_dvo_dev_ops| 575579404849SEmese Revfy item_operations| 575679404849SEmese Revfy iwl_ops| 575779404849SEmese Revfy kgdb_arch| 575879404849SEmese Revfy kgdb_io| 575979404849SEmese Revfy kset_uevent_ops| 576079404849SEmese Revfy lock_manager_operations| 576179404849SEmese Revfy microcode_ops| 576279404849SEmese Revfy mtrr_ops| 576379404849SEmese Revfy neigh_ops| 576479404849SEmese Revfy nlmsvc_binding| 57650f3c5aabSJoe Perches of_device_id| 576679404849SEmese Revfy pci_raw_ops| 576779404849SEmese Revfy pipe_buf_operations| 576879404849SEmese Revfy platform_hibernation_ops| 576979404849SEmese Revfy platform_suspend_ops| 577079404849SEmese Revfy proto_ops| 577179404849SEmese Revfy rpc_pipe_ops| 577279404849SEmese Revfy seq_operations| 577379404849SEmese Revfy snd_ac97_build_ops| 577479404849SEmese Revfy soc_pcmcia_socket_ops| 577579404849SEmese Revfy stacktrace_ops| 577679404849SEmese Revfy sysfs_ops| 577779404849SEmese Revfy tty_operations| 57786d07d01bSJoe Perches uart_ops| 577979404849SEmese Revfy usb_mon_operations| 578079404849SEmese Revfy wd_ops}x; 57816903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 57820f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5783000d1cc1SJoe Perches WARN("CONST_STRUCT", 5784000d1cc1SJoe Perches "struct $1 should normally be const\n" . 57856903ffb2SAndy Whitcroft $herecurr); 57862b6db5cbSAndy Whitcroft } 5787773647a0SAndy Whitcroft 5788773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5789773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5790773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5791c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5792c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5793171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5794171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5795171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5796773647a0SAndy Whitcroft { 5797000d1cc1SJoe Perches WARN("NR_CPUS", 5798000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5799773647a0SAndy Whitcroft } 58009c9ba34eSAndy Whitcroft 580152ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 580252ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 580352ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 580452ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 580552ea8506SJoe Perches } 580652ea8506SJoe Perches 5807acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5808acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5809acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5810acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5811acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5812acd9362cSJoe Perches } 5813acd9362cSJoe Perches 5814691d77b6SAndy Whitcroft# whine mightly about in_atomic 5815691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5816691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5817000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5818000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5819f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5820000d1cc1SJoe Perches WARN("IN_ATOMIC", 5821000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5822691d77b6SAndy Whitcroft } 5823691d77b6SAndy Whitcroft } 58241704f47bSPeter Zijlstra 58251704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 58261704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 58271704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 58281704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 58291704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 58301704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5831000d1cc1SJoe Perches ERROR("LOCKDEP", 5832000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 58331704f47bSPeter Zijlstra } 58341704f47bSPeter Zijlstra } 583588f8831cSDave Jones 5836b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5837b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5838000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5839000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 584088f8831cSDave Jones } 58412435880fSJoe Perches 5842515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5843515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5844515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5845515a235eSJoe Perches $line =~ /$mode_perms_search/) { 58462435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 58472435880fSJoe Perches my $func = $entry->[0]; 58482435880fSJoe Perches my $arg_pos = $entry->[1]; 58492435880fSJoe Perches 58502435880fSJoe Perches my $skip_args = ""; 58512435880fSJoe Perches if ($arg_pos > 1) { 58522435880fSJoe Perches $arg_pos--; 58532435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 58542435880fSJoe Perches } 58552435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5856515a235eSJoe Perches if ($line =~ /$test/) { 58572435880fSJoe Perches my $val = $1; 58582435880fSJoe Perches $val = $6 if ($skip_args ne ""); 58592435880fSJoe Perches 58601727cc70SJoe Perches if ($val !~ /^0$/ && 58611727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 58621727cc70SJoe Perches length($val) ne 4)) { 58632435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 58641727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5865c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5866c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5867c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 58682435880fSJoe Perches } 58692435880fSJoe Perches } 58702435880fSJoe Perches } 587113214adfSAndy Whitcroft } 58725a6d20ceSBjorn Andersson 58735a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 58745a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 58755a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 58765a6d20ceSBjorn Andersson my $valid_licenses = qr{ 58775a6d20ceSBjorn Andersson GPL| 58785a6d20ceSBjorn Andersson GPL\ v2| 58795a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 58805a6d20ceSBjorn Andersson Dual\ BSD/GPL| 58815a6d20ceSBjorn Andersson Dual\ MIT/GPL| 58825a6d20ceSBjorn Andersson Dual\ MPL/GPL| 58835a6d20ceSBjorn Andersson Proprietary 58845a6d20ceSBjorn Andersson }x; 58855a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 58865a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 58875a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 58885a6d20ceSBjorn Andersson } 58895a6d20ceSBjorn Andersson } 5890515a235eSJoe Perches } 589113214adfSAndy Whitcroft 589213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 589313214adfSAndy Whitcroft # so just keep quiet. 589413214adfSAndy Whitcroft if ($#rawlines == -1) { 589513214adfSAndy Whitcroft exit(0); 58960a920b5bSAndy Whitcroft } 58970a920b5bSAndy Whitcroft 58988905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 58998905a67cSAndy Whitcroft # things that appear to be patches. 59008905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 59018905a67cSAndy Whitcroft exit(0); 59028905a67cSAndy Whitcroft } 59038905a67cSAndy Whitcroft 59048905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 59058905a67cSAndy Whitcroft # just keep quiet. 59068905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 59078905a67cSAndy Whitcroft exit(0); 59088905a67cSAndy Whitcroft } 59098905a67cSAndy Whitcroft 591006330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5911000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5912000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 59130a920b5bSAndy Whitcroft } 591434d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5915000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5916000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 59170a920b5bSAndy Whitcroft } 59180a920b5bSAndy Whitcroft 5919f0a594c1SAndy Whitcroft print report_dump(); 592013214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 592113214adfSAndy Whitcroft print "$filename " if ($summary_file); 59226c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 59236c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 59246c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 59256c72ffaaSAndy Whitcroft } 59268905a67cSAndy Whitcroft 5927d2c0a235SAndy Whitcroft if ($quiet == 0) { 5928d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5929d2c0a235SAndy Whitcroft # then suggest that. 5930d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5931b0781216SMike Frysinger $rpt_cleaners = 0; 5932d8469f16SJoe Perches print << "EOM" 5933d8469f16SJoe Perches 5934d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5935d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5936d8469f16SJoe PerchesEOM 5937d2c0a235SAndy Whitcroft } 5938d2c0a235SAndy Whitcroft } 5939d2c0a235SAndy Whitcroft 5940d752fcc8SJoe Perches if ($clean == 0 && $fix && 5941d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5942d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 59439624b8d6SJoe Perches my $newfile = $filename; 59449624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 59453705ce5bSJoe Perches my $linecount = 0; 59463705ce5bSJoe Perches my $f; 59473705ce5bSJoe Perches 5948d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5949d752fcc8SJoe Perches 59503705ce5bSJoe Perches open($f, '>', $newfile) 59513705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 59523705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 59533705ce5bSJoe Perches $linecount++; 59543705ce5bSJoe Perches if ($file) { 59553705ce5bSJoe Perches if ($linecount > 3) { 59563705ce5bSJoe Perches $fixed_line =~ s/^\+//; 59573705ce5bSJoe Perches print $f $fixed_line . "\n"; 59583705ce5bSJoe Perches } 59593705ce5bSJoe Perches } else { 59603705ce5bSJoe Perches print $f $fixed_line . "\n"; 59613705ce5bSJoe Perches } 59623705ce5bSJoe Perches } 59633705ce5bSJoe Perches close($f); 59643705ce5bSJoe Perches 59653705ce5bSJoe Perches if (!$quiet) { 59663705ce5bSJoe Perches print << "EOM"; 5967d8469f16SJoe Perches 59683705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 59693705ce5bSJoe Perches 59703705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 59713705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 59723705ce5bSJoe Perches 59733705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 59743705ce5bSJoe PerchesNo warranties, expressed or implied... 59753705ce5bSJoe PerchesEOM 59763705ce5bSJoe Perches } 59773705ce5bSJoe Perches } 59783705ce5bSJoe Perches 5979d8469f16SJoe Perches if ($quiet == 0) { 5980d8469f16SJoe Perches print "\n"; 5981d8469f16SJoe Perches if ($clean == 1) { 5982d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5983d8469f16SJoe Perches } else { 5984d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 59850a920b5bSAndy Whitcroft } 59860a920b5bSAndy Whitcroft } 59870a920b5bSAndy Whitcroft return $clean; 59880a920b5bSAndy Whitcroft} 5989