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; 19560a920b5bSAndy Whitcroft 195729ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 195815662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 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) { 216934d8815fSJoe Perches $prefix = "$filename:$linenr: "; 217034d8815fSJoe Perches } 217134d8815fSJoe Perches 21722ac73b4fSJoe Perches if ($found_file) { 21732ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 21742ac73b4fSJoe Perches $check = 1; 21752ac73b4fSJoe Perches } else { 21762ac73b4fSJoe Perches $check = $check_orig; 21772ac73b4fSJoe Perches } 2178773647a0SAndy Whitcroft next; 2179773647a0SAndy Whitcroft } 2180773647a0SAndy Whitcroft 2181389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21820a920b5bSAndy Whitcroft 2183c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2184c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2185c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21860a920b5bSAndy Whitcroft 21876c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21886c72ffaaSAndy Whitcroft 2189e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch 2190e518e9a5SJoe Perches if ($in_commit_log && !$commit_log_has_diff && 2191e518e9a5SJoe Perches (($line =~ m@^\s+diff\b.*a/[\w/]+@ && 2192e518e9a5SJoe Perches $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) || 2193e518e9a5SJoe Perches $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2194e518e9a5SJoe Perches $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2195e518e9a5SJoe Perches ERROR("DIFF_IN_COMMIT_MSG", 2196e518e9a5SJoe Perches "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2197e518e9a5SJoe Perches $commit_log_has_diff = 1; 2198e518e9a5SJoe Perches } 2199e518e9a5SJoe Perches 22003bf9a009SRabin Vincent# Check for incorrect file permissions 22013bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 22023bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 220304db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 220404db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2205000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2206000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 22073bf9a009SRabin Vincent } 22083bf9a009SRabin Vincent } 22093bf9a009SRabin Vincent 221020112475SJoe Perches# Check the patch for a signoff: 2211d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 22124a0df2efSAndy Whitcroft $signoff++; 221315662b3eSJoe Perches $in_commit_log = 0; 22140a920b5bSAndy Whitcroft } 221520112475SJoe Perches 2216e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2217e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2218e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2219e0d975b1SJoe Perches $reported_maintainer_file = 1; 2220e0d975b1SJoe Perches } 2221e0d975b1SJoe Perches 222220112475SJoe Perches# Check signature styles 2223270c49a0SJoe Perches if (!$in_header_lines && 2224ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 222520112475SJoe Perches my $space_before = $1; 222620112475SJoe Perches my $sign_off = $2; 222720112475SJoe Perches my $space_after = $3; 222820112475SJoe Perches my $email = $4; 222920112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 223020112475SJoe Perches 2231ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2232ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2233ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2234ce0338dfSJoe Perches } 223520112475SJoe Perches if (defined $space_before && $space_before ne "") { 22363705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22373705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 22383705ce5bSJoe Perches $fix) { 2239194f66fcSJoe Perches $fixed[$fixlinenr] = 22403705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22413705ce5bSJoe Perches } 224220112475SJoe Perches } 224320112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 22443705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22453705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 22463705ce5bSJoe Perches $fix) { 2247194f66fcSJoe Perches $fixed[$fixlinenr] = 22483705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22493705ce5bSJoe Perches } 22503705ce5bSJoe Perches 225120112475SJoe Perches } 225220112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 22533705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 22543705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 22553705ce5bSJoe Perches $fix) { 2256194f66fcSJoe Perches $fixed[$fixlinenr] = 22573705ce5bSJoe Perches "$ucfirst_sign_off $email"; 22583705ce5bSJoe Perches } 225920112475SJoe Perches } 226020112475SJoe Perches 226120112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 226220112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 226320112475SJoe Perches if ($suggested_email eq "") { 2264000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2265000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 226620112475SJoe Perches } else { 226720112475SJoe Perches my $dequoted = $suggested_email; 226820112475SJoe Perches $dequoted =~ s/^"//; 226920112475SJoe Perches $dequoted =~ s/" </ </; 227020112475SJoe Perches # Don't force email to have quotes 227120112475SJoe Perches # Allow just an angle bracketed address 227220112475SJoe Perches if ("$dequoted$comment" ne $email && 227320112475SJoe Perches "<$email_address>$comment" ne $email && 227420112475SJoe Perches "$suggested_email$comment" ne $email) { 2275000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2276000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 227720112475SJoe Perches } 22780a920b5bSAndy Whitcroft } 22797e51f197SJoe Perches 22807e51f197SJoe Perches# Check for duplicate signatures 22817e51f197SJoe Perches my $sig_nospace = $line; 22827e51f197SJoe Perches $sig_nospace =~ s/\s//g; 22837e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 22847e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 22857e51f197SJoe Perches WARN("BAD_SIGN_OFF", 22867e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 22877e51f197SJoe Perches } else { 22887e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22897e51f197SJoe Perches } 22900a920b5bSAndy Whitcroft } 22910a920b5bSAndy Whitcroft 2292a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2293a2fe16b9SJoe Perches if ($in_header_lines && 2294a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2295a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2296a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2297a2fe16b9SJoe Perches } 2298a2fe16b9SJoe Perches 22999b3189ebSJoe Perches# Check for old stable address 23009b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 23019b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 23029b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 23039b3189ebSJoe Perches } 23049b3189ebSJoe Perches 23057ebd05efSChristopher Covington# Check for unwanted Gerrit info 23067ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 23077ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 23087ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 23097ebd05efSChristopher Covington } 23107ebd05efSChristopher Covington 23112a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once 23122a076f40SJoe Perches if ($in_commit_log && !$commit_log_long_line && 23132a076f40SJoe Perches length($line) > 75) { 23142a076f40SJoe Perches WARN("COMMIT_LOG_LONG_LINE", 23152a076f40SJoe Perches "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 23162a076f40SJoe Perches $commit_log_long_line = 1; 23172a076f40SJoe Perches } 23182a076f40SJoe Perches 23190d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 2320fe043ea1SJoe Perches if ($in_commit_log && 2321fe043ea1SJoe Perches ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 2322fe043ea1SJoe Perches $line =~ /\b[0-9a-f]{12,40}\b/i)) { 2323fe043ea1SJoe Perches my $init_char = "c"; 2324fe043ea1SJoe Perches my $orig_commit = ""; 23250d7835fcSJoe Perches my $short = 1; 23260d7835fcSJoe Perches my $long = 0; 23270d7835fcSJoe Perches my $case = 1; 23280d7835fcSJoe Perches my $space = 1; 23290d7835fcSJoe Perches my $hasdesc = 0; 233019c146a6SJoe Perches my $hasparens = 0; 23310d7835fcSJoe Perches my $id = '0123456789ab'; 23320d7835fcSJoe Perches my $orig_desc = "commit description"; 23330d7835fcSJoe Perches my $description = ""; 23340d7835fcSJoe Perches 2335fe043ea1SJoe Perches if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 2336fe043ea1SJoe Perches $init_char = $1; 2337fe043ea1SJoe Perches $orig_commit = lc($2); 2338fe043ea1SJoe Perches } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 2339fe043ea1SJoe Perches $orig_commit = lc($1); 2340fe043ea1SJoe Perches } 2341fe043ea1SJoe Perches 23420d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23430d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23440d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 23450d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 23460d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 23470d7835fcSJoe Perches $orig_desc = $1; 234819c146a6SJoe Perches $hasparens = 1; 23490d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 23500d7835fcSJoe Perches defined $rawlines[$linenr] && 23510d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 23520d7835fcSJoe Perches $orig_desc = $1; 235319c146a6SJoe Perches $hasparens = 1; 2354b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2355b671fde0SJoe Perches defined $rawlines[$linenr] && 2356b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2357b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2358b671fde0SJoe Perches $orig_desc = $1; 2359b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2360b671fde0SJoe Perches $orig_desc .= " " . $1; 236119c146a6SJoe Perches $hasparens = 1; 23620d7835fcSJoe Perches } 23630d7835fcSJoe Perches 23640d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 23650d7835fcSJoe Perches $id, $orig_desc); 23660d7835fcSJoe Perches 236719c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2368d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 23690d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 23700d7835fcSJoe Perches } 2371d311cd44SJoe Perches } 2372d311cd44SJoe Perches 237313f1937eSJoe Perches# Check for added, moved or deleted files 237413f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 237513f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 237613f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 237713f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 237813f1937eSJoe Perches (defined($1) || defined($2))))) { 237913f1937eSJoe Perches $reported_maintainer_file = 1; 238013f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 238113f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 238213f1937eSJoe Perches } 238313f1937eSJoe Perches 238400df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 23858905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2386000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2387000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 23886c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2389de7d4f0eSAndy Whitcroft } 2390de7d4f0eSAndy Whitcroft 23916ecd9674SAndy Whitcroft# Check for absolute kernel paths. 23926ecd9674SAndy Whitcroft if ($tree) { 23936ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 23946ecd9674SAndy Whitcroft my $file = $1; 23956ecd9674SAndy Whitcroft 23966ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 23976ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 23986ecd9674SAndy Whitcroft # 23996ecd9674SAndy Whitcroft } else { 24006ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 24016ecd9674SAndy Whitcroft } 24026ecd9674SAndy Whitcroft } 24036ecd9674SAndy Whitcroft } 24046ecd9674SAndy Whitcroft 2405de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2406de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2407171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2408171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2409171ae1a4SAndy Whitcroft 2410171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2411171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2412171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2413171ae1a4SAndy Whitcroft 241434d99219SJoe Perches CHK("INVALID_UTF8", 2415000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 241600df344fSAndy Whitcroft } 24170a920b5bSAndy Whitcroft 241815662b3eSJoe Perches# Check if it's the start of a commit log 241915662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 242015662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 242129ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 242229ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 242315662b3eSJoe Perches $in_header_lines = 0; 242415662b3eSJoe Perches $in_commit_log = 1; 242515662b3eSJoe Perches } 242615662b3eSJoe Perches 2427fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2428fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2429fa64205dSPasi Savanainen if ($in_header_lines && 2430fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2431fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2432fa64205dSPasi Savanainen $non_utf8_charset = 1; 2433fa64205dSPasi Savanainen } 2434fa64205dSPasi Savanainen 2435fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 243615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2437fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 243815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 243915662b3eSJoe Perches } 244015662b3eSJoe Perches 244166b47b4aSKees Cook# Check for various typo / spelling mistakes 244266d7a382SJoe Perches if (defined($misspellings) && 244366d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2444ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 244566b47b4aSKees Cook my $typo = $1; 244666b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 244766b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 244866b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 244966b47b4aSKees Cook my $msg_type = \&WARN; 245066b47b4aSKees Cook $msg_type = \&CHK if ($file); 245166b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 245266b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 245366b47b4aSKees Cook $fix) { 245466b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 245566b47b4aSKees Cook } 245666b47b4aSKees Cook } 245766b47b4aSKees Cook } 245866b47b4aSKees Cook 245930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 246030670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 246100df344fSAndy Whitcroft 24620a920b5bSAndy Whitcroft#trailing whitespace 24639c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2464c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2465d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2466d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2467d5e616fcSJoe Perches $fix) { 2468194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2469d5e616fcSJoe Perches } 2470c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2471c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24723705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 24733705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 24743705ce5bSJoe Perches $fix) { 2475194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 24763705ce5bSJoe Perches } 24773705ce5bSJoe Perches 2478d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 24790a920b5bSAndy Whitcroft } 24805368df20SAndy Whitcroft 24814783f894SJosh Triplett# Check for FSF mailing addresses. 2482109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 24833e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 24843e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 24854783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24864783f894SJosh Triplett my $msg_type = \&ERROR; 24874783f894SJosh Triplett $msg_type = \&CHK if ($file); 24884783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 24894783f894SJosh 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) 24904783f894SJosh Triplett } 24914783f894SJosh Triplett 24923354957aSAndi Kleen# check for Kconfig help text having a real description 24939fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 24949fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 24953354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 24968d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 24973354957aSAndi Kleen my $length = 0; 24989fe287d7SAndy Whitcroft my $cnt = $realcnt; 24999fe287d7SAndy Whitcroft my $ln = $linenr + 1; 25009fe287d7SAndy Whitcroft my $f; 2501a1385803SAndy Whitcroft my $is_start = 0; 25029fe287d7SAndy Whitcroft my $is_end = 0; 2503a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 25049fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 25059fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 25069fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 25079fe287d7SAndy Whitcroft 25089fe287d7SAndy Whitcroft next if ($f =~ /^-/); 25098d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2510a1385803SAndy Whitcroft 25118d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2512a1385803SAndy Whitcroft $is_start = 1; 25138d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2514a1385803SAndy Whitcroft $length = -1; 2515a1385803SAndy Whitcroft } 2516a1385803SAndy Whitcroft 25179fe287d7SAndy Whitcroft $f =~ s/^.//; 25183354957aSAndi Kleen $f =~ s/#.*//; 25193354957aSAndi Kleen $f =~ s/^\s+//; 25203354957aSAndi Kleen next if ($f =~ /^$/); 25219fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 25229fe287d7SAndy Whitcroft $is_end = 1; 25239fe287d7SAndy Whitcroft last; 25249fe287d7SAndy Whitcroft } 25253354957aSAndi Kleen $length++; 25263354957aSAndi Kleen } 252756193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2528000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 252956193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 253056193274SVadim Bendebury } 2531a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25323354957aSAndi Kleen } 25333354957aSAndi Kleen 25341ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25351ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25361ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25371ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25381ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25391ba8dfd1SKees Cook } 25401ba8dfd1SKees Cook 2541327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2542327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2543327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2544327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2545327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2546327953e9SChristoph Jaeger } 2547327953e9SChristoph Jaeger 2548c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2549c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2550c68e5878SArnaud Lacombe my $flag = $1; 2551c68e5878SArnaud Lacombe my $replacement = { 2552c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2553c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2554c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2555c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2556c68e5878SArnaud Lacombe }; 2557c68e5878SArnaud Lacombe 2558c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2559c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2560c68e5878SArnaud Lacombe } 2561c68e5878SArnaud Lacombe 2562bff5da43SRob Herring# check for DT compatible documentation 25637dd05b38SFlorian Vaussard if (defined $root && 25647dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 25657dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 25667dd05b38SFlorian Vaussard 2567bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2568bff5da43SRob Herring 2569cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2570cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2571cc93319bSFlorian Vaussard 2572bff5da43SRob Herring foreach my $compat (@compats) { 2573bff5da43SRob Herring my $compat2 = $compat; 2574185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2575185d566bSRob Herring my $compat3 = $compat; 2576185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2577185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2578bff5da43SRob Herring if ( $? >> 8 ) { 2579bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2580bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2581bff5da43SRob Herring } 2582bff5da43SRob Herring 25834fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 25844fbf32a6SFlorian Vaussard my $vendor = $1; 2585cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2586bff5da43SRob Herring if ( $? >> 8 ) { 2587bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2588cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2589bff5da43SRob Herring } 2590bff5da43SRob Herring } 2591bff5da43SRob Herring } 2592bff5da43SRob Herring 25935368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2594de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 25955368df20SAndy Whitcroft 259647e0c88bSJoe Perches# line length limit (with some exclusions) 259747e0c88bSJoe Perches# 259847e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 259947e0c88bSJoe Perches# logging functions like pr_info that end in a string 260047e0c88bSJoe Perches# lines with a single string 260147e0c88bSJoe Perches# #defines that are a single string 260247e0c88bSJoe Perches# 260347e0c88bSJoe Perches# There are 3 different line length message types: 260447e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 260547e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 260647e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 260747e0c88bSJoe Perches# 260847e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 260947e0c88bSJoe Perches# 261047e0c88bSJoe Perches 2611b4749e96SJoe Perches if ($line =~ /^\+/ && $length > $max_line_length) { 261247e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 261347e0c88bSJoe Perches 261447e0c88bSJoe Perches # Check the allowed long line types first 261547e0c88bSJoe Perches 261647e0c88bSJoe Perches # logging functions that end in a string that starts 261747e0c88bSJoe Perches # before $max_line_length 261847e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 261947e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 262047e0c88bSJoe Perches $msg_type = ""; 262147e0c88bSJoe Perches 262247e0c88bSJoe Perches # lines with only strings (w/ possible termination) 262347e0c88bSJoe Perches # #defines with only strings 262447e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 262547e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 262647e0c88bSJoe Perches $msg_type = ""; 262747e0c88bSJoe Perches 262847e0c88bSJoe Perches # Otherwise set the alternate message types 262947e0c88bSJoe Perches 263047e0c88bSJoe Perches # a comment starts before $max_line_length 263147e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 263247e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 263347e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 263447e0c88bSJoe Perches 263547e0c88bSJoe Perches # a quoted string starts before $max_line_length 263647e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 263747e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 263847e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 263947e0c88bSJoe Perches } 264047e0c88bSJoe Perches 264147e0c88bSJoe Perches if ($msg_type ne "" && 264247e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 264347e0c88bSJoe Perches WARN($msg_type, 26446cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 26450a920b5bSAndy Whitcroft } 264647e0c88bSJoe Perches } 26470a920b5bSAndy Whitcroft 26488905a67cSAndy Whitcroft# check for adding lines without a newline. 26498905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2650000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2651000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 26528905a67cSAndy Whitcroft } 26538905a67cSAndy Whitcroft 265442e41c54SMike Frysinger# Blackfin: use hi/lo macros 265542e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 265642e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 265742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2658000d1cc1SJoe Perches ERROR("LO_MACRO", 2659000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 266042e41c54SMike Frysinger } 266142e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 266242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2663000d1cc1SJoe Perches ERROR("HI_MACRO", 2664000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 266542e41c54SMike Frysinger } 266642e41c54SMike Frysinger } 266742e41c54SMike Frysinger 2668b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2669de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 26700a920b5bSAndy Whitcroft 26710a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 26720a920b5bSAndy Whitcroft# more than 8 must use tabs. 2673c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2674c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2675c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2676d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26773705ce5bSJoe Perches if (ERROR("CODE_INDENT", 26783705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 26793705ce5bSJoe Perches $fix) { 2680194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 26813705ce5bSJoe Perches } 26820a920b5bSAndy Whitcroft } 26830a920b5bSAndy Whitcroft 268408e44365SAlberto Panizzo# check for space before tabs. 268508e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 268608e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26873705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 26883705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 26893705ce5bSJoe Perches $fix) { 2690194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2691d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2692194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2693c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 26943705ce5bSJoe Perches } 269508e44365SAlberto Panizzo } 269608e44365SAlberto Panizzo 2697d1fe9c09SJoe Perches# check for && or || at the start of a line 2698d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2699d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2700d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2701d1fe9c09SJoe Perches } 2702d1fe9c09SJoe Perches 2703d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2704d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 270591cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2706d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2707d1fe9c09SJoe Perches my $oldindent = $1; 2708d1fe9c09SJoe Perches my $rest = $2; 2709d1fe9c09SJoe Perches 2710d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2711d1fe9c09SJoe Perches if ($pos >= 0) { 2712b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2713b34a26f3SJoe Perches my $newindent = $2; 2714d1fe9c09SJoe Perches 2715d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2716d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2717d1fe9c09SJoe Perches " " x ($pos % 8); 2718d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2719d1fe9c09SJoe Perches 2720d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2721d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 27223705ce5bSJoe Perches 27233705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 27243705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27253705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2726194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27273705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27283705ce5bSJoe Perches } 2729d1fe9c09SJoe Perches } 2730d1fe9c09SJoe Perches } 2731d1fe9c09SJoe Perches } 2732d1fe9c09SJoe Perches 27336ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27346ab3a970SJoe Perches# avoid checking a few false positives: 27356ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27366ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27376ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27386ab3a970SJoe Perches# multiline macros that define functions 27396ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27406ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27416ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27423705ce5bSJoe Perches if (CHK("SPACING", 2743f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27443705ce5bSJoe Perches $fix) { 2745194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2746f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 27473705ce5bSJoe Perches } 2748aad4f614SJoe Perches } 2749aad4f614SJoe Perches 275005880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2751fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 275285ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 275385ad978cSJoe Perches $realline > 2) { 275405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 275505880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 275605880600SJoe Perches } 275705880600SJoe Perches 275805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2759a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2760a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 276161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2762a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2763a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2764a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2765a605e32eSJoe Perches } 2766a605e32eSJoe Perches 2767a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2768c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2769c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2770c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2771c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 277205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 277305880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 277405880600SJoe Perches } 277505880600SJoe Perches 27767f619191SJoe Perches# check for missing blank lines after struct/union declarations 27777f619191SJoe Perches# with exceptions for various attributes and macros 27787f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 27797f619191SJoe Perches $line =~ /^\+/ && 27807f619191SJoe Perches !($line =~ /^\+\s*$/ || 27817f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 27827f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 27837f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 27847f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 27857f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 27867f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 27877f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2788d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2789d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2790d752fcc8SJoe Perches $fix) { 2791f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2792d752fcc8SJoe Perches } 27937f619191SJoe Perches } 27947f619191SJoe Perches 2795365dd4eaSJoe Perches# check for multiple consecutive blank lines 2796365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2797365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2798365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2799d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2800d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2801d752fcc8SJoe Perches $fix) { 2802f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2803d752fcc8SJoe Perches } 2804d752fcc8SJoe Perches 2805365dd4eaSJoe Perches $last_blank_line = $linenr; 2806365dd4eaSJoe Perches } 2807365dd4eaSJoe Perches 28083b617e3bSJoe Perches# check for missing blank lines after declarations 28093f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 28103f7bac03SJoe Perches # actual declarations 28113f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28125a4e1fd3SJoe Perches # function pointer declarations 28135a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28143f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28153f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28163f7bac03SJoe Perches # known declaration macros 28173f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 28183f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 28193f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 28203f7bac03SJoe Perches # other possible extensions of declaration lines 28213f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 28223f7bac03SJoe Perches # not starting a section or a macro "\" extended line 28233f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 28243f7bac03SJoe Perches # looks like a declaration 28253f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28265a4e1fd3SJoe Perches # function pointer declarations 28275a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28283f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28293f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28303f7bac03SJoe Perches # known declaration macros 28313f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28323f7bac03SJoe Perches # start of struct or union or enum 28333b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28343f7bac03SJoe Perches # start or end of block or continuation of declaration 28353f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28363f7bac03SJoe Perches # bitfield continuation 28373f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28383f7bac03SJoe Perches # other possible extensions of declaration lines 28393f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28403f7bac03SJoe Perches # indentation of previous and current line are the same 28413f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2842d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2843d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2844d752fcc8SJoe Perches $fix) { 2845f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2846d752fcc8SJoe Perches } 28473b617e3bSJoe Perches } 28483b617e3bSJoe Perches 28495f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 28506b4c5bebSAndy Whitcroft# Exceptions: 28516b4c5bebSAndy Whitcroft# 1) within comments 28526b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 28536b4c5bebSAndy Whitcroft# 3) hanging labels 28543705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 28555f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28563705ce5bSJoe Perches if (WARN("LEADING_SPACE", 28573705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 28583705ce5bSJoe Perches $fix) { 2859194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28603705ce5bSJoe Perches } 28615f7ddae6SRaffaele Recalcati } 28625f7ddae6SRaffaele Recalcati 2863b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2864b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2865b9ea10d6SAndy Whitcroft 2866032a4c0fSJoe Perches# check indentation of any line with a bare else 2867840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2868032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2869032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2870032a4c0fSJoe Perches my $tabs = length($1) + 1; 2871840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2872840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2873840080a0SJoe Perches defined $lines[$linenr] && 2874840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2875032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2876032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2877032a4c0fSJoe Perches } 2878032a4c0fSJoe Perches } 2879032a4c0fSJoe Perches 2880c00df19aSJoe Perches# check indentation of a line with a break; 2881c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2882c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2883c00df19aSJoe Perches my $tabs = $1; 2884c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2885c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2886c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2887c00df19aSJoe Perches } 2888c00df19aSJoe Perches } 2889c00df19aSJoe Perches 28901ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 28911ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 28921ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 28931ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 28941ba8dfd1SKees Cook } 28951ba8dfd1SKees Cook 2896c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2897cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2898000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2899000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2900c2fdda0dSAndy Whitcroft } 290122f2a2efSAndy Whitcroft 290242e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 290342e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 290442e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2905000d1cc1SJoe Perches ERROR("CSYNC", 2906000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 290742e41c54SMike Frysinger } 290842e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 290942e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2910000d1cc1SJoe Perches ERROR("SSYNC", 2911000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 291242e41c54SMike Frysinger } 291342e41c54SMike Frysinger 291456e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 291556e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 291656e77d70SJoe Perches WARN("HOTPLUG_SECTION", 291756e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 291856e77d70SJoe Perches } 291956e77d70SJoe Perches 29209c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 29212b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 29222b474a1aSAndy Whitcroft $realline_next); 29233e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 29243e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29251b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2926170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2927f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2928171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2929171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2930171ae1a4SAndy Whitcroft 29313e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29323e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29333e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29343e469cdcSAndy Whitcroft # until we hit end of it. 29353e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29363e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29373e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29383e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29393e469cdcSAndy Whitcroft } 2940f74bd194SAndy Whitcroft 29412b474a1aSAndy Whitcroft # Find the real next line. 29422b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 29432b474a1aSAndy Whitcroft if (defined $realline_next && 29442b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 29452b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 29462b474a1aSAndy Whitcroft $realline_next++; 29472b474a1aSAndy Whitcroft } 29482b474a1aSAndy Whitcroft 2949171ae1a4SAndy Whitcroft my $s = $stat; 2950171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2951cf655043SAndy Whitcroft 2952c2fdda0dSAndy Whitcroft # Ignore goto labels. 2953171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2954c2fdda0dSAndy Whitcroft 2955c2fdda0dSAndy Whitcroft # Ignore functions being called 2956171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2957c2fdda0dSAndy Whitcroft 2958463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2959463f2864SAndy Whitcroft 2960c45dcabdSAndy Whitcroft # declarations always start with types 2961d2506586SAndy 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) { 2962c45dcabdSAndy Whitcroft my $type = $1; 2963c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2964c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2965c45dcabdSAndy Whitcroft 29666c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2967a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2968c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2969c2fdda0dSAndy Whitcroft } 29708905a67cSAndy Whitcroft 29716c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 297265863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2973c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 29749c0ca6f9SAndy Whitcroft } 29758905a67cSAndy Whitcroft 29768905a67cSAndy Whitcroft # Check for any sort of function declaration. 29778905a67cSAndy Whitcroft # int foo(something bar, other baz); 29788905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2979171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 29808905a67cSAndy Whitcroft my ($name_len) = length($1); 29818905a67cSAndy Whitcroft 2982cf655043SAndy Whitcroft my $ctx = $s; 2983773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 29848905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2985cf655043SAndy Whitcroft 29868905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2987c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 29888905a67cSAndy Whitcroft 2989c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 29908905a67cSAndy Whitcroft } 29918905a67cSAndy Whitcroft } 29928905a67cSAndy Whitcroft } 29938905a67cSAndy Whitcroft 29949c0ca6f9SAndy Whitcroft } 29959c0ca6f9SAndy Whitcroft 299600df344fSAndy Whitcroft# 299700df344fSAndy Whitcroft# Checks which may be anchored in the context. 299800df344fSAndy Whitcroft# 299900df344fSAndy Whitcroft 300000df344fSAndy Whitcroft# Check for switch () and associated case and default 300100df344fSAndy Whitcroft# statements should be at the same indent. 300200df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 300300df344fSAndy Whitcroft my $err = ''; 300400df344fSAndy Whitcroft my $sep = ''; 300500df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 300600df344fSAndy Whitcroft shift(@ctx); 300700df344fSAndy Whitcroft for my $ctx (@ctx) { 300800df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 300900df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 301000df344fSAndy Whitcroft $indent != $cindent) { 301100df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 301200df344fSAndy Whitcroft $sep = ''; 301300df344fSAndy Whitcroft } else { 301400df344fSAndy Whitcroft $sep = "[...]\n"; 301500df344fSAndy Whitcroft } 301600df344fSAndy Whitcroft } 301700df344fSAndy Whitcroft if ($err ne '') { 3018000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3019000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3020de7d4f0eSAndy Whitcroft } 3021de7d4f0eSAndy Whitcroft } 3022de7d4f0eSAndy Whitcroft 3023de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3024de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30250fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3026773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3027773647a0SAndy Whitcroft 30289c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30298eef05ddSJoe Perches 30308eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30318eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30328eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30338eef05ddSJoe Perches } 30348eef05ddSJoe Perches 3035de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3036de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3037de7d4f0eSAndy Whitcroft 3038548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3039548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3040de7d4f0eSAndy Whitcroft 3041548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3042548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3043548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3044548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3045548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3046773647a0SAndy Whitcroft $ctx_ln++; 3047773647a0SAndy Whitcroft } 3048548596d5SAndy Whitcroft 304953210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 305053210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3051773647a0SAndy Whitcroft 3052773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3053000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3054000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 305501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 305600df344fSAndy Whitcroft } 3057773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3058773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3059773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3060773647a0SAndy Whitcroft { 30619c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 30629c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3063000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3064000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 306501464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 30669c0ca6f9SAndy Whitcroft } 30679c0ca6f9SAndy Whitcroft } 306800df344fSAndy Whitcroft } 306900df344fSAndy Whitcroft 30704d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 30710fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 30723e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 30733e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 30743e469cdcSAndy Whitcroft if (!defined $stat); 30754d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 30764d001e4dSAndy Whitcroft 30774d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 30784d001e4dSAndy Whitcroft 30799f5af480SJoe Perches # remove inline comments 30809f5af480SJoe Perches $s =~ s/$;/ /g; 30819f5af480SJoe Perches $c =~ s/$;/ /g; 30824d001e4dSAndy Whitcroft 30834d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 30846f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 30856f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 30864d001e4dSAndy Whitcroft 30879f5af480SJoe Perches # Make sure we remove the line prefixes as we have 30889f5af480SJoe Perches # none on the first line, and are going to readd them 30899f5af480SJoe Perches # where necessary. 30909f5af480SJoe Perches $s =~ s/\n./\n/gs; 30919f5af480SJoe Perches while ($s =~ /\n\s+\\\n/) { 30929f5af480SJoe Perches $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 30939f5af480SJoe Perches } 30949f5af480SJoe Perches 30954d001e4dSAndy Whitcroft # We want to check the first line inside the block 30964d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 30974d001e4dSAndy Whitcroft # 1) any blank line termination 30984d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 30994d001e4dSAndy Whitcroft # 3) any do (...) { 31004d001e4dSAndy Whitcroft my $continuation = 0; 31014d001e4dSAndy Whitcroft my $check = 0; 31024d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 31034d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 31044d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 31054d001e4dSAndy Whitcroft $continuation = 1; 31064d001e4dSAndy Whitcroft } 31079bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 31084d001e4dSAndy Whitcroft $check = 1; 31094d001e4dSAndy Whitcroft $cond_lines++; 31104d001e4dSAndy Whitcroft } 31114d001e4dSAndy Whitcroft 31124d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 31134d001e4dSAndy Whitcroft # preprocessor statement. 31144d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 31154d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 31164d001e4dSAndy Whitcroft $check = 0; 31174d001e4dSAndy Whitcroft } 31184d001e4dSAndy Whitcroft 31199bd49efeSAndy Whitcroft my $cond_ptr = -1; 3120740504c6SAndy Whitcroft $continuation = 0; 31219bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 31229bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 31234d001e4dSAndy Whitcroft 3124f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3125f16fa28fSAndy Whitcroft # is not linear. 3126f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3127f16fa28fSAndy Whitcroft $check = 0; 3128f16fa28fSAndy Whitcroft } 3129f16fa28fSAndy Whitcroft 31309bd49efeSAndy Whitcroft # Ignore: 31319bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31329bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31339bd49efeSAndy Whitcroft # 3) labels. 3134740504c6SAndy Whitcroft if ($continuation || 3135740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31369bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31379bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3138740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 313930dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31409bd49efeSAndy Whitcroft $cond_lines++; 31419bd49efeSAndy Whitcroft } 31424d001e4dSAndy Whitcroft } 314330dad6ebSAndy Whitcroft } 31444d001e4dSAndy Whitcroft 31454d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 31464d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 31474d001e4dSAndy Whitcroft 31484d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 31494d001e4dSAndy Whitcroft # this is not this patch's fault. 31504d001e4dSAndy Whitcroft if (!defined($stat_real) || 31514d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 31524d001e4dSAndy Whitcroft $check = 0; 31534d001e4dSAndy Whitcroft } 31544d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 31554d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 31564d001e4dSAndy Whitcroft } 31574d001e4dSAndy Whitcroft 31589bd49efeSAndy 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"; 31594d001e4dSAndy Whitcroft 31609f5af480SJoe Perches if ($check && $s ne '' && 31619f5af480SJoe Perches (($sindent % 8) != 0 || 31629f5af480SJoe Perches ($sindent < $indent) || 31639f5af480SJoe Perches ($sindent > $indent + 8))) { 3164000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3165000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 31664d001e4dSAndy Whitcroft } 31674d001e4dSAndy Whitcroft } 31684d001e4dSAndy Whitcroft 31696c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 31706c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 31711f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 31721f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 31736c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3174c2fdda0dSAndy Whitcroft if ($dbg_values) { 3175c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3176cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3177cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 31781f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3179c2fdda0dSAndy Whitcroft } 31806c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 31816c72ffaaSAndy Whitcroft 318200df344fSAndy Whitcroft#ignore lines not being added 31833705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 318400df344fSAndy Whitcroft 3185653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 31867429c690SAndy Whitcroft if ($dbg_type) { 31877429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3188000d1cc1SJoe Perches ERROR("TEST_TYPE", 3189000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 31907429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3191000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3192000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 31937429c690SAndy Whitcroft } 3194653d4876SAndy Whitcroft next; 3195653d4876SAndy Whitcroft } 3196a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3197a1ef277eSAndy Whitcroft if ($dbg_attr) { 31989360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3199000d1cc1SJoe Perches ERROR("TEST_ATTR", 3200000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 32019360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3202000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3203000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3204a1ef277eSAndy Whitcroft } 3205a1ef277eSAndy Whitcroft next; 3206a1ef277eSAndy Whitcroft } 3207653d4876SAndy Whitcroft 3208f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 320999423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 321099423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3211d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3212d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3213f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3214f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3215f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3216d752fcc8SJoe Perches my $fixedline = $prevrawline; 3217d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3218f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3219d752fcc8SJoe Perches $fixedline = $line; 3220d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3221f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3222d752fcc8SJoe Perches } 3223f0a594c1SAndy Whitcroft } 3224f0a594c1SAndy Whitcroft 322500df344fSAndy Whitcroft# 322600df344fSAndy Whitcroft# Checks which are anchored on the added line. 322700df344fSAndy Whitcroft# 322800df344fSAndy Whitcroft 3229653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3230c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3231653d4876SAndy Whitcroft my $path = $1; 3232653d4876SAndy Whitcroft if ($path =~ m{//}) { 3233000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3234495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3235495e9d84SJoe Perches } 3236495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3237495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3238495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3239653d4876SAndy Whitcroft } 3240653d4876SAndy Whitcroft } 3241653d4876SAndy Whitcroft 324200df344fSAndy Whitcroft# no C99 // comments 324300df344fSAndy Whitcroft if ($line =~ m{//}) { 32443705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 32453705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 32463705ce5bSJoe Perches $fix) { 3247194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 32483705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 32493705ce5bSJoe Perches my $comment = trim($1); 3250194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 32513705ce5bSJoe Perches } 32523705ce5bSJoe Perches } 325300df344fSAndy Whitcroft } 325400df344fSAndy Whitcroft # Remove C99 comments. 32550a920b5bSAndy Whitcroft $line =~ s@//.*@@; 32566c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 32570a920b5bSAndy Whitcroft 32582b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 32592b474a1aSAndy Whitcroft# the whole statement. 32602b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 32612b474a1aSAndy Whitcroft if (defined $realline_next && 32622b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 32632b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 32642b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32652b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32663cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 32673cbf62dfSAndy Whitcroft # a prefix: 32683cbf62dfSAndy Whitcroft # XXX(foo); 32693cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3270653d4876SAndy Whitcroft my $name = $1; 327187a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 32723cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 32733cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 32743cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 32753cbf62dfSAndy Whitcroft 32763cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 32772b474a1aSAndy Whitcroft \n.}\s*$| 327848012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 327948012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 328048012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 32812b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 32822b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 328348012058SAndy Whitcroft )/x) { 32842b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 32852b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 32862b474a1aSAndy Whitcroft } else { 32872b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 32880a920b5bSAndy Whitcroft } 32890a920b5bSAndy Whitcroft } 32902b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 32912b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 32922b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32932b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32942b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 32952b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 32962b474a1aSAndy Whitcroft } 32972b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 32982b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3299000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3300000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 33012b474a1aSAndy Whitcroft } 33020a920b5bSAndy Whitcroft 33035150bda4SJoe Eloff# check for global initialisers. 33045129e87cSJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) { 3305d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3306000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3307d5e616fcSJoe Perches $herecurr) && 3308d5e616fcSJoe Perches $fix) { 33095129e87cSJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/; 3310d5e616fcSJoe Perches } 3311f0a594c1SAndy Whitcroft } 33120a920b5bSAndy Whitcroft# check for static initialisers. 3313d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3314d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3315000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3316d5e616fcSJoe Perches $herecurr) && 3317d5e616fcSJoe Perches $fix) { 3318194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3319d5e616fcSJoe Perches } 33200a920b5bSAndy Whitcroft } 33210a920b5bSAndy Whitcroft 33221813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 33231813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 33241813087dSJoe Perches my $tmp = trim($1); 33251813087dSJoe Perches WARN("MISORDERED_TYPE", 33261813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 33271813087dSJoe Perches } 33281813087dSJoe Perches 3329cb710ecaSJoe Perches# check for static const char * arrays. 3330cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3331000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3332000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3333cb710ecaSJoe Perches $herecurr); 3334cb710ecaSJoe Perches } 3335cb710ecaSJoe Perches 3336cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3337cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3338000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3339000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3340cb710ecaSJoe Perches $herecurr); 3341cb710ecaSJoe Perches } 3342cb710ecaSJoe Perches 3343ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3344ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3345ab7e23f3SJoe Perches my $found = $1; 3346ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3347ab7e23f3SJoe Perches WARN("CONST_CONST", 3348ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3349ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3350ab7e23f3SJoe Perches WARN("CONST_CONST", 3351ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3352ab7e23f3SJoe Perches } 3353ab7e23f3SJoe Perches } 3354ab7e23f3SJoe Perches 33559b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 33569b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 33579b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 33589b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 33599b0fa60dSJoe Perches $herecurr); 33609b0fa60dSJoe Perches } 33619b0fa60dSJoe Perches 3362b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3363b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3364b598b670SJoe Perches my $array = $1; 3365b598b670SJoe 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*\))@) { 3366b598b670SJoe Perches my $array_div = $1; 3367b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3368b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3369b598b670SJoe Perches $fix) { 3370b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3371b598b670SJoe Perches } 3372b598b670SJoe Perches } 3373b598b670SJoe Perches } 3374b598b670SJoe Perches 3375b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3376b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3377b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3378b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3379b36190c5SJoe Perches $fix) { 3380194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3381b36190c5SJoe Perches } 3382b36190c5SJoe Perches } 3383b36190c5SJoe Perches 338492e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 338592e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 338692e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 338792e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 338892e112fdSJoe Perches $fix) { 3389194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 339092e112fdSJoe Perches } 339193ed0e2dSJoe Perches } 339293ed0e2dSJoe Perches 3393653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3394653d4876SAndy Whitcroft# make sense. 3395653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 33968054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3397c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 33988ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3399653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3400000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3401000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 34020a920b5bSAndy Whitcroft } 34030a920b5bSAndy Whitcroft 34040a920b5bSAndy Whitcroft# * goes on variable not on type 340565863862SAndy Whitcroft # (char*[ const]) 3406bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3407bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 34083705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3409d8aaf121SAndy Whitcroft 341065863862SAndy Whitcroft # Should start with a space. 341165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 341265863862SAndy Whitcroft # Should not end with a space. 341365863862SAndy Whitcroft $to =~ s/\s+$//; 341465863862SAndy Whitcroft # '*'s should not have spaces between. 3415f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 341665863862SAndy Whitcroft } 3417d8aaf121SAndy Whitcroft 34183705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 341965863862SAndy Whitcroft if ($from ne $to) { 34203705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34213705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 34223705ce5bSJoe Perches $fix) { 34233705ce5bSJoe Perches my $sub_from = $ident; 34243705ce5bSJoe Perches my $sub_to = $ident; 34253705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3426194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34273705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34283705ce5bSJoe Perches } 342965863862SAndy Whitcroft } 3430bfcb2cc7SAndy Whitcroft } 3431bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3432bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 34333705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3434d8aaf121SAndy Whitcroft 343565863862SAndy Whitcroft # Should start with a space. 343665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 343765863862SAndy Whitcroft # Should not end with a space. 343865863862SAndy Whitcroft $to =~ s/\s+$//; 343965863862SAndy Whitcroft # '*'s should not have spaces between. 3440f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 344165863862SAndy Whitcroft } 344265863862SAndy Whitcroft # Modifiers should have spaces. 344365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 344465863862SAndy Whitcroft 34453705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3446667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 34473705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34483705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 34493705ce5bSJoe Perches $fix) { 34503705ce5bSJoe Perches 34513705ce5bSJoe Perches my $sub_from = $match; 34523705ce5bSJoe Perches my $sub_to = $match; 34533705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3454194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34553705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34563705ce5bSJoe Perches } 345765863862SAndy Whitcroft } 34580a920b5bSAndy Whitcroft } 34590a920b5bSAndy Whitcroft 34609d3e3c70SJoe Perches# avoid BUG() or BUG_ON() 34619d3e3c70SJoe Perches if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 34629d3e3c70SJoe Perches my $msg_type = \&WARN; 34639d3e3c70SJoe Perches $msg_type = \&CHK if ($file); 34649d3e3c70SJoe Perches &{$msg_type}("AVOID_BUG", 34659d3e3c70SJoe Perches "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 34669d3e3c70SJoe Perches } 34670a920b5bSAndy Whitcroft 34689d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE 34698905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3470000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3471000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 34728905a67cSAndy Whitcroft } 34738905a67cSAndy Whitcroft 347417441227SJoe Perches# check for uses of printk_ratelimit 347517441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3476000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3477000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 347817441227SJoe Perches } 347917441227SJoe Perches 348000df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 348100df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 348200df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 348325985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 348400df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3485f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 348600df344fSAndy Whitcroft my $ok = 0; 348700df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 348800df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 348925985edcSLucas De Marchi # we have a preceding printk if it ends 349000df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 349100df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 349200df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 349300df344fSAndy Whitcroft $ok = 1; 349400df344fSAndy Whitcroft } 349500df344fSAndy Whitcroft last; 349600df344fSAndy Whitcroft } 349700df344fSAndy Whitcroft } 349800df344fSAndy Whitcroft if ($ok == 0) { 3499000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3500000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 35010a920b5bSAndy Whitcroft } 350200df344fSAndy Whitcroft } 35030a920b5bSAndy Whitcroft 3504243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3505243f3803SJoe Perches my $orig = $1; 3506243f3803SJoe Perches my $level = lc($orig); 3507243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 35088f26b837SJoe Perches my $level2 = $level; 35098f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3510243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3511daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3512243f3803SJoe Perches } 3513243f3803SJoe Perches 3514243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3515d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3516d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3517d5e616fcSJoe Perches $fix) { 3518194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3519d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3520d5e616fcSJoe Perches } 3521243f3803SJoe Perches } 3522243f3803SJoe Perches 3523dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3524dc139313SJoe Perches my $orig = $1; 3525dc139313SJoe Perches my $level = lc($orig); 3526dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3527dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3528dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3529dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3530dc139313SJoe Perches } 3531dc139313SJoe Perches 353291c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 353391c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 353491c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 353591c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 353691c9afafSAndy Lutomirski WARN("ENOSYS", 353791c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 353891c9afafSAndy Lutomirski } 353991c9afafSAndy Lutomirski 3540653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3541653d4876SAndy Whitcroft# or if closed on same line 35428d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3543c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 35448d182478SJoe Perches if (ERROR("OPEN_BRACE", 35458d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 35468d182478SJoe Perches $fix) { 35478d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35488d182478SJoe Perches my $fixed_line = $rawline; 35498d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 35508d182478SJoe Perches my $line1 = $1; 35518d182478SJoe Perches my $line2 = $2; 35528d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 35538d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 35548d182478SJoe Perches if ($line2 !~ /^\s*$/) { 35558d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 35568d182478SJoe Perches } 35578d182478SJoe Perches } 35580a920b5bSAndy Whitcroft } 3559653d4876SAndy Whitcroft 35608905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 35618905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 35628905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 35638d182478SJoe Perches if (ERROR("OPEN_BRACE", 35648d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 35658d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 35668d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 35678d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35688d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 35698d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35708d182478SJoe Perches $fixedline = $rawline; 35718d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 35728d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 35738d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35748d182478SJoe Perches } 35758d182478SJoe Perches } 35768905a67cSAndy Whitcroft } 35778905a67cSAndy Whitcroft 35780c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 35793705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 35803705ce5bSJoe Perches if (WARN("SPACING", 35813705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 35823705ce5bSJoe Perches $fix) { 3583194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35843705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 35853705ce5bSJoe Perches } 35860c73b4ebSAndy Whitcroft } 35870c73b4ebSAndy Whitcroft 358831070b5dSJoe Perches# Function pointer declarations 358931070b5dSJoe Perches# check spacing between type, funcptr, and args 359031070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 359191f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 359231070b5dSJoe Perches my $declare = $1; 359331070b5dSJoe Perches my $pre_pointer_space = $2; 359431070b5dSJoe Perches my $post_pointer_space = $3; 359531070b5dSJoe Perches my $funcname = $4; 359631070b5dSJoe Perches my $post_funcname_space = $5; 359731070b5dSJoe Perches my $pre_args_space = $6; 359831070b5dSJoe Perches 359991f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 360091f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 360191f72e9cSJoe Perches# don't need a space so don't warn for those. 360291f72e9cSJoe Perches my $post_declare_space = ""; 360391f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 360491f72e9cSJoe Perches $post_declare_space = $1; 360591f72e9cSJoe Perches $declare = rtrim($declare); 360691f72e9cSJoe Perches } 360791f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 360831070b5dSJoe Perches WARN("SPACING", 360931070b5dSJoe Perches "missing space after return type\n" . $herecurr); 361091f72e9cSJoe Perches $post_declare_space = " "; 361131070b5dSJoe Perches } 361231070b5dSJoe Perches 361331070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 361491f72e9cSJoe Perches# This test is not currently implemented because these declarations are 361591f72e9cSJoe Perches# equivalent to 361691f72e9cSJoe Perches# int foo(int bar, ...) 361791f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 361891f72e9cSJoe Perches# 361991f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 362091f72e9cSJoe Perches# WARN("SPACING", 362191f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 362291f72e9cSJoe Perches# } 362331070b5dSJoe Perches 362431070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 362531070b5dSJoe Perches if (defined $pre_pointer_space && 362631070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 362731070b5dSJoe Perches WARN("SPACING", 362831070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 362931070b5dSJoe Perches } 363031070b5dSJoe Perches 363131070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 363231070b5dSJoe Perches if (defined $post_pointer_space && 363331070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 363431070b5dSJoe Perches WARN("SPACING", 363531070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 363631070b5dSJoe Perches } 363731070b5dSJoe Perches 363831070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 363931070b5dSJoe Perches if (defined $post_funcname_space && 364031070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 364131070b5dSJoe Perches WARN("SPACING", 364231070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 364331070b5dSJoe Perches } 364431070b5dSJoe Perches 364531070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 364631070b5dSJoe Perches if (defined $pre_args_space && 364731070b5dSJoe Perches $pre_args_space =~ /^\s/) { 364831070b5dSJoe Perches WARN("SPACING", 364931070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 365031070b5dSJoe Perches } 365131070b5dSJoe Perches 365231070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3653194f66fcSJoe Perches $fixed[$fixlinenr] =~ 365491f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 365531070b5dSJoe Perches } 365631070b5dSJoe Perches } 365731070b5dSJoe Perches 36588d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 36598d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3660fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3661fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 36628d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 36638d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 36648d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3665fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3666daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 36673705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 36683705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 36693705ce5bSJoe Perches $fix) { 3670194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36713705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 36723705ce5bSJoe Perches } 36738d31cfceSAndy Whitcroft } 36748d31cfceSAndy Whitcroft } 36758d31cfceSAndy Whitcroft 3676f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 36776c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3678c2fdda0dSAndy Whitcroft my $name = $1; 3679773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3680773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3681c2fdda0dSAndy Whitcroft 3682c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3683773647a0SAndy Whitcroft if ($name =~ /^(?: 3684773647a0SAndy Whitcroft if|for|while|switch|return|case| 3685773647a0SAndy Whitcroft volatile|__volatile__| 3686773647a0SAndy Whitcroft __attribute__|format|__extension__| 3687773647a0SAndy Whitcroft asm|__asm__)$/x) 3688773647a0SAndy Whitcroft { 3689c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3690c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3691c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3692c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3693773647a0SAndy Whitcroft 3694773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3695c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3696c2fdda0dSAndy Whitcroft 3697c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3698c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3699773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3700c2fdda0dSAndy Whitcroft 3701c2fdda0dSAndy Whitcroft } else { 37023705ce5bSJoe Perches if (WARN("SPACING", 37033705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 37043705ce5bSJoe Perches $fix) { 3705194f66fcSJoe Perches $fixed[$fixlinenr] =~ 37063705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 37073705ce5bSJoe Perches } 3708f0a594c1SAndy Whitcroft } 37096c72ffaaSAndy Whitcroft } 37109a4cad4eSEric Nelson 3711653d4876SAndy Whitcroft# Check operator spacing. 37120a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 37133705ce5bSJoe Perches my $fixed_line = ""; 37143705ce5bSJoe Perches my $line_fixed = 0; 37153705ce5bSJoe Perches 37169c0ca6f9SAndy Whitcroft my $ops = qr{ 37179c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 37189c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 37199c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 37201f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 372184731623SJoe Perches \?:|\?|: 37229c0ca6f9SAndy Whitcroft }x; 3723cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 37243705ce5bSJoe Perches 37253705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 37263705ce5bSJoe Perches## foreach my $el (@elements) { 37273705ce5bSJoe Perches## print("el: <$el>\n"); 37283705ce5bSJoe Perches## } 37293705ce5bSJoe Perches 37303705ce5bSJoe Perches my @fix_elements = (); 373100df344fSAndy Whitcroft my $off = 0; 37326c72ffaaSAndy Whitcroft 37333705ce5bSJoe Perches foreach my $el (@elements) { 37343705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 37353705ce5bSJoe Perches $off += length($el); 37363705ce5bSJoe Perches } 37373705ce5bSJoe Perches 37383705ce5bSJoe Perches $off = 0; 37393705ce5bSJoe Perches 37406c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3741b34c648bSJoe Perches my $last_after = -1; 37426c72ffaaSAndy Whitcroft 37430a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 37443705ce5bSJoe Perches 37453705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 37463705ce5bSJoe Perches 37473705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 37483705ce5bSJoe Perches 37494a0df2efSAndy Whitcroft $off += length($elements[$n]); 37504a0df2efSAndy Whitcroft 375125985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3752773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3753773647a0SAndy Whitcroft my $cc = ''; 3754773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3755773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3756773647a0SAndy Whitcroft } 3757773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3758773647a0SAndy Whitcroft 37594a0df2efSAndy Whitcroft my $a = ''; 37604a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 37614a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3762cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 37634a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 37644a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3765773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 37664a0df2efSAndy Whitcroft 37670a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 37684a0df2efSAndy Whitcroft 37694a0df2efSAndy Whitcroft my $c = ''; 37700a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 37714a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 37724a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3773cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 37744a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 37754a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 37768b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 37774a0df2efSAndy Whitcroft } else { 37784a0df2efSAndy Whitcroft $c = 'E'; 37790a920b5bSAndy Whitcroft } 37800a920b5bSAndy Whitcroft 37814a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 37824a0df2efSAndy Whitcroft 37834a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 37844a0df2efSAndy Whitcroft 37856c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3786de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 37870a920b5bSAndy Whitcroft 378874048ed8SAndy Whitcroft # Pull out the value of this operator. 37896c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 37900a920b5bSAndy Whitcroft 37911f65f947SAndy Whitcroft # Get the full operator variant. 37921f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 37931f65f947SAndy Whitcroft 379413214adfSAndy Whitcroft # Ignore operators passed as parameters. 379513214adfSAndy Whitcroft if ($op_type ne 'V' && 3796d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 379713214adfSAndy Whitcroft 3798cf655043SAndy Whitcroft# # Ignore comments 3799cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 380013214adfSAndy Whitcroft 3801d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 380213214adfSAndy Whitcroft } elsif ($op eq ';') { 3803cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3804cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 38053705ce5bSJoe Perches if (ERROR("SPACING", 38063705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3807b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38083705ce5bSJoe Perches $line_fixed = 1; 38093705ce5bSJoe Perches } 3810d8aaf121SAndy Whitcroft } 3811d8aaf121SAndy Whitcroft 3812d8aaf121SAndy Whitcroft # // is a comment 3813d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 38140a920b5bSAndy Whitcroft 3815b00e4814SJoe Perches # : when part of a bitfield 3816b00e4814SJoe Perches } elsif ($opv eq ':B') { 3817b00e4814SJoe Perches # skip the bitfield test for now 3818b00e4814SJoe Perches 38191f65f947SAndy Whitcroft # No spaces for: 38201f65f947SAndy Whitcroft # -> 3821b00e4814SJoe Perches } elsif ($op eq '->') { 38224a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 38233705ce5bSJoe Perches if (ERROR("SPACING", 38243705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3825b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38263705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38273705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38283705ce5bSJoe Perches } 3829b34c648bSJoe Perches $line_fixed = 1; 38303705ce5bSJoe Perches } 38310a920b5bSAndy Whitcroft } 38320a920b5bSAndy Whitcroft 38332381097bSJoe Perches # , must not have a space before and must have a space on the right. 38340a920b5bSAndy Whitcroft } elsif ($op eq ',') { 38352381097bSJoe Perches my $rtrim_before = 0; 38362381097bSJoe Perches my $space_after = 0; 38372381097bSJoe Perches if ($ctx =~ /Wx./) { 38382381097bSJoe Perches if (ERROR("SPACING", 38392381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 38402381097bSJoe Perches $line_fixed = 1; 38412381097bSJoe Perches $rtrim_before = 1; 38422381097bSJoe Perches } 38432381097bSJoe Perches } 3844cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 38453705ce5bSJoe Perches if (ERROR("SPACING", 38463705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 38473705ce5bSJoe Perches $line_fixed = 1; 3848b34c648bSJoe Perches $last_after = $n; 38492381097bSJoe Perches $space_after = 1; 38502381097bSJoe Perches } 38512381097bSJoe Perches } 38522381097bSJoe Perches if ($rtrim_before || $space_after) { 38532381097bSJoe Perches if ($rtrim_before) { 38542381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38552381097bSJoe Perches } else { 38562381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38572381097bSJoe Perches } 38582381097bSJoe Perches if ($space_after) { 38592381097bSJoe Perches $good .= " "; 38603705ce5bSJoe Perches } 38610a920b5bSAndy Whitcroft } 38620a920b5bSAndy Whitcroft 38639c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 386474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 38659c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 38669c0ca6f9SAndy Whitcroft 38679c0ca6f9SAndy Whitcroft # unary operators should have a space before and 38689c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 38699c0ca6f9SAndy Whitcroft # unary operator, or a cast 38709c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 387174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 38720d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3873cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 38743705ce5bSJoe Perches if (ERROR("SPACING", 38753705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3876b34c648bSJoe Perches if ($n != $last_after + 2) { 3877b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 38783705ce5bSJoe Perches $line_fixed = 1; 38793705ce5bSJoe Perches } 38800a920b5bSAndy Whitcroft } 3881b34c648bSJoe Perches } 3882a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3883171ae1a4SAndy Whitcroft # A unary '*' may be const 3884171ae1a4SAndy Whitcroft 3885171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 38863705ce5bSJoe Perches if (ERROR("SPACING", 38873705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3888b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 38893705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38903705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38913705ce5bSJoe Perches } 3892b34c648bSJoe Perches $line_fixed = 1; 38933705ce5bSJoe Perches } 38940a920b5bSAndy Whitcroft } 38950a920b5bSAndy Whitcroft 38960a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 38970a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3898773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 38993705ce5bSJoe Perches if (ERROR("SPACING", 39003705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3901b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 39023705ce5bSJoe Perches $line_fixed = 1; 39033705ce5bSJoe Perches } 39040a920b5bSAndy Whitcroft } 3905773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3906773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 39073705ce5bSJoe Perches if (ERROR("SPACING", 39083705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3909b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39103705ce5bSJoe Perches $line_fixed = 1; 39113705ce5bSJoe Perches } 3912653d4876SAndy Whitcroft } 3913773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 39143705ce5bSJoe Perches if (ERROR("SPACING", 39153705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3916b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 39173705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 39183705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3919773647a0SAndy Whitcroft } 3920b34c648bSJoe Perches $line_fixed = 1; 39213705ce5bSJoe Perches } 39223705ce5bSJoe Perches } 39230a920b5bSAndy Whitcroft 39240a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 39259c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 39269c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 39279c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3928c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3929c2fdda0dSAndy Whitcroft $op eq '%') 39300a920b5bSAndy Whitcroft { 3931d2e025f3SJoe Perches if ($check) { 3932d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3933d2e025f3SJoe Perches if (CHK("SPACING", 3934d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3935d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3936d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3937d2e025f3SJoe Perches $line_fixed = 1; 3938d2e025f3SJoe Perches } 3939d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3940d2e025f3SJoe Perches if (CHK("SPACING", 3941d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3942d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3943d2e025f3SJoe Perches $line_fixed = 1; 3944d2e025f3SJoe Perches } 3945d2e025f3SJoe Perches } 3946d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 39473705ce5bSJoe Perches if (ERROR("SPACING", 39483705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3949b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3950b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3951b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3952b34c648bSJoe Perches } 39533705ce5bSJoe Perches $line_fixed = 1; 39543705ce5bSJoe Perches } 39550a920b5bSAndy Whitcroft } 39560a920b5bSAndy Whitcroft 39571f65f947SAndy Whitcroft # A colon needs no spaces before when it is 39581f65f947SAndy Whitcroft # terminating a case value or a label. 39591f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 39601f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 39613705ce5bSJoe Perches if (ERROR("SPACING", 39623705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3963b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39643705ce5bSJoe Perches $line_fixed = 1; 39653705ce5bSJoe Perches } 39661f65f947SAndy Whitcroft } 39671f65f947SAndy Whitcroft 39680a920b5bSAndy Whitcroft # All the others need spaces both sides. 3969cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 39701f65f947SAndy Whitcroft my $ok = 0; 39711f65f947SAndy Whitcroft 397222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 39731f65f947SAndy Whitcroft if (($op eq '<' && 39741f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 39751f65f947SAndy Whitcroft ($op eq '>' && 39761f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 39771f65f947SAndy Whitcroft { 39781f65f947SAndy Whitcroft $ok = 1; 39791f65f947SAndy Whitcroft } 39801f65f947SAndy Whitcroft 3981e0df7e1fSJoe Perches # for asm volatile statements 3982e0df7e1fSJoe Perches # ignore a colon with another 3983e0df7e1fSJoe Perches # colon immediately before or after 3984e0df7e1fSJoe Perches if (($op eq ':') && 3985e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 3986e0df7e1fSJoe Perches $ok = 1; 3987e0df7e1fSJoe Perches } 3988e0df7e1fSJoe Perches 398984731623SJoe Perches # messages are ERROR, but ?: are CHK 39901f65f947SAndy Whitcroft if ($ok == 0) { 399184731623SJoe Perches my $msg_type = \&ERROR; 399284731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 399384731623SJoe Perches 399484731623SJoe Perches if (&{$msg_type}("SPACING", 39953705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3996b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3997b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3998b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3999b34c648bSJoe Perches } 40003705ce5bSJoe Perches $line_fixed = 1; 40013705ce5bSJoe Perches } 40020a920b5bSAndy Whitcroft } 400322f2a2efSAndy Whitcroft } 40044a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 40053705ce5bSJoe Perches 40063705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 40073705ce5bSJoe Perches 40083705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 40090a920b5bSAndy Whitcroft } 40103705ce5bSJoe Perches 40113705ce5bSJoe Perches if (($#elements % 2) == 0) { 40123705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 40133705ce5bSJoe Perches } 40143705ce5bSJoe Perches 4015194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 4016194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 40173705ce5bSJoe Perches } 40183705ce5bSJoe Perches 40193705ce5bSJoe Perches 40200a920b5bSAndy Whitcroft } 40210a920b5bSAndy Whitcroft 4022786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4023d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4024786b6326SJoe Perches if (WARN("SPACING", 4025786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4026786b6326SJoe Perches $fix) { 4027194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4028786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4029786b6326SJoe Perches } 4030786b6326SJoe Perches } 4031786b6326SJoe Perches 4032f0a594c1SAndy Whitcroft# check for multiple assignments 4033f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4034000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4035000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4036f0a594c1SAndy Whitcroft } 4037f0a594c1SAndy Whitcroft 403822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 403922f2a2efSAndy Whitcroft## # continuation. 404022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 404122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 404222f2a2efSAndy Whitcroft## 404322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 404422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 404522f2a2efSAndy Whitcroft## my $ln = $line; 404622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 404722f2a2efSAndy Whitcroft## } 404822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4049000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4050000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 405122f2a2efSAndy Whitcroft## } 405222f2a2efSAndy Whitcroft## } 4053f0a594c1SAndy Whitcroft 40540a920b5bSAndy Whitcroft#need space before brace following if, while, etc 405522f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 405622f2a2efSAndy Whitcroft $line =~ /do{/) { 40573705ce5bSJoe Perches if (ERROR("SPACING", 40583705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 40593705ce5bSJoe Perches $fix) { 4060194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 40613705ce5bSJoe Perches } 4062de7d4f0eSAndy Whitcroft } 4063de7d4f0eSAndy Whitcroft 4064c4a62ef9SJoe Perches## # check for blank lines before declarations 4065c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4066c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4067c4a62ef9SJoe Perches## WARN("SPACING", 4068c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4069c4a62ef9SJoe Perches## } 4070c4a62ef9SJoe Perches## 4071c4a62ef9SJoe Perches 4072de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4073de7d4f0eSAndy Whitcroft# on the line 4074de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4075d5e616fcSJoe Perches if (ERROR("SPACING", 4076d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4077d5e616fcSJoe Perches $fix) { 4078194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4079d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4080d5e616fcSJoe Perches } 40810a920b5bSAndy Whitcroft } 40820a920b5bSAndy Whitcroft 408322f2a2efSAndy Whitcroft# check spacing on square brackets 408422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 40853705ce5bSJoe Perches if (ERROR("SPACING", 40863705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 40873705ce5bSJoe Perches $fix) { 4088194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40893705ce5bSJoe Perches s/\[\s+/\[/; 40903705ce5bSJoe Perches } 409122f2a2efSAndy Whitcroft } 409222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 40933705ce5bSJoe Perches if (ERROR("SPACING", 40943705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 40953705ce5bSJoe Perches $fix) { 4096194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40973705ce5bSJoe Perches s/\s+\]/\]/; 40983705ce5bSJoe Perches } 409922f2a2efSAndy Whitcroft } 410022f2a2efSAndy Whitcroft 4101c45dcabdSAndy Whitcroft# check spacing on parentheses 41029c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 41039c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 41043705ce5bSJoe Perches if (ERROR("SPACING", 41053705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 41063705ce5bSJoe Perches $fix) { 4107194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41083705ce5bSJoe Perches s/\(\s+/\(/; 41093705ce5bSJoe Perches } 411022f2a2efSAndy Whitcroft } 411113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4112c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4113c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 41143705ce5bSJoe Perches if (ERROR("SPACING", 41153705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 41163705ce5bSJoe Perches $fix) { 4117194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41183705ce5bSJoe Perches s/\s+\)/\)/; 41193705ce5bSJoe Perches } 412022f2a2efSAndy Whitcroft } 412122f2a2efSAndy Whitcroft 4122e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4123e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4124e2826fd0SJoe Perches 4125e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4126ea4acbb1SJoe Perches my $var = $1; 4127ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4128ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4129ea4acbb1SJoe Perches $fix) { 4130ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4131ea4acbb1SJoe Perches } 4132ea4acbb1SJoe Perches } 4133ea4acbb1SJoe Perches 4134ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4135ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4136ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4137ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4138ea4acbb1SJoe Perches my $var = $2; 4139ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4140ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4141ea4acbb1SJoe Perches $fix) { 4142ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4143ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4144ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4145ea4acbb1SJoe Perches } 4146e2826fd0SJoe Perches } 4147e2826fd0SJoe Perches 41480a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 41494a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 41500a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 41513705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 41523705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 41533705ce5bSJoe Perches $fix) { 4154194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41553705ce5bSJoe Perches s/^(.)\s+/$1/; 41563705ce5bSJoe Perches } 41570a920b5bSAndy Whitcroft } 41580a920b5bSAndy Whitcroft 41595b9553abSJoe Perches# return is not a function 4160507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4161c45dcabdSAndy Whitcroft my $spacing = $1; 4162507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 41635b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 41645b9553abSJoe Perches my $value = $1; 41655b9553abSJoe Perches $value = deparenthesize($value); 41665b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4167000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4168000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 41695b9553abSJoe Perches } 4170c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4171000d1cc1SJoe Perches ERROR("SPACING", 4172000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4173c45dcabdSAndy Whitcroft } 4174c45dcabdSAndy Whitcroft } 4175507e5141SJoe Perches 4176b43ae21bSJoe Perches# unnecessary return in a void function 4177b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4178b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4179b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4180b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4181b43ae21bSJoe Perches $linenr >= 3 && 4182b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4183b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 41849819cf25SJoe Perches WARN("RETURN_VOID", 4185b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 41869819cf25SJoe Perches } 41879819cf25SJoe Perches 4188189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4189189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4190189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4191189248d8SJoe Perches my $openparens = $1; 4192189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4193189248d8SJoe Perches my $msg = ""; 4194189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4195189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4196189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4197189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4198189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4199189248d8SJoe Perches } 4200189248d8SJoe Perches } 4201189248d8SJoe Perches 4202f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4203f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 420453a3c448SAndy Whitcroft my $name = $1; 420553a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4206000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4207f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 420853a3c448SAndy Whitcroft } 420953a3c448SAndy Whitcroft } 4210c45dcabdSAndy Whitcroft 42110a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 42124a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 42133705ce5bSJoe Perches if (ERROR("SPACING", 42143705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 42153705ce5bSJoe Perches $fix) { 4216194f66fcSJoe Perches $fixed[$fixlinenr] =~ 42173705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 42183705ce5bSJoe Perches } 42190a920b5bSAndy Whitcroft } 42200a920b5bSAndy Whitcroft 4221f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4222f5fe35ddSAndy Whitcroft# statements after the conditional. 4223170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 42243e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 42253e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 42263e469cdcSAndy Whitcroft if (!defined $stat); 4227170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4228170d3a22SAndy Whitcroft $remain_next, $off_next); 4229170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4230170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4231170d3a22SAndy Whitcroft 4232170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4233170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4234170d3a22SAndy Whitcroft # then count those as offsets. 4235170d3a22SAndy Whitcroft my ($whitespace) = 4236170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4237170d3a22SAndy Whitcroft my $offset = 4238170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4239170d3a22SAndy Whitcroft 4240170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4241170d3a22SAndy Whitcroft $offset} = 1; 4242170d3a22SAndy Whitcroft } 4243170d3a22SAndy Whitcroft } 4244170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4245c11230f4SJoe Perches defined($stat) && defined($cond) && 4246170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4247171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 42488905a67cSAndy Whitcroft 4249b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4250000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4251000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 42528905a67cSAndy Whitcroft } 42538905a67cSAndy Whitcroft 42548905a67cSAndy Whitcroft # Find out what is on the end of the line after the 42558905a67cSAndy Whitcroft # conditional. 4256773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 42578905a67cSAndy Whitcroft $s =~ s/\n.*//g; 425813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 425953210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 426053210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4261773647a0SAndy Whitcroft { 4262bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4263bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4264bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 426542bdf74cSHidetoshi Seto my $stat_real = ''; 4266bb44ad39SAndy Whitcroft 426742bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 426842bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4269bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4270bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4271bb44ad39SAndy Whitcroft } 4272bb44ad39SAndy Whitcroft 4273000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4274000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 42758905a67cSAndy Whitcroft } 42768905a67cSAndy Whitcroft } 42778905a67cSAndy Whitcroft 427813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 427913214adfSAndy Whitcroft if ($line =~ / 428013214adfSAndy Whitcroft (?: 428113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 428213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 428313214adfSAndy Whitcroft (?:\&\&|\|\|) 428413214adfSAndy Whitcroft | 428513214adfSAndy Whitcroft (?:\&\&|\|\|) 428613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 428713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 428813214adfSAndy Whitcroft )/x) 428913214adfSAndy Whitcroft { 4290000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4291000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 429213214adfSAndy Whitcroft } 429313214adfSAndy Whitcroft 42948905a67cSAndy Whitcroft# if and else should not have general statements after it 429513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 429613214adfSAndy Whitcroft my $s = $1; 429713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 429813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4299000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4300000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 43010a920b5bSAndy Whitcroft } 430213214adfSAndy Whitcroft } 430339667782SAndy Whitcroft# if should not continue a brace 430439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4305000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4306048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 430739667782SAndy Whitcroft $herecurr); 430839667782SAndy Whitcroft } 4309a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4310a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4311a1080bf8SAndy Whitcroft $line !~ /\G(?: 43123fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4313a1080bf8SAndy Whitcroft \s*return\s+ 4314a1080bf8SAndy Whitcroft )/xg) 4315a1080bf8SAndy Whitcroft { 4316000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4317000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4318a1080bf8SAndy Whitcroft } 43190a920b5bSAndy Whitcroft 43200a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 43210a920b5bSAndy Whitcroft # indent level to be relevant to each other. 43228b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 43230a920b5bSAndy Whitcroft $previndent == $indent) { 43248b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 43258b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 43268b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43278b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43288b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43298b8856f4SJoe Perches my $fixedline = $prevrawline; 43308b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 43318b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 43328b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43338b8856f4SJoe Perches } 43348b8856f4SJoe Perches $fixedline = $rawline; 43358b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 43368b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43378b8856f4SJoe Perches } 43380a920b5bSAndy Whitcroft } 43390a920b5bSAndy Whitcroft 43408b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4341c2fdda0dSAndy Whitcroft $previndent == $indent) { 4342c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4343c2fdda0dSAndy Whitcroft 4344c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4345c2fdda0dSAndy Whitcroft # conditional. 4346773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4347c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4348c2fdda0dSAndy Whitcroft 4349c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 43508b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 43518b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 43528b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43538b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43548b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43558b8856f4SJoe Perches my $fixedline = $prevrawline; 43568b8856f4SJoe Perches my $trailing = $rawline; 43578b8856f4SJoe Perches $trailing =~ s/^\+//; 43588b8856f4SJoe Perches $trailing = trim($trailing); 43598b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 43608b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43618b8856f4SJoe Perches } 4362c2fdda0dSAndy Whitcroft } 4363c2fdda0dSAndy Whitcroft } 4364c2fdda0dSAndy Whitcroft 436595e2c602SJoe Perches#Specific variable tests 4366323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4367323c1260SJoe Perches my $var = $1; 436895e2c602SJoe Perches 436995e2c602SJoe Perches#gcc binary extension 437095e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4371d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4372d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4373d5e616fcSJoe Perches $fix) { 4374d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4375194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4376d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4377d5e616fcSJoe Perches } 437895e2c602SJoe Perches } 437995e2c602SJoe Perches 438095e2c602SJoe Perches#CamelCase 4381807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4382be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 438322735ce8SJoe Perches#Ignore Page<foo> variants 4384807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 438522735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4386f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4387f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4388f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 43897e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 43907e781f67SJoe Perches my $word = $1; 43917e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4392d8b07710SJoe Perches if ($check) { 4393d8b07710SJoe Perches seed_camelcase_includes(); 4394d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4395d8b07710SJoe Perches seed_camelcase_file($realfile); 4396d8b07710SJoe Perches $camelcase_file_seeded = 1; 4397d8b07710SJoe Perches } 4398d8b07710SJoe Perches } 43997e781f67SJoe Perches if (!defined $camelcase{$word}) { 44007e781f67SJoe Perches $camelcase{$word} = 1; 4401be79794bSJoe Perches CHK("CAMELCASE", 44027e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 44037e781f67SJoe Perches } 4404323c1260SJoe Perches } 4405323c1260SJoe Perches } 44063445686aSJoe Perches } 44070a920b5bSAndy Whitcroft 44080a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4409d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4410d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4411d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4412d5e616fcSJoe Perches $fix) { 4413194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4414d5e616fcSJoe Perches } 44150a920b5bSAndy Whitcroft } 44160a920b5bSAndy Whitcroft 44170e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 44180e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4419c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4420e09dec48SAndy Whitcroft my $file = "$1.h"; 4421e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4422e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4423e09dec48SAndy Whitcroft $realfile ne $checkfile && 44247840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4425c45dcabdSAndy Whitcroft { 44260e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 44270e212e0aSFabian Frederick if ($asminclude > 0) { 4428e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4429000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4430000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4431e09dec48SAndy Whitcroft } else { 4432000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4433000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4434e09dec48SAndy Whitcroft } 44350a920b5bSAndy Whitcroft } 44360a920b5bSAndy Whitcroft } 44370e212e0aSFabian Frederick } 44380a920b5bSAndy Whitcroft 4439653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4440653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4441cf655043SAndy Whitcroft# in a known good container 4442b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4443b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4444d8aaf121SAndy Whitcroft my $ln = $linenr; 4445d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4446c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4447c45dcabdSAndy Whitcroft my $ctx = ''; 444808a2843eSJoe Perches my $has_flow_statement = 0; 444908a2843eSJoe Perches my $has_arg_concat = 0; 4450c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4451f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4452f74bd194SAndy Whitcroft $ctx = $dstat; 4453c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4454a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4455c45dcabdSAndy Whitcroft 445608a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 445708a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 445808a2843eSJoe Perches 4459f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4460292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4461c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4462c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4463c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4464c45dcabdSAndy Whitcroft 4465c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4466bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4467bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4468c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4469bf30d6edSAndy Whitcroft { 4470c45dcabdSAndy Whitcroft } 4471c45dcabdSAndy Whitcroft 4472e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 447333acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 447433acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4475e45bab8eSAndy Whitcroft { 4476e45bab8eSAndy Whitcroft } 4477e45bab8eSAndy Whitcroft 4478c45dcabdSAndy Whitcroft my $exceptions = qr{ 4479c45dcabdSAndy Whitcroft $Declare| 4480c45dcabdSAndy Whitcroft module_param_named| 4481a0a0a7a9SKees Cook MODULE_PARM_DESC| 4482c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4483c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4484383099fdSAndy Whitcroft __typeof__\(| 448522fd2d3eSStefani Seibold union| 448622fd2d3eSStefani Seibold struct| 4487ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4488ea71a0a0SAndy Whitcroft ^\"|\"$ 4489c45dcabdSAndy Whitcroft }x; 44905eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4491f74bd194SAndy Whitcroft if ($dstat ne '' && 4492f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4493f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 44943cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4495356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4496f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4497f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4498e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 449972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4500f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4501f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4502f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4503f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4504f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4505c45dcabdSAndy Whitcroft { 4506f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4507f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4508f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4509f74bd194SAndy Whitcroft 4510f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4511f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4512c45dcabdSAndy Whitcroft } 4513c45dcabdSAndy Whitcroft 4514f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4515f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4516f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4517f74bd194SAndy Whitcroft } else { 4518000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4519388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4520d8aaf121SAndy Whitcroft } 45210a920b5bSAndy Whitcroft } 45225023d347SJoe Perches 452308a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 452408a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 452508a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 452608a2843eSJoe Perches my $herectx = $here . "\n"; 452708a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 452808a2843eSJoe Perches 452908a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 453008a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 453108a2843eSJoe Perches } 453208a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 453308a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 453408a2843eSJoe Perches } 453508a2843eSJoe Perches 4536481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 45375023d347SJoe Perches 45385023d347SJoe Perches } else { 45395023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4540481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4541481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 45425023d347SJoe Perches $line =~ /^\+.*\\$/) { 45435023d347SJoe Perches WARN("LINE_CONTINUATIONS", 45445023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 45455023d347SJoe Perches } 4546653d4876SAndy Whitcroft } 45470a920b5bSAndy Whitcroft 4548b13edf7fSJoe Perches# do {} while (0) macro tests: 4549b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4550b13edf7fSJoe Perches# macro should not end with a semicolon 4551b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4552b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4553b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4554b13edf7fSJoe Perches my $ln = $linenr; 4555b13edf7fSJoe Perches my $cnt = $realcnt; 4556b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4557b13edf7fSJoe Perches my $ctx = ''; 4558b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4559b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4560b13edf7fSJoe Perches $ctx = $dstat; 4561b13edf7fSJoe Perches 4562b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 45631b36b201SJoe Perches $dstat =~ s/$;/ /g; 4564b13edf7fSJoe Perches 4565b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4566b13edf7fSJoe Perches my $stmts = $2; 4567b13edf7fSJoe Perches my $semis = $3; 4568b13edf7fSJoe Perches 4569b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4570b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4571b13edf7fSJoe Perches my $herectx = $here . "\n"; 4572b13edf7fSJoe Perches 4573b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4574b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4575b13edf7fSJoe Perches } 4576b13edf7fSJoe Perches 4577ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4578ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4579b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4580b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4581b13edf7fSJoe Perches } 4582b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4583b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4584b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4585b13edf7fSJoe Perches } 4586f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4587f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4588f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4589f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4590f5ef95b1SJoe Perches 4591f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4592f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4593f5ef95b1SJoe Perches } 4594f5ef95b1SJoe Perches 4595f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4596f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4597b13edf7fSJoe Perches } 4598b13edf7fSJoe Perches } 4599b13edf7fSJoe Perches 4600080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4601080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4602080ba929SMike Frysinger# . 4603080ba929SMike Frysinger# ALIGN(...) 4604080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4605080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4606000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4607000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4608080ba929SMike Frysinger } 4609080ba929SMike Frysinger 4610f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 461113214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 461213214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4613cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 461413214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4615cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4616cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4617aad4f614SJoe Perches my @allowed = (); 4618aad4f614SJoe Perches my $allow = 0; 461913214adfSAndy Whitcroft my $seen = 0; 4620773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4621cf655043SAndy Whitcroft my $ln = $linenr - 1; 462213214adfSAndy Whitcroft for my $chunk (@chunks) { 462313214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 462413214adfSAndy Whitcroft 4625773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4626773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4627773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4628773647a0SAndy Whitcroft 4629aad4f614SJoe Perches $allowed[$allow] = 0; 4630773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4631773647a0SAndy Whitcroft 4632773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4633773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4634773647a0SAndy Whitcroft 4635773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4636cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4637cf655043SAndy Whitcroft 4638773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 463913214adfSAndy Whitcroft 464013214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 464113214adfSAndy Whitcroft 4642aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4643cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4644cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4645aad4f614SJoe Perches $allowed[$allow] = 1; 464613214adfSAndy Whitcroft } 464713214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4648cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4649aad4f614SJoe Perches $allowed[$allow] = 1; 465013214adfSAndy Whitcroft } 4651cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4652cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4653aad4f614SJoe Perches $allowed[$allow] = 1; 465413214adfSAndy Whitcroft } 4655aad4f614SJoe Perches $allow++; 465613214adfSAndy Whitcroft } 4657aad4f614SJoe Perches if ($seen) { 4658aad4f614SJoe Perches my $sum_allowed = 0; 4659aad4f614SJoe Perches foreach (@allowed) { 4660aad4f614SJoe Perches $sum_allowed += $_; 4661aad4f614SJoe Perches } 4662aad4f614SJoe Perches if ($sum_allowed == 0) { 4663000d1cc1SJoe Perches WARN("BRACES", 4664000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4665aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4666aad4f614SJoe Perches $seen != $allow) { 4667aad4f614SJoe Perches CHK("BRACES", 4668aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4669aad4f614SJoe Perches } 467013214adfSAndy Whitcroft } 467113214adfSAndy Whitcroft } 467213214adfSAndy Whitcroft } 4673773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 467413214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4675cf655043SAndy Whitcroft my $allowed = 0; 4676f0a594c1SAndy Whitcroft 4677cf655043SAndy Whitcroft # Check the pre-context. 4678cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4679cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4680cf655043SAndy Whitcroft $allowed = 1; 4681f0a594c1SAndy Whitcroft } 4682773647a0SAndy Whitcroft 4683773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4684773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4685773647a0SAndy Whitcroft 4686cf655043SAndy Whitcroft # Check the condition. 4687cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4688773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4689cf655043SAndy Whitcroft if (defined $cond) { 4690773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4691cf655043SAndy Whitcroft } 4692cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4693cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4694cf655043SAndy Whitcroft $allowed = 1; 4695cf655043SAndy Whitcroft } 4696cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4697cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4698cf655043SAndy Whitcroft $allowed = 1; 4699cf655043SAndy Whitcroft } 4700cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4701cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4702cf655043SAndy Whitcroft $allowed = 1; 4703cf655043SAndy Whitcroft } 4704cf655043SAndy Whitcroft # Check the post-context. 4705cf655043SAndy Whitcroft if (defined $chunks[1]) { 4706cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4707cf655043SAndy Whitcroft if (defined $cond) { 4708773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4709cf655043SAndy Whitcroft } 4710cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4711cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4712cf655043SAndy Whitcroft $allowed = 1; 4713cf655043SAndy Whitcroft } 4714cf655043SAndy Whitcroft } 4715cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 471669932487SJustin P. Mattock my $herectx = $here . "\n"; 4717f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4718cf655043SAndy Whitcroft 4719f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 472069932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4721cf655043SAndy Whitcroft } 4722cf655043SAndy Whitcroft 4723000d1cc1SJoe Perches WARN("BRACES", 4724000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4725f0a594c1SAndy Whitcroft } 4726f0a594c1SAndy Whitcroft } 4727f0a594c1SAndy Whitcroft 47280979ae66SJoe Perches# check for unnecessary blank lines around braces 472977b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4730f8e58219SJoe Perches if (CHK("BRACES", 4731f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4732f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4733f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4734f8e58219SJoe Perches } 47350979ae66SJoe Perches } 473677b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4737f8e58219SJoe Perches if (CHK("BRACES", 4738f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4739f8e58219SJoe Perches $fix) { 4740f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4741f8e58219SJoe Perches } 47420979ae66SJoe Perches } 47430979ae66SJoe Perches 47444a0df2efSAndy Whitcroft# no volatiles please 47456c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 47466c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4747000d1cc1SJoe Perches WARN("VOLATILE", 4748000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 47494a0df2efSAndy Whitcroft } 47504a0df2efSAndy Whitcroft 47515e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 47525e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 47535e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 47545e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 475533acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 47565e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 47575e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 47585e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 47595e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 47605e4f6ba5SJoe Perches $fix && 47615e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 47625e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 47635e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 47645e4f6ba5SJoe Perches my $comma_close = ""; 47655e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 47665e4f6ba5SJoe Perches $comma_close = $1; 47675e4f6ba5SJoe Perches } 47685e4f6ba5SJoe Perches 47695e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47705e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 47715e4f6ba5SJoe Perches my $fixedline = $prevrawline; 47725e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 47735e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 47745e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 47755e4f6ba5SJoe Perches $fixedline = $rawline; 47765e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 47775e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 47785e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47795e4f6ba5SJoe Perches } 47805e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 47815e4f6ba5SJoe Perches } 47825e4f6ba5SJoe Perches } 47835e4f6ba5SJoe Perches 47845e4f6ba5SJoe Perches# check for missing a space in a string concatenation 47855e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 47865e4f6ba5SJoe Perches WARN('MISSING_SPACE', 47875e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 47885e4f6ba5SJoe Perches } 47895e4f6ba5SJoe Perches 47905e4f6ba5SJoe Perches# check for spaces before a quoted newline 47915e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 47925e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 47935e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 47945e4f6ba5SJoe Perches $fix) { 47955e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 47965e4f6ba5SJoe Perches } 47975e4f6ba5SJoe Perches 47985e4f6ba5SJoe Perches } 47995e4f6ba5SJoe Perches 4800f17dba4fSJoe Perches# concatenated string without spaces between elements 480133acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4802f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4803f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4804f17dba4fSJoe Perches } 4805f17dba4fSJoe Perches 480690ad30e5SJoe Perches# uncoalesced string fragments 480733acb54aSJoe Perches if ($line =~ /$String\s*"/) { 480890ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 480990ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 481090ad30e5SJoe Perches } 481190ad30e5SJoe Perches 48125e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 48135e4f6ba5SJoe Perches my $string; 48145e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 48155e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 48165e4f6ba5SJoe Perches $string =~ s/%%/__/g; 48175e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 48185e4f6ba5SJoe Perches WARN("PRINTF_L", 48195e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 48205e4f6ba5SJoe Perches last; 48215e4f6ba5SJoe Perches } 48225e4f6ba5SJoe Perches } 48235e4f6ba5SJoe Perches 48245e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 48255e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 48265e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 48275e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 48285e4f6ba5SJoe Perches } 48295e4f6ba5SJoe Perches 483000df344fSAndy Whitcroft# warn about #if 0 4831c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4832000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4833000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4834de7d4f0eSAndy Whitcroft $herecurr); 48354a0df2efSAndy Whitcroft } 48364a0df2efSAndy Whitcroft 483703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 483803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 4839*100425deSJoe Perches my $tested = quotemeta($1); 4840*100425deSJoe Perches my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 4841*100425deSJoe Perches if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 4842*100425deSJoe Perches my $func = $1; 4843*100425deSJoe Perches if (WARN('NEEDLESS_IF', 4844*100425deSJoe Perches "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 4845*100425deSJoe Perches $fix) { 4846*100425deSJoe Perches my $do_fix = 1; 4847*100425deSJoe Perches my $leading_tabs = ""; 4848*100425deSJoe Perches my $new_leading_tabs = ""; 4849*100425deSJoe Perches if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 4850*100425deSJoe Perches $leading_tabs = $1; 4851*100425deSJoe Perches } else { 4852*100425deSJoe Perches $do_fix = 0; 4853*100425deSJoe Perches } 4854*100425deSJoe Perches if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 4855*100425deSJoe Perches $new_leading_tabs = $1; 4856*100425deSJoe Perches if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 4857*100425deSJoe Perches $do_fix = 0; 4858*100425deSJoe Perches } 4859*100425deSJoe Perches } else { 4860*100425deSJoe Perches $do_fix = 0; 4861*100425deSJoe Perches } 4862*100425deSJoe Perches if ($do_fix) { 4863*100425deSJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4864*100425deSJoe Perches $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 4865*100425deSJoe Perches } 4866*100425deSJoe Perches } 48674c432a8fSGreg Kroah-Hartman } 48684c432a8fSGreg Kroah-Hartman } 4869f0a594c1SAndy Whitcroft 4870ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4871ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4872ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4873ebfdc409SJoe Perches (defined $1 || defined $3) && 4874ebfdc409SJoe Perches $linenr > 3) { 4875ebfdc409SJoe Perches my $testval = $2; 4876ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4877ebfdc409SJoe Perches 4878ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4879ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4880ebfdc409SJoe Perches 4881ebfdc409SJoe 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)/) { 4882ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4883ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4884ebfdc409SJoe Perches } 4885ebfdc409SJoe Perches } 4886ebfdc409SJoe Perches 4887f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4888dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4889f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4890f78d98f6SJoe Perches my $level = $1; 4891f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4892f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4893f78d98f6SJoe Perches $fix) { 4894f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4895f78d98f6SJoe Perches } 4896f78d98f6SJoe Perches } 4897f78d98f6SJoe Perches 4898abb08a53SJoe Perches# check for mask then right shift without a parentheses 4899abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4900abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4901abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4902abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4903abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4904abb08a53SJoe Perches } 4905abb08a53SJoe Perches 4906b75ac618SJoe Perches# check for pointer comparisons to NULL 4907b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4908b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4909b75ac618SJoe Perches my $val = $1; 4910b75ac618SJoe Perches my $equal = "!"; 4911b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4912b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4913b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4914b75ac618SJoe Perches $fix) { 4915b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4916b75ac618SJoe Perches } 4917b75ac618SJoe Perches } 4918b75ac618SJoe Perches } 4919b75ac618SJoe Perches 49208716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 49218716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 49228716de38SJoe Perches my $attr = $1; 49238716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 49248716de38SJoe Perches my $ptr = $1; 49258716de38SJoe Perches my $var = $2; 49268716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 49278716de38SJoe Perches ERROR("MISPLACED_INIT", 49288716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 49298716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 49308716de38SJoe Perches WARN("MISPLACED_INIT", 49318716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 49328716de38SJoe Perches $fix) { 4933194f66fcSJoe 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; 49348716de38SJoe Perches } 49358716de38SJoe Perches } 49368716de38SJoe Perches } 49378716de38SJoe Perches 4938e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4939e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4940e970b884SJoe Perches my $attr = $1; 4941e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4942e970b884SJoe Perches my $attr_prefix = $1; 4943e970b884SJoe Perches my $attr_type = $2; 4944e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4945e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4946e970b884SJoe Perches $fix) { 4947194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4948e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4949e970b884SJoe Perches } 4950e970b884SJoe Perches } 4951e970b884SJoe Perches 4952e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4953e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4954e970b884SJoe Perches my $attr = $1; 4955e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4956e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4957e970b884SJoe Perches $fix) { 4958194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4959e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4960e970b884SJoe Perches $lead = rtrim($1); 4961e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4962e970b884SJoe Perches $lead = "${lead}const "; 4963194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4964e970b884SJoe Perches } 4965e970b884SJoe Perches } 4966e970b884SJoe Perches 4967c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 4968c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 4969c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 4970c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 4971c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 4972c17893c7SJoe Perches $fix) { 4973c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 4974c17893c7SJoe Perches } 4975c17893c7SJoe Perches } 4976c17893c7SJoe Perches 4977fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4978fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4979fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4980fbdb8138SJoe Perches my $constant_func = $1; 4981fbdb8138SJoe Perches my $func = $constant_func; 4982fbdb8138SJoe Perches $func =~ s/^__constant_//; 4983fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4984fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4985fbdb8138SJoe Perches $fix) { 4986194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4987fbdb8138SJoe Perches } 4988fbdb8138SJoe Perches } 4989fbdb8138SJoe Perches 49901a15a250SPatrick Pannuto# prefer usleep_range over udelay 499137581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 499243c1d77cSJoe Perches my $delay = $1; 49931a15a250SPatrick Pannuto # ignore udelay's < 10, however 499443c1d77cSJoe Perches if (! ($delay < 10) ) { 4995000d1cc1SJoe Perches CHK("USLEEP_RANGE", 499643c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 499743c1d77cSJoe Perches } 499843c1d77cSJoe Perches if ($delay > 2000) { 499943c1d77cSJoe Perches WARN("LONG_UDELAY", 500043c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 50011a15a250SPatrick Pannuto } 50021a15a250SPatrick Pannuto } 50031a15a250SPatrick Pannuto 500409ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 500509ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 500609ef8725SPatrick Pannuto if ($1 < 20) { 5007000d1cc1SJoe Perches WARN("MSLEEP", 500843c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 500909ef8725SPatrick Pannuto } 501009ef8725SPatrick Pannuto } 501109ef8725SPatrick Pannuto 501236ec1939SJoe Perches# check for comparisons of jiffies 501336ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 501436ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 501536ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 501636ec1939SJoe Perches } 501736ec1939SJoe Perches 50189d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 50199d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 50209d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 50219d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 50229d7a34a5SJoe Perches } 50239d7a34a5SJoe Perches 502400df344fSAndy Whitcroft# warn about #ifdefs in C files 5025c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 502600df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 502700df344fSAndy Whitcroft# print "$herecurr"; 502800df344fSAndy Whitcroft# $clean = 0; 502900df344fSAndy Whitcroft# } 503000df344fSAndy Whitcroft 503122f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 5032c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 50333705ce5bSJoe Perches if (ERROR("SPACING", 50343705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 50353705ce5bSJoe Perches $fix) { 5036194f66fcSJoe Perches $fixed[$fixlinenr] =~ 50373705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 50383705ce5bSJoe Perches } 50393705ce5bSJoe Perches 504022f2a2efSAndy Whitcroft } 504122f2a2efSAndy Whitcroft 50424a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 5043171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5044171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 50454a0df2efSAndy Whitcroft my $which = $1; 50464a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5047000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5048000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 50494a0df2efSAndy Whitcroft } 50504a0df2efSAndy Whitcroft } 50514a0df2efSAndy Whitcroft# check for memory barriers without a comment. 50524a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 50534a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5054c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5055000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 50564a0df2efSAndy Whitcroft } 50574a0df2efSAndy Whitcroft } 50583ad81779SPaul E. McKenney 5059cb426e99SJoe Perches# check for waitqueue_active without a comment. 5060cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5061cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5062cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5063cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5064cb426e99SJoe Perches } 5065cb426e99SJoe Perches } 50663ad81779SPaul E. McKenney 50673ad81779SPaul E. McKenney# Check for expedited grace periods that interrupt non-idle non-nohz 50683ad81779SPaul E. McKenney# online CPUs. These expedited can therefore degrade real-time response 50693ad81779SPaul E. McKenney# if used carelessly, and should be avoided where not absolutely 50703ad81779SPaul E. McKenney# needed. It is always OK to use synchronize_rcu_expedited() and 50713ad81779SPaul E. McKenney# synchronize_sched_expedited() at boot time (before real-time applications 50723ad81779SPaul E. McKenney# start) and in error situations where real-time response is compromised in 50733ad81779SPaul E. McKenney# any case. Note that synchronize_srcu_expedited() does -not- interrupt 50743ad81779SPaul E. McKenney# other CPUs, so don't warn on uses of synchronize_srcu_expedited(). 50753ad81779SPaul E. McKenney# Of course, nothing comes for free, and srcu_read_lock() and 50763ad81779SPaul E. McKenney# srcu_read_unlock() do contain full memory barriers in payment for 50773ad81779SPaul E. McKenney# synchronize_srcu_expedited() non-interruption properties. 50783ad81779SPaul E. McKenney if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) { 50793ad81779SPaul E. McKenney WARN("EXPEDITED_RCU_GRACE_PERIOD", 50803ad81779SPaul E. McKenney "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr); 50813ad81779SPaul E. McKenney 50823ad81779SPaul E. McKenney } 50833ad81779SPaul E. McKenney 50844a0df2efSAndy Whitcroft# check of hardware specific defines 5085c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5086000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5087000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 50880a920b5bSAndy Whitcroft } 5089653d4876SAndy Whitcroft 5090d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5091d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5092000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5093000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5094d4977c78STobias Klauser } 5095d4977c78STobias Klauser 5096de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5097de7d4f0eSAndy Whitcroft# storage class and type. 50989c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 50999c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5100000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5101000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5102de7d4f0eSAndy Whitcroft } 5103de7d4f0eSAndy Whitcroft 51048905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 51052b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51062b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5107d5e616fcSJoe Perches if (WARN("INLINE", 5108d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5109d5e616fcSJoe Perches $fix) { 5110194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5111d5e616fcSJoe Perches 5112d5e616fcSJoe Perches } 51138905a67cSAndy Whitcroft } 51148905a67cSAndy Whitcroft 51153d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 51162b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51172b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5118000d1cc1SJoe Perches WARN("PREFER_PACKED", 5119000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 51203d130fd0SJoe Perches } 51213d130fd0SJoe Perches 512239b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 51232b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51242b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5125000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5126000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 512739b7e287SJoe Perches } 512839b7e287SJoe Perches 51295f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 51302b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51312b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5132d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5133d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5134d5e616fcSJoe Perches $fix) { 5135194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5136d5e616fcSJoe Perches 5137d5e616fcSJoe Perches } 51385f14d3bdSJoe Perches } 51395f14d3bdSJoe Perches 51406061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 51412b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 51422b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5143d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5144d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5145d5e616fcSJoe Perches $fix) { 5146194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5147d5e616fcSJoe Perches } 51486061d949SJoe Perches } 51496061d949SJoe Perches 5150619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5151619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5152619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5153619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5154619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5155619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5156619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5157619a908aSJoe Perches } 5158619a908aSJoe Perches 5159e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5160e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5161e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5162e6176fa4SJoe Perches my $type = $1; 5163e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5164e6176fa4SJoe Perches $type = $1; 5165e6176fa4SJoe Perches my $kernel_type = 'u'; 5166e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5167e6176fa4SJoe Perches $type =~ /(\d+)/; 5168e6176fa4SJoe Perches $kernel_type .= $1; 5169e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5170e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5171e6176fa4SJoe Perches $fix) { 5172e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5173e6176fa4SJoe Perches } 5174e6176fa4SJoe Perches } 5175e6176fa4SJoe Perches } 5176e6176fa4SJoe Perches 51778f53a9b8SJoe Perches# check for sizeof(&) 51788f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5179000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5180000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 51818f53a9b8SJoe Perches } 51828f53a9b8SJoe Perches 518366c80b60SJoe Perches# check for sizeof without parenthesis 518466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5185d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5186d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5187d5e616fcSJoe Perches $fix) { 5188194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5189d5e616fcSJoe Perches } 519066c80b60SJoe Perches } 519166c80b60SJoe Perches 519288982feaSJoe Perches# check for struct spinlock declarations 519388982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 519488982feaSJoe Perches WARN("USE_SPINLOCK_T", 519588982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 519688982feaSJoe Perches } 519788982feaSJoe Perches 5198a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 519906668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5200a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5201caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5202caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5203d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5204d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5205d5e616fcSJoe Perches $fix) { 5206194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5207d5e616fcSJoe Perches } 5208a6962d72SJoe Perches } 5209a6962d72SJoe Perches } 5210a6962d72SJoe Perches 5211554e165cSAndy Whitcroft# Check for misused memsets 5212d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5213d1fe9c09SJoe Perches defined $stat && 52149e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5215554e165cSAndy Whitcroft 5216d7c76ba7SJoe Perches my $ms_addr = $2; 5217d1fe9c09SJoe Perches my $ms_val = $7; 5218d1fe9c09SJoe Perches my $ms_size = $12; 5219d7c76ba7SJoe Perches 5220554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5221554e165cSAndy Whitcroft ERROR("MEMSET", 5222d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5223554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5224554e165cSAndy Whitcroft WARN("MEMSET", 5225d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5226d7c76ba7SJoe Perches } 5227d7c76ba7SJoe Perches } 5228d7c76ba7SJoe Perches 522998a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 523098a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 523110895d2cSMateusz Kulikowski defined $stat && 523210895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 523398a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 523410895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 523598a9bba5SJoe Perches $fix) { 5236194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 523798a9bba5SJoe Perches } 523898a9bba5SJoe Perches } 523998a9bba5SJoe Perches 5240b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5241b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5242b6117d17SMateusz Kulikowski defined $stat && 5243b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5244b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5245b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5246b6117d17SMateusz Kulikowski } 5247b6117d17SMateusz Kulikowski 52488617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 52498617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 52508617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 52518617cd09SMateusz Kulikowski defined $stat && 52528617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 52538617cd09SMateusz Kulikowski 52548617cd09SMateusz Kulikowski my $ms_val = $7; 52558617cd09SMateusz Kulikowski 52568617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 52578617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 52588617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 52598617cd09SMateusz Kulikowski $fix) { 52608617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 52618617cd09SMateusz Kulikowski } 52628617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 52638617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 52648617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 52658617cd09SMateusz Kulikowski $fix) { 52668617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 52678617cd09SMateusz Kulikowski } 52688617cd09SMateusz Kulikowski } 52698617cd09SMateusz Kulikowski } 52708617cd09SMateusz Kulikowski 5271d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5272d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5273d1fe9c09SJoe Perches defined $stat && 5274d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5275d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5276d7c76ba7SJoe Perches my $call = $1; 5277d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5278d7c76ba7SJoe Perches my $arg1 = $3; 5279d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5280d1fe9c09SJoe Perches my $arg2 = $8; 5281d7c76ba7SJoe Perches my $cast; 5282d7c76ba7SJoe Perches 5283d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5284d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5285d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5286d7c76ba7SJoe Perches $cast = $cast1; 5287d7c76ba7SJoe Perches } else { 5288d7c76ba7SJoe Perches $cast = $cast2; 5289d7c76ba7SJoe Perches } 5290d7c76ba7SJoe Perches WARN("MINMAX", 5291d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5292554e165cSAndy Whitcroft } 5293554e165cSAndy Whitcroft } 5294554e165cSAndy Whitcroft 52954a273195SJoe Perches# check usleep_range arguments 52964a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 52974a273195SJoe Perches defined $stat && 52984a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 52994a273195SJoe Perches my $min = $1; 53004a273195SJoe Perches my $max = $7; 53014a273195SJoe Perches if ($min eq $max) { 53024a273195SJoe Perches WARN("USLEEP_RANGE", 53034a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 53044a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 53054a273195SJoe Perches $min > $max) { 53064a273195SJoe Perches WARN("USLEEP_RANGE", 53074a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 53084a273195SJoe Perches } 53094a273195SJoe Perches } 53104a273195SJoe Perches 5311823b794cSJoe Perches# check for naked sscanf 5312823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5313823b794cSJoe Perches defined $stat && 53146c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5315823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5316823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5317823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5318823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5319823b794cSJoe Perches $lc = $lc + $linenr; 5320823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5321823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5322823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5323823b794cSJoe Perches } 5324823b794cSJoe Perches WARN("NAKED_SSCANF", 5325823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5326823b794cSJoe Perches } 5327823b794cSJoe Perches 5328afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5329afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5330afc819abSJoe Perches defined $stat && 5331afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5332afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5333afc819abSJoe Perches $lc = $lc + $linenr; 5334afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5335afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5336afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5337afc819abSJoe Perches } 5338afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5339afc819abSJoe Perches my $format = $6; 5340afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5341afc819abSJoe Perches if ($count == 1 && 5342afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5343afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5344afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5345afc819abSJoe Perches } 5346afc819abSJoe Perches } 5347afc819abSJoe Perches } 5348afc819abSJoe Perches 534970dc8a48SJoe Perches# check for new externs in .h files. 535070dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 535170dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5352d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 535370dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 535470dc8a48SJoe Perches $fix) { 5355194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 535670dc8a48SJoe Perches } 535770dc8a48SJoe Perches } 535870dc8a48SJoe Perches 5359de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5360171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5361c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5362171ae1a4SAndy Whitcroft { 5363c45dcabdSAndy Whitcroft my $function_name = $1; 5364c45dcabdSAndy Whitcroft my $paren_space = $2; 5365171ae1a4SAndy Whitcroft 5366171ae1a4SAndy Whitcroft my $s = $stat; 5367171ae1a4SAndy Whitcroft if (defined $cond) { 5368171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5369171ae1a4SAndy Whitcroft } 5370c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5371c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5372c45dcabdSAndy Whitcroft { 5373000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5374000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5375de7d4f0eSAndy Whitcroft } 5376de7d4f0eSAndy Whitcroft 5377171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5378000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5379000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5380171ae1a4SAndy Whitcroft } 53819c9ba34eSAndy Whitcroft 53829c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 53839c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 53849c9ba34eSAndy Whitcroft { 5385000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5386000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5387171ae1a4SAndy Whitcroft } 5388171ae1a4SAndy Whitcroft 5389de7d4f0eSAndy Whitcroft# checks for new __setup's 5390de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5391de7d4f0eSAndy Whitcroft my $name = $1; 5392de7d4f0eSAndy Whitcroft 5393de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5394000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5395000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5396de7d4f0eSAndy Whitcroft } 5397653d4876SAndy Whitcroft } 53989c0ca6f9SAndy Whitcroft 53999c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5400caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5401000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5402000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 54039c0ca6f9SAndy Whitcroft } 540413214adfSAndy Whitcroft 5405a640d25cSJoe Perches# alloc style 5406a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5407a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5408a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5409a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5410a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5411a640d25cSJoe Perches } 5412a640d25cSJoe Perches 541360a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 541460a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5415e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 541660a55369SJoe Perches my $oldfunc = $3; 541760a55369SJoe Perches my $a1 = $4; 541860a55369SJoe Perches my $a2 = $10; 541960a55369SJoe Perches my $newfunc = "kmalloc_array"; 542060a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 542160a55369SJoe Perches my $r1 = $a1; 542260a55369SJoe Perches my $r2 = $a2; 542360a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 542460a55369SJoe Perches $r1 = $a2; 542560a55369SJoe Perches $r2 = $a1; 542660a55369SJoe Perches } 5427e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5428e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5429e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5430e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5431e367455aSJoe Perches $fix) { 5432194f66fcSJoe 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; 543360a55369SJoe Perches 543460a55369SJoe Perches } 543560a55369SJoe Perches } 543660a55369SJoe Perches } 543760a55369SJoe Perches 5438972fdea2SJoe Perches# check for krealloc arg reuse 5439972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5440972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5441972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5442972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5443972fdea2SJoe Perches } 5444972fdea2SJoe Perches 54455ce59ae0SJoe Perches# check for alloc argument mismatch 54465ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 54475ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 54485ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 54495ce59ae0SJoe Perches } 54505ce59ae0SJoe Perches 5451caf2a54fSJoe Perches# check for multiple semicolons 5452caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5453d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5454d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5455d5e616fcSJoe Perches $fix) { 5456194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5457d5e616fcSJoe Perches } 5458d1e2ad07SJoe Perches } 5459d1e2ad07SJoe Perches 54600ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 54610ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 54620ab90191SJoe Perches my $ull = ""; 54630ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 54640ab90191SJoe Perches if (CHK("BIT_MACRO", 54650ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 54660ab90191SJoe Perches $fix) { 54670ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 54680ab90191SJoe Perches } 54690ab90191SJoe Perches } 54700ab90191SJoe Perches 5471e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5472c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5473c34c09a8SJoe Perches my $has_break = 0; 5474c34c09a8SJoe Perches my $has_statement = 0; 5475c34c09a8SJoe Perches my $count = 0; 5476c34c09a8SJoe Perches my $prevline = $linenr; 5477e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5478c34c09a8SJoe Perches $prevline--; 5479c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5480c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5481c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5482c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5483c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5484c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5485c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5486c34c09a8SJoe Perches $has_statement = 1; 5487c34c09a8SJoe Perches $count++; 5488c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5489c34c09a8SJoe Perches } 5490c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5491c34c09a8SJoe Perches WARN("MISSING_BREAK", 5492c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5493c34c09a8SJoe Perches } 5494c34c09a8SJoe Perches } 5495c34c09a8SJoe Perches 5496d1e2ad07SJoe Perches# check for switch/default statements without a break; 5497d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5498d1e2ad07SJoe Perches defined $stat && 5499d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5500d1e2ad07SJoe Perches my $ctx = ''; 5501d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5502d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5503d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5504d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5505d1e2ad07SJoe Perches } 5506d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5507d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5508caf2a54fSJoe Perches } 5509caf2a54fSJoe Perches 551013214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5511d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5512d5e616fcSJoe Perches if (WARN("USE_FUNC", 5513d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5514d5e616fcSJoe Perches $fix) { 5515194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5516d5e616fcSJoe Perches } 551713214adfSAndy Whitcroft } 5518773647a0SAndy Whitcroft 551962ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 552062ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 552162ec818fSJoe Perches ERROR("DATE_TIME", 552262ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 552362ec818fSJoe Perches } 552462ec818fSJoe Perches 55252c92488aSJoe Perches# check for use of yield() 55262c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 55272c92488aSJoe Perches WARN("YIELD", 55282c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 55292c92488aSJoe Perches } 55302c92488aSJoe Perches 5531179f8f40SJoe Perches# check for comparisons against true and false 5532179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5533179f8f40SJoe Perches my $lead = $1; 5534179f8f40SJoe Perches my $arg = $2; 5535179f8f40SJoe Perches my $test = $3; 5536179f8f40SJoe Perches my $otype = $4; 5537179f8f40SJoe Perches my $trail = $5; 5538179f8f40SJoe Perches my $op = "!"; 5539179f8f40SJoe Perches 5540179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5541179f8f40SJoe Perches 5542179f8f40SJoe Perches my $type = lc($otype); 5543179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5544179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5545179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5546179f8f40SJoe Perches $op = ""; 5547179f8f40SJoe Perches } 5548179f8f40SJoe Perches 5549179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5550179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5551179f8f40SJoe Perches 5552179f8f40SJoe Perches## maybe suggesting a correct construct would better 5553179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5554179f8f40SJoe Perches 5555179f8f40SJoe Perches } 5556179f8f40SJoe Perches } 5557179f8f40SJoe Perches 55584882720bSThomas Gleixner# check for semaphores initialized locked 55594882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5560000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5561000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5562773647a0SAndy Whitcroft } 55636712d858SJoe Perches 556467d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 556567d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5566000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 556767d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5568773647a0SAndy Whitcroft } 55696712d858SJoe Perches 5570ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5571f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5572000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5573ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5574f3db6639SMichael Ellerman } 55756712d858SJoe Perches 55760f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 55770f3c5aabSJoe Perches my $const_structs = qr{ 55780f3c5aabSJoe Perches acpi_dock_ops| 557979404849SEmese Revfy address_space_operations| 558079404849SEmese Revfy backlight_ops| 558179404849SEmese Revfy block_device_operations| 558279404849SEmese Revfy dentry_operations| 558379404849SEmese Revfy dev_pm_ops| 558479404849SEmese Revfy dma_map_ops| 558579404849SEmese Revfy extent_io_ops| 558679404849SEmese Revfy file_lock_operations| 558779404849SEmese Revfy file_operations| 558879404849SEmese Revfy hv_ops| 558979404849SEmese Revfy ide_dma_ops| 559079404849SEmese Revfy intel_dvo_dev_ops| 559179404849SEmese Revfy item_operations| 559279404849SEmese Revfy iwl_ops| 559379404849SEmese Revfy kgdb_arch| 559479404849SEmese Revfy kgdb_io| 559579404849SEmese Revfy kset_uevent_ops| 559679404849SEmese Revfy lock_manager_operations| 559779404849SEmese Revfy microcode_ops| 559879404849SEmese Revfy mtrr_ops| 559979404849SEmese Revfy neigh_ops| 560079404849SEmese Revfy nlmsvc_binding| 56010f3c5aabSJoe Perches of_device_id| 560279404849SEmese Revfy pci_raw_ops| 560379404849SEmese Revfy pipe_buf_operations| 560479404849SEmese Revfy platform_hibernation_ops| 560579404849SEmese Revfy platform_suspend_ops| 560679404849SEmese Revfy proto_ops| 560779404849SEmese Revfy rpc_pipe_ops| 560879404849SEmese Revfy seq_operations| 560979404849SEmese Revfy snd_ac97_build_ops| 561079404849SEmese Revfy soc_pcmcia_socket_ops| 561179404849SEmese Revfy stacktrace_ops| 561279404849SEmese Revfy sysfs_ops| 561379404849SEmese Revfy tty_operations| 56146d07d01bSJoe Perches uart_ops| 561579404849SEmese Revfy usb_mon_operations| 561679404849SEmese Revfy wd_ops}x; 56176903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 56180f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5619000d1cc1SJoe Perches WARN("CONST_STRUCT", 5620000d1cc1SJoe Perches "struct $1 should normally be const\n" . 56216903ffb2SAndy Whitcroft $herecurr); 56222b6db5cbSAndy Whitcroft } 5623773647a0SAndy Whitcroft 5624773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5625773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5626773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5627c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5628c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5629171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5630171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5631171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5632773647a0SAndy Whitcroft { 5633000d1cc1SJoe Perches WARN("NR_CPUS", 5634000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5635773647a0SAndy Whitcroft } 56369c9ba34eSAndy Whitcroft 563752ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 563852ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 563952ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 564052ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 564152ea8506SJoe Perches } 564252ea8506SJoe Perches 5643acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5644acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5645acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5646acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5647acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5648acd9362cSJoe Perches } 5649acd9362cSJoe Perches 5650691d77b6SAndy Whitcroft# whine mightly about in_atomic 5651691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5652691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5653000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5654000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5655f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5656000d1cc1SJoe Perches WARN("IN_ATOMIC", 5657000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5658691d77b6SAndy Whitcroft } 5659691d77b6SAndy Whitcroft } 56601704f47bSPeter Zijlstra 56611704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 56621704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 56631704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 56641704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 56651704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 56661704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5667000d1cc1SJoe Perches ERROR("LOCKDEP", 5668000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 56691704f47bSPeter Zijlstra } 56701704f47bSPeter Zijlstra } 567188f8831cSDave Jones 5672b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5673b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5674000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5675000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 567688f8831cSDave Jones } 56772435880fSJoe Perches 5678515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5679515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5680515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5681515a235eSJoe Perches $line =~ /$mode_perms_search/) { 56822435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 56832435880fSJoe Perches my $func = $entry->[0]; 56842435880fSJoe Perches my $arg_pos = $entry->[1]; 56852435880fSJoe Perches 56862435880fSJoe Perches my $skip_args = ""; 56872435880fSJoe Perches if ($arg_pos > 1) { 56882435880fSJoe Perches $arg_pos--; 56892435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 56902435880fSJoe Perches } 56912435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5692515a235eSJoe Perches if ($line =~ /$test/) { 56932435880fSJoe Perches my $val = $1; 56942435880fSJoe Perches $val = $6 if ($skip_args ne ""); 56952435880fSJoe Perches 56961727cc70SJoe Perches if ($val !~ /^0$/ && 56971727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 56981727cc70SJoe Perches length($val) ne 4)) { 56992435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 57001727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5701c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5702c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5703c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 57042435880fSJoe Perches } 57052435880fSJoe Perches } 57062435880fSJoe Perches } 570713214adfSAndy Whitcroft } 57085a6d20ceSBjorn Andersson 57095a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 57105a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 57115a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 57125a6d20ceSBjorn Andersson my $valid_licenses = qr{ 57135a6d20ceSBjorn Andersson GPL| 57145a6d20ceSBjorn Andersson GPL\ v2| 57155a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 57165a6d20ceSBjorn Andersson Dual\ BSD/GPL| 57175a6d20ceSBjorn Andersson Dual\ MIT/GPL| 57185a6d20ceSBjorn Andersson Dual\ MPL/GPL| 57195a6d20ceSBjorn Andersson Proprietary 57205a6d20ceSBjorn Andersson }x; 57215a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 57225a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 57235a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 57245a6d20ceSBjorn Andersson } 57255a6d20ceSBjorn Andersson } 5726515a235eSJoe Perches } 572713214adfSAndy Whitcroft 572813214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 572913214adfSAndy Whitcroft # so just keep quiet. 573013214adfSAndy Whitcroft if ($#rawlines == -1) { 573113214adfSAndy Whitcroft exit(0); 57320a920b5bSAndy Whitcroft } 57330a920b5bSAndy Whitcroft 57348905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 57358905a67cSAndy Whitcroft # things that appear to be patches. 57368905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 57378905a67cSAndy Whitcroft exit(0); 57388905a67cSAndy Whitcroft } 57398905a67cSAndy Whitcroft 57408905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 57418905a67cSAndy Whitcroft # just keep quiet. 57428905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 57438905a67cSAndy Whitcroft exit(0); 57448905a67cSAndy Whitcroft } 57458905a67cSAndy Whitcroft 574606330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5747000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5748000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 57490a920b5bSAndy Whitcroft } 575034d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5751000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5752000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 57530a920b5bSAndy Whitcroft } 57540a920b5bSAndy Whitcroft 5755f0a594c1SAndy Whitcroft print report_dump(); 575613214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 575713214adfSAndy Whitcroft print "$filename " if ($summary_file); 57586c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 57596c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 57606c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 57616c72ffaaSAndy Whitcroft } 57628905a67cSAndy Whitcroft 5763d2c0a235SAndy Whitcroft if ($quiet == 0) { 5764d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5765d2c0a235SAndy Whitcroft # then suggest that. 5766d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5767b0781216SMike Frysinger $rpt_cleaners = 0; 5768d8469f16SJoe Perches print << "EOM" 5769d8469f16SJoe Perches 5770d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5771d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5772d8469f16SJoe PerchesEOM 5773d2c0a235SAndy Whitcroft } 5774d2c0a235SAndy Whitcroft } 5775d2c0a235SAndy Whitcroft 5776d752fcc8SJoe Perches if ($clean == 0 && $fix && 5777d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5778d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 57799624b8d6SJoe Perches my $newfile = $filename; 57809624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 57813705ce5bSJoe Perches my $linecount = 0; 57823705ce5bSJoe Perches my $f; 57833705ce5bSJoe Perches 5784d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5785d752fcc8SJoe Perches 57863705ce5bSJoe Perches open($f, '>', $newfile) 57873705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 57883705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 57893705ce5bSJoe Perches $linecount++; 57903705ce5bSJoe Perches if ($file) { 57913705ce5bSJoe Perches if ($linecount > 3) { 57923705ce5bSJoe Perches $fixed_line =~ s/^\+//; 57933705ce5bSJoe Perches print $f $fixed_line . "\n"; 57943705ce5bSJoe Perches } 57953705ce5bSJoe Perches } else { 57963705ce5bSJoe Perches print $f $fixed_line . "\n"; 57973705ce5bSJoe Perches } 57983705ce5bSJoe Perches } 57993705ce5bSJoe Perches close($f); 58003705ce5bSJoe Perches 58013705ce5bSJoe Perches if (!$quiet) { 58023705ce5bSJoe Perches print << "EOM"; 5803d8469f16SJoe Perches 58043705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 58053705ce5bSJoe Perches 58063705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 58073705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 58083705ce5bSJoe Perches 58093705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 58103705ce5bSJoe PerchesNo warranties, expressed or implied... 58113705ce5bSJoe PerchesEOM 58123705ce5bSJoe Perches } 58133705ce5bSJoe Perches } 58143705ce5bSJoe Perches 5815d8469f16SJoe Perches if ($quiet == 0) { 5816d8469f16SJoe Perches print "\n"; 5817d8469f16SJoe Perches if ($clean == 1) { 5818d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5819d8469f16SJoe Perches } else { 5820d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 58210a920b5bSAndy Whitcroft } 58220a920b5bSAndy Whitcroft } 58230a920b5bSAndy Whitcroft return $clean; 58240a920b5bSAndy Whitcroft} 5825