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); 436485ff23eSAlex Dowadour @typeListFile = (); 4378716de38SJoe Perchesour @typeListWithAttr = ( 4388716de38SJoe Perches @typeList, 4398716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4408716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4418716de38SJoe Perches); 4428716de38SJoe Perches 443c45dcabdSAndy Whitcroftour @modifierList = ( 444c45dcabdSAndy Whitcroft qr{fastcall}, 445c45dcabdSAndy Whitcroft); 446485ff23eSAlex Dowadour @modifierListFile = (); 4478905a67cSAndy Whitcroft 4482435880fSJoe Perchesour @mode_permission_funcs = ( 4492435880fSJoe Perches ["module_param", 3], 4502435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4512435880fSJoe Perches ["module_param_array_named", 5], 4522435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4532435880fSJoe Perches ["proc_create(?:_data|)", 2], 4542435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4552435880fSJoe Perches); 4562435880fSJoe Perches 457515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 458515a235eSJoe Perchesour $mode_perms_search = ""; 459515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 460515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 461515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 462515a235eSJoe Perches} 463515a235eSJoe Perches 464b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 465b392c64fSJoe Perches S_IWUGO | 466b392c64fSJoe Perches S_IWOTH | 467b392c64fSJoe Perches S_IRWXUGO | 468b392c64fSJoe Perches S_IALLUGO | 469b392c64fSJoe Perches 0[0-7][0-7][2367] 470b392c64fSJoe Perches}x; 471b392c64fSJoe Perches 4727840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4737840a94cSWolfram Sang irq| 474cdcee686SSergey Ryazanov memory| 475cdcee686SSergey Ryazanov time| 476cdcee686SSergey Ryazanov reboot 4777840a94cSWolfram Sang)}; 4787840a94cSWolfram Sang# memory.h: ARM has a custom one 4797840a94cSWolfram Sang 48066b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 48166b47b4aSKees Cookmy $misspellings; 48266b47b4aSKees Cookmy %spelling_fix; 48336061e38SJoe Perches 48436061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 48566b47b4aSKees Cook while (<$spelling>) { 48666b47b4aSKees Cook my $line = $_; 48766b47b4aSKees Cook 48866b47b4aSKees Cook $line =~ s/\s*\n?$//g; 48966b47b4aSKees Cook $line =~ s/^\s*//g; 49066b47b4aSKees Cook 49166b47b4aSKees Cook next if ($line =~ m/^\s*#/); 49266b47b4aSKees Cook next if ($line =~ m/^\s*$/); 49366b47b4aSKees Cook 49466b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 49566b47b4aSKees Cook 49666b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 49766b47b4aSKees Cook } 49866b47b4aSKees Cook close($spelling); 49936061e38SJoe Perches} else { 50036061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 50136061e38SJoe Perches} 50266b47b4aSKees Cook 503ebfd7d62SJoe Perchesif ($codespell) { 504ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 505ebfd7d62SJoe Perches while (<$spelling>) { 506ebfd7d62SJoe Perches my $line = $_; 507ebfd7d62SJoe Perches 508ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 509ebfd7d62SJoe Perches $line =~ s/^\s*//g; 510ebfd7d62SJoe Perches 511ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 512ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 513ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 514ebfd7d62SJoe Perches 515ebfd7d62SJoe Perches $line =~ s/,.*$//; 516ebfd7d62SJoe Perches 517ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 518ebfd7d62SJoe Perches 519ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 520ebfd7d62SJoe Perches } 521ebfd7d62SJoe Perches close($spelling); 522ebfd7d62SJoe Perches } else { 523ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 524ebfd7d62SJoe Perches } 525ebfd7d62SJoe Perches} 526ebfd7d62SJoe Perches 527ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 528ebfd7d62SJoe Perches 5298905a67cSAndy Whitcroftsub build_types { 530485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 531485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 5321813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5338716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 534c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 535ab7e23f3SJoe Perches $BasicType = qr{ 536ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 537ab7e23f3SJoe Perches (?:${all}\b) 538ab7e23f3SJoe Perches }x; 5398905a67cSAndy Whitcroft $NonptrType = qr{ 540d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 541cf655043SAndy Whitcroft (?: 5426b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 5438ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 544c45dcabdSAndy Whitcroft (?:${all}\b) 545cf655043SAndy Whitcroft ) 546c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5478905a67cSAndy Whitcroft }x; 5481813087dSJoe Perches $NonptrTypeMisordered = qr{ 5491813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5501813087dSJoe Perches (?: 5511813087dSJoe Perches (?:${Misordered}\b) 5521813087dSJoe Perches ) 5531813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5541813087dSJoe Perches }x; 5558716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5568716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5578716de38SJoe Perches (?: 5588716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5598716de38SJoe Perches (?:$typeTypedefs\b)| 5608716de38SJoe Perches (?:${allWithAttr}\b) 5618716de38SJoe Perches ) 5628716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5638716de38SJoe Perches }x; 5648905a67cSAndy Whitcroft $Type = qr{ 565c45dcabdSAndy Whitcroft $NonptrType 5661574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 567c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5688905a67cSAndy Whitcroft }x; 5691813087dSJoe Perches $TypeMisordered = qr{ 5701813087dSJoe Perches $NonptrTypeMisordered 5711813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5721813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5731813087dSJoe Perches }x; 57491cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5751813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5768905a67cSAndy Whitcroft} 5778905a67cSAndy Whitcroftbuild_types(); 5786c72ffaaSAndy Whitcroft 5797d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 580d1fe9c09SJoe Perches 581d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 582d1fe9c09SJoe Perches# requires at least perl version v5.10.0 583d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 584d1fe9c09SJoe Perches 585d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5862435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 587c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 5887d2367afSJoe Perches 589f8422308SJoe Perchesour $declaration_macros = qr{(?x: 5903e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 591f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 592f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 593f8422308SJoe Perches)}; 594f8422308SJoe Perches 5957d2367afSJoe Perchessub deparenthesize { 5967d2367afSJoe Perches my ($string) = @_; 5977d2367afSJoe Perches return "" if (!defined($string)); 5985b9553abSJoe Perches 5995b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 6005b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 6015b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 6025b9553abSJoe Perches } 6035b9553abSJoe Perches 6047d2367afSJoe Perches $string =~ s@\s+@ @g; 6055b9553abSJoe Perches 6067d2367afSJoe Perches return $string; 6077d2367afSJoe Perches} 6087d2367afSJoe Perches 6093445686aSJoe Perchessub seed_camelcase_file { 6103445686aSJoe Perches my ($file) = @_; 6113445686aSJoe Perches 6123445686aSJoe Perches return if (!(-f $file)); 6133445686aSJoe Perches 6143445686aSJoe Perches local $/; 6153445686aSJoe Perches 6163445686aSJoe Perches open(my $include_file, '<', "$file") 6173445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6183445686aSJoe Perches my $text = <$include_file>; 6193445686aSJoe Perches close($include_file); 6203445686aSJoe Perches 6213445686aSJoe Perches my @lines = split('\n', $text); 6223445686aSJoe Perches 6233445686aSJoe Perches foreach my $line (@lines) { 6243445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6253445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6263445686aSJoe Perches $camelcase{$1} = 1; 62711ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 62811ea516aSJoe Perches $camelcase{$1} = 1; 62911ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6303445686aSJoe Perches $camelcase{$1} = 1; 6313445686aSJoe Perches } 6323445686aSJoe Perches } 6333445686aSJoe Perches} 6343445686aSJoe Perches 6353445686aSJoe Perchesmy $camelcase_seeded = 0; 6363445686aSJoe Perchessub seed_camelcase_includes { 6373445686aSJoe Perches return if ($camelcase_seeded); 6383445686aSJoe Perches 6393445686aSJoe Perches my $files; 640c707a81dSJoe Perches my $camelcase_cache = ""; 641c707a81dSJoe Perches my @include_files = (); 642c707a81dSJoe Perches 643c707a81dSJoe Perches $camelcase_seeded = 1; 644351b2a1fSJoe Perches 6453645e328SRichard Genoud if (-e ".git") { 646351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 647351b2a1fSJoe Perches chomp $git_last_include_commit; 648c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 649c707a81dSJoe Perches } else { 650c707a81dSJoe Perches my $last_mod_date = 0; 651c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 652c707a81dSJoe Perches @include_files = split('\n', $files); 653c707a81dSJoe Perches foreach my $file (@include_files) { 654c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 655c707a81dSJoe Perches localtime((stat $file)[9])); 656c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 657c707a81dSJoe Perches } 658c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 659c707a81dSJoe Perches } 660c707a81dSJoe Perches 661c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 662c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 663c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 664351b2a1fSJoe Perches while (<$camelcase_file>) { 665351b2a1fSJoe Perches chomp; 666351b2a1fSJoe Perches $camelcase{$_} = 1; 667351b2a1fSJoe Perches } 668351b2a1fSJoe Perches close($camelcase_file); 669351b2a1fSJoe Perches 670351b2a1fSJoe Perches return; 671351b2a1fSJoe Perches } 672c707a81dSJoe Perches 6733645e328SRichard Genoud if (-e ".git") { 674c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 675c707a81dSJoe Perches @include_files = split('\n', $files); 6763445686aSJoe Perches } 677c707a81dSJoe Perches 6783445686aSJoe Perches foreach my $file (@include_files) { 6793445686aSJoe Perches seed_camelcase_file($file); 6803445686aSJoe Perches } 681351b2a1fSJoe Perches 682c707a81dSJoe Perches if ($camelcase_cache ne "") { 683351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 684c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 685c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 686351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 687351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 688351b2a1fSJoe Perches } 689351b2a1fSJoe Perches close($camelcase_file); 690351b2a1fSJoe Perches } 6913445686aSJoe Perches} 6923445686aSJoe Perches 693d311cd44SJoe Perchessub git_commit_info { 694d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 695d311cd44SJoe Perches 696d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 697d311cd44SJoe Perches 698d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 699d311cd44SJoe Perches $output =~ s/^\s*//gm; 700d311cd44SJoe Perches my @lines = split("\n", $output); 701d311cd44SJoe Perches 7020d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 7030d7835fcSJoe Perches 704d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 705d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 706d311cd44SJoe Perches# all matching commit ids, but it's very slow... 707d311cd44SJoe Perches# 708d311cd44SJoe Perches# echo "checking commits $1..." 709d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 710d311cd44SJoe Perches# while read line ; do 711d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 712d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 713d311cd44SJoe Perches# done 714d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 715d311cd44SJoe Perches } else { 716d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 717d311cd44SJoe Perches $desc = substr($lines[0], 41); 718d311cd44SJoe Perches } 719d311cd44SJoe Perches 720d311cd44SJoe Perches return ($id, $desc); 721d311cd44SJoe Perches} 722d311cd44SJoe Perches 7236c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7240a920b5bSAndy Whitcroft 72500df344fSAndy Whitcroftmy @rawlines = (); 726c2fdda0dSAndy Whitcroftmy @lines = (); 7273705ce5bSJoe Perchesmy @fixed = (); 728d752fcc8SJoe Perchesmy @fixed_inserted = (); 729d752fcc8SJoe Perchesmy @fixed_deleted = (); 730194f66fcSJoe Perchesmy $fixlinenr = -1; 731194f66fcSJoe Perches 732c2fdda0dSAndy Whitcroftmy $vname; 7336c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 73421caa13cSAndy Whitcroft my $FILE; 7356c72ffaaSAndy Whitcroft if ($file) { 73621caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7376c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 73821caa13cSAndy Whitcroft } elsif ($filename eq '-') { 73921caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7406c72ffaaSAndy Whitcroft } else { 74121caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7426c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7436c72ffaaSAndy Whitcroft } 744c2fdda0dSAndy Whitcroft if ($filename eq '-') { 745c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 746c2fdda0dSAndy Whitcroft } else { 747c2fdda0dSAndy Whitcroft $vname = $filename; 748c2fdda0dSAndy Whitcroft } 74921caa13cSAndy Whitcroft while (<$FILE>) { 7500a920b5bSAndy Whitcroft chomp; 75100df344fSAndy Whitcroft push(@rawlines, $_); 7526c72ffaaSAndy Whitcroft } 75321caa13cSAndy Whitcroft close($FILE); 754d8469f16SJoe Perches 755d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 756d8469f16SJoe Perches print '-' x length($vname) . "\n"; 757d8469f16SJoe Perches print "$vname\n"; 758d8469f16SJoe Perches print '-' x length($vname) . "\n"; 759d8469f16SJoe Perches } 760d8469f16SJoe Perches 761c2fdda0dSAndy Whitcroft if (!process($filename)) { 7620a920b5bSAndy Whitcroft $exit = 1; 7630a920b5bSAndy Whitcroft } 76400df344fSAndy Whitcroft @rawlines = (); 76513214adfSAndy Whitcroft @lines = (); 7663705ce5bSJoe Perches @fixed = (); 767d752fcc8SJoe Perches @fixed_inserted = (); 768d752fcc8SJoe Perches @fixed_deleted = (); 769194f66fcSJoe Perches $fixlinenr = -1; 770485ff23eSAlex Dowad @modifierListFile = (); 771485ff23eSAlex Dowad @typeListFile = (); 772485ff23eSAlex Dowad build_types(); 7730a920b5bSAndy Whitcroft} 7740a920b5bSAndy Whitcroft 775d8469f16SJoe Perchesif (!$quiet) { 7763c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 7773c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 7783c816e49SJoe Perches 779d8469f16SJoe Perches if ($^V lt 5.10.0) { 780d8469f16SJoe Perches print << "EOM" 781d8469f16SJoe Perches 782d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 783d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 784d8469f16SJoe PerchesEOM 785d8469f16SJoe Perches } 786d8469f16SJoe Perches if ($exit) { 787d8469f16SJoe Perches print << "EOM" 788d8469f16SJoe Perches 789d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 790d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 791d8469f16SJoe PerchesEOM 792d8469f16SJoe Perches } 793d8469f16SJoe Perches} 794d8469f16SJoe Perches 7950a920b5bSAndy Whitcroftexit($exit); 7960a920b5bSAndy Whitcroft 7970a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7986c72ffaaSAndy Whitcroft my ($root) = @_; 7996c72ffaaSAndy Whitcroft 8006c72ffaaSAndy Whitcroft my @tree_check = ( 8016c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 8026c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 8036c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 8046c72ffaaSAndy Whitcroft ); 8056c72ffaaSAndy Whitcroft 8066c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 8076c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 8080a920b5bSAndy Whitcroft return 0; 8090a920b5bSAndy Whitcroft } 8106c72ffaaSAndy Whitcroft } 8116c72ffaaSAndy Whitcroft return 1; 8126c72ffaaSAndy Whitcroft} 8130a920b5bSAndy Whitcroft 81420112475SJoe Perchessub parse_email { 81520112475SJoe Perches my ($formatted_email) = @_; 81620112475SJoe Perches 81720112475SJoe Perches my $name = ""; 81820112475SJoe Perches my $address = ""; 81920112475SJoe Perches my $comment = ""; 82020112475SJoe Perches 82120112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 82220112475SJoe Perches $name = $1; 82320112475SJoe Perches $address = $2; 82420112475SJoe Perches $comment = $3 if defined $3; 82520112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 82620112475SJoe Perches $address = $1; 82720112475SJoe Perches $comment = $2 if defined $2; 82820112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 82920112475SJoe Perches $address = $1; 83020112475SJoe Perches $comment = $2 if defined $2; 83120112475SJoe Perches $formatted_email =~ s/$address.*$//; 83220112475SJoe Perches $name = $formatted_email; 8333705ce5bSJoe Perches $name = trim($name); 83420112475SJoe Perches $name =~ s/^\"|\"$//g; 83520112475SJoe Perches # If there's a name left after stripping spaces and 83620112475SJoe Perches # leading quotes, and the address doesn't have both 83720112475SJoe Perches # leading and trailing angle brackets, the address 83820112475SJoe Perches # is invalid. ie: 83920112475SJoe Perches # "joe smith [email protected]" bad 84020112475SJoe Perches # "joe smith <[email protected]" bad 84120112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 84220112475SJoe Perches $name = ""; 84320112475SJoe Perches $address = ""; 84420112475SJoe Perches $comment = ""; 84520112475SJoe Perches } 84620112475SJoe Perches } 84720112475SJoe Perches 8483705ce5bSJoe Perches $name = trim($name); 84920112475SJoe Perches $name =~ s/^\"|\"$//g; 8503705ce5bSJoe Perches $address = trim($address); 85120112475SJoe Perches $address =~ s/^\<|\>$//g; 85220112475SJoe Perches 85320112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 85420112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 85520112475SJoe Perches $name = "\"$name\""; 85620112475SJoe Perches } 85720112475SJoe Perches 85820112475SJoe Perches return ($name, $address, $comment); 85920112475SJoe Perches} 86020112475SJoe Perches 86120112475SJoe Perchessub format_email { 86220112475SJoe Perches my ($name, $address) = @_; 86320112475SJoe Perches 86420112475SJoe Perches my $formatted_email; 86520112475SJoe Perches 8663705ce5bSJoe Perches $name = trim($name); 86720112475SJoe Perches $name =~ s/^\"|\"$//g; 8683705ce5bSJoe Perches $address = trim($address); 86920112475SJoe Perches 87020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 87120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 87220112475SJoe Perches $name = "\"$name\""; 87320112475SJoe Perches } 87420112475SJoe Perches 87520112475SJoe Perches if ("$name" eq "") { 87620112475SJoe Perches $formatted_email = "$address"; 87720112475SJoe Perches } else { 87820112475SJoe Perches $formatted_email = "$name <$address>"; 87920112475SJoe Perches } 88020112475SJoe Perches 88120112475SJoe Perches return $formatted_email; 88220112475SJoe Perches} 88320112475SJoe Perches 884d311cd44SJoe Perchessub which { 885d311cd44SJoe Perches my ($bin) = @_; 886d311cd44SJoe Perches 887d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 888d311cd44SJoe Perches if (-e "$path/$bin") { 889d311cd44SJoe Perches return "$path/$bin"; 890d311cd44SJoe Perches } 891d311cd44SJoe Perches } 892d311cd44SJoe Perches 893d311cd44SJoe Perches return ""; 894d311cd44SJoe Perches} 895d311cd44SJoe Perches 896000d1cc1SJoe Perchessub which_conf { 897000d1cc1SJoe Perches my ($conf) = @_; 898000d1cc1SJoe Perches 899000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 900000d1cc1SJoe Perches if (-e "$path/$conf") { 901000d1cc1SJoe Perches return "$path/$conf"; 902000d1cc1SJoe Perches } 903000d1cc1SJoe Perches } 904000d1cc1SJoe Perches 905000d1cc1SJoe Perches return ""; 906000d1cc1SJoe Perches} 907000d1cc1SJoe Perches 9080a920b5bSAndy Whitcroftsub expand_tabs { 9090a920b5bSAndy Whitcroft my ($str) = @_; 9100a920b5bSAndy Whitcroft 9110a920b5bSAndy Whitcroft my $res = ''; 9120a920b5bSAndy Whitcroft my $n = 0; 9130a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 9140a920b5bSAndy Whitcroft if ($c eq "\t") { 9150a920b5bSAndy Whitcroft $res .= ' '; 9160a920b5bSAndy Whitcroft $n++; 9170a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 9180a920b5bSAndy Whitcroft $res .= ' '; 9190a920b5bSAndy Whitcroft } 9200a920b5bSAndy Whitcroft next; 9210a920b5bSAndy Whitcroft } 9220a920b5bSAndy Whitcroft $res .= $c; 9230a920b5bSAndy Whitcroft $n++; 9240a920b5bSAndy Whitcroft } 9250a920b5bSAndy Whitcroft 9260a920b5bSAndy Whitcroft return $res; 9270a920b5bSAndy Whitcroft} 9286c72ffaaSAndy Whitcroftsub copy_spacing { 929773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 9306c72ffaaSAndy Whitcroft return $res; 9316c72ffaaSAndy Whitcroft} 9320a920b5bSAndy Whitcroft 9334a0df2efSAndy Whitcroftsub line_stats { 9344a0df2efSAndy Whitcroft my ($line) = @_; 9354a0df2efSAndy Whitcroft 9364a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 9374a0df2efSAndy Whitcroft $line =~ s/^.//; 9384a0df2efSAndy Whitcroft $line = expand_tabs($line); 9394a0df2efSAndy Whitcroft 9404a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 9414a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9424a0df2efSAndy Whitcroft 9434a0df2efSAndy Whitcroft return (length($line), length($white)); 9444a0df2efSAndy Whitcroft} 9454a0df2efSAndy Whitcroft 946773647a0SAndy Whitcroftmy $sanitise_quote = ''; 947773647a0SAndy Whitcroft 948773647a0SAndy Whitcroftsub sanitise_line_reset { 949773647a0SAndy Whitcroft my ($in_comment) = @_; 950773647a0SAndy Whitcroft 951773647a0SAndy Whitcroft if ($in_comment) { 952773647a0SAndy Whitcroft $sanitise_quote = '*/'; 953773647a0SAndy Whitcroft } else { 954773647a0SAndy Whitcroft $sanitise_quote = ''; 955773647a0SAndy Whitcroft } 956773647a0SAndy Whitcroft} 95700df344fSAndy Whitcroftsub sanitise_line { 95800df344fSAndy Whitcroft my ($line) = @_; 95900df344fSAndy Whitcroft 96000df344fSAndy Whitcroft my $res = ''; 96100df344fSAndy Whitcroft my $l = ''; 96200df344fSAndy Whitcroft 963c2fdda0dSAndy Whitcroft my $qlen = 0; 964773647a0SAndy Whitcroft my $off = 0; 965773647a0SAndy Whitcroft my $c; 96600df344fSAndy Whitcroft 967773647a0SAndy Whitcroft # Always copy over the diff marker. 968773647a0SAndy Whitcroft $res = substr($line, 0, 1); 969773647a0SAndy Whitcroft 970773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 971773647a0SAndy Whitcroft $c = substr($line, $off, 1); 972773647a0SAndy Whitcroft 973773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 974773647a0SAndy Whitcroft # and end, all to $;. 975773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 976773647a0SAndy Whitcroft $sanitise_quote = '*/'; 977773647a0SAndy Whitcroft 978773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 979773647a0SAndy Whitcroft $off++; 98000df344fSAndy Whitcroft next; 981773647a0SAndy Whitcroft } 98281bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 983773647a0SAndy Whitcroft $sanitise_quote = ''; 984773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 985773647a0SAndy Whitcroft $off++; 986773647a0SAndy Whitcroft next; 987773647a0SAndy Whitcroft } 988113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 989113f04a8SDaniel Walker $sanitise_quote = '//'; 990113f04a8SDaniel Walker 991113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 992113f04a8SDaniel Walker $off++; 993113f04a8SDaniel Walker next; 994113f04a8SDaniel Walker } 995773647a0SAndy Whitcroft 996773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 997773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 998773647a0SAndy Whitcroft $c eq "\\") { 999773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 1000773647a0SAndy Whitcroft $off++; 1001773647a0SAndy Whitcroft next; 1002773647a0SAndy Whitcroft } 1003773647a0SAndy Whitcroft # Regular quotes. 1004773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1005773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1006773647a0SAndy Whitcroft $sanitise_quote = $c; 1007773647a0SAndy Whitcroft 1008773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1009773647a0SAndy Whitcroft next; 1010773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1011773647a0SAndy Whitcroft $sanitise_quote = ''; 101200df344fSAndy Whitcroft } 101300df344fSAndy Whitcroft } 1014773647a0SAndy Whitcroft 1015fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1016773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1017773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1018113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1019113f04a8SDaniel Walker substr($res, $off, 1, $;); 1020773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1021773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 102200df344fSAndy Whitcroft } else { 1023773647a0SAndy Whitcroft substr($res, $off, 1, $c); 102400df344fSAndy Whitcroft } 1025c2fdda0dSAndy Whitcroft } 1026c2fdda0dSAndy Whitcroft 1027113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1028113f04a8SDaniel Walker $sanitise_quote = ''; 1029113f04a8SDaniel Walker } 1030113f04a8SDaniel Walker 1031c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1032c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1033c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1034c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1035c2fdda0dSAndy Whitcroft 1036c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1037c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1038c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1039c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1040c2fdda0dSAndy Whitcroft } 1041c2fdda0dSAndy Whitcroft 104200df344fSAndy Whitcroft return $res; 104300df344fSAndy Whitcroft} 104400df344fSAndy Whitcroft 1045a6962d72SJoe Perchessub get_quoted_string { 1046a6962d72SJoe Perches my ($line, $rawline) = @_; 1047a6962d72SJoe Perches 104833acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1049a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1050a6962d72SJoe Perches} 1051a6962d72SJoe Perches 10528905a67cSAndy Whitcroftsub ctx_statement_block { 10538905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10548905a67cSAndy Whitcroft my $line = $linenr - 1; 10558905a67cSAndy Whitcroft my $blk = ''; 10568905a67cSAndy Whitcroft my $soff = $off; 10578905a67cSAndy Whitcroft my $coff = $off - 1; 1058773647a0SAndy Whitcroft my $coff_set = 0; 10598905a67cSAndy Whitcroft 106013214adfSAndy Whitcroft my $loff = 0; 106113214adfSAndy Whitcroft 10628905a67cSAndy Whitcroft my $type = ''; 10638905a67cSAndy Whitcroft my $level = 0; 1064a2750645SAndy Whitcroft my @stack = (); 1065cf655043SAndy Whitcroft my $p; 10668905a67cSAndy Whitcroft my $c; 10678905a67cSAndy Whitcroft my $len = 0; 106813214adfSAndy Whitcroft 106913214adfSAndy Whitcroft my $remainder; 10708905a67cSAndy Whitcroft while (1) { 1071a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1072a2750645SAndy Whitcroft 1073773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10748905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10758905a67cSAndy Whitcroft # context. 10768905a67cSAndy Whitcroft if ($off >= $len) { 10778905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1078dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1079c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10808905a67cSAndy Whitcroft $remain--; 108113214adfSAndy Whitcroft $loff = $len; 1082c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10838905a67cSAndy Whitcroft $len = length($blk); 10848905a67cSAndy Whitcroft $line++; 10858905a67cSAndy Whitcroft last; 10868905a67cSAndy Whitcroft } 10878905a67cSAndy Whitcroft # Bail if there is no further context. 10888905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 108913214adfSAndy Whitcroft if ($off >= $len) { 10908905a67cSAndy Whitcroft last; 10918905a67cSAndy Whitcroft } 1092f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1093f74bd194SAndy Whitcroft $level++; 1094f74bd194SAndy Whitcroft $type = '#'; 1095f74bd194SAndy Whitcroft } 10968905a67cSAndy Whitcroft } 1097cf655043SAndy Whitcroft $p = $c; 10988905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 109913214adfSAndy Whitcroft $remainder = substr($blk, $off); 11008905a67cSAndy Whitcroft 1101773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 11024635f4fbSAndy Whitcroft 11034635f4fbSAndy Whitcroft # Handle nested #if/#else. 11044635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 11054635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 11064635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 11074635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 11084635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 11094635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 11104635f4fbSAndy Whitcroft } 11114635f4fbSAndy Whitcroft 11128905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 11138905a67cSAndy Whitcroft # outermost level. 11148905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 11158905a67cSAndy Whitcroft last; 11168905a67cSAndy Whitcroft } 11178905a67cSAndy Whitcroft 111813214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1119773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1120773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1121773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1122773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1123773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1124773647a0SAndy Whitcroft $coff_set = 1; 1125773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1126773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 112713214adfSAndy Whitcroft } 112813214adfSAndy Whitcroft 11298905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 11308905a67cSAndy Whitcroft $level++; 11318905a67cSAndy Whitcroft $type = '('; 11328905a67cSAndy Whitcroft } 11338905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 11348905a67cSAndy Whitcroft $level--; 11358905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 11368905a67cSAndy Whitcroft 11378905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 11388905a67cSAndy Whitcroft $coff = $off; 1139773647a0SAndy Whitcroft $coff_set = 1; 1140773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 11418905a67cSAndy Whitcroft } 11428905a67cSAndy Whitcroft } 11438905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11448905a67cSAndy Whitcroft $level++; 11458905a67cSAndy Whitcroft $type = '{'; 11468905a67cSAndy Whitcroft } 11478905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11488905a67cSAndy Whitcroft $level--; 11498905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11508905a67cSAndy Whitcroft 11518905a67cSAndy Whitcroft if ($level == 0) { 1152b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1153b998e001SPatrick Pannuto $off++; 1154b998e001SPatrick Pannuto } 11558905a67cSAndy Whitcroft last; 11568905a67cSAndy Whitcroft } 11578905a67cSAndy Whitcroft } 1158f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1159f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1160f74bd194SAndy Whitcroft $level--; 1161f74bd194SAndy Whitcroft $type = ''; 1162f74bd194SAndy Whitcroft $off++; 1163f74bd194SAndy Whitcroft last; 1164f74bd194SAndy Whitcroft } 11658905a67cSAndy Whitcroft $off++; 11668905a67cSAndy Whitcroft } 1167a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 116813214adfSAndy Whitcroft if ($off == $len) { 1169a3bb97a7SAndy Whitcroft $loff = $len + 1; 117013214adfSAndy Whitcroft $line++; 117113214adfSAndy Whitcroft $remain--; 117213214adfSAndy Whitcroft } 11738905a67cSAndy Whitcroft 11748905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11758905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11768905a67cSAndy Whitcroft 11778905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11788905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11798905a67cSAndy Whitcroft 1180773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 118113214adfSAndy Whitcroft 118213214adfSAndy Whitcroft return ($statement, $condition, 118313214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 118413214adfSAndy Whitcroft} 118513214adfSAndy Whitcroft 1186cf655043SAndy Whitcroftsub statement_lines { 1187cf655043SAndy Whitcroft my ($stmt) = @_; 1188cf655043SAndy Whitcroft 1189cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1190cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1191cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1192cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1193cf655043SAndy Whitcroft 1194cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1195cf655043SAndy Whitcroft 1196cf655043SAndy Whitcroft return $#stmt_lines + 2; 1197cf655043SAndy Whitcroft} 1198cf655043SAndy Whitcroft 1199cf655043SAndy Whitcroftsub statement_rawlines { 1200cf655043SAndy Whitcroft my ($stmt) = @_; 1201cf655043SAndy Whitcroft 1202cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1203cf655043SAndy Whitcroft 1204cf655043SAndy Whitcroft return $#stmt_lines + 2; 1205cf655043SAndy Whitcroft} 1206cf655043SAndy Whitcroft 1207cf655043SAndy Whitcroftsub statement_block_size { 1208cf655043SAndy Whitcroft my ($stmt) = @_; 1209cf655043SAndy Whitcroft 1210cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1211cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1212cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1213cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1214cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1215cf655043SAndy Whitcroft 1216cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1217cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1218cf655043SAndy Whitcroft 1219cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1220cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1221cf655043SAndy Whitcroft 1222cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1223cf655043SAndy Whitcroft return $stmt_lines; 1224cf655043SAndy Whitcroft } else { 1225cf655043SAndy Whitcroft return $stmt_statements; 1226cf655043SAndy Whitcroft } 1227cf655043SAndy Whitcroft} 1228cf655043SAndy Whitcroft 122913214adfSAndy Whitcroftsub ctx_statement_full { 123013214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 123113214adfSAndy Whitcroft my ($statement, $condition, $level); 123213214adfSAndy Whitcroft 123313214adfSAndy Whitcroft my (@chunks); 123413214adfSAndy Whitcroft 1235cf655043SAndy Whitcroft # Grab the first conditional/block pair. 123613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 123713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1238773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 123913214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1240cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1241cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1242cf655043SAndy Whitcroft } 1243cf655043SAndy Whitcroft 1244cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1245cf655043SAndy Whitcroft # could continue the statement. 1246cf655043SAndy Whitcroft for (;;) { 124713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 124813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1249cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1250773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1251cf655043SAndy Whitcroft #print "C: push\n"; 1252cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 125313214adfSAndy Whitcroft } 125413214adfSAndy Whitcroft 125513214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12568905a67cSAndy Whitcroft} 12578905a67cSAndy Whitcroft 12584a0df2efSAndy Whitcroftsub ctx_block_get { 1259f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12604a0df2efSAndy Whitcroft my $line; 12614a0df2efSAndy Whitcroft my $start = $linenr - 1; 12624a0df2efSAndy Whitcroft my $blk = ''; 12634a0df2efSAndy Whitcroft my @o; 12644a0df2efSAndy Whitcroft my @c; 12654a0df2efSAndy Whitcroft my @res = (); 12664a0df2efSAndy Whitcroft 1267f0a594c1SAndy Whitcroft my $level = 0; 12684635f4fbSAndy Whitcroft my @stack = ($level); 126900df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 127000df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 127100df344fSAndy Whitcroft $remain--; 127200df344fSAndy Whitcroft 127300df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12744635f4fbSAndy Whitcroft 12754635f4fbSAndy Whitcroft # Handle nested #if/#else. 127601464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12774635f4fbSAndy Whitcroft push(@stack, $level); 127801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12794635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 128001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12814635f4fbSAndy Whitcroft $level = pop(@stack); 12824635f4fbSAndy Whitcroft } 12834635f4fbSAndy Whitcroft 128401464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1285f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1286f0a594c1SAndy Whitcroft if ($off > 0) { 1287f0a594c1SAndy Whitcroft $off--; 1288f0a594c1SAndy Whitcroft next; 1289f0a594c1SAndy Whitcroft } 12904a0df2efSAndy Whitcroft 1291f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1292f0a594c1SAndy Whitcroft $level--; 1293f0a594c1SAndy Whitcroft last if ($level == 0); 1294f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1295f0a594c1SAndy Whitcroft $level++; 1296f0a594c1SAndy Whitcroft } 1297f0a594c1SAndy Whitcroft } 12984a0df2efSAndy Whitcroft 1299f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 130000df344fSAndy Whitcroft push(@res, $rawlines[$line]); 13014a0df2efSAndy Whitcroft } 13024a0df2efSAndy Whitcroft 1303f0a594c1SAndy Whitcroft last if ($level == 0); 13044a0df2efSAndy Whitcroft } 13054a0df2efSAndy Whitcroft 1306f0a594c1SAndy Whitcroft return ($level, @res); 13074a0df2efSAndy Whitcroft} 13084a0df2efSAndy Whitcroftsub ctx_block_outer { 13094a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13104a0df2efSAndy Whitcroft 1311f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1312f0a594c1SAndy Whitcroft return @r; 13134a0df2efSAndy Whitcroft} 13144a0df2efSAndy Whitcroftsub ctx_block { 13154a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13164a0df2efSAndy Whitcroft 1317f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1318f0a594c1SAndy Whitcroft return @r; 1319653d4876SAndy Whitcroft} 1320653d4876SAndy Whitcroftsub ctx_statement { 1321f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1322f0a594c1SAndy Whitcroft 1323f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1324f0a594c1SAndy Whitcroft return @r; 1325f0a594c1SAndy Whitcroft} 1326f0a594c1SAndy Whitcroftsub ctx_block_level { 1327653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1328653d4876SAndy Whitcroft 1329f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 13304a0df2efSAndy Whitcroft} 13319c0ca6f9SAndy Whitcroftsub ctx_statement_level { 13329c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 13339c0ca6f9SAndy Whitcroft 13349c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 13359c0ca6f9SAndy Whitcroft} 13364a0df2efSAndy Whitcroft 13374a0df2efSAndy Whitcroftsub ctx_locate_comment { 13384a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13394a0df2efSAndy Whitcroft 13404a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1341beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13424a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13434a0df2efSAndy Whitcroft 13444a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13454a0df2efSAndy Whitcroft # comment. 13464a0df2efSAndy Whitcroft my $in_comment = 0; 13474a0df2efSAndy Whitcroft $current_comment = ''; 13484a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 134900df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 135000df344fSAndy Whitcroft #warn " $line\n"; 13514a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13524a0df2efSAndy Whitcroft $in_comment = 1; 13534a0df2efSAndy Whitcroft } 13544a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13554a0df2efSAndy Whitcroft $in_comment = 1; 13564a0df2efSAndy Whitcroft } 13574a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13584a0df2efSAndy Whitcroft $current_comment = ''; 13594a0df2efSAndy Whitcroft } 13604a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13614a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13624a0df2efSAndy Whitcroft $in_comment = 0; 13634a0df2efSAndy Whitcroft } 13644a0df2efSAndy Whitcroft } 13654a0df2efSAndy Whitcroft 13664a0df2efSAndy Whitcroft chomp($current_comment); 13674a0df2efSAndy Whitcroft return($current_comment); 13684a0df2efSAndy Whitcroft} 13694a0df2efSAndy Whitcroftsub ctx_has_comment { 13704a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13714a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13724a0df2efSAndy Whitcroft 137300df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13744a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13754a0df2efSAndy Whitcroft 13764a0df2efSAndy Whitcroft return ($cmt ne ''); 13774a0df2efSAndy Whitcroft} 13784a0df2efSAndy Whitcroft 13794d001e4dSAndy Whitcroftsub raw_line { 13804d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13814d001e4dSAndy Whitcroft 13824d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13834d001e4dSAndy Whitcroft $cnt++; 13844d001e4dSAndy Whitcroft 13854d001e4dSAndy Whitcroft my $line; 13864d001e4dSAndy Whitcroft while ($cnt) { 13874d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13884d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13894d001e4dSAndy Whitcroft $cnt--; 13904d001e4dSAndy Whitcroft } 13914d001e4dSAndy Whitcroft 13924d001e4dSAndy Whitcroft return $line; 13934d001e4dSAndy Whitcroft} 13944d001e4dSAndy Whitcroft 13950a920b5bSAndy Whitcroftsub cat_vet { 13960a920b5bSAndy Whitcroft my ($vet) = @_; 13979c0ca6f9SAndy Whitcroft my ($res, $coded); 13980a920b5bSAndy Whitcroft 13999c0ca6f9SAndy Whitcroft $res = ''; 14006c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 14016c72ffaaSAndy Whitcroft $res .= $1; 14026c72ffaaSAndy Whitcroft if ($2 ne '') { 14039c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 14046c72ffaaSAndy Whitcroft $res .= $coded; 14056c72ffaaSAndy Whitcroft } 14069c0ca6f9SAndy Whitcroft } 14079c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 14080a920b5bSAndy Whitcroft 14099c0ca6f9SAndy Whitcroft return $res; 14100a920b5bSAndy Whitcroft} 14110a920b5bSAndy Whitcroft 1412c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1413cf655043SAndy Whitcroftmy $av_pending; 1414c2fdda0dSAndy Whitcroftmy @av_paren_type; 14151f65f947SAndy Whitcroftmy $av_pend_colon; 1416c2fdda0dSAndy Whitcroft 1417c2fdda0dSAndy Whitcroftsub annotate_reset { 1418c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1419cf655043SAndy Whitcroft $av_pending = '_'; 1420cf655043SAndy Whitcroft @av_paren_type = ('E'); 14211f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1422c2fdda0dSAndy Whitcroft} 1423c2fdda0dSAndy Whitcroft 14246c72ffaaSAndy Whitcroftsub annotate_values { 14256c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 14266c72ffaaSAndy Whitcroft 14276c72ffaaSAndy Whitcroft my $res; 14281f65f947SAndy Whitcroft my $var = '_' x length($stream); 14296c72ffaaSAndy Whitcroft my $cur = $stream; 14306c72ffaaSAndy Whitcroft 1431c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 14326c72ffaaSAndy Whitcroft 14336c72ffaaSAndy Whitcroft while (length($cur)) { 1434773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1435cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1436171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 14376c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1438c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1439c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1440cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1441c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14426c72ffaaSAndy Whitcroft } 14436c72ffaaSAndy Whitcroft 1444c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14459446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14469446ef56SAndy Whitcroft push(@av_paren_type, $type); 1447addcdceaSAndy Whitcroft $type = 'c'; 14489446ef56SAndy Whitcroft 1449e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1450c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14516c72ffaaSAndy Whitcroft $type = 'T'; 14526c72ffaaSAndy Whitcroft 1453389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1454389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1455389a2fe5SAndy Whitcroft $type = 'T'; 1456389a2fe5SAndy Whitcroft 1457c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1458171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1459c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1460171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1461171ae1a4SAndy Whitcroft if ($2 ne '') { 1462cf655043SAndy Whitcroft $av_pending = 'N'; 1463171ae1a4SAndy Whitcroft } 1464171ae1a4SAndy Whitcroft $type = 'E'; 1465171ae1a4SAndy Whitcroft 1466c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1467171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1468171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1469171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14706c72ffaaSAndy Whitcroft 1471c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1472cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1473c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1474cf655043SAndy Whitcroft 1475cf655043SAndy Whitcroft push(@av_paren_type, $type); 1476cf655043SAndy Whitcroft push(@av_paren_type, $type); 1477171ae1a4SAndy Whitcroft $type = 'E'; 1478cf655043SAndy Whitcroft 1479c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1480cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1481cf655043SAndy Whitcroft $av_preprocessor = 1; 1482cf655043SAndy Whitcroft 1483cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1484cf655043SAndy Whitcroft 1485171ae1a4SAndy Whitcroft $type = 'E'; 1486cf655043SAndy Whitcroft 1487c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1488cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1489cf655043SAndy Whitcroft 1490cf655043SAndy Whitcroft $av_preprocessor = 1; 1491cf655043SAndy Whitcroft 1492cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1493cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1494cf655043SAndy Whitcroft pop(@av_paren_type); 1495cf655043SAndy Whitcroft push(@av_paren_type, $type); 1496171ae1a4SAndy Whitcroft $type = 'E'; 14976c72ffaaSAndy Whitcroft 14986c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1499c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 15006c72ffaaSAndy Whitcroft 1501171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1502171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1503171ae1a4SAndy Whitcroft $av_pending = $type; 1504171ae1a4SAndy Whitcroft $type = 'N'; 1505171ae1a4SAndy Whitcroft 15066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1507c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 15086c72ffaaSAndy Whitcroft if (defined $2) { 1509cf655043SAndy Whitcroft $av_pending = 'V'; 15106c72ffaaSAndy Whitcroft } 15116c72ffaaSAndy Whitcroft $type = 'N'; 15126c72ffaaSAndy Whitcroft 151314b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1514c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 151514b111c1SAndy Whitcroft $av_pending = 'E'; 15166c72ffaaSAndy Whitcroft $type = 'N'; 15176c72ffaaSAndy Whitcroft 15181f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 15191f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 15201f65f947SAndy Whitcroft $av_pend_colon = 'C'; 15211f65f947SAndy Whitcroft $type = 'N'; 15221f65f947SAndy Whitcroft 152314b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1524c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 15256c72ffaaSAndy Whitcroft $type = 'N'; 15266c72ffaaSAndy Whitcroft 15276c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1528c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1529cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1530cf655043SAndy Whitcroft $av_pending = '_'; 15316c72ffaaSAndy Whitcroft $type = 'N'; 15326c72ffaaSAndy Whitcroft 15336c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1534cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1535cf655043SAndy Whitcroft if ($new_type ne '_') { 1536cf655043SAndy Whitcroft $type = $new_type; 1537c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1538c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 15396c72ffaaSAndy Whitcroft } else { 1540c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 15416c72ffaaSAndy Whitcroft } 15426c72ffaaSAndy Whitcroft 1543c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1544c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1545c8cb2ca3SAndy Whitcroft $type = 'V'; 1546cf655043SAndy Whitcroft $av_pending = 'V'; 15476c72ffaaSAndy Whitcroft 15488e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15498e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15501f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15518e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15528e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15531f65f947SAndy Whitcroft } 15541f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15551f65f947SAndy Whitcroft $type = 'V'; 15561f65f947SAndy Whitcroft 15576c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1558c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15596c72ffaaSAndy Whitcroft $type = 'V'; 15606c72ffaaSAndy Whitcroft 15616c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1562c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15636c72ffaaSAndy Whitcroft $type = 'N'; 15646c72ffaaSAndy Whitcroft 1565cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1566c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 156713214adfSAndy Whitcroft $type = 'E'; 15681f65f947SAndy Whitcroft $av_pend_colon = 'O'; 156913214adfSAndy Whitcroft 15708e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15718e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15728e761b04SAndy Whitcroft $type = 'C'; 15738e761b04SAndy Whitcroft 15741f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15751f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15761f65f947SAndy Whitcroft $type = 'N'; 15771f65f947SAndy Whitcroft 15781f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15791f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15801f65f947SAndy Whitcroft 15811f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15821f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15831f65f947SAndy Whitcroft $type = 'E'; 15841f65f947SAndy Whitcroft } else { 15851f65f947SAndy Whitcroft $type = 'N'; 15861f65f947SAndy Whitcroft } 15871f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15881f65f947SAndy Whitcroft 15898e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 159013214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15916c72ffaaSAndy Whitcroft $type = 'N'; 15926c72ffaaSAndy Whitcroft 15930d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 159474048ed8SAndy Whitcroft my $variant; 159574048ed8SAndy Whitcroft 159674048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 159774048ed8SAndy Whitcroft if ($type eq 'V') { 159874048ed8SAndy Whitcroft $variant = 'B'; 159974048ed8SAndy Whitcroft } else { 160074048ed8SAndy Whitcroft $variant = 'U'; 160174048ed8SAndy Whitcroft } 160274048ed8SAndy Whitcroft 160374048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 160474048ed8SAndy Whitcroft $type = 'N'; 160574048ed8SAndy Whitcroft 16066c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1607c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 16086c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 16096c72ffaaSAndy Whitcroft $type = 'N'; 16106c72ffaaSAndy Whitcroft } 16116c72ffaaSAndy Whitcroft 16126c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1613c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 16146c72ffaaSAndy Whitcroft } 16156c72ffaaSAndy Whitcroft if (defined $1) { 16166c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 16176c72ffaaSAndy Whitcroft $res .= $type x length($1); 16186c72ffaaSAndy Whitcroft } 16196c72ffaaSAndy Whitcroft } 16206c72ffaaSAndy Whitcroft 16211f65f947SAndy Whitcroft return ($res, $var); 16226c72ffaaSAndy Whitcroft} 16236c72ffaaSAndy Whitcroft 16248905a67cSAndy Whitcroftsub possible { 162513214adfSAndy Whitcroft my ($possible, $line) = @_; 16269a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 16270776e594SAndy Whitcroft ^(?: 16280776e594SAndy Whitcroft $Modifier| 16290776e594SAndy Whitcroft $Storage| 16300776e594SAndy Whitcroft $Type| 16319a974fdbSAndy Whitcroft DEFINE_\S+ 16329a974fdbSAndy Whitcroft )$| 16339a974fdbSAndy Whitcroft ^(?: 16340776e594SAndy Whitcroft goto| 16350776e594SAndy Whitcroft return| 16360776e594SAndy Whitcroft case| 16370776e594SAndy Whitcroft else| 16380776e594SAndy Whitcroft asm|__asm__| 163989a88353SAndy Whitcroft do| 164089a88353SAndy Whitcroft \#| 164189a88353SAndy Whitcroft \#\#| 16429a974fdbSAndy Whitcroft )(?:\s|$)| 16430776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16449a974fdbSAndy Whitcroft )}x; 16459a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16469a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1647c45dcabdSAndy Whitcroft # Check for modifiers. 1648c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1649c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1650c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1651c45dcabdSAndy Whitcroft 1652c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1653c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1654d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16559a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1656d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1657485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1658d2506586SAndy Whitcroft } 16599a974fdbSAndy Whitcroft } 1660c45dcabdSAndy Whitcroft 1661c45dcabdSAndy Whitcroft } else { 166213214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1663485ff23eSAlex Dowad push(@typeListFile, $possible); 1664c45dcabdSAndy Whitcroft } 16658905a67cSAndy Whitcroft build_types(); 16660776e594SAndy Whitcroft } else { 16670776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16688905a67cSAndy Whitcroft } 16698905a67cSAndy Whitcroft} 16708905a67cSAndy Whitcroft 16716c72ffaaSAndy Whitcroftmy $prefix = ''; 16726c72ffaaSAndy Whitcroft 1673000d1cc1SJoe Perchessub show_type { 1674cbec18afSJoe Perches my ($type) = @_; 167591bfe484SJoe Perches 1676cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1677cbec18afSJoe Perches 1678cbec18afSJoe Perches return !defined $ignore_type{$type}; 1679000d1cc1SJoe Perches} 1680000d1cc1SJoe Perches 1681f0a594c1SAndy Whitcroftsub report { 1682cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1683cbec18afSJoe Perches 1684cbec18afSJoe Perches if (!show_type($type) || 1685cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1686773647a0SAndy Whitcroft return 0; 1687773647a0SAndy Whitcroft } 168857230297SJoe Perches my $output = ''; 168957230297SJoe Perches if (-t STDOUT && $color) { 169057230297SJoe Perches if ($level eq 'ERROR') { 169157230297SJoe Perches $output .= RED; 169257230297SJoe Perches } elsif ($level eq 'WARNING') { 169357230297SJoe Perches $output .= YELLOW; 1694000d1cc1SJoe Perches } else { 169557230297SJoe Perches $output .= GREEN; 1696000d1cc1SJoe Perches } 169757230297SJoe Perches } 169857230297SJoe Perches $output .= $prefix . $level . ':'; 169957230297SJoe Perches if ($show_types) { 170057230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 170157230297SJoe Perches $output .= "$type:"; 170257230297SJoe Perches } 170357230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 170457230297SJoe Perches $output .= ' ' . $msg . "\n"; 170534d8815fSJoe Perches 170634d8815fSJoe Perches if ($showfile) { 170734d8815fSJoe Perches my @lines = split("\n", $output, -1); 170834d8815fSJoe Perches splice(@lines, 1, 1); 170934d8815fSJoe Perches $output = join("\n", @lines); 171034d8815fSJoe Perches } 171157230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 17128905a67cSAndy Whitcroft 171357230297SJoe Perches push(our @report, $output); 1714773647a0SAndy Whitcroft 1715773647a0SAndy Whitcroft return 1; 1716f0a594c1SAndy Whitcroft} 1717cbec18afSJoe Perches 1718f0a594c1SAndy Whitcroftsub report_dump { 171913214adfSAndy Whitcroft our @report; 1720f0a594c1SAndy Whitcroft} 1721000d1cc1SJoe Perches 1722d752fcc8SJoe Perchessub fixup_current_range { 1723d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1724d752fcc8SJoe Perches 1725d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1726d752fcc8SJoe Perches my $o = $1; 1727d752fcc8SJoe Perches my $l = $2; 1728d752fcc8SJoe Perches my $no = $o + $offset; 1729d752fcc8SJoe Perches my $nl = $l + $length; 1730d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1731d752fcc8SJoe Perches } 1732d752fcc8SJoe Perches} 1733d752fcc8SJoe Perches 1734d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1735d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1736d752fcc8SJoe Perches 1737d752fcc8SJoe Perches my $range_last_linenr = 0; 1738d752fcc8SJoe Perches my $delta_offset = 0; 1739d752fcc8SJoe Perches 1740d752fcc8SJoe Perches my $old_linenr = 0; 1741d752fcc8SJoe Perches my $new_linenr = 0; 1742d752fcc8SJoe Perches 1743d752fcc8SJoe Perches my $next_insert = 0; 1744d752fcc8SJoe Perches my $next_delete = 0; 1745d752fcc8SJoe Perches 1746d752fcc8SJoe Perches my @lines = (); 1747d752fcc8SJoe Perches 1748d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1749d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1750d752fcc8SJoe Perches 1751d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1752d752fcc8SJoe Perches my $save_line = 1; 1753d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1754323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1755d752fcc8SJoe Perches $delta_offset = 0; 1756d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1757d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1758d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1759d752fcc8SJoe Perches } 1760d752fcc8SJoe Perches 1761d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1762d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1763d752fcc8SJoe Perches $save_line = 0; 1764d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1765d752fcc8SJoe Perches } 1766d752fcc8SJoe Perches 1767d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1768d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1769d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1770d752fcc8SJoe Perches $new_linenr++; 1771d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1772d752fcc8SJoe Perches } 1773d752fcc8SJoe Perches 1774d752fcc8SJoe Perches if ($save_line) { 1775d752fcc8SJoe Perches push(@lines, $line); 1776d752fcc8SJoe Perches $new_linenr++; 1777d752fcc8SJoe Perches } 1778d752fcc8SJoe Perches 1779d752fcc8SJoe Perches $old_linenr++; 1780d752fcc8SJoe Perches } 1781d752fcc8SJoe Perches 1782d752fcc8SJoe Perches return @lines; 1783d752fcc8SJoe Perches} 1784d752fcc8SJoe Perches 1785f2d7e4d4SJoe Perchessub fix_insert_line { 1786f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1787f2d7e4d4SJoe Perches 1788f2d7e4d4SJoe Perches my $inserted = { 1789f2d7e4d4SJoe Perches LINENR => $linenr, 1790f2d7e4d4SJoe Perches LINE => $line, 1791f2d7e4d4SJoe Perches }; 1792f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1793f2d7e4d4SJoe Perches} 1794f2d7e4d4SJoe Perches 1795f2d7e4d4SJoe Perchessub fix_delete_line { 1796f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1797f2d7e4d4SJoe Perches 1798f2d7e4d4SJoe Perches my $deleted = { 1799f2d7e4d4SJoe Perches LINENR => $linenr, 1800f2d7e4d4SJoe Perches LINE => $line, 1801f2d7e4d4SJoe Perches }; 1802f2d7e4d4SJoe Perches 1803f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1804f2d7e4d4SJoe Perches} 1805f2d7e4d4SJoe Perches 1806de7d4f0eSAndy Whitcroftsub ERROR { 1807cbec18afSJoe Perches my ($type, $msg) = @_; 1808cbec18afSJoe Perches 1809cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1810de7d4f0eSAndy Whitcroft our $clean = 0; 18116c72ffaaSAndy Whitcroft our $cnt_error++; 18123705ce5bSJoe Perches return 1; 1813de7d4f0eSAndy Whitcroft } 18143705ce5bSJoe Perches return 0; 1815773647a0SAndy Whitcroft} 1816de7d4f0eSAndy Whitcroftsub WARN { 1817cbec18afSJoe Perches my ($type, $msg) = @_; 1818cbec18afSJoe Perches 1819cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1820de7d4f0eSAndy Whitcroft our $clean = 0; 18216c72ffaaSAndy Whitcroft our $cnt_warn++; 18223705ce5bSJoe Perches return 1; 1823de7d4f0eSAndy Whitcroft } 18243705ce5bSJoe Perches return 0; 1825773647a0SAndy Whitcroft} 1826de7d4f0eSAndy Whitcroftsub CHK { 1827cbec18afSJoe Perches my ($type, $msg) = @_; 1828cbec18afSJoe Perches 1829cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1830de7d4f0eSAndy Whitcroft our $clean = 0; 18316c72ffaaSAndy Whitcroft our $cnt_chk++; 18323705ce5bSJoe Perches return 1; 18336c72ffaaSAndy Whitcroft } 18343705ce5bSJoe Perches return 0; 1835de7d4f0eSAndy Whitcroft} 1836de7d4f0eSAndy Whitcroft 18376ecd9674SAndy Whitcroftsub check_absolute_file { 18386ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 18396ecd9674SAndy Whitcroft my $file = $absolute; 18406ecd9674SAndy Whitcroft 18416ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 18426ecd9674SAndy Whitcroft 18436ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 18446ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 18456ecd9674SAndy Whitcroft if (-f "$root/$file") { 18466ecd9674SAndy Whitcroft ##print "file<$file>\n"; 18476ecd9674SAndy Whitcroft last; 18486ecd9674SAndy Whitcroft } 18496ecd9674SAndy Whitcroft } 18506ecd9674SAndy Whitcroft if (! -f _) { 18516ecd9674SAndy Whitcroft return 0; 18526ecd9674SAndy Whitcroft } 18536ecd9674SAndy Whitcroft 18546ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 18556ecd9674SAndy Whitcroft my $prefix = $absolute; 18566ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 18576ecd9674SAndy Whitcroft 18586ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18596ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1860000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1861000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18626ecd9674SAndy Whitcroft } 18636ecd9674SAndy Whitcroft} 18646ecd9674SAndy Whitcroft 18653705ce5bSJoe Perchessub trim { 18663705ce5bSJoe Perches my ($string) = @_; 18673705ce5bSJoe Perches 1868b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1869b34c648bSJoe Perches 1870b34c648bSJoe Perches return $string; 1871b34c648bSJoe Perches} 1872b34c648bSJoe Perches 1873b34c648bSJoe Perchessub ltrim { 1874b34c648bSJoe Perches my ($string) = @_; 1875b34c648bSJoe Perches 1876b34c648bSJoe Perches $string =~ s/^\s+//; 1877b34c648bSJoe Perches 1878b34c648bSJoe Perches return $string; 1879b34c648bSJoe Perches} 1880b34c648bSJoe Perches 1881b34c648bSJoe Perchessub rtrim { 1882b34c648bSJoe Perches my ($string) = @_; 1883b34c648bSJoe Perches 1884b34c648bSJoe Perches $string =~ s/\s+$//; 18853705ce5bSJoe Perches 18863705ce5bSJoe Perches return $string; 18873705ce5bSJoe Perches} 18883705ce5bSJoe Perches 188952ea8506SJoe Perchessub string_find_replace { 189052ea8506SJoe Perches my ($string, $find, $replace) = @_; 189152ea8506SJoe Perches 189252ea8506SJoe Perches $string =~ s/$find/$replace/g; 189352ea8506SJoe Perches 189452ea8506SJoe Perches return $string; 189552ea8506SJoe Perches} 189652ea8506SJoe Perches 18973705ce5bSJoe Perchessub tabify { 18983705ce5bSJoe Perches my ($leading) = @_; 18993705ce5bSJoe Perches 19003705ce5bSJoe Perches my $source_indent = 8; 19013705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 19023705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 19033705ce5bSJoe Perches 19043705ce5bSJoe Perches #convert leading spaces to tabs 19053705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 19063705ce5bSJoe Perches #Remove spaces before a tab 19073705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 19083705ce5bSJoe Perches 19093705ce5bSJoe Perches return "$leading"; 19103705ce5bSJoe Perches} 19113705ce5bSJoe Perches 1912d1fe9c09SJoe Perchessub pos_last_openparen { 1913d1fe9c09SJoe Perches my ($line) = @_; 1914d1fe9c09SJoe Perches 1915d1fe9c09SJoe Perches my $pos = 0; 1916d1fe9c09SJoe Perches 1917d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1918d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1919d1fe9c09SJoe Perches 1920d1fe9c09SJoe Perches my $last_openparen = 0; 1921d1fe9c09SJoe Perches 1922d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1923d1fe9c09SJoe Perches return -1; 1924d1fe9c09SJoe Perches } 1925d1fe9c09SJoe Perches 1926d1fe9c09SJoe Perches my $len = length($line); 1927d1fe9c09SJoe Perches 1928d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1929d1fe9c09SJoe Perches my $string = substr($line, $pos); 1930d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1931d1fe9c09SJoe Perches $pos += length($1) - 1; 1932d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1933d1fe9c09SJoe Perches $last_openparen = $pos; 1934d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1935d1fe9c09SJoe Perches last; 1936d1fe9c09SJoe Perches } 1937d1fe9c09SJoe Perches } 1938d1fe9c09SJoe Perches 193991cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1940d1fe9c09SJoe Perches} 1941d1fe9c09SJoe Perches 19420a920b5bSAndy Whitcroftsub process { 19430a920b5bSAndy Whitcroft my $filename = shift; 19440a920b5bSAndy Whitcroft 19450a920b5bSAndy Whitcroft my $linenr=0; 19460a920b5bSAndy Whitcroft my $prevline=""; 1947c2fdda0dSAndy Whitcroft my $prevrawline=""; 19480a920b5bSAndy Whitcroft my $stashline=""; 1949c2fdda0dSAndy Whitcroft my $stashrawline=""; 19500a920b5bSAndy Whitcroft 19514a0df2efSAndy Whitcroft my $length; 19520a920b5bSAndy Whitcroft my $indent; 19530a920b5bSAndy Whitcroft my $previndent=0; 19540a920b5bSAndy Whitcroft my $stashindent=0; 19550a920b5bSAndy Whitcroft 1956de7d4f0eSAndy Whitcroft our $clean = 1; 19570a920b5bSAndy Whitcroft my $signoff = 0; 19580a920b5bSAndy Whitcroft my $is_patch = 0; 195929ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 196015662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 1961bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 19622a076f40SJoe Perches my $commit_log_long_line = 0; 1963e518e9a5SJoe Perches my $commit_log_has_diff = 0; 196413f1937eSJoe Perches my $reported_maintainer_file = 0; 1965fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1966fa64205dSPasi Savanainen 1967365dd4eaSJoe Perches my $last_blank_line = 0; 19685e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1969365dd4eaSJoe Perches 197013214adfSAndy Whitcroft our @report = (); 19716c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19726c72ffaaSAndy Whitcroft our $cnt_error = 0; 19736c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19746c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19756c72ffaaSAndy Whitcroft 19760a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19770a920b5bSAndy Whitcroft my $realfile = ''; 19780a920b5bSAndy Whitcroft my $realline = 0; 19790a920b5bSAndy Whitcroft my $realcnt = 0; 19800a920b5bSAndy Whitcroft my $here = ''; 19810a920b5bSAndy Whitcroft my $in_comment = 0; 1982c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19830a920b5bSAndy Whitcroft my $first_line = 0; 19841e855726SWolfram Sang my $p1_prefix = ''; 19850a920b5bSAndy Whitcroft 198613214adfSAndy Whitcroft my $prev_values = 'E'; 198713214adfSAndy Whitcroft 198813214adfSAndy Whitcroft # suppression flags 1989773647a0SAndy Whitcroft my %suppress_ifbraces; 1990170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19912b474a1aSAndy Whitcroft my %suppress_export; 19923e469cdcSAndy Whitcroft my $suppress_statement = 0; 1993653d4876SAndy Whitcroft 19947e51f197SJoe Perches my %signatures = (); 1995323c1260SJoe Perches 1996c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1997de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1998c2fdda0dSAndy Whitcroft # 1999de7d4f0eSAndy Whitcroft my @setup_docs = (); 2000de7d4f0eSAndy Whitcroft my $setup_docs = 0; 2001773647a0SAndy Whitcroft 2002d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2003d8b07710SJoe Perches 2004773647a0SAndy Whitcroft sanitise_line_reset(); 2005c2fdda0dSAndy Whitcroft my $line; 2006c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2007773647a0SAndy Whitcroft $linenr++; 2008773647a0SAndy Whitcroft $line = $rawline; 2009c2fdda0dSAndy Whitcroft 20103705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 20113705ce5bSJoe Perches 2012773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2013de7d4f0eSAndy Whitcroft $setup_docs = 0; 2014de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2015de7d4f0eSAndy Whitcroft $setup_docs = 1; 2016de7d4f0eSAndy Whitcroft } 2017773647a0SAndy Whitcroft #next; 2018de7d4f0eSAndy Whitcroft } 2019773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2020773647a0SAndy Whitcroft $realline=$1-1; 2021773647a0SAndy Whitcroft if (defined $2) { 2022773647a0SAndy Whitcroft $realcnt=$3+1; 2023773647a0SAndy Whitcroft } else { 2024773647a0SAndy Whitcroft $realcnt=1+1; 2025773647a0SAndy Whitcroft } 2026c45dcabdSAndy Whitcroft $in_comment = 0; 2027773647a0SAndy Whitcroft 2028773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2029773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2030773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2031773647a0SAndy Whitcroft # at context start. 2032773647a0SAndy Whitcroft my $edge; 203301fa9147SAndy Whitcroft my $cnt = $realcnt; 203401fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 203501fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 203601fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 203701fa9147SAndy Whitcroft $cnt--; 203801fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2039721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2040fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2041fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2042fae17daeSAndy Whitcroft ($edge) = $1; 2043fae17daeSAndy Whitcroft last; 2044fae17daeSAndy Whitcroft } 2045773647a0SAndy Whitcroft } 2046773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2047773647a0SAndy Whitcroft $in_comment = 1; 2048773647a0SAndy Whitcroft } 2049773647a0SAndy Whitcroft 2050773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2051773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2052773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2053773647a0SAndy Whitcroft if (!defined $edge && 205483242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2055773647a0SAndy Whitcroft { 2056773647a0SAndy Whitcroft $in_comment = 1; 2057773647a0SAndy Whitcroft } 2058773647a0SAndy Whitcroft 2059773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2060773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2061773647a0SAndy Whitcroft 2062171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2063773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2064171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2065773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2066773647a0SAndy Whitcroft } 2067773647a0SAndy Whitcroft push(@lines, $line); 2068773647a0SAndy Whitcroft 2069773647a0SAndy Whitcroft if ($realcnt > 1) { 2070773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2071773647a0SAndy Whitcroft } else { 2072773647a0SAndy Whitcroft $realcnt = 0; 2073773647a0SAndy Whitcroft } 2074773647a0SAndy Whitcroft 2075773647a0SAndy Whitcroft #print "==>$rawline\n"; 2076773647a0SAndy Whitcroft #print "-->$line\n"; 2077de7d4f0eSAndy Whitcroft 2078de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2079de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2080de7d4f0eSAndy Whitcroft } 2081de7d4f0eSAndy Whitcroft } 2082de7d4f0eSAndy Whitcroft 20836c72ffaaSAndy Whitcroft $prefix = ''; 20846c72ffaaSAndy Whitcroft 2085773647a0SAndy Whitcroft $realcnt = 0; 2086773647a0SAndy Whitcroft $linenr = 0; 2087194f66fcSJoe Perches $fixlinenr = -1; 20880a920b5bSAndy Whitcroft foreach my $line (@lines) { 20890a920b5bSAndy Whitcroft $linenr++; 2090194f66fcSJoe Perches $fixlinenr++; 20911b5539b1SJoe Perches my $sline = $line; #copy of $line 20921b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20930a920b5bSAndy Whitcroft 2094c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20956c72ffaaSAndy Whitcroft 20960a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2097e518e9a5SJoe Perches if (!$in_commit_log && 2098e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20990a920b5bSAndy Whitcroft $is_patch = 1; 21004a0df2efSAndy Whitcroft $first_line = $linenr + 1; 21010a920b5bSAndy Whitcroft $realline=$1-1; 21020a920b5bSAndy Whitcroft if (defined $2) { 21030a920b5bSAndy Whitcroft $realcnt=$3+1; 21040a920b5bSAndy Whitcroft } else { 21050a920b5bSAndy Whitcroft $realcnt=1+1; 21060a920b5bSAndy Whitcroft } 2107c2fdda0dSAndy Whitcroft annotate_reset(); 210813214adfSAndy Whitcroft $prev_values = 'E'; 210913214adfSAndy Whitcroft 2110773647a0SAndy Whitcroft %suppress_ifbraces = (); 2111170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 21122b474a1aSAndy Whitcroft %suppress_export = (); 21133e469cdcSAndy Whitcroft $suppress_statement = 0; 21140a920b5bSAndy Whitcroft next; 21150a920b5bSAndy Whitcroft 21164a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 21174a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 21184a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2119773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 21200a920b5bSAndy Whitcroft $realline++; 2121d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 21220a920b5bSAndy Whitcroft 21234a0df2efSAndy Whitcroft # Measure the line length and indent. 2124c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 21250a920b5bSAndy Whitcroft 21260a920b5bSAndy Whitcroft # Track the previous line. 21270a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 21280a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2129c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2130c2fdda0dSAndy Whitcroft 2131773647a0SAndy Whitcroft #warn "line<$line>\n"; 21326c72ffaaSAndy Whitcroft 2133d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2134d8aaf121SAndy Whitcroft $realcnt--; 21350a920b5bSAndy Whitcroft } 21360a920b5bSAndy Whitcroft 2137cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2138cc77cdcaSAndy Whitcroft 21396c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 21406c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2141773647a0SAndy Whitcroft 21422ac73b4fSJoe Perches my $found_file = 0; 2143773647a0SAndy Whitcroft # extract the filename as it passes 21443bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 21453bf9a009SRabin Vincent $realfile = $1; 21462b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2147270c49a0SJoe Perches $in_commit_log = 0; 21482ac73b4fSJoe Perches $found_file = 1; 21493bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2150773647a0SAndy Whitcroft $realfile = $1; 21512b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2152270c49a0SJoe Perches $in_commit_log = 0; 21531e855726SWolfram Sang 21541e855726SWolfram Sang $p1_prefix = $1; 2155e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2156e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2157000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2158000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21591e855726SWolfram Sang } 2160773647a0SAndy Whitcroft 2161c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2162000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2163000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2164773647a0SAndy Whitcroft } 21652ac73b4fSJoe Perches $found_file = 1; 21662ac73b4fSJoe Perches } 21672ac73b4fSJoe Perches 216834d8815fSJoe Perches#make up the handle for any error we report on this line 216934d8815fSJoe Perches if ($showfile) { 217034d8815fSJoe Perches $prefix = "$realfile:$realline: " 217134d8815fSJoe Perches } elsif ($emacs) { 21727d3a9f67SJoe Perches if ($file) { 21737d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 21747d3a9f67SJoe Perches } else { 217534d8815fSJoe Perches $prefix = "$filename:$linenr: "; 217634d8815fSJoe Perches } 21777d3a9f67SJoe Perches } 217834d8815fSJoe Perches 21792ac73b4fSJoe Perches if ($found_file) { 21807bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 21812ac73b4fSJoe Perches $check = 1; 21822ac73b4fSJoe Perches } else { 21832ac73b4fSJoe Perches $check = $check_orig; 21842ac73b4fSJoe Perches } 2185773647a0SAndy Whitcroft next; 2186773647a0SAndy Whitcroft } 2187773647a0SAndy Whitcroft 2188389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21890a920b5bSAndy Whitcroft 2190c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2191c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2192c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21930a920b5bSAndy Whitcroft 21946c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21956c72ffaaSAndy Whitcroft 2196e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2197e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2198e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2199e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2200e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2201e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2202e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2203e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2204e518e9a5SJoe Perches $commit_log_has_diff = 1; 2205e518e9a5SJoe Perches } 2206e518e9a5SJoe Perches 22073bf9a009SRabin Vincent# Check for incorrect file permissions 22083bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 22093bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 221004db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 221104db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2212000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2213000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 22143bf9a009SRabin Vincent } 22153bf9a009SRabin Vincent } 22163bf9a009SRabin Vincent 221720112475SJoe Perches# Check the patch for a signoff: 2218d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 22194a0df2efSAndy Whitcroft $signoff++; 222015662b3eSJoe Perches $in_commit_log = 0; 22210a920b5bSAndy Whitcroft } 222220112475SJoe Perches 2223e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2224e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2225e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2226e0d975b1SJoe Perches $reported_maintainer_file = 1; 2227e0d975b1SJoe Perches } 2228e0d975b1SJoe Perches 222920112475SJoe Perches# Check signature styles 2230270c49a0SJoe Perches if (!$in_header_lines && 2231ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 223220112475SJoe Perches my $space_before = $1; 223320112475SJoe Perches my $sign_off = $2; 223420112475SJoe Perches my $space_after = $3; 223520112475SJoe Perches my $email = $4; 223620112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 223720112475SJoe Perches 2238ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2239ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2240ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2241ce0338dfSJoe Perches } 224220112475SJoe Perches if (defined $space_before && $space_before ne "") { 22433705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22443705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 22453705ce5bSJoe Perches $fix) { 2246194f66fcSJoe Perches $fixed[$fixlinenr] = 22473705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22483705ce5bSJoe Perches } 224920112475SJoe Perches } 225020112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22513705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22523705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22533705ce5bSJoe Perches $fix) { 2254194f66fcSJoe Perches $fixed[$fixlinenr] = 22553705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22563705ce5bSJoe Perches } 22573705ce5bSJoe Perches 225820112475SJoe Perches } 225920112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22603705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22613705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22623705ce5bSJoe Perches $fix) { 2263194f66fcSJoe Perches $fixed[$fixlinenr] = 22643705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22653705ce5bSJoe Perches } 226620112475SJoe Perches } 226720112475SJoe Perches 226820112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 226920112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 227020112475SJoe Perches if ($suggested_email eq "") { 2271000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2272000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 227320112475SJoe Perches } else { 227420112475SJoe Perches my $dequoted = $suggested_email; 227520112475SJoe Perches $dequoted =~ s/^"//; 227620112475SJoe Perches $dequoted =~ s/" </ </; 227720112475SJoe Perches # Don't force email to have quotes 227820112475SJoe Perches # Allow just an angle bracketed address 227920112475SJoe Perches if ("$dequoted$comment" ne $email && 228020112475SJoe Perches "<$email_address>$comment" ne $email && 228120112475SJoe Perches "$suggested_email$comment" ne $email) { 2282000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2283000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 228420112475SJoe Perches } 22850a920b5bSAndy Whitcroft } 22867e51f197SJoe Perches 22877e51f197SJoe Perches# Check for duplicate signatures 22887e51f197SJoe Perches my $sig_nospace = $line; 22897e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22907e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22917e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22927e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22937e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22947e51f197SJoe Perches } else { 22957e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22967e51f197SJoe Perches } 22970a920b5bSAndy Whitcroft } 22980a920b5bSAndy Whitcroft 2299a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2300a2fe16b9SJoe Perches if ($in_header_lines && 2301a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2302a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2303a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2304a2fe16b9SJoe Perches } 2305a2fe16b9SJoe Perches 23069b3189ebSJoe Perches# Check for old stable address 23079b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 23089b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 23099b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 23109b3189ebSJoe Perches } 23119b3189ebSJoe Perches 23127ebd05efSChristopher Covington# Check for unwanted Gerrit info 23137ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 23147ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 23157ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 23167ebd05efSChristopher Covington } 23177ebd05efSChristopher Covington 2318369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump 2319369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2320369c8dd3SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2321369c8dd3SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2322369c8dd3SJoe Perches # timestamp 2323369c8dd3SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2324369c8dd3SJoe Perches # stack dump address 2325369c8dd3SJoe Perches $commit_log_possible_stack_dump = 1; 2326369c8dd3SJoe Perches } 2327369c8dd3SJoe Perches 23282a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 23292a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2330bf4daf12SJoe Perches length($line) > 75 && 2331bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2332bf4daf12SJoe Perches # file delta changes 2333bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2334bf4daf12SJoe Perches # filename then : 2335bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2336bf4daf12SJoe Perches # A Fixes: or Link: line 2337bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 23382a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 23392a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 23402a076f40SJoe Perches $commit_log_long_line = 1; 23412a076f40SJoe Perches } 23422a076f40SJoe Perches 2343bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2344bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2345bf4daf12SJoe Perches $line =~ /^\s*$/) { 2346bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2347bf4daf12SJoe Perches } 2348bf4daf12SJoe Perches 23490d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2350369c8dd3SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2351fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2352bf4daf12SJoe Perches ($line =~ /\b[0-9a-f]{12,40}\b/i && 2353369c8dd3SJoe Perches $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 2354bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2355fe043ea1SJoe Perches my $init_char = "c"; 2356fe043ea1SJoe Perches my $orig_commit = ""; 23570d7835fcSJoe Perches my $short = 1; 23580d7835fcSJoe Perches my $long = 0; 23590d7835fcSJoe Perches my $case = 1; 23600d7835fcSJoe Perches my $space = 1; 23610d7835fcSJoe Perches my $hasdesc = 0; 236219c146a6SJoe Perches my $hasparens = 0; 23630d7835fcSJoe Perches my $id = '0123456789ab'; 23640d7835fcSJoe Perches my $orig_desc = "commit description"; 23650d7835fcSJoe Perches my $description = ""; 23660d7835fcSJoe Perches 2367fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2368fe043ea1SJoe Perches $init_char = $1; 2369fe043ea1SJoe Perches $orig_commit = lc($2); 2370fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2371fe043ea1SJoe Perches $orig_commit = lc($1); 2372fe043ea1SJoe Perches } 2373fe043ea1SJoe Perches 23740d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23750d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23760d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 23770d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 23780d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 23790d7835fcSJoe Perches $orig_desc = $1; 238019c146a6SJoe Perches $hasparens = 1; 23810d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 23820d7835fcSJoe Perches defined $rawlines[$linenr] && 23830d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 23840d7835fcSJoe Perches $orig_desc = $1; 238519c146a6SJoe Perches $hasparens = 1; 2386b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2387b671fde0SJoe Perches defined $rawlines[$linenr] && 2388b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2389b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2390b671fde0SJoe Perches $orig_desc = $1; 2391b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2392b671fde0SJoe Perches $orig_desc .= " " . $1; 239319c146a6SJoe Perches $hasparens = 1; 23940d7835fcSJoe Perches } 23950d7835fcSJoe Perches 23960d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 23970d7835fcSJoe Perches $id, $orig_desc); 23980d7835fcSJoe Perches 239919c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2400d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 24010d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 24020d7835fcSJoe Perches } 2403d311cd44SJoe Perches } 2404d311cd44SJoe Perches 240513f1937eSJoe Perches# Check for added, moved or deleted files 240613f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 240713f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 240813f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 240913f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 241013f1937eSJoe Perches (defined($1) || defined($2))))) { 241113f1937eSJoe Perches $reported_maintainer_file = 1; 241213f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 241313f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 241413f1937eSJoe Perches } 241513f1937eSJoe Perches 241600df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 24178905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2418000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2419000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 24206c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2421de7d4f0eSAndy Whitcroft } 2422de7d4f0eSAndy Whitcroft 24236ecd9674SAndy Whitcroft# Check for absolute kernel paths. 24246ecd9674SAndy Whitcroft if ($tree) { 24256ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 24266ecd9674SAndy Whitcroft my $file = $1; 24276ecd9674SAndy Whitcroft 24286ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 24296ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 24306ecd9674SAndy Whitcroft # 24316ecd9674SAndy Whitcroft } else { 24326ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 24336ecd9674SAndy Whitcroft } 24346ecd9674SAndy Whitcroft } 24356ecd9674SAndy Whitcroft } 24366ecd9674SAndy Whitcroft 2437de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2438de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2439171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2440171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2441171ae1a4SAndy Whitcroft 2442171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2443171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2444171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2445171ae1a4SAndy Whitcroft 244634d99219SJoe Perches CHK("INVALID_UTF8", 2447000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 244800df344fSAndy Whitcroft } 24490a920b5bSAndy Whitcroft 245015662b3eSJoe Perches# Check if it's the start of a commit log 245115662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 245215662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 245329ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 245429ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 245515662b3eSJoe Perches $in_header_lines = 0; 245615662b3eSJoe Perches $in_commit_log = 1; 245715662b3eSJoe Perches } 245815662b3eSJoe Perches 2459fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2460fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2461fa64205dSPasi Savanainen if ($in_header_lines && 2462fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2463fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2464fa64205dSPasi Savanainen $non_utf8_charset = 1; 2465fa64205dSPasi Savanainen } 2466fa64205dSPasi Savanainen 2467fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 246815662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2469fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 247015662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 247115662b3eSJoe Perches } 247215662b3eSJoe Perches 247366b47b4aSKees Cook# Check for various typo / spelling mistakes 247466d7a382SJoe Perches if (defined($misspellings) && 247566d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2476ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 247766b47b4aSKees Cook my $typo = $1; 247866b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 247966b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 248066b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 248166b47b4aSKees Cook my $msg_type = \&WARN; 248266b47b4aSKees Cook $msg_type = \&CHK if ($file); 248366b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 248466b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 248566b47b4aSKees Cook $fix) { 248666b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 248766b47b4aSKees Cook } 248866b47b4aSKees Cook } 248966b47b4aSKees Cook } 249066b47b4aSKees Cook 249130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 249230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 249300df344fSAndy Whitcroft 24940a920b5bSAndy Whitcroft#trailing whitespace 24959c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2496c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2497d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2498d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2499d5e616fcSJoe Perches $fix) { 2500194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2501d5e616fcSJoe Perches } 2502c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2503c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25043705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 25053705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 25063705ce5bSJoe Perches $fix) { 2507194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 25083705ce5bSJoe Perches } 25093705ce5bSJoe Perches 2510d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25110a920b5bSAndy Whitcroft } 25125368df20SAndy Whitcroft 25134783f894SJosh Triplett# Check for FSF mailing addresses. 2514109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 25153e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 25163e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 25174783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25184783f894SJosh Triplett my $msg_type = \&ERROR; 25194783f894SJosh Triplett $msg_type = \&CHK if ($file); 25204783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 25214783f894SJosh 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) 25224783f894SJosh Triplett } 25234783f894SJosh Triplett 25243354957aSAndi Kleen# check for Kconfig help text having a real description 25259fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 25269fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 25273354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 25288d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 25293354957aSAndi Kleen my $length = 0; 25309fe287d7SAndy Whitcroft my $cnt = $realcnt; 25319fe287d7SAndy Whitcroft my $ln = $linenr + 1; 25329fe287d7SAndy Whitcroft my $f; 2533a1385803SAndy Whitcroft my $is_start = 0; 25349fe287d7SAndy Whitcroft my $is_end = 0; 2535a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 25369fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 25379fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 25389fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 25399fe287d7SAndy Whitcroft 25409fe287d7SAndy Whitcroft next if ($f =~ /^-/); 25418d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2542a1385803SAndy Whitcroft 25438d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2544a1385803SAndy Whitcroft $is_start = 1; 25458d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2546a1385803SAndy Whitcroft $length = -1; 2547a1385803SAndy Whitcroft } 2548a1385803SAndy Whitcroft 25499fe287d7SAndy Whitcroft $f =~ s/^.//; 25503354957aSAndi Kleen $f =~ s/#.*//; 25513354957aSAndi Kleen $f =~ s/^\s+//; 25523354957aSAndi Kleen next if ($f =~ /^$/); 25539fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 25549fe287d7SAndy Whitcroft $is_end = 1; 25559fe287d7SAndy Whitcroft last; 25569fe287d7SAndy Whitcroft } 25573354957aSAndi Kleen $length++; 25583354957aSAndi Kleen } 255956193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2560000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 256156193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 256256193274SVadim Bendebury } 2563a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25643354957aSAndi Kleen } 25653354957aSAndi Kleen 25661ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25671ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25681ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25691ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25701ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25711ba8dfd1SKees Cook } 25721ba8dfd1SKees Cook 2573327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2574327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2575327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2576327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2577327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2578327953e9SChristoph Jaeger } 2579327953e9SChristoph Jaeger 2580c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2581c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2582c68e5878SArnaud Lacombe my $flag = $1; 2583c68e5878SArnaud Lacombe my $replacement = { 2584c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2585c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2586c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2587c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2588c68e5878SArnaud Lacombe }; 2589c68e5878SArnaud Lacombe 2590c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2591c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2592c68e5878SArnaud Lacombe } 2593c68e5878SArnaud Lacombe 2594bff5da43SRob Herring# check for DT compatible documentation 25957dd05b38SFlorian Vaussard if (defined $root && 25967dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 25977dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 25987dd05b38SFlorian Vaussard 2599bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2600bff5da43SRob Herring 2601cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2602cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2603cc93319bSFlorian Vaussard 2604bff5da43SRob Herring foreach my $compat (@compats) { 2605bff5da43SRob Herring my $compat2 = $compat; 2606185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2607185d566bSRob Herring my $compat3 = $compat; 2608185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2609185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2610bff5da43SRob Herring if ( $? >> 8 ) { 2611bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2612bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2613bff5da43SRob Herring } 2614bff5da43SRob Herring 26154fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 26164fbf32a6SFlorian Vaussard my $vendor = $1; 2617cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2618bff5da43SRob Herring if ( $? >> 8 ) { 2619bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2620cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2621bff5da43SRob Herring } 2622bff5da43SRob Herring } 2623bff5da43SRob Herring } 2624bff5da43SRob Herring 26255368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2626de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 26275368df20SAndy Whitcroft 262847e0c88bSJoe Perches# line length limit (with some exclusions) 262947e0c88bSJoe Perches# 263047e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 263147e0c88bSJoe Perches# logging functions like pr_info that end in a string 263247e0c88bSJoe Perches# lines with a single string 263347e0c88bSJoe Perches# #defines that are a single string 263447e0c88bSJoe Perches# 263547e0c88bSJoe Perches# There are 3 different line length message types: 263647e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 263747e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 263847e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 263947e0c88bSJoe Perches# 264047e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 264147e0c88bSJoe Perches# 264247e0c88bSJoe Perches 2643b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 264447e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 264547e0c88bSJoe Perches 264647e0c88bSJoe Perches # Check the allowed long line types first 264747e0c88bSJoe Perches 264847e0c88bSJoe Perches # logging functions that end in a string that starts 264947e0c88bSJoe Perches # before $max_line_length 265047e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 265147e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 265247e0c88bSJoe Perches $msg_type = ""; 265347e0c88bSJoe Perches 265447e0c88bSJoe Perches # lines with only strings (w/ possible termination) 265547e0c88bSJoe Perches # #defines with only strings 265647e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 265747e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 265847e0c88bSJoe Perches $msg_type = ""; 265947e0c88bSJoe Perches 266047e0c88bSJoe Perches # Otherwise set the alternate message types 266147e0c88bSJoe Perches 266247e0c88bSJoe Perches # a comment starts before $max_line_length 266347e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 266447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 266547e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 266647e0c88bSJoe Perches 266747e0c88bSJoe Perches # a quoted string starts before $max_line_length 266847e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 266947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 267047e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 267147e0c88bSJoe Perches } 267247e0c88bSJoe Perches 267347e0c88bSJoe Perches if ($msg_type ne "" && 267447e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 267547e0c88bSJoe Perches WARN($msg_type, 26766cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 26770a920b5bSAndy Whitcroft } 267847e0c88bSJoe Perches } 26790a920b5bSAndy Whitcroft 26808905a67cSAndy Whitcroft# check for adding lines without a newline. 26818905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2682000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2683000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 26848905a67cSAndy Whitcroft } 26858905a67cSAndy Whitcroft 268642e41c54SMike Frysinger# Blackfin: use hi/lo macros 268742e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 268842e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 268942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2690000d1cc1SJoe Perches ERROR("LO_MACRO", 2691000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 269242e41c54SMike Frysinger } 269342e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 269442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2695000d1cc1SJoe Perches ERROR("HI_MACRO", 2696000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 269742e41c54SMike Frysinger } 269842e41c54SMike Frysinger } 269942e41c54SMike Frysinger 2700b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2701de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 27020a920b5bSAndy Whitcroft 27030a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 27040a920b5bSAndy Whitcroft# more than 8 must use tabs. 2705c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2706c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2707c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2708d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27093705ce5bSJoe Perches if (ERROR("CODE_INDENT", 27103705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 27113705ce5bSJoe Perches $fix) { 2712194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27133705ce5bSJoe Perches } 27140a920b5bSAndy Whitcroft } 27150a920b5bSAndy Whitcroft 271608e44365SAlberto Panizzo# check for space before tabs. 271708e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 271808e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27193705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 27203705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 27213705ce5bSJoe Perches $fix) { 2722194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2723d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2724194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2725c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 27263705ce5bSJoe Perches } 272708e44365SAlberto Panizzo } 272808e44365SAlberto Panizzo 2729d1fe9c09SJoe Perches# check for && or || at the start of a line 2730d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2731d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2732d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2733d1fe9c09SJoe Perches } 2734d1fe9c09SJoe Perches 2735d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2736d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 273791cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2738d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2739d1fe9c09SJoe Perches my $oldindent = $1; 2740d1fe9c09SJoe Perches my $rest = $2; 2741d1fe9c09SJoe Perches 2742d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2743d1fe9c09SJoe Perches if ($pos >= 0) { 2744b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2745b34a26f3SJoe Perches my $newindent = $2; 2746d1fe9c09SJoe Perches 2747d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2748d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2749d1fe9c09SJoe Perches " " x ($pos % 8); 2750d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2751d1fe9c09SJoe Perches 2752d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2753d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 27543705ce5bSJoe Perches 27553705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 27563705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27573705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2758194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27593705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27603705ce5bSJoe Perches } 2761d1fe9c09SJoe Perches } 2762d1fe9c09SJoe Perches } 2763d1fe9c09SJoe Perches } 2764d1fe9c09SJoe Perches 27656ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27666ab3a970SJoe Perches# avoid checking a few false positives: 27676ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27686ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27696ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27706ab3a970SJoe Perches# multiline macros that define functions 27716ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27726ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27736ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27743705ce5bSJoe Perches if (CHK("SPACING", 2775f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27763705ce5bSJoe Perches $fix) { 2777194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2778f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 27793705ce5bSJoe Perches } 2780aad4f614SJoe Perches } 2781aad4f614SJoe Perches 278286406b1cSJoe Perches# Block comment styles 278386406b1cSJoe Perches# Networking with an initial /* 278405880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2785fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 278685ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 278785ad978cSJoe Perches $realline > 2) { 278805880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 278905880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 279005880600SJoe Perches } 279105880600SJoe Perches 279286406b1cSJoe Perches# Block comments use * on subsequent lines 279386406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 279486406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2795a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 279661135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2797a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 279886406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 279986406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2800a605e32eSJoe Perches } 2801a605e32eSJoe Perches 280286406b1cSJoe Perches# Block comments use */ on trailing lines 280386406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2804c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2805c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2806c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 280786406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 280886406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 280905880600SJoe Perches } 281005880600SJoe Perches 28117f619191SJoe Perches# check for missing blank lines after struct/union declarations 28127f619191SJoe Perches# with exceptions for various attributes and macros 28137f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 28147f619191SJoe Perches $line =~ /^\+/ && 28157f619191SJoe Perches !($line =~ /^\+\s*$/ || 28167f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 28177f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 28187f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 28197f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 28207f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 28217f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 28227f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2823d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2824d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2825d752fcc8SJoe Perches $fix) { 2826f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2827d752fcc8SJoe Perches } 28287f619191SJoe Perches } 28297f619191SJoe Perches 2830365dd4eaSJoe Perches# check for multiple consecutive blank lines 2831365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2832365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2833365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2834d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2835d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2836d752fcc8SJoe Perches $fix) { 2837f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2838d752fcc8SJoe Perches } 2839d752fcc8SJoe Perches 2840365dd4eaSJoe Perches $last_blank_line = $linenr; 2841365dd4eaSJoe Perches } 2842365dd4eaSJoe Perches 28433b617e3bSJoe Perches# check for missing blank lines after declarations 28443f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 28453f7bac03SJoe Perches # actual declarations 28463f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28475a4e1fd3SJoe Perches # function pointer declarations 28485a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28493f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28503f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28513f7bac03SJoe Perches # known declaration macros 28523f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 28533f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 28543f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 28553f7bac03SJoe Perches # other possible extensions of declaration lines 28563f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 28573f7bac03SJoe Perches # not starting a section or a macro "\" extended line 28583f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 28593f7bac03SJoe Perches # looks like a declaration 28603f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28615a4e1fd3SJoe Perches # function pointer declarations 28625a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28633f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28643f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28653f7bac03SJoe Perches # known declaration macros 28663f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28673f7bac03SJoe Perches # start of struct or union or enum 28683b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28693f7bac03SJoe Perches # start or end of block or continuation of declaration 28703f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28713f7bac03SJoe Perches # bitfield continuation 28723f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28733f7bac03SJoe Perches # other possible extensions of declaration lines 28743f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28753f7bac03SJoe Perches # indentation of previous and current line are the same 28763f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2877d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2878d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2879d752fcc8SJoe Perches $fix) { 2880f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2881d752fcc8SJoe Perches } 28823b617e3bSJoe Perches } 28833b617e3bSJoe Perches 28845f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 28856b4c5bebSAndy Whitcroft# Exceptions: 28866b4c5bebSAndy Whitcroft# 1) within comments 28876b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 28886b4c5bebSAndy Whitcroft# 3) hanging labels 28893705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 28905f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28913705ce5bSJoe Perches if (WARN("LEADING_SPACE", 28923705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 28933705ce5bSJoe Perches $fix) { 2894194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28953705ce5bSJoe Perches } 28965f7ddae6SRaffaele Recalcati } 28975f7ddae6SRaffaele Recalcati 2898b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2899b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2900b9ea10d6SAndy Whitcroft 2901032a4c0fSJoe Perches# check indentation of any line with a bare else 2902840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2903032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2904032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2905032a4c0fSJoe Perches my $tabs = length($1) + 1; 2906840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2907840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2908840080a0SJoe Perches defined $lines[$linenr] && 2909840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2910032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2911032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2912032a4c0fSJoe Perches } 2913032a4c0fSJoe Perches } 2914032a4c0fSJoe Perches 2915c00df19aSJoe Perches# check indentation of a line with a break; 2916c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2917c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2918c00df19aSJoe Perches my $tabs = $1; 2919c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2920c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2921c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2922c00df19aSJoe Perches } 2923c00df19aSJoe Perches } 2924c00df19aSJoe Perches 29251ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 29261ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 29271ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 29281ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 29291ba8dfd1SKees Cook } 29301ba8dfd1SKees Cook 2931c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2932cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2933000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2934000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2935c2fdda0dSAndy Whitcroft } 293622f2a2efSAndy Whitcroft 293742e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 293842e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 293942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2940000d1cc1SJoe Perches ERROR("CSYNC", 2941000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 294242e41c54SMike Frysinger } 294342e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 294442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2945000d1cc1SJoe Perches ERROR("SSYNC", 2946000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 294742e41c54SMike Frysinger } 294842e41c54SMike Frysinger 294956e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 295056e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 295156e77d70SJoe Perches WARN("HOTPLUG_SECTION", 295256e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 295356e77d70SJoe Perches } 295456e77d70SJoe Perches 29559c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 29562b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 29572b474a1aSAndy Whitcroft $realline_next); 29583e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 29593e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29601b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2961170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2962f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2963171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2964171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2965171ae1a4SAndy Whitcroft 29663e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29673e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29683e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29693e469cdcSAndy Whitcroft # until we hit end of it. 29703e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29713e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29723e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29733e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29743e469cdcSAndy Whitcroft } 2975f74bd194SAndy Whitcroft 29762b474a1aSAndy Whitcroft # Find the real next line. 29772b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 29782b474a1aSAndy Whitcroft if (defined $realline_next && 29792b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 29802b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 29812b474a1aSAndy Whitcroft $realline_next++; 29822b474a1aSAndy Whitcroft } 29832b474a1aSAndy Whitcroft 2984171ae1a4SAndy Whitcroft my $s = $stat; 2985171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2986cf655043SAndy Whitcroft 2987c2fdda0dSAndy Whitcroft # Ignore goto labels. 2988171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2989c2fdda0dSAndy Whitcroft 2990c2fdda0dSAndy Whitcroft # Ignore functions being called 2991171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2992c2fdda0dSAndy Whitcroft 2993463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2994463f2864SAndy Whitcroft 2995c45dcabdSAndy Whitcroft # declarations always start with types 2996d2506586SAndy 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) { 2997c45dcabdSAndy Whitcroft my $type = $1; 2998c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2999c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 3000c45dcabdSAndy Whitcroft 30016c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 3002a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3003c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3004c2fdda0dSAndy Whitcroft } 30058905a67cSAndy Whitcroft 30066c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 300765863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3008c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 30099c0ca6f9SAndy Whitcroft } 30108905a67cSAndy Whitcroft 30118905a67cSAndy Whitcroft # Check for any sort of function declaration. 30128905a67cSAndy Whitcroft # int foo(something bar, other baz); 30138905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3014171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 30158905a67cSAndy Whitcroft my ($name_len) = length($1); 30168905a67cSAndy Whitcroft 3017cf655043SAndy Whitcroft my $ctx = $s; 3018773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 30198905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3020cf655043SAndy Whitcroft 30218905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3022c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 30238905a67cSAndy Whitcroft 3024c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 30258905a67cSAndy Whitcroft } 30268905a67cSAndy Whitcroft } 30278905a67cSAndy Whitcroft } 30288905a67cSAndy Whitcroft 30299c0ca6f9SAndy Whitcroft } 30309c0ca6f9SAndy Whitcroft 303100df344fSAndy Whitcroft# 303200df344fSAndy Whitcroft# Checks which may be anchored in the context. 303300df344fSAndy Whitcroft# 303400df344fSAndy Whitcroft 303500df344fSAndy Whitcroft# Check for switch () and associated case and default 303600df344fSAndy Whitcroft# statements should be at the same indent. 303700df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 303800df344fSAndy Whitcroft my $err = ''; 303900df344fSAndy Whitcroft my $sep = ''; 304000df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 304100df344fSAndy Whitcroft shift(@ctx); 304200df344fSAndy Whitcroft for my $ctx (@ctx) { 304300df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 304400df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 304500df344fSAndy Whitcroft $indent != $cindent) { 304600df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 304700df344fSAndy Whitcroft $sep = ''; 304800df344fSAndy Whitcroft } else { 304900df344fSAndy Whitcroft $sep = "[...]\n"; 305000df344fSAndy Whitcroft } 305100df344fSAndy Whitcroft } 305200df344fSAndy Whitcroft if ($err ne '') { 3053000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3054000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3055de7d4f0eSAndy Whitcroft } 3056de7d4f0eSAndy Whitcroft } 3057de7d4f0eSAndy Whitcroft 3058de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3059de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30600fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3061773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3062773647a0SAndy Whitcroft 30639c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30648eef05ddSJoe Perches 30658eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30668eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30678eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30688eef05ddSJoe Perches } 30698eef05ddSJoe Perches 3070de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3071de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3072de7d4f0eSAndy Whitcroft 3073548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3074548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3075de7d4f0eSAndy Whitcroft 3076548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3077548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3078548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3079548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3080548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3081773647a0SAndy Whitcroft $ctx_ln++; 3082773647a0SAndy Whitcroft } 3083548596d5SAndy Whitcroft 308453210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 308553210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3086773647a0SAndy Whitcroft 3087773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3088000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3089000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 309001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 309100df344fSAndy Whitcroft } 3092773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3093773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3094773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3095773647a0SAndy Whitcroft { 30969c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 30979c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3098000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3099000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 310001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 31019c0ca6f9SAndy Whitcroft } 31029c0ca6f9SAndy Whitcroft } 310300df344fSAndy Whitcroft } 310400df344fSAndy Whitcroft 31054d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 31060fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 31073e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 31083e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 31093e469cdcSAndy Whitcroft if (!defined $stat); 31104d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 31114d001e4dSAndy Whitcroft 31124d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 31134d001e4dSAndy Whitcroft 31149f5af480SJoe Perches # remove inline comments 31159f5af480SJoe Perches $s =~ s/$;/ /g; 31169f5af480SJoe Perches $c =~ s/$;/ /g; 31174d001e4dSAndy Whitcroft 31184d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 31196f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 31206f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 31214d001e4dSAndy Whitcroft 31229f5af480SJoe Perches # Make sure we remove the line prefixes as we have 31239f5af480SJoe Perches # none on the first line, and are going to readd them 31249f5af480SJoe Perches # where necessary. 31259f5af480SJoe Perches $s =~ s/\n./\n/gs; 31269f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 31279f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 31289f5af480SJoe Perches } 31299f5af480SJoe Perches 31304d001e4dSAndy Whitcroft # We want to check the first line inside the block 31314d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 31324d001e4dSAndy Whitcroft # 1) any blank line termination 31334d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 31344d001e4dSAndy Whitcroft # 3) any do (...) { 31354d001e4dSAndy Whitcroft my $continuation = 0; 31364d001e4dSAndy Whitcroft my $check = 0; 31374d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 31384d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 31394d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 31404d001e4dSAndy Whitcroft $continuation = 1; 31414d001e4dSAndy Whitcroft } 31429bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 31434d001e4dSAndy Whitcroft $check = 1; 31444d001e4dSAndy Whitcroft $cond_lines++; 31454d001e4dSAndy Whitcroft } 31464d001e4dSAndy Whitcroft 31474d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 31484d001e4dSAndy Whitcroft # preprocessor statement. 31494d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 31504d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 31514d001e4dSAndy Whitcroft $check = 0; 31524d001e4dSAndy Whitcroft } 31534d001e4dSAndy Whitcroft 31549bd49efeSAndy Whitcroft my $cond_ptr = -1; 3155740504c6SAndy Whitcroft $continuation = 0; 31569bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 31579bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 31584d001e4dSAndy Whitcroft 3159f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3160f16fa28fSAndy Whitcroft # is not linear. 3161f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3162f16fa28fSAndy Whitcroft $check = 0; 3163f16fa28fSAndy Whitcroft } 3164f16fa28fSAndy Whitcroft 31659bd49efeSAndy Whitcroft # Ignore: 31669bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31679bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31689bd49efeSAndy Whitcroft # 3) labels. 3169740504c6SAndy Whitcroft if ($continuation || 3170740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31719bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31729bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3173740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 317430dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31759bd49efeSAndy Whitcroft $cond_lines++; 31769bd49efeSAndy Whitcroft } 31774d001e4dSAndy Whitcroft } 317830dad6ebSAndy Whitcroft } 31794d001e4dSAndy Whitcroft 31804d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 31814d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 31824d001e4dSAndy Whitcroft 31834d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 31844d001e4dSAndy Whitcroft # this is not this patch's fault. 31854d001e4dSAndy Whitcroft if (!defined($stat_real) || 31864d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 31874d001e4dSAndy Whitcroft $check = 0; 31884d001e4dSAndy Whitcroft } 31894d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 31904d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 31914d001e4dSAndy Whitcroft } 31924d001e4dSAndy Whitcroft 31939bd49efeSAndy 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"; 31944d001e4dSAndy Whitcroft 31959f5af480SJoe Perches if ($check && $s ne '' && 31969f5af480SJoe Perches (($sindent % 8) != 0 || 31979f5af480SJoe Perches ($sindent < $indent) || 31989f5af480SJoe Perches ($sindent > $indent + 8))) { 3199000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3200000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 32014d001e4dSAndy Whitcroft } 32024d001e4dSAndy Whitcroft } 32034d001e4dSAndy Whitcroft 32046c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 32056c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 32061f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 32071f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 32086c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3209c2fdda0dSAndy Whitcroft if ($dbg_values) { 3210c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3211cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3212cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 32131f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3214c2fdda0dSAndy Whitcroft } 32156c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 32166c72ffaaSAndy Whitcroft 321700df344fSAndy Whitcroft#ignore lines not being added 32183705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 321900df344fSAndy Whitcroft 3220653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 32217429c690SAndy Whitcroft if ($dbg_type) { 32227429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3223000d1cc1SJoe Perches ERROR("TEST_TYPE", 3224000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 32257429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3226000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3227000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 32287429c690SAndy Whitcroft } 3229653d4876SAndy Whitcroft next; 3230653d4876SAndy Whitcroft } 3231a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3232a1ef277eSAndy Whitcroft if ($dbg_attr) { 32339360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3234000d1cc1SJoe Perches ERROR("TEST_ATTR", 3235000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 32369360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3237000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3238000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3239a1ef277eSAndy Whitcroft } 3240a1ef277eSAndy Whitcroft next; 3241a1ef277eSAndy Whitcroft } 3242653d4876SAndy Whitcroft 3243f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 324499423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 324599423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3246d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3247d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3248f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3249f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3250f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3251d752fcc8SJoe Perches my $fixedline = $prevrawline; 3252d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3253f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3254d752fcc8SJoe Perches $fixedline = $line; 3255d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3256f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3257d752fcc8SJoe Perches } 3258f0a594c1SAndy Whitcroft } 3259f0a594c1SAndy Whitcroft 326000df344fSAndy Whitcroft# 326100df344fSAndy Whitcroft# Checks which are anchored on the added line. 326200df344fSAndy Whitcroft# 326300df344fSAndy Whitcroft 3264653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3265c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3266653d4876SAndy Whitcroft my $path = $1; 3267653d4876SAndy Whitcroft if ($path =~ m{//}) { 3268000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3269495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3270495e9d84SJoe Perches } 3271495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3272495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3273495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3274653d4876SAndy Whitcroft } 3275653d4876SAndy Whitcroft } 3276653d4876SAndy Whitcroft 327700df344fSAndy Whitcroft# no C99 // comments 327800df344fSAndy Whitcroft if ($line =~ m{//}) { 32793705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 32803705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 32813705ce5bSJoe Perches $fix) { 3282194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 32833705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 32843705ce5bSJoe Perches my $comment = trim($1); 3285194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 32863705ce5bSJoe Perches } 32873705ce5bSJoe Perches } 328800df344fSAndy Whitcroft } 328900df344fSAndy Whitcroft # Remove C99 comments. 32900a920b5bSAndy Whitcroft $line =~ s@//.*@@; 32916c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 32920a920b5bSAndy Whitcroft 32932b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 32942b474a1aSAndy Whitcroft# the whole statement. 32952b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 32962b474a1aSAndy Whitcroft if (defined $realline_next && 32972b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 32982b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 32992b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33002b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33013cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 33023cbf62dfSAndy Whitcroft # a prefix: 33033cbf62dfSAndy Whitcroft # XXX(foo); 33043cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3305653d4876SAndy Whitcroft my $name = $1; 330687a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 33073cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 33083cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 33093cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 33103cbf62dfSAndy Whitcroft 33113cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 33122b474a1aSAndy Whitcroft \n.}\s*$| 331348012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 331448012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 331548012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 33162b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 33172b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 331848012058SAndy Whitcroft )/x) { 33192b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 33202b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 33212b474a1aSAndy Whitcroft } else { 33222b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 33230a920b5bSAndy Whitcroft } 33240a920b5bSAndy Whitcroft } 33252b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 33262b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 33272b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33282b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33292b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 33302b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 33312b474a1aSAndy Whitcroft } 33322b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 33332b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3334000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3335000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 33362b474a1aSAndy Whitcroft } 33370a920b5bSAndy Whitcroft 33385150bda4SJoe Eloff# check for global initialisers. 33396d32f7a3SJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) { 3340d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 33416d32f7a3SJoe Perches "do not initialise globals to $1\n" . $herecurr) && 3342d5e616fcSJoe Perches $fix) { 33436d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 3344d5e616fcSJoe Perches } 3345f0a594c1SAndy Whitcroft } 33460a920b5bSAndy Whitcroft# check for static initialisers. 33476d32f7a3SJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 3348d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 33496d32f7a3SJoe Perches "do not initialise statics to $1\n" . 3350d5e616fcSJoe Perches $herecurr) && 3351d5e616fcSJoe Perches $fix) { 33526d32f7a3SJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 3353d5e616fcSJoe Perches } 33540a920b5bSAndy Whitcroft } 33550a920b5bSAndy Whitcroft 33561813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 33571813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 33581813087dSJoe Perches my $tmp = trim($1); 33591813087dSJoe Perches WARN("MISORDERED_TYPE", 33601813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 33611813087dSJoe Perches } 33621813087dSJoe Perches 3363cb710ecaSJoe Perches# check for static const char * arrays. 3364cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3365000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3366000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3367cb710ecaSJoe Perches $herecurr); 3368cb710ecaSJoe Perches } 3369cb710ecaSJoe Perches 3370cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3371cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3372000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3373000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3374cb710ecaSJoe Perches $herecurr); 3375cb710ecaSJoe Perches } 3376cb710ecaSJoe Perches 3377ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3378ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3379ab7e23f3SJoe Perches my $found = $1; 3380ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3381ab7e23f3SJoe Perches WARN("CONST_CONST", 3382ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3383ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3384ab7e23f3SJoe Perches WARN("CONST_CONST", 3385ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3386ab7e23f3SJoe Perches } 3387ab7e23f3SJoe Perches } 3388ab7e23f3SJoe Perches 33899b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 33909b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 33919b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 33929b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 33939b0fa60dSJoe Perches $herecurr); 33949b0fa60dSJoe Perches } 33959b0fa60dSJoe Perches 3396b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3397b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3398b598b670SJoe Perches my $array = $1; 3399b598b670SJoe 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*\))@) { 3400b598b670SJoe Perches my $array_div = $1; 3401b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3402b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3403b598b670SJoe Perches $fix) { 3404b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3405b598b670SJoe Perches } 3406b598b670SJoe Perches } 3407b598b670SJoe Perches } 3408b598b670SJoe Perches 3409b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3410b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3411b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3412b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3413b36190c5SJoe Perches $fix) { 3414194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3415b36190c5SJoe Perches } 3416b36190c5SJoe Perches } 3417b36190c5SJoe Perches 341892e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 341992e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 342092e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 342192e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 342292e112fdSJoe Perches $fix) { 3423194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 342492e112fdSJoe Perches } 342593ed0e2dSJoe Perches } 342693ed0e2dSJoe Perches 3427653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3428653d4876SAndy Whitcroft# make sense. 3429653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 34308054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3431c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 34328ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3433653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3434000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3435000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 34360a920b5bSAndy Whitcroft } 34370a920b5bSAndy Whitcroft 34380a920b5bSAndy Whitcroft# * goes on variable not on type 343965863862SAndy Whitcroft # (char*[ const]) 3440bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3441bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 34423705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3443d8aaf121SAndy Whitcroft 344465863862SAndy Whitcroft # Should start with a space. 344565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 344665863862SAndy Whitcroft # Should not end with a space. 344765863862SAndy Whitcroft $to =~ s/\s+$//; 344865863862SAndy Whitcroft # '*'s should not have spaces between. 3449f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 345065863862SAndy Whitcroft } 3451d8aaf121SAndy Whitcroft 34523705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 345365863862SAndy Whitcroft if ($from ne $to) { 34543705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34553705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 34563705ce5bSJoe Perches $fix) { 34573705ce5bSJoe Perches my $sub_from = $ident; 34583705ce5bSJoe Perches my $sub_to = $ident; 34593705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3460194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34613705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34623705ce5bSJoe Perches } 346365863862SAndy Whitcroft } 3464bfcb2cc7SAndy Whitcroft } 3465bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3466bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 34673705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3468d8aaf121SAndy Whitcroft 346965863862SAndy Whitcroft # Should start with a space. 347065863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 347165863862SAndy Whitcroft # Should not end with a space. 347265863862SAndy Whitcroft $to =~ s/\s+$//; 347365863862SAndy Whitcroft # '*'s should not have spaces between. 3474f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 347565863862SAndy Whitcroft } 347665863862SAndy Whitcroft # Modifiers should have spaces. 347765863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 347865863862SAndy Whitcroft 34793705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3480667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 34813705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34823705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 34833705ce5bSJoe Perches $fix) { 34843705ce5bSJoe Perches 34853705ce5bSJoe Perches my $sub_from = $match; 34863705ce5bSJoe Perches my $sub_to = $match; 34873705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3488194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34893705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34903705ce5bSJoe Perches } 349165863862SAndy Whitcroft } 34920a920b5bSAndy Whitcroft } 34930a920b5bSAndy Whitcroft 34949d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 34959d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 34969d3e3c70SJoe Perches my $msg_type = \&WARN; 34979d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 34989d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 34999d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 35009d3e3c70SJoe Perches } 35010a920b5bSAndy Whitcroft 35029d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 35038905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3504000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3505000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 35068905a67cSAndy Whitcroft } 35078905a67cSAndy Whitcroft 350817441227SJoe Perches# check for uses of printk_ratelimit 350917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3510000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3511000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 351217441227SJoe Perches } 351317441227SJoe Perches 351400df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 351500df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 351600df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 351725985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 351800df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3519f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 352000df344fSAndy Whitcroft my $ok = 0; 352100df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 352200df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 352325985edcSLucas De Marchi # we have a preceding printk if it ends 352400df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 352500df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 352600df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 352700df344fSAndy Whitcroft $ok = 1; 352800df344fSAndy Whitcroft } 352900df344fSAndy Whitcroft last; 353000df344fSAndy Whitcroft } 353100df344fSAndy Whitcroft } 353200df344fSAndy Whitcroft if ($ok == 0) { 3533000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3534000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 35350a920b5bSAndy Whitcroft } 353600df344fSAndy Whitcroft } 35370a920b5bSAndy Whitcroft 3538243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3539243f3803SJoe Perches my $orig = $1; 3540243f3803SJoe Perches my $level = lc($orig); 3541243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 35428f26b837SJoe Perches my $level2 = $level; 35438f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3544243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3545daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3546243f3803SJoe Perches } 3547243f3803SJoe Perches 3548243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3549d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3550d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3551d5e616fcSJoe Perches $fix) { 3552194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3553d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3554d5e616fcSJoe Perches } 3555243f3803SJoe Perches } 3556243f3803SJoe Perches 3557dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3558dc139313SJoe Perches my $orig = $1; 3559dc139313SJoe Perches my $level = lc($orig); 3560dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3561dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3562dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3563dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3564dc139313SJoe Perches } 3565dc139313SJoe Perches 356691c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 356791c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 356891c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 356991c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 357091c9afafSAndy Lutomirski WARN("ENOSYS", 357191c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 357291c9afafSAndy Lutomirski } 357391c9afafSAndy Lutomirski 3574653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3575653d4876SAndy Whitcroft# or if closed on same line 35768d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 35774e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 35788d182478SJoe Perches if (ERROR("OPEN_BRACE", 35798d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 35808d182478SJoe Perches $fix) { 35818d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35828d182478SJoe Perches my $fixed_line = $rawline; 35838d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 35848d182478SJoe Perches my $line1 = $1; 35858d182478SJoe Perches my $line2 = $2; 35868d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 35878d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 35888d182478SJoe Perches if ($line2 !~ /^\s*$/) { 35898d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 35908d182478SJoe Perches } 35918d182478SJoe Perches } 35920a920b5bSAndy Whitcroft } 3593653d4876SAndy Whitcroft 35948905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 35958905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 35968905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 35978d182478SJoe Perches if (ERROR("OPEN_BRACE", 35988d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 35998d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 36008d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 36018d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 36028d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 36038d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36048d182478SJoe Perches $fixedline = $rawline; 36058d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 36068d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 36078d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36088d182478SJoe Perches } 36098d182478SJoe Perches } 36108905a67cSAndy Whitcroft } 36118905a67cSAndy Whitcroft 36120c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 36133705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 36143705ce5bSJoe Perches if (WARN("SPACING", 36153705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 36163705ce5bSJoe Perches $fix) { 3617194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36183705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 36193705ce5bSJoe Perches } 36200c73b4ebSAndy Whitcroft } 36210c73b4ebSAndy Whitcroft 362231070b5dSJoe Perches# Function pointer declarations 362331070b5dSJoe Perches# check spacing between type, funcptr, and args 362431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 362591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 362631070b5dSJoe Perches my $declare = $1; 362731070b5dSJoe Perches my $pre_pointer_space = $2; 362831070b5dSJoe Perches my $post_pointer_space = $3; 362931070b5dSJoe Perches my $funcname = $4; 363031070b5dSJoe Perches my $post_funcname_space = $5; 363131070b5dSJoe Perches my $pre_args_space = $6; 363231070b5dSJoe Perches 363391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 363491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 363591f72e9cSJoe Perches# don't need a space so don't warn for those. 363691f72e9cSJoe Perches my $post_declare_space = ""; 363791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 363891f72e9cSJoe Perches $post_declare_space = $1; 363991f72e9cSJoe Perches $declare = rtrim($declare); 364091f72e9cSJoe Perches } 364191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 364231070b5dSJoe Perches WARN("SPACING", 364331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 364491f72e9cSJoe Perches $post_declare_space = " "; 364531070b5dSJoe Perches } 364631070b5dSJoe Perches 364731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 364891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 364991f72e9cSJoe Perches# equivalent to 365091f72e9cSJoe Perches# int foo(int bar, ...) 365191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 365291f72e9cSJoe Perches# 365391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 365491f72e9cSJoe Perches# WARN("SPACING", 365591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 365691f72e9cSJoe Perches# } 365731070b5dSJoe Perches 365831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 365931070b5dSJoe Perches if (defined $pre_pointer_space && 366031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 366131070b5dSJoe Perches WARN("SPACING", 366231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 366331070b5dSJoe Perches } 366431070b5dSJoe Perches 366531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 366631070b5dSJoe Perches if (defined $post_pointer_space && 366731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 366831070b5dSJoe Perches WARN("SPACING", 366931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 367031070b5dSJoe Perches } 367131070b5dSJoe Perches 367231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 367331070b5dSJoe Perches if (defined $post_funcname_space && 367431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 367531070b5dSJoe Perches WARN("SPACING", 367631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 367731070b5dSJoe Perches } 367831070b5dSJoe Perches 367931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 368031070b5dSJoe Perches if (defined $pre_args_space && 368131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 368231070b5dSJoe Perches WARN("SPACING", 368331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 368431070b5dSJoe Perches } 368531070b5dSJoe Perches 368631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3687194f66fcSJoe Perches $fixed[$fixlinenr] =~ 368891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 368931070b5dSJoe Perches } 369031070b5dSJoe Perches } 369131070b5dSJoe Perches 36928d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 36938d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3694fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3695fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 36968d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 36978d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 36988d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3699fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3700daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 37013705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 37023705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 37033705ce5bSJoe Perches $fix) { 3704194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37053705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 37063705ce5bSJoe Perches } 37078d31cfceSAndy Whitcroft } 37088d31cfceSAndy Whitcroft } 37098d31cfceSAndy Whitcroft 3710f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 37116c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3712c2fdda0dSAndy Whitcroft my $name = $1; 3713773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3714773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3715c2fdda0dSAndy Whitcroft 3716c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3717773647a0SAndy Whitcroft if ($name =~ /^(?: 3718773647a0SAndy Whitcroft if|for|while|switch|return|case| 3719773647a0SAndy Whitcroft volatile|__volatile__| 3720773647a0SAndy Whitcroft __attribute__|format|__extension__| 3721773647a0SAndy Whitcroft asm|__asm__)$/x) 3722773647a0SAndy Whitcroft { 3723c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3724c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3725c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3726c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3727773647a0SAndy Whitcroft 3728773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3729c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3730c2fdda0dSAndy Whitcroft 3731c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3732c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3733773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3734c2fdda0dSAndy Whitcroft 3735c2fdda0dSAndy Whitcroft } else { 37363705ce5bSJoe Perches if (WARN("SPACING", 37373705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 37383705ce5bSJoe Perches $fix) { 3739194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37403705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 37413705ce5bSJoe Perches } 3742f0a594c1SAndy Whitcroft } 37436c72ffaaSAndy Whitcroft } 37449a4cad4eSEric Nelson 3745653d4876SAndy Whitcroft# Check operator spacing. 37460a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 37473705ce5bSJoe Perches my $fixed_line = ""; 37483705ce5bSJoe Perches my $line_fixed = 0; 37493705ce5bSJoe Perches 37509c0ca6f9SAndy Whitcroft my $ops = qr{ 37519c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 37529c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 37539c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 37541f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 375584731623SJoe Perches \?:|\?|: 37569c0ca6f9SAndy Whitcroft }x; 3757cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 37583705ce5bSJoe Perches 37593705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 37603705ce5bSJoe Perches## foreach my $el (@elements) { 37613705ce5bSJoe Perches## print("el: <$el>\n"); 37623705ce5bSJoe Perches## } 37633705ce5bSJoe Perches 37643705ce5bSJoe Perches my @fix_elements = (); 376500df344fSAndy Whitcroft my $off = 0; 37666c72ffaaSAndy Whitcroft 37673705ce5bSJoe Perches foreach my $el (@elements) { 37683705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 37693705ce5bSJoe Perches $off += length($el); 37703705ce5bSJoe Perches } 37713705ce5bSJoe Perches 37723705ce5bSJoe Perches $off = 0; 37733705ce5bSJoe Perches 37746c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3775b34c648bSJoe Perches my $last_after = -1; 37766c72ffaaSAndy Whitcroft 37770a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 37783705ce5bSJoe Perches 37793705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 37803705ce5bSJoe Perches 37813705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 37823705ce5bSJoe Perches 37834a0df2efSAndy Whitcroft $off += length($elements[$n]); 37844a0df2efSAndy Whitcroft 378525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3786773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3787773647a0SAndy Whitcroft my $cc = ''; 3788773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3789773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3790773647a0SAndy Whitcroft } 3791773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3792773647a0SAndy Whitcroft 37934a0df2efSAndy Whitcroft my $a = ''; 37944a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 37954a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3796cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 37974a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 37984a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3799773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 38004a0df2efSAndy Whitcroft 38010a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 38024a0df2efSAndy Whitcroft 38034a0df2efSAndy Whitcroft my $c = ''; 38040a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 38054a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 38064a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3807cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 38084a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 38094a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 38108b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 38114a0df2efSAndy Whitcroft } else { 38124a0df2efSAndy Whitcroft $c = 'E'; 38130a920b5bSAndy Whitcroft } 38140a920b5bSAndy Whitcroft 38154a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 38164a0df2efSAndy Whitcroft 38174a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 38184a0df2efSAndy Whitcroft 38196c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3820de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 38210a920b5bSAndy Whitcroft 382274048ed8SAndy Whitcroft # Pull out the value of this operator. 38236c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 38240a920b5bSAndy Whitcroft 38251f65f947SAndy Whitcroft # Get the full operator variant. 38261f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 38271f65f947SAndy Whitcroft 382813214adfSAndy Whitcroft # Ignore operators passed as parameters. 382913214adfSAndy Whitcroft if ($op_type ne 'V' && 3830d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 383113214adfSAndy Whitcroft 3832cf655043SAndy Whitcroft# # Ignore comments 3833cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 383413214adfSAndy Whitcroft 3835d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 383613214adfSAndy Whitcroft } elsif ($op eq ';') { 3837cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3838cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 38393705ce5bSJoe Perches if (ERROR("SPACING", 38403705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3841b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38423705ce5bSJoe Perches $line_fixed = 1; 38433705ce5bSJoe Perches } 3844d8aaf121SAndy Whitcroft } 3845d8aaf121SAndy Whitcroft 3846d8aaf121SAndy Whitcroft # // is a comment 3847d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 38480a920b5bSAndy Whitcroft 3849b00e4814SJoe Perches # : when part of a bitfield 3850b00e4814SJoe Perches } elsif ($opv eq ':B') { 3851b00e4814SJoe Perches # skip the bitfield test for now 3852b00e4814SJoe Perches 38531f65f947SAndy Whitcroft # No spaces for: 38541f65f947SAndy Whitcroft # -> 3855b00e4814SJoe Perches } elsif ($op eq '->') { 38564a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 38573705ce5bSJoe Perches if (ERROR("SPACING", 38583705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3859b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38603705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38613705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38623705ce5bSJoe Perches } 3863b34c648bSJoe Perches $line_fixed = 1; 38643705ce5bSJoe Perches } 38650a920b5bSAndy Whitcroft } 38660a920b5bSAndy Whitcroft 38672381097bSJoe Perches # , must not have a space before and must have a space on the right. 38680a920b5bSAndy Whitcroft } elsif ($op eq ',') { 38692381097bSJoe Perches my $rtrim_before = 0; 38702381097bSJoe Perches my $space_after = 0; 38712381097bSJoe Perches if ($ctx =~ /Wx./) { 38722381097bSJoe Perches if (ERROR("SPACING", 38732381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 38742381097bSJoe Perches $line_fixed = 1; 38752381097bSJoe Perches $rtrim_before = 1; 38762381097bSJoe Perches } 38772381097bSJoe Perches } 3878cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 38793705ce5bSJoe Perches if (ERROR("SPACING", 38803705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 38813705ce5bSJoe Perches $line_fixed = 1; 3882b34c648bSJoe Perches $last_after = $n; 38832381097bSJoe Perches $space_after = 1; 38842381097bSJoe Perches } 38852381097bSJoe Perches } 38862381097bSJoe Perches if ($rtrim_before || $space_after) { 38872381097bSJoe Perches if ($rtrim_before) { 38882381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38892381097bSJoe Perches } else { 38902381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38912381097bSJoe Perches } 38922381097bSJoe Perches if ($space_after) { 38932381097bSJoe Perches $good .= " "; 38943705ce5bSJoe Perches } 38950a920b5bSAndy Whitcroft } 38960a920b5bSAndy Whitcroft 38979c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 389874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 38999c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 39009c0ca6f9SAndy Whitcroft 39019c0ca6f9SAndy Whitcroft # unary operators should have a space before and 39029c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 39039c0ca6f9SAndy Whitcroft # unary operator, or a cast 39049c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 390574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 39060d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3907cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 39083705ce5bSJoe Perches if (ERROR("SPACING", 39093705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3910b34c648bSJoe Perches if ($n != $last_after + 2) { 3911b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 39123705ce5bSJoe Perches $line_fixed = 1; 39133705ce5bSJoe Perches } 39140a920b5bSAndy Whitcroft } 3915b34c648bSJoe Perches } 3916a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3917171ae1a4SAndy Whitcroft # A unary '*' may be const 3918171ae1a4SAndy Whitcroft 3919171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 39203705ce5bSJoe Perches if (ERROR("SPACING", 39213705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3922b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 39233705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39243705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 39253705ce5bSJoe Perches } 3926b34c648bSJoe Perches $line_fixed = 1; 39273705ce5bSJoe Perches } 39280a920b5bSAndy Whitcroft } 39290a920b5bSAndy Whitcroft 39300a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 39310a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3932773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 39333705ce5bSJoe Perches if (ERROR("SPACING", 39343705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3935b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39363705ce5bSJoe Perches $line_fixed = 1; 39373705ce5bSJoe Perches } 39380a920b5bSAndy Whitcroft } 3939773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3940773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 39413705ce5bSJoe Perches if (ERROR("SPACING", 39423705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3943b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39443705ce5bSJoe Perches $line_fixed = 1; 39453705ce5bSJoe Perches } 3946653d4876SAndy Whitcroft } 3947773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 39483705ce5bSJoe Perches if (ERROR("SPACING", 39493705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3950b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39513705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39523705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3953773647a0SAndy Whitcroft } 3954b34c648bSJoe Perches $line_fixed = 1; 39553705ce5bSJoe Perches } 39563705ce5bSJoe Perches } 39570a920b5bSAndy Whitcroft 39580a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 39599c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 39609c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 39619c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3962c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3963c2fdda0dSAndy Whitcroft $op eq '%') 39640a920b5bSAndy Whitcroft { 3965d2e025f3SJoe Perches if ($check) { 3966d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3967d2e025f3SJoe Perches if (CHK("SPACING", 3968d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3969d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3970d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3971d2e025f3SJoe Perches $line_fixed = 1; 3972d2e025f3SJoe Perches } 3973d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3974d2e025f3SJoe Perches if (CHK("SPACING", 3975d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3976d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3977d2e025f3SJoe Perches $line_fixed = 1; 3978d2e025f3SJoe Perches } 3979d2e025f3SJoe Perches } 3980d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 39813705ce5bSJoe Perches if (ERROR("SPACING", 39823705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3983b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3984b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3985b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3986b34c648bSJoe Perches } 39873705ce5bSJoe Perches $line_fixed = 1; 39883705ce5bSJoe Perches } 39890a920b5bSAndy Whitcroft } 39900a920b5bSAndy Whitcroft 39911f65f947SAndy Whitcroft # A colon needs no spaces before when it is 39921f65f947SAndy Whitcroft # terminating a case value or a label. 39931f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 39941f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 39953705ce5bSJoe Perches if (ERROR("SPACING", 39963705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3997b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39983705ce5bSJoe Perches $line_fixed = 1; 39993705ce5bSJoe Perches } 40001f65f947SAndy Whitcroft } 40011f65f947SAndy Whitcroft 40020a920b5bSAndy Whitcroft # All the others need spaces both sides. 4003cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 40041f65f947SAndy Whitcroft my $ok = 0; 40051f65f947SAndy Whitcroft 400622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 40071f65f947SAndy Whitcroft if (($op eq '<' && 40081f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 40091f65f947SAndy Whitcroft ($op eq '>' && 40101f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 40111f65f947SAndy Whitcroft { 40121f65f947SAndy Whitcroft $ok = 1; 40131f65f947SAndy Whitcroft } 40141f65f947SAndy Whitcroft 4015e0df7e1fSJoe Perches # for asm volatile statements 4016e0df7e1fSJoe Perches # ignore a colon with another 4017e0df7e1fSJoe Perches # colon immediately before or after 4018e0df7e1fSJoe Perches if (($op eq ':') && 4019e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4020e0df7e1fSJoe Perches $ok = 1; 4021e0df7e1fSJoe Perches } 4022e0df7e1fSJoe Perches 402384731623SJoe Perches # messages are ERROR, but ?: are CHK 40241f65f947SAndy Whitcroft if ($ok == 0) { 402584731623SJoe Perches my $msg_type = \&ERROR; 402684731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 402784731623SJoe Perches 402884731623SJoe Perches if (&{$msg_type}("SPACING", 40293705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4030b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4031b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4032b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4033b34c648bSJoe Perches } 40343705ce5bSJoe Perches $line_fixed = 1; 40353705ce5bSJoe Perches } 40360a920b5bSAndy Whitcroft } 403722f2a2efSAndy Whitcroft } 40384a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 40393705ce5bSJoe Perches 40403705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 40413705ce5bSJoe Perches 40423705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 40430a920b5bSAndy Whitcroft } 40443705ce5bSJoe Perches 40453705ce5bSJoe Perches if (($#elements % 2) == 0) { 40463705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 40473705ce5bSJoe Perches } 40483705ce5bSJoe Perches 4049194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4050194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 40513705ce5bSJoe Perches } 40523705ce5bSJoe Perches 40533705ce5bSJoe Perches 40540a920b5bSAndy Whitcroft } 40550a920b5bSAndy Whitcroft 4056786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4057d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4058786b6326SJoe Perches if (WARN("SPACING", 4059786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4060786b6326SJoe Perches $fix) { 4061194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4062786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4063786b6326SJoe Perches } 4064786b6326SJoe Perches } 4065786b6326SJoe Perches 4066f0a594c1SAndy Whitcroft# check for multiple assignments 4067f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4068000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4069000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4070f0a594c1SAndy Whitcroft } 4071f0a594c1SAndy Whitcroft 407222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 407322f2a2efSAndy Whitcroft## # continuation. 407422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 407522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 407622f2a2efSAndy Whitcroft## 407722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 407822f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 407922f2a2efSAndy Whitcroft## my $ln = $line; 408022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 408122f2a2efSAndy Whitcroft## } 408222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4083000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4084000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 408522f2a2efSAndy Whitcroft## } 408622f2a2efSAndy Whitcroft## } 4087f0a594c1SAndy Whitcroft 40880a920b5bSAndy Whitcroft#need space before brace following if, while, etc 40894e5d56bdSEddie Kovsky if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\){/) || 40904e5d56bdSEddie Kovsky $line =~ /do\{/) { 40913705ce5bSJoe Perches if (ERROR("SPACING", 40923705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 40933705ce5bSJoe Perches $fix) { 4094194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 40953705ce5bSJoe Perches } 4096de7d4f0eSAndy Whitcroft } 4097de7d4f0eSAndy Whitcroft 4098c4a62ef9SJoe Perches## # check for blank lines before declarations 4099c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4100c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4101c4a62ef9SJoe Perches## WARN("SPACING", 4102c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4103c4a62ef9SJoe Perches## } 4104c4a62ef9SJoe Perches## 4105c4a62ef9SJoe Perches 4106de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4107de7d4f0eSAndy Whitcroft# on the line 4108de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4109d5e616fcSJoe Perches if (ERROR("SPACING", 4110d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4111d5e616fcSJoe Perches $fix) { 4112194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4113d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4114d5e616fcSJoe Perches } 41150a920b5bSAndy Whitcroft } 41160a920b5bSAndy Whitcroft 411722f2a2efSAndy Whitcroft# check spacing on square brackets 411822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 41193705ce5bSJoe Perches if (ERROR("SPACING", 41203705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 41213705ce5bSJoe Perches $fix) { 4122194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41233705ce5bSJoe Perches s/\[\s+/\[/; 41243705ce5bSJoe Perches } 412522f2a2efSAndy Whitcroft } 412622f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 41273705ce5bSJoe Perches if (ERROR("SPACING", 41283705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 41293705ce5bSJoe Perches $fix) { 4130194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41313705ce5bSJoe Perches s/\s+\]/\]/; 41323705ce5bSJoe Perches } 413322f2a2efSAndy Whitcroft } 413422f2a2efSAndy Whitcroft 4135c45dcabdSAndy Whitcroft# check spacing on parentheses 41369c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 41379c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 41383705ce5bSJoe Perches if (ERROR("SPACING", 41393705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 41403705ce5bSJoe Perches $fix) { 4141194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41423705ce5bSJoe Perches s/\(\s+/\(/; 41433705ce5bSJoe Perches } 414422f2a2efSAndy Whitcroft } 414513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4146c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4147c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 41483705ce5bSJoe Perches if (ERROR("SPACING", 41493705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 41503705ce5bSJoe Perches $fix) { 4151194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41523705ce5bSJoe Perches s/\s+\)/\)/; 41533705ce5bSJoe Perches } 415422f2a2efSAndy Whitcroft } 415522f2a2efSAndy Whitcroft 4156e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4157e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4158e2826fd0SJoe Perches 4159e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4160ea4acbb1SJoe Perches my $var = $1; 4161ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4162ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4163ea4acbb1SJoe Perches $fix) { 4164ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4165ea4acbb1SJoe Perches } 4166ea4acbb1SJoe Perches } 4167ea4acbb1SJoe Perches 4168ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4169ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4170ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4171ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4172ea4acbb1SJoe Perches my $var = $2; 4173ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4174ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4175ea4acbb1SJoe Perches $fix) { 4176ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4177ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4178ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4179ea4acbb1SJoe Perches } 4180e2826fd0SJoe Perches } 4181e2826fd0SJoe Perches 41820a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 41834a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 41840a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 41853705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 41863705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 41873705ce5bSJoe Perches $fix) { 4188194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41893705ce5bSJoe Perches s/^(.)\s+/$1/; 41903705ce5bSJoe Perches } 41910a920b5bSAndy Whitcroft } 41920a920b5bSAndy Whitcroft 41935b9553abSJoe Perches# return is not a function 4194507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4195c45dcabdSAndy Whitcroft my $spacing = $1; 4196507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 41975b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 41985b9553abSJoe Perches my $value = $1; 41995b9553abSJoe Perches $value = deparenthesize($value); 42005b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4201000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4202000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 42035b9553abSJoe Perches } 4204c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4205000d1cc1SJoe Perches ERROR("SPACING", 4206000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4207c45dcabdSAndy Whitcroft } 4208c45dcabdSAndy Whitcroft } 4209507e5141SJoe Perches 4210b43ae21bSJoe Perches# unnecessary return in a void function 4211b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4212b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4213b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4214b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4215b43ae21bSJoe Perches $linenr >= 3 && 4216b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4217b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 42189819cf25SJoe Perches WARN("RETURN_VOID", 4219b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 42209819cf25SJoe Perches } 42219819cf25SJoe Perches 4222189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4223189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4224189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4225189248d8SJoe Perches my $openparens = $1; 4226189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4227189248d8SJoe Perches my $msg = ""; 4228189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4229189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4230189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4231189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4232189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4233189248d8SJoe Perches } 4234189248d8SJoe Perches } 4235189248d8SJoe Perches 4236c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left 4237c5595fa2SJoe Perches# avoid cases like "foo + BAR < baz" 4238c5595fa2SJoe Perches# only fix matches surrounded by parentheses to avoid incorrect 4239c5595fa2SJoe Perches# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 4240c5595fa2SJoe Perches if ($^V && $^V ge 5.10.0 && 4241c5595fa2SJoe Perches $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 4242c5595fa2SJoe Perches my $lead = $1; 4243c5595fa2SJoe Perches my $const = $2; 4244c5595fa2SJoe Perches my $comp = $3; 4245c5595fa2SJoe Perches my $to = $4; 4246c5595fa2SJoe Perches my $newcomp = $comp; 4247c5595fa2SJoe Perches if ($lead !~ /$Operators\s*$/ && 4248c5595fa2SJoe Perches $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 4249c5595fa2SJoe Perches WARN("CONSTANT_COMPARISON", 4250c5595fa2SJoe Perches "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 4251c5595fa2SJoe Perches $fix) { 4252c5595fa2SJoe Perches if ($comp eq "<") { 4253c5595fa2SJoe Perches $newcomp = ">"; 4254c5595fa2SJoe Perches } elsif ($comp eq "<=") { 4255c5595fa2SJoe Perches $newcomp = ">="; 4256c5595fa2SJoe Perches } elsif ($comp eq ">") { 4257c5595fa2SJoe Perches $newcomp = "<"; 4258c5595fa2SJoe Perches } elsif ($comp eq ">=") { 4259c5595fa2SJoe Perches $newcomp = "<="; 4260c5595fa2SJoe Perches } 4261c5595fa2SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 4262c5595fa2SJoe Perches } 4263c5595fa2SJoe Perches } 4264c5595fa2SJoe Perches 4265f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4266f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 426753a3c448SAndy Whitcroft my $name = $1; 426853a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4269000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4270f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 427153a3c448SAndy Whitcroft } 427253a3c448SAndy Whitcroft } 4273c45dcabdSAndy Whitcroft 42740a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 42754a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 42763705ce5bSJoe Perches if (ERROR("SPACING", 42773705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 42783705ce5bSJoe Perches $fix) { 4279194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42803705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 42813705ce5bSJoe Perches } 42820a920b5bSAndy Whitcroft } 42830a920b5bSAndy Whitcroft 4284f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4285f5fe35ddSAndy Whitcroft# statements after the conditional. 4286170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 42873e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 42883e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 42893e469cdcSAndy Whitcroft if (!defined $stat); 4290170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4291170d3a22SAndy Whitcroft $remain_next, $off_next); 4292170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4293170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4294170d3a22SAndy Whitcroft 4295170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4296170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4297170d3a22SAndy Whitcroft # then count those as offsets. 4298170d3a22SAndy Whitcroft my ($whitespace) = 4299170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4300170d3a22SAndy Whitcroft my $offset = 4301170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4302170d3a22SAndy Whitcroft 4303170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4304170d3a22SAndy Whitcroft $offset} = 1; 4305170d3a22SAndy Whitcroft } 4306170d3a22SAndy Whitcroft } 4307170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4308c11230f4SJoe Perches defined($stat) && defined($cond) && 4309170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4310171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 43118905a67cSAndy Whitcroft 4312b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4313000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4314000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 43158905a67cSAndy Whitcroft } 43168905a67cSAndy Whitcroft 43178905a67cSAndy Whitcroft # Find out what is on the end of the line after the 43188905a67cSAndy Whitcroft # conditional. 4319773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 43208905a67cSAndy Whitcroft $s =~ s/\n.*//g; 432113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 432253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 432353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4324773647a0SAndy Whitcroft { 4325bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4326bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4327bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 432842bdf74cSHidetoshi Seto my $stat_real = ''; 4329bb44ad39SAndy Whitcroft 433042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 433142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4332bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4333bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4334bb44ad39SAndy Whitcroft } 4335bb44ad39SAndy Whitcroft 4336000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4337000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 43388905a67cSAndy Whitcroft } 43398905a67cSAndy Whitcroft } 43408905a67cSAndy Whitcroft 434113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 434213214adfSAndy Whitcroft if ($line =~ / 434313214adfSAndy Whitcroft (?: 434413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 434513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 434613214adfSAndy Whitcroft (?:\&\&|\|\|) 434713214adfSAndy Whitcroft | 434813214adfSAndy Whitcroft (?:\&\&|\|\|) 434913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 435013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 435113214adfSAndy Whitcroft )/x) 435213214adfSAndy Whitcroft { 4353000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4354000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 435513214adfSAndy Whitcroft } 435613214adfSAndy Whitcroft 43578905a67cSAndy Whitcroft# if and else should not have general statements after it 435813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 435913214adfSAndy Whitcroft my $s = $1; 436013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 436113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4362000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4363000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 43640a920b5bSAndy Whitcroft } 436513214adfSAndy Whitcroft } 436639667782SAndy Whitcroft# if should not continue a brace 436739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4368000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4369048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 437039667782SAndy Whitcroft $herecurr); 437139667782SAndy Whitcroft } 4372a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4373a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4374a1080bf8SAndy Whitcroft $line !~ /\G(?: 43753fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4376a1080bf8SAndy Whitcroft \s*return\s+ 4377a1080bf8SAndy Whitcroft )/xg) 4378a1080bf8SAndy Whitcroft { 4379000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4380000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4381a1080bf8SAndy Whitcroft } 43820a920b5bSAndy Whitcroft 43830a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 43840a920b5bSAndy Whitcroft # indent level to be relevant to each other. 43858b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 43860a920b5bSAndy Whitcroft $previndent == $indent) { 43878b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 43888b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 43898b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43908b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43918b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43928b8856f4SJoe Perches my $fixedline = $prevrawline; 43938b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 43948b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 43958b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43968b8856f4SJoe Perches } 43978b8856f4SJoe Perches $fixedline = $rawline; 43988b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 43998b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44008b8856f4SJoe Perches } 44010a920b5bSAndy Whitcroft } 44020a920b5bSAndy Whitcroft 44038b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4404c2fdda0dSAndy Whitcroft $previndent == $indent) { 4405c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4406c2fdda0dSAndy Whitcroft 4407c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4408c2fdda0dSAndy Whitcroft # conditional. 4409773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4410c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4411c2fdda0dSAndy Whitcroft 4412c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 44138b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 44148b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 44158b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 44168b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 44178b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 44188b8856f4SJoe Perches my $fixedline = $prevrawline; 44198b8856f4SJoe Perches my $trailing = $rawline; 44208b8856f4SJoe Perches $trailing =~ s/^\+//; 44218b8856f4SJoe Perches $trailing = trim($trailing); 44228b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 44238b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 44248b8856f4SJoe Perches } 4425c2fdda0dSAndy Whitcroft } 4426c2fdda0dSAndy Whitcroft } 4427c2fdda0dSAndy Whitcroft 442895e2c602SJoe Perches#Specific variable tests 4429323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4430323c1260SJoe Perches my $var = $1; 443195e2c602SJoe Perches 443295e2c602SJoe Perches#gcc binary extension 443395e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4434d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4435d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4436d5e616fcSJoe Perches $fix) { 4437d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4438194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4439d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4440d5e616fcSJoe Perches } 444195e2c602SJoe Perches } 444295e2c602SJoe Perches 444395e2c602SJoe Perches#CamelCase 4444807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4445be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 444622735ce8SJoe Perches#Ignore Page<foo> variants 4447807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 444822735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4449f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4450f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4451f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 44527e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 44537e781f67SJoe Perches my $word = $1; 44547e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4455d8b07710SJoe Perches if ($check) { 4456d8b07710SJoe Perches seed_camelcase_includes(); 4457d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4458d8b07710SJoe Perches seed_camelcase_file($realfile); 4459d8b07710SJoe Perches $camelcase_file_seeded = 1; 4460d8b07710SJoe Perches } 4461d8b07710SJoe Perches } 44627e781f67SJoe Perches if (!defined $camelcase{$word}) { 44637e781f67SJoe Perches $camelcase{$word} = 1; 4464be79794bSJoe Perches CHK("CAMELCASE", 44657e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 44667e781f67SJoe Perches } 4467323c1260SJoe Perches } 4468323c1260SJoe Perches } 44693445686aSJoe Perches } 44700a920b5bSAndy Whitcroft 44710a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4472d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4473d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4474d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4475d5e616fcSJoe Perches $fix) { 4476194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4477d5e616fcSJoe Perches } 44780a920b5bSAndy Whitcroft } 44790a920b5bSAndy Whitcroft 44800e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 44810e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4482c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4483e09dec48SAndy Whitcroft my $file = "$1.h"; 4484e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4485e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4486e09dec48SAndy Whitcroft $realfile ne $checkfile && 44877840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4488c45dcabdSAndy Whitcroft { 44890e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 44900e212e0aSFabian Frederick if ($asminclude > 0) { 4491e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4492000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4493000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4494e09dec48SAndy Whitcroft } else { 4495000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4496000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4497e09dec48SAndy Whitcroft } 44980a920b5bSAndy Whitcroft } 44990a920b5bSAndy Whitcroft } 45000e212e0aSFabian Frederick } 45010a920b5bSAndy Whitcroft 4502653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4503653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4504cf655043SAndy Whitcroft# in a known good container 4505b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4506b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4507d8aaf121SAndy Whitcroft my $ln = $linenr; 4508d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4509c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4510c45dcabdSAndy Whitcroft my $ctx = ''; 451108a2843eSJoe Perches my $has_flow_statement = 0; 451208a2843eSJoe Perches my $has_arg_concat = 0; 4513c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4514f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4515f74bd194SAndy Whitcroft $ctx = $dstat; 4516c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4517a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4518c45dcabdSAndy Whitcroft 451908a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 452008a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 452108a2843eSJoe Perches 4522f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4523292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4524c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4525c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4526c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4527c45dcabdSAndy Whitcroft 4528c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4529bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4530bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4531c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4532bf30d6edSAndy Whitcroft { 4533c45dcabdSAndy Whitcroft } 4534c45dcabdSAndy Whitcroft 4535e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 453633acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 453733acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4538e45bab8eSAndy Whitcroft { 4539e45bab8eSAndy Whitcroft } 4540e45bab8eSAndy Whitcroft 4541c45dcabdSAndy Whitcroft my $exceptions = qr{ 4542c45dcabdSAndy Whitcroft $Declare| 4543c45dcabdSAndy Whitcroft module_param_named| 4544a0a0a7a9SKees Cook MODULE_PARM_DESC| 4545c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4546c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4547383099fdSAndy Whitcroft __typeof__\(| 454822fd2d3eSStefani Seibold union| 454922fd2d3eSStefani Seibold struct| 4550ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4551ea71a0a0SAndy Whitcroft ^\"|\"$ 4552c45dcabdSAndy Whitcroft }x; 45535eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4554f74bd194SAndy Whitcroft if ($dstat ne '' && 4555f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4556f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 45573cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4558356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4559f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4560f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4561e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 456272f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4563f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4564f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4565f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 45664e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4567f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4568c45dcabdSAndy Whitcroft { 4569f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4570f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4571f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4572f74bd194SAndy Whitcroft 4573f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4574f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4575c45dcabdSAndy Whitcroft } 4576c45dcabdSAndy Whitcroft 4577f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4578f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4579f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4580f74bd194SAndy Whitcroft } else { 4581000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4582388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4583d8aaf121SAndy Whitcroft } 45840a920b5bSAndy Whitcroft } 45855023d347SJoe Perches 458608a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 458708a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 458808a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 458908a2843eSJoe Perches my $herectx = $here . "\n"; 459008a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 459108a2843eSJoe Perches 459208a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 459308a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 459408a2843eSJoe Perches } 459508a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 459608a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 459708a2843eSJoe Perches } 459808a2843eSJoe Perches 4599481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 46005023d347SJoe Perches 46015023d347SJoe Perches } else { 46025023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4603481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4604481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 46055023d347SJoe Perches $line =~ /^\+.*\\$/) { 46065023d347SJoe Perches WARN("LINE_CONTINUATIONS", 46075023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 46085023d347SJoe Perches } 4609653d4876SAndy Whitcroft } 46100a920b5bSAndy Whitcroft 4611b13edf7fSJoe Perches# do {} while (0) macro tests: 4612b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4613b13edf7fSJoe Perches# macro should not end with a semicolon 4614b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4615b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4616b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4617b13edf7fSJoe Perches my $ln = $linenr; 4618b13edf7fSJoe Perches my $cnt = $realcnt; 4619b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4620b13edf7fSJoe Perches my $ctx = ''; 4621b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4622b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4623b13edf7fSJoe Perches $ctx = $dstat; 4624b13edf7fSJoe Perches 4625b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 46261b36b201SJoe Perches $dstat =~ s/$;/ /g; 4627b13edf7fSJoe Perches 4628b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4629b13edf7fSJoe Perches my $stmts = $2; 4630b13edf7fSJoe Perches my $semis = $3; 4631b13edf7fSJoe Perches 4632b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4633b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4634b13edf7fSJoe Perches my $herectx = $here . "\n"; 4635b13edf7fSJoe Perches 4636b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4637b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4638b13edf7fSJoe Perches } 4639b13edf7fSJoe Perches 4640ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4641ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4642b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4643b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4644b13edf7fSJoe Perches } 4645b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4646b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4647b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4648b13edf7fSJoe Perches } 4649f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4650f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4651f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4652f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4653f5ef95b1SJoe Perches 4654f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4655f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4656f5ef95b1SJoe Perches } 4657f5ef95b1SJoe Perches 4658f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4659f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4660b13edf7fSJoe Perches } 4661b13edf7fSJoe Perches } 4662b13edf7fSJoe Perches 4663080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4664080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4665080ba929SMike Frysinger# . 4666080ba929SMike Frysinger# ALIGN(...) 4667080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4668080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4669000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4670000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4671080ba929SMike Frysinger } 4672080ba929SMike Frysinger 4673f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 467413214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 467513214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4676cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 467713214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4678cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4679cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4680aad4f614SJoe Perches my @allowed = (); 4681aad4f614SJoe Perches my $allow = 0; 468213214adfSAndy Whitcroft my $seen = 0; 4683773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4684cf655043SAndy Whitcroft my $ln = $linenr - 1; 468513214adfSAndy Whitcroft for my $chunk (@chunks) { 468613214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 468713214adfSAndy Whitcroft 4688773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4689773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4690773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4691773647a0SAndy Whitcroft 4692aad4f614SJoe Perches $allowed[$allow] = 0; 4693773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4694773647a0SAndy Whitcroft 4695773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4696773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4697773647a0SAndy Whitcroft 4698773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4699cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4700cf655043SAndy Whitcroft 4701773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 470213214adfSAndy Whitcroft 470313214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 470413214adfSAndy Whitcroft 4705aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4706cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4707cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4708aad4f614SJoe Perches $allowed[$allow] = 1; 470913214adfSAndy Whitcroft } 471013214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4711cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4712aad4f614SJoe Perches $allowed[$allow] = 1; 471313214adfSAndy Whitcroft } 4714cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4715cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4716aad4f614SJoe Perches $allowed[$allow] = 1; 471713214adfSAndy Whitcroft } 4718aad4f614SJoe Perches $allow++; 471913214adfSAndy Whitcroft } 4720aad4f614SJoe Perches if ($seen) { 4721aad4f614SJoe Perches my $sum_allowed = 0; 4722aad4f614SJoe Perches foreach (@allowed) { 4723aad4f614SJoe Perches $sum_allowed += $_; 4724aad4f614SJoe Perches } 4725aad4f614SJoe Perches if ($sum_allowed == 0) { 4726000d1cc1SJoe Perches WARN("BRACES", 4727000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4728aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4729aad4f614SJoe Perches $seen != $allow) { 4730aad4f614SJoe Perches CHK("BRACES", 4731aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4732aad4f614SJoe Perches } 473313214adfSAndy Whitcroft } 473413214adfSAndy Whitcroft } 473513214adfSAndy Whitcroft } 4736773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 473713214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4738cf655043SAndy Whitcroft my $allowed = 0; 4739f0a594c1SAndy Whitcroft 4740cf655043SAndy Whitcroft # Check the pre-context. 4741cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4742cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4743cf655043SAndy Whitcroft $allowed = 1; 4744f0a594c1SAndy Whitcroft } 4745773647a0SAndy Whitcroft 4746773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4747773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4748773647a0SAndy Whitcroft 4749cf655043SAndy Whitcroft # Check the condition. 4750cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4751773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4752cf655043SAndy Whitcroft if (defined $cond) { 4753773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4754cf655043SAndy Whitcroft } 4755cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4756cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4757cf655043SAndy Whitcroft $allowed = 1; 4758cf655043SAndy Whitcroft } 4759cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4760cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4761cf655043SAndy Whitcroft $allowed = 1; 4762cf655043SAndy Whitcroft } 4763cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4764cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4765cf655043SAndy Whitcroft $allowed = 1; 4766cf655043SAndy Whitcroft } 4767cf655043SAndy Whitcroft # Check the post-context. 4768cf655043SAndy Whitcroft if (defined $chunks[1]) { 4769cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4770cf655043SAndy Whitcroft if (defined $cond) { 4771773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4772cf655043SAndy Whitcroft } 4773cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4774cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4775cf655043SAndy Whitcroft $allowed = 1; 4776cf655043SAndy Whitcroft } 4777cf655043SAndy Whitcroft } 4778cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 477969932487SJustin P. Mattock my $herectx = $here . "\n"; 4780f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4781cf655043SAndy Whitcroft 4782f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 478369932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4784cf655043SAndy Whitcroft } 4785cf655043SAndy Whitcroft 4786000d1cc1SJoe Perches WARN("BRACES", 4787000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4788f0a594c1SAndy Whitcroft } 4789f0a594c1SAndy Whitcroft } 4790f0a594c1SAndy Whitcroft 47910979ae66SJoe Perches# check for unnecessary blank lines around braces 479277b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4793f8e58219SJoe Perches if (CHK("BRACES", 4794f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4795f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4796f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4797f8e58219SJoe Perches } 47980979ae66SJoe Perches } 479977b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4800f8e58219SJoe Perches if (CHK("BRACES", 4801f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4802f8e58219SJoe Perches $fix) { 4803f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4804f8e58219SJoe Perches } 48050979ae66SJoe Perches } 48060979ae66SJoe Perches 48074a0df2efSAndy Whitcroft# no volatiles please 48086c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 48096c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4810000d1cc1SJoe Perches WARN("VOLATILE", 4811000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 48124a0df2efSAndy Whitcroft } 48134a0df2efSAndy Whitcroft 48145e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 48155e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 48165e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 48175e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 481833acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 48195e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 48205e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 48215e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 48225e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 48235e4f6ba5SJoe Perches $fix && 48245e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 48255e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 48265e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 48275e4f6ba5SJoe Perches my $comma_close = ""; 48285e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 48295e4f6ba5SJoe Perches $comma_close = $1; 48305e4f6ba5SJoe Perches } 48315e4f6ba5SJoe Perches 48325e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48335e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 48345e4f6ba5SJoe Perches my $fixedline = $prevrawline; 48355e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 48365e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 48375e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 48385e4f6ba5SJoe Perches $fixedline = $rawline; 48395e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 48405e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 48415e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48425e4f6ba5SJoe Perches } 48435e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 48445e4f6ba5SJoe Perches } 48455e4f6ba5SJoe Perches } 48465e4f6ba5SJoe Perches 48475e4f6ba5SJoe Perches# check for missing a space in a string concatenation 48485e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 48495e4f6ba5SJoe Perches WARN('MISSING_SPACE', 48505e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 48515e4f6ba5SJoe Perches } 48525e4f6ba5SJoe Perches 48535e4f6ba5SJoe Perches# check for spaces before a quoted newline 48545e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 48555e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 48565e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 48575e4f6ba5SJoe Perches $fix) { 48585e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 48595e4f6ba5SJoe Perches } 48605e4f6ba5SJoe Perches 48615e4f6ba5SJoe Perches } 48625e4f6ba5SJoe Perches 4863f17dba4fSJoe Perches# concatenated string without spaces between elements 486433acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4865f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4866f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4867f17dba4fSJoe Perches } 4868f17dba4fSJoe Perches 486990ad30e5SJoe Perches# uncoalesced string fragments 487033acb54aSJoe Perches if ($line =~ /$String\s*"/) { 487190ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 487290ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 487390ad30e5SJoe Perches } 487490ad30e5SJoe Perches 48756e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 48765e4f6ba5SJoe Perches my $string; 48775e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 48785e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 48795e4f6ba5SJoe Perches $string =~ s/%%/__/g; 48806e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 48815e4f6ba5SJoe Perches WARN("PRINTF_L", 48825e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 48835e4f6ba5SJoe Perches last; 48845e4f6ba5SJoe Perches } 48856e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 48866e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 48876e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 48886e300757SJoe Perches } 48895e4f6ba5SJoe Perches } 48905e4f6ba5SJoe Perches 48915e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 48925e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 48935e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 48945e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 48955e4f6ba5SJoe Perches } 48965e4f6ba5SJoe Perches 489700df344fSAndy Whitcroft# warn about #if 0 4898c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4899000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4900000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4901de7d4f0eSAndy Whitcroft $herecurr); 49024a0df2efSAndy Whitcroft } 49034a0df2efSAndy Whitcroft 490403df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 490503df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 4906100425deSJoe Perches my $tested = quotemeta($1); 4907100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 4908100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 4909100425deSJoe Perches my $func = $1; 4910100425deSJoe Perches if (WARN('NEEDLESS_IF', 4911100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 4912100425deSJoe Perches $fix) { 4913100425deSJoe Perches my $do_fix = 1; 4914100425deSJoe Perches my $leading_tabs = ""; 4915100425deSJoe Perches my $new_leading_tabs = ""; 4916100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 4917100425deSJoe Perches $leading_tabs = $1; 4918100425deSJoe Perches } else { 4919100425deSJoe Perches $do_fix = 0; 4920100425deSJoe Perches } 4921100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 4922100425deSJoe Perches $new_leading_tabs = $1; 4923100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 4924100425deSJoe Perches $do_fix = 0; 4925100425deSJoe Perches } 4926100425deSJoe Perches } else { 4927100425deSJoe Perches $do_fix = 0; 4928100425deSJoe Perches } 4929100425deSJoe Perches if ($do_fix) { 4930100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4931100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 4932100425deSJoe Perches } 4933100425deSJoe Perches } 49344c432a8fSGreg Kroah-Hartman } 49354c432a8fSGreg Kroah-Hartman } 4936f0a594c1SAndy Whitcroft 4937ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4938ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4939ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4940ebfdc409SJoe Perches (defined $1 || defined $3) && 4941ebfdc409SJoe Perches $linenr > 3) { 4942ebfdc409SJoe Perches my $testval = $2; 4943ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4944ebfdc409SJoe Perches 4945ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4946ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4947ebfdc409SJoe Perches 4948ebfdc409SJoe 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)/) { 4949ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4950ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4951ebfdc409SJoe Perches } 4952ebfdc409SJoe Perches } 4953ebfdc409SJoe Perches 4954f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4955dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4956f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4957f78d98f6SJoe Perches my $level = $1; 4958f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4959f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4960f78d98f6SJoe Perches $fix) { 4961f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4962f78d98f6SJoe Perches } 4963f78d98f6SJoe Perches } 4964f78d98f6SJoe Perches 4965abb08a53SJoe Perches# check for mask then right shift without a parentheses 4966abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4967abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4968abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4969abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4970abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4971abb08a53SJoe Perches } 4972abb08a53SJoe Perches 4973b75ac618SJoe Perches# check for pointer comparisons to NULL 4974b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4975b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4976b75ac618SJoe Perches my $val = $1; 4977b75ac618SJoe Perches my $equal = "!"; 4978b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4979b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4980b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4981b75ac618SJoe Perches $fix) { 4982b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4983b75ac618SJoe Perches } 4984b75ac618SJoe Perches } 4985b75ac618SJoe Perches } 4986b75ac618SJoe Perches 49878716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 49888716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 49898716de38SJoe Perches my $attr = $1; 49908716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 49918716de38SJoe Perches my $ptr = $1; 49928716de38SJoe Perches my $var = $2; 49938716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 49948716de38SJoe Perches ERROR("MISPLACED_INIT", 49958716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 49968716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 49978716de38SJoe Perches WARN("MISPLACED_INIT", 49988716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 49998716de38SJoe Perches $fix) { 5000194f66fcSJoe 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; 50018716de38SJoe Perches } 50028716de38SJoe Perches } 50038716de38SJoe Perches } 50048716de38SJoe Perches 5005e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 5006e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 5007e970b884SJoe Perches my $attr = $1; 5008e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 5009e970b884SJoe Perches my $attr_prefix = $1; 5010e970b884SJoe Perches my $attr_type = $2; 5011e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5012e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 5013e970b884SJoe Perches $fix) { 5014194f66fcSJoe Perches $fixed[$fixlinenr] =~ 5015e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 5016e970b884SJoe Perches } 5017e970b884SJoe Perches } 5018e970b884SJoe Perches 5019e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 5020e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 5021e970b884SJoe Perches my $attr = $1; 5022e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 5023e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 5024e970b884SJoe Perches $fix) { 5025194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 5026e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 5027e970b884SJoe Perches $lead = rtrim($1); 5028e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 5029e970b884SJoe Perches $lead = "${lead}const "; 5030194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 5031e970b884SJoe Perches } 5032e970b884SJoe Perches } 5033e970b884SJoe Perches 5034c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5035c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5036c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5037c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5038c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5039c17893c7SJoe Perches $fix) { 5040c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5041c17893c7SJoe Perches } 5042c17893c7SJoe Perches } 5043c17893c7SJoe Perches 5044fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5045fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5046fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5047fbdb8138SJoe Perches my $constant_func = $1; 5048fbdb8138SJoe Perches my $func = $constant_func; 5049fbdb8138SJoe Perches $func =~ s/^__constant_//; 5050fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5051fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5052fbdb8138SJoe Perches $fix) { 5053194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5054fbdb8138SJoe Perches } 5055fbdb8138SJoe Perches } 5056fbdb8138SJoe Perches 50571a15a250SPatrick Pannuto# prefer usleep_range over udelay 505837581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 505943c1d77cSJoe Perches my $delay = $1; 50601a15a250SPatrick Pannuto # ignore udelay's < 10, however 506143c1d77cSJoe Perches if (! ($delay < 10) ) { 5062000d1cc1SJoe Perches CHK("USLEEP_RANGE", 506343c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 506443c1d77cSJoe Perches } 506543c1d77cSJoe Perches if ($delay > 2000) { 506643c1d77cSJoe Perches WARN("LONG_UDELAY", 506743c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 50681a15a250SPatrick Pannuto } 50691a15a250SPatrick Pannuto } 50701a15a250SPatrick Pannuto 507109ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 507209ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 507309ef8725SPatrick Pannuto if ($1 < 20) { 5074000d1cc1SJoe Perches WARN("MSLEEP", 507543c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 507609ef8725SPatrick Pannuto } 507709ef8725SPatrick Pannuto } 507809ef8725SPatrick Pannuto 507936ec1939SJoe Perches# check for comparisons of jiffies 508036ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 508136ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 508236ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 508336ec1939SJoe Perches } 508436ec1939SJoe Perches 50859d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 50869d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 50879d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 50889d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 50899d7a34a5SJoe Perches } 50909d7a34a5SJoe Perches 509100df344fSAndy Whitcroft# warn about #ifdefs in C files 5092c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 509300df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 509400df344fSAndy Whitcroft# print "$herecurr"; 509500df344fSAndy Whitcroft# $clean = 0; 509600df344fSAndy Whitcroft# } 509700df344fSAndy Whitcroft 509822f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5099c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 51003705ce5bSJoe Perches if (ERROR("SPACING", 51013705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 51023705ce5bSJoe Perches $fix) { 5103194f66fcSJoe Perches $fixed[$fixlinenr] =~ 51043705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 51053705ce5bSJoe Perches } 51063705ce5bSJoe Perches 510722f2a2efSAndy Whitcroft } 510822f2a2efSAndy Whitcroft 51094a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5110171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5111171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 51124a0df2efSAndy Whitcroft my $which = $1; 51134a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5114000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5115000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 51164a0df2efSAndy Whitcroft } 51174a0df2efSAndy Whitcroft } 51184a0df2efSAndy Whitcroft# check for memory barriers without a comment. 5119402c2553SMichael S. Tsirkin 5120402c2553SMichael S. Tsirkin my $barriers = qr{ 5121402c2553SMichael S. Tsirkin mb| 5122402c2553SMichael S. Tsirkin rmb| 5123402c2553SMichael S. Tsirkin wmb| 5124402c2553SMichael S. Tsirkin read_barrier_depends 5125402c2553SMichael S. Tsirkin }x; 5126402c2553SMichael S. Tsirkin my $barrier_stems = qr{ 5127402c2553SMichael S. Tsirkin mb__before_atomic| 5128402c2553SMichael S. Tsirkin mb__after_atomic| 5129402c2553SMichael S. Tsirkin store_release| 5130402c2553SMichael S. Tsirkin load_acquire| 5131402c2553SMichael S. Tsirkin store_mb| 5132402c2553SMichael S. Tsirkin (?:$barriers) 5133402c2553SMichael S. Tsirkin }x; 5134402c2553SMichael S. Tsirkin my $all_barriers = qr{ 5135402c2553SMichael S. Tsirkin (?:$barriers)| 5136402c2553SMichael S. Tsirkin smp_(?:$barrier_stems) 5137402c2553SMichael S. Tsirkin }x; 5138402c2553SMichael S. Tsirkin 5139402c2553SMichael S. Tsirkin if ($line =~ /\b(?:$all_barriers)\s*\(/) { 51404a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5141c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5142000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 51434a0df2efSAndy Whitcroft } 51444a0df2efSAndy Whitcroft } 51453ad81779SPaul E. McKenney 5146*f4073b0fSMichael S. Tsirkin my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 5147*f4073b0fSMichael S. Tsirkin 5148*f4073b0fSMichael S. Tsirkin if ($realfile !~ m@^include/asm-generic/@ && 5149*f4073b0fSMichael S. Tsirkin $realfile !~ m@/barrier\.h$@ && 5150*f4073b0fSMichael S. Tsirkin $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 5151*f4073b0fSMichael S. Tsirkin $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 5152*f4073b0fSMichael S. Tsirkin WARN("MEMORY_BARRIER", 5153*f4073b0fSMichael S. Tsirkin "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 5154*f4073b0fSMichael S. Tsirkin } 5155*f4073b0fSMichael S. Tsirkin 5156cb426e99SJoe Perches# check for waitqueue_active without a comment. 5157cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5158cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5159cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5160cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5161cb426e99SJoe Perches } 5162cb426e99SJoe Perches } 51633ad81779SPaul E. McKenney 51643ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 51653ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 51663ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 51673ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 51683ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 51693ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 51703ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 51713ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 51723ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 51733ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 51743ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 51753ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 51763ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 51773ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 51783ad81779SPaul E. McKenney 51793ad81779SPaul E. McKenney } 51803ad81779SPaul E. McKenney 51814a0df2efSAndy Whitcroft# check of hardware specific defines 5182c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5183000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5184000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 51850a920b5bSAndy Whitcroft } 5186653d4876SAndy Whitcroft 5187d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5188d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5189000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5190000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5191d4977c78STobias Klauser } 5192d4977c78STobias Klauser 5193de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5194de7d4f0eSAndy Whitcroft# storage class and type. 51959c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 51969c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5197000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5198000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5199de7d4f0eSAndy Whitcroft } 5200de7d4f0eSAndy Whitcroft 52018905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 52022b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52032b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5204d5e616fcSJoe Perches if (WARN("INLINE", 5205d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5206d5e616fcSJoe Perches $fix) { 5207194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5208d5e616fcSJoe Perches 5209d5e616fcSJoe Perches } 52108905a67cSAndy Whitcroft } 52118905a67cSAndy Whitcroft 52123d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 52132b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52142b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5215000d1cc1SJoe Perches WARN("PREFER_PACKED", 5216000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 52173d130fd0SJoe Perches } 52183d130fd0SJoe Perches 521939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 52202b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52212b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5222000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5223000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 522439b7e287SJoe Perches } 522539b7e287SJoe Perches 52265f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 52272b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52282b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5229d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5230d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5231d5e616fcSJoe Perches $fix) { 5232194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5233d5e616fcSJoe Perches 5234d5e616fcSJoe Perches } 52355f14d3bdSJoe Perches } 52365f14d3bdSJoe Perches 52376061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 52382b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 52392b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5240d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5241d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5242d5e616fcSJoe Perches $fix) { 5243194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5244d5e616fcSJoe Perches } 52456061d949SJoe Perches } 52466061d949SJoe Perches 5247619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5248619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5249619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5250619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5251619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5252619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5253619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5254619a908aSJoe Perches } 5255619a908aSJoe Perches 5256e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5257e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5258e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5259e6176fa4SJoe Perches my $type = $1; 5260e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5261e6176fa4SJoe Perches $type = $1; 5262e6176fa4SJoe Perches my $kernel_type = 'u'; 5263e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5264e6176fa4SJoe Perches $type =~ /(\d+)/; 5265e6176fa4SJoe Perches $kernel_type .= $1; 5266e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5267e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5268e6176fa4SJoe Perches $fix) { 5269e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5270e6176fa4SJoe Perches } 5271e6176fa4SJoe Perches } 5272e6176fa4SJoe Perches } 5273e6176fa4SJoe Perches 52748f53a9b8SJoe Perches# check for sizeof(&) 52758f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5276000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5277000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 52788f53a9b8SJoe Perches } 52798f53a9b8SJoe Perches 528066c80b60SJoe Perches# check for sizeof without parenthesis 528166c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5282d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5283d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5284d5e616fcSJoe Perches $fix) { 5285194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5286d5e616fcSJoe Perches } 528766c80b60SJoe Perches } 528866c80b60SJoe Perches 528988982feaSJoe Perches# check for struct spinlock declarations 529088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 529188982feaSJoe Perches WARN("USE_SPINLOCK_T", 529288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 529388982feaSJoe Perches } 529488982feaSJoe Perches 5295a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 529606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5297a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5298caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5299caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5300d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5301d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5302d5e616fcSJoe Perches $fix) { 5303194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5304d5e616fcSJoe Perches } 5305a6962d72SJoe Perches } 5306a6962d72SJoe Perches } 5307a6962d72SJoe Perches 5308554e165cSAndy Whitcroft# Check for misused memsets 5309d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5310d1fe9c09SJoe Perches defined $stat && 53119e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5312554e165cSAndy Whitcroft 5313d7c76ba7SJoe Perches my $ms_addr = $2; 5314d1fe9c09SJoe Perches my $ms_val = $7; 5315d1fe9c09SJoe Perches my $ms_size = $12; 5316d7c76ba7SJoe Perches 5317554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5318554e165cSAndy Whitcroft ERROR("MEMSET", 5319d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5320554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5321554e165cSAndy Whitcroft WARN("MEMSET", 5322d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5323d7c76ba7SJoe Perches } 5324d7c76ba7SJoe Perches } 5325d7c76ba7SJoe Perches 532698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 532798a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 532810895d2cSMateusz Kulikowski defined $stat && 532910895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 533098a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 533110895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 533298a9bba5SJoe Perches $fix) { 5333194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 533498a9bba5SJoe Perches } 533598a9bba5SJoe Perches } 533698a9bba5SJoe Perches 5337b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5338b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5339b6117d17SMateusz Kulikowski defined $stat && 5340b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5341b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5342b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5343b6117d17SMateusz Kulikowski } 5344b6117d17SMateusz Kulikowski 53458617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 53468617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 53478617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 53488617cd09SMateusz Kulikowski defined $stat && 53498617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 53508617cd09SMateusz Kulikowski 53518617cd09SMateusz Kulikowski my $ms_val = $7; 53528617cd09SMateusz Kulikowski 53538617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 53548617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 53558617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 53568617cd09SMateusz Kulikowski $fix) { 53578617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 53588617cd09SMateusz Kulikowski } 53598617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 53608617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 53618617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 53628617cd09SMateusz Kulikowski $fix) { 53638617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 53648617cd09SMateusz Kulikowski } 53658617cd09SMateusz Kulikowski } 53668617cd09SMateusz Kulikowski } 53678617cd09SMateusz Kulikowski 5368d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5369d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5370d1fe9c09SJoe Perches defined $stat && 5371d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5372d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5373d7c76ba7SJoe Perches my $call = $1; 5374d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5375d7c76ba7SJoe Perches my $arg1 = $3; 5376d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5377d1fe9c09SJoe Perches my $arg2 = $8; 5378d7c76ba7SJoe Perches my $cast; 5379d7c76ba7SJoe Perches 5380d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5381d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5382d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5383d7c76ba7SJoe Perches $cast = $cast1; 5384d7c76ba7SJoe Perches } else { 5385d7c76ba7SJoe Perches $cast = $cast2; 5386d7c76ba7SJoe Perches } 5387d7c76ba7SJoe Perches WARN("MINMAX", 5388d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5389554e165cSAndy Whitcroft } 5390554e165cSAndy Whitcroft } 5391554e165cSAndy Whitcroft 53924a273195SJoe Perches# check usleep_range arguments 53934a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 53944a273195SJoe Perches defined $stat && 53954a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 53964a273195SJoe Perches my $min = $1; 53974a273195SJoe Perches my $max = $7; 53984a273195SJoe Perches if ($min eq $max) { 53994a273195SJoe Perches WARN("USLEEP_RANGE", 54004a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 54014a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 54024a273195SJoe Perches $min > $max) { 54034a273195SJoe Perches WARN("USLEEP_RANGE", 54044a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 54054a273195SJoe Perches } 54064a273195SJoe Perches } 54074a273195SJoe Perches 5408823b794cSJoe Perches# check for naked sscanf 5409823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5410823b794cSJoe Perches defined $stat && 54116c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5412823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5413823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5414823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5415823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5416823b794cSJoe Perches $lc = $lc + $linenr; 5417823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5418823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5419823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5420823b794cSJoe Perches } 5421823b794cSJoe Perches WARN("NAKED_SSCANF", 5422823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5423823b794cSJoe Perches } 5424823b794cSJoe Perches 5425afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5426afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5427afc819abSJoe Perches defined $stat && 5428afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5429afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5430afc819abSJoe Perches $lc = $lc + $linenr; 5431afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5432afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5433afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5434afc819abSJoe Perches } 5435afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5436afc819abSJoe Perches my $format = $6; 5437afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5438afc819abSJoe Perches if ($count == 1 && 5439afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5440afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5441afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5442afc819abSJoe Perches } 5443afc819abSJoe Perches } 5444afc819abSJoe Perches } 5445afc819abSJoe Perches 544670dc8a48SJoe Perches# check for new externs in .h files. 544770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 544870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5449d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 545070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 545170dc8a48SJoe Perches $fix) { 5452194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 545370dc8a48SJoe Perches } 545470dc8a48SJoe Perches } 545570dc8a48SJoe Perches 5456de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5457171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5458c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5459171ae1a4SAndy Whitcroft { 5460c45dcabdSAndy Whitcroft my $function_name = $1; 5461c45dcabdSAndy Whitcroft my $paren_space = $2; 5462171ae1a4SAndy Whitcroft 5463171ae1a4SAndy Whitcroft my $s = $stat; 5464171ae1a4SAndy Whitcroft if (defined $cond) { 5465171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5466171ae1a4SAndy Whitcroft } 5467c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5468c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5469c45dcabdSAndy Whitcroft { 5470000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5471000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5472de7d4f0eSAndy Whitcroft } 5473de7d4f0eSAndy Whitcroft 5474171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5475000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5476000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5477171ae1a4SAndy Whitcroft } 54789c9ba34eSAndy Whitcroft 54799c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 54809c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 54819c9ba34eSAndy Whitcroft { 5482000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5483000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5484171ae1a4SAndy Whitcroft } 5485171ae1a4SAndy Whitcroft 5486de7d4f0eSAndy Whitcroft# checks for new __setup's 5487de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5488de7d4f0eSAndy Whitcroft my $name = $1; 5489de7d4f0eSAndy Whitcroft 5490de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5491000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5492000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5493de7d4f0eSAndy Whitcroft } 5494653d4876SAndy Whitcroft } 54959c0ca6f9SAndy Whitcroft 54969c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5497caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5498000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5499000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 55009c0ca6f9SAndy Whitcroft } 550113214adfSAndy Whitcroft 5502a640d25cSJoe Perches# alloc style 5503a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5504a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5505a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5506a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5507a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5508a640d25cSJoe Perches } 5509a640d25cSJoe Perches 551060a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 551160a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5512e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 551360a55369SJoe Perches my $oldfunc = $3; 551460a55369SJoe Perches my $a1 = $4; 551560a55369SJoe Perches my $a2 = $10; 551660a55369SJoe Perches my $newfunc = "kmalloc_array"; 551760a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 551860a55369SJoe Perches my $r1 = $a1; 551960a55369SJoe Perches my $r2 = $a2; 552060a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 552160a55369SJoe Perches $r1 = $a2; 552260a55369SJoe Perches $r2 = $a1; 552360a55369SJoe Perches } 5524e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5525e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5526e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5527e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5528e367455aSJoe Perches $fix) { 5529194f66fcSJoe 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; 553060a55369SJoe Perches 553160a55369SJoe Perches } 553260a55369SJoe Perches } 553360a55369SJoe Perches } 553460a55369SJoe Perches 5535972fdea2SJoe Perches# check for krealloc arg reuse 5536972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5537972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5538972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5539972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5540972fdea2SJoe Perches } 5541972fdea2SJoe Perches 55425ce59ae0SJoe Perches# check for alloc argument mismatch 55435ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 55445ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 55455ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 55465ce59ae0SJoe Perches } 55475ce59ae0SJoe Perches 5548caf2a54fSJoe Perches# check for multiple semicolons 5549caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5550d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5551d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5552d5e616fcSJoe Perches $fix) { 5553194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5554d5e616fcSJoe Perches } 5555d1e2ad07SJoe Perches } 5556d1e2ad07SJoe Perches 55570ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 55580ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 55590ab90191SJoe Perches my $ull = ""; 55600ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 55610ab90191SJoe Perches if (CHK("BIT_MACRO", 55620ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 55630ab90191SJoe Perches $fix) { 55640ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 55650ab90191SJoe Perches } 55660ab90191SJoe Perches } 55670ab90191SJoe Perches 5568e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5569c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5570c34c09a8SJoe Perches my $has_break = 0; 5571c34c09a8SJoe Perches my $has_statement = 0; 5572c34c09a8SJoe Perches my $count = 0; 5573c34c09a8SJoe Perches my $prevline = $linenr; 5574e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5575c34c09a8SJoe Perches $prevline--; 5576c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5577c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5578c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5579c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5580c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5581c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5582c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5583c34c09a8SJoe Perches $has_statement = 1; 5584c34c09a8SJoe Perches $count++; 5585c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5586c34c09a8SJoe Perches } 5587c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5588c34c09a8SJoe Perches WARN("MISSING_BREAK", 5589c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5590c34c09a8SJoe Perches } 5591c34c09a8SJoe Perches } 5592c34c09a8SJoe Perches 5593d1e2ad07SJoe Perches# check for switch/default statements without a break; 5594d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5595d1e2ad07SJoe Perches defined $stat && 5596d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5597d1e2ad07SJoe Perches my $ctx = ''; 5598d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5599d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5600d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5601d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5602d1e2ad07SJoe Perches } 5603d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5604d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5605caf2a54fSJoe Perches } 5606caf2a54fSJoe Perches 560713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5608d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5609d5e616fcSJoe Perches if (WARN("USE_FUNC", 5610d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5611d5e616fcSJoe Perches $fix) { 5612194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5613d5e616fcSJoe Perches } 561413214adfSAndy Whitcroft } 5615773647a0SAndy Whitcroft 561662ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 561762ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 561862ec818fSJoe Perches ERROR("DATE_TIME", 561962ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 562062ec818fSJoe Perches } 562162ec818fSJoe Perches 56222c92488aSJoe Perches# check for use of yield() 56232c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 56242c92488aSJoe Perches WARN("YIELD", 56252c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 56262c92488aSJoe Perches } 56272c92488aSJoe Perches 5628179f8f40SJoe Perches# check for comparisons against true and false 5629179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5630179f8f40SJoe Perches my $lead = $1; 5631179f8f40SJoe Perches my $arg = $2; 5632179f8f40SJoe Perches my $test = $3; 5633179f8f40SJoe Perches my $otype = $4; 5634179f8f40SJoe Perches my $trail = $5; 5635179f8f40SJoe Perches my $op = "!"; 5636179f8f40SJoe Perches 5637179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5638179f8f40SJoe Perches 5639179f8f40SJoe Perches my $type = lc($otype); 5640179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5641179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5642179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5643179f8f40SJoe Perches $op = ""; 5644179f8f40SJoe Perches } 5645179f8f40SJoe Perches 5646179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5647179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5648179f8f40SJoe Perches 5649179f8f40SJoe Perches## maybe suggesting a correct construct would better 5650179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5651179f8f40SJoe Perches 5652179f8f40SJoe Perches } 5653179f8f40SJoe Perches } 5654179f8f40SJoe Perches 56554882720bSThomas Gleixner# check for semaphores initialized locked 56564882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5657000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5658000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5659773647a0SAndy Whitcroft } 56606712d858SJoe Perches 566167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 566267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5663000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 566467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5665773647a0SAndy Whitcroft } 56666712d858SJoe Perches 5667ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5668f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5669000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5670ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5671f3db6639SMichael Ellerman } 56726712d858SJoe Perches 56730f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 56740f3c5aabSJoe Perches my $const_structs = qr{ 56750f3c5aabSJoe Perches acpi_dock_ops| 567679404849SEmese Revfy address_space_operations| 567779404849SEmese Revfy backlight_ops| 567879404849SEmese Revfy block_device_operations| 567979404849SEmese Revfy dentry_operations| 568079404849SEmese Revfy dev_pm_ops| 568179404849SEmese Revfy dma_map_ops| 568279404849SEmese Revfy extent_io_ops| 568379404849SEmese Revfy file_lock_operations| 568479404849SEmese Revfy file_operations| 568579404849SEmese Revfy hv_ops| 568679404849SEmese Revfy ide_dma_ops| 568779404849SEmese Revfy intel_dvo_dev_ops| 568879404849SEmese Revfy item_operations| 568979404849SEmese Revfy iwl_ops| 569079404849SEmese Revfy kgdb_arch| 569179404849SEmese Revfy kgdb_io| 569279404849SEmese Revfy kset_uevent_ops| 569379404849SEmese Revfy lock_manager_operations| 569479404849SEmese Revfy microcode_ops| 569579404849SEmese Revfy mtrr_ops| 569679404849SEmese Revfy neigh_ops| 569779404849SEmese Revfy nlmsvc_binding| 56980f3c5aabSJoe Perches of_device_id| 569979404849SEmese Revfy pci_raw_ops| 570079404849SEmese Revfy pipe_buf_operations| 570179404849SEmese Revfy platform_hibernation_ops| 570279404849SEmese Revfy platform_suspend_ops| 570379404849SEmese Revfy proto_ops| 570479404849SEmese Revfy rpc_pipe_ops| 570579404849SEmese Revfy seq_operations| 570679404849SEmese Revfy snd_ac97_build_ops| 570779404849SEmese Revfy soc_pcmcia_socket_ops| 570879404849SEmese Revfy stacktrace_ops| 570979404849SEmese Revfy sysfs_ops| 571079404849SEmese Revfy tty_operations| 57116d07d01bSJoe Perches uart_ops| 571279404849SEmese Revfy usb_mon_operations| 571379404849SEmese Revfy wd_ops}x; 57146903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 57150f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5716000d1cc1SJoe Perches WARN("CONST_STRUCT", 5717000d1cc1SJoe Perches "struct $1 should normally be const\n" . 57186903ffb2SAndy Whitcroft $herecurr); 57192b6db5cbSAndy Whitcroft } 5720773647a0SAndy Whitcroft 5721773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5722773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5723773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5724c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5725c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5726171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5727171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5728171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5729773647a0SAndy Whitcroft { 5730000d1cc1SJoe Perches WARN("NR_CPUS", 5731000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5732773647a0SAndy Whitcroft } 57339c9ba34eSAndy Whitcroft 573452ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 573552ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 573652ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 573752ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 573852ea8506SJoe Perches } 573952ea8506SJoe Perches 5740acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5741acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5742acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5743acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5744acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5745acd9362cSJoe Perches } 5746acd9362cSJoe Perches 5747691d77b6SAndy Whitcroft# whine mightly about in_atomic 5748691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5749691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5750000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5751000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5752f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5753000d1cc1SJoe Perches WARN("IN_ATOMIC", 5754000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5755691d77b6SAndy Whitcroft } 5756691d77b6SAndy Whitcroft } 57571704f47bSPeter Zijlstra 57581704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 57591704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 57601704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 57611704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 57621704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 57631704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5764000d1cc1SJoe Perches ERROR("LOCKDEP", 5765000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 57661704f47bSPeter Zijlstra } 57671704f47bSPeter Zijlstra } 576888f8831cSDave Jones 5769b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5770b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5771000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5772000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 577388f8831cSDave Jones } 57742435880fSJoe Perches 5775515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5776515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5777515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5778515a235eSJoe Perches $line =~ /$mode_perms_search/) { 57792435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 57802435880fSJoe Perches my $func = $entry->[0]; 57812435880fSJoe Perches my $arg_pos = $entry->[1]; 57822435880fSJoe Perches 57832435880fSJoe Perches my $skip_args = ""; 57842435880fSJoe Perches if ($arg_pos > 1) { 57852435880fSJoe Perches $arg_pos--; 57862435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 57872435880fSJoe Perches } 57882435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5789515a235eSJoe Perches if ($line =~ /$test/) { 57902435880fSJoe Perches my $val = $1; 57912435880fSJoe Perches $val = $6 if ($skip_args ne ""); 57922435880fSJoe Perches 57931727cc70SJoe Perches if ($val !~ /^0$/ && 57941727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 57951727cc70SJoe Perches length($val) ne 4)) { 57962435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 57971727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5798c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5799c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5800c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 58012435880fSJoe Perches } 58022435880fSJoe Perches } 58032435880fSJoe Perches } 580413214adfSAndy Whitcroft } 58055a6d20ceSBjorn Andersson 58065a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 58075a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 58085a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 58095a6d20ceSBjorn Andersson my $valid_licenses = qr{ 58105a6d20ceSBjorn Andersson GPL| 58115a6d20ceSBjorn Andersson GPL\ v2| 58125a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 58135a6d20ceSBjorn Andersson Dual\ BSD/GPL| 58145a6d20ceSBjorn Andersson Dual\ MIT/GPL| 58155a6d20ceSBjorn Andersson Dual\ MPL/GPL| 58165a6d20ceSBjorn Andersson Proprietary 58175a6d20ceSBjorn Andersson }x; 58185a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 58195a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 58205a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 58215a6d20ceSBjorn Andersson } 58225a6d20ceSBjorn Andersson } 5823515a235eSJoe Perches } 582413214adfSAndy Whitcroft 582513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 582613214adfSAndy Whitcroft # so just keep quiet. 582713214adfSAndy Whitcroft if ($#rawlines == -1) { 582813214adfSAndy Whitcroft exit(0); 58290a920b5bSAndy Whitcroft } 58300a920b5bSAndy Whitcroft 58318905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 58328905a67cSAndy Whitcroft # things that appear to be patches. 58338905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 58348905a67cSAndy Whitcroft exit(0); 58358905a67cSAndy Whitcroft } 58368905a67cSAndy Whitcroft 58378905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 58388905a67cSAndy Whitcroft # just keep quiet. 58398905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 58408905a67cSAndy Whitcroft exit(0); 58418905a67cSAndy Whitcroft } 58428905a67cSAndy Whitcroft 584306330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5844000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5845000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 58460a920b5bSAndy Whitcroft } 584734d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5848000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5849000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 58500a920b5bSAndy Whitcroft } 58510a920b5bSAndy Whitcroft 5852f0a594c1SAndy Whitcroft print report_dump(); 585313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 585413214adfSAndy Whitcroft print "$filename " if ($summary_file); 58556c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 58566c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 58576c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 58586c72ffaaSAndy Whitcroft } 58598905a67cSAndy Whitcroft 5860d2c0a235SAndy Whitcroft if ($quiet == 0) { 5861d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5862d2c0a235SAndy Whitcroft # then suggest that. 5863d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5864b0781216SMike Frysinger $rpt_cleaners = 0; 5865d8469f16SJoe Perches print << "EOM" 5866d8469f16SJoe Perches 5867d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5868d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5869d8469f16SJoe PerchesEOM 5870d2c0a235SAndy Whitcroft } 5871d2c0a235SAndy Whitcroft } 5872d2c0a235SAndy Whitcroft 5873d752fcc8SJoe Perches if ($clean == 0 && $fix && 5874d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5875d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 58769624b8d6SJoe Perches my $newfile = $filename; 58779624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 58783705ce5bSJoe Perches my $linecount = 0; 58793705ce5bSJoe Perches my $f; 58803705ce5bSJoe Perches 5881d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5882d752fcc8SJoe Perches 58833705ce5bSJoe Perches open($f, '>', $newfile) 58843705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 58853705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 58863705ce5bSJoe Perches $linecount++; 58873705ce5bSJoe Perches if ($file) { 58883705ce5bSJoe Perches if ($linecount > 3) { 58893705ce5bSJoe Perches $fixed_line =~ s/^\+//; 58903705ce5bSJoe Perches print $f $fixed_line . "\n"; 58913705ce5bSJoe Perches } 58923705ce5bSJoe Perches } else { 58933705ce5bSJoe Perches print $f $fixed_line . "\n"; 58943705ce5bSJoe Perches } 58953705ce5bSJoe Perches } 58963705ce5bSJoe Perches close($f); 58973705ce5bSJoe Perches 58983705ce5bSJoe Perches if (!$quiet) { 58993705ce5bSJoe Perches print << "EOM"; 5900d8469f16SJoe Perches 59013705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 59023705ce5bSJoe Perches 59033705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 59043705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 59053705ce5bSJoe Perches 59063705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 59073705ce5bSJoe PerchesNo warranties, expressed or implied... 59083705ce5bSJoe PerchesEOM 59093705ce5bSJoe Perches } 59103705ce5bSJoe Perches } 59113705ce5bSJoe Perches 5912d8469f16SJoe Perches if ($quiet == 0) { 5913d8469f16SJoe Perches print "\n"; 5914d8469f16SJoe Perches if ($clean == 1) { 5915d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5916d8469f16SJoe Perches } else { 5917d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 59180a920b5bSAndy Whitcroft } 59190a920b5bSAndy Whitcroft } 59200a920b5bSAndy Whitcroft return $clean; 59210a920b5bSAndy Whitcroft} 5922