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 20658cb3cf6SJoe Perches if ($quiet == 0 && 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| 2676c72ffaaSAndy Whitcroft __must_check| 2686c72ffaaSAndy Whitcroft __init_refok| 269417495edSAndy Whitcroft __kprobes| 270165e72a6SSven Eckelmann __ref| 271165e72a6SSven Eckelmann __rcu 2726c72ffaaSAndy Whitcroft }x; 273e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 274e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 275e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 276e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 277e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2788716de38SJoe Perches 27952131292SWolfram Sang# Notes to $Attribute: 28052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2816c72ffaaSAndy Whitcroftour $Attribute = qr{ 2826c72ffaaSAndy Whitcroft const| 28303f1df7dSJoe Perches __percpu| 28403f1df7dSJoe Perches __nocast| 28503f1df7dSJoe Perches __safe| 28603f1df7dSJoe Perches __bitwise__| 28703f1df7dSJoe Perches __packed__| 28803f1df7dSJoe Perches __packed2__| 28903f1df7dSJoe Perches __naked| 29003f1df7dSJoe Perches __maybe_unused| 29103f1df7dSJoe Perches __always_unused| 29203f1df7dSJoe Perches __noreturn| 29303f1df7dSJoe Perches __used| 29403f1df7dSJoe Perches __cold| 295e23ef1f3SJoe Perches __pure| 29603f1df7dSJoe Perches __noclone| 29703f1df7dSJoe Perches __deprecated| 2986c72ffaaSAndy Whitcroft __read_mostly| 2996c72ffaaSAndy Whitcroft __kprobes| 3008716de38SJoe Perches $InitAttribute| 30124e1d81aSAndy Whitcroft ____cacheline_aligned| 30224e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 3035fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 3045fe3af11SAndy Whitcroft __weak 3056c72ffaaSAndy Whitcroft }x; 306c45dcabdSAndy Whitcroftour $Modifier; 30791cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3086c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3096c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3106c72ffaaSAndy Whitcroft 31195e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 31295e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 31395e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 31495e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3152435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 316c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 317326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 318326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 319326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 32074349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3212435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 322326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 323447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 32423f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3256c72ffaaSAndy Whitcroftour $Operators = qr{ 3266c72ffaaSAndy Whitcroft <=|>=|==|!=| 3276c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 32823f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3296c72ffaaSAndy Whitcroft }x; 3306c72ffaaSAndy Whitcroft 33191cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 33291cb5195SJoe Perches 333ab7e23f3SJoe Perchesour $BasicType; 3348905a67cSAndy Whitcroftour $NonptrType; 3351813087dSJoe Perchesour $NonptrTypeMisordered; 3368716de38SJoe Perchesour $NonptrTypeWithAttr; 3378905a67cSAndy Whitcroftour $Type; 3381813087dSJoe Perchesour $TypeMisordered; 3398905a67cSAndy Whitcroftour $Declare; 3401813087dSJoe Perchesour $DeclareMisordered; 3418905a67cSAndy Whitcroft 34215662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 34315662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 344171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 345171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 346171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 347171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 348171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 349171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 350171ae1a4SAndy Whitcroft}x; 351171ae1a4SAndy Whitcroft 35215662b3eSJoe Perchesour $UTF8 = qr{ 35315662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 35415662b3eSJoe Perches | $NON_ASCII_UTF8 35515662b3eSJoe Perches}x; 35615662b3eSJoe Perches 357e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 358021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 359021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 360021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 361021158b4SJoe Perches)}; 362e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x: 363fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3648ed22cadSAndy Whitcroft atomic_t 3658ed22cadSAndy Whitcroft)}; 366e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x: 367e6176fa4SJoe Perches $typeC99Typedefs\b| 368e6176fa4SJoe Perches $typeOtherOSTypedefs\b| 369e6176fa4SJoe Perches $typeKernelTypedefs\b 370e6176fa4SJoe Perches)}; 3718ed22cadSAndy Whitcroft 372691e669bSJoe Perchesour $logFunctions = qr{(?x: 3736e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3747d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3756e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 376b0531722SJoe Perches panic| 37706668727SJoe Perches MODULE_[A-Z_]+| 37806668727SJoe Perches seq_vprintf|seq_printf|seq_puts 379691e669bSJoe Perches)}; 380691e669bSJoe Perches 38120112475SJoe Perchesour $signature_tags = qr{(?xi: 38220112475SJoe Perches Signed-off-by:| 38320112475SJoe Perches Acked-by:| 38420112475SJoe Perches Tested-by:| 38520112475SJoe Perches Reviewed-by:| 38620112475SJoe Perches Reported-by:| 3878543ae12SMugunthan V N Suggested-by:| 38820112475SJoe Perches To:| 38920112475SJoe Perches Cc: 39020112475SJoe Perches)}; 39120112475SJoe Perches 3921813087dSJoe Perchesour @typeListMisordered = ( 3931813087dSJoe Perches qr{char\s+(?:un)?signed}, 3941813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3951813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 3961813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 3971813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 3981813087dSJoe Perches qr{short\s+(?:un)?signed}, 3991813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 4001813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 4011813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 4021813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 4031813087dSJoe Perches qr{int\s+(?:un)?signed}, 4041813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 4051813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 4061813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 4071813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 4081813087dSJoe Perches qr{long\s+(?:un)?signed}, 4091813087dSJoe Perches); 4101813087dSJoe Perches 4118905a67cSAndy Whitcroftour @typeList = ( 4128905a67cSAndy Whitcroft qr{void}, 4130c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4140c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4150c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4160c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4170c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4180c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4190c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4200c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4210c773d9dSJoe Perches qr{(?:un)?signed}, 4228905a67cSAndy Whitcroft qr{float}, 4238905a67cSAndy Whitcroft qr{double}, 4248905a67cSAndy Whitcroft qr{bool}, 4258905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4268905a67cSAndy Whitcroft qr{union\s+$Ident}, 4278905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4288905a67cSAndy Whitcroft qr{${Ident}_t}, 4298905a67cSAndy Whitcroft qr{${Ident}_handler}, 4308905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4311813087dSJoe Perches @typeListMisordered, 4328905a67cSAndy Whitcroft); 433485ff23eSAlex Dowadour @typeListFile = (); 4348716de38SJoe Perchesour @typeListWithAttr = ( 4358716de38SJoe Perches @typeList, 4368716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4378716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4388716de38SJoe Perches); 4398716de38SJoe Perches 440c45dcabdSAndy Whitcroftour @modifierList = ( 441c45dcabdSAndy Whitcroft qr{fastcall}, 442c45dcabdSAndy Whitcroft); 443485ff23eSAlex Dowadour @modifierListFile = (); 4448905a67cSAndy Whitcroft 4452435880fSJoe Perchesour @mode_permission_funcs = ( 4462435880fSJoe Perches ["module_param", 3], 4472435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4482435880fSJoe Perches ["module_param_array_named", 5], 4492435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4502435880fSJoe Perches ["proc_create(?:_data|)", 2], 4512435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4522435880fSJoe Perches); 4532435880fSJoe Perches 454515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 455515a235eSJoe Perchesour $mode_perms_search = ""; 456515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 457515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 458515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 459515a235eSJoe Perches} 460515a235eSJoe Perches 461b392c64fSJoe Perchesour $mode_perms_world_writable = qr{ 462b392c64fSJoe Perches S_IWUGO | 463b392c64fSJoe Perches S_IWOTH | 464b392c64fSJoe Perches S_IRWXUGO | 465b392c64fSJoe Perches S_IALLUGO | 466b392c64fSJoe Perches 0[0-7][0-7][2367] 467b392c64fSJoe Perches}x; 468b392c64fSJoe Perches 4697840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4707840a94cSWolfram Sang irq| 471cdcee686SSergey Ryazanov memory| 472cdcee686SSergey Ryazanov time| 473cdcee686SSergey Ryazanov reboot 4747840a94cSWolfram Sang)}; 4757840a94cSWolfram Sang# memory.h: ARM has a custom one 4767840a94cSWolfram Sang 47766b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 47866b47b4aSKees Cookmy $misspellings; 47966b47b4aSKees Cookmy %spelling_fix; 48036061e38SJoe Perches 48136061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 48266b47b4aSKees Cook while (<$spelling>) { 48366b47b4aSKees Cook my $line = $_; 48466b47b4aSKees Cook 48566b47b4aSKees Cook $line =~ s/\s*\n?$//g; 48666b47b4aSKees Cook $line =~ s/^\s*//g; 48766b47b4aSKees Cook 48866b47b4aSKees Cook next if ($line =~ m/^\s*#/); 48966b47b4aSKees Cook next if ($line =~ m/^\s*$/); 49066b47b4aSKees Cook 49166b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 49266b47b4aSKees Cook 49366b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 49466b47b4aSKees Cook } 49566b47b4aSKees Cook close($spelling); 49636061e38SJoe Perches} else { 49736061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 49836061e38SJoe Perches} 49966b47b4aSKees Cook 500ebfd7d62SJoe Perchesif ($codespell) { 501ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 502ebfd7d62SJoe Perches while (<$spelling>) { 503ebfd7d62SJoe Perches my $line = $_; 504ebfd7d62SJoe Perches 505ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 506ebfd7d62SJoe Perches $line =~ s/^\s*//g; 507ebfd7d62SJoe Perches 508ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 509ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 510ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 511ebfd7d62SJoe Perches 512ebfd7d62SJoe Perches $line =~ s/,.*$//; 513ebfd7d62SJoe Perches 514ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 515ebfd7d62SJoe Perches 516ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 517ebfd7d62SJoe Perches } 518ebfd7d62SJoe Perches close($spelling); 519ebfd7d62SJoe Perches } else { 520ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 521ebfd7d62SJoe Perches } 522ebfd7d62SJoe Perches} 523ebfd7d62SJoe Perches 524ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 525ebfd7d62SJoe Perches 5268905a67cSAndy Whitcroftsub build_types { 527485ff23eSAlex Dowad my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 528485ff23eSAlex Dowad my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 5291813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5308716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 531c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 532ab7e23f3SJoe Perches $BasicType = qr{ 533ab7e23f3SJoe Perches (?:$typeTypedefs\b)| 534ab7e23f3SJoe Perches (?:${all}\b) 535ab7e23f3SJoe Perches }x; 5368905a67cSAndy Whitcroft $NonptrType = qr{ 537d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 538cf655043SAndy Whitcroft (?: 5396b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 5408ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 541c45dcabdSAndy Whitcroft (?:${all}\b) 542cf655043SAndy Whitcroft ) 543c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5448905a67cSAndy Whitcroft }x; 5451813087dSJoe Perches $NonptrTypeMisordered = qr{ 5461813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5471813087dSJoe Perches (?: 5481813087dSJoe Perches (?:${Misordered}\b) 5491813087dSJoe Perches ) 5501813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5511813087dSJoe Perches }x; 5528716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5538716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5548716de38SJoe Perches (?: 5558716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5568716de38SJoe Perches (?:$typeTypedefs\b)| 5578716de38SJoe Perches (?:${allWithAttr}\b) 5588716de38SJoe Perches ) 5598716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5608716de38SJoe Perches }x; 5618905a67cSAndy Whitcroft $Type = qr{ 562c45dcabdSAndy Whitcroft $NonptrType 5631574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 564c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5658905a67cSAndy Whitcroft }x; 5661813087dSJoe Perches $TypeMisordered = qr{ 5671813087dSJoe Perches $NonptrTypeMisordered 5681813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5691813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5701813087dSJoe Perches }x; 57191cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5721813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5738905a67cSAndy Whitcroft} 5748905a67cSAndy Whitcroftbuild_types(); 5756c72ffaaSAndy Whitcroft 5767d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 577d1fe9c09SJoe Perches 578d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 579d1fe9c09SJoe Perches# requires at least perl version v5.10.0 580d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 581d1fe9c09SJoe Perches 582d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5832435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 584c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 5857d2367afSJoe Perches 586f8422308SJoe Perchesour $declaration_macros = qr{(?x: 587f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 588f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 589f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 590f8422308SJoe Perches)}; 591f8422308SJoe Perches 5927d2367afSJoe Perchessub deparenthesize { 5937d2367afSJoe Perches my ($string) = @_; 5947d2367afSJoe Perches return "" if (!defined($string)); 5955b9553abSJoe Perches 5965b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5975b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5985b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5995b9553abSJoe Perches } 6005b9553abSJoe Perches 6017d2367afSJoe Perches $string =~ s@\s+@ @g; 6025b9553abSJoe Perches 6037d2367afSJoe Perches return $string; 6047d2367afSJoe Perches} 6057d2367afSJoe Perches 6063445686aSJoe Perchessub seed_camelcase_file { 6073445686aSJoe Perches my ($file) = @_; 6083445686aSJoe Perches 6093445686aSJoe Perches return if (!(-f $file)); 6103445686aSJoe Perches 6113445686aSJoe Perches local $/; 6123445686aSJoe Perches 6133445686aSJoe Perches open(my $include_file, '<', "$file") 6143445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6153445686aSJoe Perches my $text = <$include_file>; 6163445686aSJoe Perches close($include_file); 6173445686aSJoe Perches 6183445686aSJoe Perches my @lines = split('\n', $text); 6193445686aSJoe Perches 6203445686aSJoe Perches foreach my $line (@lines) { 6213445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6223445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6233445686aSJoe Perches $camelcase{$1} = 1; 62411ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 62511ea516aSJoe Perches $camelcase{$1} = 1; 62611ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6273445686aSJoe Perches $camelcase{$1} = 1; 6283445686aSJoe Perches } 6293445686aSJoe Perches } 6303445686aSJoe Perches} 6313445686aSJoe Perches 6323445686aSJoe Perchesmy $camelcase_seeded = 0; 6333445686aSJoe Perchessub seed_camelcase_includes { 6343445686aSJoe Perches return if ($camelcase_seeded); 6353445686aSJoe Perches 6363445686aSJoe Perches my $files; 637c707a81dSJoe Perches my $camelcase_cache = ""; 638c707a81dSJoe Perches my @include_files = (); 639c707a81dSJoe Perches 640c707a81dSJoe Perches $camelcase_seeded = 1; 641351b2a1fSJoe Perches 6423645e328SRichard Genoud if (-e ".git") { 643351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 644351b2a1fSJoe Perches chomp $git_last_include_commit; 645c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 646c707a81dSJoe Perches } else { 647c707a81dSJoe Perches my $last_mod_date = 0; 648c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 649c707a81dSJoe Perches @include_files = split('\n', $files); 650c707a81dSJoe Perches foreach my $file (@include_files) { 651c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 652c707a81dSJoe Perches localtime((stat $file)[9])); 653c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 654c707a81dSJoe Perches } 655c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 656c707a81dSJoe Perches } 657c707a81dSJoe Perches 658c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 659c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 660c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 661351b2a1fSJoe Perches while (<$camelcase_file>) { 662351b2a1fSJoe Perches chomp; 663351b2a1fSJoe Perches $camelcase{$_} = 1; 664351b2a1fSJoe Perches } 665351b2a1fSJoe Perches close($camelcase_file); 666351b2a1fSJoe Perches 667351b2a1fSJoe Perches return; 668351b2a1fSJoe Perches } 669c707a81dSJoe Perches 6703645e328SRichard Genoud if (-e ".git") { 671c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 672c707a81dSJoe Perches @include_files = split('\n', $files); 6733445686aSJoe Perches } 674c707a81dSJoe Perches 6753445686aSJoe Perches foreach my $file (@include_files) { 6763445686aSJoe Perches seed_camelcase_file($file); 6773445686aSJoe Perches } 678351b2a1fSJoe Perches 679c707a81dSJoe Perches if ($camelcase_cache ne "") { 680351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 681c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 682c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 683351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 684351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 685351b2a1fSJoe Perches } 686351b2a1fSJoe Perches close($camelcase_file); 687351b2a1fSJoe Perches } 6883445686aSJoe Perches} 6893445686aSJoe Perches 690d311cd44SJoe Perchessub git_commit_info { 691d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 692d311cd44SJoe Perches 693d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 694d311cd44SJoe Perches 695d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 696d311cd44SJoe Perches $output =~ s/^\s*//gm; 697d311cd44SJoe Perches my @lines = split("\n", $output); 698d311cd44SJoe Perches 6990d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 7000d7835fcSJoe Perches 701d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 702d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 703d311cd44SJoe Perches# all matching commit ids, but it's very slow... 704d311cd44SJoe Perches# 705d311cd44SJoe Perches# echo "checking commits $1..." 706d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 707d311cd44SJoe Perches# while read line ; do 708d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 709d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 710d311cd44SJoe Perches# done 711d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 712d311cd44SJoe Perches } else { 713d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 714d311cd44SJoe Perches $desc = substr($lines[0], 41); 715d311cd44SJoe Perches } 716d311cd44SJoe Perches 717d311cd44SJoe Perches return ($id, $desc); 718d311cd44SJoe Perches} 719d311cd44SJoe Perches 7206c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7210a920b5bSAndy Whitcroft 72200df344fSAndy Whitcroftmy @rawlines = (); 723c2fdda0dSAndy Whitcroftmy @lines = (); 7243705ce5bSJoe Perchesmy @fixed = (); 725d752fcc8SJoe Perchesmy @fixed_inserted = (); 726d752fcc8SJoe Perchesmy @fixed_deleted = (); 727194f66fcSJoe Perchesmy $fixlinenr = -1; 728194f66fcSJoe Perches 729c2fdda0dSAndy Whitcroftmy $vname; 7306c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 73121caa13cSAndy Whitcroft my $FILE; 7326c72ffaaSAndy Whitcroft if ($file) { 73321caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7346c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 73521caa13cSAndy Whitcroft } elsif ($filename eq '-') { 73621caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7376c72ffaaSAndy Whitcroft } else { 73821caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7396c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7406c72ffaaSAndy Whitcroft } 741c2fdda0dSAndy Whitcroft if ($filename eq '-') { 742c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 743c2fdda0dSAndy Whitcroft } else { 744c2fdda0dSAndy Whitcroft $vname = $filename; 745c2fdda0dSAndy Whitcroft } 74621caa13cSAndy Whitcroft while (<$FILE>) { 7470a920b5bSAndy Whitcroft chomp; 74800df344fSAndy Whitcroft push(@rawlines, $_); 7496c72ffaaSAndy Whitcroft } 75021caa13cSAndy Whitcroft close($FILE); 751d8469f16SJoe Perches 752d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 753d8469f16SJoe Perches print '-' x length($vname) . "\n"; 754d8469f16SJoe Perches print "$vname\n"; 755d8469f16SJoe Perches print '-' x length($vname) . "\n"; 756d8469f16SJoe Perches } 757d8469f16SJoe Perches 758c2fdda0dSAndy Whitcroft if (!process($filename)) { 7590a920b5bSAndy Whitcroft $exit = 1; 7600a920b5bSAndy Whitcroft } 76100df344fSAndy Whitcroft @rawlines = (); 76213214adfSAndy Whitcroft @lines = (); 7633705ce5bSJoe Perches @fixed = (); 764d752fcc8SJoe Perches @fixed_inserted = (); 765d752fcc8SJoe Perches @fixed_deleted = (); 766194f66fcSJoe Perches $fixlinenr = -1; 767485ff23eSAlex Dowad @modifierListFile = (); 768485ff23eSAlex Dowad @typeListFile = (); 769485ff23eSAlex Dowad build_types(); 7700a920b5bSAndy Whitcroft} 7710a920b5bSAndy Whitcroft 772d8469f16SJoe Perchesif (!$quiet) { 773d8469f16SJoe Perches if ($^V lt 5.10.0) { 774d8469f16SJoe Perches print << "EOM" 775d8469f16SJoe Perches 776d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 777d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 778d8469f16SJoe PerchesEOM 779d8469f16SJoe Perches } 780d8469f16SJoe Perches if ($exit) { 781d8469f16SJoe Perches print << "EOM" 782d8469f16SJoe Perches 783d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 784d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 785d8469f16SJoe PerchesEOM 786d8469f16SJoe Perches } 787d8469f16SJoe Perches} 788d8469f16SJoe Perches 7890a920b5bSAndy Whitcroftexit($exit); 7900a920b5bSAndy Whitcroft 7910a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7926c72ffaaSAndy Whitcroft my ($root) = @_; 7936c72ffaaSAndy Whitcroft 7946c72ffaaSAndy Whitcroft my @tree_check = ( 7956c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7966c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 7976c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 7986c72ffaaSAndy Whitcroft ); 7996c72ffaaSAndy Whitcroft 8006c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 8016c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 8020a920b5bSAndy Whitcroft return 0; 8030a920b5bSAndy Whitcroft } 8046c72ffaaSAndy Whitcroft } 8056c72ffaaSAndy Whitcroft return 1; 8066c72ffaaSAndy Whitcroft} 8070a920b5bSAndy Whitcroft 80820112475SJoe Perchessub parse_email { 80920112475SJoe Perches my ($formatted_email) = @_; 81020112475SJoe Perches 81120112475SJoe Perches my $name = ""; 81220112475SJoe Perches my $address = ""; 81320112475SJoe Perches my $comment = ""; 81420112475SJoe Perches 81520112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 81620112475SJoe Perches $name = $1; 81720112475SJoe Perches $address = $2; 81820112475SJoe Perches $comment = $3 if defined $3; 81920112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 82020112475SJoe Perches $address = $1; 82120112475SJoe Perches $comment = $2 if defined $2; 82220112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 82320112475SJoe Perches $address = $1; 82420112475SJoe Perches $comment = $2 if defined $2; 82520112475SJoe Perches $formatted_email =~ s/$address.*$//; 82620112475SJoe Perches $name = $formatted_email; 8273705ce5bSJoe Perches $name = trim($name); 82820112475SJoe Perches $name =~ s/^\"|\"$//g; 82920112475SJoe Perches # If there's a name left after stripping spaces and 83020112475SJoe Perches # leading quotes, and the address doesn't have both 83120112475SJoe Perches # leading and trailing angle brackets, the address 83220112475SJoe Perches # is invalid. ie: 83320112475SJoe Perches # "joe smith [email protected]" bad 83420112475SJoe Perches # "joe smith <[email protected]" bad 83520112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 83620112475SJoe Perches $name = ""; 83720112475SJoe Perches $address = ""; 83820112475SJoe Perches $comment = ""; 83920112475SJoe Perches } 84020112475SJoe Perches } 84120112475SJoe Perches 8423705ce5bSJoe Perches $name = trim($name); 84320112475SJoe Perches $name =~ s/^\"|\"$//g; 8443705ce5bSJoe Perches $address = trim($address); 84520112475SJoe Perches $address =~ s/^\<|\>$//g; 84620112475SJoe Perches 84720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 84820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 84920112475SJoe Perches $name = "\"$name\""; 85020112475SJoe Perches } 85120112475SJoe Perches 85220112475SJoe Perches return ($name, $address, $comment); 85320112475SJoe Perches} 85420112475SJoe Perches 85520112475SJoe Perchessub format_email { 85620112475SJoe Perches my ($name, $address) = @_; 85720112475SJoe Perches 85820112475SJoe Perches my $formatted_email; 85920112475SJoe Perches 8603705ce5bSJoe Perches $name = trim($name); 86120112475SJoe Perches $name =~ s/^\"|\"$//g; 8623705ce5bSJoe Perches $address = trim($address); 86320112475SJoe Perches 86420112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 86520112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 86620112475SJoe Perches $name = "\"$name\""; 86720112475SJoe Perches } 86820112475SJoe Perches 86920112475SJoe Perches if ("$name" eq "") { 87020112475SJoe Perches $formatted_email = "$address"; 87120112475SJoe Perches } else { 87220112475SJoe Perches $formatted_email = "$name <$address>"; 87320112475SJoe Perches } 87420112475SJoe Perches 87520112475SJoe Perches return $formatted_email; 87620112475SJoe Perches} 87720112475SJoe Perches 878d311cd44SJoe Perchessub which { 879d311cd44SJoe Perches my ($bin) = @_; 880d311cd44SJoe Perches 881d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 882d311cd44SJoe Perches if (-e "$path/$bin") { 883d311cd44SJoe Perches return "$path/$bin"; 884d311cd44SJoe Perches } 885d311cd44SJoe Perches } 886d311cd44SJoe Perches 887d311cd44SJoe Perches return ""; 888d311cd44SJoe Perches} 889d311cd44SJoe Perches 890000d1cc1SJoe Perchessub which_conf { 891000d1cc1SJoe Perches my ($conf) = @_; 892000d1cc1SJoe Perches 893000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 894000d1cc1SJoe Perches if (-e "$path/$conf") { 895000d1cc1SJoe Perches return "$path/$conf"; 896000d1cc1SJoe Perches } 897000d1cc1SJoe Perches } 898000d1cc1SJoe Perches 899000d1cc1SJoe Perches return ""; 900000d1cc1SJoe Perches} 901000d1cc1SJoe Perches 9020a920b5bSAndy Whitcroftsub expand_tabs { 9030a920b5bSAndy Whitcroft my ($str) = @_; 9040a920b5bSAndy Whitcroft 9050a920b5bSAndy Whitcroft my $res = ''; 9060a920b5bSAndy Whitcroft my $n = 0; 9070a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 9080a920b5bSAndy Whitcroft if ($c eq "\t") { 9090a920b5bSAndy Whitcroft $res .= ' '; 9100a920b5bSAndy Whitcroft $n++; 9110a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 9120a920b5bSAndy Whitcroft $res .= ' '; 9130a920b5bSAndy Whitcroft } 9140a920b5bSAndy Whitcroft next; 9150a920b5bSAndy Whitcroft } 9160a920b5bSAndy Whitcroft $res .= $c; 9170a920b5bSAndy Whitcroft $n++; 9180a920b5bSAndy Whitcroft } 9190a920b5bSAndy Whitcroft 9200a920b5bSAndy Whitcroft return $res; 9210a920b5bSAndy Whitcroft} 9226c72ffaaSAndy Whitcroftsub copy_spacing { 923773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 9246c72ffaaSAndy Whitcroft return $res; 9256c72ffaaSAndy Whitcroft} 9260a920b5bSAndy Whitcroft 9274a0df2efSAndy Whitcroftsub line_stats { 9284a0df2efSAndy Whitcroft my ($line) = @_; 9294a0df2efSAndy Whitcroft 9304a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 9314a0df2efSAndy Whitcroft $line =~ s/^.//; 9324a0df2efSAndy Whitcroft $line = expand_tabs($line); 9334a0df2efSAndy Whitcroft 9344a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 9354a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9364a0df2efSAndy Whitcroft 9374a0df2efSAndy Whitcroft return (length($line), length($white)); 9384a0df2efSAndy Whitcroft} 9394a0df2efSAndy Whitcroft 940773647a0SAndy Whitcroftmy $sanitise_quote = ''; 941773647a0SAndy Whitcroft 942773647a0SAndy Whitcroftsub sanitise_line_reset { 943773647a0SAndy Whitcroft my ($in_comment) = @_; 944773647a0SAndy Whitcroft 945773647a0SAndy Whitcroft if ($in_comment) { 946773647a0SAndy Whitcroft $sanitise_quote = '*/'; 947773647a0SAndy Whitcroft } else { 948773647a0SAndy Whitcroft $sanitise_quote = ''; 949773647a0SAndy Whitcroft } 950773647a0SAndy Whitcroft} 95100df344fSAndy Whitcroftsub sanitise_line { 95200df344fSAndy Whitcroft my ($line) = @_; 95300df344fSAndy Whitcroft 95400df344fSAndy Whitcroft my $res = ''; 95500df344fSAndy Whitcroft my $l = ''; 95600df344fSAndy Whitcroft 957c2fdda0dSAndy Whitcroft my $qlen = 0; 958773647a0SAndy Whitcroft my $off = 0; 959773647a0SAndy Whitcroft my $c; 96000df344fSAndy Whitcroft 961773647a0SAndy Whitcroft # Always copy over the diff marker. 962773647a0SAndy Whitcroft $res = substr($line, 0, 1); 963773647a0SAndy Whitcroft 964773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 965773647a0SAndy Whitcroft $c = substr($line, $off, 1); 966773647a0SAndy Whitcroft 967773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 968773647a0SAndy Whitcroft # and end, all to $;. 969773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 970773647a0SAndy Whitcroft $sanitise_quote = '*/'; 971773647a0SAndy Whitcroft 972773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 973773647a0SAndy Whitcroft $off++; 97400df344fSAndy Whitcroft next; 975773647a0SAndy Whitcroft } 97681bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 977773647a0SAndy Whitcroft $sanitise_quote = ''; 978773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 979773647a0SAndy Whitcroft $off++; 980773647a0SAndy Whitcroft next; 981773647a0SAndy Whitcroft } 982113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 983113f04a8SDaniel Walker $sanitise_quote = '//'; 984113f04a8SDaniel Walker 985113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 986113f04a8SDaniel Walker $off++; 987113f04a8SDaniel Walker next; 988113f04a8SDaniel Walker } 989773647a0SAndy Whitcroft 990773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 991773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 992773647a0SAndy Whitcroft $c eq "\\") { 993773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 994773647a0SAndy Whitcroft $off++; 995773647a0SAndy Whitcroft next; 996773647a0SAndy Whitcroft } 997773647a0SAndy Whitcroft # Regular quotes. 998773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 999773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1000773647a0SAndy Whitcroft $sanitise_quote = $c; 1001773647a0SAndy Whitcroft 1002773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1003773647a0SAndy Whitcroft next; 1004773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1005773647a0SAndy Whitcroft $sanitise_quote = ''; 100600df344fSAndy Whitcroft } 100700df344fSAndy Whitcroft } 1008773647a0SAndy Whitcroft 1009fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1010773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1011773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1012113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1013113f04a8SDaniel Walker substr($res, $off, 1, $;); 1014773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1015773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 101600df344fSAndy Whitcroft } else { 1017773647a0SAndy Whitcroft substr($res, $off, 1, $c); 101800df344fSAndy Whitcroft } 1019c2fdda0dSAndy Whitcroft } 1020c2fdda0dSAndy Whitcroft 1021113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1022113f04a8SDaniel Walker $sanitise_quote = ''; 1023113f04a8SDaniel Walker } 1024113f04a8SDaniel Walker 1025c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1026c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1027c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1028c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1029c2fdda0dSAndy Whitcroft 1030c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1031c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1032c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1033c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1034c2fdda0dSAndy Whitcroft } 1035c2fdda0dSAndy Whitcroft 103600df344fSAndy Whitcroft return $res; 103700df344fSAndy Whitcroft} 103800df344fSAndy Whitcroft 1039a6962d72SJoe Perchessub get_quoted_string { 1040a6962d72SJoe Perches my ($line, $rawline) = @_; 1041a6962d72SJoe Perches 104233acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1043a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1044a6962d72SJoe Perches} 1045a6962d72SJoe Perches 10468905a67cSAndy Whitcroftsub ctx_statement_block { 10478905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10488905a67cSAndy Whitcroft my $line = $linenr - 1; 10498905a67cSAndy Whitcroft my $blk = ''; 10508905a67cSAndy Whitcroft my $soff = $off; 10518905a67cSAndy Whitcroft my $coff = $off - 1; 1052773647a0SAndy Whitcroft my $coff_set = 0; 10538905a67cSAndy Whitcroft 105413214adfSAndy Whitcroft my $loff = 0; 105513214adfSAndy Whitcroft 10568905a67cSAndy Whitcroft my $type = ''; 10578905a67cSAndy Whitcroft my $level = 0; 1058a2750645SAndy Whitcroft my @stack = (); 1059cf655043SAndy Whitcroft my $p; 10608905a67cSAndy Whitcroft my $c; 10618905a67cSAndy Whitcroft my $len = 0; 106213214adfSAndy Whitcroft 106313214adfSAndy Whitcroft my $remainder; 10648905a67cSAndy Whitcroft while (1) { 1065a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1066a2750645SAndy Whitcroft 1067773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10688905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10698905a67cSAndy Whitcroft # context. 10708905a67cSAndy Whitcroft if ($off >= $len) { 10718905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1072dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1073c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10748905a67cSAndy Whitcroft $remain--; 107513214adfSAndy Whitcroft $loff = $len; 1076c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10778905a67cSAndy Whitcroft $len = length($blk); 10788905a67cSAndy Whitcroft $line++; 10798905a67cSAndy Whitcroft last; 10808905a67cSAndy Whitcroft } 10818905a67cSAndy Whitcroft # Bail if there is no further context. 10828905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 108313214adfSAndy Whitcroft if ($off >= $len) { 10848905a67cSAndy Whitcroft last; 10858905a67cSAndy Whitcroft } 1086f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1087f74bd194SAndy Whitcroft $level++; 1088f74bd194SAndy Whitcroft $type = '#'; 1089f74bd194SAndy Whitcroft } 10908905a67cSAndy Whitcroft } 1091cf655043SAndy Whitcroft $p = $c; 10928905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 109313214adfSAndy Whitcroft $remainder = substr($blk, $off); 10948905a67cSAndy Whitcroft 1095773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10964635f4fbSAndy Whitcroft 10974635f4fbSAndy Whitcroft # Handle nested #if/#else. 10984635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 10994635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 11004635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 11014635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 11024635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 11034635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 11044635f4fbSAndy Whitcroft } 11054635f4fbSAndy Whitcroft 11068905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 11078905a67cSAndy Whitcroft # outermost level. 11088905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 11098905a67cSAndy Whitcroft last; 11108905a67cSAndy Whitcroft } 11118905a67cSAndy Whitcroft 111213214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1113773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1114773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1115773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1116773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1117773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1118773647a0SAndy Whitcroft $coff_set = 1; 1119773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1120773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 112113214adfSAndy Whitcroft } 112213214adfSAndy Whitcroft 11238905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 11248905a67cSAndy Whitcroft $level++; 11258905a67cSAndy Whitcroft $type = '('; 11268905a67cSAndy Whitcroft } 11278905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 11288905a67cSAndy Whitcroft $level--; 11298905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 11308905a67cSAndy Whitcroft 11318905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 11328905a67cSAndy Whitcroft $coff = $off; 1133773647a0SAndy Whitcroft $coff_set = 1; 1134773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 11358905a67cSAndy Whitcroft } 11368905a67cSAndy Whitcroft } 11378905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11388905a67cSAndy Whitcroft $level++; 11398905a67cSAndy Whitcroft $type = '{'; 11408905a67cSAndy Whitcroft } 11418905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11428905a67cSAndy Whitcroft $level--; 11438905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11448905a67cSAndy Whitcroft 11458905a67cSAndy Whitcroft if ($level == 0) { 1146b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1147b998e001SPatrick Pannuto $off++; 1148b998e001SPatrick Pannuto } 11498905a67cSAndy Whitcroft last; 11508905a67cSAndy Whitcroft } 11518905a67cSAndy Whitcroft } 1152f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1153f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1154f74bd194SAndy Whitcroft $level--; 1155f74bd194SAndy Whitcroft $type = ''; 1156f74bd194SAndy Whitcroft $off++; 1157f74bd194SAndy Whitcroft last; 1158f74bd194SAndy Whitcroft } 11598905a67cSAndy Whitcroft $off++; 11608905a67cSAndy Whitcroft } 1161a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 116213214adfSAndy Whitcroft if ($off == $len) { 1163a3bb97a7SAndy Whitcroft $loff = $len + 1; 116413214adfSAndy Whitcroft $line++; 116513214adfSAndy Whitcroft $remain--; 116613214adfSAndy Whitcroft } 11678905a67cSAndy Whitcroft 11688905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11698905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11708905a67cSAndy Whitcroft 11718905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11728905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11738905a67cSAndy Whitcroft 1174773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 117513214adfSAndy Whitcroft 117613214adfSAndy Whitcroft return ($statement, $condition, 117713214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 117813214adfSAndy Whitcroft} 117913214adfSAndy Whitcroft 1180cf655043SAndy Whitcroftsub statement_lines { 1181cf655043SAndy Whitcroft my ($stmt) = @_; 1182cf655043SAndy Whitcroft 1183cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1184cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1185cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1186cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1187cf655043SAndy Whitcroft 1188cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1189cf655043SAndy Whitcroft 1190cf655043SAndy Whitcroft return $#stmt_lines + 2; 1191cf655043SAndy Whitcroft} 1192cf655043SAndy Whitcroft 1193cf655043SAndy Whitcroftsub statement_rawlines { 1194cf655043SAndy Whitcroft my ($stmt) = @_; 1195cf655043SAndy Whitcroft 1196cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1197cf655043SAndy Whitcroft 1198cf655043SAndy Whitcroft return $#stmt_lines + 2; 1199cf655043SAndy Whitcroft} 1200cf655043SAndy Whitcroft 1201cf655043SAndy Whitcroftsub statement_block_size { 1202cf655043SAndy Whitcroft my ($stmt) = @_; 1203cf655043SAndy Whitcroft 1204cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1205cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1206cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1207cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1208cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1209cf655043SAndy Whitcroft 1210cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1211cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1212cf655043SAndy Whitcroft 1213cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1214cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1215cf655043SAndy Whitcroft 1216cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1217cf655043SAndy Whitcroft return $stmt_lines; 1218cf655043SAndy Whitcroft } else { 1219cf655043SAndy Whitcroft return $stmt_statements; 1220cf655043SAndy Whitcroft } 1221cf655043SAndy Whitcroft} 1222cf655043SAndy Whitcroft 122313214adfSAndy Whitcroftsub ctx_statement_full { 122413214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 122513214adfSAndy Whitcroft my ($statement, $condition, $level); 122613214adfSAndy Whitcroft 122713214adfSAndy Whitcroft my (@chunks); 122813214adfSAndy Whitcroft 1229cf655043SAndy Whitcroft # Grab the first conditional/block pair. 123013214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 123113214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1232773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 123313214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1234cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1235cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1236cf655043SAndy Whitcroft } 1237cf655043SAndy Whitcroft 1238cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1239cf655043SAndy Whitcroft # could continue the statement. 1240cf655043SAndy Whitcroft for (;;) { 124113214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 124213214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1243cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1244773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1245cf655043SAndy Whitcroft #print "C: push\n"; 1246cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 124713214adfSAndy Whitcroft } 124813214adfSAndy Whitcroft 124913214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12508905a67cSAndy Whitcroft} 12518905a67cSAndy Whitcroft 12524a0df2efSAndy Whitcroftsub ctx_block_get { 1253f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12544a0df2efSAndy Whitcroft my $line; 12554a0df2efSAndy Whitcroft my $start = $linenr - 1; 12564a0df2efSAndy Whitcroft my $blk = ''; 12574a0df2efSAndy Whitcroft my @o; 12584a0df2efSAndy Whitcroft my @c; 12594a0df2efSAndy Whitcroft my @res = (); 12604a0df2efSAndy Whitcroft 1261f0a594c1SAndy Whitcroft my $level = 0; 12624635f4fbSAndy Whitcroft my @stack = ($level); 126300df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 126400df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 126500df344fSAndy Whitcroft $remain--; 126600df344fSAndy Whitcroft 126700df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12684635f4fbSAndy Whitcroft 12694635f4fbSAndy Whitcroft # Handle nested #if/#else. 127001464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12714635f4fbSAndy Whitcroft push(@stack, $level); 127201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12734635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 127401464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12754635f4fbSAndy Whitcroft $level = pop(@stack); 12764635f4fbSAndy Whitcroft } 12774635f4fbSAndy Whitcroft 127801464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1279f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1280f0a594c1SAndy Whitcroft if ($off > 0) { 1281f0a594c1SAndy Whitcroft $off--; 1282f0a594c1SAndy Whitcroft next; 1283f0a594c1SAndy Whitcroft } 12844a0df2efSAndy Whitcroft 1285f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1286f0a594c1SAndy Whitcroft $level--; 1287f0a594c1SAndy Whitcroft last if ($level == 0); 1288f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1289f0a594c1SAndy Whitcroft $level++; 1290f0a594c1SAndy Whitcroft } 1291f0a594c1SAndy Whitcroft } 12924a0df2efSAndy Whitcroft 1293f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 129400df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12954a0df2efSAndy Whitcroft } 12964a0df2efSAndy Whitcroft 1297f0a594c1SAndy Whitcroft last if ($level == 0); 12984a0df2efSAndy Whitcroft } 12994a0df2efSAndy Whitcroft 1300f0a594c1SAndy Whitcroft return ($level, @res); 13014a0df2efSAndy Whitcroft} 13024a0df2efSAndy Whitcroftsub ctx_block_outer { 13034a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13044a0df2efSAndy Whitcroft 1305f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1306f0a594c1SAndy Whitcroft return @r; 13074a0df2efSAndy Whitcroft} 13084a0df2efSAndy Whitcroftsub ctx_block { 13094a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13104a0df2efSAndy Whitcroft 1311f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1312f0a594c1SAndy Whitcroft return @r; 1313653d4876SAndy Whitcroft} 1314653d4876SAndy Whitcroftsub ctx_statement { 1315f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1316f0a594c1SAndy Whitcroft 1317f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1318f0a594c1SAndy Whitcroft return @r; 1319f0a594c1SAndy Whitcroft} 1320f0a594c1SAndy Whitcroftsub ctx_block_level { 1321653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1322653d4876SAndy Whitcroft 1323f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 13244a0df2efSAndy Whitcroft} 13259c0ca6f9SAndy Whitcroftsub ctx_statement_level { 13269c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 13279c0ca6f9SAndy Whitcroft 13289c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 13299c0ca6f9SAndy Whitcroft} 13304a0df2efSAndy Whitcroft 13314a0df2efSAndy Whitcroftsub ctx_locate_comment { 13324a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13334a0df2efSAndy Whitcroft 13344a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1335beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13364a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13374a0df2efSAndy Whitcroft 13384a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13394a0df2efSAndy Whitcroft # comment. 13404a0df2efSAndy Whitcroft my $in_comment = 0; 13414a0df2efSAndy Whitcroft $current_comment = ''; 13424a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 134300df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 134400df344fSAndy Whitcroft #warn " $line\n"; 13454a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13464a0df2efSAndy Whitcroft $in_comment = 1; 13474a0df2efSAndy Whitcroft } 13484a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13494a0df2efSAndy Whitcroft $in_comment = 1; 13504a0df2efSAndy Whitcroft } 13514a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13524a0df2efSAndy Whitcroft $current_comment = ''; 13534a0df2efSAndy Whitcroft } 13544a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13554a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13564a0df2efSAndy Whitcroft $in_comment = 0; 13574a0df2efSAndy Whitcroft } 13584a0df2efSAndy Whitcroft } 13594a0df2efSAndy Whitcroft 13604a0df2efSAndy Whitcroft chomp($current_comment); 13614a0df2efSAndy Whitcroft return($current_comment); 13624a0df2efSAndy Whitcroft} 13634a0df2efSAndy Whitcroftsub ctx_has_comment { 13644a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13654a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13664a0df2efSAndy Whitcroft 136700df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13684a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13694a0df2efSAndy Whitcroft 13704a0df2efSAndy Whitcroft return ($cmt ne ''); 13714a0df2efSAndy Whitcroft} 13724a0df2efSAndy Whitcroft 13734d001e4dSAndy Whitcroftsub raw_line { 13744d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13754d001e4dSAndy Whitcroft 13764d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13774d001e4dSAndy Whitcroft $cnt++; 13784d001e4dSAndy Whitcroft 13794d001e4dSAndy Whitcroft my $line; 13804d001e4dSAndy Whitcroft while ($cnt) { 13814d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13824d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13834d001e4dSAndy Whitcroft $cnt--; 13844d001e4dSAndy Whitcroft } 13854d001e4dSAndy Whitcroft 13864d001e4dSAndy Whitcroft return $line; 13874d001e4dSAndy Whitcroft} 13884d001e4dSAndy Whitcroft 13890a920b5bSAndy Whitcroftsub cat_vet { 13900a920b5bSAndy Whitcroft my ($vet) = @_; 13919c0ca6f9SAndy Whitcroft my ($res, $coded); 13920a920b5bSAndy Whitcroft 13939c0ca6f9SAndy Whitcroft $res = ''; 13946c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13956c72ffaaSAndy Whitcroft $res .= $1; 13966c72ffaaSAndy Whitcroft if ($2 ne '') { 13979c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 13986c72ffaaSAndy Whitcroft $res .= $coded; 13996c72ffaaSAndy Whitcroft } 14009c0ca6f9SAndy Whitcroft } 14019c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 14020a920b5bSAndy Whitcroft 14039c0ca6f9SAndy Whitcroft return $res; 14040a920b5bSAndy Whitcroft} 14050a920b5bSAndy Whitcroft 1406c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1407cf655043SAndy Whitcroftmy $av_pending; 1408c2fdda0dSAndy Whitcroftmy @av_paren_type; 14091f65f947SAndy Whitcroftmy $av_pend_colon; 1410c2fdda0dSAndy Whitcroft 1411c2fdda0dSAndy Whitcroftsub annotate_reset { 1412c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1413cf655043SAndy Whitcroft $av_pending = '_'; 1414cf655043SAndy Whitcroft @av_paren_type = ('E'); 14151f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1416c2fdda0dSAndy Whitcroft} 1417c2fdda0dSAndy Whitcroft 14186c72ffaaSAndy Whitcroftsub annotate_values { 14196c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 14206c72ffaaSAndy Whitcroft 14216c72ffaaSAndy Whitcroft my $res; 14221f65f947SAndy Whitcroft my $var = '_' x length($stream); 14236c72ffaaSAndy Whitcroft my $cur = $stream; 14246c72ffaaSAndy Whitcroft 1425c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 14266c72ffaaSAndy Whitcroft 14276c72ffaaSAndy Whitcroft while (length($cur)) { 1428773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1429cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1430171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 14316c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1432c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1433c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1434cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1435c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14366c72ffaaSAndy Whitcroft } 14376c72ffaaSAndy Whitcroft 1438c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14399446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14409446ef56SAndy Whitcroft push(@av_paren_type, $type); 1441addcdceaSAndy Whitcroft $type = 'c'; 14429446ef56SAndy Whitcroft 1443e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1444c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14456c72ffaaSAndy Whitcroft $type = 'T'; 14466c72ffaaSAndy Whitcroft 1447389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1448389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1449389a2fe5SAndy Whitcroft $type = 'T'; 1450389a2fe5SAndy Whitcroft 1451c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1452171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1453c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1454171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1455171ae1a4SAndy Whitcroft if ($2 ne '') { 1456cf655043SAndy Whitcroft $av_pending = 'N'; 1457171ae1a4SAndy Whitcroft } 1458171ae1a4SAndy Whitcroft $type = 'E'; 1459171ae1a4SAndy Whitcroft 1460c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1461171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1462171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1463171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14646c72ffaaSAndy Whitcroft 1465c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1466cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1467c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1468cf655043SAndy Whitcroft 1469cf655043SAndy Whitcroft push(@av_paren_type, $type); 1470cf655043SAndy Whitcroft push(@av_paren_type, $type); 1471171ae1a4SAndy Whitcroft $type = 'E'; 1472cf655043SAndy Whitcroft 1473c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1474cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1475cf655043SAndy Whitcroft $av_preprocessor = 1; 1476cf655043SAndy Whitcroft 1477cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1478cf655043SAndy Whitcroft 1479171ae1a4SAndy Whitcroft $type = 'E'; 1480cf655043SAndy Whitcroft 1481c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1482cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1483cf655043SAndy Whitcroft 1484cf655043SAndy Whitcroft $av_preprocessor = 1; 1485cf655043SAndy Whitcroft 1486cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1487cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1488cf655043SAndy Whitcroft pop(@av_paren_type); 1489cf655043SAndy Whitcroft push(@av_paren_type, $type); 1490171ae1a4SAndy Whitcroft $type = 'E'; 14916c72ffaaSAndy Whitcroft 14926c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1493c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14946c72ffaaSAndy Whitcroft 1495171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1496171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1497171ae1a4SAndy Whitcroft $av_pending = $type; 1498171ae1a4SAndy Whitcroft $type = 'N'; 1499171ae1a4SAndy Whitcroft 15006c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1501c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 15026c72ffaaSAndy Whitcroft if (defined $2) { 1503cf655043SAndy Whitcroft $av_pending = 'V'; 15046c72ffaaSAndy Whitcroft } 15056c72ffaaSAndy Whitcroft $type = 'N'; 15066c72ffaaSAndy Whitcroft 150714b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1508c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 150914b111c1SAndy Whitcroft $av_pending = 'E'; 15106c72ffaaSAndy Whitcroft $type = 'N'; 15116c72ffaaSAndy Whitcroft 15121f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 15131f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 15141f65f947SAndy Whitcroft $av_pend_colon = 'C'; 15151f65f947SAndy Whitcroft $type = 'N'; 15161f65f947SAndy Whitcroft 151714b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1518c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 15196c72ffaaSAndy Whitcroft $type = 'N'; 15206c72ffaaSAndy Whitcroft 15216c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1522c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1523cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1524cf655043SAndy Whitcroft $av_pending = '_'; 15256c72ffaaSAndy Whitcroft $type = 'N'; 15266c72ffaaSAndy Whitcroft 15276c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1528cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1529cf655043SAndy Whitcroft if ($new_type ne '_') { 1530cf655043SAndy Whitcroft $type = $new_type; 1531c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1532c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 15336c72ffaaSAndy Whitcroft } else { 1534c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 15356c72ffaaSAndy Whitcroft } 15366c72ffaaSAndy Whitcroft 1537c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1538c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1539c8cb2ca3SAndy Whitcroft $type = 'V'; 1540cf655043SAndy Whitcroft $av_pending = 'V'; 15416c72ffaaSAndy Whitcroft 15428e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15438e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15441f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15458e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15468e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15471f65f947SAndy Whitcroft } 15481f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15491f65f947SAndy Whitcroft $type = 'V'; 15501f65f947SAndy Whitcroft 15516c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1552c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15536c72ffaaSAndy Whitcroft $type = 'V'; 15546c72ffaaSAndy Whitcroft 15556c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1556c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15576c72ffaaSAndy Whitcroft $type = 'N'; 15586c72ffaaSAndy Whitcroft 1559cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1560c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 156113214adfSAndy Whitcroft $type = 'E'; 15621f65f947SAndy Whitcroft $av_pend_colon = 'O'; 156313214adfSAndy Whitcroft 15648e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15658e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15668e761b04SAndy Whitcroft $type = 'C'; 15678e761b04SAndy Whitcroft 15681f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15691f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15701f65f947SAndy Whitcroft $type = 'N'; 15711f65f947SAndy Whitcroft 15721f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15731f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15741f65f947SAndy Whitcroft 15751f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15761f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15771f65f947SAndy Whitcroft $type = 'E'; 15781f65f947SAndy Whitcroft } else { 15791f65f947SAndy Whitcroft $type = 'N'; 15801f65f947SAndy Whitcroft } 15811f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15821f65f947SAndy Whitcroft 15838e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 158413214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15856c72ffaaSAndy Whitcroft $type = 'N'; 15866c72ffaaSAndy Whitcroft 15870d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 158874048ed8SAndy Whitcroft my $variant; 158974048ed8SAndy Whitcroft 159074048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 159174048ed8SAndy Whitcroft if ($type eq 'V') { 159274048ed8SAndy Whitcroft $variant = 'B'; 159374048ed8SAndy Whitcroft } else { 159474048ed8SAndy Whitcroft $variant = 'U'; 159574048ed8SAndy Whitcroft } 159674048ed8SAndy Whitcroft 159774048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 159874048ed8SAndy Whitcroft $type = 'N'; 159974048ed8SAndy Whitcroft 16006c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1601c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 16026c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 16036c72ffaaSAndy Whitcroft $type = 'N'; 16046c72ffaaSAndy Whitcroft } 16056c72ffaaSAndy Whitcroft 16066c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1607c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 16086c72ffaaSAndy Whitcroft } 16096c72ffaaSAndy Whitcroft if (defined $1) { 16106c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 16116c72ffaaSAndy Whitcroft $res .= $type x length($1); 16126c72ffaaSAndy Whitcroft } 16136c72ffaaSAndy Whitcroft } 16146c72ffaaSAndy Whitcroft 16151f65f947SAndy Whitcroft return ($res, $var); 16166c72ffaaSAndy Whitcroft} 16176c72ffaaSAndy Whitcroft 16188905a67cSAndy Whitcroftsub possible { 161913214adfSAndy Whitcroft my ($possible, $line) = @_; 16209a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 16210776e594SAndy Whitcroft ^(?: 16220776e594SAndy Whitcroft $Modifier| 16230776e594SAndy Whitcroft $Storage| 16240776e594SAndy Whitcroft $Type| 16259a974fdbSAndy Whitcroft DEFINE_\S+ 16269a974fdbSAndy Whitcroft )$| 16279a974fdbSAndy Whitcroft ^(?: 16280776e594SAndy Whitcroft goto| 16290776e594SAndy Whitcroft return| 16300776e594SAndy Whitcroft case| 16310776e594SAndy Whitcroft else| 16320776e594SAndy Whitcroft asm|__asm__| 163389a88353SAndy Whitcroft do| 163489a88353SAndy Whitcroft \#| 163589a88353SAndy Whitcroft \#\#| 16369a974fdbSAndy Whitcroft )(?:\s|$)| 16370776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16389a974fdbSAndy Whitcroft )}x; 16399a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16409a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1641c45dcabdSAndy Whitcroft # Check for modifiers. 1642c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1643c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1644c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1645c45dcabdSAndy Whitcroft 1646c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1647c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1648d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16499a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1650d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1651485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1652d2506586SAndy Whitcroft } 16539a974fdbSAndy Whitcroft } 1654c45dcabdSAndy Whitcroft 1655c45dcabdSAndy Whitcroft } else { 165613214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1657485ff23eSAlex Dowad push(@typeListFile, $possible); 1658c45dcabdSAndy Whitcroft } 16598905a67cSAndy Whitcroft build_types(); 16600776e594SAndy Whitcroft } else { 16610776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16628905a67cSAndy Whitcroft } 16638905a67cSAndy Whitcroft} 16648905a67cSAndy Whitcroft 16656c72ffaaSAndy Whitcroftmy $prefix = ''; 16666c72ffaaSAndy Whitcroft 1667000d1cc1SJoe Perchessub show_type { 1668cbec18afSJoe Perches my ($type) = @_; 166991bfe484SJoe Perches 1670cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1671cbec18afSJoe Perches 1672cbec18afSJoe Perches return !defined $ignore_type{$type}; 1673000d1cc1SJoe Perches} 1674000d1cc1SJoe Perches 1675f0a594c1SAndy Whitcroftsub report { 1676cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1677cbec18afSJoe Perches 1678cbec18afSJoe Perches if (!show_type($type) || 1679cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1680773647a0SAndy Whitcroft return 0; 1681773647a0SAndy Whitcroft } 168257230297SJoe Perches my $output = ''; 168357230297SJoe Perches if (-t STDOUT && $color) { 168457230297SJoe Perches if ($level eq 'ERROR') { 168557230297SJoe Perches $output .= RED; 168657230297SJoe Perches } elsif ($level eq 'WARNING') { 168757230297SJoe Perches $output .= YELLOW; 1688000d1cc1SJoe Perches } else { 168957230297SJoe Perches $output .= GREEN; 1690000d1cc1SJoe Perches } 169157230297SJoe Perches } 169257230297SJoe Perches $output .= $prefix . $level . ':'; 169357230297SJoe Perches if ($show_types) { 169457230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 169557230297SJoe Perches $output .= "$type:"; 169657230297SJoe Perches } 169757230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 169857230297SJoe Perches $output .= ' ' . $msg . "\n"; 169934d8815fSJoe Perches 170034d8815fSJoe Perches if ($showfile) { 170134d8815fSJoe Perches my @lines = split("\n", $output, -1); 170234d8815fSJoe Perches splice(@lines, 1, 1); 170334d8815fSJoe Perches $output = join("\n", @lines); 170434d8815fSJoe Perches } 170557230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 17068905a67cSAndy Whitcroft 170757230297SJoe Perches push(our @report, $output); 1708773647a0SAndy Whitcroft 1709773647a0SAndy Whitcroft return 1; 1710f0a594c1SAndy Whitcroft} 1711cbec18afSJoe Perches 1712f0a594c1SAndy Whitcroftsub report_dump { 171313214adfSAndy Whitcroft our @report; 1714f0a594c1SAndy Whitcroft} 1715000d1cc1SJoe Perches 1716d752fcc8SJoe Perchessub fixup_current_range { 1717d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1718d752fcc8SJoe Perches 1719d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1720d752fcc8SJoe Perches my $o = $1; 1721d752fcc8SJoe Perches my $l = $2; 1722d752fcc8SJoe Perches my $no = $o + $offset; 1723d752fcc8SJoe Perches my $nl = $l + $length; 1724d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1725d752fcc8SJoe Perches } 1726d752fcc8SJoe Perches} 1727d752fcc8SJoe Perches 1728d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1729d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1730d752fcc8SJoe Perches 1731d752fcc8SJoe Perches my $range_last_linenr = 0; 1732d752fcc8SJoe Perches my $delta_offset = 0; 1733d752fcc8SJoe Perches 1734d752fcc8SJoe Perches my $old_linenr = 0; 1735d752fcc8SJoe Perches my $new_linenr = 0; 1736d752fcc8SJoe Perches 1737d752fcc8SJoe Perches my $next_insert = 0; 1738d752fcc8SJoe Perches my $next_delete = 0; 1739d752fcc8SJoe Perches 1740d752fcc8SJoe Perches my @lines = (); 1741d752fcc8SJoe Perches 1742d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1743d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1744d752fcc8SJoe Perches 1745d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1746d752fcc8SJoe Perches my $save_line = 1; 1747d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1748323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1749d752fcc8SJoe Perches $delta_offset = 0; 1750d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1751d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1752d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1753d752fcc8SJoe Perches } 1754d752fcc8SJoe Perches 1755d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1756d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1757d752fcc8SJoe Perches $save_line = 0; 1758d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1759d752fcc8SJoe Perches } 1760d752fcc8SJoe Perches 1761d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1762d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1763d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1764d752fcc8SJoe Perches $new_linenr++; 1765d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1766d752fcc8SJoe Perches } 1767d752fcc8SJoe Perches 1768d752fcc8SJoe Perches if ($save_line) { 1769d752fcc8SJoe Perches push(@lines, $line); 1770d752fcc8SJoe Perches $new_linenr++; 1771d752fcc8SJoe Perches } 1772d752fcc8SJoe Perches 1773d752fcc8SJoe Perches $old_linenr++; 1774d752fcc8SJoe Perches } 1775d752fcc8SJoe Perches 1776d752fcc8SJoe Perches return @lines; 1777d752fcc8SJoe Perches} 1778d752fcc8SJoe Perches 1779f2d7e4d4SJoe Perchessub fix_insert_line { 1780f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1781f2d7e4d4SJoe Perches 1782f2d7e4d4SJoe Perches my $inserted = { 1783f2d7e4d4SJoe Perches LINENR => $linenr, 1784f2d7e4d4SJoe Perches LINE => $line, 1785f2d7e4d4SJoe Perches }; 1786f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1787f2d7e4d4SJoe Perches} 1788f2d7e4d4SJoe Perches 1789f2d7e4d4SJoe Perchessub fix_delete_line { 1790f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1791f2d7e4d4SJoe Perches 1792f2d7e4d4SJoe Perches my $deleted = { 1793f2d7e4d4SJoe Perches LINENR => $linenr, 1794f2d7e4d4SJoe Perches LINE => $line, 1795f2d7e4d4SJoe Perches }; 1796f2d7e4d4SJoe Perches 1797f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1798f2d7e4d4SJoe Perches} 1799f2d7e4d4SJoe Perches 1800de7d4f0eSAndy Whitcroftsub ERROR { 1801cbec18afSJoe Perches my ($type, $msg) = @_; 1802cbec18afSJoe Perches 1803cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1804de7d4f0eSAndy Whitcroft our $clean = 0; 18056c72ffaaSAndy Whitcroft our $cnt_error++; 18063705ce5bSJoe Perches return 1; 1807de7d4f0eSAndy Whitcroft } 18083705ce5bSJoe Perches return 0; 1809773647a0SAndy Whitcroft} 1810de7d4f0eSAndy Whitcroftsub WARN { 1811cbec18afSJoe Perches my ($type, $msg) = @_; 1812cbec18afSJoe Perches 1813cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1814de7d4f0eSAndy Whitcroft our $clean = 0; 18156c72ffaaSAndy Whitcroft our $cnt_warn++; 18163705ce5bSJoe Perches return 1; 1817de7d4f0eSAndy Whitcroft } 18183705ce5bSJoe Perches return 0; 1819773647a0SAndy Whitcroft} 1820de7d4f0eSAndy Whitcroftsub CHK { 1821cbec18afSJoe Perches my ($type, $msg) = @_; 1822cbec18afSJoe Perches 1823cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1824de7d4f0eSAndy Whitcroft our $clean = 0; 18256c72ffaaSAndy Whitcroft our $cnt_chk++; 18263705ce5bSJoe Perches return 1; 18276c72ffaaSAndy Whitcroft } 18283705ce5bSJoe Perches return 0; 1829de7d4f0eSAndy Whitcroft} 1830de7d4f0eSAndy Whitcroft 18316ecd9674SAndy Whitcroftsub check_absolute_file { 18326ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 18336ecd9674SAndy Whitcroft my $file = $absolute; 18346ecd9674SAndy Whitcroft 18356ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 18366ecd9674SAndy Whitcroft 18376ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 18386ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 18396ecd9674SAndy Whitcroft if (-f "$root/$file") { 18406ecd9674SAndy Whitcroft ##print "file<$file>\n"; 18416ecd9674SAndy Whitcroft last; 18426ecd9674SAndy Whitcroft } 18436ecd9674SAndy Whitcroft } 18446ecd9674SAndy Whitcroft if (! -f _) { 18456ecd9674SAndy Whitcroft return 0; 18466ecd9674SAndy Whitcroft } 18476ecd9674SAndy Whitcroft 18486ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 18496ecd9674SAndy Whitcroft my $prefix = $absolute; 18506ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 18516ecd9674SAndy Whitcroft 18526ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18536ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1854000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1855000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18566ecd9674SAndy Whitcroft } 18576ecd9674SAndy Whitcroft} 18586ecd9674SAndy Whitcroft 18593705ce5bSJoe Perchessub trim { 18603705ce5bSJoe Perches my ($string) = @_; 18613705ce5bSJoe Perches 1862b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1863b34c648bSJoe Perches 1864b34c648bSJoe Perches return $string; 1865b34c648bSJoe Perches} 1866b34c648bSJoe Perches 1867b34c648bSJoe Perchessub ltrim { 1868b34c648bSJoe Perches my ($string) = @_; 1869b34c648bSJoe Perches 1870b34c648bSJoe Perches $string =~ s/^\s+//; 1871b34c648bSJoe Perches 1872b34c648bSJoe Perches return $string; 1873b34c648bSJoe Perches} 1874b34c648bSJoe Perches 1875b34c648bSJoe Perchessub rtrim { 1876b34c648bSJoe Perches my ($string) = @_; 1877b34c648bSJoe Perches 1878b34c648bSJoe Perches $string =~ s/\s+$//; 18793705ce5bSJoe Perches 18803705ce5bSJoe Perches return $string; 18813705ce5bSJoe Perches} 18823705ce5bSJoe Perches 188352ea8506SJoe Perchessub string_find_replace { 188452ea8506SJoe Perches my ($string, $find, $replace) = @_; 188552ea8506SJoe Perches 188652ea8506SJoe Perches $string =~ s/$find/$replace/g; 188752ea8506SJoe Perches 188852ea8506SJoe Perches return $string; 188952ea8506SJoe Perches} 189052ea8506SJoe Perches 18913705ce5bSJoe Perchessub tabify { 18923705ce5bSJoe Perches my ($leading) = @_; 18933705ce5bSJoe Perches 18943705ce5bSJoe Perches my $source_indent = 8; 18953705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 18963705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 18973705ce5bSJoe Perches 18983705ce5bSJoe Perches #convert leading spaces to tabs 18993705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 19003705ce5bSJoe Perches #Remove spaces before a tab 19013705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 19023705ce5bSJoe Perches 19033705ce5bSJoe Perches return "$leading"; 19043705ce5bSJoe Perches} 19053705ce5bSJoe Perches 1906d1fe9c09SJoe Perchessub pos_last_openparen { 1907d1fe9c09SJoe Perches my ($line) = @_; 1908d1fe9c09SJoe Perches 1909d1fe9c09SJoe Perches my $pos = 0; 1910d1fe9c09SJoe Perches 1911d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1912d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1913d1fe9c09SJoe Perches 1914d1fe9c09SJoe Perches my $last_openparen = 0; 1915d1fe9c09SJoe Perches 1916d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1917d1fe9c09SJoe Perches return -1; 1918d1fe9c09SJoe Perches } 1919d1fe9c09SJoe Perches 1920d1fe9c09SJoe Perches my $len = length($line); 1921d1fe9c09SJoe Perches 1922d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1923d1fe9c09SJoe Perches my $string = substr($line, $pos); 1924d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1925d1fe9c09SJoe Perches $pos += length($1) - 1; 1926d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1927d1fe9c09SJoe Perches $last_openparen = $pos; 1928d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1929d1fe9c09SJoe Perches last; 1930d1fe9c09SJoe Perches } 1931d1fe9c09SJoe Perches } 1932d1fe9c09SJoe Perches 193391cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1934d1fe9c09SJoe Perches} 1935d1fe9c09SJoe Perches 19360a920b5bSAndy Whitcroftsub process { 19370a920b5bSAndy Whitcroft my $filename = shift; 19380a920b5bSAndy Whitcroft 19390a920b5bSAndy Whitcroft my $linenr=0; 19400a920b5bSAndy Whitcroft my $prevline=""; 1941c2fdda0dSAndy Whitcroft my $prevrawline=""; 19420a920b5bSAndy Whitcroft my $stashline=""; 1943c2fdda0dSAndy Whitcroft my $stashrawline=""; 19440a920b5bSAndy Whitcroft 19454a0df2efSAndy Whitcroft my $length; 19460a920b5bSAndy Whitcroft my $indent; 19470a920b5bSAndy Whitcroft my $previndent=0; 19480a920b5bSAndy Whitcroft my $stashindent=0; 19490a920b5bSAndy Whitcroft 1950de7d4f0eSAndy Whitcroft our $clean = 1; 19510a920b5bSAndy Whitcroft my $signoff = 0; 19520a920b5bSAndy Whitcroft my $is_patch = 0; 19530a920b5bSAndy Whitcroft 195429ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 195515662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 19562a076f40SJoe Perches my $commit_log_long_line = 0; 195713f1937eSJoe Perches my $reported_maintainer_file = 0; 1958fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1959fa64205dSPasi Savanainen 1960365dd4eaSJoe Perches my $last_blank_line = 0; 19615e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1962365dd4eaSJoe Perches 196313214adfSAndy Whitcroft our @report = (); 19646c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19656c72ffaaSAndy Whitcroft our $cnt_error = 0; 19666c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19676c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19686c72ffaaSAndy Whitcroft 19690a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19700a920b5bSAndy Whitcroft my $realfile = ''; 19710a920b5bSAndy Whitcroft my $realline = 0; 19720a920b5bSAndy Whitcroft my $realcnt = 0; 19730a920b5bSAndy Whitcroft my $here = ''; 19740a920b5bSAndy Whitcroft my $in_comment = 0; 1975c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19760a920b5bSAndy Whitcroft my $first_line = 0; 19771e855726SWolfram Sang my $p1_prefix = ''; 19780a920b5bSAndy Whitcroft 197913214adfSAndy Whitcroft my $prev_values = 'E'; 198013214adfSAndy Whitcroft 198113214adfSAndy Whitcroft # suppression flags 1982773647a0SAndy Whitcroft my %suppress_ifbraces; 1983170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19842b474a1aSAndy Whitcroft my %suppress_export; 19853e469cdcSAndy Whitcroft my $suppress_statement = 0; 1986653d4876SAndy Whitcroft 19877e51f197SJoe Perches my %signatures = (); 1988323c1260SJoe Perches 1989c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1990de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1991c2fdda0dSAndy Whitcroft # 1992de7d4f0eSAndy Whitcroft my @setup_docs = (); 1993de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1994773647a0SAndy Whitcroft 1995d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1996d8b07710SJoe Perches 1997773647a0SAndy Whitcroft sanitise_line_reset(); 1998c2fdda0dSAndy Whitcroft my $line; 1999c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2000773647a0SAndy Whitcroft $linenr++; 2001773647a0SAndy Whitcroft $line = $rawline; 2002c2fdda0dSAndy Whitcroft 20033705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 20043705ce5bSJoe Perches 2005773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2006de7d4f0eSAndy Whitcroft $setup_docs = 0; 2007de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2008de7d4f0eSAndy Whitcroft $setup_docs = 1; 2009de7d4f0eSAndy Whitcroft } 2010773647a0SAndy Whitcroft #next; 2011de7d4f0eSAndy Whitcroft } 2012773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2013773647a0SAndy Whitcroft $realline=$1-1; 2014773647a0SAndy Whitcroft if (defined $2) { 2015773647a0SAndy Whitcroft $realcnt=$3+1; 2016773647a0SAndy Whitcroft } else { 2017773647a0SAndy Whitcroft $realcnt=1+1; 2018773647a0SAndy Whitcroft } 2019c45dcabdSAndy Whitcroft $in_comment = 0; 2020773647a0SAndy Whitcroft 2021773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2022773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2023773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2024773647a0SAndy Whitcroft # at context start. 2025773647a0SAndy Whitcroft my $edge; 202601fa9147SAndy Whitcroft my $cnt = $realcnt; 202701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 202801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 202901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 203001fa9147SAndy Whitcroft $cnt--; 203101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2032721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2033fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2034fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2035fae17daeSAndy Whitcroft ($edge) = $1; 2036fae17daeSAndy Whitcroft last; 2037fae17daeSAndy Whitcroft } 2038773647a0SAndy Whitcroft } 2039773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2040773647a0SAndy Whitcroft $in_comment = 1; 2041773647a0SAndy Whitcroft } 2042773647a0SAndy Whitcroft 2043773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2044773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2045773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2046773647a0SAndy Whitcroft if (!defined $edge && 204783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2048773647a0SAndy Whitcroft { 2049773647a0SAndy Whitcroft $in_comment = 1; 2050773647a0SAndy Whitcroft } 2051773647a0SAndy Whitcroft 2052773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2053773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2054773647a0SAndy Whitcroft 2055171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2056773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2057171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2058773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2059773647a0SAndy Whitcroft } 2060773647a0SAndy Whitcroft push(@lines, $line); 2061773647a0SAndy Whitcroft 2062773647a0SAndy Whitcroft if ($realcnt > 1) { 2063773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2064773647a0SAndy Whitcroft } else { 2065773647a0SAndy Whitcroft $realcnt = 0; 2066773647a0SAndy Whitcroft } 2067773647a0SAndy Whitcroft 2068773647a0SAndy Whitcroft #print "==>$rawline\n"; 2069773647a0SAndy Whitcroft #print "-->$line\n"; 2070de7d4f0eSAndy Whitcroft 2071de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2072de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2073de7d4f0eSAndy Whitcroft } 2074de7d4f0eSAndy Whitcroft } 2075de7d4f0eSAndy Whitcroft 20766c72ffaaSAndy Whitcroft $prefix = ''; 20776c72ffaaSAndy Whitcroft 2078773647a0SAndy Whitcroft $realcnt = 0; 2079773647a0SAndy Whitcroft $linenr = 0; 2080194f66fcSJoe Perches $fixlinenr = -1; 20810a920b5bSAndy Whitcroft foreach my $line (@lines) { 20820a920b5bSAndy Whitcroft $linenr++; 2083194f66fcSJoe Perches $fixlinenr++; 20841b5539b1SJoe Perches my $sline = $line; #copy of $line 20851b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20860a920b5bSAndy Whitcroft 2087c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20886c72ffaaSAndy Whitcroft 20890a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 20906c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20910a920b5bSAndy Whitcroft $is_patch = 1; 20924a0df2efSAndy Whitcroft $first_line = $linenr + 1; 20930a920b5bSAndy Whitcroft $realline=$1-1; 20940a920b5bSAndy Whitcroft if (defined $2) { 20950a920b5bSAndy Whitcroft $realcnt=$3+1; 20960a920b5bSAndy Whitcroft } else { 20970a920b5bSAndy Whitcroft $realcnt=1+1; 20980a920b5bSAndy Whitcroft } 2099c2fdda0dSAndy Whitcroft annotate_reset(); 210013214adfSAndy Whitcroft $prev_values = 'E'; 210113214adfSAndy Whitcroft 2102773647a0SAndy Whitcroft %suppress_ifbraces = (); 2103170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 21042b474a1aSAndy Whitcroft %suppress_export = (); 21053e469cdcSAndy Whitcroft $suppress_statement = 0; 21060a920b5bSAndy Whitcroft next; 21070a920b5bSAndy Whitcroft 21084a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 21094a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 21104a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2111773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 21120a920b5bSAndy Whitcroft $realline++; 2113d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 21140a920b5bSAndy Whitcroft 21154a0df2efSAndy Whitcroft # Measure the line length and indent. 2116c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 21170a920b5bSAndy Whitcroft 21180a920b5bSAndy Whitcroft # Track the previous line. 21190a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 21200a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2121c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2122c2fdda0dSAndy Whitcroft 2123773647a0SAndy Whitcroft #warn "line<$line>\n"; 21246c72ffaaSAndy Whitcroft 2125d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2126d8aaf121SAndy Whitcroft $realcnt--; 21270a920b5bSAndy Whitcroft } 21280a920b5bSAndy Whitcroft 2129cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2130cc77cdcaSAndy Whitcroft 21316c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 21326c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2133773647a0SAndy Whitcroft 21342ac73b4fSJoe Perches my $found_file = 0; 2135773647a0SAndy Whitcroft # extract the filename as it passes 21363bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 21373bf9a009SRabin Vincent $realfile = $1; 21382b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2139270c49a0SJoe Perches $in_commit_log = 0; 21402ac73b4fSJoe Perches $found_file = 1; 21413bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2142773647a0SAndy Whitcroft $realfile = $1; 21432b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2144270c49a0SJoe Perches $in_commit_log = 0; 21451e855726SWolfram Sang 21461e855726SWolfram Sang $p1_prefix = $1; 2147e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2148e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2149000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2150000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21511e855726SWolfram Sang } 2152773647a0SAndy Whitcroft 2153c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2154000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2155000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2156773647a0SAndy Whitcroft } 21572ac73b4fSJoe Perches $found_file = 1; 21582ac73b4fSJoe Perches } 21592ac73b4fSJoe Perches 216034d8815fSJoe Perches#make up the handle for any error we report on this line 216134d8815fSJoe Perches if ($showfile) { 216234d8815fSJoe Perches $prefix = "$realfile:$realline: " 216334d8815fSJoe Perches } elsif ($emacs) { 216434d8815fSJoe Perches $prefix = "$filename:$linenr: "; 216534d8815fSJoe Perches } 216634d8815fSJoe Perches 21672ac73b4fSJoe Perches if ($found_file) { 21682ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 21692ac73b4fSJoe Perches $check = 1; 21702ac73b4fSJoe Perches } else { 21712ac73b4fSJoe Perches $check = $check_orig; 21722ac73b4fSJoe Perches } 2173773647a0SAndy Whitcroft next; 2174773647a0SAndy Whitcroft } 2175773647a0SAndy Whitcroft 2176389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21770a920b5bSAndy Whitcroft 2178c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2179c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2180c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21810a920b5bSAndy Whitcroft 21826c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21836c72ffaaSAndy Whitcroft 21843bf9a009SRabin Vincent# Check for incorrect file permissions 21853bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 21863bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 218704db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 218804db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2189000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2190000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 21913bf9a009SRabin Vincent } 21923bf9a009SRabin Vincent } 21933bf9a009SRabin Vincent 219420112475SJoe Perches# Check the patch for a signoff: 2195d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 21964a0df2efSAndy Whitcroft $signoff++; 219715662b3eSJoe Perches $in_commit_log = 0; 21980a920b5bSAndy Whitcroft } 219920112475SJoe Perches 2200e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2201e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2202e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2203e0d975b1SJoe Perches $reported_maintainer_file = 1; 2204e0d975b1SJoe Perches } 2205e0d975b1SJoe Perches 220620112475SJoe Perches# Check signature styles 2207270c49a0SJoe Perches if (!$in_header_lines && 2208ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 220920112475SJoe Perches my $space_before = $1; 221020112475SJoe Perches my $sign_off = $2; 221120112475SJoe Perches my $space_after = $3; 221220112475SJoe Perches my $email = $4; 221320112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 221420112475SJoe Perches 2215ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2216ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2217ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2218ce0338dfSJoe Perches } 221920112475SJoe Perches if (defined $space_before && $space_before ne "") { 22203705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22213705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 22223705ce5bSJoe Perches $fix) { 2223194f66fcSJoe Perches $fixed[$fixlinenr] = 22243705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22253705ce5bSJoe Perches } 222620112475SJoe Perches } 222720112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22283705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22293705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22303705ce5bSJoe Perches $fix) { 2231194f66fcSJoe Perches $fixed[$fixlinenr] = 22323705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22333705ce5bSJoe Perches } 22343705ce5bSJoe Perches 223520112475SJoe Perches } 223620112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22373705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22383705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22393705ce5bSJoe Perches $fix) { 2240194f66fcSJoe Perches $fixed[$fixlinenr] = 22413705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22423705ce5bSJoe Perches } 224320112475SJoe Perches } 224420112475SJoe Perches 224520112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 224620112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 224720112475SJoe Perches if ($suggested_email eq "") { 2248000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2249000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 225020112475SJoe Perches } else { 225120112475SJoe Perches my $dequoted = $suggested_email; 225220112475SJoe Perches $dequoted =~ s/^"//; 225320112475SJoe Perches $dequoted =~ s/" </ </; 225420112475SJoe Perches # Don't force email to have quotes 225520112475SJoe Perches # Allow just an angle bracketed address 225620112475SJoe Perches if ("$dequoted$comment" ne $email && 225720112475SJoe Perches "<$email_address>$comment" ne $email && 225820112475SJoe Perches "$suggested_email$comment" ne $email) { 2259000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2260000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 226120112475SJoe Perches } 22620a920b5bSAndy Whitcroft } 22637e51f197SJoe Perches 22647e51f197SJoe Perches# Check for duplicate signatures 22657e51f197SJoe Perches my $sig_nospace = $line; 22667e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22677e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22687e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22697e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22707e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22717e51f197SJoe Perches } else { 22727e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22737e51f197SJoe Perches } 22740a920b5bSAndy Whitcroft } 22750a920b5bSAndy Whitcroft 2276a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2277a2fe16b9SJoe Perches if ($in_header_lines && 2278a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2279a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2280a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2281a2fe16b9SJoe Perches } 2282a2fe16b9SJoe Perches 22839b3189ebSJoe Perches# Check for old stable address 22849b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 22859b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 22869b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 22879b3189ebSJoe Perches } 22889b3189ebSJoe Perches 22897ebd05efSChristopher Covington# Check for unwanted Gerrit info 22907ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 22917ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 22927ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 22937ebd05efSChristopher Covington } 22947ebd05efSChristopher Covington 22952a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 22962a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 22972a076f40SJoe Perches length($line) > 75) { 22982a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 22992a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 23002a076f40SJoe Perches $commit_log_long_line = 1; 23012a076f40SJoe Perches } 23022a076f40SJoe Perches 23030d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 23040d7835fcSJoe Perches if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) { 2305d311cd44SJoe Perches my $init_char = $1; 2306d311cd44SJoe Perches my $orig_commit = lc($2); 23070d7835fcSJoe Perches my $short = 1; 23080d7835fcSJoe Perches my $long = 0; 23090d7835fcSJoe Perches my $case = 1; 23100d7835fcSJoe Perches my $space = 1; 23110d7835fcSJoe Perches my $hasdesc = 0; 231219c146a6SJoe Perches my $hasparens = 0; 23130d7835fcSJoe Perches my $id = '0123456789ab'; 23140d7835fcSJoe Perches my $orig_desc = "commit description"; 23150d7835fcSJoe Perches my $description = ""; 23160d7835fcSJoe Perches 23170d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23180d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23190d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 23200d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 23210d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 23220d7835fcSJoe Perches $orig_desc = $1; 232319c146a6SJoe Perches $hasparens = 1; 23240d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 23250d7835fcSJoe Perches defined $rawlines[$linenr] && 23260d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 23270d7835fcSJoe Perches $orig_desc = $1; 232819c146a6SJoe Perches $hasparens = 1; 2329b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2330b671fde0SJoe Perches defined $rawlines[$linenr] && 2331b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2332b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2333b671fde0SJoe Perches $orig_desc = $1; 2334b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2335b671fde0SJoe Perches $orig_desc .= " " . $1; 233619c146a6SJoe Perches $hasparens = 1; 23370d7835fcSJoe Perches } 23380d7835fcSJoe Perches 23390d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 23400d7835fcSJoe Perches $id, $orig_desc); 23410d7835fcSJoe Perches 234219c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2343d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 23440d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 23450d7835fcSJoe Perches } 2346d311cd44SJoe Perches } 2347d311cd44SJoe Perches 234813f1937eSJoe Perches# Check for added, moved or deleted files 234913f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 235013f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 235113f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 235213f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 235313f1937eSJoe Perches (defined($1) || defined($2))))) { 235413f1937eSJoe Perches $reported_maintainer_file = 1; 235513f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 235613f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 235713f1937eSJoe Perches } 235813f1937eSJoe Perches 235900df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 23608905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2361000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2362000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 23636c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2364de7d4f0eSAndy Whitcroft } 2365de7d4f0eSAndy Whitcroft 23666ecd9674SAndy Whitcroft# Check for absolute kernel paths. 23676ecd9674SAndy Whitcroft if ($tree) { 23686ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 23696ecd9674SAndy Whitcroft my $file = $1; 23706ecd9674SAndy Whitcroft 23716ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 23726ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 23736ecd9674SAndy Whitcroft # 23746ecd9674SAndy Whitcroft } else { 23756ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 23766ecd9674SAndy Whitcroft } 23776ecd9674SAndy Whitcroft } 23786ecd9674SAndy Whitcroft } 23796ecd9674SAndy Whitcroft 2380de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2381de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2382171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2383171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2384171ae1a4SAndy Whitcroft 2385171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2386171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2387171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2388171ae1a4SAndy Whitcroft 238934d99219SJoe Perches CHK("INVALID_UTF8", 2390000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 239100df344fSAndy Whitcroft } 23920a920b5bSAndy Whitcroft 239315662b3eSJoe Perches# Check if it's the start of a commit log 239415662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 239515662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 239629ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 239729ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 239815662b3eSJoe Perches $in_header_lines = 0; 239915662b3eSJoe Perches $in_commit_log = 1; 240015662b3eSJoe Perches } 240115662b3eSJoe Perches 2402fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2403fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2404fa64205dSPasi Savanainen if ($in_header_lines && 2405fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2406fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2407fa64205dSPasi Savanainen $non_utf8_charset = 1; 2408fa64205dSPasi Savanainen } 2409fa64205dSPasi Savanainen 2410fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 241115662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2412fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 241315662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 241415662b3eSJoe Perches } 241515662b3eSJoe Perches 241666b47b4aSKees Cook# Check for various typo / spelling mistakes 241766d7a382SJoe Perches if (defined($misspellings) && 241866d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2419ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 242066b47b4aSKees Cook my $typo = $1; 242166b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 242266b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 242366b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 242466b47b4aSKees Cook my $msg_type = \&WARN; 242566b47b4aSKees Cook $msg_type = \&CHK if ($file); 242666b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 242766b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 242866b47b4aSKees Cook $fix) { 242966b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 243066b47b4aSKees Cook } 243166b47b4aSKees Cook } 243266b47b4aSKees Cook } 243366b47b4aSKees Cook 243430670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 243530670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 243600df344fSAndy Whitcroft 24370a920b5bSAndy Whitcroft#trailing whitespace 24389c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2439c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2440d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2441d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2442d5e616fcSJoe Perches $fix) { 2443194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2444d5e616fcSJoe Perches } 2445c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2446c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24473705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 24483705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 24493705ce5bSJoe Perches $fix) { 2450194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 24513705ce5bSJoe Perches } 24523705ce5bSJoe Perches 2453d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 24540a920b5bSAndy Whitcroft } 24555368df20SAndy Whitcroft 24564783f894SJosh Triplett# Check for FSF mailing addresses. 2457109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 24583e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 24593e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 24604783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24614783f894SJosh Triplett my $msg_type = \&ERROR; 24624783f894SJosh Triplett $msg_type = \&CHK if ($file); 24634783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 24644783f894SJosh 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) 24654783f894SJosh Triplett } 24664783f894SJosh Triplett 24673354957aSAndi Kleen# check for Kconfig help text having a real description 24689fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 24699fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 24703354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 24718d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 24723354957aSAndi Kleen my $length = 0; 24739fe287d7SAndy Whitcroft my $cnt = $realcnt; 24749fe287d7SAndy Whitcroft my $ln = $linenr + 1; 24759fe287d7SAndy Whitcroft my $f; 2476a1385803SAndy Whitcroft my $is_start = 0; 24779fe287d7SAndy Whitcroft my $is_end = 0; 2478a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 24799fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 24809fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 24819fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 24829fe287d7SAndy Whitcroft 24839fe287d7SAndy Whitcroft next if ($f =~ /^-/); 24848d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2485a1385803SAndy Whitcroft 24868d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2487a1385803SAndy Whitcroft $is_start = 1; 24888d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2489a1385803SAndy Whitcroft $length = -1; 2490a1385803SAndy Whitcroft } 2491a1385803SAndy Whitcroft 24929fe287d7SAndy Whitcroft $f =~ s/^.//; 24933354957aSAndi Kleen $f =~ s/#.*//; 24943354957aSAndi Kleen $f =~ s/^\s+//; 24953354957aSAndi Kleen next if ($f =~ /^$/); 24969fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 24979fe287d7SAndy Whitcroft $is_end = 1; 24989fe287d7SAndy Whitcroft last; 24999fe287d7SAndy Whitcroft } 25003354957aSAndi Kleen $length++; 25013354957aSAndi Kleen } 250256193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2503000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 250456193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 250556193274SVadim Bendebury } 2506a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25073354957aSAndi Kleen } 25083354957aSAndi Kleen 25091ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25101ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25111ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25121ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25131ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25141ba8dfd1SKees Cook } 25151ba8dfd1SKees Cook 2516327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2517327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2518327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2519327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2520327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2521327953e9SChristoph Jaeger } 2522327953e9SChristoph Jaeger 2523c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2524c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2525c68e5878SArnaud Lacombe my $flag = $1; 2526c68e5878SArnaud Lacombe my $replacement = { 2527c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2528c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2529c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2530c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2531c68e5878SArnaud Lacombe }; 2532c68e5878SArnaud Lacombe 2533c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2534c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2535c68e5878SArnaud Lacombe } 2536c68e5878SArnaud Lacombe 2537bff5da43SRob Herring# check for DT compatible documentation 25387dd05b38SFlorian Vaussard if (defined $root && 25397dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 25407dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 25417dd05b38SFlorian Vaussard 2542bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2543bff5da43SRob Herring 2544cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2545cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2546cc93319bSFlorian Vaussard 2547bff5da43SRob Herring foreach my $compat (@compats) { 2548bff5da43SRob Herring my $compat2 = $compat; 2549185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2550185d566bSRob Herring my $compat3 = $compat; 2551185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2552185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2553bff5da43SRob Herring if ( $? >> 8 ) { 2554bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2555bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2556bff5da43SRob Herring } 2557bff5da43SRob Herring 25584fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 25594fbf32a6SFlorian Vaussard my $vendor = $1; 2560cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2561bff5da43SRob Herring if ( $? >> 8 ) { 2562bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2563cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2564bff5da43SRob Herring } 2565bff5da43SRob Herring } 2566bff5da43SRob Herring } 2567bff5da43SRob Herring 25685368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2569de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 25705368df20SAndy Whitcroft 257147e0c88bSJoe Perches# line length limit (with some exclusions) 257247e0c88bSJoe Perches# 257347e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 257447e0c88bSJoe Perches# logging functions like pr_info that end in a string 257547e0c88bSJoe Perches# lines with a single string 257647e0c88bSJoe Perches# #defines that are a single string 257747e0c88bSJoe Perches# 257847e0c88bSJoe Perches# There are 3 different line length message types: 257947e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 258047e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 258147e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 258247e0c88bSJoe Perches# 258347e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 258447e0c88bSJoe Perches# 258547e0c88bSJoe Perches 258647e0c88bSJoe Perches if ($length > $max_line_length) { 258747e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 258847e0c88bSJoe Perches 258947e0c88bSJoe Perches # Check the allowed long line types first 259047e0c88bSJoe Perches 259147e0c88bSJoe Perches # logging functions that end in a string that starts 259247e0c88bSJoe Perches # before $max_line_length 259347e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 259447e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 259547e0c88bSJoe Perches $msg_type = ""; 259647e0c88bSJoe Perches 259747e0c88bSJoe Perches # lines with only strings (w/ possible termination) 259847e0c88bSJoe Perches # #defines with only strings 259947e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 260047e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 260147e0c88bSJoe Perches $msg_type = ""; 260247e0c88bSJoe Perches 260347e0c88bSJoe Perches # Otherwise set the alternate message types 260447e0c88bSJoe Perches 260547e0c88bSJoe Perches # a comment starts before $max_line_length 260647e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 260747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 260847e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 260947e0c88bSJoe Perches 261047e0c88bSJoe Perches # a quoted string starts before $max_line_length 261147e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 261247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 261347e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 261447e0c88bSJoe Perches } 261547e0c88bSJoe Perches 261647e0c88bSJoe Perches if ($msg_type ne "" && 261747e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 261847e0c88bSJoe Perches WARN($msg_type, 26196cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 26200a920b5bSAndy Whitcroft } 262147e0c88bSJoe Perches } 26220a920b5bSAndy Whitcroft 26238905a67cSAndy Whitcroft# check for adding lines without a newline. 26248905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2625000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2626000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 26278905a67cSAndy Whitcroft } 26288905a67cSAndy Whitcroft 262942e41c54SMike Frysinger# Blackfin: use hi/lo macros 263042e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 263142e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 263242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2633000d1cc1SJoe Perches ERROR("LO_MACRO", 2634000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 263542e41c54SMike Frysinger } 263642e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 263742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2638000d1cc1SJoe Perches ERROR("HI_MACRO", 2639000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 264042e41c54SMike Frysinger } 264142e41c54SMike Frysinger } 264242e41c54SMike Frysinger 2643b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2644de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 26450a920b5bSAndy Whitcroft 26460a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 26470a920b5bSAndy Whitcroft# more than 8 must use tabs. 2648c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2649c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2650c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2651d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26523705ce5bSJoe Perches if (ERROR("CODE_INDENT", 26533705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 26543705ce5bSJoe Perches $fix) { 2655194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 26563705ce5bSJoe Perches } 26570a920b5bSAndy Whitcroft } 26580a920b5bSAndy Whitcroft 265908e44365SAlberto Panizzo# check for space before tabs. 266008e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 266108e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26623705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 26633705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 26643705ce5bSJoe Perches $fix) { 2665194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2666d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2667194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2668c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 26693705ce5bSJoe Perches } 267008e44365SAlberto Panizzo } 267108e44365SAlberto Panizzo 2672d1fe9c09SJoe Perches# check for && or || at the start of a line 2673d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2674d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2675d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2676d1fe9c09SJoe Perches } 2677d1fe9c09SJoe Perches 2678d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2679d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 268091cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2681d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2682d1fe9c09SJoe Perches my $oldindent = $1; 2683d1fe9c09SJoe Perches my $rest = $2; 2684d1fe9c09SJoe Perches 2685d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2686d1fe9c09SJoe Perches if ($pos >= 0) { 2687b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2688b34a26f3SJoe Perches my $newindent = $2; 2689d1fe9c09SJoe Perches 2690d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2691d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2692d1fe9c09SJoe Perches " " x ($pos % 8); 2693d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2694d1fe9c09SJoe Perches 2695d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2696d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 26973705ce5bSJoe Perches 26983705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 26993705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27003705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2701194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27023705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27033705ce5bSJoe Perches } 2704d1fe9c09SJoe Perches } 2705d1fe9c09SJoe Perches } 2706d1fe9c09SJoe Perches } 2707d1fe9c09SJoe Perches 27086ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27096ab3a970SJoe Perches# avoid checking a few false positives: 27106ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27116ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27126ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27136ab3a970SJoe Perches# multiline macros that define functions 27146ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27156ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27166ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27173705ce5bSJoe Perches if (CHK("SPACING", 2718f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27193705ce5bSJoe Perches $fix) { 2720194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2721f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 27223705ce5bSJoe Perches } 2723aad4f614SJoe Perches } 2724aad4f614SJoe Perches 272505880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2726fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 272785ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 272885ad978cSJoe Perches $realline > 2) { 272905880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 273005880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 273105880600SJoe Perches } 273205880600SJoe Perches 273305880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2734a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2735a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 273661135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2737a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2738a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2739a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2740a605e32eSJoe Perches } 2741a605e32eSJoe Perches 2742a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2743c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2744c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2745c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2746c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 274705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 274805880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 274905880600SJoe Perches } 275005880600SJoe Perches 27517f619191SJoe Perches# check for missing blank lines after struct/union declarations 27527f619191SJoe Perches# with exceptions for various attributes and macros 27537f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 27547f619191SJoe Perches $line =~ /^\+/ && 27557f619191SJoe Perches !($line =~ /^\+\s*$/ || 27567f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 27577f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 27587f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 27597f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 27607f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 27617f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 27627f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2763d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2764d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2765d752fcc8SJoe Perches $fix) { 2766f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2767d752fcc8SJoe Perches } 27687f619191SJoe Perches } 27697f619191SJoe Perches 2770365dd4eaSJoe Perches# check for multiple consecutive blank lines 2771365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2772365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2773365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2774d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2775d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2776d752fcc8SJoe Perches $fix) { 2777f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2778d752fcc8SJoe Perches } 2779d752fcc8SJoe Perches 2780365dd4eaSJoe Perches $last_blank_line = $linenr; 2781365dd4eaSJoe Perches } 2782365dd4eaSJoe Perches 27833b617e3bSJoe Perches# check for missing blank lines after declarations 27843f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 27853f7bac03SJoe Perches # actual declarations 27863f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 27875a4e1fd3SJoe Perches # function pointer declarations 27885a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 27893f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 27903f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 27913f7bac03SJoe Perches # known declaration macros 27923f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 27933f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 27943f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 27953f7bac03SJoe Perches # other possible extensions of declaration lines 27963f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 27973f7bac03SJoe Perches # not starting a section or a macro "\" extended line 27983f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 27993f7bac03SJoe Perches # looks like a declaration 28003f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28015a4e1fd3SJoe Perches # function pointer declarations 28025a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28033f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28043f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28053f7bac03SJoe Perches # known declaration macros 28063f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28073f7bac03SJoe Perches # start of struct or union or enum 28083b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28093f7bac03SJoe Perches # start or end of block or continuation of declaration 28103f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28113f7bac03SJoe Perches # bitfield continuation 28123f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28133f7bac03SJoe Perches # other possible extensions of declaration lines 28143f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28153f7bac03SJoe Perches # indentation of previous and current line are the same 28163f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2817d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2818d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2819d752fcc8SJoe Perches $fix) { 2820f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2821d752fcc8SJoe Perches } 28223b617e3bSJoe Perches } 28233b617e3bSJoe Perches 28245f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 28256b4c5bebSAndy Whitcroft# Exceptions: 28266b4c5bebSAndy Whitcroft# 1) within comments 28276b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 28286b4c5bebSAndy Whitcroft# 3) hanging labels 28293705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 28305f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28313705ce5bSJoe Perches if (WARN("LEADING_SPACE", 28323705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 28333705ce5bSJoe Perches $fix) { 2834194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28353705ce5bSJoe Perches } 28365f7ddae6SRaffaele Recalcati } 28375f7ddae6SRaffaele Recalcati 2838b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2839b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2840b9ea10d6SAndy Whitcroft 2841032a4c0fSJoe Perches# check indentation of any line with a bare else 2842840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2843032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2844032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2845032a4c0fSJoe Perches my $tabs = length($1) + 1; 2846840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2847840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2848840080a0SJoe Perches defined $lines[$linenr] && 2849840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2850032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2851032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2852032a4c0fSJoe Perches } 2853032a4c0fSJoe Perches } 2854032a4c0fSJoe Perches 2855c00df19aSJoe Perches# check indentation of a line with a break; 2856c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2857c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2858c00df19aSJoe Perches my $tabs = $1; 2859c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2860c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2861c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2862c00df19aSJoe Perches } 2863c00df19aSJoe Perches } 2864c00df19aSJoe Perches 28651ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 28661ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 28671ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 28681ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 28691ba8dfd1SKees Cook } 28701ba8dfd1SKees Cook 2871c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2872cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2873000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2874000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2875c2fdda0dSAndy Whitcroft } 287622f2a2efSAndy Whitcroft 287742e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 287842e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 287942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2880000d1cc1SJoe Perches ERROR("CSYNC", 2881000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 288242e41c54SMike Frysinger } 288342e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 288442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2885000d1cc1SJoe Perches ERROR("SSYNC", 2886000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 288742e41c54SMike Frysinger } 288842e41c54SMike Frysinger 288956e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 289056e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 289156e77d70SJoe Perches WARN("HOTPLUG_SECTION", 289256e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 289356e77d70SJoe Perches } 289456e77d70SJoe Perches 28959c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 28962b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 28972b474a1aSAndy Whitcroft $realline_next); 28983e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 28993e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29001b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2901170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2902f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2903171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2904171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2905171ae1a4SAndy Whitcroft 29063e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29073e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29083e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29093e469cdcSAndy Whitcroft # until we hit end of it. 29103e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29113e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29123e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29133e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29143e469cdcSAndy Whitcroft } 2915f74bd194SAndy Whitcroft 29162b474a1aSAndy Whitcroft # Find the real next line. 29172b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 29182b474a1aSAndy Whitcroft if (defined $realline_next && 29192b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 29202b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 29212b474a1aSAndy Whitcroft $realline_next++; 29222b474a1aSAndy Whitcroft } 29232b474a1aSAndy Whitcroft 2924171ae1a4SAndy Whitcroft my $s = $stat; 2925171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2926cf655043SAndy Whitcroft 2927c2fdda0dSAndy Whitcroft # Ignore goto labels. 2928171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2929c2fdda0dSAndy Whitcroft 2930c2fdda0dSAndy Whitcroft # Ignore functions being called 2931171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2932c2fdda0dSAndy Whitcroft 2933463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2934463f2864SAndy Whitcroft 2935c45dcabdSAndy Whitcroft # declarations always start with types 2936d2506586SAndy 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) { 2937c45dcabdSAndy Whitcroft my $type = $1; 2938c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2939c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2940c45dcabdSAndy Whitcroft 29416c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2942a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2943c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2944c2fdda0dSAndy Whitcroft } 29458905a67cSAndy Whitcroft 29466c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 294765863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2948c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 29499c0ca6f9SAndy Whitcroft } 29508905a67cSAndy Whitcroft 29518905a67cSAndy Whitcroft # Check for any sort of function declaration. 29528905a67cSAndy Whitcroft # int foo(something bar, other baz); 29538905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2954171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 29558905a67cSAndy Whitcroft my ($name_len) = length($1); 29568905a67cSAndy Whitcroft 2957cf655043SAndy Whitcroft my $ctx = $s; 2958773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 29598905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2960cf655043SAndy Whitcroft 29618905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2962c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 29638905a67cSAndy Whitcroft 2964c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 29658905a67cSAndy Whitcroft } 29668905a67cSAndy Whitcroft } 29678905a67cSAndy Whitcroft } 29688905a67cSAndy Whitcroft 29699c0ca6f9SAndy Whitcroft } 29709c0ca6f9SAndy Whitcroft 297100df344fSAndy Whitcroft# 297200df344fSAndy Whitcroft# Checks which may be anchored in the context. 297300df344fSAndy Whitcroft# 297400df344fSAndy Whitcroft 297500df344fSAndy Whitcroft# Check for switch () and associated case and default 297600df344fSAndy Whitcroft# statements should be at the same indent. 297700df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 297800df344fSAndy Whitcroft my $err = ''; 297900df344fSAndy Whitcroft my $sep = ''; 298000df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 298100df344fSAndy Whitcroft shift(@ctx); 298200df344fSAndy Whitcroft for my $ctx (@ctx) { 298300df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 298400df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 298500df344fSAndy Whitcroft $indent != $cindent) { 298600df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 298700df344fSAndy Whitcroft $sep = ''; 298800df344fSAndy Whitcroft } else { 298900df344fSAndy Whitcroft $sep = "[...]\n"; 299000df344fSAndy Whitcroft } 299100df344fSAndy Whitcroft } 299200df344fSAndy Whitcroft if ($err ne '') { 2993000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2994000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2995de7d4f0eSAndy Whitcroft } 2996de7d4f0eSAndy Whitcroft } 2997de7d4f0eSAndy Whitcroft 2998de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2999de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30000fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3001773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3002773647a0SAndy Whitcroft 30039c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30048eef05ddSJoe Perches 30058eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30068eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30078eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30088eef05ddSJoe Perches } 30098eef05ddSJoe Perches 3010de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3011de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3012de7d4f0eSAndy Whitcroft 3013548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3014548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3015de7d4f0eSAndy Whitcroft 3016548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3017548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3018548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3019548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3020548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3021773647a0SAndy Whitcroft $ctx_ln++; 3022773647a0SAndy Whitcroft } 3023548596d5SAndy Whitcroft 302453210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 302553210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3026773647a0SAndy Whitcroft 3027773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3028000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3029000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 303001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 303100df344fSAndy Whitcroft } 3032773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3033773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3034773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3035773647a0SAndy Whitcroft { 30369c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 30379c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3038000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3039000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 304001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 30419c0ca6f9SAndy Whitcroft } 30429c0ca6f9SAndy Whitcroft } 304300df344fSAndy Whitcroft } 304400df344fSAndy Whitcroft 30454d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 30460fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 30473e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 30483e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 30493e469cdcSAndy Whitcroft if (!defined $stat); 30504d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 30514d001e4dSAndy Whitcroft 30524d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 30534d001e4dSAndy Whitcroft 30544d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 30554d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 30564d001e4dSAndy Whitcroft # where necessary. 30574d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 30584d001e4dSAndy Whitcroft 30594d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 30606f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 30616f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 30624d001e4dSAndy Whitcroft 30634d001e4dSAndy Whitcroft # We want to check the first line inside the block 30644d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 30654d001e4dSAndy Whitcroft # 1) any blank line termination 30664d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 30674d001e4dSAndy Whitcroft # 3) any do (...) { 30684d001e4dSAndy Whitcroft my $continuation = 0; 30694d001e4dSAndy Whitcroft my $check = 0; 30704d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 30714d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 30724d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 30734d001e4dSAndy Whitcroft $continuation = 1; 30744d001e4dSAndy Whitcroft } 30759bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 30764d001e4dSAndy Whitcroft $check = 1; 30774d001e4dSAndy Whitcroft $cond_lines++; 30784d001e4dSAndy Whitcroft } 30794d001e4dSAndy Whitcroft 30804d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 30814d001e4dSAndy Whitcroft # preprocessor statement. 30824d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 30834d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 30844d001e4dSAndy Whitcroft $check = 0; 30854d001e4dSAndy Whitcroft } 30864d001e4dSAndy Whitcroft 30879bd49efeSAndy Whitcroft my $cond_ptr = -1; 3088740504c6SAndy Whitcroft $continuation = 0; 30899bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 30909bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 30914d001e4dSAndy Whitcroft 3092f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3093f16fa28fSAndy Whitcroft # is not linear. 3094f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3095f16fa28fSAndy Whitcroft $check = 0; 3096f16fa28fSAndy Whitcroft } 3097f16fa28fSAndy Whitcroft 30989bd49efeSAndy Whitcroft # Ignore: 30999bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31009bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31019bd49efeSAndy Whitcroft # 3) labels. 3102740504c6SAndy Whitcroft if ($continuation || 3103740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31049bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31059bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3106740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 310730dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31089bd49efeSAndy Whitcroft $cond_lines++; 31099bd49efeSAndy Whitcroft } 31104d001e4dSAndy Whitcroft } 311130dad6ebSAndy Whitcroft } 31124d001e4dSAndy Whitcroft 31134d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 31144d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 31154d001e4dSAndy Whitcroft 31164d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 31174d001e4dSAndy Whitcroft # this is not this patch's fault. 31184d001e4dSAndy Whitcroft if (!defined($stat_real) || 31194d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 31204d001e4dSAndy Whitcroft $check = 0; 31214d001e4dSAndy Whitcroft } 31224d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 31234d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 31244d001e4dSAndy Whitcroft } 31254d001e4dSAndy Whitcroft 31269bd49efeSAndy 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"; 31274d001e4dSAndy Whitcroft 31284d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 31294d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 3130000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3131000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 31324d001e4dSAndy Whitcroft } 31334d001e4dSAndy Whitcroft } 31344d001e4dSAndy Whitcroft 31356c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 31366c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 31371f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 31381f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 31396c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3140c2fdda0dSAndy Whitcroft if ($dbg_values) { 3141c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3142cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3143cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 31441f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3145c2fdda0dSAndy Whitcroft } 31466c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 31476c72ffaaSAndy Whitcroft 314800df344fSAndy Whitcroft#ignore lines not being added 31493705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 315000df344fSAndy Whitcroft 3151653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 31527429c690SAndy Whitcroft if ($dbg_type) { 31537429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3154000d1cc1SJoe Perches ERROR("TEST_TYPE", 3155000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 31567429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3157000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3158000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 31597429c690SAndy Whitcroft } 3160653d4876SAndy Whitcroft next; 3161653d4876SAndy Whitcroft } 3162a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3163a1ef277eSAndy Whitcroft if ($dbg_attr) { 31649360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3165000d1cc1SJoe Perches ERROR("TEST_ATTR", 3166000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 31679360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3168000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3169000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3170a1ef277eSAndy Whitcroft } 3171a1ef277eSAndy Whitcroft next; 3172a1ef277eSAndy Whitcroft } 3173653d4876SAndy Whitcroft 3174f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 317599423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 317699423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3177d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3178d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3179f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3180f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3181f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3182d752fcc8SJoe Perches my $fixedline = $prevrawline; 3183d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3184f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3185d752fcc8SJoe Perches $fixedline = $line; 3186d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3187f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3188d752fcc8SJoe Perches } 3189f0a594c1SAndy Whitcroft } 3190f0a594c1SAndy Whitcroft 319100df344fSAndy Whitcroft# 319200df344fSAndy Whitcroft# Checks which are anchored on the added line. 319300df344fSAndy Whitcroft# 319400df344fSAndy Whitcroft 3195653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3196c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3197653d4876SAndy Whitcroft my $path = $1; 3198653d4876SAndy Whitcroft if ($path =~ m{//}) { 3199000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3200495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3201495e9d84SJoe Perches } 3202495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3203495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3204495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3205653d4876SAndy Whitcroft } 3206653d4876SAndy Whitcroft } 3207653d4876SAndy Whitcroft 320800df344fSAndy Whitcroft# no C99 // comments 320900df344fSAndy Whitcroft if ($line =~ m{//}) { 32103705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 32113705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 32123705ce5bSJoe Perches $fix) { 3213194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 32143705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 32153705ce5bSJoe Perches my $comment = trim($1); 3216194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 32173705ce5bSJoe Perches } 32183705ce5bSJoe Perches } 321900df344fSAndy Whitcroft } 322000df344fSAndy Whitcroft # Remove C99 comments. 32210a920b5bSAndy Whitcroft $line =~ s@//.*@@; 32226c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 32230a920b5bSAndy Whitcroft 32242b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 32252b474a1aSAndy Whitcroft# the whole statement. 32262b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 32272b474a1aSAndy Whitcroft if (defined $realline_next && 32282b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 32292b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 32302b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32312b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32323cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 32333cbf62dfSAndy Whitcroft # a prefix: 32343cbf62dfSAndy Whitcroft # XXX(foo); 32353cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3236653d4876SAndy Whitcroft my $name = $1; 323787a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 32383cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 32393cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 32403cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 32413cbf62dfSAndy Whitcroft 32423cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 32432b474a1aSAndy Whitcroft \n.}\s*$| 324448012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 324548012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 324648012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 32472b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 32482b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 324948012058SAndy Whitcroft )/x) { 32502b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 32512b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 32522b474a1aSAndy Whitcroft } else { 32532b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 32540a920b5bSAndy Whitcroft } 32550a920b5bSAndy Whitcroft } 32562b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 32572b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 32582b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32592b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32602b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 32612b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 32622b474a1aSAndy Whitcroft } 32632b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 32642b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3265000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3266000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 32672b474a1aSAndy Whitcroft } 32680a920b5bSAndy Whitcroft 32695150bda4SJoe Eloff# check for global initialisers. 32705129e87cSJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) { 3271d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3272000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3273d5e616fcSJoe Perches $herecurr) && 3274d5e616fcSJoe Perches $fix) { 32755129e87cSJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/; 3276d5e616fcSJoe Perches } 3277f0a594c1SAndy Whitcroft } 32780a920b5bSAndy Whitcroft# check for static initialisers. 3279d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3280d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3281000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3282d5e616fcSJoe Perches $herecurr) && 3283d5e616fcSJoe Perches $fix) { 3284194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3285d5e616fcSJoe Perches } 32860a920b5bSAndy Whitcroft } 32870a920b5bSAndy Whitcroft 32881813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 32891813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 32901813087dSJoe Perches my $tmp = trim($1); 32911813087dSJoe Perches WARN("MISORDERED_TYPE", 32921813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 32931813087dSJoe Perches } 32941813087dSJoe Perches 3295cb710ecaSJoe Perches# check for static const char * arrays. 3296cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3297000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3298000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3299cb710ecaSJoe Perches $herecurr); 3300cb710ecaSJoe Perches } 3301cb710ecaSJoe Perches 3302cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3303cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3304000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3305000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3306cb710ecaSJoe Perches $herecurr); 3307cb710ecaSJoe Perches } 3308cb710ecaSJoe Perches 3309ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3310ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3311ab7e23f3SJoe Perches my $found = $1; 3312ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3313ab7e23f3SJoe Perches WARN("CONST_CONST", 3314ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3315ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3316ab7e23f3SJoe Perches WARN("CONST_CONST", 3317ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3318ab7e23f3SJoe Perches } 3319ab7e23f3SJoe Perches } 3320ab7e23f3SJoe Perches 33219b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 33229b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 33239b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 33249b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 33259b0fa60dSJoe Perches $herecurr); 33269b0fa60dSJoe Perches } 33279b0fa60dSJoe Perches 3328b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3329b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3330b598b670SJoe Perches my $array = $1; 3331b598b670SJoe 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*\))@) { 3332b598b670SJoe Perches my $array_div = $1; 3333b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3334b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3335b598b670SJoe Perches $fix) { 3336b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3337b598b670SJoe Perches } 3338b598b670SJoe Perches } 3339b598b670SJoe Perches } 3340b598b670SJoe Perches 3341b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3342b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3343b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3344b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3345b36190c5SJoe Perches $fix) { 3346194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3347b36190c5SJoe Perches } 3348b36190c5SJoe Perches } 3349b36190c5SJoe Perches 335092e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 335192e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 335292e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 335392e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 335492e112fdSJoe Perches $fix) { 3355194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 335692e112fdSJoe Perches } 335793ed0e2dSJoe Perches } 335893ed0e2dSJoe Perches 3359653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3360653d4876SAndy Whitcroft# make sense. 3361653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 33628054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3363c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 33648ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3365653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3366000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3367000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 33680a920b5bSAndy Whitcroft } 33690a920b5bSAndy Whitcroft 33700a920b5bSAndy Whitcroft# * goes on variable not on type 337165863862SAndy Whitcroft # (char*[ const]) 3372bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3373bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 33743705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3375d8aaf121SAndy Whitcroft 337665863862SAndy Whitcroft # Should start with a space. 337765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 337865863862SAndy Whitcroft # Should not end with a space. 337965863862SAndy Whitcroft $to =~ s/\s+$//; 338065863862SAndy Whitcroft # '*'s should not have spaces between. 3381f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 338265863862SAndy Whitcroft } 3383d8aaf121SAndy Whitcroft 33843705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 338565863862SAndy Whitcroft if ($from ne $to) { 33863705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 33873705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 33883705ce5bSJoe Perches $fix) { 33893705ce5bSJoe Perches my $sub_from = $ident; 33903705ce5bSJoe Perches my $sub_to = $ident; 33913705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3392194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33933705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 33943705ce5bSJoe Perches } 339565863862SAndy Whitcroft } 3396bfcb2cc7SAndy Whitcroft } 3397bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3398bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 33993705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3400d8aaf121SAndy Whitcroft 340165863862SAndy Whitcroft # Should start with a space. 340265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 340365863862SAndy Whitcroft # Should not end with a space. 340465863862SAndy Whitcroft $to =~ s/\s+$//; 340565863862SAndy Whitcroft # '*'s should not have spaces between. 3406f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 340765863862SAndy Whitcroft } 340865863862SAndy Whitcroft # Modifiers should have spaces. 340965863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 341065863862SAndy Whitcroft 34113705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3412667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 34133705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34143705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 34153705ce5bSJoe Perches $fix) { 34163705ce5bSJoe Perches 34173705ce5bSJoe Perches my $sub_from = $match; 34183705ce5bSJoe Perches my $sub_to = $match; 34193705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3420194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34213705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34223705ce5bSJoe Perches } 342365863862SAndy Whitcroft } 34240a920b5bSAndy Whitcroft } 34250a920b5bSAndy Whitcroft 34260a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 34270a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 34280a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 34290a920b5bSAndy Whitcroft# print "$herecurr"; 34300a920b5bSAndy Whitcroft# $clean = 0; 34310a920b5bSAndy Whitcroft# } 34320a920b5bSAndy Whitcroft 34338905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3434000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3435000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 34368905a67cSAndy Whitcroft } 34378905a67cSAndy Whitcroft 343817441227SJoe Perches# check for uses of printk_ratelimit 343917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3440000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3441000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 344217441227SJoe Perches } 344317441227SJoe Perches 344400df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 344500df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 344600df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 344725985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 344800df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3449f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 345000df344fSAndy Whitcroft my $ok = 0; 345100df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 345200df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 345325985edcSLucas De Marchi # we have a preceding printk if it ends 345400df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 345500df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 345600df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 345700df344fSAndy Whitcroft $ok = 1; 345800df344fSAndy Whitcroft } 345900df344fSAndy Whitcroft last; 346000df344fSAndy Whitcroft } 346100df344fSAndy Whitcroft } 346200df344fSAndy Whitcroft if ($ok == 0) { 3463000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3464000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 34650a920b5bSAndy Whitcroft } 346600df344fSAndy Whitcroft } 34670a920b5bSAndy Whitcroft 3468243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3469243f3803SJoe Perches my $orig = $1; 3470243f3803SJoe Perches my $level = lc($orig); 3471243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 34728f26b837SJoe Perches my $level2 = $level; 34738f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3474243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3475daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3476243f3803SJoe Perches } 3477243f3803SJoe Perches 3478243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3479d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3480d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3481d5e616fcSJoe Perches $fix) { 3482194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3483d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3484d5e616fcSJoe Perches } 3485243f3803SJoe Perches } 3486243f3803SJoe Perches 3487dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3488dc139313SJoe Perches my $orig = $1; 3489dc139313SJoe Perches my $level = lc($orig); 3490dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3491dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3492dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3493dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3494dc139313SJoe Perches } 3495dc139313SJoe Perches 349691c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 349791c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 349891c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 349991c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 350091c9afafSAndy Lutomirski WARN("ENOSYS", 350191c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 350291c9afafSAndy Lutomirski } 350391c9afafSAndy Lutomirski 3504653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3505653d4876SAndy Whitcroft# or if closed on same line 35068d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3507c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 35088d182478SJoe Perches if (ERROR("OPEN_BRACE", 35098d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 35108d182478SJoe Perches $fix) { 35118d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35128d182478SJoe Perches my $fixed_line = $rawline; 35138d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 35148d182478SJoe Perches my $line1 = $1; 35158d182478SJoe Perches my $line2 = $2; 35168d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 35178d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 35188d182478SJoe Perches if ($line2 !~ /^\s*$/) { 35198d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 35208d182478SJoe Perches } 35218d182478SJoe Perches } 35220a920b5bSAndy Whitcroft } 3523653d4876SAndy Whitcroft 35248905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 35258905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 35268905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 35278d182478SJoe Perches if (ERROR("OPEN_BRACE", 35288d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 35298d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 35308d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 35318d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35328d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 35338d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35348d182478SJoe Perches $fixedline = $rawline; 35358d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 35368d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 35378d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35388d182478SJoe Perches } 35398d182478SJoe Perches } 35408905a67cSAndy Whitcroft } 35418905a67cSAndy Whitcroft 35420c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 35433705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 35443705ce5bSJoe Perches if (WARN("SPACING", 35453705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 35463705ce5bSJoe Perches $fix) { 3547194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35483705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 35493705ce5bSJoe Perches } 35500c73b4ebSAndy Whitcroft } 35510c73b4ebSAndy Whitcroft 355231070b5dSJoe Perches# Function pointer declarations 355331070b5dSJoe Perches# check spacing between type, funcptr, and args 355431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 355591f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 355631070b5dSJoe Perches my $declare = $1; 355731070b5dSJoe Perches my $pre_pointer_space = $2; 355831070b5dSJoe Perches my $post_pointer_space = $3; 355931070b5dSJoe Perches my $funcname = $4; 356031070b5dSJoe Perches my $post_funcname_space = $5; 356131070b5dSJoe Perches my $pre_args_space = $6; 356231070b5dSJoe Perches 356391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 356491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 356591f72e9cSJoe Perches# don't need a space so don't warn for those. 356691f72e9cSJoe Perches my $post_declare_space = ""; 356791f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 356891f72e9cSJoe Perches $post_declare_space = $1; 356991f72e9cSJoe Perches $declare = rtrim($declare); 357091f72e9cSJoe Perches } 357191f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 357231070b5dSJoe Perches WARN("SPACING", 357331070b5dSJoe Perches "missing space after return type\n" . $herecurr); 357491f72e9cSJoe Perches $post_declare_space = " "; 357531070b5dSJoe Perches } 357631070b5dSJoe Perches 357731070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 357891f72e9cSJoe Perches# This test is not currently implemented because these declarations are 357991f72e9cSJoe Perches# equivalent to 358091f72e9cSJoe Perches# int foo(int bar, ...) 358191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 358291f72e9cSJoe Perches# 358391f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 358491f72e9cSJoe Perches# WARN("SPACING", 358591f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 358691f72e9cSJoe Perches# } 358731070b5dSJoe Perches 358831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 358931070b5dSJoe Perches if (defined $pre_pointer_space && 359031070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 359131070b5dSJoe Perches WARN("SPACING", 359231070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 359331070b5dSJoe Perches } 359431070b5dSJoe Perches 359531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 359631070b5dSJoe Perches if (defined $post_pointer_space && 359731070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 359831070b5dSJoe Perches WARN("SPACING", 359931070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 360031070b5dSJoe Perches } 360131070b5dSJoe Perches 360231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 360331070b5dSJoe Perches if (defined $post_funcname_space && 360431070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 360531070b5dSJoe Perches WARN("SPACING", 360631070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 360731070b5dSJoe Perches } 360831070b5dSJoe Perches 360931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 361031070b5dSJoe Perches if (defined $pre_args_space && 361131070b5dSJoe Perches $pre_args_space =~ /^\s/) { 361231070b5dSJoe Perches WARN("SPACING", 361331070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 361431070b5dSJoe Perches } 361531070b5dSJoe Perches 361631070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3617194f66fcSJoe Perches $fixed[$fixlinenr] =~ 361891f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 361931070b5dSJoe Perches } 362031070b5dSJoe Perches } 362131070b5dSJoe Perches 36228d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 36238d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3624fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3625fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 36268d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 36278d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 36288d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3629fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3630daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 36313705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 36323705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 36333705ce5bSJoe Perches $fix) { 3634194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36353705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 36363705ce5bSJoe Perches } 36378d31cfceSAndy Whitcroft } 36388d31cfceSAndy Whitcroft } 36398d31cfceSAndy Whitcroft 3640f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 36416c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3642c2fdda0dSAndy Whitcroft my $name = $1; 3643773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3644773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3645c2fdda0dSAndy Whitcroft 3646c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3647773647a0SAndy Whitcroft if ($name =~ /^(?: 3648773647a0SAndy Whitcroft if|for|while|switch|return|case| 3649773647a0SAndy Whitcroft volatile|__volatile__| 3650773647a0SAndy Whitcroft __attribute__|format|__extension__| 3651773647a0SAndy Whitcroft asm|__asm__)$/x) 3652773647a0SAndy Whitcroft { 3653c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3654c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3655c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3656c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3657773647a0SAndy Whitcroft 3658773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3659c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3660c2fdda0dSAndy Whitcroft 3661c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3662c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3663773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3664c2fdda0dSAndy Whitcroft 3665c2fdda0dSAndy Whitcroft } else { 36663705ce5bSJoe Perches if (WARN("SPACING", 36673705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 36683705ce5bSJoe Perches $fix) { 3669194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36703705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 36713705ce5bSJoe Perches } 3672f0a594c1SAndy Whitcroft } 36736c72ffaaSAndy Whitcroft } 36749a4cad4eSEric Nelson 3675653d4876SAndy Whitcroft# Check operator spacing. 36760a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 36773705ce5bSJoe Perches my $fixed_line = ""; 36783705ce5bSJoe Perches my $line_fixed = 0; 36793705ce5bSJoe Perches 36809c0ca6f9SAndy Whitcroft my $ops = qr{ 36819c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 36829c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 36839c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 36841f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 368584731623SJoe Perches \?:|\?|: 36869c0ca6f9SAndy Whitcroft }x; 3687cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 36883705ce5bSJoe Perches 36893705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 36903705ce5bSJoe Perches## foreach my $el (@elements) { 36913705ce5bSJoe Perches## print("el: <$el>\n"); 36923705ce5bSJoe Perches## } 36933705ce5bSJoe Perches 36943705ce5bSJoe Perches my @fix_elements = (); 369500df344fSAndy Whitcroft my $off = 0; 36966c72ffaaSAndy Whitcroft 36973705ce5bSJoe Perches foreach my $el (@elements) { 36983705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 36993705ce5bSJoe Perches $off += length($el); 37003705ce5bSJoe Perches } 37013705ce5bSJoe Perches 37023705ce5bSJoe Perches $off = 0; 37033705ce5bSJoe Perches 37046c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3705b34c648bSJoe Perches my $last_after = -1; 37066c72ffaaSAndy Whitcroft 37070a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 37083705ce5bSJoe Perches 37093705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 37103705ce5bSJoe Perches 37113705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 37123705ce5bSJoe Perches 37134a0df2efSAndy Whitcroft $off += length($elements[$n]); 37144a0df2efSAndy Whitcroft 371525985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3716773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3717773647a0SAndy Whitcroft my $cc = ''; 3718773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3719773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3720773647a0SAndy Whitcroft } 3721773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3722773647a0SAndy Whitcroft 37234a0df2efSAndy Whitcroft my $a = ''; 37244a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 37254a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3726cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 37274a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 37284a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3729773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 37304a0df2efSAndy Whitcroft 37310a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 37324a0df2efSAndy Whitcroft 37334a0df2efSAndy Whitcroft my $c = ''; 37340a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 37354a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 37364a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3737cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 37384a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 37394a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 37408b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 37414a0df2efSAndy Whitcroft } else { 37424a0df2efSAndy Whitcroft $c = 'E'; 37430a920b5bSAndy Whitcroft } 37440a920b5bSAndy Whitcroft 37454a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 37464a0df2efSAndy Whitcroft 37474a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 37484a0df2efSAndy Whitcroft 37496c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3750de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 37510a920b5bSAndy Whitcroft 375274048ed8SAndy Whitcroft # Pull out the value of this operator. 37536c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 37540a920b5bSAndy Whitcroft 37551f65f947SAndy Whitcroft # Get the full operator variant. 37561f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 37571f65f947SAndy Whitcroft 375813214adfSAndy Whitcroft # Ignore operators passed as parameters. 375913214adfSAndy Whitcroft if ($op_type ne 'V' && 3760d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 376113214adfSAndy Whitcroft 3762cf655043SAndy Whitcroft# # Ignore comments 3763cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 376413214adfSAndy Whitcroft 3765d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 376613214adfSAndy Whitcroft } elsif ($op eq ';') { 3767cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3768cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 37693705ce5bSJoe Perches if (ERROR("SPACING", 37703705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3771b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 37723705ce5bSJoe Perches $line_fixed = 1; 37733705ce5bSJoe Perches } 3774d8aaf121SAndy Whitcroft } 3775d8aaf121SAndy Whitcroft 3776d8aaf121SAndy Whitcroft # // is a comment 3777d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 37780a920b5bSAndy Whitcroft 3779b00e4814SJoe Perches # : when part of a bitfield 3780b00e4814SJoe Perches } elsif ($opv eq ':B') { 3781b00e4814SJoe Perches # skip the bitfield test for now 3782b00e4814SJoe Perches 37831f65f947SAndy Whitcroft # No spaces for: 37841f65f947SAndy Whitcroft # -> 3785b00e4814SJoe Perches } elsif ($op eq '->') { 37864a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 37873705ce5bSJoe Perches if (ERROR("SPACING", 37883705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3789b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37903705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37913705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 37923705ce5bSJoe Perches } 3793b34c648bSJoe Perches $line_fixed = 1; 37943705ce5bSJoe Perches } 37950a920b5bSAndy Whitcroft } 37960a920b5bSAndy Whitcroft 37972381097bSJoe Perches # , must not have a space before and must have a space on the right. 37980a920b5bSAndy Whitcroft } elsif ($op eq ',') { 37992381097bSJoe Perches my $rtrim_before = 0; 38002381097bSJoe Perches my $space_after = 0; 38012381097bSJoe Perches if ($ctx =~ /Wx./) { 38022381097bSJoe Perches if (ERROR("SPACING", 38032381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 38042381097bSJoe Perches $line_fixed = 1; 38052381097bSJoe Perches $rtrim_before = 1; 38062381097bSJoe Perches } 38072381097bSJoe Perches } 3808cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 38093705ce5bSJoe Perches if (ERROR("SPACING", 38103705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 38113705ce5bSJoe Perches $line_fixed = 1; 3812b34c648bSJoe Perches $last_after = $n; 38132381097bSJoe Perches $space_after = 1; 38142381097bSJoe Perches } 38152381097bSJoe Perches } 38162381097bSJoe Perches if ($rtrim_before || $space_after) { 38172381097bSJoe Perches if ($rtrim_before) { 38182381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38192381097bSJoe Perches } else { 38202381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38212381097bSJoe Perches } 38222381097bSJoe Perches if ($space_after) { 38232381097bSJoe Perches $good .= " "; 38243705ce5bSJoe Perches } 38250a920b5bSAndy Whitcroft } 38260a920b5bSAndy Whitcroft 38279c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 382874048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 38299c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 38309c0ca6f9SAndy Whitcroft 38319c0ca6f9SAndy Whitcroft # unary operators should have a space before and 38329c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 38339c0ca6f9SAndy Whitcroft # unary operator, or a cast 38349c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 383574048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 38360d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3837cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 38383705ce5bSJoe Perches if (ERROR("SPACING", 38393705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3840b34c648bSJoe Perches if ($n != $last_after + 2) { 3841b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 38423705ce5bSJoe Perches $line_fixed = 1; 38433705ce5bSJoe Perches } 38440a920b5bSAndy Whitcroft } 3845b34c648bSJoe Perches } 3846a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3847171ae1a4SAndy Whitcroft # A unary '*' may be const 3848171ae1a4SAndy Whitcroft 3849171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 38503705ce5bSJoe Perches if (ERROR("SPACING", 38513705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3852b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 38533705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38543705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38553705ce5bSJoe Perches } 3856b34c648bSJoe Perches $line_fixed = 1; 38573705ce5bSJoe Perches } 38580a920b5bSAndy Whitcroft } 38590a920b5bSAndy Whitcroft 38600a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 38610a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3862773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 38633705ce5bSJoe Perches if (ERROR("SPACING", 38643705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3865b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38663705ce5bSJoe Perches $line_fixed = 1; 38673705ce5bSJoe Perches } 38680a920b5bSAndy Whitcroft } 3869773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3870773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 38713705ce5bSJoe Perches if (ERROR("SPACING", 38723705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3873b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38743705ce5bSJoe Perches $line_fixed = 1; 38753705ce5bSJoe Perches } 3876653d4876SAndy Whitcroft } 3877773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 38783705ce5bSJoe Perches if (ERROR("SPACING", 38793705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3880b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38813705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38823705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3883773647a0SAndy Whitcroft } 3884b34c648bSJoe Perches $line_fixed = 1; 38853705ce5bSJoe Perches } 38863705ce5bSJoe Perches } 38870a920b5bSAndy Whitcroft 38880a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 38899c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 38909c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 38919c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3892c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3893c2fdda0dSAndy Whitcroft $op eq '%') 38940a920b5bSAndy Whitcroft { 3895d2e025f3SJoe Perches if ($check) { 3896d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3897d2e025f3SJoe Perches if (CHK("SPACING", 3898d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3899d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3900d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3901d2e025f3SJoe Perches $line_fixed = 1; 3902d2e025f3SJoe Perches } 3903d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3904d2e025f3SJoe Perches if (CHK("SPACING", 3905d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3906d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3907d2e025f3SJoe Perches $line_fixed = 1; 3908d2e025f3SJoe Perches } 3909d2e025f3SJoe Perches } 3910d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 39113705ce5bSJoe Perches if (ERROR("SPACING", 39123705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3913b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3914b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3915b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3916b34c648bSJoe Perches } 39173705ce5bSJoe Perches $line_fixed = 1; 39183705ce5bSJoe Perches } 39190a920b5bSAndy Whitcroft } 39200a920b5bSAndy Whitcroft 39211f65f947SAndy Whitcroft # A colon needs no spaces before when it is 39221f65f947SAndy Whitcroft # terminating a case value or a label. 39231f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 39241f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 39253705ce5bSJoe Perches if (ERROR("SPACING", 39263705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3927b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39283705ce5bSJoe Perches $line_fixed = 1; 39293705ce5bSJoe Perches } 39301f65f947SAndy Whitcroft } 39311f65f947SAndy Whitcroft 39320a920b5bSAndy Whitcroft # All the others need spaces both sides. 3933cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 39341f65f947SAndy Whitcroft my $ok = 0; 39351f65f947SAndy Whitcroft 393622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 39371f65f947SAndy Whitcroft if (($op eq '<' && 39381f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 39391f65f947SAndy Whitcroft ($op eq '>' && 39401f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 39411f65f947SAndy Whitcroft { 39421f65f947SAndy Whitcroft $ok = 1; 39431f65f947SAndy Whitcroft } 39441f65f947SAndy Whitcroft 3945e0df7e1fSJoe Perches # for asm volatile statements 3946e0df7e1fSJoe Perches # ignore a colon with another 3947e0df7e1fSJoe Perches # colon immediately before or after 3948e0df7e1fSJoe Perches if (($op eq ':') && 3949e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 3950e0df7e1fSJoe Perches $ok = 1; 3951e0df7e1fSJoe Perches } 3952e0df7e1fSJoe Perches 395384731623SJoe Perches # messages are ERROR, but ?: are CHK 39541f65f947SAndy Whitcroft if ($ok == 0) { 395584731623SJoe Perches my $msg_type = \&ERROR; 395684731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 395784731623SJoe Perches 395884731623SJoe Perches if (&{$msg_type}("SPACING", 39593705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3960b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3961b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3962b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3963b34c648bSJoe Perches } 39643705ce5bSJoe Perches $line_fixed = 1; 39653705ce5bSJoe Perches } 39660a920b5bSAndy Whitcroft } 396722f2a2efSAndy Whitcroft } 39684a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 39693705ce5bSJoe Perches 39703705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 39713705ce5bSJoe Perches 39723705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 39730a920b5bSAndy Whitcroft } 39743705ce5bSJoe Perches 39753705ce5bSJoe Perches if (($#elements % 2) == 0) { 39763705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 39773705ce5bSJoe Perches } 39783705ce5bSJoe Perches 3979194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3980194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 39813705ce5bSJoe Perches } 39823705ce5bSJoe Perches 39833705ce5bSJoe Perches 39840a920b5bSAndy Whitcroft } 39850a920b5bSAndy Whitcroft 3986786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3987d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3988786b6326SJoe Perches if (WARN("SPACING", 3989786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3990786b6326SJoe Perches $fix) { 3991194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3992786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3993786b6326SJoe Perches } 3994786b6326SJoe Perches } 3995786b6326SJoe Perches 3996f0a594c1SAndy Whitcroft# check for multiple assignments 3997f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3998000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3999000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4000f0a594c1SAndy Whitcroft } 4001f0a594c1SAndy Whitcroft 400222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 400322f2a2efSAndy Whitcroft## # continuation. 400422f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 400522f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 400622f2a2efSAndy Whitcroft## 400722f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 400822f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 400922f2a2efSAndy Whitcroft## my $ln = $line; 401022f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 401122f2a2efSAndy Whitcroft## } 401222f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4013000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4014000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 401522f2a2efSAndy Whitcroft## } 401622f2a2efSAndy Whitcroft## } 4017f0a594c1SAndy Whitcroft 40180a920b5bSAndy Whitcroft#need space before brace following if, while, etc 401922f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 402022f2a2efSAndy Whitcroft $line =~ /do{/) { 40213705ce5bSJoe Perches if (ERROR("SPACING", 40223705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 40233705ce5bSJoe Perches $fix) { 4024194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 40253705ce5bSJoe Perches } 4026de7d4f0eSAndy Whitcroft } 4027de7d4f0eSAndy Whitcroft 4028c4a62ef9SJoe Perches## # check for blank lines before declarations 4029c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4030c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4031c4a62ef9SJoe Perches## WARN("SPACING", 4032c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4033c4a62ef9SJoe Perches## } 4034c4a62ef9SJoe Perches## 4035c4a62ef9SJoe Perches 4036de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4037de7d4f0eSAndy Whitcroft# on the line 4038de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4039d5e616fcSJoe Perches if (ERROR("SPACING", 4040d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4041d5e616fcSJoe Perches $fix) { 4042194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4043d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4044d5e616fcSJoe Perches } 40450a920b5bSAndy Whitcroft } 40460a920b5bSAndy Whitcroft 404722f2a2efSAndy Whitcroft# check spacing on square brackets 404822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 40493705ce5bSJoe Perches if (ERROR("SPACING", 40503705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 40513705ce5bSJoe Perches $fix) { 4052194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40533705ce5bSJoe Perches s/\[\s+/\[/; 40543705ce5bSJoe Perches } 405522f2a2efSAndy Whitcroft } 405622f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 40573705ce5bSJoe Perches if (ERROR("SPACING", 40583705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 40593705ce5bSJoe Perches $fix) { 4060194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40613705ce5bSJoe Perches s/\s+\]/\]/; 40623705ce5bSJoe Perches } 406322f2a2efSAndy Whitcroft } 406422f2a2efSAndy Whitcroft 4065c45dcabdSAndy Whitcroft# check spacing on parentheses 40669c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 40679c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 40683705ce5bSJoe Perches if (ERROR("SPACING", 40693705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 40703705ce5bSJoe Perches $fix) { 4071194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40723705ce5bSJoe Perches s/\(\s+/\(/; 40733705ce5bSJoe Perches } 407422f2a2efSAndy Whitcroft } 407513214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4076c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4077c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 40783705ce5bSJoe Perches if (ERROR("SPACING", 40793705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 40803705ce5bSJoe Perches $fix) { 4081194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40823705ce5bSJoe Perches s/\s+\)/\)/; 40833705ce5bSJoe Perches } 408422f2a2efSAndy Whitcroft } 408522f2a2efSAndy Whitcroft 4086e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4087e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4088e2826fd0SJoe Perches 4089e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4090ea4acbb1SJoe Perches my $var = $1; 4091ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4092ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4093ea4acbb1SJoe Perches $fix) { 4094ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4095ea4acbb1SJoe Perches } 4096ea4acbb1SJoe Perches } 4097ea4acbb1SJoe Perches 4098ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4099ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4100ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4101ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4102ea4acbb1SJoe Perches my $var = $2; 4103ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4104ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4105ea4acbb1SJoe Perches $fix) { 4106ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4107ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4108ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4109ea4acbb1SJoe Perches } 4110e2826fd0SJoe Perches } 4111e2826fd0SJoe Perches 41120a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 41134a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 41140a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 41153705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 41163705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 41173705ce5bSJoe Perches $fix) { 4118194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41193705ce5bSJoe Perches s/^(.)\s+/$1/; 41203705ce5bSJoe Perches } 41210a920b5bSAndy Whitcroft } 41220a920b5bSAndy Whitcroft 41235b9553abSJoe Perches# return is not a function 4124507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4125c45dcabdSAndy Whitcroft my $spacing = $1; 4126507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 41275b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 41285b9553abSJoe Perches my $value = $1; 41295b9553abSJoe Perches $value = deparenthesize($value); 41305b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4131000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4132000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 41335b9553abSJoe Perches } 4134c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4135000d1cc1SJoe Perches ERROR("SPACING", 4136000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4137c45dcabdSAndy Whitcroft } 4138c45dcabdSAndy Whitcroft } 4139507e5141SJoe Perches 4140b43ae21bSJoe Perches# unnecessary return in a void function 4141b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4142b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4143b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4144b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4145b43ae21bSJoe Perches $linenr >= 3 && 4146b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4147b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 41489819cf25SJoe Perches WARN("RETURN_VOID", 4149b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 41509819cf25SJoe Perches } 41519819cf25SJoe Perches 4152189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4153189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4154189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4155189248d8SJoe Perches my $openparens = $1; 4156189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4157189248d8SJoe Perches my $msg = ""; 4158189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4159189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4160189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4161189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4162189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4163189248d8SJoe Perches } 4164189248d8SJoe Perches } 4165189248d8SJoe Perches 4166f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4167f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 416853a3c448SAndy Whitcroft my $name = $1; 416953a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4170000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4171f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 417253a3c448SAndy Whitcroft } 417353a3c448SAndy Whitcroft } 4174c45dcabdSAndy Whitcroft 41750a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 41764a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 41773705ce5bSJoe Perches if (ERROR("SPACING", 41783705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 41793705ce5bSJoe Perches $fix) { 4180194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41813705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 41823705ce5bSJoe Perches } 41830a920b5bSAndy Whitcroft } 41840a920b5bSAndy Whitcroft 4185f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4186f5fe35ddSAndy Whitcroft# statements after the conditional. 4187170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 41883e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 41893e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 41903e469cdcSAndy Whitcroft if (!defined $stat); 4191170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4192170d3a22SAndy Whitcroft $remain_next, $off_next); 4193170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4194170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4195170d3a22SAndy Whitcroft 4196170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4197170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4198170d3a22SAndy Whitcroft # then count those as offsets. 4199170d3a22SAndy Whitcroft my ($whitespace) = 4200170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4201170d3a22SAndy Whitcroft my $offset = 4202170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4203170d3a22SAndy Whitcroft 4204170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4205170d3a22SAndy Whitcroft $offset} = 1; 4206170d3a22SAndy Whitcroft } 4207170d3a22SAndy Whitcroft } 4208170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4209c11230f4SJoe Perches defined($stat) && defined($cond) && 4210170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4211171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 42128905a67cSAndy Whitcroft 4213b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4214000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4215000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 42168905a67cSAndy Whitcroft } 42178905a67cSAndy Whitcroft 42188905a67cSAndy Whitcroft # Find out what is on the end of the line after the 42198905a67cSAndy Whitcroft # conditional. 4220773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 42218905a67cSAndy Whitcroft $s =~ s/\n.*//g; 422213214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 422353210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 422453210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4225773647a0SAndy Whitcroft { 4226bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4227bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4228bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 422942bdf74cSHidetoshi Seto my $stat_real = ''; 4230bb44ad39SAndy Whitcroft 423142bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 423242bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4233bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4234bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4235bb44ad39SAndy Whitcroft } 4236bb44ad39SAndy Whitcroft 4237000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4238000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 42398905a67cSAndy Whitcroft } 42408905a67cSAndy Whitcroft } 42418905a67cSAndy Whitcroft 424213214adfSAndy Whitcroft# Check for bitwise tests written as boolean 424313214adfSAndy Whitcroft if ($line =~ / 424413214adfSAndy Whitcroft (?: 424513214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 424613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 424713214adfSAndy Whitcroft (?:\&\&|\|\|) 424813214adfSAndy Whitcroft | 424913214adfSAndy Whitcroft (?:\&\&|\|\|) 425013214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 425113214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 425213214adfSAndy Whitcroft )/x) 425313214adfSAndy Whitcroft { 4254000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4255000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 425613214adfSAndy Whitcroft } 425713214adfSAndy Whitcroft 42588905a67cSAndy Whitcroft# if and else should not have general statements after it 425913214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 426013214adfSAndy Whitcroft my $s = $1; 426113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 426213214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4263000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4264000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 42650a920b5bSAndy Whitcroft } 426613214adfSAndy Whitcroft } 426739667782SAndy Whitcroft# if should not continue a brace 426839667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4269000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4270048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 427139667782SAndy Whitcroft $herecurr); 427239667782SAndy Whitcroft } 4273a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4274a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4275a1080bf8SAndy Whitcroft $line !~ /\G(?: 42763fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4277a1080bf8SAndy Whitcroft \s*return\s+ 4278a1080bf8SAndy Whitcroft )/xg) 4279a1080bf8SAndy Whitcroft { 4280000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4281000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4282a1080bf8SAndy Whitcroft } 42830a920b5bSAndy Whitcroft 42840a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 42850a920b5bSAndy Whitcroft # indent level to be relevant to each other. 42868b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 42870a920b5bSAndy Whitcroft $previndent == $indent) { 42888b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 42898b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 42908b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 42918b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 42928b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 42938b8856f4SJoe Perches my $fixedline = $prevrawline; 42948b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 42958b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 42968b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 42978b8856f4SJoe Perches } 42988b8856f4SJoe Perches $fixedline = $rawline; 42998b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 43008b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43018b8856f4SJoe Perches } 43020a920b5bSAndy Whitcroft } 43030a920b5bSAndy Whitcroft 43048b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4305c2fdda0dSAndy Whitcroft $previndent == $indent) { 4306c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4307c2fdda0dSAndy Whitcroft 4308c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4309c2fdda0dSAndy Whitcroft # conditional. 4310773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4311c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4312c2fdda0dSAndy Whitcroft 4313c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 43148b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 43158b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 43168b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43178b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43188b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43198b8856f4SJoe Perches my $fixedline = $prevrawline; 43208b8856f4SJoe Perches my $trailing = $rawline; 43218b8856f4SJoe Perches $trailing =~ s/^\+//; 43228b8856f4SJoe Perches $trailing = trim($trailing); 43238b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 43248b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43258b8856f4SJoe Perches } 4326c2fdda0dSAndy Whitcroft } 4327c2fdda0dSAndy Whitcroft } 4328c2fdda0dSAndy Whitcroft 432995e2c602SJoe Perches#Specific variable tests 4330323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4331323c1260SJoe Perches my $var = $1; 433295e2c602SJoe Perches 433395e2c602SJoe Perches#gcc binary extension 433495e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4335d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4336d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4337d5e616fcSJoe Perches $fix) { 4338d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4339194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4340d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4341d5e616fcSJoe Perches } 434295e2c602SJoe Perches } 434395e2c602SJoe Perches 434495e2c602SJoe Perches#CamelCase 4345807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4346be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 434722735ce8SJoe Perches#Ignore Page<foo> variants 4348807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 434922735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4350f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4351f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4352f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 43537e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 43547e781f67SJoe Perches my $word = $1; 43557e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4356d8b07710SJoe Perches if ($check) { 4357d8b07710SJoe Perches seed_camelcase_includes(); 4358d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4359d8b07710SJoe Perches seed_camelcase_file($realfile); 4360d8b07710SJoe Perches $camelcase_file_seeded = 1; 4361d8b07710SJoe Perches } 4362d8b07710SJoe Perches } 43637e781f67SJoe Perches if (!defined $camelcase{$word}) { 43647e781f67SJoe Perches $camelcase{$word} = 1; 4365be79794bSJoe Perches CHK("CAMELCASE", 43667e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 43677e781f67SJoe Perches } 4368323c1260SJoe Perches } 4369323c1260SJoe Perches } 43703445686aSJoe Perches } 43710a920b5bSAndy Whitcroft 43720a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4373d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4374d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4375d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4376d5e616fcSJoe Perches $fix) { 4377194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4378d5e616fcSJoe Perches } 43790a920b5bSAndy Whitcroft } 43800a920b5bSAndy Whitcroft 43810e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 43820e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4383c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4384e09dec48SAndy Whitcroft my $file = "$1.h"; 4385e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4386e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4387e09dec48SAndy Whitcroft $realfile ne $checkfile && 43887840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4389c45dcabdSAndy Whitcroft { 43900e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 43910e212e0aSFabian Frederick if ($asminclude > 0) { 4392e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4393000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4394000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4395e09dec48SAndy Whitcroft } else { 4396000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4397000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4398e09dec48SAndy Whitcroft } 43990a920b5bSAndy Whitcroft } 44000a920b5bSAndy Whitcroft } 44010e212e0aSFabian Frederick } 44020a920b5bSAndy Whitcroft 4403653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4404653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4405cf655043SAndy Whitcroft# in a known good container 4406b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4407b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4408d8aaf121SAndy Whitcroft my $ln = $linenr; 4409d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4410c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4411c45dcabdSAndy Whitcroft my $ctx = ''; 441208a2843eSJoe Perches my $has_flow_statement = 0; 441308a2843eSJoe Perches my $has_arg_concat = 0; 4414c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4415f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4416f74bd194SAndy Whitcroft $ctx = $dstat; 4417c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4418a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4419c45dcabdSAndy Whitcroft 442008a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 442108a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 442208a2843eSJoe Perches 4423f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4424292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4425c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4426c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4427c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4428c45dcabdSAndy Whitcroft 4429c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4430bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4431bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4432c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4433bf30d6edSAndy Whitcroft { 4434c45dcabdSAndy Whitcroft } 4435c45dcabdSAndy Whitcroft 4436e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 443733acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 443833acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4439e45bab8eSAndy Whitcroft { 4440e45bab8eSAndy Whitcroft } 4441e45bab8eSAndy Whitcroft 4442c45dcabdSAndy Whitcroft my $exceptions = qr{ 4443c45dcabdSAndy Whitcroft $Declare| 4444c45dcabdSAndy Whitcroft module_param_named| 4445a0a0a7a9SKees Cook MODULE_PARM_DESC| 4446c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4447c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4448383099fdSAndy Whitcroft __typeof__\(| 444922fd2d3eSStefani Seibold union| 445022fd2d3eSStefani Seibold struct| 4451ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4452ea71a0a0SAndy Whitcroft ^\"|\"$ 4453c45dcabdSAndy Whitcroft }x; 44545eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4455f74bd194SAndy Whitcroft if ($dstat ne '' && 4456f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4457f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 44583cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4459356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4460f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4461f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4462e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 446372f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4464f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4465f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4466f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4467f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4468f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4469c45dcabdSAndy Whitcroft { 4470f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4471f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4472f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4473f74bd194SAndy Whitcroft 4474f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4475f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4476c45dcabdSAndy Whitcroft } 4477c45dcabdSAndy Whitcroft 4478f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4479f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4480f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4481f74bd194SAndy Whitcroft } else { 4482000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4483388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4484d8aaf121SAndy Whitcroft } 44850a920b5bSAndy Whitcroft } 44865023d347SJoe Perches 448708a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 448808a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 448908a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 449008a2843eSJoe Perches my $herectx = $here . "\n"; 449108a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 449208a2843eSJoe Perches 449308a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 449408a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 449508a2843eSJoe Perches } 449608a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 449708a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 449808a2843eSJoe Perches } 449908a2843eSJoe Perches 4500481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 45015023d347SJoe Perches 45025023d347SJoe Perches } else { 45035023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4504481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4505481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 45065023d347SJoe Perches $line =~ /^\+.*\\$/) { 45075023d347SJoe Perches WARN("LINE_CONTINUATIONS", 45085023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 45095023d347SJoe Perches } 4510653d4876SAndy Whitcroft } 45110a920b5bSAndy Whitcroft 4512b13edf7fSJoe Perches# do {} while (0) macro tests: 4513b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4514b13edf7fSJoe Perches# macro should not end with a semicolon 4515b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4516b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4517b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4518b13edf7fSJoe Perches my $ln = $linenr; 4519b13edf7fSJoe Perches my $cnt = $realcnt; 4520b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4521b13edf7fSJoe Perches my $ctx = ''; 4522b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4523b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4524b13edf7fSJoe Perches $ctx = $dstat; 4525b13edf7fSJoe Perches 4526b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 45271b36b201SJoe Perches $dstat =~ s/$;/ /g; 4528b13edf7fSJoe Perches 4529b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4530b13edf7fSJoe Perches my $stmts = $2; 4531b13edf7fSJoe Perches my $semis = $3; 4532b13edf7fSJoe Perches 4533b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4534b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4535b13edf7fSJoe Perches my $herectx = $here . "\n"; 4536b13edf7fSJoe Perches 4537b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4538b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4539b13edf7fSJoe Perches } 4540b13edf7fSJoe Perches 4541ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4542ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4543b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4544b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4545b13edf7fSJoe Perches } 4546b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4547b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4548b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4549b13edf7fSJoe Perches } 4550f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4551f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4552f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4553f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4554f5ef95b1SJoe Perches 4555f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4556f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4557f5ef95b1SJoe Perches } 4558f5ef95b1SJoe Perches 4559f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4560f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4561b13edf7fSJoe Perches } 4562b13edf7fSJoe Perches } 4563b13edf7fSJoe Perches 4564080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4565080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4566080ba929SMike Frysinger# . 4567080ba929SMike Frysinger# ALIGN(...) 4568080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4569080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4570000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4571000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4572080ba929SMike Frysinger } 4573080ba929SMike Frysinger 4574f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 457513214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 457613214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4577cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 457813214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4579cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4580cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4581aad4f614SJoe Perches my @allowed = (); 4582aad4f614SJoe Perches my $allow = 0; 458313214adfSAndy Whitcroft my $seen = 0; 4584773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4585cf655043SAndy Whitcroft my $ln = $linenr - 1; 458613214adfSAndy Whitcroft for my $chunk (@chunks) { 458713214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 458813214adfSAndy Whitcroft 4589773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4590773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4591773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4592773647a0SAndy Whitcroft 4593aad4f614SJoe Perches $allowed[$allow] = 0; 4594773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4595773647a0SAndy Whitcroft 4596773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4597773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4598773647a0SAndy Whitcroft 4599773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4600cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4601cf655043SAndy Whitcroft 4602773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 460313214adfSAndy Whitcroft 460413214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 460513214adfSAndy Whitcroft 4606aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4607cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4608cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4609aad4f614SJoe Perches $allowed[$allow] = 1; 461013214adfSAndy Whitcroft } 461113214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4612cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4613aad4f614SJoe Perches $allowed[$allow] = 1; 461413214adfSAndy Whitcroft } 4615cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4616cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4617aad4f614SJoe Perches $allowed[$allow] = 1; 461813214adfSAndy Whitcroft } 4619aad4f614SJoe Perches $allow++; 462013214adfSAndy Whitcroft } 4621aad4f614SJoe Perches if ($seen) { 4622aad4f614SJoe Perches my $sum_allowed = 0; 4623aad4f614SJoe Perches foreach (@allowed) { 4624aad4f614SJoe Perches $sum_allowed += $_; 4625aad4f614SJoe Perches } 4626aad4f614SJoe Perches if ($sum_allowed == 0) { 4627000d1cc1SJoe Perches WARN("BRACES", 4628000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4629aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4630aad4f614SJoe Perches $seen != $allow) { 4631aad4f614SJoe Perches CHK("BRACES", 4632aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4633aad4f614SJoe Perches } 463413214adfSAndy Whitcroft } 463513214adfSAndy Whitcroft } 463613214adfSAndy Whitcroft } 4637773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 463813214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4639cf655043SAndy Whitcroft my $allowed = 0; 4640f0a594c1SAndy Whitcroft 4641cf655043SAndy Whitcroft # Check the pre-context. 4642cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4643cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4644cf655043SAndy Whitcroft $allowed = 1; 4645f0a594c1SAndy Whitcroft } 4646773647a0SAndy Whitcroft 4647773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4648773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4649773647a0SAndy Whitcroft 4650cf655043SAndy Whitcroft # Check the condition. 4651cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4652773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4653cf655043SAndy Whitcroft if (defined $cond) { 4654773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4655cf655043SAndy Whitcroft } 4656cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4657cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4658cf655043SAndy Whitcroft $allowed = 1; 4659cf655043SAndy Whitcroft } 4660cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4661cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4662cf655043SAndy Whitcroft $allowed = 1; 4663cf655043SAndy Whitcroft } 4664cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4665cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4666cf655043SAndy Whitcroft $allowed = 1; 4667cf655043SAndy Whitcroft } 4668cf655043SAndy Whitcroft # Check the post-context. 4669cf655043SAndy Whitcroft if (defined $chunks[1]) { 4670cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4671cf655043SAndy Whitcroft if (defined $cond) { 4672773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4673cf655043SAndy Whitcroft } 4674cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4675cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4676cf655043SAndy Whitcroft $allowed = 1; 4677cf655043SAndy Whitcroft } 4678cf655043SAndy Whitcroft } 4679cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 468069932487SJustin P. Mattock my $herectx = $here . "\n"; 4681f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4682cf655043SAndy Whitcroft 4683f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 468469932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4685cf655043SAndy Whitcroft } 4686cf655043SAndy Whitcroft 4687000d1cc1SJoe Perches WARN("BRACES", 4688000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4689f0a594c1SAndy Whitcroft } 4690f0a594c1SAndy Whitcroft } 4691f0a594c1SAndy Whitcroft 46920979ae66SJoe Perches# check for unnecessary blank lines around braces 469377b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4694f8e58219SJoe Perches if (CHK("BRACES", 4695f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4696f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4697f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4698f8e58219SJoe Perches } 46990979ae66SJoe Perches } 470077b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4701f8e58219SJoe Perches if (CHK("BRACES", 4702f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4703f8e58219SJoe Perches $fix) { 4704f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4705f8e58219SJoe Perches } 47060979ae66SJoe Perches } 47070979ae66SJoe Perches 47084a0df2efSAndy Whitcroft# no volatiles please 47096c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 47106c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4711000d1cc1SJoe Perches WARN("VOLATILE", 4712000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 47134a0df2efSAndy Whitcroft } 47144a0df2efSAndy Whitcroft 47155e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 47165e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 47175e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 47185e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 471933acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 47205e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 47215e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 47225e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 47235e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 47245e4f6ba5SJoe Perches $fix && 47255e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 47265e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 47275e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 47285e4f6ba5SJoe Perches my $comma_close = ""; 47295e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 47305e4f6ba5SJoe Perches $comma_close = $1; 47315e4f6ba5SJoe Perches } 47325e4f6ba5SJoe Perches 47335e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47345e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 47355e4f6ba5SJoe Perches my $fixedline = $prevrawline; 47365e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 47375e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 47385e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 47395e4f6ba5SJoe Perches $fixedline = $rawline; 47405e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 47415e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 47425e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47435e4f6ba5SJoe Perches } 47445e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 47455e4f6ba5SJoe Perches } 47465e4f6ba5SJoe Perches } 47475e4f6ba5SJoe Perches 47485e4f6ba5SJoe Perches# check for missing a space in a string concatenation 47495e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 47505e4f6ba5SJoe Perches WARN('MISSING_SPACE', 47515e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 47525e4f6ba5SJoe Perches } 47535e4f6ba5SJoe Perches 47545e4f6ba5SJoe Perches# check for spaces before a quoted newline 47555e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 47565e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 47575e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 47585e4f6ba5SJoe Perches $fix) { 47595e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 47605e4f6ba5SJoe Perches } 47615e4f6ba5SJoe Perches 47625e4f6ba5SJoe Perches } 47635e4f6ba5SJoe Perches 4764f17dba4fSJoe Perches# concatenated string without spaces between elements 476533acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4766f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4767f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4768f17dba4fSJoe Perches } 4769f17dba4fSJoe Perches 477090ad30e5SJoe Perches# uncoalesced string fragments 477133acb54aSJoe Perches if ($line =~ /$String\s*"/) { 477290ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 477390ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 477490ad30e5SJoe Perches } 477590ad30e5SJoe Perches 47765e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 47775e4f6ba5SJoe Perches my $string; 47785e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 47795e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 47805e4f6ba5SJoe Perches $string =~ s/%%/__/g; 47815e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 47825e4f6ba5SJoe Perches WARN("PRINTF_L", 47835e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 47845e4f6ba5SJoe Perches last; 47855e4f6ba5SJoe Perches } 47865e4f6ba5SJoe Perches } 47875e4f6ba5SJoe Perches 47885e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 47895e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 47905e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 47915e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 47925e4f6ba5SJoe Perches } 47935e4f6ba5SJoe Perches 479400df344fSAndy Whitcroft# warn about #if 0 4795c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4796000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4797000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4798de7d4f0eSAndy Whitcroft $herecurr); 47994a0df2efSAndy Whitcroft } 48004a0df2efSAndy Whitcroft 480103df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 480203df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 480303df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 480403df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 480503df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 480615160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 48074c432a8fSGreg Kroah-Hartman } 48084c432a8fSGreg Kroah-Hartman } 4809f0a594c1SAndy Whitcroft 4810ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4811ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4812ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4813ebfdc409SJoe Perches (defined $1 || defined $3) && 4814ebfdc409SJoe Perches $linenr > 3) { 4815ebfdc409SJoe Perches my $testval = $2; 4816ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4817ebfdc409SJoe Perches 4818ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4819ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4820ebfdc409SJoe Perches 4821ebfdc409SJoe 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)/) { 4822ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4823ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4824ebfdc409SJoe Perches } 4825ebfdc409SJoe Perches } 4826ebfdc409SJoe Perches 4827f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4828dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4829f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4830f78d98f6SJoe Perches my $level = $1; 4831f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4832f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4833f78d98f6SJoe Perches $fix) { 4834f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4835f78d98f6SJoe Perches } 4836f78d98f6SJoe Perches } 4837f78d98f6SJoe Perches 4838abb08a53SJoe Perches# check for mask then right shift without a parentheses 4839abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4840abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4841abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4842abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4843abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4844abb08a53SJoe Perches } 4845abb08a53SJoe Perches 4846b75ac618SJoe Perches# check for pointer comparisons to NULL 4847b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4848b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4849b75ac618SJoe Perches my $val = $1; 4850b75ac618SJoe Perches my $equal = "!"; 4851b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4852b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4853b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4854b75ac618SJoe Perches $fix) { 4855b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4856b75ac618SJoe Perches } 4857b75ac618SJoe Perches } 4858b75ac618SJoe Perches } 4859b75ac618SJoe Perches 48608716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 48618716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 48628716de38SJoe Perches my $attr = $1; 48638716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 48648716de38SJoe Perches my $ptr = $1; 48658716de38SJoe Perches my $var = $2; 48668716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 48678716de38SJoe Perches ERROR("MISPLACED_INIT", 48688716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 48698716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 48708716de38SJoe Perches WARN("MISPLACED_INIT", 48718716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 48728716de38SJoe Perches $fix) { 4873194f66fcSJoe 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; 48748716de38SJoe Perches } 48758716de38SJoe Perches } 48768716de38SJoe Perches } 48778716de38SJoe Perches 4878e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4879e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4880e970b884SJoe Perches my $attr = $1; 4881e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4882e970b884SJoe Perches my $attr_prefix = $1; 4883e970b884SJoe Perches my $attr_type = $2; 4884e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4885e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4886e970b884SJoe Perches $fix) { 4887194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4888e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4889e970b884SJoe Perches } 4890e970b884SJoe Perches } 4891e970b884SJoe Perches 4892e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4893e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4894e970b884SJoe Perches my $attr = $1; 4895e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4896e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4897e970b884SJoe Perches $fix) { 4898194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4899e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4900e970b884SJoe Perches $lead = rtrim($1); 4901e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4902e970b884SJoe Perches $lead = "${lead}const "; 4903194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4904e970b884SJoe Perches } 4905e970b884SJoe Perches } 4906e970b884SJoe Perches 4907c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 4908c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 4909c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 4910c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 4911c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 4912c17893c7SJoe Perches $fix) { 4913c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 4914c17893c7SJoe Perches } 4915c17893c7SJoe Perches } 4916c17893c7SJoe Perches 4917fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4918fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4919fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4920fbdb8138SJoe Perches my $constant_func = $1; 4921fbdb8138SJoe Perches my $func = $constant_func; 4922fbdb8138SJoe Perches $func =~ s/^__constant_//; 4923fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4924fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4925fbdb8138SJoe Perches $fix) { 4926194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4927fbdb8138SJoe Perches } 4928fbdb8138SJoe Perches } 4929fbdb8138SJoe Perches 49301a15a250SPatrick Pannuto# prefer usleep_range over udelay 493137581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 493243c1d77cSJoe Perches my $delay = $1; 49331a15a250SPatrick Pannuto # ignore udelay's < 10, however 493443c1d77cSJoe Perches if (! ($delay < 10) ) { 4935000d1cc1SJoe Perches CHK("USLEEP_RANGE", 493643c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 493743c1d77cSJoe Perches } 493843c1d77cSJoe Perches if ($delay > 2000) { 493943c1d77cSJoe Perches WARN("LONG_UDELAY", 494043c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 49411a15a250SPatrick Pannuto } 49421a15a250SPatrick Pannuto } 49431a15a250SPatrick Pannuto 494409ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 494509ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 494609ef8725SPatrick Pannuto if ($1 < 20) { 4947000d1cc1SJoe Perches WARN("MSLEEP", 494843c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 494909ef8725SPatrick Pannuto } 495009ef8725SPatrick Pannuto } 495109ef8725SPatrick Pannuto 495236ec1939SJoe Perches# check for comparisons of jiffies 495336ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 495436ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 495536ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 495636ec1939SJoe Perches } 495736ec1939SJoe Perches 49589d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 49599d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 49609d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 49619d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 49629d7a34a5SJoe Perches } 49639d7a34a5SJoe Perches 496400df344fSAndy Whitcroft# warn about #ifdefs in C files 4965c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 496600df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 496700df344fSAndy Whitcroft# print "$herecurr"; 496800df344fSAndy Whitcroft# $clean = 0; 496900df344fSAndy Whitcroft# } 497000df344fSAndy Whitcroft 497122f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4972c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 49733705ce5bSJoe Perches if (ERROR("SPACING", 49743705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 49753705ce5bSJoe Perches $fix) { 4976194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49773705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 49783705ce5bSJoe Perches } 49793705ce5bSJoe Perches 498022f2a2efSAndy Whitcroft } 498122f2a2efSAndy Whitcroft 49824a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4983171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4984171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 49854a0df2efSAndy Whitcroft my $which = $1; 49864a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4987000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4988000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 49894a0df2efSAndy Whitcroft } 49904a0df2efSAndy Whitcroft } 49914a0df2efSAndy Whitcroft# check for memory barriers without a comment. 49924a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 49934a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4994c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4995000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 49964a0df2efSAndy Whitcroft } 49974a0df2efSAndy Whitcroft } 4998cb426e99SJoe Perches# check for waitqueue_active without a comment. 4999cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5000cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5001cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5002cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5003cb426e99SJoe Perches } 5004cb426e99SJoe Perches } 50054a0df2efSAndy Whitcroft# check of hardware specific defines 5006c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5007000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5008000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 50090a920b5bSAndy Whitcroft } 5010653d4876SAndy Whitcroft 5011d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5012d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5013000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5014000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5015d4977c78STobias Klauser } 5016d4977c78STobias Klauser 5017de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5018de7d4f0eSAndy Whitcroft# storage class and type. 50199c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 50209c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5021000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5022000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5023de7d4f0eSAndy Whitcroft } 5024de7d4f0eSAndy Whitcroft 50258905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 50262b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50272b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5028d5e616fcSJoe Perches if (WARN("INLINE", 5029d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5030d5e616fcSJoe Perches $fix) { 5031194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5032d5e616fcSJoe Perches 5033d5e616fcSJoe Perches } 50348905a67cSAndy Whitcroft } 50358905a67cSAndy Whitcroft 50363d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 50372b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50382b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5039000d1cc1SJoe Perches WARN("PREFER_PACKED", 5040000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 50413d130fd0SJoe Perches } 50423d130fd0SJoe Perches 504339b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 50442b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50452b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5046000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5047000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 504839b7e287SJoe Perches } 504939b7e287SJoe Perches 50505f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 50512b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50522b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5053d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5054d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5055d5e616fcSJoe Perches $fix) { 5056194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5057d5e616fcSJoe Perches 5058d5e616fcSJoe Perches } 50595f14d3bdSJoe Perches } 50605f14d3bdSJoe Perches 50616061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 50622b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50632b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5064d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5065d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5066d5e616fcSJoe Perches $fix) { 5067194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5068d5e616fcSJoe Perches } 50696061d949SJoe Perches } 50706061d949SJoe Perches 5071619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5072619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5073619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5074619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5075619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5076619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5077619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5078619a908aSJoe Perches } 5079619a908aSJoe Perches 5080e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5081e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5082e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5083e6176fa4SJoe Perches my $type = $1; 5084e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5085e6176fa4SJoe Perches $type = $1; 5086e6176fa4SJoe Perches my $kernel_type = 'u'; 5087e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5088e6176fa4SJoe Perches $type =~ /(\d+)/; 5089e6176fa4SJoe Perches $kernel_type .= $1; 5090e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5091e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5092e6176fa4SJoe Perches $fix) { 5093e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5094e6176fa4SJoe Perches } 5095e6176fa4SJoe Perches } 5096e6176fa4SJoe Perches } 5097e6176fa4SJoe Perches 50988f53a9b8SJoe Perches# check for sizeof(&) 50998f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5100000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5101000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 51028f53a9b8SJoe Perches } 51038f53a9b8SJoe Perches 510466c80b60SJoe Perches# check for sizeof without parenthesis 510566c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5106d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5107d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5108d5e616fcSJoe Perches $fix) { 5109194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5110d5e616fcSJoe Perches } 511166c80b60SJoe Perches } 511266c80b60SJoe Perches 511388982feaSJoe Perches# check for struct spinlock declarations 511488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 511588982feaSJoe Perches WARN("USE_SPINLOCK_T", 511688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 511788982feaSJoe Perches } 511888982feaSJoe Perches 5119a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 512006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5121a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5122caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5123caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5124d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5125d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5126d5e616fcSJoe Perches $fix) { 5127194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5128d5e616fcSJoe Perches } 5129a6962d72SJoe Perches } 5130a6962d72SJoe Perches } 5131a6962d72SJoe Perches 5132554e165cSAndy Whitcroft# Check for misused memsets 5133d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5134d1fe9c09SJoe Perches defined $stat && 51359e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5136554e165cSAndy Whitcroft 5137d7c76ba7SJoe Perches my $ms_addr = $2; 5138d1fe9c09SJoe Perches my $ms_val = $7; 5139d1fe9c09SJoe Perches my $ms_size = $12; 5140d7c76ba7SJoe Perches 5141554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5142554e165cSAndy Whitcroft ERROR("MEMSET", 5143d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5144554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5145554e165cSAndy Whitcroft WARN("MEMSET", 5146d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5147d7c76ba7SJoe Perches } 5148d7c76ba7SJoe Perches } 5149d7c76ba7SJoe Perches 515098a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 515198a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 515298a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 515398a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 515498a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 515598a9bba5SJoe Perches $fix) { 5156194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 515798a9bba5SJoe Perches } 515898a9bba5SJoe Perches } 515998a9bba5SJoe Perches 5160b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5161b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5162b6117d17SMateusz Kulikowski defined $stat && 5163b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5164b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5165b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5166b6117d17SMateusz Kulikowski } 5167b6117d17SMateusz Kulikowski 5168*8617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 5169*8617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 5170*8617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5171*8617cd09SMateusz Kulikowski defined $stat && 5172*8617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5173*8617cd09SMateusz Kulikowski 5174*8617cd09SMateusz Kulikowski my $ms_val = $7; 5175*8617cd09SMateusz Kulikowski 5176*8617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 5177*8617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 5178*8617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 5179*8617cd09SMateusz Kulikowski $fix) { 5180*8617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 5181*8617cd09SMateusz Kulikowski } 5182*8617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 5183*8617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 5184*8617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 5185*8617cd09SMateusz Kulikowski $fix) { 5186*8617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 5187*8617cd09SMateusz Kulikowski } 5188*8617cd09SMateusz Kulikowski } 5189*8617cd09SMateusz Kulikowski } 5190*8617cd09SMateusz Kulikowski 5191d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5192d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5193d1fe9c09SJoe Perches defined $stat && 5194d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5195d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5196d7c76ba7SJoe Perches my $call = $1; 5197d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5198d7c76ba7SJoe Perches my $arg1 = $3; 5199d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5200d1fe9c09SJoe Perches my $arg2 = $8; 5201d7c76ba7SJoe Perches my $cast; 5202d7c76ba7SJoe Perches 5203d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5204d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5205d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5206d7c76ba7SJoe Perches $cast = $cast1; 5207d7c76ba7SJoe Perches } else { 5208d7c76ba7SJoe Perches $cast = $cast2; 5209d7c76ba7SJoe Perches } 5210d7c76ba7SJoe Perches WARN("MINMAX", 5211d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5212554e165cSAndy Whitcroft } 5213554e165cSAndy Whitcroft } 5214554e165cSAndy Whitcroft 52154a273195SJoe Perches# check usleep_range arguments 52164a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 52174a273195SJoe Perches defined $stat && 52184a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 52194a273195SJoe Perches my $min = $1; 52204a273195SJoe Perches my $max = $7; 52214a273195SJoe Perches if ($min eq $max) { 52224a273195SJoe Perches WARN("USLEEP_RANGE", 52234a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 52244a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 52254a273195SJoe Perches $min > $max) { 52264a273195SJoe Perches WARN("USLEEP_RANGE", 52274a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 52284a273195SJoe Perches } 52294a273195SJoe Perches } 52304a273195SJoe Perches 5231823b794cSJoe Perches# check for naked sscanf 5232823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5233823b794cSJoe Perches defined $stat && 52346c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5235823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5236823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5237823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5238823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5239823b794cSJoe Perches $lc = $lc + $linenr; 5240823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5241823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5242823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5243823b794cSJoe Perches } 5244823b794cSJoe Perches WARN("NAKED_SSCANF", 5245823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5246823b794cSJoe Perches } 5247823b794cSJoe Perches 5248afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5249afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5250afc819abSJoe Perches defined $stat && 5251afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5252afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5253afc819abSJoe Perches $lc = $lc + $linenr; 5254afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5255afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5256afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5257afc819abSJoe Perches } 5258afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5259afc819abSJoe Perches my $format = $6; 5260afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5261afc819abSJoe Perches if ($count == 1 && 5262afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5263afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5264afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5265afc819abSJoe Perches } 5266afc819abSJoe Perches } 5267afc819abSJoe Perches } 5268afc819abSJoe Perches 526970dc8a48SJoe Perches# check for new externs in .h files. 527070dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 527170dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5272d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 527370dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 527470dc8a48SJoe Perches $fix) { 5275194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 527670dc8a48SJoe Perches } 527770dc8a48SJoe Perches } 527870dc8a48SJoe Perches 5279de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5280171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5281c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5282171ae1a4SAndy Whitcroft { 5283c45dcabdSAndy Whitcroft my $function_name = $1; 5284c45dcabdSAndy Whitcroft my $paren_space = $2; 5285171ae1a4SAndy Whitcroft 5286171ae1a4SAndy Whitcroft my $s = $stat; 5287171ae1a4SAndy Whitcroft if (defined $cond) { 5288171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5289171ae1a4SAndy Whitcroft } 5290c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5291c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5292c45dcabdSAndy Whitcroft { 5293000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5294000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5295de7d4f0eSAndy Whitcroft } 5296de7d4f0eSAndy Whitcroft 5297171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5298000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5299000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5300171ae1a4SAndy Whitcroft } 53019c9ba34eSAndy Whitcroft 53029c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 53039c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 53049c9ba34eSAndy Whitcroft { 5305000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5306000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5307171ae1a4SAndy Whitcroft } 5308171ae1a4SAndy Whitcroft 5309de7d4f0eSAndy Whitcroft# checks for new __setup's 5310de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5311de7d4f0eSAndy Whitcroft my $name = $1; 5312de7d4f0eSAndy Whitcroft 5313de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5314000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5315000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5316de7d4f0eSAndy Whitcroft } 5317653d4876SAndy Whitcroft } 53189c0ca6f9SAndy Whitcroft 53199c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5320caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5321000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5322000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 53239c0ca6f9SAndy Whitcroft } 532413214adfSAndy Whitcroft 5325a640d25cSJoe Perches# alloc style 5326a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5327a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5328a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5329a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5330a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5331a640d25cSJoe Perches } 5332a640d25cSJoe Perches 533360a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 533460a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5335e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 533660a55369SJoe Perches my $oldfunc = $3; 533760a55369SJoe Perches my $a1 = $4; 533860a55369SJoe Perches my $a2 = $10; 533960a55369SJoe Perches my $newfunc = "kmalloc_array"; 534060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 534160a55369SJoe Perches my $r1 = $a1; 534260a55369SJoe Perches my $r2 = $a2; 534360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 534460a55369SJoe Perches $r1 = $a2; 534560a55369SJoe Perches $r2 = $a1; 534660a55369SJoe Perches } 5347e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5348e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5349e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5350e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5351e367455aSJoe Perches $fix) { 5352194f66fcSJoe 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; 535360a55369SJoe Perches 535460a55369SJoe Perches } 535560a55369SJoe Perches } 535660a55369SJoe Perches } 535760a55369SJoe Perches 5358972fdea2SJoe Perches# check for krealloc arg reuse 5359972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5360972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5361972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5362972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5363972fdea2SJoe Perches } 5364972fdea2SJoe Perches 53655ce59ae0SJoe Perches# check for alloc argument mismatch 53665ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 53675ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 53685ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 53695ce59ae0SJoe Perches } 53705ce59ae0SJoe Perches 5371caf2a54fSJoe Perches# check for multiple semicolons 5372caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5373d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5374d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5375d5e616fcSJoe Perches $fix) { 5376194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5377d5e616fcSJoe Perches } 5378d1e2ad07SJoe Perches } 5379d1e2ad07SJoe Perches 53800ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 53810ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 53820ab90191SJoe Perches my $ull = ""; 53830ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 53840ab90191SJoe Perches if (CHK("BIT_MACRO", 53850ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 53860ab90191SJoe Perches $fix) { 53870ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 53880ab90191SJoe Perches } 53890ab90191SJoe Perches } 53900ab90191SJoe Perches 5391e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5392c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5393c34c09a8SJoe Perches my $has_break = 0; 5394c34c09a8SJoe Perches my $has_statement = 0; 5395c34c09a8SJoe Perches my $count = 0; 5396c34c09a8SJoe Perches my $prevline = $linenr; 5397e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5398c34c09a8SJoe Perches $prevline--; 5399c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5400c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5401c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5402c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5403c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5404c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5405c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5406c34c09a8SJoe Perches $has_statement = 1; 5407c34c09a8SJoe Perches $count++; 5408c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5409c34c09a8SJoe Perches } 5410c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5411c34c09a8SJoe Perches WARN("MISSING_BREAK", 5412c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5413c34c09a8SJoe Perches } 5414c34c09a8SJoe Perches } 5415c34c09a8SJoe Perches 5416d1e2ad07SJoe Perches# check for switch/default statements without a break; 5417d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5418d1e2ad07SJoe Perches defined $stat && 5419d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5420d1e2ad07SJoe Perches my $ctx = ''; 5421d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5422d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5423d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5424d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5425d1e2ad07SJoe Perches } 5426d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5427d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5428caf2a54fSJoe Perches } 5429caf2a54fSJoe Perches 543013214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5431d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5432d5e616fcSJoe Perches if (WARN("USE_FUNC", 5433d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5434d5e616fcSJoe Perches $fix) { 5435194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5436d5e616fcSJoe Perches } 543713214adfSAndy Whitcroft } 5438773647a0SAndy Whitcroft 543962ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 544062ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 544162ec818fSJoe Perches ERROR("DATE_TIME", 544262ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 544362ec818fSJoe Perches } 544462ec818fSJoe Perches 54452c92488aSJoe Perches# check for use of yield() 54462c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 54472c92488aSJoe Perches WARN("YIELD", 54482c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 54492c92488aSJoe Perches } 54502c92488aSJoe Perches 5451179f8f40SJoe Perches# check for comparisons against true and false 5452179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5453179f8f40SJoe Perches my $lead = $1; 5454179f8f40SJoe Perches my $arg = $2; 5455179f8f40SJoe Perches my $test = $3; 5456179f8f40SJoe Perches my $otype = $4; 5457179f8f40SJoe Perches my $trail = $5; 5458179f8f40SJoe Perches my $op = "!"; 5459179f8f40SJoe Perches 5460179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5461179f8f40SJoe Perches 5462179f8f40SJoe Perches my $type = lc($otype); 5463179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5464179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5465179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5466179f8f40SJoe Perches $op = ""; 5467179f8f40SJoe Perches } 5468179f8f40SJoe Perches 5469179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5470179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5471179f8f40SJoe Perches 5472179f8f40SJoe Perches## maybe suggesting a correct construct would better 5473179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5474179f8f40SJoe Perches 5475179f8f40SJoe Perches } 5476179f8f40SJoe Perches } 5477179f8f40SJoe Perches 54784882720bSThomas Gleixner# check for semaphores initialized locked 54794882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5480000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5481000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5482773647a0SAndy Whitcroft } 54836712d858SJoe Perches 548467d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 548567d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5486000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 548767d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5488773647a0SAndy Whitcroft } 54896712d858SJoe Perches 5490ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5491f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5492000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5493ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5494f3db6639SMichael Ellerman } 54956712d858SJoe Perches 54960f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 54970f3c5aabSJoe Perches my $const_structs = qr{ 54980f3c5aabSJoe Perches acpi_dock_ops| 549979404849SEmese Revfy address_space_operations| 550079404849SEmese Revfy backlight_ops| 550179404849SEmese Revfy block_device_operations| 550279404849SEmese Revfy dentry_operations| 550379404849SEmese Revfy dev_pm_ops| 550479404849SEmese Revfy dma_map_ops| 550579404849SEmese Revfy extent_io_ops| 550679404849SEmese Revfy file_lock_operations| 550779404849SEmese Revfy file_operations| 550879404849SEmese Revfy hv_ops| 550979404849SEmese Revfy ide_dma_ops| 551079404849SEmese Revfy intel_dvo_dev_ops| 551179404849SEmese Revfy item_operations| 551279404849SEmese Revfy iwl_ops| 551379404849SEmese Revfy kgdb_arch| 551479404849SEmese Revfy kgdb_io| 551579404849SEmese Revfy kset_uevent_ops| 551679404849SEmese Revfy lock_manager_operations| 551779404849SEmese Revfy microcode_ops| 551879404849SEmese Revfy mtrr_ops| 551979404849SEmese Revfy neigh_ops| 552079404849SEmese Revfy nlmsvc_binding| 55210f3c5aabSJoe Perches of_device_id| 552279404849SEmese Revfy pci_raw_ops| 552379404849SEmese Revfy pipe_buf_operations| 552479404849SEmese Revfy platform_hibernation_ops| 552579404849SEmese Revfy platform_suspend_ops| 552679404849SEmese Revfy proto_ops| 552779404849SEmese Revfy rpc_pipe_ops| 552879404849SEmese Revfy seq_operations| 552979404849SEmese Revfy snd_ac97_build_ops| 553079404849SEmese Revfy soc_pcmcia_socket_ops| 553179404849SEmese Revfy stacktrace_ops| 553279404849SEmese Revfy sysfs_ops| 553379404849SEmese Revfy tty_operations| 55346d07d01bSJoe Perches uart_ops| 553579404849SEmese Revfy usb_mon_operations| 553679404849SEmese Revfy wd_ops}x; 55376903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 55380f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5539000d1cc1SJoe Perches WARN("CONST_STRUCT", 5540000d1cc1SJoe Perches "struct $1 should normally be const\n" . 55416903ffb2SAndy Whitcroft $herecurr); 55422b6db5cbSAndy Whitcroft } 5543773647a0SAndy Whitcroft 5544773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5545773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5546773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5547c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5548c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5549171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5550171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5551171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5552773647a0SAndy Whitcroft { 5553000d1cc1SJoe Perches WARN("NR_CPUS", 5554000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5555773647a0SAndy Whitcroft } 55569c9ba34eSAndy Whitcroft 555752ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 555852ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 555952ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 556052ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 556152ea8506SJoe Perches } 556252ea8506SJoe Perches 5563acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5564acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5565acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5566acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5567acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5568acd9362cSJoe Perches } 5569acd9362cSJoe Perches 5570691d77b6SAndy Whitcroft# whine mightly about in_atomic 5571691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5572691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5573000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5574000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5575f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5576000d1cc1SJoe Perches WARN("IN_ATOMIC", 5577000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5578691d77b6SAndy Whitcroft } 5579691d77b6SAndy Whitcroft } 55801704f47bSPeter Zijlstra 55811704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 55821704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 55831704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 55841704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 55851704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 55861704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5587000d1cc1SJoe Perches ERROR("LOCKDEP", 5588000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 55891704f47bSPeter Zijlstra } 55901704f47bSPeter Zijlstra } 559188f8831cSDave Jones 5592b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5593b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5594000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5595000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 559688f8831cSDave Jones } 55972435880fSJoe Perches 5598515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5599515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5600515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5601515a235eSJoe Perches $line =~ /$mode_perms_search/) { 56022435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 56032435880fSJoe Perches my $func = $entry->[0]; 56042435880fSJoe Perches my $arg_pos = $entry->[1]; 56052435880fSJoe Perches 56062435880fSJoe Perches my $skip_args = ""; 56072435880fSJoe Perches if ($arg_pos > 1) { 56082435880fSJoe Perches $arg_pos--; 56092435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 56102435880fSJoe Perches } 56112435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5612515a235eSJoe Perches if ($line =~ /$test/) { 56132435880fSJoe Perches my $val = $1; 56142435880fSJoe Perches $val = $6 if ($skip_args ne ""); 56152435880fSJoe Perches 56161727cc70SJoe Perches if ($val !~ /^0$/ && 56171727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 56181727cc70SJoe Perches length($val) ne 4)) { 56192435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 56201727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5621c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5622c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5623c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 56242435880fSJoe Perches } 56252435880fSJoe Perches } 56262435880fSJoe Perches } 562713214adfSAndy Whitcroft } 5628515a235eSJoe Perches } 562913214adfSAndy Whitcroft 563013214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 563113214adfSAndy Whitcroft # so just keep quiet. 563213214adfSAndy Whitcroft if ($#rawlines == -1) { 563313214adfSAndy Whitcroft exit(0); 56340a920b5bSAndy Whitcroft } 56350a920b5bSAndy Whitcroft 56368905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 56378905a67cSAndy Whitcroft # things that appear to be patches. 56388905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 56398905a67cSAndy Whitcroft exit(0); 56408905a67cSAndy Whitcroft } 56418905a67cSAndy Whitcroft 56428905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 56438905a67cSAndy Whitcroft # just keep quiet. 56448905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 56458905a67cSAndy Whitcroft exit(0); 56468905a67cSAndy Whitcroft } 56478905a67cSAndy Whitcroft 564806330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5649000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5650000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 56510a920b5bSAndy Whitcroft } 565234d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5653000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5654000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 56550a920b5bSAndy Whitcroft } 56560a920b5bSAndy Whitcroft 5657f0a594c1SAndy Whitcroft print report_dump(); 565813214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 565913214adfSAndy Whitcroft print "$filename " if ($summary_file); 56606c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 56616c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 56626c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 56636c72ffaaSAndy Whitcroft } 56648905a67cSAndy Whitcroft 5665d2c0a235SAndy Whitcroft if ($quiet == 0) { 5666d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5667d2c0a235SAndy Whitcroft # then suggest that. 5668d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5669b0781216SMike Frysinger $rpt_cleaners = 0; 5670d8469f16SJoe Perches print << "EOM" 5671d8469f16SJoe Perches 5672d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5673d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5674d8469f16SJoe PerchesEOM 5675d2c0a235SAndy Whitcroft } 5676d2c0a235SAndy Whitcroft } 5677d2c0a235SAndy Whitcroft 567891bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 567991bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5680000d1cc1SJoe Perches 5681d752fcc8SJoe Perches if ($clean == 0 && $fix && 5682d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5683d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 56849624b8d6SJoe Perches my $newfile = $filename; 56859624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 56863705ce5bSJoe Perches my $linecount = 0; 56873705ce5bSJoe Perches my $f; 56883705ce5bSJoe Perches 5689d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5690d752fcc8SJoe Perches 56913705ce5bSJoe Perches open($f, '>', $newfile) 56923705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 56933705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 56943705ce5bSJoe Perches $linecount++; 56953705ce5bSJoe Perches if ($file) { 56963705ce5bSJoe Perches if ($linecount > 3) { 56973705ce5bSJoe Perches $fixed_line =~ s/^\+//; 56983705ce5bSJoe Perches print $f $fixed_line . "\n"; 56993705ce5bSJoe Perches } 57003705ce5bSJoe Perches } else { 57013705ce5bSJoe Perches print $f $fixed_line . "\n"; 57023705ce5bSJoe Perches } 57033705ce5bSJoe Perches } 57043705ce5bSJoe Perches close($f); 57053705ce5bSJoe Perches 57063705ce5bSJoe Perches if (!$quiet) { 57073705ce5bSJoe Perches print << "EOM"; 5708d8469f16SJoe Perches 57093705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 57103705ce5bSJoe Perches 57113705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 57123705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 57133705ce5bSJoe Perches 57143705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 57153705ce5bSJoe PerchesNo warranties, expressed or implied... 57163705ce5bSJoe PerchesEOM 57173705ce5bSJoe Perches } 57183705ce5bSJoe Perches } 57193705ce5bSJoe Perches 5720d8469f16SJoe Perches if ($quiet == 0) { 5721d8469f16SJoe Perches print "\n"; 5722d8469f16SJoe Perches if ($clean == 1) { 5723d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5724d8469f16SJoe Perches } else { 5725d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 57260a920b5bSAndy Whitcroft } 57270a920b5bSAndy Whitcroft } 57280a920b5bSAndy Whitcroft return $clean; 57290a920b5bSAndy Whitcroft} 5730