10a920b5bSAndy Whitcroft#!/usr/bin/perl -w 2dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit) 300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit) 42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite) 5015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]> 60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2 70a920b5bSAndy Whitcroft 80a920b5bSAndy Whitcroftuse strict; 9c707a81dSJoe Perchesuse POSIX; 1036061e38SJoe Perchesuse File::Basename; 1136061e38SJoe Perchesuse Cwd 'abs_path'; 1257230297SJoe Perchesuse Term::ANSIColor qw(:constants); 130a920b5bSAndy Whitcroft 140a920b5bSAndy Whitcroftmy $P = $0; 1536061e38SJoe Perchesmy $D = dirname(abs_path($P)); 160a920b5bSAndy Whitcroft 17000d1cc1SJoe Perchesmy $V = '0.32'; 180a920b5bSAndy Whitcroft 190a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 200a920b5bSAndy Whitcroft 210a920b5bSAndy Whitcroftmy $quiet = 0; 220a920b5bSAndy Whitcroftmy $tree = 1; 230a920b5bSAndy Whitcroftmy $chk_signoff = 1; 240a920b5bSAndy Whitcroftmy $chk_patch = 1; 25773647a0SAndy Whitcroftmy $tst_only; 266c72ffaaSAndy Whitcroftmy $emacs = 0; 278905a67cSAndy Whitcroftmy $terse = 0; 2834d8815fSJoe Perchesmy $showfile = 0; 296c72ffaaSAndy Whitcroftmy $file = 0; 306c72ffaaSAndy Whitcroftmy $check = 0; 312ac73b4fSJoe Perchesmy $check_orig = 0; 328905a67cSAndy Whitcroftmy $summary = 1; 338905a67cSAndy Whitcroftmy $mailback = 0; 3413214adfSAndy Whitcroftmy $summary_file = 0; 35000d1cc1SJoe Perchesmy $show_types = 0; 363705ce5bSJoe Perchesmy $fix = 0; 379624b8d6SJoe Perchesmy $fix_inplace = 0; 386c72ffaaSAndy Whitcroftmy $root; 39c2fdda0dSAndy Whitcroftmy %debug; 403445686aSJoe Perchesmy %camelcase = (); 4191bfe484SJoe Perchesmy %use_type = (); 4291bfe484SJoe Perchesmy @use = (); 4391bfe484SJoe Perchesmy %ignore_type = (); 44000d1cc1SJoe Perchesmy @ignore = (); 4577f5b10aSHannes Edermy $help = 0; 46000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 476cd7f386SJoe Perchesmy $max_line_length = 80; 48d62a201fSDave Hansenmy $ignore_perl_version = 0; 49d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 5056193274SVadim Bendeburymy $min_conf_desc_length = 4; 5166b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 52ebfd7d62SJoe Perchesmy $codespell = 0; 53f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt"; 5457230297SJoe Perchesmy $color = 1; 5577f5b10aSHannes Eder 5677f5b10aSHannes Edersub help { 5777f5b10aSHannes Eder my ($exitcode) = @_; 5877f5b10aSHannes Eder 5977f5b10aSHannes Eder print << "EOM"; 6077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 6177f5b10aSHannes EderVersion: $V 6277f5b10aSHannes Eder 6377f5b10aSHannes EderOptions: 6477f5b10aSHannes Eder -q, --quiet quiet 6577f5b10aSHannes Eder --no-tree run without a kernel tree 6677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 6777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 6877f5b10aSHannes Eder --emacs emacs compile window format 6977f5b10aSHannes Eder --terse one line per report 7034d8815fSJoe Perches --showfile emit diffed file position, not input file position 7177f5b10aSHannes Eder -f, --file treat FILE as regular source file 7277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 7391bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 74000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 756cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 7656193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 77000d1cc1SJoe Perches --show-types show the message "types" in the output 7877f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 7977f5b10aSHannes Eder --no-summary suppress the per-file summary 8077f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 8177f5b10aSHannes Eder --summary-file include the filename in summary 8277f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 8377f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 8477f5b10aSHannes Eder is all off) 8577f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 8677f5b10aSHannes Eder literally 873705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 883705ce5bSJoe Perches If correctable single-line errors exist, create 893705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 903705ce5bSJoe Perches with potential errors corrected to the preferred 913705ce5bSJoe Perches checkpatch style 929624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 939624b8d6SJoe Perches Is the same as --fix, but overwrites the input 949624b8d6SJoe Perches file. It's your fault if there's no backup or git 95d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 96d62a201fSDave Hansen runtime errors. 97ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 98f1a63678SMaxim Uvarov (default:/usr/share/codespell/dictionary.txt) 99ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 10057230297SJoe Perches --color Use colors when output is STDOUT (default: on) 10177f5b10aSHannes Eder -h, --help, --version display this help and exit 10277f5b10aSHannes Eder 10377f5b10aSHannes EderWhen FILE is - read standard input. 10477f5b10aSHannes EderEOM 10577f5b10aSHannes Eder 10677f5b10aSHannes Eder exit($exitcode); 10777f5b10aSHannes Eder} 10877f5b10aSHannes Eder 109000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 110000d1cc1SJoe Perchesif (-f $conf) { 111000d1cc1SJoe Perches my @conf_args; 112000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 113000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 114000d1cc1SJoe Perches 115000d1cc1SJoe Perches while (<$conffile>) { 116000d1cc1SJoe Perches my $line = $_; 117000d1cc1SJoe Perches 118000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 119000d1cc1SJoe Perches $line =~ s/^\s*//g; 120000d1cc1SJoe Perches $line =~ s/\s+/ /g; 121000d1cc1SJoe Perches 122000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 123000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 124000d1cc1SJoe Perches 125000d1cc1SJoe Perches my @words = split(" ", $line); 126000d1cc1SJoe Perches foreach my $word (@words) { 127000d1cc1SJoe Perches last if ($word =~ m/^#/); 128000d1cc1SJoe Perches push (@conf_args, $word); 129000d1cc1SJoe Perches } 130000d1cc1SJoe Perches } 131000d1cc1SJoe Perches close($conffile); 132000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 133000d1cc1SJoe Perches} 134000d1cc1SJoe Perches 1350a920b5bSAndy WhitcroftGetOptions( 1366c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1370a920b5bSAndy Whitcroft 'tree!' => \$tree, 1380a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1390a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1406c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1418905a67cSAndy Whitcroft 'terse!' => \$terse, 14234d8815fSJoe Perches 'showfile!' => \$showfile, 14377f5b10aSHannes Eder 'f|file!' => \$file, 1446c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1456c72ffaaSAndy Whitcroft 'strict!' => \$check, 146000d1cc1SJoe Perches 'ignore=s' => \@ignore, 14791bfe484SJoe Perches 'types=s' => \@use, 148000d1cc1SJoe Perches 'show-types!' => \$show_types, 1496cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 15056193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1516c72ffaaSAndy Whitcroft 'root=s' => \$root, 1528905a67cSAndy Whitcroft 'summary!' => \$summary, 1538905a67cSAndy Whitcroft 'mailback!' => \$mailback, 15413214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1553705ce5bSJoe Perches 'fix!' => \$fix, 1569624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 157d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 158c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 159773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 160ebfd7d62SJoe Perches 'codespell!' => \$codespell, 161ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 16257230297SJoe Perches 'color!' => \$color, 16377f5b10aSHannes Eder 'h|help' => \$help, 16477f5b10aSHannes Eder 'version' => \$help 16577f5b10aSHannes Eder) or help(1); 16677f5b10aSHannes Eder 16777f5b10aSHannes Ederhelp(0) if ($help); 1680a920b5bSAndy Whitcroft 1699624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1702ac73b4fSJoe Perches$check_orig = $check; 1719624b8d6SJoe Perches 1720a920b5bSAndy Whitcroftmy $exit = 0; 1730a920b5bSAndy Whitcroft 174d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 175d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 176d62a201fSDave Hansen if (!$ignore_perl_version) { 177d62a201fSDave Hansen exit(1); 178d62a201fSDave Hansen } 179d62a201fSDave Hansen} 180d62a201fSDave Hansen 1810a920b5bSAndy Whitcroftif ($#ARGV < 0) { 18277f5b10aSHannes Eder print "$P: no input files\n"; 1830a920b5bSAndy Whitcroft exit(1); 1840a920b5bSAndy Whitcroft} 1850a920b5bSAndy Whitcroft 18691bfe484SJoe Perchessub hash_save_array_words { 18791bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 18891bfe484SJoe Perches 18991bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 19091bfe484SJoe Perches foreach my $word (@array) { 191000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 192000d1cc1SJoe Perches $word =~ s/^\s*//g; 193000d1cc1SJoe Perches $word =~ s/\s+/ /g; 194000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 195000d1cc1SJoe Perches 196000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 197000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 198000d1cc1SJoe Perches 19991bfe484SJoe Perches $hashRef->{$word}++; 200000d1cc1SJoe Perches } 20191bfe484SJoe Perches} 20291bfe484SJoe Perches 20391bfe484SJoe Perchessub hash_show_words { 20491bfe484SJoe Perches my ($hashRef, $prefix) = @_; 20591bfe484SJoe Perches 2063c816e49SJoe Perches if (keys %$hashRef) { 207d8469f16SJoe Perches print "\nNOTE: $prefix message types:"; 20858cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 20991bfe484SJoe Perches print " $word"; 21091bfe484SJoe Perches } 211d8469f16SJoe Perches print "\n"; 21291bfe484SJoe Perches } 21391bfe484SJoe Perches} 21491bfe484SJoe Perches 21591bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 21691bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 217000d1cc1SJoe Perches 218c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 219c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2207429c690SAndy Whitcroftmy $dbg_type = 0; 221a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 222c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 22321caa13cSAndy Whitcroft ## no critic 22421caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 22521caa13cSAndy Whitcroft die "$@" if ($@); 226c2fdda0dSAndy Whitcroft} 227c2fdda0dSAndy Whitcroft 228d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 229d2c0a235SAndy Whitcroft 2308905a67cSAndy Whitcroftif ($terse) { 2318905a67cSAndy Whitcroft $emacs = 1; 2328905a67cSAndy Whitcroft $quiet++; 2338905a67cSAndy Whitcroft} 2348905a67cSAndy Whitcroft 2356c72ffaaSAndy Whitcroftif ($tree) { 2366c72ffaaSAndy Whitcroft if (defined $root) { 2376c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2386c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2396c72ffaaSAndy Whitcroft } 2406c72ffaaSAndy Whitcroft } else { 2416c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2426c72ffaaSAndy Whitcroft $root = '.'; 2436c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2446c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2456c72ffaaSAndy Whitcroft $root = $1; 2466c72ffaaSAndy Whitcroft } 2476c72ffaaSAndy Whitcroft } 2486c72ffaaSAndy Whitcroft 2496c72ffaaSAndy Whitcroft if (!defined $root) { 2500a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2510a920b5bSAndy Whitcroft exit(2); 2520a920b5bSAndy Whitcroft } 2536c72ffaaSAndy Whitcroft} 2546c72ffaaSAndy Whitcroft 2556c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2566c72ffaaSAndy Whitcroft 2572ceb532bSAndy Whitcroftour $Ident = qr{ 2582ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2592ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2602ceb532bSAndy Whitcroft }x; 2616c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2626c72ffaaSAndy Whitcroftour $Sparse = qr{ 2636c72ffaaSAndy Whitcroft __user| 2646c72ffaaSAndy Whitcroft __kernel| 2656c72ffaaSAndy Whitcroft __force| 2666c72ffaaSAndy Whitcroft __iomem| 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: 5873e838b6cSJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\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) { 7733c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 7743c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 7753c816e49SJoe Perches 776d8469f16SJoe Perches if ($^V lt 5.10.0) { 777d8469f16SJoe Perches print << "EOM" 778d8469f16SJoe Perches 779d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues. 780d8469f16SJoe Perches An upgrade to at least perl v5.10.0 is suggested. 781d8469f16SJoe PerchesEOM 782d8469f16SJoe Perches } 783d8469f16SJoe Perches if ($exit) { 784d8469f16SJoe Perches print << "EOM" 785d8469f16SJoe Perches 786d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report 787d8469f16SJoe Perches them to the maintainer, see CHECKPATCH in MAINTAINERS. 788d8469f16SJoe PerchesEOM 789d8469f16SJoe Perches } 790d8469f16SJoe Perches} 791d8469f16SJoe Perches 7920a920b5bSAndy Whitcroftexit($exit); 7930a920b5bSAndy Whitcroft 7940a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7956c72ffaaSAndy Whitcroft my ($root) = @_; 7966c72ffaaSAndy Whitcroft 7976c72ffaaSAndy Whitcroft my @tree_check = ( 7986c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7996c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 8006c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 8016c72ffaaSAndy Whitcroft ); 8026c72ffaaSAndy Whitcroft 8036c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 8046c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 8050a920b5bSAndy Whitcroft return 0; 8060a920b5bSAndy Whitcroft } 8076c72ffaaSAndy Whitcroft } 8086c72ffaaSAndy Whitcroft return 1; 8096c72ffaaSAndy Whitcroft} 8100a920b5bSAndy Whitcroft 81120112475SJoe Perchessub parse_email { 81220112475SJoe Perches my ($formatted_email) = @_; 81320112475SJoe Perches 81420112475SJoe Perches my $name = ""; 81520112475SJoe Perches my $address = ""; 81620112475SJoe Perches my $comment = ""; 81720112475SJoe Perches 81820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 81920112475SJoe Perches $name = $1; 82020112475SJoe Perches $address = $2; 82120112475SJoe Perches $comment = $3 if defined $3; 82220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 82320112475SJoe Perches $address = $1; 82420112475SJoe Perches $comment = $2 if defined $2; 82520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 82620112475SJoe Perches $address = $1; 82720112475SJoe Perches $comment = $2 if defined $2; 82820112475SJoe Perches $formatted_email =~ s/$address.*$//; 82920112475SJoe Perches $name = $formatted_email; 8303705ce5bSJoe Perches $name = trim($name); 83120112475SJoe Perches $name =~ s/^\"|\"$//g; 83220112475SJoe Perches # If there's a name left after stripping spaces and 83320112475SJoe Perches # leading quotes, and the address doesn't have both 83420112475SJoe Perches # leading and trailing angle brackets, the address 83520112475SJoe Perches # is invalid. ie: 83620112475SJoe Perches # "joe smith [email protected]" bad 83720112475SJoe Perches # "joe smith <[email protected]" bad 83820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 83920112475SJoe Perches $name = ""; 84020112475SJoe Perches $address = ""; 84120112475SJoe Perches $comment = ""; 84220112475SJoe Perches } 84320112475SJoe Perches } 84420112475SJoe Perches 8453705ce5bSJoe Perches $name = trim($name); 84620112475SJoe Perches $name =~ s/^\"|\"$//g; 8473705ce5bSJoe Perches $address = trim($address); 84820112475SJoe Perches $address =~ s/^\<|\>$//g; 84920112475SJoe Perches 85020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 85120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 85220112475SJoe Perches $name = "\"$name\""; 85320112475SJoe Perches } 85420112475SJoe Perches 85520112475SJoe Perches return ($name, $address, $comment); 85620112475SJoe Perches} 85720112475SJoe Perches 85820112475SJoe Perchessub format_email { 85920112475SJoe Perches my ($name, $address) = @_; 86020112475SJoe Perches 86120112475SJoe Perches my $formatted_email; 86220112475SJoe Perches 8633705ce5bSJoe Perches $name = trim($name); 86420112475SJoe Perches $name =~ s/^\"|\"$//g; 8653705ce5bSJoe Perches $address = trim($address); 86620112475SJoe Perches 86720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 86820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 86920112475SJoe Perches $name = "\"$name\""; 87020112475SJoe Perches } 87120112475SJoe Perches 87220112475SJoe Perches if ("$name" eq "") { 87320112475SJoe Perches $formatted_email = "$address"; 87420112475SJoe Perches } else { 87520112475SJoe Perches $formatted_email = "$name <$address>"; 87620112475SJoe Perches } 87720112475SJoe Perches 87820112475SJoe Perches return $formatted_email; 87920112475SJoe Perches} 88020112475SJoe Perches 881d311cd44SJoe Perchessub which { 882d311cd44SJoe Perches my ($bin) = @_; 883d311cd44SJoe Perches 884d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 885d311cd44SJoe Perches if (-e "$path/$bin") { 886d311cd44SJoe Perches return "$path/$bin"; 887d311cd44SJoe Perches } 888d311cd44SJoe Perches } 889d311cd44SJoe Perches 890d311cd44SJoe Perches return ""; 891d311cd44SJoe Perches} 892d311cd44SJoe Perches 893000d1cc1SJoe Perchessub which_conf { 894000d1cc1SJoe Perches my ($conf) = @_; 895000d1cc1SJoe Perches 896000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 897000d1cc1SJoe Perches if (-e "$path/$conf") { 898000d1cc1SJoe Perches return "$path/$conf"; 899000d1cc1SJoe Perches } 900000d1cc1SJoe Perches } 901000d1cc1SJoe Perches 902000d1cc1SJoe Perches return ""; 903000d1cc1SJoe Perches} 904000d1cc1SJoe Perches 9050a920b5bSAndy Whitcroftsub expand_tabs { 9060a920b5bSAndy Whitcroft my ($str) = @_; 9070a920b5bSAndy Whitcroft 9080a920b5bSAndy Whitcroft my $res = ''; 9090a920b5bSAndy Whitcroft my $n = 0; 9100a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 9110a920b5bSAndy Whitcroft if ($c eq "\t") { 9120a920b5bSAndy Whitcroft $res .= ' '; 9130a920b5bSAndy Whitcroft $n++; 9140a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 9150a920b5bSAndy Whitcroft $res .= ' '; 9160a920b5bSAndy Whitcroft } 9170a920b5bSAndy Whitcroft next; 9180a920b5bSAndy Whitcroft } 9190a920b5bSAndy Whitcroft $res .= $c; 9200a920b5bSAndy Whitcroft $n++; 9210a920b5bSAndy Whitcroft } 9220a920b5bSAndy Whitcroft 9230a920b5bSAndy Whitcroft return $res; 9240a920b5bSAndy Whitcroft} 9256c72ffaaSAndy Whitcroftsub copy_spacing { 926773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 9276c72ffaaSAndy Whitcroft return $res; 9286c72ffaaSAndy Whitcroft} 9290a920b5bSAndy Whitcroft 9304a0df2efSAndy Whitcroftsub line_stats { 9314a0df2efSAndy Whitcroft my ($line) = @_; 9324a0df2efSAndy Whitcroft 9334a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 9344a0df2efSAndy Whitcroft $line =~ s/^.//; 9354a0df2efSAndy Whitcroft $line = expand_tabs($line); 9364a0df2efSAndy Whitcroft 9374a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 9384a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 9394a0df2efSAndy Whitcroft 9404a0df2efSAndy Whitcroft return (length($line), length($white)); 9414a0df2efSAndy Whitcroft} 9424a0df2efSAndy Whitcroft 943773647a0SAndy Whitcroftmy $sanitise_quote = ''; 944773647a0SAndy Whitcroft 945773647a0SAndy Whitcroftsub sanitise_line_reset { 946773647a0SAndy Whitcroft my ($in_comment) = @_; 947773647a0SAndy Whitcroft 948773647a0SAndy Whitcroft if ($in_comment) { 949773647a0SAndy Whitcroft $sanitise_quote = '*/'; 950773647a0SAndy Whitcroft } else { 951773647a0SAndy Whitcroft $sanitise_quote = ''; 952773647a0SAndy Whitcroft } 953773647a0SAndy Whitcroft} 95400df344fSAndy Whitcroftsub sanitise_line { 95500df344fSAndy Whitcroft my ($line) = @_; 95600df344fSAndy Whitcroft 95700df344fSAndy Whitcroft my $res = ''; 95800df344fSAndy Whitcroft my $l = ''; 95900df344fSAndy Whitcroft 960c2fdda0dSAndy Whitcroft my $qlen = 0; 961773647a0SAndy Whitcroft my $off = 0; 962773647a0SAndy Whitcroft my $c; 96300df344fSAndy Whitcroft 964773647a0SAndy Whitcroft # Always copy over the diff marker. 965773647a0SAndy Whitcroft $res = substr($line, 0, 1); 966773647a0SAndy Whitcroft 967773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 968773647a0SAndy Whitcroft $c = substr($line, $off, 1); 969773647a0SAndy Whitcroft 970773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 971773647a0SAndy Whitcroft # and end, all to $;. 972773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 973773647a0SAndy Whitcroft $sanitise_quote = '*/'; 974773647a0SAndy Whitcroft 975773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 976773647a0SAndy Whitcroft $off++; 97700df344fSAndy Whitcroft next; 978773647a0SAndy Whitcroft } 97981bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 980773647a0SAndy Whitcroft $sanitise_quote = ''; 981773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 982773647a0SAndy Whitcroft $off++; 983773647a0SAndy Whitcroft next; 984773647a0SAndy Whitcroft } 985113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 986113f04a8SDaniel Walker $sanitise_quote = '//'; 987113f04a8SDaniel Walker 988113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 989113f04a8SDaniel Walker $off++; 990113f04a8SDaniel Walker next; 991113f04a8SDaniel Walker } 992773647a0SAndy Whitcroft 993773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 994773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 995773647a0SAndy Whitcroft $c eq "\\") { 996773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 997773647a0SAndy Whitcroft $off++; 998773647a0SAndy Whitcroft next; 999773647a0SAndy Whitcroft } 1000773647a0SAndy Whitcroft # Regular quotes. 1001773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 1002773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 1003773647a0SAndy Whitcroft $sanitise_quote = $c; 1004773647a0SAndy Whitcroft 1005773647a0SAndy Whitcroft substr($res, $off, 1, $c); 1006773647a0SAndy Whitcroft next; 1007773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 1008773647a0SAndy Whitcroft $sanitise_quote = ''; 100900df344fSAndy Whitcroft } 101000df344fSAndy Whitcroft } 1011773647a0SAndy Whitcroft 1012fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 1013773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1014773647a0SAndy Whitcroft substr($res, $off, 1, $;); 1015113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1016113f04a8SDaniel Walker substr($res, $off, 1, $;); 1017773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1018773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 101900df344fSAndy Whitcroft } else { 1020773647a0SAndy Whitcroft substr($res, $off, 1, $c); 102100df344fSAndy Whitcroft } 1022c2fdda0dSAndy Whitcroft } 1023c2fdda0dSAndy Whitcroft 1024113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 1025113f04a8SDaniel Walker $sanitise_quote = ''; 1026113f04a8SDaniel Walker } 1027113f04a8SDaniel Walker 1028c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 1029c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1030c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1031c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 1032c2fdda0dSAndy Whitcroft 1033c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 1034c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1035c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 1036c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1037c2fdda0dSAndy Whitcroft } 1038c2fdda0dSAndy Whitcroft 103900df344fSAndy Whitcroft return $res; 104000df344fSAndy Whitcroft} 104100df344fSAndy Whitcroft 1042a6962d72SJoe Perchessub get_quoted_string { 1043a6962d72SJoe Perches my ($line, $rawline) = @_; 1044a6962d72SJoe Perches 104533acb54aSJoe Perches return "" if ($line !~ m/($String)/g); 1046a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 1047a6962d72SJoe Perches} 1048a6962d72SJoe Perches 10498905a67cSAndy Whitcroftsub ctx_statement_block { 10508905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 10518905a67cSAndy Whitcroft my $line = $linenr - 1; 10528905a67cSAndy Whitcroft my $blk = ''; 10538905a67cSAndy Whitcroft my $soff = $off; 10548905a67cSAndy Whitcroft my $coff = $off - 1; 1055773647a0SAndy Whitcroft my $coff_set = 0; 10568905a67cSAndy Whitcroft 105713214adfSAndy Whitcroft my $loff = 0; 105813214adfSAndy Whitcroft 10598905a67cSAndy Whitcroft my $type = ''; 10608905a67cSAndy Whitcroft my $level = 0; 1061a2750645SAndy Whitcroft my @stack = (); 1062cf655043SAndy Whitcroft my $p; 10638905a67cSAndy Whitcroft my $c; 10648905a67cSAndy Whitcroft my $len = 0; 106513214adfSAndy Whitcroft 106613214adfSAndy Whitcroft my $remainder; 10678905a67cSAndy Whitcroft while (1) { 1068a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1069a2750645SAndy Whitcroft 1070773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10718905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10728905a67cSAndy Whitcroft # context. 10738905a67cSAndy Whitcroft if ($off >= $len) { 10748905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1075dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1076c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10778905a67cSAndy Whitcroft $remain--; 107813214adfSAndy Whitcroft $loff = $len; 1079c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10808905a67cSAndy Whitcroft $len = length($blk); 10818905a67cSAndy Whitcroft $line++; 10828905a67cSAndy Whitcroft last; 10838905a67cSAndy Whitcroft } 10848905a67cSAndy Whitcroft # Bail if there is no further context. 10858905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 108613214adfSAndy Whitcroft if ($off >= $len) { 10878905a67cSAndy Whitcroft last; 10888905a67cSAndy Whitcroft } 1089f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1090f74bd194SAndy Whitcroft $level++; 1091f74bd194SAndy Whitcroft $type = '#'; 1092f74bd194SAndy Whitcroft } 10938905a67cSAndy Whitcroft } 1094cf655043SAndy Whitcroft $p = $c; 10958905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 109613214adfSAndy Whitcroft $remainder = substr($blk, $off); 10978905a67cSAndy Whitcroft 1098773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10994635f4fbSAndy Whitcroft 11004635f4fbSAndy Whitcroft # Handle nested #if/#else. 11014635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 11024635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 11034635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 11044635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 11054635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 11064635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 11074635f4fbSAndy Whitcroft } 11084635f4fbSAndy Whitcroft 11098905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 11108905a67cSAndy Whitcroft # outermost level. 11118905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 11128905a67cSAndy Whitcroft last; 11138905a67cSAndy Whitcroft } 11148905a67cSAndy Whitcroft 111513214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1116773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1117773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1118773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1119773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1120773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1121773647a0SAndy Whitcroft $coff_set = 1; 1122773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1123773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 112413214adfSAndy Whitcroft } 112513214adfSAndy Whitcroft 11268905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 11278905a67cSAndy Whitcroft $level++; 11288905a67cSAndy Whitcroft $type = '('; 11298905a67cSAndy Whitcroft } 11308905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 11318905a67cSAndy Whitcroft $level--; 11328905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 11338905a67cSAndy Whitcroft 11348905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 11358905a67cSAndy Whitcroft $coff = $off; 1136773647a0SAndy Whitcroft $coff_set = 1; 1137773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 11388905a67cSAndy Whitcroft } 11398905a67cSAndy Whitcroft } 11408905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 11418905a67cSAndy Whitcroft $level++; 11428905a67cSAndy Whitcroft $type = '{'; 11438905a67cSAndy Whitcroft } 11448905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 11458905a67cSAndy Whitcroft $level--; 11468905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 11478905a67cSAndy Whitcroft 11488905a67cSAndy Whitcroft if ($level == 0) { 1149b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1150b998e001SPatrick Pannuto $off++; 1151b998e001SPatrick Pannuto } 11528905a67cSAndy Whitcroft last; 11538905a67cSAndy Whitcroft } 11548905a67cSAndy Whitcroft } 1155f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1156f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1157f74bd194SAndy Whitcroft $level--; 1158f74bd194SAndy Whitcroft $type = ''; 1159f74bd194SAndy Whitcroft $off++; 1160f74bd194SAndy Whitcroft last; 1161f74bd194SAndy Whitcroft } 11628905a67cSAndy Whitcroft $off++; 11638905a67cSAndy Whitcroft } 1164a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 116513214adfSAndy Whitcroft if ($off == $len) { 1166a3bb97a7SAndy Whitcroft $loff = $len + 1; 116713214adfSAndy Whitcroft $line++; 116813214adfSAndy Whitcroft $remain--; 116913214adfSAndy Whitcroft } 11708905a67cSAndy Whitcroft 11718905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11728905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11738905a67cSAndy Whitcroft 11748905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11758905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11768905a67cSAndy Whitcroft 1177773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 117813214adfSAndy Whitcroft 117913214adfSAndy Whitcroft return ($statement, $condition, 118013214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 118113214adfSAndy Whitcroft} 118213214adfSAndy Whitcroft 1183cf655043SAndy Whitcroftsub statement_lines { 1184cf655043SAndy Whitcroft my ($stmt) = @_; 1185cf655043SAndy Whitcroft 1186cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1187cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1188cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1189cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1190cf655043SAndy Whitcroft 1191cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1192cf655043SAndy Whitcroft 1193cf655043SAndy Whitcroft return $#stmt_lines + 2; 1194cf655043SAndy Whitcroft} 1195cf655043SAndy Whitcroft 1196cf655043SAndy Whitcroftsub statement_rawlines { 1197cf655043SAndy Whitcroft my ($stmt) = @_; 1198cf655043SAndy Whitcroft 1199cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1200cf655043SAndy Whitcroft 1201cf655043SAndy Whitcroft return $#stmt_lines + 2; 1202cf655043SAndy Whitcroft} 1203cf655043SAndy Whitcroft 1204cf655043SAndy Whitcroftsub statement_block_size { 1205cf655043SAndy Whitcroft my ($stmt) = @_; 1206cf655043SAndy Whitcroft 1207cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1208cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1209cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1210cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1211cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1212cf655043SAndy Whitcroft 1213cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1214cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1215cf655043SAndy Whitcroft 1216cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1217cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1218cf655043SAndy Whitcroft 1219cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1220cf655043SAndy Whitcroft return $stmt_lines; 1221cf655043SAndy Whitcroft } else { 1222cf655043SAndy Whitcroft return $stmt_statements; 1223cf655043SAndy Whitcroft } 1224cf655043SAndy Whitcroft} 1225cf655043SAndy Whitcroft 122613214adfSAndy Whitcroftsub ctx_statement_full { 122713214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 122813214adfSAndy Whitcroft my ($statement, $condition, $level); 122913214adfSAndy Whitcroft 123013214adfSAndy Whitcroft my (@chunks); 123113214adfSAndy Whitcroft 1232cf655043SAndy Whitcroft # Grab the first conditional/block pair. 123313214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 123413214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1235773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 123613214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1237cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1238cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1239cf655043SAndy Whitcroft } 1240cf655043SAndy Whitcroft 1241cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1242cf655043SAndy Whitcroft # could continue the statement. 1243cf655043SAndy Whitcroft for (;;) { 124413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 124513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1246cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1247773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1248cf655043SAndy Whitcroft #print "C: push\n"; 1249cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 125013214adfSAndy Whitcroft } 125113214adfSAndy Whitcroft 125213214adfSAndy Whitcroft return ($level, $linenr, @chunks); 12538905a67cSAndy Whitcroft} 12548905a67cSAndy Whitcroft 12554a0df2efSAndy Whitcroftsub ctx_block_get { 1256f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12574a0df2efSAndy Whitcroft my $line; 12584a0df2efSAndy Whitcroft my $start = $linenr - 1; 12594a0df2efSAndy Whitcroft my $blk = ''; 12604a0df2efSAndy Whitcroft my @o; 12614a0df2efSAndy Whitcroft my @c; 12624a0df2efSAndy Whitcroft my @res = (); 12634a0df2efSAndy Whitcroft 1264f0a594c1SAndy Whitcroft my $level = 0; 12654635f4fbSAndy Whitcroft my @stack = ($level); 126600df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 126700df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 126800df344fSAndy Whitcroft $remain--; 126900df344fSAndy Whitcroft 127000df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12714635f4fbSAndy Whitcroft 12724635f4fbSAndy Whitcroft # Handle nested #if/#else. 127301464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12744635f4fbSAndy Whitcroft push(@stack, $level); 127501464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12764635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 127701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12784635f4fbSAndy Whitcroft $level = pop(@stack); 12794635f4fbSAndy Whitcroft } 12804635f4fbSAndy Whitcroft 128101464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1282f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1283f0a594c1SAndy Whitcroft if ($off > 0) { 1284f0a594c1SAndy Whitcroft $off--; 1285f0a594c1SAndy Whitcroft next; 1286f0a594c1SAndy Whitcroft } 12874a0df2efSAndy Whitcroft 1288f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1289f0a594c1SAndy Whitcroft $level--; 1290f0a594c1SAndy Whitcroft last if ($level == 0); 1291f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1292f0a594c1SAndy Whitcroft $level++; 1293f0a594c1SAndy Whitcroft } 1294f0a594c1SAndy Whitcroft } 12954a0df2efSAndy Whitcroft 1296f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 129700df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12984a0df2efSAndy Whitcroft } 12994a0df2efSAndy Whitcroft 1300f0a594c1SAndy Whitcroft last if ($level == 0); 13014a0df2efSAndy Whitcroft } 13024a0df2efSAndy Whitcroft 1303f0a594c1SAndy Whitcroft return ($level, @res); 13044a0df2efSAndy Whitcroft} 13054a0df2efSAndy Whitcroftsub ctx_block_outer { 13064a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13074a0df2efSAndy Whitcroft 1308f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1309f0a594c1SAndy Whitcroft return @r; 13104a0df2efSAndy Whitcroft} 13114a0df2efSAndy Whitcroftsub ctx_block { 13124a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 13134a0df2efSAndy Whitcroft 1314f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1315f0a594c1SAndy Whitcroft return @r; 1316653d4876SAndy Whitcroft} 1317653d4876SAndy Whitcroftsub ctx_statement { 1318f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1319f0a594c1SAndy Whitcroft 1320f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1321f0a594c1SAndy Whitcroft return @r; 1322f0a594c1SAndy Whitcroft} 1323f0a594c1SAndy Whitcroftsub ctx_block_level { 1324653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1325653d4876SAndy Whitcroft 1326f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 13274a0df2efSAndy Whitcroft} 13289c0ca6f9SAndy Whitcroftsub ctx_statement_level { 13299c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 13309c0ca6f9SAndy Whitcroft 13319c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 13329c0ca6f9SAndy Whitcroft} 13334a0df2efSAndy Whitcroft 13344a0df2efSAndy Whitcroftsub ctx_locate_comment { 13354a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13364a0df2efSAndy Whitcroft 13374a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1338beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 13394a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 13404a0df2efSAndy Whitcroft 13414a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 13424a0df2efSAndy Whitcroft # comment. 13434a0df2efSAndy Whitcroft my $in_comment = 0; 13444a0df2efSAndy Whitcroft $current_comment = ''; 13454a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 134600df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 134700df344fSAndy Whitcroft #warn " $line\n"; 13484a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 13494a0df2efSAndy Whitcroft $in_comment = 1; 13504a0df2efSAndy Whitcroft } 13514a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 13524a0df2efSAndy Whitcroft $in_comment = 1; 13534a0df2efSAndy Whitcroft } 13544a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13554a0df2efSAndy Whitcroft $current_comment = ''; 13564a0df2efSAndy Whitcroft } 13574a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13584a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13594a0df2efSAndy Whitcroft $in_comment = 0; 13604a0df2efSAndy Whitcroft } 13614a0df2efSAndy Whitcroft } 13624a0df2efSAndy Whitcroft 13634a0df2efSAndy Whitcroft chomp($current_comment); 13644a0df2efSAndy Whitcroft return($current_comment); 13654a0df2efSAndy Whitcroft} 13664a0df2efSAndy Whitcroftsub ctx_has_comment { 13674a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13684a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13694a0df2efSAndy Whitcroft 137000df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13714a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13724a0df2efSAndy Whitcroft 13734a0df2efSAndy Whitcroft return ($cmt ne ''); 13744a0df2efSAndy Whitcroft} 13754a0df2efSAndy Whitcroft 13764d001e4dSAndy Whitcroftsub raw_line { 13774d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13784d001e4dSAndy Whitcroft 13794d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13804d001e4dSAndy Whitcroft $cnt++; 13814d001e4dSAndy Whitcroft 13824d001e4dSAndy Whitcroft my $line; 13834d001e4dSAndy Whitcroft while ($cnt) { 13844d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13854d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13864d001e4dSAndy Whitcroft $cnt--; 13874d001e4dSAndy Whitcroft } 13884d001e4dSAndy Whitcroft 13894d001e4dSAndy Whitcroft return $line; 13904d001e4dSAndy Whitcroft} 13914d001e4dSAndy Whitcroft 13920a920b5bSAndy Whitcroftsub cat_vet { 13930a920b5bSAndy Whitcroft my ($vet) = @_; 13949c0ca6f9SAndy Whitcroft my ($res, $coded); 13950a920b5bSAndy Whitcroft 13969c0ca6f9SAndy Whitcroft $res = ''; 13976c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13986c72ffaaSAndy Whitcroft $res .= $1; 13996c72ffaaSAndy Whitcroft if ($2 ne '') { 14009c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 14016c72ffaaSAndy Whitcroft $res .= $coded; 14026c72ffaaSAndy Whitcroft } 14039c0ca6f9SAndy Whitcroft } 14049c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 14050a920b5bSAndy Whitcroft 14069c0ca6f9SAndy Whitcroft return $res; 14070a920b5bSAndy Whitcroft} 14080a920b5bSAndy Whitcroft 1409c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1410cf655043SAndy Whitcroftmy $av_pending; 1411c2fdda0dSAndy Whitcroftmy @av_paren_type; 14121f65f947SAndy Whitcroftmy $av_pend_colon; 1413c2fdda0dSAndy Whitcroft 1414c2fdda0dSAndy Whitcroftsub annotate_reset { 1415c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1416cf655043SAndy Whitcroft $av_pending = '_'; 1417cf655043SAndy Whitcroft @av_paren_type = ('E'); 14181f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1419c2fdda0dSAndy Whitcroft} 1420c2fdda0dSAndy Whitcroft 14216c72ffaaSAndy Whitcroftsub annotate_values { 14226c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 14236c72ffaaSAndy Whitcroft 14246c72ffaaSAndy Whitcroft my $res; 14251f65f947SAndy Whitcroft my $var = '_' x length($stream); 14266c72ffaaSAndy Whitcroft my $cur = $stream; 14276c72ffaaSAndy Whitcroft 1428c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 14296c72ffaaSAndy Whitcroft 14306c72ffaaSAndy Whitcroft while (length($cur)) { 1431773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1432cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1433171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 14346c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1435c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1436c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1437cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1438c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 14396c72ffaaSAndy Whitcroft } 14406c72ffaaSAndy Whitcroft 1441c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 14429446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 14439446ef56SAndy Whitcroft push(@av_paren_type, $type); 1444addcdceaSAndy Whitcroft $type = 'c'; 14459446ef56SAndy Whitcroft 1446e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1447c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 14486c72ffaaSAndy Whitcroft $type = 'T'; 14496c72ffaaSAndy Whitcroft 1450389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1451389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1452389a2fe5SAndy Whitcroft $type = 'T'; 1453389a2fe5SAndy Whitcroft 1454c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1455171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1456c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1457171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1458171ae1a4SAndy Whitcroft if ($2 ne '') { 1459cf655043SAndy Whitcroft $av_pending = 'N'; 1460171ae1a4SAndy Whitcroft } 1461171ae1a4SAndy Whitcroft $type = 'E'; 1462171ae1a4SAndy Whitcroft 1463c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1464171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1465171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1466171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14676c72ffaaSAndy Whitcroft 1468c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1469cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1470c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1471cf655043SAndy Whitcroft 1472cf655043SAndy Whitcroft push(@av_paren_type, $type); 1473cf655043SAndy Whitcroft push(@av_paren_type, $type); 1474171ae1a4SAndy Whitcroft $type = 'E'; 1475cf655043SAndy Whitcroft 1476c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1477cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1478cf655043SAndy Whitcroft $av_preprocessor = 1; 1479cf655043SAndy Whitcroft 1480cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1481cf655043SAndy Whitcroft 1482171ae1a4SAndy Whitcroft $type = 'E'; 1483cf655043SAndy Whitcroft 1484c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1485cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1486cf655043SAndy Whitcroft 1487cf655043SAndy Whitcroft $av_preprocessor = 1; 1488cf655043SAndy Whitcroft 1489cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1490cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1491cf655043SAndy Whitcroft pop(@av_paren_type); 1492cf655043SAndy Whitcroft push(@av_paren_type, $type); 1493171ae1a4SAndy Whitcroft $type = 'E'; 14946c72ffaaSAndy Whitcroft 14956c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1496c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14976c72ffaaSAndy Whitcroft 1498171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1499171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1500171ae1a4SAndy Whitcroft $av_pending = $type; 1501171ae1a4SAndy Whitcroft $type = 'N'; 1502171ae1a4SAndy Whitcroft 15036c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1504c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 15056c72ffaaSAndy Whitcroft if (defined $2) { 1506cf655043SAndy Whitcroft $av_pending = 'V'; 15076c72ffaaSAndy Whitcroft } 15086c72ffaaSAndy Whitcroft $type = 'N'; 15096c72ffaaSAndy Whitcroft 151014b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1511c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 151214b111c1SAndy Whitcroft $av_pending = 'E'; 15136c72ffaaSAndy Whitcroft $type = 'N'; 15146c72ffaaSAndy Whitcroft 15151f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 15161f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 15171f65f947SAndy Whitcroft $av_pend_colon = 'C'; 15181f65f947SAndy Whitcroft $type = 'N'; 15191f65f947SAndy Whitcroft 152014b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1521c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 15226c72ffaaSAndy Whitcroft $type = 'N'; 15236c72ffaaSAndy Whitcroft 15246c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1525c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1526cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1527cf655043SAndy Whitcroft $av_pending = '_'; 15286c72ffaaSAndy Whitcroft $type = 'N'; 15296c72ffaaSAndy Whitcroft 15306c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1531cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1532cf655043SAndy Whitcroft if ($new_type ne '_') { 1533cf655043SAndy Whitcroft $type = $new_type; 1534c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1535c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 15366c72ffaaSAndy Whitcroft } else { 1537c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 15386c72ffaaSAndy Whitcroft } 15396c72ffaaSAndy Whitcroft 1540c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1541c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1542c8cb2ca3SAndy Whitcroft $type = 'V'; 1543cf655043SAndy Whitcroft $av_pending = 'V'; 15446c72ffaaSAndy Whitcroft 15458e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 15468e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 15471f65f947SAndy Whitcroft $av_pend_colon = 'B'; 15488e761b04SAndy Whitcroft } elsif ($type eq 'E') { 15498e761b04SAndy Whitcroft $av_pend_colon = 'L'; 15501f65f947SAndy Whitcroft } 15511f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 15521f65f947SAndy Whitcroft $type = 'V'; 15531f65f947SAndy Whitcroft 15546c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1555c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15566c72ffaaSAndy Whitcroft $type = 'V'; 15576c72ffaaSAndy Whitcroft 15586c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1559c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15606c72ffaaSAndy Whitcroft $type = 'N'; 15616c72ffaaSAndy Whitcroft 1562cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1563c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 156413214adfSAndy Whitcroft $type = 'E'; 15651f65f947SAndy Whitcroft $av_pend_colon = 'O'; 156613214adfSAndy Whitcroft 15678e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15688e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15698e761b04SAndy Whitcroft $type = 'C'; 15708e761b04SAndy Whitcroft 15711f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15721f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15731f65f947SAndy Whitcroft $type = 'N'; 15741f65f947SAndy Whitcroft 15751f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15761f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15771f65f947SAndy Whitcroft 15781f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15791f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15801f65f947SAndy Whitcroft $type = 'E'; 15811f65f947SAndy Whitcroft } else { 15821f65f947SAndy Whitcroft $type = 'N'; 15831f65f947SAndy Whitcroft } 15841f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15851f65f947SAndy Whitcroft 15868e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 158713214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15886c72ffaaSAndy Whitcroft $type = 'N'; 15896c72ffaaSAndy Whitcroft 15900d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 159174048ed8SAndy Whitcroft my $variant; 159274048ed8SAndy Whitcroft 159374048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 159474048ed8SAndy Whitcroft if ($type eq 'V') { 159574048ed8SAndy Whitcroft $variant = 'B'; 159674048ed8SAndy Whitcroft } else { 159774048ed8SAndy Whitcroft $variant = 'U'; 159874048ed8SAndy Whitcroft } 159974048ed8SAndy Whitcroft 160074048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 160174048ed8SAndy Whitcroft $type = 'N'; 160274048ed8SAndy Whitcroft 16036c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1604c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 16056c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 16066c72ffaaSAndy Whitcroft $type = 'N'; 16076c72ffaaSAndy Whitcroft } 16086c72ffaaSAndy Whitcroft 16096c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1610c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 16116c72ffaaSAndy Whitcroft } 16126c72ffaaSAndy Whitcroft if (defined $1) { 16136c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 16146c72ffaaSAndy Whitcroft $res .= $type x length($1); 16156c72ffaaSAndy Whitcroft } 16166c72ffaaSAndy Whitcroft } 16176c72ffaaSAndy Whitcroft 16181f65f947SAndy Whitcroft return ($res, $var); 16196c72ffaaSAndy Whitcroft} 16206c72ffaaSAndy Whitcroft 16218905a67cSAndy Whitcroftsub possible { 162213214adfSAndy Whitcroft my ($possible, $line) = @_; 16239a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 16240776e594SAndy Whitcroft ^(?: 16250776e594SAndy Whitcroft $Modifier| 16260776e594SAndy Whitcroft $Storage| 16270776e594SAndy Whitcroft $Type| 16289a974fdbSAndy Whitcroft DEFINE_\S+ 16299a974fdbSAndy Whitcroft )$| 16309a974fdbSAndy Whitcroft ^(?: 16310776e594SAndy Whitcroft goto| 16320776e594SAndy Whitcroft return| 16330776e594SAndy Whitcroft case| 16340776e594SAndy Whitcroft else| 16350776e594SAndy Whitcroft asm|__asm__| 163689a88353SAndy Whitcroft do| 163789a88353SAndy Whitcroft \#| 163889a88353SAndy Whitcroft \#\#| 16399a974fdbSAndy Whitcroft )(?:\s|$)| 16400776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 16419a974fdbSAndy Whitcroft )}x; 16429a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 16439a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1644c45dcabdSAndy Whitcroft # Check for modifiers. 1645c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1646c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1647c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1648c45dcabdSAndy Whitcroft 1649c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1650c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1651d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 16529a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1653d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1654485ff23eSAlex Dowad push(@modifierListFile, $modifier); 1655d2506586SAndy Whitcroft } 16569a974fdbSAndy Whitcroft } 1657c45dcabdSAndy Whitcroft 1658c45dcabdSAndy Whitcroft } else { 165913214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1660485ff23eSAlex Dowad push(@typeListFile, $possible); 1661c45dcabdSAndy Whitcroft } 16628905a67cSAndy Whitcroft build_types(); 16630776e594SAndy Whitcroft } else { 16640776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16658905a67cSAndy Whitcroft } 16668905a67cSAndy Whitcroft} 16678905a67cSAndy Whitcroft 16686c72ffaaSAndy Whitcroftmy $prefix = ''; 16696c72ffaaSAndy Whitcroft 1670000d1cc1SJoe Perchessub show_type { 1671cbec18afSJoe Perches my ($type) = @_; 167291bfe484SJoe Perches 1673cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1674cbec18afSJoe Perches 1675cbec18afSJoe Perches return !defined $ignore_type{$type}; 1676000d1cc1SJoe Perches} 1677000d1cc1SJoe Perches 1678f0a594c1SAndy Whitcroftsub report { 1679cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1680cbec18afSJoe Perches 1681cbec18afSJoe Perches if (!show_type($type) || 1682cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1683773647a0SAndy Whitcroft return 0; 1684773647a0SAndy Whitcroft } 168557230297SJoe Perches my $output = ''; 168657230297SJoe Perches if (-t STDOUT && $color) { 168757230297SJoe Perches if ($level eq 'ERROR') { 168857230297SJoe Perches $output .= RED; 168957230297SJoe Perches } elsif ($level eq 'WARNING') { 169057230297SJoe Perches $output .= YELLOW; 1691000d1cc1SJoe Perches } else { 169257230297SJoe Perches $output .= GREEN; 1693000d1cc1SJoe Perches } 169457230297SJoe Perches } 169557230297SJoe Perches $output .= $prefix . $level . ':'; 169657230297SJoe Perches if ($show_types) { 169757230297SJoe Perches $output .= BLUE if (-t STDOUT && $color); 169857230297SJoe Perches $output .= "$type:"; 169957230297SJoe Perches } 170057230297SJoe Perches $output .= RESET if (-t STDOUT && $color); 170157230297SJoe Perches $output .= ' ' . $msg . "\n"; 170234d8815fSJoe Perches 170334d8815fSJoe Perches if ($showfile) { 170434d8815fSJoe Perches my @lines = split("\n", $output, -1); 170534d8815fSJoe Perches splice(@lines, 1, 1); 170634d8815fSJoe Perches $output = join("\n", @lines); 170734d8815fSJoe Perches } 170857230297SJoe Perches $output = (split('\n', $output))[0] . "\n" if ($terse); 17098905a67cSAndy Whitcroft 171057230297SJoe Perches push(our @report, $output); 1711773647a0SAndy Whitcroft 1712773647a0SAndy Whitcroft return 1; 1713f0a594c1SAndy Whitcroft} 1714cbec18afSJoe Perches 1715f0a594c1SAndy Whitcroftsub report_dump { 171613214adfSAndy Whitcroft our @report; 1717f0a594c1SAndy Whitcroft} 1718000d1cc1SJoe Perches 1719d752fcc8SJoe Perchessub fixup_current_range { 1720d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1721d752fcc8SJoe Perches 1722d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1723d752fcc8SJoe Perches my $o = $1; 1724d752fcc8SJoe Perches my $l = $2; 1725d752fcc8SJoe Perches my $no = $o + $offset; 1726d752fcc8SJoe Perches my $nl = $l + $length; 1727d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1728d752fcc8SJoe Perches } 1729d752fcc8SJoe Perches} 1730d752fcc8SJoe Perches 1731d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1732d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1733d752fcc8SJoe Perches 1734d752fcc8SJoe Perches my $range_last_linenr = 0; 1735d752fcc8SJoe Perches my $delta_offset = 0; 1736d752fcc8SJoe Perches 1737d752fcc8SJoe Perches my $old_linenr = 0; 1738d752fcc8SJoe Perches my $new_linenr = 0; 1739d752fcc8SJoe Perches 1740d752fcc8SJoe Perches my $next_insert = 0; 1741d752fcc8SJoe Perches my $next_delete = 0; 1742d752fcc8SJoe Perches 1743d752fcc8SJoe Perches my @lines = (); 1744d752fcc8SJoe Perches 1745d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1746d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1747d752fcc8SJoe Perches 1748d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1749d752fcc8SJoe Perches my $save_line = 1; 1750d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1751323b267fSJoe Perches if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 1752d752fcc8SJoe Perches $delta_offset = 0; 1753d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1754d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1755d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1756d752fcc8SJoe Perches } 1757d752fcc8SJoe Perches 1758d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1759d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1760d752fcc8SJoe Perches $save_line = 0; 1761d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1762d752fcc8SJoe Perches } 1763d752fcc8SJoe Perches 1764d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1765d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1766d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1767d752fcc8SJoe Perches $new_linenr++; 1768d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1769d752fcc8SJoe Perches } 1770d752fcc8SJoe Perches 1771d752fcc8SJoe Perches if ($save_line) { 1772d752fcc8SJoe Perches push(@lines, $line); 1773d752fcc8SJoe Perches $new_linenr++; 1774d752fcc8SJoe Perches } 1775d752fcc8SJoe Perches 1776d752fcc8SJoe Perches $old_linenr++; 1777d752fcc8SJoe Perches } 1778d752fcc8SJoe Perches 1779d752fcc8SJoe Perches return @lines; 1780d752fcc8SJoe Perches} 1781d752fcc8SJoe Perches 1782f2d7e4d4SJoe Perchessub fix_insert_line { 1783f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1784f2d7e4d4SJoe Perches 1785f2d7e4d4SJoe Perches my $inserted = { 1786f2d7e4d4SJoe Perches LINENR => $linenr, 1787f2d7e4d4SJoe Perches LINE => $line, 1788f2d7e4d4SJoe Perches }; 1789f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1790f2d7e4d4SJoe Perches} 1791f2d7e4d4SJoe Perches 1792f2d7e4d4SJoe Perchessub fix_delete_line { 1793f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1794f2d7e4d4SJoe Perches 1795f2d7e4d4SJoe Perches my $deleted = { 1796f2d7e4d4SJoe Perches LINENR => $linenr, 1797f2d7e4d4SJoe Perches LINE => $line, 1798f2d7e4d4SJoe Perches }; 1799f2d7e4d4SJoe Perches 1800f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1801f2d7e4d4SJoe Perches} 1802f2d7e4d4SJoe Perches 1803de7d4f0eSAndy Whitcroftsub ERROR { 1804cbec18afSJoe Perches my ($type, $msg) = @_; 1805cbec18afSJoe Perches 1806cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1807de7d4f0eSAndy Whitcroft our $clean = 0; 18086c72ffaaSAndy Whitcroft our $cnt_error++; 18093705ce5bSJoe Perches return 1; 1810de7d4f0eSAndy Whitcroft } 18113705ce5bSJoe Perches return 0; 1812773647a0SAndy Whitcroft} 1813de7d4f0eSAndy Whitcroftsub WARN { 1814cbec18afSJoe Perches my ($type, $msg) = @_; 1815cbec18afSJoe Perches 1816cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1817de7d4f0eSAndy Whitcroft our $clean = 0; 18186c72ffaaSAndy Whitcroft our $cnt_warn++; 18193705ce5bSJoe Perches return 1; 1820de7d4f0eSAndy Whitcroft } 18213705ce5bSJoe Perches return 0; 1822773647a0SAndy Whitcroft} 1823de7d4f0eSAndy Whitcroftsub CHK { 1824cbec18afSJoe Perches my ($type, $msg) = @_; 1825cbec18afSJoe Perches 1826cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1827de7d4f0eSAndy Whitcroft our $clean = 0; 18286c72ffaaSAndy Whitcroft our $cnt_chk++; 18293705ce5bSJoe Perches return 1; 18306c72ffaaSAndy Whitcroft } 18313705ce5bSJoe Perches return 0; 1832de7d4f0eSAndy Whitcroft} 1833de7d4f0eSAndy Whitcroft 18346ecd9674SAndy Whitcroftsub check_absolute_file { 18356ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 18366ecd9674SAndy Whitcroft my $file = $absolute; 18376ecd9674SAndy Whitcroft 18386ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 18396ecd9674SAndy Whitcroft 18406ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 18416ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 18426ecd9674SAndy Whitcroft if (-f "$root/$file") { 18436ecd9674SAndy Whitcroft ##print "file<$file>\n"; 18446ecd9674SAndy Whitcroft last; 18456ecd9674SAndy Whitcroft } 18466ecd9674SAndy Whitcroft } 18476ecd9674SAndy Whitcroft if (! -f _) { 18486ecd9674SAndy Whitcroft return 0; 18496ecd9674SAndy Whitcroft } 18506ecd9674SAndy Whitcroft 18516ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 18526ecd9674SAndy Whitcroft my $prefix = $absolute; 18536ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 18546ecd9674SAndy Whitcroft 18556ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 18566ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1857000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1858000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 18596ecd9674SAndy Whitcroft } 18606ecd9674SAndy Whitcroft} 18616ecd9674SAndy Whitcroft 18623705ce5bSJoe Perchessub trim { 18633705ce5bSJoe Perches my ($string) = @_; 18643705ce5bSJoe Perches 1865b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1866b34c648bSJoe Perches 1867b34c648bSJoe Perches return $string; 1868b34c648bSJoe Perches} 1869b34c648bSJoe Perches 1870b34c648bSJoe Perchessub ltrim { 1871b34c648bSJoe Perches my ($string) = @_; 1872b34c648bSJoe Perches 1873b34c648bSJoe Perches $string =~ s/^\s+//; 1874b34c648bSJoe Perches 1875b34c648bSJoe Perches return $string; 1876b34c648bSJoe Perches} 1877b34c648bSJoe Perches 1878b34c648bSJoe Perchessub rtrim { 1879b34c648bSJoe Perches my ($string) = @_; 1880b34c648bSJoe Perches 1881b34c648bSJoe Perches $string =~ s/\s+$//; 18823705ce5bSJoe Perches 18833705ce5bSJoe Perches return $string; 18843705ce5bSJoe Perches} 18853705ce5bSJoe Perches 188652ea8506SJoe Perchessub string_find_replace { 188752ea8506SJoe Perches my ($string, $find, $replace) = @_; 188852ea8506SJoe Perches 188952ea8506SJoe Perches $string =~ s/$find/$replace/g; 189052ea8506SJoe Perches 189152ea8506SJoe Perches return $string; 189252ea8506SJoe Perches} 189352ea8506SJoe Perches 18943705ce5bSJoe Perchessub tabify { 18953705ce5bSJoe Perches my ($leading) = @_; 18963705ce5bSJoe Perches 18973705ce5bSJoe Perches my $source_indent = 8; 18983705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 18993705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 19003705ce5bSJoe Perches 19013705ce5bSJoe Perches #convert leading spaces to tabs 19023705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 19033705ce5bSJoe Perches #Remove spaces before a tab 19043705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 19053705ce5bSJoe Perches 19063705ce5bSJoe Perches return "$leading"; 19073705ce5bSJoe Perches} 19083705ce5bSJoe Perches 1909d1fe9c09SJoe Perchessub pos_last_openparen { 1910d1fe9c09SJoe Perches my ($line) = @_; 1911d1fe9c09SJoe Perches 1912d1fe9c09SJoe Perches my $pos = 0; 1913d1fe9c09SJoe Perches 1914d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1915d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1916d1fe9c09SJoe Perches 1917d1fe9c09SJoe Perches my $last_openparen = 0; 1918d1fe9c09SJoe Perches 1919d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1920d1fe9c09SJoe Perches return -1; 1921d1fe9c09SJoe Perches } 1922d1fe9c09SJoe Perches 1923d1fe9c09SJoe Perches my $len = length($line); 1924d1fe9c09SJoe Perches 1925d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1926d1fe9c09SJoe Perches my $string = substr($line, $pos); 1927d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1928d1fe9c09SJoe Perches $pos += length($1) - 1; 1929d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1930d1fe9c09SJoe Perches $last_openparen = $pos; 1931d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1932d1fe9c09SJoe Perches last; 1933d1fe9c09SJoe Perches } 1934d1fe9c09SJoe Perches } 1935d1fe9c09SJoe Perches 193691cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1937d1fe9c09SJoe Perches} 1938d1fe9c09SJoe Perches 19390a920b5bSAndy Whitcroftsub process { 19400a920b5bSAndy Whitcroft my $filename = shift; 19410a920b5bSAndy Whitcroft 19420a920b5bSAndy Whitcroft my $linenr=0; 19430a920b5bSAndy Whitcroft my $prevline=""; 1944c2fdda0dSAndy Whitcroft my $prevrawline=""; 19450a920b5bSAndy Whitcroft my $stashline=""; 1946c2fdda0dSAndy Whitcroft my $stashrawline=""; 19470a920b5bSAndy Whitcroft 19484a0df2efSAndy Whitcroft my $length; 19490a920b5bSAndy Whitcroft my $indent; 19500a920b5bSAndy Whitcroft my $previndent=0; 19510a920b5bSAndy Whitcroft my $stashindent=0; 19520a920b5bSAndy Whitcroft 1953de7d4f0eSAndy Whitcroft our $clean = 1; 19540a920b5bSAndy Whitcroft my $signoff = 0; 19550a920b5bSAndy Whitcroft my $is_patch = 0; 195629ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 195715662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 1958bf4daf12SJoe Perches my $commit_log_possible_stack_dump = 0; 19592a076f40SJoe Perches my $commit_log_long_line = 0; 1960e518e9a5SJoe Perches my $commit_log_has_diff = 0; 196113f1937eSJoe Perches my $reported_maintainer_file = 0; 1962fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1963fa64205dSPasi Savanainen 1964365dd4eaSJoe Perches my $last_blank_line = 0; 19655e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1966365dd4eaSJoe Perches 196713214adfSAndy Whitcroft our @report = (); 19686c72ffaaSAndy Whitcroft our $cnt_lines = 0; 19696c72ffaaSAndy Whitcroft our $cnt_error = 0; 19706c72ffaaSAndy Whitcroft our $cnt_warn = 0; 19716c72ffaaSAndy Whitcroft our $cnt_chk = 0; 19726c72ffaaSAndy Whitcroft 19730a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19740a920b5bSAndy Whitcroft my $realfile = ''; 19750a920b5bSAndy Whitcroft my $realline = 0; 19760a920b5bSAndy Whitcroft my $realcnt = 0; 19770a920b5bSAndy Whitcroft my $here = ''; 19780a920b5bSAndy Whitcroft my $in_comment = 0; 1979c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19800a920b5bSAndy Whitcroft my $first_line = 0; 19811e855726SWolfram Sang my $p1_prefix = ''; 19820a920b5bSAndy Whitcroft 198313214adfSAndy Whitcroft my $prev_values = 'E'; 198413214adfSAndy Whitcroft 198513214adfSAndy Whitcroft # suppression flags 1986773647a0SAndy Whitcroft my %suppress_ifbraces; 1987170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19882b474a1aSAndy Whitcroft my %suppress_export; 19893e469cdcSAndy Whitcroft my $suppress_statement = 0; 1990653d4876SAndy Whitcroft 19917e51f197SJoe Perches my %signatures = (); 1992323c1260SJoe Perches 1993c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1994de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1995c2fdda0dSAndy Whitcroft # 1996de7d4f0eSAndy Whitcroft my @setup_docs = (); 1997de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1998773647a0SAndy Whitcroft 1999d8b07710SJoe Perches my $camelcase_file_seeded = 0; 2000d8b07710SJoe Perches 2001773647a0SAndy Whitcroft sanitise_line_reset(); 2002c2fdda0dSAndy Whitcroft my $line; 2003c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 2004773647a0SAndy Whitcroft $linenr++; 2005773647a0SAndy Whitcroft $line = $rawline; 2006c2fdda0dSAndy Whitcroft 20073705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 20083705ce5bSJoe Perches 2009773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 2010de7d4f0eSAndy Whitcroft $setup_docs = 0; 2011de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2012de7d4f0eSAndy Whitcroft $setup_docs = 1; 2013de7d4f0eSAndy Whitcroft } 2014773647a0SAndy Whitcroft #next; 2015de7d4f0eSAndy Whitcroft } 2016773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2017773647a0SAndy Whitcroft $realline=$1-1; 2018773647a0SAndy Whitcroft if (defined $2) { 2019773647a0SAndy Whitcroft $realcnt=$3+1; 2020773647a0SAndy Whitcroft } else { 2021773647a0SAndy Whitcroft $realcnt=1+1; 2022773647a0SAndy Whitcroft } 2023c45dcabdSAndy Whitcroft $in_comment = 0; 2024773647a0SAndy Whitcroft 2025773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 2026773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 2027773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 2028773647a0SAndy Whitcroft # at context start. 2029773647a0SAndy Whitcroft my $edge; 203001fa9147SAndy Whitcroft my $cnt = $realcnt; 203101fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 203201fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 203301fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 203401fa9147SAndy Whitcroft $cnt--; 203501fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 2036721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 2037fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2038fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2039fae17daeSAndy Whitcroft ($edge) = $1; 2040fae17daeSAndy Whitcroft last; 2041fae17daeSAndy Whitcroft } 2042773647a0SAndy Whitcroft } 2043773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 2044773647a0SAndy Whitcroft $in_comment = 1; 2045773647a0SAndy Whitcroft } 2046773647a0SAndy Whitcroft 2047773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 2048773647a0SAndy Whitcroft # is the start of a diff block and this line starts 2049773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 2050773647a0SAndy Whitcroft if (!defined $edge && 205183242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2052773647a0SAndy Whitcroft { 2053773647a0SAndy Whitcroft $in_comment = 1; 2054773647a0SAndy Whitcroft } 2055773647a0SAndy Whitcroft 2056773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2057773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 2058773647a0SAndy Whitcroft 2059171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2060773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 2061171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 2062773647a0SAndy Whitcroft $line = sanitise_line($rawline); 2063773647a0SAndy Whitcroft } 2064773647a0SAndy Whitcroft push(@lines, $line); 2065773647a0SAndy Whitcroft 2066773647a0SAndy Whitcroft if ($realcnt > 1) { 2067773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 2068773647a0SAndy Whitcroft } else { 2069773647a0SAndy Whitcroft $realcnt = 0; 2070773647a0SAndy Whitcroft } 2071773647a0SAndy Whitcroft 2072773647a0SAndy Whitcroft #print "==>$rawline\n"; 2073773647a0SAndy Whitcroft #print "-->$line\n"; 2074de7d4f0eSAndy Whitcroft 2075de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2076de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2077de7d4f0eSAndy Whitcroft } 2078de7d4f0eSAndy Whitcroft } 2079de7d4f0eSAndy Whitcroft 20806c72ffaaSAndy Whitcroft $prefix = ''; 20816c72ffaaSAndy Whitcroft 2082773647a0SAndy Whitcroft $realcnt = 0; 2083773647a0SAndy Whitcroft $linenr = 0; 2084194f66fcSJoe Perches $fixlinenr = -1; 20850a920b5bSAndy Whitcroft foreach my $line (@lines) { 20860a920b5bSAndy Whitcroft $linenr++; 2087194f66fcSJoe Perches $fixlinenr++; 20881b5539b1SJoe Perches my $sline = $line; #copy of $line 20891b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20900a920b5bSAndy Whitcroft 2091c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20926c72ffaaSAndy Whitcroft 20930a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 2094e518e9a5SJoe Perches if (!$in_commit_log && 2095e518e9a5SJoe Perches $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20960a920b5bSAndy Whitcroft $is_patch = 1; 20974a0df2efSAndy Whitcroft $first_line = $linenr + 1; 20980a920b5bSAndy Whitcroft $realline=$1-1; 20990a920b5bSAndy Whitcroft if (defined $2) { 21000a920b5bSAndy Whitcroft $realcnt=$3+1; 21010a920b5bSAndy Whitcroft } else { 21020a920b5bSAndy Whitcroft $realcnt=1+1; 21030a920b5bSAndy Whitcroft } 2104c2fdda0dSAndy Whitcroft annotate_reset(); 210513214adfSAndy Whitcroft $prev_values = 'E'; 210613214adfSAndy Whitcroft 2107773647a0SAndy Whitcroft %suppress_ifbraces = (); 2108170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 21092b474a1aSAndy Whitcroft %suppress_export = (); 21103e469cdcSAndy Whitcroft $suppress_statement = 0; 21110a920b5bSAndy Whitcroft next; 21120a920b5bSAndy Whitcroft 21134a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 21144a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 21154a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2116773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 21170a920b5bSAndy Whitcroft $realline++; 2118d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 21190a920b5bSAndy Whitcroft 21204a0df2efSAndy Whitcroft # Measure the line length and indent. 2121c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 21220a920b5bSAndy Whitcroft 21230a920b5bSAndy Whitcroft # Track the previous line. 21240a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 21250a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2126c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2127c2fdda0dSAndy Whitcroft 2128773647a0SAndy Whitcroft #warn "line<$line>\n"; 21296c72ffaaSAndy Whitcroft 2130d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2131d8aaf121SAndy Whitcroft $realcnt--; 21320a920b5bSAndy Whitcroft } 21330a920b5bSAndy Whitcroft 2134cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2135cc77cdcaSAndy Whitcroft 21366c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 21376c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2138773647a0SAndy Whitcroft 21392ac73b4fSJoe Perches my $found_file = 0; 2140773647a0SAndy Whitcroft # extract the filename as it passes 21413bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 21423bf9a009SRabin Vincent $realfile = $1; 21432b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2144270c49a0SJoe Perches $in_commit_log = 0; 21452ac73b4fSJoe Perches $found_file = 1; 21463bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2147773647a0SAndy Whitcroft $realfile = $1; 21482b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2149270c49a0SJoe Perches $in_commit_log = 0; 21501e855726SWolfram Sang 21511e855726SWolfram Sang $p1_prefix = $1; 2152e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2153e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2154000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2155000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 21561e855726SWolfram Sang } 2157773647a0SAndy Whitcroft 2158c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2159000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2160000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2161773647a0SAndy Whitcroft } 21622ac73b4fSJoe Perches $found_file = 1; 21632ac73b4fSJoe Perches } 21642ac73b4fSJoe Perches 216534d8815fSJoe Perches#make up the handle for any error we report on this line 216634d8815fSJoe Perches if ($showfile) { 216734d8815fSJoe Perches $prefix = "$realfile:$realline: " 216834d8815fSJoe Perches } elsif ($emacs) { 21697d3a9f67SJoe Perches if ($file) { 21707d3a9f67SJoe Perches $prefix = "$filename:$realline: "; 21717d3a9f67SJoe Perches } else { 217234d8815fSJoe Perches $prefix = "$filename:$linenr: "; 217334d8815fSJoe Perches } 21747d3a9f67SJoe Perches } 217534d8815fSJoe Perches 21762ac73b4fSJoe Perches if ($found_file) { 21777bd7e483SJoe Perches if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 21782ac73b4fSJoe Perches $check = 1; 21792ac73b4fSJoe Perches } else { 21802ac73b4fSJoe Perches $check = $check_orig; 21812ac73b4fSJoe Perches } 2182773647a0SAndy Whitcroft next; 2183773647a0SAndy Whitcroft } 2184773647a0SAndy Whitcroft 2185389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21860a920b5bSAndy Whitcroft 2187c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2188c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2189c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21900a920b5bSAndy Whitcroft 21916c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21926c72ffaaSAndy Whitcroft 2193e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2194e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2195e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2196e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2197e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2198e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2199e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2200e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2201e518e9a5SJoe Perches $commit_log_has_diff = 1; 2202e518e9a5SJoe Perches } 2203e518e9a5SJoe Perches 22043bf9a009SRabin Vincent# Check for incorrect file permissions 22053bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 22063bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 220704db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 220804db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2209000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2210000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 22113bf9a009SRabin Vincent } 22123bf9a009SRabin Vincent } 22133bf9a009SRabin Vincent 221420112475SJoe Perches# Check the patch for a signoff: 2215d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 22164a0df2efSAndy Whitcroft $signoff++; 221715662b3eSJoe Perches $in_commit_log = 0; 22180a920b5bSAndy Whitcroft } 221920112475SJoe Perches 2220e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2221e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2222e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2223e0d975b1SJoe Perches $reported_maintainer_file = 1; 2224e0d975b1SJoe Perches } 2225e0d975b1SJoe Perches 222620112475SJoe Perches# Check signature styles 2227270c49a0SJoe Perches if (!$in_header_lines && 2228ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 222920112475SJoe Perches my $space_before = $1; 223020112475SJoe Perches my $sign_off = $2; 223120112475SJoe Perches my $space_after = $3; 223220112475SJoe Perches my $email = $4; 223320112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 223420112475SJoe Perches 2235ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2236ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2237ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2238ce0338dfSJoe Perches } 223920112475SJoe Perches if (defined $space_before && $space_before ne "") { 22403705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22413705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 22423705ce5bSJoe Perches $fix) { 2243194f66fcSJoe Perches $fixed[$fixlinenr] = 22443705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22453705ce5bSJoe Perches } 224620112475SJoe Perches } 224720112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22483705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22493705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22503705ce5bSJoe Perches $fix) { 2251194f66fcSJoe Perches $fixed[$fixlinenr] = 22523705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22533705ce5bSJoe Perches } 22543705ce5bSJoe Perches 225520112475SJoe Perches } 225620112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22573705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22583705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22593705ce5bSJoe Perches $fix) { 2260194f66fcSJoe Perches $fixed[$fixlinenr] = 22613705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22623705ce5bSJoe Perches } 226320112475SJoe Perches } 226420112475SJoe Perches 226520112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 226620112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 226720112475SJoe Perches if ($suggested_email eq "") { 2268000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2269000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 227020112475SJoe Perches } else { 227120112475SJoe Perches my $dequoted = $suggested_email; 227220112475SJoe Perches $dequoted =~ s/^"//; 227320112475SJoe Perches $dequoted =~ s/" </ </; 227420112475SJoe Perches # Don't force email to have quotes 227520112475SJoe Perches # Allow just an angle bracketed address 227620112475SJoe Perches if ("$dequoted$comment" ne $email && 227720112475SJoe Perches "<$email_address>$comment" ne $email && 227820112475SJoe Perches "$suggested_email$comment" ne $email) { 2279000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2280000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 228120112475SJoe Perches } 22820a920b5bSAndy Whitcroft } 22837e51f197SJoe Perches 22847e51f197SJoe Perches# Check for duplicate signatures 22857e51f197SJoe Perches my $sig_nospace = $line; 22867e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22877e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22887e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22897e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22907e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22917e51f197SJoe Perches } else { 22927e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22937e51f197SJoe Perches } 22940a920b5bSAndy Whitcroft } 22950a920b5bSAndy Whitcroft 2296a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2297a2fe16b9SJoe Perches if ($in_header_lines && 2298a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2299a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2300a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2301a2fe16b9SJoe Perches } 2302a2fe16b9SJoe Perches 23039b3189ebSJoe Perches# Check for old stable address 23049b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 23059b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 23069b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 23079b3189ebSJoe Perches } 23089b3189ebSJoe Perches 23097ebd05efSChristopher Covington# Check for unwanted Gerrit info 23107ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 23117ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 23127ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 23137ebd05efSChristopher Covington } 23147ebd05efSChristopher Covington 23152a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 23162a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 2317bf4daf12SJoe Perches length($line) > 75 && 2318bf4daf12SJoe Perches !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 2319bf4daf12SJoe Perches # file delta changes 2320bf4daf12SJoe Perches $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 2321bf4daf12SJoe Perches # filename then : 2322bf4daf12SJoe Perches $line =~ /^\s*(?:Fixes:|Link:)/i || 2323bf4daf12SJoe Perches # A Fixes: or Link: line 2324bf4daf12SJoe Perches $commit_log_possible_stack_dump)) { 23252a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 23262a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 23272a076f40SJoe Perches $commit_log_long_line = 1; 23282a076f40SJoe Perches } 23292a076f40SJoe Perches 2330bf4daf12SJoe Perches# Check if the commit log is in a possible stack dump 2331bf4daf12SJoe Perches if ($in_commit_log && !$commit_log_possible_stack_dump && 2332bf4daf12SJoe Perches ($line =~ /^\s*(?:WARNING:|BUG:)/ || 2333bf4daf12SJoe Perches $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 2334bf4daf12SJoe Perches # timestamp 2335bf4daf12SJoe Perches $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) { 2336bf4daf12SJoe Perches # stack dump address 2337bf4daf12SJoe Perches $commit_log_possible_stack_dump = 1; 2338bf4daf12SJoe Perches } 2339bf4daf12SJoe Perches 2340bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found 2341bf4daf12SJoe Perches if ($in_commit_log && $commit_log_possible_stack_dump && 2342bf4daf12SJoe Perches $line =~ /^\s*$/) { 2343bf4daf12SJoe Perches $commit_log_possible_stack_dump = 0; 2344bf4daf12SJoe Perches } 2345bf4daf12SJoe Perches 23460d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2347fe043ea1SJoe Perches if ($in_commit_log && 2348fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2349bf4daf12SJoe Perches ($line =~ /\b[0-9a-f]{12,40}\b/i && 2350bf4daf12SJoe Perches $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 2351fe043ea1SJoe Perches my $init_char = "c"; 2352fe043ea1SJoe Perches my $orig_commit = ""; 23530d7835fcSJoe Perches my $short = 1; 23540d7835fcSJoe Perches my $long = 0; 23550d7835fcSJoe Perches my $case = 1; 23560d7835fcSJoe Perches my $space = 1; 23570d7835fcSJoe Perches my $hasdesc = 0; 235819c146a6SJoe Perches my $hasparens = 0; 23590d7835fcSJoe Perches my $id = '0123456789ab'; 23600d7835fcSJoe Perches my $orig_desc = "commit description"; 23610d7835fcSJoe Perches my $description = ""; 23620d7835fcSJoe Perches 2363fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2364fe043ea1SJoe Perches $init_char = $1; 2365fe043ea1SJoe Perches $orig_commit = lc($2); 2366fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2367fe043ea1SJoe Perches $orig_commit = lc($1); 2368fe043ea1SJoe Perches } 2369fe043ea1SJoe Perches 23700d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23710d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23720d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 23730d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 23740d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 23750d7835fcSJoe Perches $orig_desc = $1; 237619c146a6SJoe Perches $hasparens = 1; 23770d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 23780d7835fcSJoe Perches defined $rawlines[$linenr] && 23790d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 23800d7835fcSJoe Perches $orig_desc = $1; 238119c146a6SJoe Perches $hasparens = 1; 2382b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2383b671fde0SJoe Perches defined $rawlines[$linenr] && 2384b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2385b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2386b671fde0SJoe Perches $orig_desc = $1; 2387b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2388b671fde0SJoe Perches $orig_desc .= " " . $1; 238919c146a6SJoe Perches $hasparens = 1; 23900d7835fcSJoe Perches } 23910d7835fcSJoe Perches 23920d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 23930d7835fcSJoe Perches $id, $orig_desc); 23940d7835fcSJoe Perches 239519c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2396d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 23970d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 23980d7835fcSJoe Perches } 2399d311cd44SJoe Perches } 2400d311cd44SJoe Perches 240113f1937eSJoe Perches# Check for added, moved or deleted files 240213f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 240313f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 240413f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 240513f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 240613f1937eSJoe Perches (defined($1) || defined($2))))) { 240713f1937eSJoe Perches $reported_maintainer_file = 1; 240813f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 240913f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 241013f1937eSJoe Perches } 241113f1937eSJoe Perches 241200df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 24138905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2414000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2415000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 24166c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2417de7d4f0eSAndy Whitcroft } 2418de7d4f0eSAndy Whitcroft 24196ecd9674SAndy Whitcroft# Check for absolute kernel paths. 24206ecd9674SAndy Whitcroft if ($tree) { 24216ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 24226ecd9674SAndy Whitcroft my $file = $1; 24236ecd9674SAndy Whitcroft 24246ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 24256ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 24266ecd9674SAndy Whitcroft # 24276ecd9674SAndy Whitcroft } else { 24286ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 24296ecd9674SAndy Whitcroft } 24306ecd9674SAndy Whitcroft } 24316ecd9674SAndy Whitcroft } 24326ecd9674SAndy Whitcroft 2433de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2434de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2435171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2436171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2437171ae1a4SAndy Whitcroft 2438171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2439171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2440171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2441171ae1a4SAndy Whitcroft 244234d99219SJoe Perches CHK("INVALID_UTF8", 2443000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 244400df344fSAndy Whitcroft } 24450a920b5bSAndy Whitcroft 244615662b3eSJoe Perches# Check if it's the start of a commit log 244715662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 244815662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 244929ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 245029ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 245115662b3eSJoe Perches $in_header_lines = 0; 245215662b3eSJoe Perches $in_commit_log = 1; 245315662b3eSJoe Perches } 245415662b3eSJoe Perches 2455fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2456fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2457fa64205dSPasi Savanainen if ($in_header_lines && 2458fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2459fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2460fa64205dSPasi Savanainen $non_utf8_charset = 1; 2461fa64205dSPasi Savanainen } 2462fa64205dSPasi Savanainen 2463fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 246415662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2465fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 246615662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 246715662b3eSJoe Perches } 246815662b3eSJoe Perches 246966b47b4aSKees Cook# Check for various typo / spelling mistakes 247066d7a382SJoe Perches if (defined($misspellings) && 247166d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2472ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 247366b47b4aSKees Cook my $typo = $1; 247466b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 247566b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 247666b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 247766b47b4aSKees Cook my $msg_type = \&WARN; 247866b47b4aSKees Cook $msg_type = \&CHK if ($file); 247966b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 248066b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 248166b47b4aSKees Cook $fix) { 248266b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 248366b47b4aSKees Cook } 248466b47b4aSKees Cook } 248566b47b4aSKees Cook } 248666b47b4aSKees Cook 248730670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 248830670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 248900df344fSAndy Whitcroft 24900a920b5bSAndy Whitcroft#trailing whitespace 24919c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2492c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2493d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2494d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2495d5e616fcSJoe Perches $fix) { 2496194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2497d5e616fcSJoe Perches } 2498c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2499c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25003705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 25013705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 25023705ce5bSJoe Perches $fix) { 2503194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 25043705ce5bSJoe Perches } 25053705ce5bSJoe Perches 2506d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25070a920b5bSAndy Whitcroft } 25085368df20SAndy Whitcroft 25094783f894SJosh Triplett# Check for FSF mailing addresses. 2510109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 25113e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 25123e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 25134783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25144783f894SJosh Triplett my $msg_type = \&ERROR; 25154783f894SJosh Triplett $msg_type = \&CHK if ($file); 25164783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 25174783f894SJosh 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) 25184783f894SJosh Triplett } 25194783f894SJosh Triplett 25203354957aSAndi Kleen# check for Kconfig help text having a real description 25219fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 25229fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 25233354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 25248d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 25253354957aSAndi Kleen my $length = 0; 25269fe287d7SAndy Whitcroft my $cnt = $realcnt; 25279fe287d7SAndy Whitcroft my $ln = $linenr + 1; 25289fe287d7SAndy Whitcroft my $f; 2529a1385803SAndy Whitcroft my $is_start = 0; 25309fe287d7SAndy Whitcroft my $is_end = 0; 2531a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 25329fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 25339fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 25349fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 25359fe287d7SAndy Whitcroft 25369fe287d7SAndy Whitcroft next if ($f =~ /^-/); 25378d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2538a1385803SAndy Whitcroft 25398d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2540a1385803SAndy Whitcroft $is_start = 1; 25418d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2542a1385803SAndy Whitcroft $length = -1; 2543a1385803SAndy Whitcroft } 2544a1385803SAndy Whitcroft 25459fe287d7SAndy Whitcroft $f =~ s/^.//; 25463354957aSAndi Kleen $f =~ s/#.*//; 25473354957aSAndi Kleen $f =~ s/^\s+//; 25483354957aSAndi Kleen next if ($f =~ /^$/); 25499fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 25509fe287d7SAndy Whitcroft $is_end = 1; 25519fe287d7SAndy Whitcroft last; 25529fe287d7SAndy Whitcroft } 25533354957aSAndi Kleen $length++; 25543354957aSAndi Kleen } 255556193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2556000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 255756193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 255856193274SVadim Bendebury } 2559a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25603354957aSAndi Kleen } 25613354957aSAndi Kleen 25621ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25631ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25641ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25651ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25661ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25671ba8dfd1SKees Cook } 25681ba8dfd1SKees Cook 2569327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2570327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2571327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2572327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2573327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2574327953e9SChristoph Jaeger } 2575327953e9SChristoph Jaeger 2576c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2577c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2578c68e5878SArnaud Lacombe my $flag = $1; 2579c68e5878SArnaud Lacombe my $replacement = { 2580c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2581c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2582c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2583c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2584c68e5878SArnaud Lacombe }; 2585c68e5878SArnaud Lacombe 2586c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2587c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2588c68e5878SArnaud Lacombe } 2589c68e5878SArnaud Lacombe 2590bff5da43SRob Herring# check for DT compatible documentation 25917dd05b38SFlorian Vaussard if (defined $root && 25927dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 25937dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 25947dd05b38SFlorian Vaussard 2595bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2596bff5da43SRob Herring 2597cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2598cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2599cc93319bSFlorian Vaussard 2600bff5da43SRob Herring foreach my $compat (@compats) { 2601bff5da43SRob Herring my $compat2 = $compat; 2602185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2603185d566bSRob Herring my $compat3 = $compat; 2604185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2605185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2606bff5da43SRob Herring if ( $? >> 8 ) { 2607bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2608bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2609bff5da43SRob Herring } 2610bff5da43SRob Herring 26114fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 26124fbf32a6SFlorian Vaussard my $vendor = $1; 2613cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2614bff5da43SRob Herring if ( $? >> 8 ) { 2615bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2616cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2617bff5da43SRob Herring } 2618bff5da43SRob Herring } 2619bff5da43SRob Herring } 2620bff5da43SRob Herring 26215368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2622de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 26235368df20SAndy Whitcroft 262447e0c88bSJoe Perches# line length limit (with some exclusions) 262547e0c88bSJoe Perches# 262647e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 262747e0c88bSJoe Perches# logging functions like pr_info that end in a string 262847e0c88bSJoe Perches# lines with a single string 262947e0c88bSJoe Perches# #defines that are a single string 263047e0c88bSJoe Perches# 263147e0c88bSJoe Perches# There are 3 different line length message types: 263247e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 263347e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 263447e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 263547e0c88bSJoe Perches# 263647e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 263747e0c88bSJoe Perches# 263847e0c88bSJoe Perches 2639b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 264047e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 264147e0c88bSJoe Perches 264247e0c88bSJoe Perches # Check the allowed long line types first 264347e0c88bSJoe Perches 264447e0c88bSJoe Perches # logging functions that end in a string that starts 264547e0c88bSJoe Perches # before $max_line_length 264647e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 264747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 264847e0c88bSJoe Perches $msg_type = ""; 264947e0c88bSJoe Perches 265047e0c88bSJoe Perches # lines with only strings (w/ possible termination) 265147e0c88bSJoe Perches # #defines with only strings 265247e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 265347e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 265447e0c88bSJoe Perches $msg_type = ""; 265547e0c88bSJoe Perches 265647e0c88bSJoe Perches # Otherwise set the alternate message types 265747e0c88bSJoe Perches 265847e0c88bSJoe Perches # a comment starts before $max_line_length 265947e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 266047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 266147e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 266247e0c88bSJoe Perches 266347e0c88bSJoe Perches # a quoted string starts before $max_line_length 266447e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 266547e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 266647e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 266747e0c88bSJoe Perches } 266847e0c88bSJoe Perches 266947e0c88bSJoe Perches if ($msg_type ne "" && 267047e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 267147e0c88bSJoe Perches WARN($msg_type, 26726cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 26730a920b5bSAndy Whitcroft } 267447e0c88bSJoe Perches } 26750a920b5bSAndy Whitcroft 26768905a67cSAndy Whitcroft# check for adding lines without a newline. 26778905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2678000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2679000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 26808905a67cSAndy Whitcroft } 26818905a67cSAndy Whitcroft 268242e41c54SMike Frysinger# Blackfin: use hi/lo macros 268342e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 268442e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 268542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2686000d1cc1SJoe Perches ERROR("LO_MACRO", 2687000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 268842e41c54SMike Frysinger } 268942e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 269042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2691000d1cc1SJoe Perches ERROR("HI_MACRO", 2692000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 269342e41c54SMike Frysinger } 269442e41c54SMike Frysinger } 269542e41c54SMike Frysinger 2696b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2697de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 26980a920b5bSAndy Whitcroft 26990a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 27000a920b5bSAndy Whitcroft# more than 8 must use tabs. 2701c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2702c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2703c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2704d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 27053705ce5bSJoe Perches if (ERROR("CODE_INDENT", 27063705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 27073705ce5bSJoe Perches $fix) { 2708194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27093705ce5bSJoe Perches } 27100a920b5bSAndy Whitcroft } 27110a920b5bSAndy Whitcroft 271208e44365SAlberto Panizzo# check for space before tabs. 271308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 271408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27153705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 27163705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 27173705ce5bSJoe Perches $fix) { 2718194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2719d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2720194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2721c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 27223705ce5bSJoe Perches } 272308e44365SAlberto Panizzo } 272408e44365SAlberto Panizzo 2725d1fe9c09SJoe Perches# check for && or || at the start of a line 2726d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2727d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2728d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2729d1fe9c09SJoe Perches } 2730d1fe9c09SJoe Perches 2731d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2732d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 273391cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2734d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2735d1fe9c09SJoe Perches my $oldindent = $1; 2736d1fe9c09SJoe Perches my $rest = $2; 2737d1fe9c09SJoe Perches 2738d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2739d1fe9c09SJoe Perches if ($pos >= 0) { 2740b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2741b34a26f3SJoe Perches my $newindent = $2; 2742d1fe9c09SJoe Perches 2743d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2744d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2745d1fe9c09SJoe Perches " " x ($pos % 8); 2746d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2747d1fe9c09SJoe Perches 2748d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2749d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 27503705ce5bSJoe Perches 27513705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 27523705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27533705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2754194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27553705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27563705ce5bSJoe Perches } 2757d1fe9c09SJoe Perches } 2758d1fe9c09SJoe Perches } 2759d1fe9c09SJoe Perches } 2760d1fe9c09SJoe Perches 27616ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27626ab3a970SJoe Perches# avoid checking a few false positives: 27636ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27646ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27656ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27666ab3a970SJoe Perches# multiline macros that define functions 27676ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27686ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27696ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27703705ce5bSJoe Perches if (CHK("SPACING", 2771f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27723705ce5bSJoe Perches $fix) { 2773194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2774f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 27753705ce5bSJoe Perches } 2776aad4f614SJoe Perches } 2777aad4f614SJoe Perches 277886406b1cSJoe Perches# Block comment styles 277986406b1cSJoe Perches# Networking with an initial /* 278005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2781fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 278285ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 278385ad978cSJoe Perches $realline > 2) { 278405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 278505880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 278605880600SJoe Perches } 278705880600SJoe Perches 278886406b1cSJoe Perches# Block comments use * on subsequent lines 278986406b1cSJoe Perches if ($prevline =~ /$;[ \t]*$/ && #ends in comment 279086406b1cSJoe Perches $prevrawline =~ /^\+.*?\/\*/ && #starting /* 2791a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 279261135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2793a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 279486406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 279586406b1cSJoe Perches "Block comments use * on subsequent lines\n" . $hereprev); 2796a605e32eSJoe Perches } 2797a605e32eSJoe Perches 279886406b1cSJoe Perches# Block comments use */ on trailing lines 279986406b1cSJoe Perches if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2800c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2801c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2802c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 280386406b1cSJoe Perches WARN("BLOCK_COMMENT_STYLE", 280486406b1cSJoe Perches "Block comments use a trailing */ on a separate line\n" . $herecurr); 280505880600SJoe Perches } 280605880600SJoe Perches 28077f619191SJoe Perches# check for missing blank lines after struct/union declarations 28087f619191SJoe Perches# with exceptions for various attributes and macros 28097f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 28107f619191SJoe Perches $line =~ /^\+/ && 28117f619191SJoe Perches !($line =~ /^\+\s*$/ || 28127f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 28137f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 28147f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 28157f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 28167f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 28177f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 28187f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2819d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2820d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2821d752fcc8SJoe Perches $fix) { 2822f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2823d752fcc8SJoe Perches } 28247f619191SJoe Perches } 28257f619191SJoe Perches 2826365dd4eaSJoe Perches# check for multiple consecutive blank lines 2827365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2828365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2829365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2830d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2831d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2832d752fcc8SJoe Perches $fix) { 2833f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2834d752fcc8SJoe Perches } 2835d752fcc8SJoe Perches 2836365dd4eaSJoe Perches $last_blank_line = $linenr; 2837365dd4eaSJoe Perches } 2838365dd4eaSJoe Perches 28393b617e3bSJoe Perches# check for missing blank lines after declarations 28403f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 28413f7bac03SJoe Perches # actual declarations 28423f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28435a4e1fd3SJoe Perches # function pointer declarations 28445a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28453f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28463f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28473f7bac03SJoe Perches # known declaration macros 28483f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 28493f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 28503f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 28513f7bac03SJoe Perches # other possible extensions of declaration lines 28523f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 28533f7bac03SJoe Perches # not starting a section or a macro "\" extended line 28543f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 28553f7bac03SJoe Perches # looks like a declaration 28563f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28575a4e1fd3SJoe Perches # function pointer declarations 28585a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28593f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28603f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28613f7bac03SJoe Perches # known declaration macros 28623f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28633f7bac03SJoe Perches # start of struct or union or enum 28643b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28653f7bac03SJoe Perches # start or end of block or continuation of declaration 28663f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28673f7bac03SJoe Perches # bitfield continuation 28683f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28693f7bac03SJoe Perches # other possible extensions of declaration lines 28703f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28713f7bac03SJoe Perches # indentation of previous and current line are the same 28723f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2873d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2874d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2875d752fcc8SJoe Perches $fix) { 2876f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2877d752fcc8SJoe Perches } 28783b617e3bSJoe Perches } 28793b617e3bSJoe Perches 28805f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 28816b4c5bebSAndy Whitcroft# Exceptions: 28826b4c5bebSAndy Whitcroft# 1) within comments 28836b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 28846b4c5bebSAndy Whitcroft# 3) hanging labels 28853705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 28865f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28873705ce5bSJoe Perches if (WARN("LEADING_SPACE", 28883705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 28893705ce5bSJoe Perches $fix) { 2890194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28913705ce5bSJoe Perches } 28925f7ddae6SRaffaele Recalcati } 28935f7ddae6SRaffaele Recalcati 2894b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2895b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2896b9ea10d6SAndy Whitcroft 2897032a4c0fSJoe Perches# check indentation of any line with a bare else 2898840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2899032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2900032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2901032a4c0fSJoe Perches my $tabs = length($1) + 1; 2902840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2903840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2904840080a0SJoe Perches defined $lines[$linenr] && 2905840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2906032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2907032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2908032a4c0fSJoe Perches } 2909032a4c0fSJoe Perches } 2910032a4c0fSJoe Perches 2911c00df19aSJoe Perches# check indentation of a line with a break; 2912c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2913c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2914c00df19aSJoe Perches my $tabs = $1; 2915c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2916c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2917c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2918c00df19aSJoe Perches } 2919c00df19aSJoe Perches } 2920c00df19aSJoe Perches 29211ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 29221ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 29231ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 29241ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 29251ba8dfd1SKees Cook } 29261ba8dfd1SKees Cook 2927c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2928cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2929000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2930000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2931c2fdda0dSAndy Whitcroft } 293222f2a2efSAndy Whitcroft 293342e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 293442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 293542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2936000d1cc1SJoe Perches ERROR("CSYNC", 2937000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 293842e41c54SMike Frysinger } 293942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 294042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2941000d1cc1SJoe Perches ERROR("SSYNC", 2942000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 294342e41c54SMike Frysinger } 294442e41c54SMike Frysinger 294556e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 294656e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 294756e77d70SJoe Perches WARN("HOTPLUG_SECTION", 294856e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 294956e77d70SJoe Perches } 295056e77d70SJoe Perches 29519c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 29522b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 29532b474a1aSAndy Whitcroft $realline_next); 29543e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 29553e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29561b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2957170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2958f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2959171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2960171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2961171ae1a4SAndy Whitcroft 29623e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29633e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29643e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29653e469cdcSAndy Whitcroft # until we hit end of it. 29663e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29673e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29683e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29693e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29703e469cdcSAndy Whitcroft } 2971f74bd194SAndy Whitcroft 29722b474a1aSAndy Whitcroft # Find the real next line. 29732b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 29742b474a1aSAndy Whitcroft if (defined $realline_next && 29752b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 29762b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 29772b474a1aSAndy Whitcroft $realline_next++; 29782b474a1aSAndy Whitcroft } 29792b474a1aSAndy Whitcroft 2980171ae1a4SAndy Whitcroft my $s = $stat; 2981171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2982cf655043SAndy Whitcroft 2983c2fdda0dSAndy Whitcroft # Ignore goto labels. 2984171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2985c2fdda0dSAndy Whitcroft 2986c2fdda0dSAndy Whitcroft # Ignore functions being called 2987171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2988c2fdda0dSAndy Whitcroft 2989463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2990463f2864SAndy Whitcroft 2991c45dcabdSAndy Whitcroft # declarations always start with types 2992d2506586SAndy 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) { 2993c45dcabdSAndy Whitcroft my $type = $1; 2994c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2995c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2996c45dcabdSAndy Whitcroft 29976c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2998a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2999c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 3000c2fdda0dSAndy Whitcroft } 30018905a67cSAndy Whitcroft 30026c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 300365863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3004c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 30059c0ca6f9SAndy Whitcroft } 30068905a67cSAndy Whitcroft 30078905a67cSAndy Whitcroft # Check for any sort of function declaration. 30088905a67cSAndy Whitcroft # int foo(something bar, other baz); 30098905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 3010171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 30118905a67cSAndy Whitcroft my ($name_len) = length($1); 30128905a67cSAndy Whitcroft 3013cf655043SAndy Whitcroft my $ctx = $s; 3014773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 30158905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 3016cf655043SAndy Whitcroft 30178905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 3018c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 30198905a67cSAndy Whitcroft 3020c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 30218905a67cSAndy Whitcroft } 30228905a67cSAndy Whitcroft } 30238905a67cSAndy Whitcroft } 30248905a67cSAndy Whitcroft 30259c0ca6f9SAndy Whitcroft } 30269c0ca6f9SAndy Whitcroft 302700df344fSAndy Whitcroft# 302800df344fSAndy Whitcroft# Checks which may be anchored in the context. 302900df344fSAndy Whitcroft# 303000df344fSAndy Whitcroft 303100df344fSAndy Whitcroft# Check for switch () and associated case and default 303200df344fSAndy Whitcroft# statements should be at the same indent. 303300df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 303400df344fSAndy Whitcroft my $err = ''; 303500df344fSAndy Whitcroft my $sep = ''; 303600df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 303700df344fSAndy Whitcroft shift(@ctx); 303800df344fSAndy Whitcroft for my $ctx (@ctx) { 303900df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 304000df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 304100df344fSAndy Whitcroft $indent != $cindent) { 304200df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 304300df344fSAndy Whitcroft $sep = ''; 304400df344fSAndy Whitcroft } else { 304500df344fSAndy Whitcroft $sep = "[...]\n"; 304600df344fSAndy Whitcroft } 304700df344fSAndy Whitcroft } 304800df344fSAndy Whitcroft if ($err ne '') { 3049000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3050000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3051de7d4f0eSAndy Whitcroft } 3052de7d4f0eSAndy Whitcroft } 3053de7d4f0eSAndy Whitcroft 3054de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3055de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30560fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3057773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3058773647a0SAndy Whitcroft 30599c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30608eef05ddSJoe Perches 30618eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30628eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30638eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30648eef05ddSJoe Perches } 30658eef05ddSJoe Perches 3066de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3067de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3068de7d4f0eSAndy Whitcroft 3069548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3070548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3071de7d4f0eSAndy Whitcroft 3072548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3073548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3074548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3075548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3076548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3077773647a0SAndy Whitcroft $ctx_ln++; 3078773647a0SAndy Whitcroft } 3079548596d5SAndy Whitcroft 308053210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 308153210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3082773647a0SAndy Whitcroft 3083773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3084000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3085000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 308601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 308700df344fSAndy Whitcroft } 3088773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3089773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3090773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3091773647a0SAndy Whitcroft { 30929c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 30939c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3094000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3095000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 309601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 30979c0ca6f9SAndy Whitcroft } 30989c0ca6f9SAndy Whitcroft } 309900df344fSAndy Whitcroft } 310000df344fSAndy Whitcroft 31014d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 31020fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 31033e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 31043e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 31053e469cdcSAndy Whitcroft if (!defined $stat); 31064d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 31074d001e4dSAndy Whitcroft 31084d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 31094d001e4dSAndy Whitcroft 31109f5af480SJoe Perches # remove inline comments 31119f5af480SJoe Perches $s =~ s/$;/ /g; 31129f5af480SJoe Perches $c =~ s/$;/ /g; 31134d001e4dSAndy Whitcroft 31144d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 31156f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 31166f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 31174d001e4dSAndy Whitcroft 31189f5af480SJoe Perches # Make sure we remove the line prefixes as we have 31199f5af480SJoe Perches # none on the first line, and are going to readd them 31209f5af480SJoe Perches # where necessary. 31219f5af480SJoe Perches $s =~ s/\n./\n/gs; 31229f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 31239f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 31249f5af480SJoe Perches } 31259f5af480SJoe Perches 31264d001e4dSAndy Whitcroft # We want to check the first line inside the block 31274d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 31284d001e4dSAndy Whitcroft # 1) any blank line termination 31294d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 31304d001e4dSAndy Whitcroft # 3) any do (...) { 31314d001e4dSAndy Whitcroft my $continuation = 0; 31324d001e4dSAndy Whitcroft my $check = 0; 31334d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 31344d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 31354d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 31364d001e4dSAndy Whitcroft $continuation = 1; 31374d001e4dSAndy Whitcroft } 31389bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 31394d001e4dSAndy Whitcroft $check = 1; 31404d001e4dSAndy Whitcroft $cond_lines++; 31414d001e4dSAndy Whitcroft } 31424d001e4dSAndy Whitcroft 31434d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 31444d001e4dSAndy Whitcroft # preprocessor statement. 31454d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 31464d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 31474d001e4dSAndy Whitcroft $check = 0; 31484d001e4dSAndy Whitcroft } 31494d001e4dSAndy Whitcroft 31509bd49efeSAndy Whitcroft my $cond_ptr = -1; 3151740504c6SAndy Whitcroft $continuation = 0; 31529bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 31539bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 31544d001e4dSAndy Whitcroft 3155f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3156f16fa28fSAndy Whitcroft # is not linear. 3157f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3158f16fa28fSAndy Whitcroft $check = 0; 3159f16fa28fSAndy Whitcroft } 3160f16fa28fSAndy Whitcroft 31619bd49efeSAndy Whitcroft # Ignore: 31629bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31639bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31649bd49efeSAndy Whitcroft # 3) labels. 3165740504c6SAndy Whitcroft if ($continuation || 3166740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31679bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31689bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3169740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 317030dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31719bd49efeSAndy Whitcroft $cond_lines++; 31729bd49efeSAndy Whitcroft } 31734d001e4dSAndy Whitcroft } 317430dad6ebSAndy Whitcroft } 31754d001e4dSAndy Whitcroft 31764d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 31774d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 31784d001e4dSAndy Whitcroft 31794d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 31804d001e4dSAndy Whitcroft # this is not this patch's fault. 31814d001e4dSAndy Whitcroft if (!defined($stat_real) || 31824d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 31834d001e4dSAndy Whitcroft $check = 0; 31844d001e4dSAndy Whitcroft } 31854d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 31864d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 31874d001e4dSAndy Whitcroft } 31884d001e4dSAndy Whitcroft 31899bd49efeSAndy 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"; 31904d001e4dSAndy Whitcroft 31919f5af480SJoe Perches if ($check && $s ne '' && 31929f5af480SJoe Perches (($sindent % 8) != 0 || 31939f5af480SJoe Perches ($sindent < $indent) || 31949f5af480SJoe Perches ($sindent > $indent + 8))) { 3195000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3196000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 31974d001e4dSAndy Whitcroft } 31984d001e4dSAndy Whitcroft } 31994d001e4dSAndy Whitcroft 32006c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 32016c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 32021f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 32031f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 32046c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3205c2fdda0dSAndy Whitcroft if ($dbg_values) { 3206c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3207cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3208cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 32091f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3210c2fdda0dSAndy Whitcroft } 32116c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 32126c72ffaaSAndy Whitcroft 321300df344fSAndy Whitcroft#ignore lines not being added 32143705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 321500df344fSAndy Whitcroft 3216653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 32177429c690SAndy Whitcroft if ($dbg_type) { 32187429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3219000d1cc1SJoe Perches ERROR("TEST_TYPE", 3220000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 32217429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3222000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3223000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 32247429c690SAndy Whitcroft } 3225653d4876SAndy Whitcroft next; 3226653d4876SAndy Whitcroft } 3227a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3228a1ef277eSAndy Whitcroft if ($dbg_attr) { 32299360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3230000d1cc1SJoe Perches ERROR("TEST_ATTR", 3231000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 32329360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3233000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3234000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3235a1ef277eSAndy Whitcroft } 3236a1ef277eSAndy Whitcroft next; 3237a1ef277eSAndy Whitcroft } 3238653d4876SAndy Whitcroft 3239f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 324099423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 324199423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3242d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3243d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3244f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3245f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3246f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3247d752fcc8SJoe Perches my $fixedline = $prevrawline; 3248d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3249f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3250d752fcc8SJoe Perches $fixedline = $line; 3251d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3252f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3253d752fcc8SJoe Perches } 3254f0a594c1SAndy Whitcroft } 3255f0a594c1SAndy Whitcroft 325600df344fSAndy Whitcroft# 325700df344fSAndy Whitcroft# Checks which are anchored on the added line. 325800df344fSAndy Whitcroft# 325900df344fSAndy Whitcroft 3260653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3261c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3262653d4876SAndy Whitcroft my $path = $1; 3263653d4876SAndy Whitcroft if ($path =~ m{//}) { 3264000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3265495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3266495e9d84SJoe Perches } 3267495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3268495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3269495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3270653d4876SAndy Whitcroft } 3271653d4876SAndy Whitcroft } 3272653d4876SAndy Whitcroft 327300df344fSAndy Whitcroft# no C99 // comments 327400df344fSAndy Whitcroft if ($line =~ m{//}) { 32753705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 32763705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 32773705ce5bSJoe Perches $fix) { 3278194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 32793705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 32803705ce5bSJoe Perches my $comment = trim($1); 3281194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 32823705ce5bSJoe Perches } 32833705ce5bSJoe Perches } 328400df344fSAndy Whitcroft } 328500df344fSAndy Whitcroft # Remove C99 comments. 32860a920b5bSAndy Whitcroft $line =~ s@//.*@@; 32876c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 32880a920b5bSAndy Whitcroft 32892b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 32902b474a1aSAndy Whitcroft# the whole statement. 32912b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 32922b474a1aSAndy Whitcroft if (defined $realline_next && 32932b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 32942b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 32952b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32962b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32973cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 32983cbf62dfSAndy Whitcroft # a prefix: 32993cbf62dfSAndy Whitcroft # XXX(foo); 33003cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3301653d4876SAndy Whitcroft my $name = $1; 330287a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 33033cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 33043cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 33053cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 33063cbf62dfSAndy Whitcroft 33073cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 33082b474a1aSAndy Whitcroft \n.}\s*$| 330948012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 331048012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 331148012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 33122b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 33132b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 331448012058SAndy Whitcroft )/x) { 33152b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 33162b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 33172b474a1aSAndy Whitcroft } else { 33182b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 33190a920b5bSAndy Whitcroft } 33200a920b5bSAndy Whitcroft } 33212b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 33222b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 33232b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 33242b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 33252b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 33262b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 33272b474a1aSAndy Whitcroft } 33282b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 33292b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3330000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3331000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 33322b474a1aSAndy Whitcroft } 33330a920b5bSAndy Whitcroft 33345150bda4SJoe Eloff# check for global initialisers. 33355129e87cSJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) { 3336d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3337000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3338d5e616fcSJoe Perches $herecurr) && 3339d5e616fcSJoe Perches $fix) { 33405129e87cSJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/; 3341d5e616fcSJoe Perches } 3342f0a594c1SAndy Whitcroft } 33430a920b5bSAndy Whitcroft# check for static initialisers. 3344d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3345d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3346000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3347d5e616fcSJoe Perches $herecurr) && 3348d5e616fcSJoe Perches $fix) { 3349194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3350d5e616fcSJoe Perches } 33510a920b5bSAndy Whitcroft } 33520a920b5bSAndy Whitcroft 33531813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 33541813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 33551813087dSJoe Perches my $tmp = trim($1); 33561813087dSJoe Perches WARN("MISORDERED_TYPE", 33571813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 33581813087dSJoe Perches } 33591813087dSJoe Perches 3360cb710ecaSJoe Perches# check for static const char * arrays. 3361cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3362000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3363000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3364cb710ecaSJoe Perches $herecurr); 3365cb710ecaSJoe Perches } 3366cb710ecaSJoe Perches 3367cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3368cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3369000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3370000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3371cb710ecaSJoe Perches $herecurr); 3372cb710ecaSJoe Perches } 3373cb710ecaSJoe Perches 3374ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3375ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3376ab7e23f3SJoe Perches my $found = $1; 3377ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3378ab7e23f3SJoe Perches WARN("CONST_CONST", 3379ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3380ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3381ab7e23f3SJoe Perches WARN("CONST_CONST", 3382ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3383ab7e23f3SJoe Perches } 3384ab7e23f3SJoe Perches } 3385ab7e23f3SJoe Perches 33869b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 33879b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 33889b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 33899b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 33909b0fa60dSJoe Perches $herecurr); 33919b0fa60dSJoe Perches } 33929b0fa60dSJoe Perches 3393b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3394b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3395b598b670SJoe Perches my $array = $1; 3396b598b670SJoe 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*\))@) { 3397b598b670SJoe Perches my $array_div = $1; 3398b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3399b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3400b598b670SJoe Perches $fix) { 3401b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3402b598b670SJoe Perches } 3403b598b670SJoe Perches } 3404b598b670SJoe Perches } 3405b598b670SJoe Perches 3406b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3407b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3408b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3409b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3410b36190c5SJoe Perches $fix) { 3411194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3412b36190c5SJoe Perches } 3413b36190c5SJoe Perches } 3414b36190c5SJoe Perches 341592e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 341692e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 341792e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 341892e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 341992e112fdSJoe Perches $fix) { 3420194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 342192e112fdSJoe Perches } 342293ed0e2dSJoe Perches } 342393ed0e2dSJoe Perches 3424653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3425653d4876SAndy Whitcroft# make sense. 3426653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 34278054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3428c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 34298ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3430653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3431000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3432000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 34330a920b5bSAndy Whitcroft } 34340a920b5bSAndy Whitcroft 34350a920b5bSAndy Whitcroft# * goes on variable not on type 343665863862SAndy Whitcroft # (char*[ const]) 3437bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3438bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 34393705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3440d8aaf121SAndy Whitcroft 344165863862SAndy Whitcroft # Should start with a space. 344265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 344365863862SAndy Whitcroft # Should not end with a space. 344465863862SAndy Whitcroft $to =~ s/\s+$//; 344565863862SAndy Whitcroft # '*'s should not have spaces between. 3446f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 344765863862SAndy Whitcroft } 3448d8aaf121SAndy Whitcroft 34493705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 345065863862SAndy Whitcroft if ($from ne $to) { 34513705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34523705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 34533705ce5bSJoe Perches $fix) { 34543705ce5bSJoe Perches my $sub_from = $ident; 34553705ce5bSJoe Perches my $sub_to = $ident; 34563705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3457194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34583705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34593705ce5bSJoe Perches } 346065863862SAndy Whitcroft } 3461bfcb2cc7SAndy Whitcroft } 3462bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3463bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 34643705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3465d8aaf121SAndy Whitcroft 346665863862SAndy Whitcroft # Should start with a space. 346765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 346865863862SAndy Whitcroft # Should not end with a space. 346965863862SAndy Whitcroft $to =~ s/\s+$//; 347065863862SAndy Whitcroft # '*'s should not have spaces between. 3471f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 347265863862SAndy Whitcroft } 347365863862SAndy Whitcroft # Modifiers should have spaces. 347465863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 347565863862SAndy Whitcroft 34763705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3477667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 34783705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34793705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 34803705ce5bSJoe Perches $fix) { 34813705ce5bSJoe Perches 34823705ce5bSJoe Perches my $sub_from = $match; 34833705ce5bSJoe Perches my $sub_to = $match; 34843705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3485194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34863705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34873705ce5bSJoe Perches } 348865863862SAndy Whitcroft } 34890a920b5bSAndy Whitcroft } 34900a920b5bSAndy Whitcroft 34919d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 34929d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 34939d3e3c70SJoe Perches my $msg_type = \&WARN; 34949d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 34959d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 34969d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 34979d3e3c70SJoe Perches } 34980a920b5bSAndy Whitcroft 34999d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 35008905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3501000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3502000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 35038905a67cSAndy Whitcroft } 35048905a67cSAndy Whitcroft 350517441227SJoe Perches# check for uses of printk_ratelimit 350617441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3507000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3508000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 350917441227SJoe Perches } 351017441227SJoe Perches 351100df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 351200df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 351300df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 351425985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 351500df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3516f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 351700df344fSAndy Whitcroft my $ok = 0; 351800df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 351900df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 352025985edcSLucas De Marchi # we have a preceding printk if it ends 352100df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 352200df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 352300df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 352400df344fSAndy Whitcroft $ok = 1; 352500df344fSAndy Whitcroft } 352600df344fSAndy Whitcroft last; 352700df344fSAndy Whitcroft } 352800df344fSAndy Whitcroft } 352900df344fSAndy Whitcroft if ($ok == 0) { 3530000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3531000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 35320a920b5bSAndy Whitcroft } 353300df344fSAndy Whitcroft } 35340a920b5bSAndy Whitcroft 3535243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3536243f3803SJoe Perches my $orig = $1; 3537243f3803SJoe Perches my $level = lc($orig); 3538243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 35398f26b837SJoe Perches my $level2 = $level; 35408f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3541243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3542daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3543243f3803SJoe Perches } 3544243f3803SJoe Perches 3545243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3546d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3547d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3548d5e616fcSJoe Perches $fix) { 3549194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3550d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3551d5e616fcSJoe Perches } 3552243f3803SJoe Perches } 3553243f3803SJoe Perches 3554dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3555dc139313SJoe Perches my $orig = $1; 3556dc139313SJoe Perches my $level = lc($orig); 3557dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3558dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3559dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3560dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3561dc139313SJoe Perches } 3562dc139313SJoe Perches 356391c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 356491c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 356591c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 356691c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 356791c9afafSAndy Lutomirski WARN("ENOSYS", 356891c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 356991c9afafSAndy Lutomirski } 357091c9afafSAndy Lutomirski 3571653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3572653d4876SAndy Whitcroft# or if closed on same line 35738d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3574*4e5d56bdSEddie Kovsky !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 35758d182478SJoe Perches if (ERROR("OPEN_BRACE", 35768d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 35778d182478SJoe Perches $fix) { 35788d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35798d182478SJoe Perches my $fixed_line = $rawline; 35808d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 35818d182478SJoe Perches my $line1 = $1; 35828d182478SJoe Perches my $line2 = $2; 35838d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 35848d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 35858d182478SJoe Perches if ($line2 !~ /^\s*$/) { 35868d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 35878d182478SJoe Perches } 35888d182478SJoe Perches } 35890a920b5bSAndy Whitcroft } 3590653d4876SAndy Whitcroft 35918905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 35928905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 35938905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 35948d182478SJoe Perches if (ERROR("OPEN_BRACE", 35958d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 35968d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 35978d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 35988d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35998d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 36008d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36018d182478SJoe Perches $fixedline = $rawline; 36028d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 36038d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 36048d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 36058d182478SJoe Perches } 36068d182478SJoe Perches } 36078905a67cSAndy Whitcroft } 36088905a67cSAndy Whitcroft 36090c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 36103705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 36113705ce5bSJoe Perches if (WARN("SPACING", 36123705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 36133705ce5bSJoe Perches $fix) { 3614194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36153705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 36163705ce5bSJoe Perches } 36170c73b4ebSAndy Whitcroft } 36180c73b4ebSAndy Whitcroft 361931070b5dSJoe Perches# Function pointer declarations 362031070b5dSJoe Perches# check spacing between type, funcptr, and args 362131070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 362291f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 362331070b5dSJoe Perches my $declare = $1; 362431070b5dSJoe Perches my $pre_pointer_space = $2; 362531070b5dSJoe Perches my $post_pointer_space = $3; 362631070b5dSJoe Perches my $funcname = $4; 362731070b5dSJoe Perches my $post_funcname_space = $5; 362831070b5dSJoe Perches my $pre_args_space = $6; 362931070b5dSJoe Perches 363091f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 363191f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 363291f72e9cSJoe Perches# don't need a space so don't warn for those. 363391f72e9cSJoe Perches my $post_declare_space = ""; 363491f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 363591f72e9cSJoe Perches $post_declare_space = $1; 363691f72e9cSJoe Perches $declare = rtrim($declare); 363791f72e9cSJoe Perches } 363891f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 363931070b5dSJoe Perches WARN("SPACING", 364031070b5dSJoe Perches "missing space after return type\n" . $herecurr); 364191f72e9cSJoe Perches $post_declare_space = " "; 364231070b5dSJoe Perches } 364331070b5dSJoe Perches 364431070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 364591f72e9cSJoe Perches# This test is not currently implemented because these declarations are 364691f72e9cSJoe Perches# equivalent to 364791f72e9cSJoe Perches# int foo(int bar, ...) 364891f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 364991f72e9cSJoe Perches# 365091f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 365191f72e9cSJoe Perches# WARN("SPACING", 365291f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 365391f72e9cSJoe Perches# } 365431070b5dSJoe Perches 365531070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 365631070b5dSJoe Perches if (defined $pre_pointer_space && 365731070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 365831070b5dSJoe Perches WARN("SPACING", 365931070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 366031070b5dSJoe Perches } 366131070b5dSJoe Perches 366231070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 366331070b5dSJoe Perches if (defined $post_pointer_space && 366431070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 366531070b5dSJoe Perches WARN("SPACING", 366631070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 366731070b5dSJoe Perches } 366831070b5dSJoe Perches 366931070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 367031070b5dSJoe Perches if (defined $post_funcname_space && 367131070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 367231070b5dSJoe Perches WARN("SPACING", 367331070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 367431070b5dSJoe Perches } 367531070b5dSJoe Perches 367631070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 367731070b5dSJoe Perches if (defined $pre_args_space && 367831070b5dSJoe Perches $pre_args_space =~ /^\s/) { 367931070b5dSJoe Perches WARN("SPACING", 368031070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 368131070b5dSJoe Perches } 368231070b5dSJoe Perches 368331070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3684194f66fcSJoe Perches $fixed[$fixlinenr] =~ 368591f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 368631070b5dSJoe Perches } 368731070b5dSJoe Perches } 368831070b5dSJoe Perches 36898d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 36908d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3691fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3692fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 36938d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 36948d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 36958d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3696fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3697daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 36983705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 36993705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 37003705ce5bSJoe Perches $fix) { 3701194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37023705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 37033705ce5bSJoe Perches } 37048d31cfceSAndy Whitcroft } 37058d31cfceSAndy Whitcroft } 37068d31cfceSAndy Whitcroft 3707f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 37086c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3709c2fdda0dSAndy Whitcroft my $name = $1; 3710773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3711773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3712c2fdda0dSAndy Whitcroft 3713c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3714773647a0SAndy Whitcroft if ($name =~ /^(?: 3715773647a0SAndy Whitcroft if|for|while|switch|return|case| 3716773647a0SAndy Whitcroft volatile|__volatile__| 3717773647a0SAndy Whitcroft __attribute__|format|__extension__| 3718773647a0SAndy Whitcroft asm|__asm__)$/x) 3719773647a0SAndy Whitcroft { 3720c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3721c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3722c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3723c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3724773647a0SAndy Whitcroft 3725773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3726c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3727c2fdda0dSAndy Whitcroft 3728c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3729c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3730773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3731c2fdda0dSAndy Whitcroft 3732c2fdda0dSAndy Whitcroft } else { 37333705ce5bSJoe Perches if (WARN("SPACING", 37343705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 37353705ce5bSJoe Perches $fix) { 3736194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37373705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 37383705ce5bSJoe Perches } 3739f0a594c1SAndy Whitcroft } 37406c72ffaaSAndy Whitcroft } 37419a4cad4eSEric Nelson 3742653d4876SAndy Whitcroft# Check operator spacing. 37430a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 37443705ce5bSJoe Perches my $fixed_line = ""; 37453705ce5bSJoe Perches my $line_fixed = 0; 37463705ce5bSJoe Perches 37479c0ca6f9SAndy Whitcroft my $ops = qr{ 37489c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 37499c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 37509c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 37511f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 375284731623SJoe Perches \?:|\?|: 37539c0ca6f9SAndy Whitcroft }x; 3754cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 37553705ce5bSJoe Perches 37563705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 37573705ce5bSJoe Perches## foreach my $el (@elements) { 37583705ce5bSJoe Perches## print("el: <$el>\n"); 37593705ce5bSJoe Perches## } 37603705ce5bSJoe Perches 37613705ce5bSJoe Perches my @fix_elements = (); 376200df344fSAndy Whitcroft my $off = 0; 37636c72ffaaSAndy Whitcroft 37643705ce5bSJoe Perches foreach my $el (@elements) { 37653705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 37663705ce5bSJoe Perches $off += length($el); 37673705ce5bSJoe Perches } 37683705ce5bSJoe Perches 37693705ce5bSJoe Perches $off = 0; 37703705ce5bSJoe Perches 37716c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3772b34c648bSJoe Perches my $last_after = -1; 37736c72ffaaSAndy Whitcroft 37740a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 37753705ce5bSJoe Perches 37763705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 37773705ce5bSJoe Perches 37783705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 37793705ce5bSJoe Perches 37804a0df2efSAndy Whitcroft $off += length($elements[$n]); 37814a0df2efSAndy Whitcroft 378225985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3783773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3784773647a0SAndy Whitcroft my $cc = ''; 3785773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3786773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3787773647a0SAndy Whitcroft } 3788773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3789773647a0SAndy Whitcroft 37904a0df2efSAndy Whitcroft my $a = ''; 37914a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 37924a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3793cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 37944a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 37954a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3796773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 37974a0df2efSAndy Whitcroft 37980a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 37994a0df2efSAndy Whitcroft 38004a0df2efSAndy Whitcroft my $c = ''; 38010a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 38024a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 38034a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3804cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 38054a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 38064a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 38078b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 38084a0df2efSAndy Whitcroft } else { 38094a0df2efSAndy Whitcroft $c = 'E'; 38100a920b5bSAndy Whitcroft } 38110a920b5bSAndy Whitcroft 38124a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 38134a0df2efSAndy Whitcroft 38144a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 38154a0df2efSAndy Whitcroft 38166c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3817de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 38180a920b5bSAndy Whitcroft 381974048ed8SAndy Whitcroft # Pull out the value of this operator. 38206c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 38210a920b5bSAndy Whitcroft 38221f65f947SAndy Whitcroft # Get the full operator variant. 38231f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 38241f65f947SAndy Whitcroft 382513214adfSAndy Whitcroft # Ignore operators passed as parameters. 382613214adfSAndy Whitcroft if ($op_type ne 'V' && 3827d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 382813214adfSAndy Whitcroft 3829cf655043SAndy Whitcroft# # Ignore comments 3830cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 383113214adfSAndy Whitcroft 3832d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 383313214adfSAndy Whitcroft } elsif ($op eq ';') { 3834cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3835cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 38363705ce5bSJoe Perches if (ERROR("SPACING", 38373705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3838b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38393705ce5bSJoe Perches $line_fixed = 1; 38403705ce5bSJoe Perches } 3841d8aaf121SAndy Whitcroft } 3842d8aaf121SAndy Whitcroft 3843d8aaf121SAndy Whitcroft # // is a comment 3844d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 38450a920b5bSAndy Whitcroft 3846b00e4814SJoe Perches # : when part of a bitfield 3847b00e4814SJoe Perches } elsif ($opv eq ':B') { 3848b00e4814SJoe Perches # skip the bitfield test for now 3849b00e4814SJoe Perches 38501f65f947SAndy Whitcroft # No spaces for: 38511f65f947SAndy Whitcroft # -> 3852b00e4814SJoe Perches } elsif ($op eq '->') { 38534a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 38543705ce5bSJoe Perches if (ERROR("SPACING", 38553705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3856b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38573705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38583705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38593705ce5bSJoe Perches } 3860b34c648bSJoe Perches $line_fixed = 1; 38613705ce5bSJoe Perches } 38620a920b5bSAndy Whitcroft } 38630a920b5bSAndy Whitcroft 38642381097bSJoe Perches # , must not have a space before and must have a space on the right. 38650a920b5bSAndy Whitcroft } elsif ($op eq ',') { 38662381097bSJoe Perches my $rtrim_before = 0; 38672381097bSJoe Perches my $space_after = 0; 38682381097bSJoe Perches if ($ctx =~ /Wx./) { 38692381097bSJoe Perches if (ERROR("SPACING", 38702381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 38712381097bSJoe Perches $line_fixed = 1; 38722381097bSJoe Perches $rtrim_before = 1; 38732381097bSJoe Perches } 38742381097bSJoe Perches } 3875cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 38763705ce5bSJoe Perches if (ERROR("SPACING", 38773705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 38783705ce5bSJoe Perches $line_fixed = 1; 3879b34c648bSJoe Perches $last_after = $n; 38802381097bSJoe Perches $space_after = 1; 38812381097bSJoe Perches } 38822381097bSJoe Perches } 38832381097bSJoe Perches if ($rtrim_before || $space_after) { 38842381097bSJoe Perches if ($rtrim_before) { 38852381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38862381097bSJoe Perches } else { 38872381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38882381097bSJoe Perches } 38892381097bSJoe Perches if ($space_after) { 38902381097bSJoe Perches $good .= " "; 38913705ce5bSJoe Perches } 38920a920b5bSAndy Whitcroft } 38930a920b5bSAndy Whitcroft 38949c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 389574048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 38969c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 38979c0ca6f9SAndy Whitcroft 38989c0ca6f9SAndy Whitcroft # unary operators should have a space before and 38999c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 39009c0ca6f9SAndy Whitcroft # unary operator, or a cast 39019c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 390274048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 39030d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3904cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 39053705ce5bSJoe Perches if (ERROR("SPACING", 39063705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3907b34c648bSJoe Perches if ($n != $last_after + 2) { 3908b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 39093705ce5bSJoe Perches $line_fixed = 1; 39103705ce5bSJoe Perches } 39110a920b5bSAndy Whitcroft } 3912b34c648bSJoe Perches } 3913a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3914171ae1a4SAndy Whitcroft # A unary '*' may be const 3915171ae1a4SAndy Whitcroft 3916171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 39173705ce5bSJoe Perches if (ERROR("SPACING", 39183705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3919b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 39203705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39213705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 39223705ce5bSJoe Perches } 3923b34c648bSJoe Perches $line_fixed = 1; 39243705ce5bSJoe Perches } 39250a920b5bSAndy Whitcroft } 39260a920b5bSAndy Whitcroft 39270a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 39280a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3929773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 39303705ce5bSJoe Perches if (ERROR("SPACING", 39313705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3932b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39333705ce5bSJoe Perches $line_fixed = 1; 39343705ce5bSJoe Perches } 39350a920b5bSAndy Whitcroft } 3936773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3937773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 39383705ce5bSJoe Perches if (ERROR("SPACING", 39393705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3940b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39413705ce5bSJoe Perches $line_fixed = 1; 39423705ce5bSJoe Perches } 3943653d4876SAndy Whitcroft } 3944773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 39453705ce5bSJoe Perches if (ERROR("SPACING", 39463705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3947b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39483705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39493705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3950773647a0SAndy Whitcroft } 3951b34c648bSJoe Perches $line_fixed = 1; 39523705ce5bSJoe Perches } 39533705ce5bSJoe Perches } 39540a920b5bSAndy Whitcroft 39550a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 39569c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 39579c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 39589c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3959c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3960c2fdda0dSAndy Whitcroft $op eq '%') 39610a920b5bSAndy Whitcroft { 3962d2e025f3SJoe Perches if ($check) { 3963d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3964d2e025f3SJoe Perches if (CHK("SPACING", 3965d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3966d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3967d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3968d2e025f3SJoe Perches $line_fixed = 1; 3969d2e025f3SJoe Perches } 3970d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3971d2e025f3SJoe Perches if (CHK("SPACING", 3972d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3973d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3974d2e025f3SJoe Perches $line_fixed = 1; 3975d2e025f3SJoe Perches } 3976d2e025f3SJoe Perches } 3977d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 39783705ce5bSJoe Perches if (ERROR("SPACING", 39793705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3980b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3981b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3982b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3983b34c648bSJoe Perches } 39843705ce5bSJoe Perches $line_fixed = 1; 39853705ce5bSJoe Perches } 39860a920b5bSAndy Whitcroft } 39870a920b5bSAndy Whitcroft 39881f65f947SAndy Whitcroft # A colon needs no spaces before when it is 39891f65f947SAndy Whitcroft # terminating a case value or a label. 39901f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 39911f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 39923705ce5bSJoe Perches if (ERROR("SPACING", 39933705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3994b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39953705ce5bSJoe Perches $line_fixed = 1; 39963705ce5bSJoe Perches } 39971f65f947SAndy Whitcroft } 39981f65f947SAndy Whitcroft 39990a920b5bSAndy Whitcroft # All the others need spaces both sides. 4000cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 40011f65f947SAndy Whitcroft my $ok = 0; 40021f65f947SAndy Whitcroft 400322f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 40041f65f947SAndy Whitcroft if (($op eq '<' && 40051f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 40061f65f947SAndy Whitcroft ($op eq '>' && 40071f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 40081f65f947SAndy Whitcroft { 40091f65f947SAndy Whitcroft $ok = 1; 40101f65f947SAndy Whitcroft } 40111f65f947SAndy Whitcroft 4012e0df7e1fSJoe Perches # for asm volatile statements 4013e0df7e1fSJoe Perches # ignore a colon with another 4014e0df7e1fSJoe Perches # colon immediately before or after 4015e0df7e1fSJoe Perches if (($op eq ':') && 4016e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 4017e0df7e1fSJoe Perches $ok = 1; 4018e0df7e1fSJoe Perches } 4019e0df7e1fSJoe Perches 402084731623SJoe Perches # messages are ERROR, but ?: are CHK 40211f65f947SAndy Whitcroft if ($ok == 0) { 402284731623SJoe Perches my $msg_type = \&ERROR; 402384731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 402484731623SJoe Perches 402584731623SJoe Perches if (&{$msg_type}("SPACING", 40263705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 4027b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 4028b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 4029b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 4030b34c648bSJoe Perches } 40313705ce5bSJoe Perches $line_fixed = 1; 40323705ce5bSJoe Perches } 40330a920b5bSAndy Whitcroft } 403422f2a2efSAndy Whitcroft } 40354a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 40363705ce5bSJoe Perches 40373705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 40383705ce5bSJoe Perches 40393705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 40400a920b5bSAndy Whitcroft } 40413705ce5bSJoe Perches 40423705ce5bSJoe Perches if (($#elements % 2) == 0) { 40433705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 40443705ce5bSJoe Perches } 40453705ce5bSJoe Perches 4046194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4047194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 40483705ce5bSJoe Perches } 40493705ce5bSJoe Perches 40503705ce5bSJoe Perches 40510a920b5bSAndy Whitcroft } 40520a920b5bSAndy Whitcroft 4053786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4054d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4055786b6326SJoe Perches if (WARN("SPACING", 4056786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4057786b6326SJoe Perches $fix) { 4058194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4059786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4060786b6326SJoe Perches } 4061786b6326SJoe Perches } 4062786b6326SJoe Perches 4063f0a594c1SAndy Whitcroft# check for multiple assignments 4064f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4065000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4066000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4067f0a594c1SAndy Whitcroft } 4068f0a594c1SAndy Whitcroft 406922f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 407022f2a2efSAndy Whitcroft## # continuation. 407122f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 407222f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 407322f2a2efSAndy Whitcroft## 407422f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 407522f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 407622f2a2efSAndy Whitcroft## my $ln = $line; 407722f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 407822f2a2efSAndy Whitcroft## } 407922f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4080000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4081000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 408222f2a2efSAndy Whitcroft## } 408322f2a2efSAndy Whitcroft## } 4084f0a594c1SAndy Whitcroft 40850a920b5bSAndy Whitcroft#need space before brace following if, while, etc 4086*4e5d56bdSEddie Kovsky if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\){/) || 4087*4e5d56bdSEddie Kovsky $line =~ /do\{/) { 40883705ce5bSJoe Perches if (ERROR("SPACING", 40893705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 40903705ce5bSJoe Perches $fix) { 4091194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 40923705ce5bSJoe Perches } 4093de7d4f0eSAndy Whitcroft } 4094de7d4f0eSAndy Whitcroft 4095c4a62ef9SJoe Perches## # check for blank lines before declarations 4096c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4097c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4098c4a62ef9SJoe Perches## WARN("SPACING", 4099c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4100c4a62ef9SJoe Perches## } 4101c4a62ef9SJoe Perches## 4102c4a62ef9SJoe Perches 4103de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4104de7d4f0eSAndy Whitcroft# on the line 4105de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4106d5e616fcSJoe Perches if (ERROR("SPACING", 4107d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4108d5e616fcSJoe Perches $fix) { 4109194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4110d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4111d5e616fcSJoe Perches } 41120a920b5bSAndy Whitcroft } 41130a920b5bSAndy Whitcroft 411422f2a2efSAndy Whitcroft# check spacing on square brackets 411522f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 41163705ce5bSJoe Perches if (ERROR("SPACING", 41173705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 41183705ce5bSJoe Perches $fix) { 4119194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41203705ce5bSJoe Perches s/\[\s+/\[/; 41213705ce5bSJoe Perches } 412222f2a2efSAndy Whitcroft } 412322f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 41243705ce5bSJoe Perches if (ERROR("SPACING", 41253705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 41263705ce5bSJoe Perches $fix) { 4127194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41283705ce5bSJoe Perches s/\s+\]/\]/; 41293705ce5bSJoe Perches } 413022f2a2efSAndy Whitcroft } 413122f2a2efSAndy Whitcroft 4132c45dcabdSAndy Whitcroft# check spacing on parentheses 41339c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 41349c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 41353705ce5bSJoe Perches if (ERROR("SPACING", 41363705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 41373705ce5bSJoe Perches $fix) { 4138194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41393705ce5bSJoe Perches s/\(\s+/\(/; 41403705ce5bSJoe Perches } 414122f2a2efSAndy Whitcroft } 414213214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4143c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4144c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 41453705ce5bSJoe Perches if (ERROR("SPACING", 41463705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 41473705ce5bSJoe Perches $fix) { 4148194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41493705ce5bSJoe Perches s/\s+\)/\)/; 41503705ce5bSJoe Perches } 415122f2a2efSAndy Whitcroft } 415222f2a2efSAndy Whitcroft 4153e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4154e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4155e2826fd0SJoe Perches 4156e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4157ea4acbb1SJoe Perches my $var = $1; 4158ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4159ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4160ea4acbb1SJoe Perches $fix) { 4161ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4162ea4acbb1SJoe Perches } 4163ea4acbb1SJoe Perches } 4164ea4acbb1SJoe Perches 4165ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4166ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4167ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4168ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4169ea4acbb1SJoe Perches my $var = $2; 4170ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4171ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4172ea4acbb1SJoe Perches $fix) { 4173ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4174ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4175ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4176ea4acbb1SJoe Perches } 4177e2826fd0SJoe Perches } 4178e2826fd0SJoe Perches 41790a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 41804a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 41810a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 41823705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 41833705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 41843705ce5bSJoe Perches $fix) { 4185194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41863705ce5bSJoe Perches s/^(.)\s+/$1/; 41873705ce5bSJoe Perches } 41880a920b5bSAndy Whitcroft } 41890a920b5bSAndy Whitcroft 41905b9553abSJoe Perches# return is not a function 4191507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4192c45dcabdSAndy Whitcroft my $spacing = $1; 4193507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 41945b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 41955b9553abSJoe Perches my $value = $1; 41965b9553abSJoe Perches $value = deparenthesize($value); 41975b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4198000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4199000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 42005b9553abSJoe Perches } 4201c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4202000d1cc1SJoe Perches ERROR("SPACING", 4203000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4204c45dcabdSAndy Whitcroft } 4205c45dcabdSAndy Whitcroft } 4206507e5141SJoe Perches 4207b43ae21bSJoe Perches# unnecessary return in a void function 4208b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4209b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4210b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4211b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4212b43ae21bSJoe Perches $linenr >= 3 && 4213b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4214b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 42159819cf25SJoe Perches WARN("RETURN_VOID", 4216b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 42179819cf25SJoe Perches } 42189819cf25SJoe Perches 4219189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4220189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4221189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4222189248d8SJoe Perches my $openparens = $1; 4223189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4224189248d8SJoe Perches my $msg = ""; 4225189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4226189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4227189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4228189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4229189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4230189248d8SJoe Perches } 4231189248d8SJoe Perches } 4232189248d8SJoe Perches 4233f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4234f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 423553a3c448SAndy Whitcroft my $name = $1; 423653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4237000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4238f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 423953a3c448SAndy Whitcroft } 424053a3c448SAndy Whitcroft } 4241c45dcabdSAndy Whitcroft 42420a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 42434a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 42443705ce5bSJoe Perches if (ERROR("SPACING", 42453705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 42463705ce5bSJoe Perches $fix) { 4247194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42483705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 42493705ce5bSJoe Perches } 42500a920b5bSAndy Whitcroft } 42510a920b5bSAndy Whitcroft 4252f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4253f5fe35ddSAndy Whitcroft# statements after the conditional. 4254170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 42553e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 42563e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 42573e469cdcSAndy Whitcroft if (!defined $stat); 4258170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4259170d3a22SAndy Whitcroft $remain_next, $off_next); 4260170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4261170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4262170d3a22SAndy Whitcroft 4263170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4264170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4265170d3a22SAndy Whitcroft # then count those as offsets. 4266170d3a22SAndy Whitcroft my ($whitespace) = 4267170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4268170d3a22SAndy Whitcroft my $offset = 4269170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4270170d3a22SAndy Whitcroft 4271170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4272170d3a22SAndy Whitcroft $offset} = 1; 4273170d3a22SAndy Whitcroft } 4274170d3a22SAndy Whitcroft } 4275170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4276c11230f4SJoe Perches defined($stat) && defined($cond) && 4277170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4278171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 42798905a67cSAndy Whitcroft 4280b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4281000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4282000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 42838905a67cSAndy Whitcroft } 42848905a67cSAndy Whitcroft 42858905a67cSAndy Whitcroft # Find out what is on the end of the line after the 42868905a67cSAndy Whitcroft # conditional. 4287773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 42888905a67cSAndy Whitcroft $s =~ s/\n.*//g; 428913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 429053210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 429153210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4292773647a0SAndy Whitcroft { 4293bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4294bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4295bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 429642bdf74cSHidetoshi Seto my $stat_real = ''; 4297bb44ad39SAndy Whitcroft 429842bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 429942bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4300bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4301bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4302bb44ad39SAndy Whitcroft } 4303bb44ad39SAndy Whitcroft 4304000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4305000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 43068905a67cSAndy Whitcroft } 43078905a67cSAndy Whitcroft } 43088905a67cSAndy Whitcroft 430913214adfSAndy Whitcroft# Check for bitwise tests written as boolean 431013214adfSAndy Whitcroft if ($line =~ / 431113214adfSAndy Whitcroft (?: 431213214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 431313214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 431413214adfSAndy Whitcroft (?:\&\&|\|\|) 431513214adfSAndy Whitcroft | 431613214adfSAndy Whitcroft (?:\&\&|\|\|) 431713214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 431813214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 431913214adfSAndy Whitcroft )/x) 432013214adfSAndy Whitcroft { 4321000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4322000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 432313214adfSAndy Whitcroft } 432413214adfSAndy Whitcroft 43258905a67cSAndy Whitcroft# if and else should not have general statements after it 432613214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 432713214adfSAndy Whitcroft my $s = $1; 432813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 432913214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4330000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4331000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 43320a920b5bSAndy Whitcroft } 433313214adfSAndy Whitcroft } 433439667782SAndy Whitcroft# if should not continue a brace 433539667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4336000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4337048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 433839667782SAndy Whitcroft $herecurr); 433939667782SAndy Whitcroft } 4340a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4341a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4342a1080bf8SAndy Whitcroft $line !~ /\G(?: 43433fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4344a1080bf8SAndy Whitcroft \s*return\s+ 4345a1080bf8SAndy Whitcroft )/xg) 4346a1080bf8SAndy Whitcroft { 4347000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4348000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4349a1080bf8SAndy Whitcroft } 43500a920b5bSAndy Whitcroft 43510a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 43520a920b5bSAndy Whitcroft # indent level to be relevant to each other. 43538b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 43540a920b5bSAndy Whitcroft $previndent == $indent) { 43558b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 43568b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 43578b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43588b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43598b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43608b8856f4SJoe Perches my $fixedline = $prevrawline; 43618b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 43628b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 43638b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43648b8856f4SJoe Perches } 43658b8856f4SJoe Perches $fixedline = $rawline; 43668b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 43678b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43688b8856f4SJoe Perches } 43690a920b5bSAndy Whitcroft } 43700a920b5bSAndy Whitcroft 43718b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4372c2fdda0dSAndy Whitcroft $previndent == $indent) { 4373c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4374c2fdda0dSAndy Whitcroft 4375c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4376c2fdda0dSAndy Whitcroft # conditional. 4377773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4378c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4379c2fdda0dSAndy Whitcroft 4380c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 43818b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 43828b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 43838b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43848b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43858b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43868b8856f4SJoe Perches my $fixedline = $prevrawline; 43878b8856f4SJoe Perches my $trailing = $rawline; 43888b8856f4SJoe Perches $trailing =~ s/^\+//; 43898b8856f4SJoe Perches $trailing = trim($trailing); 43908b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 43918b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43928b8856f4SJoe Perches } 4393c2fdda0dSAndy Whitcroft } 4394c2fdda0dSAndy Whitcroft } 4395c2fdda0dSAndy Whitcroft 439695e2c602SJoe Perches#Specific variable tests 4397323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4398323c1260SJoe Perches my $var = $1; 439995e2c602SJoe Perches 440095e2c602SJoe Perches#gcc binary extension 440195e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4402d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4403d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4404d5e616fcSJoe Perches $fix) { 4405d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4406194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4407d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4408d5e616fcSJoe Perches } 440995e2c602SJoe Perches } 441095e2c602SJoe Perches 441195e2c602SJoe Perches#CamelCase 4412807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4413be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 441422735ce8SJoe Perches#Ignore Page<foo> variants 4415807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 441622735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4417f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4418f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4419f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 44207e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 44217e781f67SJoe Perches my $word = $1; 44227e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4423d8b07710SJoe Perches if ($check) { 4424d8b07710SJoe Perches seed_camelcase_includes(); 4425d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4426d8b07710SJoe Perches seed_camelcase_file($realfile); 4427d8b07710SJoe Perches $camelcase_file_seeded = 1; 4428d8b07710SJoe Perches } 4429d8b07710SJoe Perches } 44307e781f67SJoe Perches if (!defined $camelcase{$word}) { 44317e781f67SJoe Perches $camelcase{$word} = 1; 4432be79794bSJoe Perches CHK("CAMELCASE", 44337e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 44347e781f67SJoe Perches } 4435323c1260SJoe Perches } 4436323c1260SJoe Perches } 44373445686aSJoe Perches } 44380a920b5bSAndy Whitcroft 44390a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4440d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4441d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4442d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4443d5e616fcSJoe Perches $fix) { 4444194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4445d5e616fcSJoe Perches } 44460a920b5bSAndy Whitcroft } 44470a920b5bSAndy Whitcroft 44480e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 44490e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4450c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4451e09dec48SAndy Whitcroft my $file = "$1.h"; 4452e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4453e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4454e09dec48SAndy Whitcroft $realfile ne $checkfile && 44557840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4456c45dcabdSAndy Whitcroft { 44570e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 44580e212e0aSFabian Frederick if ($asminclude > 0) { 4459e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4460000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4461000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4462e09dec48SAndy Whitcroft } else { 4463000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4464000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4465e09dec48SAndy Whitcroft } 44660a920b5bSAndy Whitcroft } 44670a920b5bSAndy Whitcroft } 44680e212e0aSFabian Frederick } 44690a920b5bSAndy Whitcroft 4470653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4471653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4472cf655043SAndy Whitcroft# in a known good container 4473b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4474b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4475d8aaf121SAndy Whitcroft my $ln = $linenr; 4476d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4477c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4478c45dcabdSAndy Whitcroft my $ctx = ''; 447908a2843eSJoe Perches my $has_flow_statement = 0; 448008a2843eSJoe Perches my $has_arg_concat = 0; 4481c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4482f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4483f74bd194SAndy Whitcroft $ctx = $dstat; 4484c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4485a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4486c45dcabdSAndy Whitcroft 448708a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 448808a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 448908a2843eSJoe Perches 4490f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4491292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4492c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4493c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4494c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4495c45dcabdSAndy Whitcroft 4496c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4497bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4498bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4499c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4500bf30d6edSAndy Whitcroft { 4501c45dcabdSAndy Whitcroft } 4502c45dcabdSAndy Whitcroft 4503e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 450433acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 450533acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4506e45bab8eSAndy Whitcroft { 4507e45bab8eSAndy Whitcroft } 4508e45bab8eSAndy Whitcroft 4509c45dcabdSAndy Whitcroft my $exceptions = qr{ 4510c45dcabdSAndy Whitcroft $Declare| 4511c45dcabdSAndy Whitcroft module_param_named| 4512a0a0a7a9SKees Cook MODULE_PARM_DESC| 4513c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4514c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4515383099fdSAndy Whitcroft __typeof__\(| 451622fd2d3eSStefani Seibold union| 451722fd2d3eSStefani Seibold struct| 4518ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4519ea71a0a0SAndy Whitcroft ^\"|\"$ 4520c45dcabdSAndy Whitcroft }x; 45215eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4522f74bd194SAndy Whitcroft if ($dstat ne '' && 4523f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4524f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 45253cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4526356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4527f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4528f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4529e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 453072f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4531f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4532f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4533f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4534*4e5d56bdSEddie Kovsky $dstat !~ /^\(\{/ && # ({... 4535f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4536c45dcabdSAndy Whitcroft { 4537f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4538f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4539f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4540f74bd194SAndy Whitcroft 4541f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4542f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4543c45dcabdSAndy Whitcroft } 4544c45dcabdSAndy Whitcroft 4545f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4546f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4547f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4548f74bd194SAndy Whitcroft } else { 4549000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4550388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4551d8aaf121SAndy Whitcroft } 45520a920b5bSAndy Whitcroft } 45535023d347SJoe Perches 455408a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 455508a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 455608a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 455708a2843eSJoe Perches my $herectx = $here . "\n"; 455808a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 455908a2843eSJoe Perches 456008a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 456108a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 456208a2843eSJoe Perches } 456308a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 456408a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 456508a2843eSJoe Perches } 456608a2843eSJoe Perches 4567481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 45685023d347SJoe Perches 45695023d347SJoe Perches } else { 45705023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4571481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4572481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 45735023d347SJoe Perches $line =~ /^\+.*\\$/) { 45745023d347SJoe Perches WARN("LINE_CONTINUATIONS", 45755023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 45765023d347SJoe Perches } 4577653d4876SAndy Whitcroft } 45780a920b5bSAndy Whitcroft 4579b13edf7fSJoe Perches# do {} while (0) macro tests: 4580b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4581b13edf7fSJoe Perches# macro should not end with a semicolon 4582b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4583b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4584b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4585b13edf7fSJoe Perches my $ln = $linenr; 4586b13edf7fSJoe Perches my $cnt = $realcnt; 4587b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4588b13edf7fSJoe Perches my $ctx = ''; 4589b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4590b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4591b13edf7fSJoe Perches $ctx = $dstat; 4592b13edf7fSJoe Perches 4593b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 45941b36b201SJoe Perches $dstat =~ s/$;/ /g; 4595b13edf7fSJoe Perches 4596b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4597b13edf7fSJoe Perches my $stmts = $2; 4598b13edf7fSJoe Perches my $semis = $3; 4599b13edf7fSJoe Perches 4600b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4601b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4602b13edf7fSJoe Perches my $herectx = $here . "\n"; 4603b13edf7fSJoe Perches 4604b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4605b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4606b13edf7fSJoe Perches } 4607b13edf7fSJoe Perches 4608ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4609ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4610b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4611b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4612b13edf7fSJoe Perches } 4613b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4614b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4615b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4616b13edf7fSJoe Perches } 4617f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4618f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4619f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4620f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4621f5ef95b1SJoe Perches 4622f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4623f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4624f5ef95b1SJoe Perches } 4625f5ef95b1SJoe Perches 4626f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4627f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4628b13edf7fSJoe Perches } 4629b13edf7fSJoe Perches } 4630b13edf7fSJoe Perches 4631080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4632080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4633080ba929SMike Frysinger# . 4634080ba929SMike Frysinger# ALIGN(...) 4635080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4636080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4637000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4638000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4639080ba929SMike Frysinger } 4640080ba929SMike Frysinger 4641f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 464213214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 464313214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4644cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 464513214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4646cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4647cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4648aad4f614SJoe Perches my @allowed = (); 4649aad4f614SJoe Perches my $allow = 0; 465013214adfSAndy Whitcroft my $seen = 0; 4651773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4652cf655043SAndy Whitcroft my $ln = $linenr - 1; 465313214adfSAndy Whitcroft for my $chunk (@chunks) { 465413214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 465513214adfSAndy Whitcroft 4656773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4657773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4658773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4659773647a0SAndy Whitcroft 4660aad4f614SJoe Perches $allowed[$allow] = 0; 4661773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4662773647a0SAndy Whitcroft 4663773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4664773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4665773647a0SAndy Whitcroft 4666773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4667cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4668cf655043SAndy Whitcroft 4669773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 467013214adfSAndy Whitcroft 467113214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 467213214adfSAndy Whitcroft 4673aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4674cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4675cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4676aad4f614SJoe Perches $allowed[$allow] = 1; 467713214adfSAndy Whitcroft } 467813214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4679cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4680aad4f614SJoe Perches $allowed[$allow] = 1; 468113214adfSAndy Whitcroft } 4682cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4683cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4684aad4f614SJoe Perches $allowed[$allow] = 1; 468513214adfSAndy Whitcroft } 4686aad4f614SJoe Perches $allow++; 468713214adfSAndy Whitcroft } 4688aad4f614SJoe Perches if ($seen) { 4689aad4f614SJoe Perches my $sum_allowed = 0; 4690aad4f614SJoe Perches foreach (@allowed) { 4691aad4f614SJoe Perches $sum_allowed += $_; 4692aad4f614SJoe Perches } 4693aad4f614SJoe Perches if ($sum_allowed == 0) { 4694000d1cc1SJoe Perches WARN("BRACES", 4695000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4696aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4697aad4f614SJoe Perches $seen != $allow) { 4698aad4f614SJoe Perches CHK("BRACES", 4699aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4700aad4f614SJoe Perches } 470113214adfSAndy Whitcroft } 470213214adfSAndy Whitcroft } 470313214adfSAndy Whitcroft } 4704773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 470513214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4706cf655043SAndy Whitcroft my $allowed = 0; 4707f0a594c1SAndy Whitcroft 4708cf655043SAndy Whitcroft # Check the pre-context. 4709cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4710cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4711cf655043SAndy Whitcroft $allowed = 1; 4712f0a594c1SAndy Whitcroft } 4713773647a0SAndy Whitcroft 4714773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4715773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4716773647a0SAndy Whitcroft 4717cf655043SAndy Whitcroft # Check the condition. 4718cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4719773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4720cf655043SAndy Whitcroft if (defined $cond) { 4721773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4722cf655043SAndy Whitcroft } 4723cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4724cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4725cf655043SAndy Whitcroft $allowed = 1; 4726cf655043SAndy Whitcroft } 4727cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4728cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4729cf655043SAndy Whitcroft $allowed = 1; 4730cf655043SAndy Whitcroft } 4731cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4732cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4733cf655043SAndy Whitcroft $allowed = 1; 4734cf655043SAndy Whitcroft } 4735cf655043SAndy Whitcroft # Check the post-context. 4736cf655043SAndy Whitcroft if (defined $chunks[1]) { 4737cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4738cf655043SAndy Whitcroft if (defined $cond) { 4739773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4740cf655043SAndy Whitcroft } 4741cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4742cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4743cf655043SAndy Whitcroft $allowed = 1; 4744cf655043SAndy Whitcroft } 4745cf655043SAndy Whitcroft } 4746cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 474769932487SJustin P. Mattock my $herectx = $here . "\n"; 4748f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4749cf655043SAndy Whitcroft 4750f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 475169932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4752cf655043SAndy Whitcroft } 4753cf655043SAndy Whitcroft 4754000d1cc1SJoe Perches WARN("BRACES", 4755000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4756f0a594c1SAndy Whitcroft } 4757f0a594c1SAndy Whitcroft } 4758f0a594c1SAndy Whitcroft 47590979ae66SJoe Perches# check for unnecessary blank lines around braces 476077b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4761f8e58219SJoe Perches if (CHK("BRACES", 4762f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4763f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4764f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4765f8e58219SJoe Perches } 47660979ae66SJoe Perches } 476777b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4768f8e58219SJoe Perches if (CHK("BRACES", 4769f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4770f8e58219SJoe Perches $fix) { 4771f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4772f8e58219SJoe Perches } 47730979ae66SJoe Perches } 47740979ae66SJoe Perches 47754a0df2efSAndy Whitcroft# no volatiles please 47766c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 47776c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4778000d1cc1SJoe Perches WARN("VOLATILE", 4779000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 47804a0df2efSAndy Whitcroft } 47814a0df2efSAndy Whitcroft 47825e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 47835e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 47845e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 47855e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 478633acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 47875e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 47885e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 47895e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 47905e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 47915e4f6ba5SJoe Perches $fix && 47925e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 47935e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 47945e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 47955e4f6ba5SJoe Perches my $comma_close = ""; 47965e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 47975e4f6ba5SJoe Perches $comma_close = $1; 47985e4f6ba5SJoe Perches } 47995e4f6ba5SJoe Perches 48005e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 48015e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 48025e4f6ba5SJoe Perches my $fixedline = $prevrawline; 48035e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 48045e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 48055e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 48065e4f6ba5SJoe Perches $fixedline = $rawline; 48075e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 48085e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 48095e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 48105e4f6ba5SJoe Perches } 48115e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 48125e4f6ba5SJoe Perches } 48135e4f6ba5SJoe Perches } 48145e4f6ba5SJoe Perches 48155e4f6ba5SJoe Perches# check for missing a space in a string concatenation 48165e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 48175e4f6ba5SJoe Perches WARN('MISSING_SPACE', 48185e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 48195e4f6ba5SJoe Perches } 48205e4f6ba5SJoe Perches 48215e4f6ba5SJoe Perches# check for spaces before a quoted newline 48225e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 48235e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 48245e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 48255e4f6ba5SJoe Perches $fix) { 48265e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 48275e4f6ba5SJoe Perches } 48285e4f6ba5SJoe Perches 48295e4f6ba5SJoe Perches } 48305e4f6ba5SJoe Perches 4831f17dba4fSJoe Perches# concatenated string without spaces between elements 483233acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4833f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4834f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4835f17dba4fSJoe Perches } 4836f17dba4fSJoe Perches 483790ad30e5SJoe Perches# uncoalesced string fragments 483833acb54aSJoe Perches if ($line =~ /$String\s*"/) { 483990ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 484090ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 484190ad30e5SJoe Perches } 484290ad30e5SJoe Perches 48436e300757SJoe Perches# check for %L{u,d,i} and 0x%[udi] in strings 48445e4f6ba5SJoe Perches my $string; 48455e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 48465e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 48475e4f6ba5SJoe Perches $string =~ s/%%/__/g; 48486e300757SJoe Perches if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) { 48495e4f6ba5SJoe Perches WARN("PRINTF_L", 48505e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 48515e4f6ba5SJoe Perches last; 48525e4f6ba5SJoe Perches } 48536e300757SJoe Perches if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) { 48546e300757SJoe Perches ERROR("PRINTF_0xDECIMAL", 48556e300757SJoe Perches "Prefixing 0x with decimal output is defective\n" . $herecurr); 48566e300757SJoe Perches } 48575e4f6ba5SJoe Perches } 48585e4f6ba5SJoe Perches 48595e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 48605e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 48615e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 48625e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 48635e4f6ba5SJoe Perches } 48645e4f6ba5SJoe Perches 486500df344fSAndy Whitcroft# warn about #if 0 4866c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4867000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4868000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4869de7d4f0eSAndy Whitcroft $herecurr); 48704a0df2efSAndy Whitcroft } 48714a0df2efSAndy Whitcroft 487203df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 487303df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 4874100425deSJoe Perches my $tested = quotemeta($1); 4875100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 4876100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 4877100425deSJoe Perches my $func = $1; 4878100425deSJoe Perches if (WARN('NEEDLESS_IF', 4879100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 4880100425deSJoe Perches $fix) { 4881100425deSJoe Perches my $do_fix = 1; 4882100425deSJoe Perches my $leading_tabs = ""; 4883100425deSJoe Perches my $new_leading_tabs = ""; 4884100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 4885100425deSJoe Perches $leading_tabs = $1; 4886100425deSJoe Perches } else { 4887100425deSJoe Perches $do_fix = 0; 4888100425deSJoe Perches } 4889100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 4890100425deSJoe Perches $new_leading_tabs = $1; 4891100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 4892100425deSJoe Perches $do_fix = 0; 4893100425deSJoe Perches } 4894100425deSJoe Perches } else { 4895100425deSJoe Perches $do_fix = 0; 4896100425deSJoe Perches } 4897100425deSJoe Perches if ($do_fix) { 4898100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4899100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 4900100425deSJoe Perches } 4901100425deSJoe Perches } 49024c432a8fSGreg Kroah-Hartman } 49034c432a8fSGreg Kroah-Hartman } 4904f0a594c1SAndy Whitcroft 4905ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4906ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4907ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4908ebfdc409SJoe Perches (defined $1 || defined $3) && 4909ebfdc409SJoe Perches $linenr > 3) { 4910ebfdc409SJoe Perches my $testval = $2; 4911ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4912ebfdc409SJoe Perches 4913ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4914ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4915ebfdc409SJoe Perches 4916ebfdc409SJoe 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)/) { 4917ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4918ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4919ebfdc409SJoe Perches } 4920ebfdc409SJoe Perches } 4921ebfdc409SJoe Perches 4922f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4923dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4924f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4925f78d98f6SJoe Perches my $level = $1; 4926f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4927f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4928f78d98f6SJoe Perches $fix) { 4929f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4930f78d98f6SJoe Perches } 4931f78d98f6SJoe Perches } 4932f78d98f6SJoe Perches 4933abb08a53SJoe Perches# check for mask then right shift without a parentheses 4934abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4935abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4936abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4937abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4938abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4939abb08a53SJoe Perches } 4940abb08a53SJoe Perches 4941b75ac618SJoe Perches# check for pointer comparisons to NULL 4942b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4943b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4944b75ac618SJoe Perches my $val = $1; 4945b75ac618SJoe Perches my $equal = "!"; 4946b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4947b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4948b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4949b75ac618SJoe Perches $fix) { 4950b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4951b75ac618SJoe Perches } 4952b75ac618SJoe Perches } 4953b75ac618SJoe Perches } 4954b75ac618SJoe Perches 49558716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 49568716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 49578716de38SJoe Perches my $attr = $1; 49588716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 49598716de38SJoe Perches my $ptr = $1; 49608716de38SJoe Perches my $var = $2; 49618716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 49628716de38SJoe Perches ERROR("MISPLACED_INIT", 49638716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 49648716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 49658716de38SJoe Perches WARN("MISPLACED_INIT", 49668716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 49678716de38SJoe Perches $fix) { 4968194f66fcSJoe 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; 49698716de38SJoe Perches } 49708716de38SJoe Perches } 49718716de38SJoe Perches } 49728716de38SJoe Perches 4973e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4974e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4975e970b884SJoe Perches my $attr = $1; 4976e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4977e970b884SJoe Perches my $attr_prefix = $1; 4978e970b884SJoe Perches my $attr_type = $2; 4979e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4980e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4981e970b884SJoe Perches $fix) { 4982194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4983e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4984e970b884SJoe Perches } 4985e970b884SJoe Perches } 4986e970b884SJoe Perches 4987e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4988e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4989e970b884SJoe Perches my $attr = $1; 4990e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4991e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4992e970b884SJoe Perches $fix) { 4993194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4994e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4995e970b884SJoe Perches $lead = rtrim($1); 4996e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4997e970b884SJoe Perches $lead = "${lead}const "; 4998194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4999e970b884SJoe Perches } 5000e970b884SJoe Perches } 5001e970b884SJoe Perches 5002c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 5003c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 5004c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 5005c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 5006c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 5007c17893c7SJoe Perches $fix) { 5008c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 5009c17893c7SJoe Perches } 5010c17893c7SJoe Perches } 5011c17893c7SJoe Perches 5012fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 5013fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 5014fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 5015fbdb8138SJoe Perches my $constant_func = $1; 5016fbdb8138SJoe Perches my $func = $constant_func; 5017fbdb8138SJoe Perches $func =~ s/^__constant_//; 5018fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 5019fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 5020fbdb8138SJoe Perches $fix) { 5021194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 5022fbdb8138SJoe Perches } 5023fbdb8138SJoe Perches } 5024fbdb8138SJoe Perches 50251a15a250SPatrick Pannuto# prefer usleep_range over udelay 502637581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 502743c1d77cSJoe Perches my $delay = $1; 50281a15a250SPatrick Pannuto # ignore udelay's < 10, however 502943c1d77cSJoe Perches if (! ($delay < 10) ) { 5030000d1cc1SJoe Perches CHK("USLEEP_RANGE", 503143c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 503243c1d77cSJoe Perches } 503343c1d77cSJoe Perches if ($delay > 2000) { 503443c1d77cSJoe Perches WARN("LONG_UDELAY", 503543c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 50361a15a250SPatrick Pannuto } 50371a15a250SPatrick Pannuto } 50381a15a250SPatrick Pannuto 503909ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 504009ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 504109ef8725SPatrick Pannuto if ($1 < 20) { 5042000d1cc1SJoe Perches WARN("MSLEEP", 504343c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 504409ef8725SPatrick Pannuto } 504509ef8725SPatrick Pannuto } 504609ef8725SPatrick Pannuto 504736ec1939SJoe Perches# check for comparisons of jiffies 504836ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 504936ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 505036ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 505136ec1939SJoe Perches } 505236ec1939SJoe Perches 50539d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 50549d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 50559d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 50569d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 50579d7a34a5SJoe Perches } 50589d7a34a5SJoe Perches 505900df344fSAndy Whitcroft# warn about #ifdefs in C files 5060c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 506100df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 506200df344fSAndy Whitcroft# print "$herecurr"; 506300df344fSAndy Whitcroft# $clean = 0; 506400df344fSAndy Whitcroft# } 506500df344fSAndy Whitcroft 506622f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5067c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 50683705ce5bSJoe Perches if (ERROR("SPACING", 50693705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 50703705ce5bSJoe Perches $fix) { 5071194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50723705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 50733705ce5bSJoe Perches } 50743705ce5bSJoe Perches 507522f2a2efSAndy Whitcroft } 507622f2a2efSAndy Whitcroft 50774a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5078171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5079171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 50804a0df2efSAndy Whitcroft my $which = $1; 50814a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5082000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5083000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 50844a0df2efSAndy Whitcroft } 50854a0df2efSAndy Whitcroft } 50864a0df2efSAndy Whitcroft# check for memory barriers without a comment. 50874a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 50884a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5089c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5090000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 50914a0df2efSAndy Whitcroft } 50924a0df2efSAndy Whitcroft } 50933ad81779SPaul E. McKenney 5094cb426e99SJoe Perches# check for waitqueue_active without a comment. 5095cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5096cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5097cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5098cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5099cb426e99SJoe Perches } 5100cb426e99SJoe Perches } 51013ad81779SPaul E. McKenney 51023ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 51033ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 51043ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 51053ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 51063ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 51073ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 51083ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 51093ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 51103ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 51113ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 51123ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 51133ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 51143ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 51153ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 51163ad81779SPaul E. McKenney 51173ad81779SPaul E. McKenney } 51183ad81779SPaul E. McKenney 51194a0df2efSAndy Whitcroft# check of hardware specific defines 5120c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5121000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5122000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 51230a920b5bSAndy Whitcroft } 5124653d4876SAndy Whitcroft 5125d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5126d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5127000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5128000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5129d4977c78STobias Klauser } 5130d4977c78STobias Klauser 5131de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5132de7d4f0eSAndy Whitcroft# storage class and type. 51339c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 51349c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5135000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5136000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5137de7d4f0eSAndy Whitcroft } 5138de7d4f0eSAndy Whitcroft 51398905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 51402b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51412b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5142d5e616fcSJoe Perches if (WARN("INLINE", 5143d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5144d5e616fcSJoe Perches $fix) { 5145194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5146d5e616fcSJoe Perches 5147d5e616fcSJoe Perches } 51488905a67cSAndy Whitcroft } 51498905a67cSAndy Whitcroft 51503d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 51512b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51522b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5153000d1cc1SJoe Perches WARN("PREFER_PACKED", 5154000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 51553d130fd0SJoe Perches } 51563d130fd0SJoe Perches 515739b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 51582b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51592b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5160000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5161000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 516239b7e287SJoe Perches } 516339b7e287SJoe Perches 51645f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 51652b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51662b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5167d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5168d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5169d5e616fcSJoe Perches $fix) { 5170194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5171d5e616fcSJoe Perches 5172d5e616fcSJoe Perches } 51735f14d3bdSJoe Perches } 51745f14d3bdSJoe Perches 51756061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 51762b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51772b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5178d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5179d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5180d5e616fcSJoe Perches $fix) { 5181194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5182d5e616fcSJoe Perches } 51836061d949SJoe Perches } 51846061d949SJoe Perches 5185619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5186619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5187619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5188619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5189619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5190619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5191619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5192619a908aSJoe Perches } 5193619a908aSJoe Perches 5194e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5195e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5196e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5197e6176fa4SJoe Perches my $type = $1; 5198e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5199e6176fa4SJoe Perches $type = $1; 5200e6176fa4SJoe Perches my $kernel_type = 'u'; 5201e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5202e6176fa4SJoe Perches $type =~ /(\d+)/; 5203e6176fa4SJoe Perches $kernel_type .= $1; 5204e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5205e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5206e6176fa4SJoe Perches $fix) { 5207e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5208e6176fa4SJoe Perches } 5209e6176fa4SJoe Perches } 5210e6176fa4SJoe Perches } 5211e6176fa4SJoe Perches 52128f53a9b8SJoe Perches# check for sizeof(&) 52138f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5214000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5215000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 52168f53a9b8SJoe Perches } 52178f53a9b8SJoe Perches 521866c80b60SJoe Perches# check for sizeof without parenthesis 521966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5220d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5221d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5222d5e616fcSJoe Perches $fix) { 5223194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5224d5e616fcSJoe Perches } 522566c80b60SJoe Perches } 522666c80b60SJoe Perches 522788982feaSJoe Perches# check for struct spinlock declarations 522888982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 522988982feaSJoe Perches WARN("USE_SPINLOCK_T", 523088982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 523188982feaSJoe Perches } 523288982feaSJoe Perches 5233a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 523406668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5235a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5236caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5237caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5238d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5239d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5240d5e616fcSJoe Perches $fix) { 5241194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5242d5e616fcSJoe Perches } 5243a6962d72SJoe Perches } 5244a6962d72SJoe Perches } 5245a6962d72SJoe Perches 5246554e165cSAndy Whitcroft# Check for misused memsets 5247d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5248d1fe9c09SJoe Perches defined $stat && 52499e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5250554e165cSAndy Whitcroft 5251d7c76ba7SJoe Perches my $ms_addr = $2; 5252d1fe9c09SJoe Perches my $ms_val = $7; 5253d1fe9c09SJoe Perches my $ms_size = $12; 5254d7c76ba7SJoe Perches 5255554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5256554e165cSAndy Whitcroft ERROR("MEMSET", 5257d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5258554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5259554e165cSAndy Whitcroft WARN("MEMSET", 5260d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5261d7c76ba7SJoe Perches } 5262d7c76ba7SJoe Perches } 5263d7c76ba7SJoe Perches 526498a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 526598a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 526610895d2cSMateusz Kulikowski defined $stat && 526710895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 526898a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 526910895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 527098a9bba5SJoe Perches $fix) { 5271194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 527298a9bba5SJoe Perches } 527398a9bba5SJoe Perches } 527498a9bba5SJoe Perches 5275b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5276b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5277b6117d17SMateusz Kulikowski defined $stat && 5278b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5279b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5280b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5281b6117d17SMateusz Kulikowski } 5282b6117d17SMateusz Kulikowski 52838617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 52848617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 52858617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 52868617cd09SMateusz Kulikowski defined $stat && 52878617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 52888617cd09SMateusz Kulikowski 52898617cd09SMateusz Kulikowski my $ms_val = $7; 52908617cd09SMateusz Kulikowski 52918617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 52928617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 52938617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 52948617cd09SMateusz Kulikowski $fix) { 52958617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 52968617cd09SMateusz Kulikowski } 52978617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 52988617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 52998617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 53008617cd09SMateusz Kulikowski $fix) { 53018617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 53028617cd09SMateusz Kulikowski } 53038617cd09SMateusz Kulikowski } 53048617cd09SMateusz Kulikowski } 53058617cd09SMateusz Kulikowski 5306d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5307d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5308d1fe9c09SJoe Perches defined $stat && 5309d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5310d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5311d7c76ba7SJoe Perches my $call = $1; 5312d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5313d7c76ba7SJoe Perches my $arg1 = $3; 5314d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5315d1fe9c09SJoe Perches my $arg2 = $8; 5316d7c76ba7SJoe Perches my $cast; 5317d7c76ba7SJoe Perches 5318d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5319d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5320d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5321d7c76ba7SJoe Perches $cast = $cast1; 5322d7c76ba7SJoe Perches } else { 5323d7c76ba7SJoe Perches $cast = $cast2; 5324d7c76ba7SJoe Perches } 5325d7c76ba7SJoe Perches WARN("MINMAX", 5326d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5327554e165cSAndy Whitcroft } 5328554e165cSAndy Whitcroft } 5329554e165cSAndy Whitcroft 53304a273195SJoe Perches# check usleep_range arguments 53314a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 53324a273195SJoe Perches defined $stat && 53334a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 53344a273195SJoe Perches my $min = $1; 53354a273195SJoe Perches my $max = $7; 53364a273195SJoe Perches if ($min eq $max) { 53374a273195SJoe Perches WARN("USLEEP_RANGE", 53384a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 53394a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 53404a273195SJoe Perches $min > $max) { 53414a273195SJoe Perches WARN("USLEEP_RANGE", 53424a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 53434a273195SJoe Perches } 53444a273195SJoe Perches } 53454a273195SJoe Perches 5346823b794cSJoe Perches# check for naked sscanf 5347823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5348823b794cSJoe Perches defined $stat && 53496c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5350823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5351823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5352823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5353823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5354823b794cSJoe Perches $lc = $lc + $linenr; 5355823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5356823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5357823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5358823b794cSJoe Perches } 5359823b794cSJoe Perches WARN("NAKED_SSCANF", 5360823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5361823b794cSJoe Perches } 5362823b794cSJoe Perches 5363afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5364afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5365afc819abSJoe Perches defined $stat && 5366afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5367afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5368afc819abSJoe Perches $lc = $lc + $linenr; 5369afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5370afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5371afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5372afc819abSJoe Perches } 5373afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5374afc819abSJoe Perches my $format = $6; 5375afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5376afc819abSJoe Perches if ($count == 1 && 5377afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5378afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5379afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5380afc819abSJoe Perches } 5381afc819abSJoe Perches } 5382afc819abSJoe Perches } 5383afc819abSJoe Perches 538470dc8a48SJoe Perches# check for new externs in .h files. 538570dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 538670dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5387d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 538870dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 538970dc8a48SJoe Perches $fix) { 5390194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 539170dc8a48SJoe Perches } 539270dc8a48SJoe Perches } 539370dc8a48SJoe Perches 5394de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5395171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5396c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5397171ae1a4SAndy Whitcroft { 5398c45dcabdSAndy Whitcroft my $function_name = $1; 5399c45dcabdSAndy Whitcroft my $paren_space = $2; 5400171ae1a4SAndy Whitcroft 5401171ae1a4SAndy Whitcroft my $s = $stat; 5402171ae1a4SAndy Whitcroft if (defined $cond) { 5403171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5404171ae1a4SAndy Whitcroft } 5405c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5406c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5407c45dcabdSAndy Whitcroft { 5408000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5409000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5410de7d4f0eSAndy Whitcroft } 5411de7d4f0eSAndy Whitcroft 5412171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5413000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5414000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5415171ae1a4SAndy Whitcroft } 54169c9ba34eSAndy Whitcroft 54179c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 54189c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 54199c9ba34eSAndy Whitcroft { 5420000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5421000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5422171ae1a4SAndy Whitcroft } 5423171ae1a4SAndy Whitcroft 5424de7d4f0eSAndy Whitcroft# checks for new __setup's 5425de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5426de7d4f0eSAndy Whitcroft my $name = $1; 5427de7d4f0eSAndy Whitcroft 5428de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5429000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5430000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5431de7d4f0eSAndy Whitcroft } 5432653d4876SAndy Whitcroft } 54339c0ca6f9SAndy Whitcroft 54349c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5435caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5436000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5437000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 54389c0ca6f9SAndy Whitcroft } 543913214adfSAndy Whitcroft 5440a640d25cSJoe Perches# alloc style 5441a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5442a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5443a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5444a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5445a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5446a640d25cSJoe Perches } 5447a640d25cSJoe Perches 544860a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 544960a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5450e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 545160a55369SJoe Perches my $oldfunc = $3; 545260a55369SJoe Perches my $a1 = $4; 545360a55369SJoe Perches my $a2 = $10; 545460a55369SJoe Perches my $newfunc = "kmalloc_array"; 545560a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 545660a55369SJoe Perches my $r1 = $a1; 545760a55369SJoe Perches my $r2 = $a2; 545860a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 545960a55369SJoe Perches $r1 = $a2; 546060a55369SJoe Perches $r2 = $a1; 546160a55369SJoe Perches } 5462e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5463e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5464e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5465e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5466e367455aSJoe Perches $fix) { 5467194f66fcSJoe 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; 546860a55369SJoe Perches 546960a55369SJoe Perches } 547060a55369SJoe Perches } 547160a55369SJoe Perches } 547260a55369SJoe Perches 5473972fdea2SJoe Perches# check for krealloc arg reuse 5474972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5475972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5476972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5477972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5478972fdea2SJoe Perches } 5479972fdea2SJoe Perches 54805ce59ae0SJoe Perches# check for alloc argument mismatch 54815ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 54825ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 54835ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 54845ce59ae0SJoe Perches } 54855ce59ae0SJoe Perches 5486caf2a54fSJoe Perches# check for multiple semicolons 5487caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5488d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5489d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5490d5e616fcSJoe Perches $fix) { 5491194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5492d5e616fcSJoe Perches } 5493d1e2ad07SJoe Perches } 5494d1e2ad07SJoe Perches 54950ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 54960ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 54970ab90191SJoe Perches my $ull = ""; 54980ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 54990ab90191SJoe Perches if (CHK("BIT_MACRO", 55000ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 55010ab90191SJoe Perches $fix) { 55020ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 55030ab90191SJoe Perches } 55040ab90191SJoe Perches } 55050ab90191SJoe Perches 5506e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5507c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5508c34c09a8SJoe Perches my $has_break = 0; 5509c34c09a8SJoe Perches my $has_statement = 0; 5510c34c09a8SJoe Perches my $count = 0; 5511c34c09a8SJoe Perches my $prevline = $linenr; 5512e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5513c34c09a8SJoe Perches $prevline--; 5514c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5515c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5516c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5517c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5518c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5519c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5520c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5521c34c09a8SJoe Perches $has_statement = 1; 5522c34c09a8SJoe Perches $count++; 5523c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5524c34c09a8SJoe Perches } 5525c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5526c34c09a8SJoe Perches WARN("MISSING_BREAK", 5527c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5528c34c09a8SJoe Perches } 5529c34c09a8SJoe Perches } 5530c34c09a8SJoe Perches 5531d1e2ad07SJoe Perches# check for switch/default statements without a break; 5532d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5533d1e2ad07SJoe Perches defined $stat && 5534d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5535d1e2ad07SJoe Perches my $ctx = ''; 5536d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5537d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5538d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5539d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5540d1e2ad07SJoe Perches } 5541d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5542d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5543caf2a54fSJoe Perches } 5544caf2a54fSJoe Perches 554513214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5546d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5547d5e616fcSJoe Perches if (WARN("USE_FUNC", 5548d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5549d5e616fcSJoe Perches $fix) { 5550194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5551d5e616fcSJoe Perches } 555213214adfSAndy Whitcroft } 5553773647a0SAndy Whitcroft 555462ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 555562ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 555662ec818fSJoe Perches ERROR("DATE_TIME", 555762ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 555862ec818fSJoe Perches } 555962ec818fSJoe Perches 55602c92488aSJoe Perches# check for use of yield() 55612c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 55622c92488aSJoe Perches WARN("YIELD", 55632c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 55642c92488aSJoe Perches } 55652c92488aSJoe Perches 5566179f8f40SJoe Perches# check for comparisons against true and false 5567179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5568179f8f40SJoe Perches my $lead = $1; 5569179f8f40SJoe Perches my $arg = $2; 5570179f8f40SJoe Perches my $test = $3; 5571179f8f40SJoe Perches my $otype = $4; 5572179f8f40SJoe Perches my $trail = $5; 5573179f8f40SJoe Perches my $op = "!"; 5574179f8f40SJoe Perches 5575179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5576179f8f40SJoe Perches 5577179f8f40SJoe Perches my $type = lc($otype); 5578179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5579179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5580179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5581179f8f40SJoe Perches $op = ""; 5582179f8f40SJoe Perches } 5583179f8f40SJoe Perches 5584179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5585179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5586179f8f40SJoe Perches 5587179f8f40SJoe Perches## maybe suggesting a correct construct would better 5588179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5589179f8f40SJoe Perches 5590179f8f40SJoe Perches } 5591179f8f40SJoe Perches } 5592179f8f40SJoe Perches 55934882720bSThomas Gleixner# check for semaphores initialized locked 55944882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5595000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5596000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5597773647a0SAndy Whitcroft } 55986712d858SJoe Perches 559967d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 560067d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5601000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 560267d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5603773647a0SAndy Whitcroft } 56046712d858SJoe Perches 5605ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5606f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5607000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5608ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5609f3db6639SMichael Ellerman } 56106712d858SJoe Perches 56110f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 56120f3c5aabSJoe Perches my $const_structs = qr{ 56130f3c5aabSJoe Perches acpi_dock_ops| 561479404849SEmese Revfy address_space_operations| 561579404849SEmese Revfy backlight_ops| 561679404849SEmese Revfy block_device_operations| 561779404849SEmese Revfy dentry_operations| 561879404849SEmese Revfy dev_pm_ops| 561979404849SEmese Revfy dma_map_ops| 562079404849SEmese Revfy extent_io_ops| 562179404849SEmese Revfy file_lock_operations| 562279404849SEmese Revfy file_operations| 562379404849SEmese Revfy hv_ops| 562479404849SEmese Revfy ide_dma_ops| 562579404849SEmese Revfy intel_dvo_dev_ops| 562679404849SEmese Revfy item_operations| 562779404849SEmese Revfy iwl_ops| 562879404849SEmese Revfy kgdb_arch| 562979404849SEmese Revfy kgdb_io| 563079404849SEmese Revfy kset_uevent_ops| 563179404849SEmese Revfy lock_manager_operations| 563279404849SEmese Revfy microcode_ops| 563379404849SEmese Revfy mtrr_ops| 563479404849SEmese Revfy neigh_ops| 563579404849SEmese Revfy nlmsvc_binding| 56360f3c5aabSJoe Perches of_device_id| 563779404849SEmese Revfy pci_raw_ops| 563879404849SEmese Revfy pipe_buf_operations| 563979404849SEmese Revfy platform_hibernation_ops| 564079404849SEmese Revfy platform_suspend_ops| 564179404849SEmese Revfy proto_ops| 564279404849SEmese Revfy rpc_pipe_ops| 564379404849SEmese Revfy seq_operations| 564479404849SEmese Revfy snd_ac97_build_ops| 564579404849SEmese Revfy soc_pcmcia_socket_ops| 564679404849SEmese Revfy stacktrace_ops| 564779404849SEmese Revfy sysfs_ops| 564879404849SEmese Revfy tty_operations| 56496d07d01bSJoe Perches uart_ops| 565079404849SEmese Revfy usb_mon_operations| 565179404849SEmese Revfy wd_ops}x; 56526903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 56530f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5654000d1cc1SJoe Perches WARN("CONST_STRUCT", 5655000d1cc1SJoe Perches "struct $1 should normally be const\n" . 56566903ffb2SAndy Whitcroft $herecurr); 56572b6db5cbSAndy Whitcroft } 5658773647a0SAndy Whitcroft 5659773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5660773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5661773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5662c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5663c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5664171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5665171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5666171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5667773647a0SAndy Whitcroft { 5668000d1cc1SJoe Perches WARN("NR_CPUS", 5669000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5670773647a0SAndy Whitcroft } 56719c9ba34eSAndy Whitcroft 567252ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 567352ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 567452ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 567552ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 567652ea8506SJoe Perches } 567752ea8506SJoe Perches 5678acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5679acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5680acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5681acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5682acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5683acd9362cSJoe Perches } 5684acd9362cSJoe Perches 5685691d77b6SAndy Whitcroft# whine mightly about in_atomic 5686691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5687691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5688000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5689000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5690f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5691000d1cc1SJoe Perches WARN("IN_ATOMIC", 5692000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5693691d77b6SAndy Whitcroft } 5694691d77b6SAndy Whitcroft } 56951704f47bSPeter Zijlstra 56961704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 56971704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 56981704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 56991704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 57001704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 57011704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5702000d1cc1SJoe Perches ERROR("LOCKDEP", 5703000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 57041704f47bSPeter Zijlstra } 57051704f47bSPeter Zijlstra } 570688f8831cSDave Jones 5707b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5708b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5709000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5710000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 571188f8831cSDave Jones } 57122435880fSJoe Perches 5713515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5714515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5715515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5716515a235eSJoe Perches $line =~ /$mode_perms_search/) { 57172435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 57182435880fSJoe Perches my $func = $entry->[0]; 57192435880fSJoe Perches my $arg_pos = $entry->[1]; 57202435880fSJoe Perches 57212435880fSJoe Perches my $skip_args = ""; 57222435880fSJoe Perches if ($arg_pos > 1) { 57232435880fSJoe Perches $arg_pos--; 57242435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 57252435880fSJoe Perches } 57262435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5727515a235eSJoe Perches if ($line =~ /$test/) { 57282435880fSJoe Perches my $val = $1; 57292435880fSJoe Perches $val = $6 if ($skip_args ne ""); 57302435880fSJoe Perches 57311727cc70SJoe Perches if ($val !~ /^0$/ && 57321727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 57331727cc70SJoe Perches length($val) ne 4)) { 57342435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 57351727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5736c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5737c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5738c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 57392435880fSJoe Perches } 57402435880fSJoe Perches } 57412435880fSJoe Perches } 574213214adfSAndy Whitcroft } 57435a6d20ceSBjorn Andersson 57445a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 57455a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 57465a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 57475a6d20ceSBjorn Andersson my $valid_licenses = qr{ 57485a6d20ceSBjorn Andersson GPL| 57495a6d20ceSBjorn Andersson GPL\ v2| 57505a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 57515a6d20ceSBjorn Andersson Dual\ BSD/GPL| 57525a6d20ceSBjorn Andersson Dual\ MIT/GPL| 57535a6d20ceSBjorn Andersson Dual\ MPL/GPL| 57545a6d20ceSBjorn Andersson Proprietary 57555a6d20ceSBjorn Andersson }x; 57565a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 57575a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 57585a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 57595a6d20ceSBjorn Andersson } 57605a6d20ceSBjorn Andersson } 5761515a235eSJoe Perches } 576213214adfSAndy Whitcroft 576313214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 576413214adfSAndy Whitcroft # so just keep quiet. 576513214adfSAndy Whitcroft if ($#rawlines == -1) { 576613214adfSAndy Whitcroft exit(0); 57670a920b5bSAndy Whitcroft } 57680a920b5bSAndy Whitcroft 57698905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 57708905a67cSAndy Whitcroft # things that appear to be patches. 57718905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 57728905a67cSAndy Whitcroft exit(0); 57738905a67cSAndy Whitcroft } 57748905a67cSAndy Whitcroft 57758905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 57768905a67cSAndy Whitcroft # just keep quiet. 57778905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 57788905a67cSAndy Whitcroft exit(0); 57798905a67cSAndy Whitcroft } 57808905a67cSAndy Whitcroft 578106330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5782000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5783000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 57840a920b5bSAndy Whitcroft } 578534d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5786000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5787000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 57880a920b5bSAndy Whitcroft } 57890a920b5bSAndy Whitcroft 5790f0a594c1SAndy Whitcroft print report_dump(); 579113214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 579213214adfSAndy Whitcroft print "$filename " if ($summary_file); 57936c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 57946c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 57956c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 57966c72ffaaSAndy Whitcroft } 57978905a67cSAndy Whitcroft 5798d2c0a235SAndy Whitcroft if ($quiet == 0) { 5799d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5800d2c0a235SAndy Whitcroft # then suggest that. 5801d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5802b0781216SMike Frysinger $rpt_cleaners = 0; 5803d8469f16SJoe Perches print << "EOM" 5804d8469f16SJoe Perches 5805d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5806d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5807d8469f16SJoe PerchesEOM 5808d2c0a235SAndy Whitcroft } 5809d2c0a235SAndy Whitcroft } 5810d2c0a235SAndy Whitcroft 5811d752fcc8SJoe Perches if ($clean == 0 && $fix && 5812d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5813d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 58149624b8d6SJoe Perches my $newfile = $filename; 58159624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 58163705ce5bSJoe Perches my $linecount = 0; 58173705ce5bSJoe Perches my $f; 58183705ce5bSJoe Perches 5819d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5820d752fcc8SJoe Perches 58213705ce5bSJoe Perches open($f, '>', $newfile) 58223705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 58233705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 58243705ce5bSJoe Perches $linecount++; 58253705ce5bSJoe Perches if ($file) { 58263705ce5bSJoe Perches if ($linecount > 3) { 58273705ce5bSJoe Perches $fixed_line =~ s/^\+//; 58283705ce5bSJoe Perches print $f $fixed_line . "\n"; 58293705ce5bSJoe Perches } 58303705ce5bSJoe Perches } else { 58313705ce5bSJoe Perches print $f $fixed_line . "\n"; 58323705ce5bSJoe Perches } 58333705ce5bSJoe Perches } 58343705ce5bSJoe Perches close($f); 58353705ce5bSJoe Perches 58363705ce5bSJoe Perches if (!$quiet) { 58373705ce5bSJoe Perches print << "EOM"; 5838d8469f16SJoe Perches 58393705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 58403705ce5bSJoe Perches 58413705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 58423705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 58433705ce5bSJoe Perches 58443705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 58453705ce5bSJoe PerchesNo warranties, expressed or implied... 58463705ce5bSJoe PerchesEOM 58473705ce5bSJoe Perches } 58483705ce5bSJoe Perches } 58493705ce5bSJoe Perches 5850d8469f16SJoe Perches if ($quiet == 0) { 5851d8469f16SJoe Perches print "\n"; 5852d8469f16SJoe Perches if ($clean == 1) { 5853d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5854d8469f16SJoe Perches } else { 5855d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 58560a920b5bSAndy Whitcroft } 58570a920b5bSAndy Whitcroft } 58580a920b5bSAndy Whitcroft return $clean; 58590a920b5bSAndy Whitcroft} 5860