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 206*3c816e49SJoe 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: 587f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 588f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 589f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 590f8422308SJoe Perches)}; 591f8422308SJoe Perches 5927d2367afSJoe Perchessub deparenthesize { 5937d2367afSJoe Perches my ($string) = @_; 5947d2367afSJoe Perches return "" if (!defined($string)); 5955b9553abSJoe Perches 5965b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5975b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5985b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5995b9553abSJoe Perches } 6005b9553abSJoe Perches 6017d2367afSJoe Perches $string =~ s@\s+@ @g; 6025b9553abSJoe Perches 6037d2367afSJoe Perches return $string; 6047d2367afSJoe Perches} 6057d2367afSJoe Perches 6063445686aSJoe Perchessub seed_camelcase_file { 6073445686aSJoe Perches my ($file) = @_; 6083445686aSJoe Perches 6093445686aSJoe Perches return if (!(-f $file)); 6103445686aSJoe Perches 6113445686aSJoe Perches local $/; 6123445686aSJoe Perches 6133445686aSJoe Perches open(my $include_file, '<', "$file") 6143445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 6153445686aSJoe Perches my $text = <$include_file>; 6163445686aSJoe Perches close($include_file); 6173445686aSJoe Perches 6183445686aSJoe Perches my @lines = split('\n', $text); 6193445686aSJoe Perches 6203445686aSJoe Perches foreach my $line (@lines) { 6213445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 6223445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 6233445686aSJoe Perches $camelcase{$1} = 1; 62411ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 62511ea516aSJoe Perches $camelcase{$1} = 1; 62611ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6273445686aSJoe Perches $camelcase{$1} = 1; 6283445686aSJoe Perches } 6293445686aSJoe Perches } 6303445686aSJoe Perches} 6313445686aSJoe Perches 6323445686aSJoe Perchesmy $camelcase_seeded = 0; 6333445686aSJoe Perchessub seed_camelcase_includes { 6343445686aSJoe Perches return if ($camelcase_seeded); 6353445686aSJoe Perches 6363445686aSJoe Perches my $files; 637c707a81dSJoe Perches my $camelcase_cache = ""; 638c707a81dSJoe Perches my @include_files = (); 639c707a81dSJoe Perches 640c707a81dSJoe Perches $camelcase_seeded = 1; 641351b2a1fSJoe Perches 6423645e328SRichard Genoud if (-e ".git") { 643351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 644351b2a1fSJoe Perches chomp $git_last_include_commit; 645c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 646c707a81dSJoe Perches } else { 647c707a81dSJoe Perches my $last_mod_date = 0; 648c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 649c707a81dSJoe Perches @include_files = split('\n', $files); 650c707a81dSJoe Perches foreach my $file (@include_files) { 651c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 652c707a81dSJoe Perches localtime((stat $file)[9])); 653c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 654c707a81dSJoe Perches } 655c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 656c707a81dSJoe Perches } 657c707a81dSJoe Perches 658c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 659c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 660c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 661351b2a1fSJoe Perches while (<$camelcase_file>) { 662351b2a1fSJoe Perches chomp; 663351b2a1fSJoe Perches $camelcase{$_} = 1; 664351b2a1fSJoe Perches } 665351b2a1fSJoe Perches close($camelcase_file); 666351b2a1fSJoe Perches 667351b2a1fSJoe Perches return; 668351b2a1fSJoe Perches } 669c707a81dSJoe Perches 6703645e328SRichard Genoud if (-e ".git") { 671c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 672c707a81dSJoe Perches @include_files = split('\n', $files); 6733445686aSJoe Perches } 674c707a81dSJoe Perches 6753445686aSJoe Perches foreach my $file (@include_files) { 6763445686aSJoe Perches seed_camelcase_file($file); 6773445686aSJoe Perches } 678351b2a1fSJoe Perches 679c707a81dSJoe Perches if ($camelcase_cache ne "") { 680351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 681c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 682c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 683351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 684351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 685351b2a1fSJoe Perches } 686351b2a1fSJoe Perches close($camelcase_file); 687351b2a1fSJoe Perches } 6883445686aSJoe Perches} 6893445686aSJoe Perches 690d311cd44SJoe Perchessub git_commit_info { 691d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 692d311cd44SJoe Perches 693d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 694d311cd44SJoe Perches 695d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 696d311cd44SJoe Perches $output =~ s/^\s*//gm; 697d311cd44SJoe Perches my @lines = split("\n", $output); 698d311cd44SJoe Perches 6990d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 7000d7835fcSJoe Perches 701d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 702d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 703d311cd44SJoe Perches# all matching commit ids, but it's very slow... 704d311cd44SJoe Perches# 705d311cd44SJoe Perches# echo "checking commits $1..." 706d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 707d311cd44SJoe Perches# while read line ; do 708d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 709d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 710d311cd44SJoe Perches# done 711d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 712d311cd44SJoe Perches } else { 713d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 714d311cd44SJoe Perches $desc = substr($lines[0], 41); 715d311cd44SJoe Perches } 716d311cd44SJoe Perches 717d311cd44SJoe Perches return ($id, $desc); 718d311cd44SJoe Perches} 719d311cd44SJoe Perches 7206c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 7210a920b5bSAndy Whitcroft 72200df344fSAndy Whitcroftmy @rawlines = (); 723c2fdda0dSAndy Whitcroftmy @lines = (); 7243705ce5bSJoe Perchesmy @fixed = (); 725d752fcc8SJoe Perchesmy @fixed_inserted = (); 726d752fcc8SJoe Perchesmy @fixed_deleted = (); 727194f66fcSJoe Perchesmy $fixlinenr = -1; 728194f66fcSJoe Perches 729c2fdda0dSAndy Whitcroftmy $vname; 7306c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 73121caa13cSAndy Whitcroft my $FILE; 7326c72ffaaSAndy Whitcroft if ($file) { 73321caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7346c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 73521caa13cSAndy Whitcroft } elsif ($filename eq '-') { 73621caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7376c72ffaaSAndy Whitcroft } else { 73821caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7396c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7406c72ffaaSAndy Whitcroft } 741c2fdda0dSAndy Whitcroft if ($filename eq '-') { 742c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 743c2fdda0dSAndy Whitcroft } else { 744c2fdda0dSAndy Whitcroft $vname = $filename; 745c2fdda0dSAndy Whitcroft } 74621caa13cSAndy Whitcroft while (<$FILE>) { 7470a920b5bSAndy Whitcroft chomp; 74800df344fSAndy Whitcroft push(@rawlines, $_); 7496c72ffaaSAndy Whitcroft } 75021caa13cSAndy Whitcroft close($FILE); 751d8469f16SJoe Perches 752d8469f16SJoe Perches if ($#ARGV > 0 && $quiet == 0) { 753d8469f16SJoe Perches print '-' x length($vname) . "\n"; 754d8469f16SJoe Perches print "$vname\n"; 755d8469f16SJoe Perches print '-' x length($vname) . "\n"; 756d8469f16SJoe Perches } 757d8469f16SJoe Perches 758c2fdda0dSAndy Whitcroft if (!process($filename)) { 7590a920b5bSAndy Whitcroft $exit = 1; 7600a920b5bSAndy Whitcroft } 76100df344fSAndy Whitcroft @rawlines = (); 76213214adfSAndy Whitcroft @lines = (); 7633705ce5bSJoe Perches @fixed = (); 764d752fcc8SJoe Perches @fixed_inserted = (); 765d752fcc8SJoe Perches @fixed_deleted = (); 766194f66fcSJoe Perches $fixlinenr = -1; 767485ff23eSAlex Dowad @modifierListFile = (); 768485ff23eSAlex Dowad @typeListFile = (); 769485ff23eSAlex Dowad build_types(); 7700a920b5bSAndy Whitcroft} 7710a920b5bSAndy Whitcroft 772d8469f16SJoe Perchesif (!$quiet) { 773*3c816e49SJoe Perches hash_show_words(\%use_type, "Used"); 774*3c816e49SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 775*3c816e49SJoe 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 23200d7835fcSJoe Perches if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) { 2321d311cd44SJoe Perches my $init_char = $1; 2322d311cd44SJoe Perches my $orig_commit = lc($2); 23230d7835fcSJoe Perches my $short = 1; 23240d7835fcSJoe Perches my $long = 0; 23250d7835fcSJoe Perches my $case = 1; 23260d7835fcSJoe Perches my $space = 1; 23270d7835fcSJoe Perches my $hasdesc = 0; 232819c146a6SJoe Perches my $hasparens = 0; 23290d7835fcSJoe Perches my $id = '0123456789ab'; 23300d7835fcSJoe Perches my $orig_desc = "commit description"; 23310d7835fcSJoe Perches my $description = ""; 23320d7835fcSJoe Perches 23330d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 23340d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 23350d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 23360d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 23370d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 23380d7835fcSJoe Perches $orig_desc = $1; 233919c146a6SJoe Perches $hasparens = 1; 23400d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 23410d7835fcSJoe Perches defined $rawlines[$linenr] && 23420d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 23430d7835fcSJoe Perches $orig_desc = $1; 234419c146a6SJoe Perches $hasparens = 1; 2345b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2346b671fde0SJoe Perches defined $rawlines[$linenr] && 2347b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2348b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2349b671fde0SJoe Perches $orig_desc = $1; 2350b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2351b671fde0SJoe Perches $orig_desc .= " " . $1; 235219c146a6SJoe Perches $hasparens = 1; 23530d7835fcSJoe Perches } 23540d7835fcSJoe Perches 23550d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 23560d7835fcSJoe Perches $id, $orig_desc); 23570d7835fcSJoe Perches 235819c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2359d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 23600d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 23610d7835fcSJoe Perches } 2362d311cd44SJoe Perches } 2363d311cd44SJoe Perches 236413f1937eSJoe Perches# Check for added, moved or deleted files 236513f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 236613f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 236713f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 236813f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 236913f1937eSJoe Perches (defined($1) || defined($2))))) { 237013f1937eSJoe Perches $reported_maintainer_file = 1; 237113f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 237213f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 237313f1937eSJoe Perches } 237413f1937eSJoe Perches 237500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 23768905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2377000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2378000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 23796c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2380de7d4f0eSAndy Whitcroft } 2381de7d4f0eSAndy Whitcroft 23826ecd9674SAndy Whitcroft# Check for absolute kernel paths. 23836ecd9674SAndy Whitcroft if ($tree) { 23846ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 23856ecd9674SAndy Whitcroft my $file = $1; 23866ecd9674SAndy Whitcroft 23876ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 23886ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 23896ecd9674SAndy Whitcroft # 23906ecd9674SAndy Whitcroft } else { 23916ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 23926ecd9674SAndy Whitcroft } 23936ecd9674SAndy Whitcroft } 23946ecd9674SAndy Whitcroft } 23956ecd9674SAndy Whitcroft 2396de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2397de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2398171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2399171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2400171ae1a4SAndy Whitcroft 2401171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2402171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2403171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2404171ae1a4SAndy Whitcroft 240534d99219SJoe Perches CHK("INVALID_UTF8", 2406000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 240700df344fSAndy Whitcroft } 24080a920b5bSAndy Whitcroft 240915662b3eSJoe Perches# Check if it's the start of a commit log 241015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 241115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 241229ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 241329ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 241415662b3eSJoe Perches $in_header_lines = 0; 241515662b3eSJoe Perches $in_commit_log = 1; 241615662b3eSJoe Perches } 241715662b3eSJoe Perches 2418fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2419fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2420fa64205dSPasi Savanainen if ($in_header_lines && 2421fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2422fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2423fa64205dSPasi Savanainen $non_utf8_charset = 1; 2424fa64205dSPasi Savanainen } 2425fa64205dSPasi Savanainen 2426fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 242715662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2428fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 242915662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 243015662b3eSJoe Perches } 243115662b3eSJoe Perches 243266b47b4aSKees Cook# Check for various typo / spelling mistakes 243366d7a382SJoe Perches if (defined($misspellings) && 243466d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2435ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 243666b47b4aSKees Cook my $typo = $1; 243766b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 243866b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 243966b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 244066b47b4aSKees Cook my $msg_type = \&WARN; 244166b47b4aSKees Cook $msg_type = \&CHK if ($file); 244266b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 244366b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 244466b47b4aSKees Cook $fix) { 244566b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 244666b47b4aSKees Cook } 244766b47b4aSKees Cook } 244866b47b4aSKees Cook } 244966b47b4aSKees Cook 245030670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 245130670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 245200df344fSAndy Whitcroft 24530a920b5bSAndy Whitcroft#trailing whitespace 24549c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2455c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2456d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2457d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2458d5e616fcSJoe Perches $fix) { 2459194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2460d5e616fcSJoe Perches } 2461c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2462c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24633705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 24643705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 24653705ce5bSJoe Perches $fix) { 2466194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 24673705ce5bSJoe Perches } 24683705ce5bSJoe Perches 2469d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 24700a920b5bSAndy Whitcroft } 24715368df20SAndy Whitcroft 24724783f894SJosh Triplett# Check for FSF mailing addresses. 2473109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 24743e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 24753e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 24764783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 24774783f894SJosh Triplett my $msg_type = \&ERROR; 24784783f894SJosh Triplett $msg_type = \&CHK if ($file); 24794783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 24804783f894SJosh 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) 24814783f894SJosh Triplett } 24824783f894SJosh Triplett 24833354957aSAndi Kleen# check for Kconfig help text having a real description 24849fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 24859fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 24863354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 24878d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 24883354957aSAndi Kleen my $length = 0; 24899fe287d7SAndy Whitcroft my $cnt = $realcnt; 24909fe287d7SAndy Whitcroft my $ln = $linenr + 1; 24919fe287d7SAndy Whitcroft my $f; 2492a1385803SAndy Whitcroft my $is_start = 0; 24939fe287d7SAndy Whitcroft my $is_end = 0; 2494a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 24959fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 24969fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 24979fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 24989fe287d7SAndy Whitcroft 24999fe287d7SAndy Whitcroft next if ($f =~ /^-/); 25008d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2501a1385803SAndy Whitcroft 25028d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2503a1385803SAndy Whitcroft $is_start = 1; 25048d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2505a1385803SAndy Whitcroft $length = -1; 2506a1385803SAndy Whitcroft } 2507a1385803SAndy Whitcroft 25089fe287d7SAndy Whitcroft $f =~ s/^.//; 25093354957aSAndi Kleen $f =~ s/#.*//; 25103354957aSAndi Kleen $f =~ s/^\s+//; 25113354957aSAndi Kleen next if ($f =~ /^$/); 25129fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 25139fe287d7SAndy Whitcroft $is_end = 1; 25149fe287d7SAndy Whitcroft last; 25159fe287d7SAndy Whitcroft } 25163354957aSAndi Kleen $length++; 25173354957aSAndi Kleen } 251856193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2519000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 252056193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 252156193274SVadim Bendebury } 2522a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 25233354957aSAndi Kleen } 25243354957aSAndi Kleen 25251ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 25261ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 25271ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 25281ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 25291ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 25301ba8dfd1SKees Cook } 25311ba8dfd1SKees Cook 2532327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2533327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2534327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2535327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2536327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2537327953e9SChristoph Jaeger } 2538327953e9SChristoph Jaeger 2539c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2540c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2541c68e5878SArnaud Lacombe my $flag = $1; 2542c68e5878SArnaud Lacombe my $replacement = { 2543c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2544c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2545c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2546c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2547c68e5878SArnaud Lacombe }; 2548c68e5878SArnaud Lacombe 2549c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2550c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2551c68e5878SArnaud Lacombe } 2552c68e5878SArnaud Lacombe 2553bff5da43SRob Herring# check for DT compatible documentation 25547dd05b38SFlorian Vaussard if (defined $root && 25557dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 25567dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 25577dd05b38SFlorian Vaussard 2558bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2559bff5da43SRob Herring 2560cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2561cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2562cc93319bSFlorian Vaussard 2563bff5da43SRob Herring foreach my $compat (@compats) { 2564bff5da43SRob Herring my $compat2 = $compat; 2565185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2566185d566bSRob Herring my $compat3 = $compat; 2567185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2568185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2569bff5da43SRob Herring if ( $? >> 8 ) { 2570bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2571bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2572bff5da43SRob Herring } 2573bff5da43SRob Herring 25744fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 25754fbf32a6SFlorian Vaussard my $vendor = $1; 2576cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2577bff5da43SRob Herring if ( $? >> 8 ) { 2578bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2579cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2580bff5da43SRob Herring } 2581bff5da43SRob Herring } 2582bff5da43SRob Herring } 2583bff5da43SRob Herring 25845368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2585de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 25865368df20SAndy Whitcroft 258747e0c88bSJoe Perches# line length limit (with some exclusions) 258847e0c88bSJoe Perches# 258947e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length: 259047e0c88bSJoe Perches# logging functions like pr_info that end in a string 259147e0c88bSJoe Perches# lines with a single string 259247e0c88bSJoe Perches# #defines that are a single string 259347e0c88bSJoe Perches# 259447e0c88bSJoe Perches# There are 3 different line length message types: 259547e0c88bSJoe Perches# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength 259647e0c88bSJoe Perches# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 259747e0c88bSJoe Perches# LONG_LINE all other lines longer than $max_line_length 259847e0c88bSJoe Perches# 259947e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored 260047e0c88bSJoe Perches# 260147e0c88bSJoe Perches 260247e0c88bSJoe Perches if ($length > $max_line_length) { 260347e0c88bSJoe Perches my $msg_type = "LONG_LINE"; 260447e0c88bSJoe Perches 260547e0c88bSJoe Perches # Check the allowed long line types first 260647e0c88bSJoe Perches 260747e0c88bSJoe Perches # logging functions that end in a string that starts 260847e0c88bSJoe Perches # before $max_line_length 260947e0c88bSJoe Perches if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 261047e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 261147e0c88bSJoe Perches $msg_type = ""; 261247e0c88bSJoe Perches 261347e0c88bSJoe Perches # lines with only strings (w/ possible termination) 261447e0c88bSJoe Perches # #defines with only strings 261547e0c88bSJoe Perches } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 261647e0c88bSJoe Perches $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 261747e0c88bSJoe Perches $msg_type = ""; 261847e0c88bSJoe Perches 261947e0c88bSJoe Perches # Otherwise set the alternate message types 262047e0c88bSJoe Perches 262147e0c88bSJoe Perches # a comment starts before $max_line_length 262247e0c88bSJoe Perches } elsif ($line =~ /($;[\s$;]*)$/ && 262347e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 262447e0c88bSJoe Perches $msg_type = "LONG_LINE_COMMENT" 262547e0c88bSJoe Perches 262647e0c88bSJoe Perches # a quoted string starts before $max_line_length 262747e0c88bSJoe Perches } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 262847e0c88bSJoe Perches length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 262947e0c88bSJoe Perches $msg_type = "LONG_LINE_STRING" 263047e0c88bSJoe Perches } 263147e0c88bSJoe Perches 263247e0c88bSJoe Perches if ($msg_type ne "" && 263347e0c88bSJoe Perches (show_type("LONG_LINE") || show_type($msg_type))) { 263447e0c88bSJoe Perches WARN($msg_type, 26356cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 26360a920b5bSAndy Whitcroft } 263747e0c88bSJoe Perches } 26380a920b5bSAndy Whitcroft 26398905a67cSAndy Whitcroft# check for adding lines without a newline. 26408905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2641000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2642000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 26438905a67cSAndy Whitcroft } 26448905a67cSAndy Whitcroft 264542e41c54SMike Frysinger# Blackfin: use hi/lo macros 264642e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 264742e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 264842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2649000d1cc1SJoe Perches ERROR("LO_MACRO", 2650000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 265142e41c54SMike Frysinger } 265242e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 265342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2654000d1cc1SJoe Perches ERROR("HI_MACRO", 2655000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 265642e41c54SMike Frysinger } 265742e41c54SMike Frysinger } 265842e41c54SMike Frysinger 2659b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2660de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 26610a920b5bSAndy Whitcroft 26620a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 26630a920b5bSAndy Whitcroft# more than 8 must use tabs. 2664c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2665c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2666c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2667d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 26683705ce5bSJoe Perches if (ERROR("CODE_INDENT", 26693705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 26703705ce5bSJoe Perches $fix) { 2671194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 26723705ce5bSJoe Perches } 26730a920b5bSAndy Whitcroft } 26740a920b5bSAndy Whitcroft 267508e44365SAlberto Panizzo# check for space before tabs. 267608e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 267708e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 26783705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 26793705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 26803705ce5bSJoe Perches $fix) { 2681194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2682d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2683194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2684c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 26853705ce5bSJoe Perches } 268608e44365SAlberto Panizzo } 268708e44365SAlberto Panizzo 2688d1fe9c09SJoe Perches# check for && or || at the start of a line 2689d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2690d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2691d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2692d1fe9c09SJoe Perches } 2693d1fe9c09SJoe Perches 2694d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2695d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 269691cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2697d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2698d1fe9c09SJoe Perches my $oldindent = $1; 2699d1fe9c09SJoe Perches my $rest = $2; 2700d1fe9c09SJoe Perches 2701d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2702d1fe9c09SJoe Perches if ($pos >= 0) { 2703b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2704b34a26f3SJoe Perches my $newindent = $2; 2705d1fe9c09SJoe Perches 2706d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2707d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2708d1fe9c09SJoe Perches " " x ($pos % 8); 2709d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2710d1fe9c09SJoe Perches 2711d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2712d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 27133705ce5bSJoe Perches 27143705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 27153705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 27163705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2717194f66fcSJoe Perches $fixed[$fixlinenr] =~ 27183705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 27193705ce5bSJoe Perches } 2720d1fe9c09SJoe Perches } 2721d1fe9c09SJoe Perches } 2722d1fe9c09SJoe Perches } 2723d1fe9c09SJoe Perches 27246ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 27256ab3a970SJoe Perches# avoid checking a few false positives: 27266ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 27276ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 27286ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 27296ab3a970SJoe Perches# multiline macros that define functions 27306ab3a970SJoe Perches# known attributes or the __attribute__ keyword 27316ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 27326ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 27333705ce5bSJoe Perches if (CHK("SPACING", 2734f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 27353705ce5bSJoe Perches $fix) { 2736194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2737f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 27383705ce5bSJoe Perches } 2739aad4f614SJoe Perches } 2740aad4f614SJoe Perches 274105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2742fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 274385ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 274485ad978cSJoe Perches $realline > 2) { 274505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 274605880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 274705880600SJoe Perches } 274805880600SJoe Perches 274905880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2750a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2751a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 275261135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2753a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2754a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2755a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2756a605e32eSJoe Perches } 2757a605e32eSJoe Perches 2758a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2759c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2760c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2761c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2762c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 276305880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 276405880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 276505880600SJoe Perches } 276605880600SJoe Perches 27677f619191SJoe Perches# check for missing blank lines after struct/union declarations 27687f619191SJoe Perches# with exceptions for various attributes and macros 27697f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 27707f619191SJoe Perches $line =~ /^\+/ && 27717f619191SJoe Perches !($line =~ /^\+\s*$/ || 27727f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 27737f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 27747f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 27757f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 27767f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 27777f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 27787f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2779d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2780d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2781d752fcc8SJoe Perches $fix) { 2782f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2783d752fcc8SJoe Perches } 27847f619191SJoe Perches } 27857f619191SJoe Perches 2786365dd4eaSJoe Perches# check for multiple consecutive blank lines 2787365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2788365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2789365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2790d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2791d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2792d752fcc8SJoe Perches $fix) { 2793f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2794d752fcc8SJoe Perches } 2795d752fcc8SJoe Perches 2796365dd4eaSJoe Perches $last_blank_line = $linenr; 2797365dd4eaSJoe Perches } 2798365dd4eaSJoe Perches 27993b617e3bSJoe Perches# check for missing blank lines after declarations 28003f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 28013f7bac03SJoe Perches # actual declarations 28023f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28035a4e1fd3SJoe Perches # function pointer declarations 28045a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28053f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28063f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28073f7bac03SJoe Perches # known declaration macros 28083f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 28093f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 28103f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 28113f7bac03SJoe Perches # other possible extensions of declaration lines 28123f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 28133f7bac03SJoe Perches # not starting a section or a macro "\" extended line 28143f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 28153f7bac03SJoe Perches # looks like a declaration 28163f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 28175a4e1fd3SJoe Perches # function pointer declarations 28185a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 28193f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 28203f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 28213f7bac03SJoe Perches # known declaration macros 28223f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 28233f7bac03SJoe Perches # start of struct or union or enum 28243b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 28253f7bac03SJoe Perches # start or end of block or continuation of declaration 28263f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 28273f7bac03SJoe Perches # bitfield continuation 28283f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 28293f7bac03SJoe Perches # other possible extensions of declaration lines 28303f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 28313f7bac03SJoe Perches # indentation of previous and current line are the same 28323f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2833d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2834d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2835d752fcc8SJoe Perches $fix) { 2836f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2837d752fcc8SJoe Perches } 28383b617e3bSJoe Perches } 28393b617e3bSJoe Perches 28405f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 28416b4c5bebSAndy Whitcroft# Exceptions: 28426b4c5bebSAndy Whitcroft# 1) within comments 28436b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 28446b4c5bebSAndy Whitcroft# 3) hanging labels 28453705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 28465f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 28473705ce5bSJoe Perches if (WARN("LEADING_SPACE", 28483705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 28493705ce5bSJoe Perches $fix) { 2850194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 28513705ce5bSJoe Perches } 28525f7ddae6SRaffaele Recalcati } 28535f7ddae6SRaffaele Recalcati 2854b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2855b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2856b9ea10d6SAndy Whitcroft 2857032a4c0fSJoe Perches# check indentation of any line with a bare else 2858840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2859032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2860032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2861032a4c0fSJoe Perches my $tabs = length($1) + 1; 2862840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2863840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2864840080a0SJoe Perches defined $lines[$linenr] && 2865840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2866032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2867032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2868032a4c0fSJoe Perches } 2869032a4c0fSJoe Perches } 2870032a4c0fSJoe Perches 2871c00df19aSJoe Perches# check indentation of a line with a break; 2872c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2873c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2874c00df19aSJoe Perches my $tabs = $1; 2875c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2876c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2877c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2878c00df19aSJoe Perches } 2879c00df19aSJoe Perches } 2880c00df19aSJoe Perches 28811ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 28821ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 28831ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 28841ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 28851ba8dfd1SKees Cook } 28861ba8dfd1SKees Cook 2887c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2888cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2889000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2890000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2891c2fdda0dSAndy Whitcroft } 289222f2a2efSAndy Whitcroft 289342e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 289442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 289542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2896000d1cc1SJoe Perches ERROR("CSYNC", 2897000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 289842e41c54SMike Frysinger } 289942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 290042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2901000d1cc1SJoe Perches ERROR("SSYNC", 2902000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 290342e41c54SMike Frysinger } 290442e41c54SMike Frysinger 290556e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 290656e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 290756e77d70SJoe Perches WARN("HOTPLUG_SECTION", 290856e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 290956e77d70SJoe Perches } 291056e77d70SJoe Perches 29119c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 29122b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 29132b474a1aSAndy Whitcroft $realline_next); 29143e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 29153e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 29161b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2917170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2918f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2919171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2920171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2921171ae1a4SAndy Whitcroft 29223e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 29233e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 29243e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 29253e469cdcSAndy Whitcroft # until we hit end of it. 29263e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 29273e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 29283e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 29293e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 29303e469cdcSAndy Whitcroft } 2931f74bd194SAndy Whitcroft 29322b474a1aSAndy Whitcroft # Find the real next line. 29332b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 29342b474a1aSAndy Whitcroft if (defined $realline_next && 29352b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 29362b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 29372b474a1aSAndy Whitcroft $realline_next++; 29382b474a1aSAndy Whitcroft } 29392b474a1aSAndy Whitcroft 2940171ae1a4SAndy Whitcroft my $s = $stat; 2941171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2942cf655043SAndy Whitcroft 2943c2fdda0dSAndy Whitcroft # Ignore goto labels. 2944171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2945c2fdda0dSAndy Whitcroft 2946c2fdda0dSAndy Whitcroft # Ignore functions being called 2947171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2948c2fdda0dSAndy Whitcroft 2949463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2950463f2864SAndy Whitcroft 2951c45dcabdSAndy Whitcroft # declarations always start with types 2952d2506586SAndy 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) { 2953c45dcabdSAndy Whitcroft my $type = $1; 2954c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2955c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2956c45dcabdSAndy Whitcroft 29576c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2958a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2959c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2960c2fdda0dSAndy Whitcroft } 29618905a67cSAndy Whitcroft 29626c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 296365863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2964c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 29659c0ca6f9SAndy Whitcroft } 29668905a67cSAndy Whitcroft 29678905a67cSAndy Whitcroft # Check for any sort of function declaration. 29688905a67cSAndy Whitcroft # int foo(something bar, other baz); 29698905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2970171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 29718905a67cSAndy Whitcroft my ($name_len) = length($1); 29728905a67cSAndy Whitcroft 2973cf655043SAndy Whitcroft my $ctx = $s; 2974773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 29758905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2976cf655043SAndy Whitcroft 29778905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2978c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 29798905a67cSAndy Whitcroft 2980c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 29818905a67cSAndy Whitcroft } 29828905a67cSAndy Whitcroft } 29838905a67cSAndy Whitcroft } 29848905a67cSAndy Whitcroft 29859c0ca6f9SAndy Whitcroft } 29869c0ca6f9SAndy Whitcroft 298700df344fSAndy Whitcroft# 298800df344fSAndy Whitcroft# Checks which may be anchored in the context. 298900df344fSAndy Whitcroft# 299000df344fSAndy Whitcroft 299100df344fSAndy Whitcroft# Check for switch () and associated case and default 299200df344fSAndy Whitcroft# statements should be at the same indent. 299300df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 299400df344fSAndy Whitcroft my $err = ''; 299500df344fSAndy Whitcroft my $sep = ''; 299600df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 299700df344fSAndy Whitcroft shift(@ctx); 299800df344fSAndy Whitcroft for my $ctx (@ctx) { 299900df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 300000df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 300100df344fSAndy Whitcroft $indent != $cindent) { 300200df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 300300df344fSAndy Whitcroft $sep = ''; 300400df344fSAndy Whitcroft } else { 300500df344fSAndy Whitcroft $sep = "[...]\n"; 300600df344fSAndy Whitcroft } 300700df344fSAndy Whitcroft } 300800df344fSAndy Whitcroft if ($err ne '') { 3009000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 3010000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 3011de7d4f0eSAndy Whitcroft } 3012de7d4f0eSAndy Whitcroft } 3013de7d4f0eSAndy Whitcroft 3014de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 3015de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 30160fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 3017773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 3018773647a0SAndy Whitcroft 30199c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 30208eef05ddSJoe Perches 30218eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 30228eef05ddSJoe Perches WARN("DEEP_INDENTATION", 30238eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 30248eef05ddSJoe Perches } 30258eef05ddSJoe Perches 3026de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 3027de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 3028de7d4f0eSAndy Whitcroft 3029548596d5SAndy Whitcroft my $ctx_ln = $linenr; 3030548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 3031de7d4f0eSAndy Whitcroft 3032548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 3033548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 3034548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 3035548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 3036548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 3037773647a0SAndy Whitcroft $ctx_ln++; 3038773647a0SAndy Whitcroft } 3039548596d5SAndy Whitcroft 304053210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 304153210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 3042773647a0SAndy Whitcroft 3043773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 3044000d1cc1SJoe Perches ERROR("OPEN_BRACE", 3045000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 304601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 304700df344fSAndy Whitcroft } 3048773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 3049773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 3050773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 3051773647a0SAndy Whitcroft { 30529c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 30539c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 3054000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 3055000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 305601464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 30579c0ca6f9SAndy Whitcroft } 30589c0ca6f9SAndy Whitcroft } 305900df344fSAndy Whitcroft } 306000df344fSAndy Whitcroft 30614d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 30620fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 30633e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 30643e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 30653e469cdcSAndy Whitcroft if (!defined $stat); 30664d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 30674d001e4dSAndy Whitcroft 30684d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 30694d001e4dSAndy Whitcroft 30704d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 30714d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 30724d001e4dSAndy Whitcroft # where necessary. 30734d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 30744d001e4dSAndy Whitcroft 30754d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 30766f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 30776f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 30784d001e4dSAndy Whitcroft 30794d001e4dSAndy Whitcroft # We want to check the first line inside the block 30804d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 30814d001e4dSAndy Whitcroft # 1) any blank line termination 30824d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 30834d001e4dSAndy Whitcroft # 3) any do (...) { 30844d001e4dSAndy Whitcroft my $continuation = 0; 30854d001e4dSAndy Whitcroft my $check = 0; 30864d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 30874d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 30884d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 30894d001e4dSAndy Whitcroft $continuation = 1; 30904d001e4dSAndy Whitcroft } 30919bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 30924d001e4dSAndy Whitcroft $check = 1; 30934d001e4dSAndy Whitcroft $cond_lines++; 30944d001e4dSAndy Whitcroft } 30954d001e4dSAndy Whitcroft 30964d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 30974d001e4dSAndy Whitcroft # preprocessor statement. 30984d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 30994d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 31004d001e4dSAndy Whitcroft $check = 0; 31014d001e4dSAndy Whitcroft } 31024d001e4dSAndy Whitcroft 31039bd49efeSAndy Whitcroft my $cond_ptr = -1; 3104740504c6SAndy Whitcroft $continuation = 0; 31059bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 31069bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 31074d001e4dSAndy Whitcroft 3108f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 3109f16fa28fSAndy Whitcroft # is not linear. 3110f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 3111f16fa28fSAndy Whitcroft $check = 0; 3112f16fa28fSAndy Whitcroft } 3113f16fa28fSAndy Whitcroft 31149bd49efeSAndy Whitcroft # Ignore: 31159bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 31169bd49efeSAndy Whitcroft # 2) preprocessor lines, and 31179bd49efeSAndy Whitcroft # 3) labels. 3118740504c6SAndy Whitcroft if ($continuation || 3119740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 31209bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 31219bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 3122740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 312330dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 31249bd49efeSAndy Whitcroft $cond_lines++; 31259bd49efeSAndy Whitcroft } 31264d001e4dSAndy Whitcroft } 312730dad6ebSAndy Whitcroft } 31284d001e4dSAndy Whitcroft 31294d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 31304d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 31314d001e4dSAndy Whitcroft 31324d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 31334d001e4dSAndy Whitcroft # this is not this patch's fault. 31344d001e4dSAndy Whitcroft if (!defined($stat_real) || 31354d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 31364d001e4dSAndy Whitcroft $check = 0; 31374d001e4dSAndy Whitcroft } 31384d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 31394d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 31404d001e4dSAndy Whitcroft } 31414d001e4dSAndy Whitcroft 31429bd49efeSAndy 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"; 31434d001e4dSAndy Whitcroft 31444d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 31454d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 3146000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3147000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 31484d001e4dSAndy Whitcroft } 31494d001e4dSAndy Whitcroft } 31504d001e4dSAndy Whitcroft 31516c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 31526c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 31531f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 31541f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 31556c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3156c2fdda0dSAndy Whitcroft if ($dbg_values) { 3157c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3158cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3159cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 31601f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3161c2fdda0dSAndy Whitcroft } 31626c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 31636c72ffaaSAndy Whitcroft 316400df344fSAndy Whitcroft#ignore lines not being added 31653705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 316600df344fSAndy Whitcroft 3167653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 31687429c690SAndy Whitcroft if ($dbg_type) { 31697429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3170000d1cc1SJoe Perches ERROR("TEST_TYPE", 3171000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 31727429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3173000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3174000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 31757429c690SAndy Whitcroft } 3176653d4876SAndy Whitcroft next; 3177653d4876SAndy Whitcroft } 3178a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3179a1ef277eSAndy Whitcroft if ($dbg_attr) { 31809360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3181000d1cc1SJoe Perches ERROR("TEST_ATTR", 3182000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 31839360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3184000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3185000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3186a1ef277eSAndy Whitcroft } 3187a1ef277eSAndy Whitcroft next; 3188a1ef277eSAndy Whitcroft } 3189653d4876SAndy Whitcroft 3190f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 319199423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 319299423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3193d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3194d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3195f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3196f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3197f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3198d752fcc8SJoe Perches my $fixedline = $prevrawline; 3199d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3200f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3201d752fcc8SJoe Perches $fixedline = $line; 3202d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3203f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3204d752fcc8SJoe Perches } 3205f0a594c1SAndy Whitcroft } 3206f0a594c1SAndy Whitcroft 320700df344fSAndy Whitcroft# 320800df344fSAndy Whitcroft# Checks which are anchored on the added line. 320900df344fSAndy Whitcroft# 321000df344fSAndy Whitcroft 3211653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3212c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3213653d4876SAndy Whitcroft my $path = $1; 3214653d4876SAndy Whitcroft if ($path =~ m{//}) { 3215000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3216495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3217495e9d84SJoe Perches } 3218495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3219495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3220495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3221653d4876SAndy Whitcroft } 3222653d4876SAndy Whitcroft } 3223653d4876SAndy Whitcroft 322400df344fSAndy Whitcroft# no C99 // comments 322500df344fSAndy Whitcroft if ($line =~ m{//}) { 32263705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 32273705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 32283705ce5bSJoe Perches $fix) { 3229194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 32303705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 32313705ce5bSJoe Perches my $comment = trim($1); 3232194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 32333705ce5bSJoe Perches } 32343705ce5bSJoe Perches } 323500df344fSAndy Whitcroft } 323600df344fSAndy Whitcroft # Remove C99 comments. 32370a920b5bSAndy Whitcroft $line =~ s@//.*@@; 32386c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 32390a920b5bSAndy Whitcroft 32402b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 32412b474a1aSAndy Whitcroft# the whole statement. 32422b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 32432b474a1aSAndy Whitcroft if (defined $realline_next && 32442b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 32452b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 32462b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32472b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32483cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 32493cbf62dfSAndy Whitcroft # a prefix: 32503cbf62dfSAndy Whitcroft # XXX(foo); 32513cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3252653d4876SAndy Whitcroft my $name = $1; 325387a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 32543cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 32553cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 32563cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 32573cbf62dfSAndy Whitcroft 32583cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 32592b474a1aSAndy Whitcroft \n.}\s*$| 326048012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 326148012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 326248012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 32632b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 32642b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 326548012058SAndy Whitcroft )/x) { 32662b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 32672b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 32682b474a1aSAndy Whitcroft } else { 32692b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 32700a920b5bSAndy Whitcroft } 32710a920b5bSAndy Whitcroft } 32722b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 32732b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 32742b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 32752b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 32762b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 32772b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 32782b474a1aSAndy Whitcroft } 32792b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 32802b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3281000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3282000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 32832b474a1aSAndy Whitcroft } 32840a920b5bSAndy Whitcroft 32855150bda4SJoe Eloff# check for global initialisers. 32865129e87cSJoe Perches if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) { 3287d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3288000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3289d5e616fcSJoe Perches $herecurr) && 3290d5e616fcSJoe Perches $fix) { 32915129e87cSJoe Perches $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/; 3292d5e616fcSJoe Perches } 3293f0a594c1SAndy Whitcroft } 32940a920b5bSAndy Whitcroft# check for static initialisers. 3295d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3296d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3297000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3298d5e616fcSJoe Perches $herecurr) && 3299d5e616fcSJoe Perches $fix) { 3300194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3301d5e616fcSJoe Perches } 33020a920b5bSAndy Whitcroft } 33030a920b5bSAndy Whitcroft 33041813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 33051813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 33061813087dSJoe Perches my $tmp = trim($1); 33071813087dSJoe Perches WARN("MISORDERED_TYPE", 33081813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 33091813087dSJoe Perches } 33101813087dSJoe Perches 3311cb710ecaSJoe Perches# check for static const char * arrays. 3312cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3313000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3314000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3315cb710ecaSJoe Perches $herecurr); 3316cb710ecaSJoe Perches } 3317cb710ecaSJoe Perches 3318cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3319cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3320000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3321000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3322cb710ecaSJoe Perches $herecurr); 3323cb710ecaSJoe Perches } 3324cb710ecaSJoe Perches 3325ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type 3326ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 3327ab7e23f3SJoe Perches my $found = $1; 3328ab7e23f3SJoe Perches if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 3329ab7e23f3SJoe Perches WARN("CONST_CONST", 3330ab7e23f3SJoe Perches "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 3331ab7e23f3SJoe Perches } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 3332ab7e23f3SJoe Perches WARN("CONST_CONST", 3333ab7e23f3SJoe Perches "'const $found const' should probably be 'const $found'\n" . $herecurr); 3334ab7e23f3SJoe Perches } 3335ab7e23f3SJoe Perches } 3336ab7e23f3SJoe Perches 33379b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 33389b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 33399b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 33409b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 33419b0fa60dSJoe Perches $herecurr); 33429b0fa60dSJoe Perches } 33439b0fa60dSJoe Perches 3344b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 3345b598b670SJoe Perches if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 3346b598b670SJoe Perches my $array = $1; 3347b598b670SJoe 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*\))@) { 3348b598b670SJoe Perches my $array_div = $1; 3349b598b670SJoe Perches if (WARN("ARRAY_SIZE", 3350b598b670SJoe Perches "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 3351b598b670SJoe Perches $fix) { 3352b598b670SJoe Perches $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 3353b598b670SJoe Perches } 3354b598b670SJoe Perches } 3355b598b670SJoe Perches } 3356b598b670SJoe Perches 3357b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3358b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3359b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3360b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3361b36190c5SJoe Perches $fix) { 3362194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3363b36190c5SJoe Perches } 3364b36190c5SJoe Perches } 3365b36190c5SJoe Perches 336692e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 336792e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 336892e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 336992e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 337092e112fdSJoe Perches $fix) { 3371194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 337292e112fdSJoe Perches } 337393ed0e2dSJoe Perches } 337493ed0e2dSJoe Perches 3375653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3376653d4876SAndy Whitcroft# make sense. 3377653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 33788054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3379c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 33808ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3381653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3382000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3383000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 33840a920b5bSAndy Whitcroft } 33850a920b5bSAndy Whitcroft 33860a920b5bSAndy Whitcroft# * goes on variable not on type 338765863862SAndy Whitcroft # (char*[ const]) 3388bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3389bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 33903705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3391d8aaf121SAndy Whitcroft 339265863862SAndy Whitcroft # Should start with a space. 339365863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 339465863862SAndy Whitcroft # Should not end with a space. 339565863862SAndy Whitcroft $to =~ s/\s+$//; 339665863862SAndy Whitcroft # '*'s should not have spaces between. 3397f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 339865863862SAndy Whitcroft } 3399d8aaf121SAndy Whitcroft 34003705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 340165863862SAndy Whitcroft if ($from ne $to) { 34023705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34033705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 34043705ce5bSJoe Perches $fix) { 34053705ce5bSJoe Perches my $sub_from = $ident; 34063705ce5bSJoe Perches my $sub_to = $ident; 34073705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3408194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34093705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34103705ce5bSJoe Perches } 341165863862SAndy Whitcroft } 3412bfcb2cc7SAndy Whitcroft } 3413bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3414bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 34153705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3416d8aaf121SAndy Whitcroft 341765863862SAndy Whitcroft # Should start with a space. 341865863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 341965863862SAndy Whitcroft # Should not end with a space. 342065863862SAndy Whitcroft $to =~ s/\s+$//; 342165863862SAndy Whitcroft # '*'s should not have spaces between. 3422f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 342365863862SAndy Whitcroft } 342465863862SAndy Whitcroft # Modifiers should have spaces. 342565863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 342665863862SAndy Whitcroft 34273705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3428667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 34293705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 34303705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 34313705ce5bSJoe Perches $fix) { 34323705ce5bSJoe Perches 34333705ce5bSJoe Perches my $sub_from = $match; 34343705ce5bSJoe Perches my $sub_to = $match; 34353705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3436194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34373705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 34383705ce5bSJoe Perches } 343965863862SAndy Whitcroft } 34400a920b5bSAndy Whitcroft } 34410a920b5bSAndy Whitcroft 34420a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 34430a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 34440a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 34450a920b5bSAndy Whitcroft# print "$herecurr"; 34460a920b5bSAndy Whitcroft# $clean = 0; 34470a920b5bSAndy Whitcroft# } 34480a920b5bSAndy Whitcroft 34498905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3450000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3451000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 34528905a67cSAndy Whitcroft } 34538905a67cSAndy Whitcroft 345417441227SJoe Perches# check for uses of printk_ratelimit 345517441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3456000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3457000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 345817441227SJoe Perches } 345917441227SJoe Perches 346000df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 346100df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 346200df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 346325985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 346400df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3465f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 346600df344fSAndy Whitcroft my $ok = 0; 346700df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 346800df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 346925985edcSLucas De Marchi # we have a preceding printk if it ends 347000df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 347100df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 347200df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 347300df344fSAndy Whitcroft $ok = 1; 347400df344fSAndy Whitcroft } 347500df344fSAndy Whitcroft last; 347600df344fSAndy Whitcroft } 347700df344fSAndy Whitcroft } 347800df344fSAndy Whitcroft if ($ok == 0) { 3479000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3480000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 34810a920b5bSAndy Whitcroft } 348200df344fSAndy Whitcroft } 34830a920b5bSAndy Whitcroft 3484243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3485243f3803SJoe Perches my $orig = $1; 3486243f3803SJoe Perches my $level = lc($orig); 3487243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 34888f26b837SJoe Perches my $level2 = $level; 34898f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3490243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3491daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3492243f3803SJoe Perches } 3493243f3803SJoe Perches 3494243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3495d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3496d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3497d5e616fcSJoe Perches $fix) { 3498194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3499d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3500d5e616fcSJoe Perches } 3501243f3803SJoe Perches } 3502243f3803SJoe Perches 3503dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3504dc139313SJoe Perches my $orig = $1; 3505dc139313SJoe Perches my $level = lc($orig); 3506dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3507dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3508dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3509dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3510dc139313SJoe Perches } 3511dc139313SJoe Perches 351291c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else. This will have a small 351391c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at 351491c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning. 351591c9afafSAndy Lutomirski if ($line =~ /\bENOSYS\b/) { 351691c9afafSAndy Lutomirski WARN("ENOSYS", 351791c9afafSAndy Lutomirski "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 351891c9afafSAndy Lutomirski } 351991c9afafSAndy Lutomirski 3520653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3521653d4876SAndy Whitcroft# or if closed on same line 35228d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3523c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 35248d182478SJoe Perches if (ERROR("OPEN_BRACE", 35258d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 35268d182478SJoe Perches $fix) { 35278d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35288d182478SJoe Perches my $fixed_line = $rawline; 35298d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 35308d182478SJoe Perches my $line1 = $1; 35318d182478SJoe Perches my $line2 = $2; 35328d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 35338d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 35348d182478SJoe Perches if ($line2 !~ /^\s*$/) { 35358d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 35368d182478SJoe Perches } 35378d182478SJoe Perches } 35380a920b5bSAndy Whitcroft } 3539653d4876SAndy Whitcroft 35408905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 35418905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 35428905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 35438d182478SJoe Perches if (ERROR("OPEN_BRACE", 35448d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 35458d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 35468d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 35478d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 35488d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 35498d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35508d182478SJoe Perches $fixedline = $rawline; 35518d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 35528d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 35538d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 35548d182478SJoe Perches } 35558d182478SJoe Perches } 35568905a67cSAndy Whitcroft } 35578905a67cSAndy Whitcroft 35580c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 35593705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 35603705ce5bSJoe Perches if (WARN("SPACING", 35613705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 35623705ce5bSJoe Perches $fix) { 3563194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35643705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 35653705ce5bSJoe Perches } 35660c73b4ebSAndy Whitcroft } 35670c73b4ebSAndy Whitcroft 356831070b5dSJoe Perches# Function pointer declarations 356931070b5dSJoe Perches# check spacing between type, funcptr, and args 357031070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 357191f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 357231070b5dSJoe Perches my $declare = $1; 357331070b5dSJoe Perches my $pre_pointer_space = $2; 357431070b5dSJoe Perches my $post_pointer_space = $3; 357531070b5dSJoe Perches my $funcname = $4; 357631070b5dSJoe Perches my $post_funcname_space = $5; 357731070b5dSJoe Perches my $pre_args_space = $6; 357831070b5dSJoe Perches 357991f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 358091f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 358191f72e9cSJoe Perches# don't need a space so don't warn for those. 358291f72e9cSJoe Perches my $post_declare_space = ""; 358391f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 358491f72e9cSJoe Perches $post_declare_space = $1; 358591f72e9cSJoe Perches $declare = rtrim($declare); 358691f72e9cSJoe Perches } 358791f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 358831070b5dSJoe Perches WARN("SPACING", 358931070b5dSJoe Perches "missing space after return type\n" . $herecurr); 359091f72e9cSJoe Perches $post_declare_space = " "; 359131070b5dSJoe Perches } 359231070b5dSJoe Perches 359331070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 359491f72e9cSJoe Perches# This test is not currently implemented because these declarations are 359591f72e9cSJoe Perches# equivalent to 359691f72e9cSJoe Perches# int foo(int bar, ...) 359791f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 359891f72e9cSJoe Perches# 359991f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 360091f72e9cSJoe Perches# WARN("SPACING", 360191f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 360291f72e9cSJoe Perches# } 360331070b5dSJoe Perches 360431070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 360531070b5dSJoe Perches if (defined $pre_pointer_space && 360631070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 360731070b5dSJoe Perches WARN("SPACING", 360831070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 360931070b5dSJoe Perches } 361031070b5dSJoe Perches 361131070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 361231070b5dSJoe Perches if (defined $post_pointer_space && 361331070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 361431070b5dSJoe Perches WARN("SPACING", 361531070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 361631070b5dSJoe Perches } 361731070b5dSJoe Perches 361831070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 361931070b5dSJoe Perches if (defined $post_funcname_space && 362031070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 362131070b5dSJoe Perches WARN("SPACING", 362231070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 362331070b5dSJoe Perches } 362431070b5dSJoe Perches 362531070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 362631070b5dSJoe Perches if (defined $pre_args_space && 362731070b5dSJoe Perches $pre_args_space =~ /^\s/) { 362831070b5dSJoe Perches WARN("SPACING", 362931070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 363031070b5dSJoe Perches } 363131070b5dSJoe Perches 363231070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3633194f66fcSJoe Perches $fixed[$fixlinenr] =~ 363491f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 363531070b5dSJoe Perches } 363631070b5dSJoe Perches } 363731070b5dSJoe Perches 36388d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 36398d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3640fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3641fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 36428d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 36438d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 36448d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3645fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3646daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 36473705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 36483705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 36493705ce5bSJoe Perches $fix) { 3650194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36513705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 36523705ce5bSJoe Perches } 36538d31cfceSAndy Whitcroft } 36548d31cfceSAndy Whitcroft } 36558d31cfceSAndy Whitcroft 3656f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 36576c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3658c2fdda0dSAndy Whitcroft my $name = $1; 3659773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3660773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3661c2fdda0dSAndy Whitcroft 3662c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3663773647a0SAndy Whitcroft if ($name =~ /^(?: 3664773647a0SAndy Whitcroft if|for|while|switch|return|case| 3665773647a0SAndy Whitcroft volatile|__volatile__| 3666773647a0SAndy Whitcroft __attribute__|format|__extension__| 3667773647a0SAndy Whitcroft asm|__asm__)$/x) 3668773647a0SAndy Whitcroft { 3669c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3670c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3671c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3672c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3673773647a0SAndy Whitcroft 3674773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3675c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3676c2fdda0dSAndy Whitcroft 3677c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3678c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3679773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3680c2fdda0dSAndy Whitcroft 3681c2fdda0dSAndy Whitcroft } else { 36823705ce5bSJoe Perches if (WARN("SPACING", 36833705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 36843705ce5bSJoe Perches $fix) { 3685194f66fcSJoe Perches $fixed[$fixlinenr] =~ 36863705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 36873705ce5bSJoe Perches } 3688f0a594c1SAndy Whitcroft } 36896c72ffaaSAndy Whitcroft } 36909a4cad4eSEric Nelson 3691653d4876SAndy Whitcroft# Check operator spacing. 36920a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 36933705ce5bSJoe Perches my $fixed_line = ""; 36943705ce5bSJoe Perches my $line_fixed = 0; 36953705ce5bSJoe Perches 36969c0ca6f9SAndy Whitcroft my $ops = qr{ 36979c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 36989c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 36999c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 37001f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 370184731623SJoe Perches \?:|\?|: 37029c0ca6f9SAndy Whitcroft }x; 3703cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 37043705ce5bSJoe Perches 37053705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 37063705ce5bSJoe Perches## foreach my $el (@elements) { 37073705ce5bSJoe Perches## print("el: <$el>\n"); 37083705ce5bSJoe Perches## } 37093705ce5bSJoe Perches 37103705ce5bSJoe Perches my @fix_elements = (); 371100df344fSAndy Whitcroft my $off = 0; 37126c72ffaaSAndy Whitcroft 37133705ce5bSJoe Perches foreach my $el (@elements) { 37143705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 37153705ce5bSJoe Perches $off += length($el); 37163705ce5bSJoe Perches } 37173705ce5bSJoe Perches 37183705ce5bSJoe Perches $off = 0; 37193705ce5bSJoe Perches 37206c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3721b34c648bSJoe Perches my $last_after = -1; 37226c72ffaaSAndy Whitcroft 37230a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 37243705ce5bSJoe Perches 37253705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 37263705ce5bSJoe Perches 37273705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 37283705ce5bSJoe Perches 37294a0df2efSAndy Whitcroft $off += length($elements[$n]); 37304a0df2efSAndy Whitcroft 373125985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3732773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3733773647a0SAndy Whitcroft my $cc = ''; 3734773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3735773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3736773647a0SAndy Whitcroft } 3737773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3738773647a0SAndy Whitcroft 37394a0df2efSAndy Whitcroft my $a = ''; 37404a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 37414a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3742cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 37434a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 37444a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3745773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 37464a0df2efSAndy Whitcroft 37470a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 37484a0df2efSAndy Whitcroft 37494a0df2efSAndy Whitcroft my $c = ''; 37500a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 37514a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 37524a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3753cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 37544a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 37554a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 37568b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 37574a0df2efSAndy Whitcroft } else { 37584a0df2efSAndy Whitcroft $c = 'E'; 37590a920b5bSAndy Whitcroft } 37600a920b5bSAndy Whitcroft 37614a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 37624a0df2efSAndy Whitcroft 37634a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 37644a0df2efSAndy Whitcroft 37656c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3766de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 37670a920b5bSAndy Whitcroft 376874048ed8SAndy Whitcroft # Pull out the value of this operator. 37696c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 37700a920b5bSAndy Whitcroft 37711f65f947SAndy Whitcroft # Get the full operator variant. 37721f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 37731f65f947SAndy Whitcroft 377413214adfSAndy Whitcroft # Ignore operators passed as parameters. 377513214adfSAndy Whitcroft if ($op_type ne 'V' && 3776d7fe8065SSam Bobroff $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 377713214adfSAndy Whitcroft 3778cf655043SAndy Whitcroft# # Ignore comments 3779cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 378013214adfSAndy Whitcroft 3781d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 378213214adfSAndy Whitcroft } elsif ($op eq ';') { 3783cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3784cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 37853705ce5bSJoe Perches if (ERROR("SPACING", 37863705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3787b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 37883705ce5bSJoe Perches $line_fixed = 1; 37893705ce5bSJoe Perches } 3790d8aaf121SAndy Whitcroft } 3791d8aaf121SAndy Whitcroft 3792d8aaf121SAndy Whitcroft # // is a comment 3793d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 37940a920b5bSAndy Whitcroft 3795b00e4814SJoe Perches # : when part of a bitfield 3796b00e4814SJoe Perches } elsif ($opv eq ':B') { 3797b00e4814SJoe Perches # skip the bitfield test for now 3798b00e4814SJoe Perches 37991f65f947SAndy Whitcroft # No spaces for: 38001f65f947SAndy Whitcroft # -> 3801b00e4814SJoe Perches } elsif ($op eq '->') { 38024a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 38033705ce5bSJoe Perches if (ERROR("SPACING", 38043705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3805b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38063705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38073705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38083705ce5bSJoe Perches } 3809b34c648bSJoe Perches $line_fixed = 1; 38103705ce5bSJoe Perches } 38110a920b5bSAndy Whitcroft } 38120a920b5bSAndy Whitcroft 38132381097bSJoe Perches # , must not have a space before and must have a space on the right. 38140a920b5bSAndy Whitcroft } elsif ($op eq ',') { 38152381097bSJoe Perches my $rtrim_before = 0; 38162381097bSJoe Perches my $space_after = 0; 38172381097bSJoe Perches if ($ctx =~ /Wx./) { 38182381097bSJoe Perches if (ERROR("SPACING", 38192381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 38202381097bSJoe Perches $line_fixed = 1; 38212381097bSJoe Perches $rtrim_before = 1; 38222381097bSJoe Perches } 38232381097bSJoe Perches } 3824cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 38253705ce5bSJoe Perches if (ERROR("SPACING", 38263705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 38273705ce5bSJoe Perches $line_fixed = 1; 3828b34c648bSJoe Perches $last_after = $n; 38292381097bSJoe Perches $space_after = 1; 38302381097bSJoe Perches } 38312381097bSJoe Perches } 38322381097bSJoe Perches if ($rtrim_before || $space_after) { 38332381097bSJoe Perches if ($rtrim_before) { 38342381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38352381097bSJoe Perches } else { 38362381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38372381097bSJoe Perches } 38382381097bSJoe Perches if ($space_after) { 38392381097bSJoe Perches $good .= " "; 38403705ce5bSJoe Perches } 38410a920b5bSAndy Whitcroft } 38420a920b5bSAndy Whitcroft 38439c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 384474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 38459c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 38469c0ca6f9SAndy Whitcroft 38479c0ca6f9SAndy Whitcroft # unary operators should have a space before and 38489c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 38499c0ca6f9SAndy Whitcroft # unary operator, or a cast 38509c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 385174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 38520d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3853cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 38543705ce5bSJoe Perches if (ERROR("SPACING", 38553705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3856b34c648bSJoe Perches if ($n != $last_after + 2) { 3857b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 38583705ce5bSJoe Perches $line_fixed = 1; 38593705ce5bSJoe Perches } 38600a920b5bSAndy Whitcroft } 3861b34c648bSJoe Perches } 3862a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3863171ae1a4SAndy Whitcroft # A unary '*' may be const 3864171ae1a4SAndy Whitcroft 3865171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 38663705ce5bSJoe Perches if (ERROR("SPACING", 38673705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3868b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 38693705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38703705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 38713705ce5bSJoe Perches } 3872b34c648bSJoe Perches $line_fixed = 1; 38733705ce5bSJoe Perches } 38740a920b5bSAndy Whitcroft } 38750a920b5bSAndy Whitcroft 38760a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 38770a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3878773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 38793705ce5bSJoe Perches if (ERROR("SPACING", 38803705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3881b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 38823705ce5bSJoe Perches $line_fixed = 1; 38833705ce5bSJoe Perches } 38840a920b5bSAndy Whitcroft } 3885773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3886773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 38873705ce5bSJoe Perches if (ERROR("SPACING", 38883705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3889b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 38903705ce5bSJoe Perches $line_fixed = 1; 38913705ce5bSJoe Perches } 3892653d4876SAndy Whitcroft } 3893773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 38943705ce5bSJoe Perches if (ERROR("SPACING", 38953705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3896b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 38973705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 38983705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3899773647a0SAndy Whitcroft } 3900b34c648bSJoe Perches $line_fixed = 1; 39013705ce5bSJoe Perches } 39023705ce5bSJoe Perches } 39030a920b5bSAndy Whitcroft 39040a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 39059c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 39069c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 39079c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3908c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3909c2fdda0dSAndy Whitcroft $op eq '%') 39100a920b5bSAndy Whitcroft { 3911d2e025f3SJoe Perches if ($check) { 3912d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3913d2e025f3SJoe Perches if (CHK("SPACING", 3914d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3915d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3916d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3917d2e025f3SJoe Perches $line_fixed = 1; 3918d2e025f3SJoe Perches } 3919d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3920d2e025f3SJoe Perches if (CHK("SPACING", 3921d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3922d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3923d2e025f3SJoe Perches $line_fixed = 1; 3924d2e025f3SJoe Perches } 3925d2e025f3SJoe Perches } 3926d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 39273705ce5bSJoe Perches if (ERROR("SPACING", 39283705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3929b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3930b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3931b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3932b34c648bSJoe Perches } 39333705ce5bSJoe Perches $line_fixed = 1; 39343705ce5bSJoe Perches } 39350a920b5bSAndy Whitcroft } 39360a920b5bSAndy Whitcroft 39371f65f947SAndy Whitcroft # A colon needs no spaces before when it is 39381f65f947SAndy Whitcroft # terminating a case value or a label. 39391f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 39401f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 39413705ce5bSJoe Perches if (ERROR("SPACING", 39423705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3943b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 39443705ce5bSJoe Perches $line_fixed = 1; 39453705ce5bSJoe Perches } 39461f65f947SAndy Whitcroft } 39471f65f947SAndy Whitcroft 39480a920b5bSAndy Whitcroft # All the others need spaces both sides. 3949cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 39501f65f947SAndy Whitcroft my $ok = 0; 39511f65f947SAndy Whitcroft 395222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 39531f65f947SAndy Whitcroft if (($op eq '<' && 39541f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 39551f65f947SAndy Whitcroft ($op eq '>' && 39561f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 39571f65f947SAndy Whitcroft { 39581f65f947SAndy Whitcroft $ok = 1; 39591f65f947SAndy Whitcroft } 39601f65f947SAndy Whitcroft 3961e0df7e1fSJoe Perches # for asm volatile statements 3962e0df7e1fSJoe Perches # ignore a colon with another 3963e0df7e1fSJoe Perches # colon immediately before or after 3964e0df7e1fSJoe Perches if (($op eq ':') && 3965e0df7e1fSJoe Perches ($ca =~ /:$/ || $cc =~ /^:/)) { 3966e0df7e1fSJoe Perches $ok = 1; 3967e0df7e1fSJoe Perches } 3968e0df7e1fSJoe Perches 396984731623SJoe Perches # messages are ERROR, but ?: are CHK 39701f65f947SAndy Whitcroft if ($ok == 0) { 397184731623SJoe Perches my $msg_type = \&ERROR; 397284731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 397384731623SJoe Perches 397484731623SJoe Perches if (&{$msg_type}("SPACING", 39753705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3976b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3977b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3978b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3979b34c648bSJoe Perches } 39803705ce5bSJoe Perches $line_fixed = 1; 39813705ce5bSJoe Perches } 39820a920b5bSAndy Whitcroft } 398322f2a2efSAndy Whitcroft } 39844a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 39853705ce5bSJoe Perches 39863705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 39873705ce5bSJoe Perches 39883705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 39890a920b5bSAndy Whitcroft } 39903705ce5bSJoe Perches 39913705ce5bSJoe Perches if (($#elements % 2) == 0) { 39923705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 39933705ce5bSJoe Perches } 39943705ce5bSJoe Perches 3995194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3996194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 39973705ce5bSJoe Perches } 39983705ce5bSJoe Perches 39993705ce5bSJoe Perches 40000a920b5bSAndy Whitcroft } 40010a920b5bSAndy Whitcroft 4002786b6326SJoe Perches# check for whitespace before a non-naked semicolon 4003d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 4004786b6326SJoe Perches if (WARN("SPACING", 4005786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 4006786b6326SJoe Perches $fix) { 4007194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 4008786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 4009786b6326SJoe Perches } 4010786b6326SJoe Perches } 4011786b6326SJoe Perches 4012f0a594c1SAndy Whitcroft# check for multiple assignments 4013f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 4014000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 4015000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 4016f0a594c1SAndy Whitcroft } 4017f0a594c1SAndy Whitcroft 401822f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 401922f2a2efSAndy Whitcroft## # continuation. 402022f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 402122f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 402222f2a2efSAndy Whitcroft## 402322f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 402422f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 402522f2a2efSAndy Whitcroft## my $ln = $line; 402622f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 402722f2a2efSAndy Whitcroft## } 402822f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 4029000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 4030000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 403122f2a2efSAndy Whitcroft## } 403222f2a2efSAndy Whitcroft## } 4033f0a594c1SAndy Whitcroft 40340a920b5bSAndy Whitcroft#need space before brace following if, while, etc 403522f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 403622f2a2efSAndy Whitcroft $line =~ /do{/) { 40373705ce5bSJoe Perches if (ERROR("SPACING", 40383705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 40393705ce5bSJoe Perches $fix) { 4040194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 40413705ce5bSJoe Perches } 4042de7d4f0eSAndy Whitcroft } 4043de7d4f0eSAndy Whitcroft 4044c4a62ef9SJoe Perches## # check for blank lines before declarations 4045c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 4046c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 4047c4a62ef9SJoe Perches## WARN("SPACING", 4048c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 4049c4a62ef9SJoe Perches## } 4050c4a62ef9SJoe Perches## 4051c4a62ef9SJoe Perches 4052de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 4053de7d4f0eSAndy Whitcroft# on the line 4054de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 4055d5e616fcSJoe Perches if (ERROR("SPACING", 4056d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 4057d5e616fcSJoe Perches $fix) { 4058194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4059d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 4060d5e616fcSJoe Perches } 40610a920b5bSAndy Whitcroft } 40620a920b5bSAndy Whitcroft 406322f2a2efSAndy Whitcroft# check spacing on square brackets 406422f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 40653705ce5bSJoe Perches if (ERROR("SPACING", 40663705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 40673705ce5bSJoe Perches $fix) { 4068194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40693705ce5bSJoe Perches s/\[\s+/\[/; 40703705ce5bSJoe Perches } 407122f2a2efSAndy Whitcroft } 407222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 40733705ce5bSJoe Perches if (ERROR("SPACING", 40743705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 40753705ce5bSJoe Perches $fix) { 4076194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40773705ce5bSJoe Perches s/\s+\]/\]/; 40783705ce5bSJoe Perches } 407922f2a2efSAndy Whitcroft } 408022f2a2efSAndy Whitcroft 4081c45dcabdSAndy Whitcroft# check spacing on parentheses 40829c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 40839c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 40843705ce5bSJoe Perches if (ERROR("SPACING", 40853705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 40863705ce5bSJoe Perches $fix) { 4087194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40883705ce5bSJoe Perches s/\(\s+/\(/; 40893705ce5bSJoe Perches } 409022f2a2efSAndy Whitcroft } 409113214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 4092c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 4093c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 40943705ce5bSJoe Perches if (ERROR("SPACING", 40953705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 40963705ce5bSJoe Perches $fix) { 4097194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40983705ce5bSJoe Perches s/\s+\)/\)/; 40993705ce5bSJoe Perches } 410022f2a2efSAndy Whitcroft } 410122f2a2efSAndy Whitcroft 4102e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 4103e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 4104e2826fd0SJoe Perches 4105e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 4106ea4acbb1SJoe Perches my $var = $1; 4107ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4108ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 4109ea4acbb1SJoe Perches $fix) { 4110ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 4111ea4acbb1SJoe Perches } 4112ea4acbb1SJoe Perches } 4113ea4acbb1SJoe Perches 4114ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 4115ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 4116ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 4117ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 4118ea4acbb1SJoe Perches my $var = $2; 4119ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 4120ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 4121ea4acbb1SJoe Perches $fix) { 4122ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 4123ea4acbb1SJoe Perches $var2 =~ s/\s//g; 4124ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 4125ea4acbb1SJoe Perches } 4126e2826fd0SJoe Perches } 4127e2826fd0SJoe Perches 41280a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 41294a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 41300a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 41313705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 41323705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 41333705ce5bSJoe Perches $fix) { 4134194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41353705ce5bSJoe Perches s/^(.)\s+/$1/; 41363705ce5bSJoe Perches } 41370a920b5bSAndy Whitcroft } 41380a920b5bSAndy Whitcroft 41395b9553abSJoe Perches# return is not a function 4140507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 4141c45dcabdSAndy Whitcroft my $spacing = $1; 4142507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 41435b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 41445b9553abSJoe Perches my $value = $1; 41455b9553abSJoe Perches $value = deparenthesize($value); 41465b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 4147000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 4148000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 41495b9553abSJoe Perches } 4150c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 4151000d1cc1SJoe Perches ERROR("SPACING", 4152000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 4153c45dcabdSAndy Whitcroft } 4154c45dcabdSAndy Whitcroft } 4155507e5141SJoe Perches 4156b43ae21bSJoe Perches# unnecessary return in a void function 4157b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 4158b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 4159b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 4160b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 4161b43ae21bSJoe Perches $linenr >= 3 && 4162b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 4163b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 41649819cf25SJoe Perches WARN("RETURN_VOID", 4165b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 41669819cf25SJoe Perches } 41679819cf25SJoe Perches 4168189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 4169189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 4170189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 4171189248d8SJoe Perches my $openparens = $1; 4172189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 4173189248d8SJoe Perches my $msg = ""; 4174189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 4175189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 4176189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 4177189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4178189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4179189248d8SJoe Perches } 4180189248d8SJoe Perches } 4181189248d8SJoe Perches 4182f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative 4183f34e4a4fSJoe Perches if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 418453a3c448SAndy Whitcroft my $name = $1; 418553a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4186000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4187f34e4a4fSJoe Perches "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 418853a3c448SAndy Whitcroft } 418953a3c448SAndy Whitcroft } 4190c45dcabdSAndy Whitcroft 41910a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 41924a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 41933705ce5bSJoe Perches if (ERROR("SPACING", 41943705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 41953705ce5bSJoe Perches $fix) { 4196194f66fcSJoe Perches $fixed[$fixlinenr] =~ 41973705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 41983705ce5bSJoe Perches } 41990a920b5bSAndy Whitcroft } 42000a920b5bSAndy Whitcroft 4201f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4202f5fe35ddSAndy Whitcroft# statements after the conditional. 4203170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 42043e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 42053e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 42063e469cdcSAndy Whitcroft if (!defined $stat); 4207170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4208170d3a22SAndy Whitcroft $remain_next, $off_next); 4209170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4210170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4211170d3a22SAndy Whitcroft 4212170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4213170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4214170d3a22SAndy Whitcroft # then count those as offsets. 4215170d3a22SAndy Whitcroft my ($whitespace) = 4216170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4217170d3a22SAndy Whitcroft my $offset = 4218170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4219170d3a22SAndy Whitcroft 4220170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4221170d3a22SAndy Whitcroft $offset} = 1; 4222170d3a22SAndy Whitcroft } 4223170d3a22SAndy Whitcroft } 4224170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4225c11230f4SJoe Perches defined($stat) && defined($cond) && 4226170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4227171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 42288905a67cSAndy Whitcroft 4229b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4230000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4231000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 42328905a67cSAndy Whitcroft } 42338905a67cSAndy Whitcroft 42348905a67cSAndy Whitcroft # Find out what is on the end of the line after the 42358905a67cSAndy Whitcroft # conditional. 4236773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 42378905a67cSAndy Whitcroft $s =~ s/\n.*//g; 423813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 423953210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 424053210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4241773647a0SAndy Whitcroft { 4242bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4243bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4244bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 424542bdf74cSHidetoshi Seto my $stat_real = ''; 4246bb44ad39SAndy Whitcroft 424742bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 424842bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4249bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4250bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4251bb44ad39SAndy Whitcroft } 4252bb44ad39SAndy Whitcroft 4253000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4254000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 42558905a67cSAndy Whitcroft } 42568905a67cSAndy Whitcroft } 42578905a67cSAndy Whitcroft 425813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 425913214adfSAndy Whitcroft if ($line =~ / 426013214adfSAndy Whitcroft (?: 426113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 426213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 426313214adfSAndy Whitcroft (?:\&\&|\|\|) 426413214adfSAndy Whitcroft | 426513214adfSAndy Whitcroft (?:\&\&|\|\|) 426613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 426713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 426813214adfSAndy Whitcroft )/x) 426913214adfSAndy Whitcroft { 4270000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4271000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 427213214adfSAndy Whitcroft } 427313214adfSAndy Whitcroft 42748905a67cSAndy Whitcroft# if and else should not have general statements after it 427513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 427613214adfSAndy Whitcroft my $s = $1; 427713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 427813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4279000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4280000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 42810a920b5bSAndy Whitcroft } 428213214adfSAndy Whitcroft } 428339667782SAndy Whitcroft# if should not continue a brace 428439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4285000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4286048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 428739667782SAndy Whitcroft $herecurr); 428839667782SAndy Whitcroft } 4289a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4290a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4291a1080bf8SAndy Whitcroft $line !~ /\G(?: 42923fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4293a1080bf8SAndy Whitcroft \s*return\s+ 4294a1080bf8SAndy Whitcroft )/xg) 4295a1080bf8SAndy Whitcroft { 4296000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4297000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4298a1080bf8SAndy Whitcroft } 42990a920b5bSAndy Whitcroft 43000a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 43010a920b5bSAndy Whitcroft # indent level to be relevant to each other. 43028b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 43030a920b5bSAndy Whitcroft $previndent == $indent) { 43048b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 43058b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 43068b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43078b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43088b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43098b8856f4SJoe Perches my $fixedline = $prevrawline; 43108b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 43118b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 43128b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43138b8856f4SJoe Perches } 43148b8856f4SJoe Perches $fixedline = $rawline; 43158b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 43168b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43178b8856f4SJoe Perches } 43180a920b5bSAndy Whitcroft } 43190a920b5bSAndy Whitcroft 43208b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4321c2fdda0dSAndy Whitcroft $previndent == $indent) { 4322c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4323c2fdda0dSAndy Whitcroft 4324c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4325c2fdda0dSAndy Whitcroft # conditional. 4326773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4327c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4328c2fdda0dSAndy Whitcroft 4329c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 43308b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 43318b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 43328b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 43338b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 43348b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 43358b8856f4SJoe Perches my $fixedline = $prevrawline; 43368b8856f4SJoe Perches my $trailing = $rawline; 43378b8856f4SJoe Perches $trailing =~ s/^\+//; 43388b8856f4SJoe Perches $trailing = trim($trailing); 43398b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 43408b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 43418b8856f4SJoe Perches } 4342c2fdda0dSAndy Whitcroft } 4343c2fdda0dSAndy Whitcroft } 4344c2fdda0dSAndy Whitcroft 434595e2c602SJoe Perches#Specific variable tests 4346323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4347323c1260SJoe Perches my $var = $1; 434895e2c602SJoe Perches 434995e2c602SJoe Perches#gcc binary extension 435095e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4351d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4352d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4353d5e616fcSJoe Perches $fix) { 4354d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4355194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4356d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4357d5e616fcSJoe Perches } 435895e2c602SJoe Perches } 435995e2c602SJoe Perches 436095e2c602SJoe Perches#CamelCase 4361807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4362be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 436322735ce8SJoe Perches#Ignore Page<foo> variants 4364807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 436522735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4366f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4367f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4368f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 43697e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 43707e781f67SJoe Perches my $word = $1; 43717e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4372d8b07710SJoe Perches if ($check) { 4373d8b07710SJoe Perches seed_camelcase_includes(); 4374d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4375d8b07710SJoe Perches seed_camelcase_file($realfile); 4376d8b07710SJoe Perches $camelcase_file_seeded = 1; 4377d8b07710SJoe Perches } 4378d8b07710SJoe Perches } 43797e781f67SJoe Perches if (!defined $camelcase{$word}) { 43807e781f67SJoe Perches $camelcase{$word} = 1; 4381be79794bSJoe Perches CHK("CAMELCASE", 43827e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 43837e781f67SJoe Perches } 4384323c1260SJoe Perches } 4385323c1260SJoe Perches } 43863445686aSJoe Perches } 43870a920b5bSAndy Whitcroft 43880a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4389d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4390d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4391d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4392d5e616fcSJoe Perches $fix) { 4393194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4394d5e616fcSJoe Perches } 43950a920b5bSAndy Whitcroft } 43960a920b5bSAndy Whitcroft 43970e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 43980e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line) 4399c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4400e09dec48SAndy Whitcroft my $file = "$1.h"; 4401e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4402e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4403e09dec48SAndy Whitcroft $realfile ne $checkfile && 44047840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4405c45dcabdSAndy Whitcroft { 44060e212e0aSFabian Frederick my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 44070e212e0aSFabian Frederick if ($asminclude > 0) { 4408e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4409000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4410000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4411e09dec48SAndy Whitcroft } else { 4412000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4413000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4414e09dec48SAndy Whitcroft } 44150a920b5bSAndy Whitcroft } 44160a920b5bSAndy Whitcroft } 44170e212e0aSFabian Frederick } 44180a920b5bSAndy Whitcroft 4419653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4420653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4421cf655043SAndy Whitcroft# in a known good container 4422b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4423b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4424d8aaf121SAndy Whitcroft my $ln = $linenr; 4425d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4426c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4427c45dcabdSAndy Whitcroft my $ctx = ''; 442808a2843eSJoe Perches my $has_flow_statement = 0; 442908a2843eSJoe Perches my $has_arg_concat = 0; 4430c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4431f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4432f74bd194SAndy Whitcroft $ctx = $dstat; 4433c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4434a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4435c45dcabdSAndy Whitcroft 443608a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 443708a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 443808a2843eSJoe Perches 4439f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4440292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4441c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4442c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4443c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4444c45dcabdSAndy Whitcroft 4445c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4446bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4447bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4448c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4449bf30d6edSAndy Whitcroft { 4450c45dcabdSAndy Whitcroft } 4451c45dcabdSAndy Whitcroft 4452e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 445333acb54aSJoe Perches while ($dstat =~ s/($String)\s*$Ident/$1/ || 445433acb54aSJoe Perches $dstat =~ s/$Ident\s*($String)/$1/) 4455e45bab8eSAndy Whitcroft { 4456e45bab8eSAndy Whitcroft } 4457e45bab8eSAndy Whitcroft 4458c45dcabdSAndy Whitcroft my $exceptions = qr{ 4459c45dcabdSAndy Whitcroft $Declare| 4460c45dcabdSAndy Whitcroft module_param_named| 4461a0a0a7a9SKees Cook MODULE_PARM_DESC| 4462c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4463c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4464383099fdSAndy Whitcroft __typeof__\(| 446522fd2d3eSStefani Seibold union| 446622fd2d3eSStefani Seibold struct| 4467ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4468ea71a0a0SAndy Whitcroft ^\"|\"$ 4469c45dcabdSAndy Whitcroft }x; 44705eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4471f74bd194SAndy Whitcroft if ($dstat ne '' && 4472f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4473f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 44743cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4475356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4476f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4477f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4478e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 447972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4480f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4481f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4482f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4483f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4484f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4485c45dcabdSAndy Whitcroft { 4486f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4487f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4488f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4489f74bd194SAndy Whitcroft 4490f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4491f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4492c45dcabdSAndy Whitcroft } 4493c45dcabdSAndy Whitcroft 4494f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4495f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4496f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4497f74bd194SAndy Whitcroft } else { 4498000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4499388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4500d8aaf121SAndy Whitcroft } 45010a920b5bSAndy Whitcroft } 45025023d347SJoe Perches 450308a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 450408a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 450508a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 450608a2843eSJoe Perches my $herectx = $here . "\n"; 450708a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 450808a2843eSJoe Perches 450908a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 451008a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 451108a2843eSJoe Perches } 451208a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 451308a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 451408a2843eSJoe Perches } 451508a2843eSJoe Perches 4516481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 45175023d347SJoe Perches 45185023d347SJoe Perches } else { 45195023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4520481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4521481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 45225023d347SJoe Perches $line =~ /^\+.*\\$/) { 45235023d347SJoe Perches WARN("LINE_CONTINUATIONS", 45245023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 45255023d347SJoe Perches } 4526653d4876SAndy Whitcroft } 45270a920b5bSAndy Whitcroft 4528b13edf7fSJoe Perches# do {} while (0) macro tests: 4529b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4530b13edf7fSJoe Perches# macro should not end with a semicolon 4531b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4532b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4533b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4534b13edf7fSJoe Perches my $ln = $linenr; 4535b13edf7fSJoe Perches my $cnt = $realcnt; 4536b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4537b13edf7fSJoe Perches my $ctx = ''; 4538b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4539b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4540b13edf7fSJoe Perches $ctx = $dstat; 4541b13edf7fSJoe Perches 4542b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 45431b36b201SJoe Perches $dstat =~ s/$;/ /g; 4544b13edf7fSJoe Perches 4545b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4546b13edf7fSJoe Perches my $stmts = $2; 4547b13edf7fSJoe Perches my $semis = $3; 4548b13edf7fSJoe Perches 4549b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4550b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4551b13edf7fSJoe Perches my $herectx = $here . "\n"; 4552b13edf7fSJoe Perches 4553b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4554b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4555b13edf7fSJoe Perches } 4556b13edf7fSJoe Perches 4557ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4558ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4559b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4560b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4561b13edf7fSJoe Perches } 4562b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4563b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4564b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4565b13edf7fSJoe Perches } 4566f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4567f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4568f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4569f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4570f5ef95b1SJoe Perches 4571f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4572f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4573f5ef95b1SJoe Perches } 4574f5ef95b1SJoe Perches 4575f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4576f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4577b13edf7fSJoe Perches } 4578b13edf7fSJoe Perches } 4579b13edf7fSJoe Perches 4580080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4581080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4582080ba929SMike Frysinger# . 4583080ba929SMike Frysinger# ALIGN(...) 4584080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4585080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4586000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4587000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4588080ba929SMike Frysinger } 4589080ba929SMike Frysinger 4590f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 459113214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 459213214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4593cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 459413214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4595cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4596cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4597aad4f614SJoe Perches my @allowed = (); 4598aad4f614SJoe Perches my $allow = 0; 459913214adfSAndy Whitcroft my $seen = 0; 4600773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4601cf655043SAndy Whitcroft my $ln = $linenr - 1; 460213214adfSAndy Whitcroft for my $chunk (@chunks) { 460313214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 460413214adfSAndy Whitcroft 4605773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4606773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4607773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4608773647a0SAndy Whitcroft 4609aad4f614SJoe Perches $allowed[$allow] = 0; 4610773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4611773647a0SAndy Whitcroft 4612773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4613773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4614773647a0SAndy Whitcroft 4615773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4616cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4617cf655043SAndy Whitcroft 4618773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 461913214adfSAndy Whitcroft 462013214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 462113214adfSAndy Whitcroft 4622aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4623cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4624cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4625aad4f614SJoe Perches $allowed[$allow] = 1; 462613214adfSAndy Whitcroft } 462713214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4628cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4629aad4f614SJoe Perches $allowed[$allow] = 1; 463013214adfSAndy Whitcroft } 4631cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4632cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4633aad4f614SJoe Perches $allowed[$allow] = 1; 463413214adfSAndy Whitcroft } 4635aad4f614SJoe Perches $allow++; 463613214adfSAndy Whitcroft } 4637aad4f614SJoe Perches if ($seen) { 4638aad4f614SJoe Perches my $sum_allowed = 0; 4639aad4f614SJoe Perches foreach (@allowed) { 4640aad4f614SJoe Perches $sum_allowed += $_; 4641aad4f614SJoe Perches } 4642aad4f614SJoe Perches if ($sum_allowed == 0) { 4643000d1cc1SJoe Perches WARN("BRACES", 4644000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4645aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4646aad4f614SJoe Perches $seen != $allow) { 4647aad4f614SJoe Perches CHK("BRACES", 4648aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4649aad4f614SJoe Perches } 465013214adfSAndy Whitcroft } 465113214adfSAndy Whitcroft } 465213214adfSAndy Whitcroft } 4653773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 465413214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4655cf655043SAndy Whitcroft my $allowed = 0; 4656f0a594c1SAndy Whitcroft 4657cf655043SAndy Whitcroft # Check the pre-context. 4658cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4659cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4660cf655043SAndy Whitcroft $allowed = 1; 4661f0a594c1SAndy Whitcroft } 4662773647a0SAndy Whitcroft 4663773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4664773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4665773647a0SAndy Whitcroft 4666cf655043SAndy Whitcroft # Check the condition. 4667cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4668773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4669cf655043SAndy Whitcroft if (defined $cond) { 4670773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4671cf655043SAndy Whitcroft } 4672cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4673cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4674cf655043SAndy Whitcroft $allowed = 1; 4675cf655043SAndy Whitcroft } 4676cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4677cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4678cf655043SAndy Whitcroft $allowed = 1; 4679cf655043SAndy Whitcroft } 4680cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4681cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4682cf655043SAndy Whitcroft $allowed = 1; 4683cf655043SAndy Whitcroft } 4684cf655043SAndy Whitcroft # Check the post-context. 4685cf655043SAndy Whitcroft if (defined $chunks[1]) { 4686cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4687cf655043SAndy Whitcroft if (defined $cond) { 4688773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4689cf655043SAndy Whitcroft } 4690cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4691cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4692cf655043SAndy Whitcroft $allowed = 1; 4693cf655043SAndy Whitcroft } 4694cf655043SAndy Whitcroft } 4695cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 469669932487SJustin P. Mattock my $herectx = $here . "\n"; 4697f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4698cf655043SAndy Whitcroft 4699f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 470069932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4701cf655043SAndy Whitcroft } 4702cf655043SAndy Whitcroft 4703000d1cc1SJoe Perches WARN("BRACES", 4704000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4705f0a594c1SAndy Whitcroft } 4706f0a594c1SAndy Whitcroft } 4707f0a594c1SAndy Whitcroft 47080979ae66SJoe Perches# check for unnecessary blank lines around braces 470977b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4710f8e58219SJoe Perches if (CHK("BRACES", 4711f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4712f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4713f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4714f8e58219SJoe Perches } 47150979ae66SJoe Perches } 471677b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4717f8e58219SJoe Perches if (CHK("BRACES", 4718f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4719f8e58219SJoe Perches $fix) { 4720f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4721f8e58219SJoe Perches } 47220979ae66SJoe Perches } 47230979ae66SJoe Perches 47244a0df2efSAndy Whitcroft# no volatiles please 47256c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 47266c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4727000d1cc1SJoe Perches WARN("VOLATILE", 4728000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 47294a0df2efSAndy Whitcroft } 47304a0df2efSAndy Whitcroft 47315e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 47325e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 47335e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 47345e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 473533acb54aSJoe Perches if ($line =~ /^\+\s*$String/ && 47365e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 47375e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 47385e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 47395e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 47405e4f6ba5SJoe Perches $fix && 47415e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 47425e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 47435e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 47445e4f6ba5SJoe Perches my $comma_close = ""; 47455e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 47465e4f6ba5SJoe Perches $comma_close = $1; 47475e4f6ba5SJoe Perches } 47485e4f6ba5SJoe Perches 47495e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 47505e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 47515e4f6ba5SJoe Perches my $fixedline = $prevrawline; 47525e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 47535e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 47545e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 47555e4f6ba5SJoe Perches $fixedline = $rawline; 47565e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 47575e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 47585e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 47595e4f6ba5SJoe Perches } 47605e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 47615e4f6ba5SJoe Perches } 47625e4f6ba5SJoe Perches } 47635e4f6ba5SJoe Perches 47645e4f6ba5SJoe Perches# check for missing a space in a string concatenation 47655e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 47665e4f6ba5SJoe Perches WARN('MISSING_SPACE', 47675e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 47685e4f6ba5SJoe Perches } 47695e4f6ba5SJoe Perches 47705e4f6ba5SJoe Perches# check for spaces before a quoted newline 47715e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 47725e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 47735e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 47745e4f6ba5SJoe Perches $fix) { 47755e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 47765e4f6ba5SJoe Perches } 47775e4f6ba5SJoe Perches 47785e4f6ba5SJoe Perches } 47795e4f6ba5SJoe Perches 4780f17dba4fSJoe Perches# concatenated string without spaces between elements 478133acb54aSJoe Perches if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) { 4782f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4783f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4784f17dba4fSJoe Perches } 4785f17dba4fSJoe Perches 478690ad30e5SJoe Perches# uncoalesced string fragments 478733acb54aSJoe Perches if ($line =~ /$String\s*"/) { 478890ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 478990ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 479090ad30e5SJoe Perches } 479190ad30e5SJoe Perches 47925e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 47935e4f6ba5SJoe Perches my $string; 47945e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 47955e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 47965e4f6ba5SJoe Perches $string =~ s/%%/__/g; 47975e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 47985e4f6ba5SJoe Perches WARN("PRINTF_L", 47995e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 48005e4f6ba5SJoe Perches last; 48015e4f6ba5SJoe Perches } 48025e4f6ba5SJoe Perches } 48035e4f6ba5SJoe Perches 48045e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 48055e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 48065e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 48075e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 48085e4f6ba5SJoe Perches } 48095e4f6ba5SJoe Perches 481000df344fSAndy Whitcroft# warn about #if 0 4811c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4812000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4813000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4814de7d4f0eSAndy Whitcroft $herecurr); 48154a0df2efSAndy Whitcroft } 48164a0df2efSAndy Whitcroft 481703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 481803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 481903df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 482003df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 482103df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 482215160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 48234c432a8fSGreg Kroah-Hartman } 48244c432a8fSGreg Kroah-Hartman } 4825f0a594c1SAndy Whitcroft 4826ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4827ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4828ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4829ebfdc409SJoe Perches (defined $1 || defined $3) && 4830ebfdc409SJoe Perches $linenr > 3) { 4831ebfdc409SJoe Perches my $testval = $2; 4832ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4833ebfdc409SJoe Perches 4834ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4835ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4836ebfdc409SJoe Perches 4837ebfdc409SJoe 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)/) { 4838ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4839ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4840ebfdc409SJoe Perches } 4841ebfdc409SJoe Perches } 4842ebfdc409SJoe Perches 4843f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4844dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4845f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4846f78d98f6SJoe Perches my $level = $1; 4847f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4848f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4849f78d98f6SJoe Perches $fix) { 4850f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4851f78d98f6SJoe Perches } 4852f78d98f6SJoe Perches } 4853f78d98f6SJoe Perches 4854abb08a53SJoe Perches# check for mask then right shift without a parentheses 4855abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4856abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4857abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4858abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4859abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4860abb08a53SJoe Perches } 4861abb08a53SJoe Perches 4862b75ac618SJoe Perches# check for pointer comparisons to NULL 4863b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4864b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4865b75ac618SJoe Perches my $val = $1; 4866b75ac618SJoe Perches my $equal = "!"; 4867b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4868b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4869b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4870b75ac618SJoe Perches $fix) { 4871b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4872b75ac618SJoe Perches } 4873b75ac618SJoe Perches } 4874b75ac618SJoe Perches } 4875b75ac618SJoe Perches 48768716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 48778716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 48788716de38SJoe Perches my $attr = $1; 48798716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 48808716de38SJoe Perches my $ptr = $1; 48818716de38SJoe Perches my $var = $2; 48828716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 48838716de38SJoe Perches ERROR("MISPLACED_INIT", 48848716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 48858716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 48868716de38SJoe Perches WARN("MISPLACED_INIT", 48878716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 48888716de38SJoe Perches $fix) { 4889194f66fcSJoe 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; 48908716de38SJoe Perches } 48918716de38SJoe Perches } 48928716de38SJoe Perches } 48938716de38SJoe Perches 4894e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4895e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4896e970b884SJoe Perches my $attr = $1; 4897e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4898e970b884SJoe Perches my $attr_prefix = $1; 4899e970b884SJoe Perches my $attr_type = $2; 4900e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4901e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4902e970b884SJoe Perches $fix) { 4903194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4904e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4905e970b884SJoe Perches } 4906e970b884SJoe Perches } 4907e970b884SJoe Perches 4908e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4909e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4910e970b884SJoe Perches my $attr = $1; 4911e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4912e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4913e970b884SJoe Perches $fix) { 4914194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4915e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4916e970b884SJoe Perches $lead = rtrim($1); 4917e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4918e970b884SJoe Perches $lead = "${lead}const "; 4919194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4920e970b884SJoe Perches } 4921e970b884SJoe Perches } 4922e970b884SJoe Perches 4923c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const) 4924c17893c7SJoe Perches if ($line =~ /\b__read_mostly\b/ && 4925c17893c7SJoe Perches $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 4926c17893c7SJoe Perches if (ERROR("CONST_READ_MOSTLY", 4927c17893c7SJoe Perches "Invalid use of __read_mostly with const type\n" . $herecurr) && 4928c17893c7SJoe Perches $fix) { 4929c17893c7SJoe Perches $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 4930c17893c7SJoe Perches } 4931c17893c7SJoe Perches } 4932c17893c7SJoe Perches 4933fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4934fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4935fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4936fbdb8138SJoe Perches my $constant_func = $1; 4937fbdb8138SJoe Perches my $func = $constant_func; 4938fbdb8138SJoe Perches $func =~ s/^__constant_//; 4939fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4940fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4941fbdb8138SJoe Perches $fix) { 4942194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4943fbdb8138SJoe Perches } 4944fbdb8138SJoe Perches } 4945fbdb8138SJoe Perches 49461a15a250SPatrick Pannuto# prefer usleep_range over udelay 494737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 494843c1d77cSJoe Perches my $delay = $1; 49491a15a250SPatrick Pannuto # ignore udelay's < 10, however 495043c1d77cSJoe Perches if (! ($delay < 10) ) { 4951000d1cc1SJoe Perches CHK("USLEEP_RANGE", 495243c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 495343c1d77cSJoe Perches } 495443c1d77cSJoe Perches if ($delay > 2000) { 495543c1d77cSJoe Perches WARN("LONG_UDELAY", 495643c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 49571a15a250SPatrick Pannuto } 49581a15a250SPatrick Pannuto } 49591a15a250SPatrick Pannuto 496009ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 496109ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 496209ef8725SPatrick Pannuto if ($1 < 20) { 4963000d1cc1SJoe Perches WARN("MSLEEP", 496443c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 496509ef8725SPatrick Pannuto } 496609ef8725SPatrick Pannuto } 496709ef8725SPatrick Pannuto 496836ec1939SJoe Perches# check for comparisons of jiffies 496936ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 497036ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 497136ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 497236ec1939SJoe Perches } 497336ec1939SJoe Perches 49749d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 49759d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 49769d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 49779d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 49789d7a34a5SJoe Perches } 49799d7a34a5SJoe Perches 498000df344fSAndy Whitcroft# warn about #ifdefs in C files 4981c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 498200df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 498300df344fSAndy Whitcroft# print "$herecurr"; 498400df344fSAndy Whitcroft# $clean = 0; 498500df344fSAndy Whitcroft# } 498600df344fSAndy Whitcroft 498722f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4988c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 49893705ce5bSJoe Perches if (ERROR("SPACING", 49903705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 49913705ce5bSJoe Perches $fix) { 4992194f66fcSJoe Perches $fixed[$fixlinenr] =~ 49933705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 49943705ce5bSJoe Perches } 49953705ce5bSJoe Perches 499622f2a2efSAndy Whitcroft } 499722f2a2efSAndy Whitcroft 49984a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4999171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 5000171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 50014a0df2efSAndy Whitcroft my $which = $1; 50024a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5003000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 5004000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 50054a0df2efSAndy Whitcroft } 50064a0df2efSAndy Whitcroft } 50074a0df2efSAndy Whitcroft# check for memory barriers without a comment. 50084a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 50094a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 5010c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 5011000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 50124a0df2efSAndy Whitcroft } 50134a0df2efSAndy Whitcroft } 5014cb426e99SJoe Perches# check for waitqueue_active without a comment. 5015cb426e99SJoe Perches if ($line =~ /\bwaitqueue_active\s*\(/) { 5016cb426e99SJoe Perches if (!ctx_has_comment($first_line, $linenr)) { 5017cb426e99SJoe Perches WARN("WAITQUEUE_ACTIVE", 5018cb426e99SJoe Perches "waitqueue_active without comment\n" . $herecurr); 5019cb426e99SJoe Perches } 5020cb426e99SJoe Perches } 50214a0df2efSAndy Whitcroft# check of hardware specific defines 5022c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 5023000d1cc1SJoe Perches CHK("ARCH_DEFINES", 5024000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 50250a920b5bSAndy Whitcroft } 5026653d4876SAndy Whitcroft 5027d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 5028d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 5029000d1cc1SJoe Perches WARN("STORAGE_CLASS", 5030000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 5031d4977c78STobias Klauser } 5032d4977c78STobias Klauser 5033de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 5034de7d4f0eSAndy Whitcroft# storage class and type. 50359c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 50369c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 5037000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 5038000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 5039de7d4f0eSAndy Whitcroft } 5040de7d4f0eSAndy Whitcroft 50418905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 50422b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50432b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 5044d5e616fcSJoe Perches if (WARN("INLINE", 5045d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 5046d5e616fcSJoe Perches $fix) { 5047194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 5048d5e616fcSJoe Perches 5049d5e616fcSJoe Perches } 50508905a67cSAndy Whitcroft } 50518905a67cSAndy Whitcroft 50523d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 50532b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50542b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 5055000d1cc1SJoe Perches WARN("PREFER_PACKED", 5056000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 50573d130fd0SJoe Perches } 50583d130fd0SJoe Perches 505939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 50602b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50612b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 5062000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 5063000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 506439b7e287SJoe Perches } 506539b7e287SJoe Perches 50665f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 50672b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50682b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 5069d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 5070d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 5071d5e616fcSJoe Perches $fix) { 5072194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 5073d5e616fcSJoe Perches 5074d5e616fcSJoe Perches } 50755f14d3bdSJoe Perches } 50765f14d3bdSJoe Perches 50776061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 50782b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 50792b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 5080d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 5081d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 5082d5e616fcSJoe Perches $fix) { 5083194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 5084d5e616fcSJoe Perches } 50856061d949SJoe Perches } 50866061d949SJoe Perches 5087619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 5088619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 5089619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 5090619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 5091619a908aSJoe Perches $line =~ /\b__weak\b/)) { 5092619a908aSJoe Perches ERROR("WEAK_DECLARATION", 5093619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 5094619a908aSJoe Perches } 5095619a908aSJoe Perches 5096e6176fa4SJoe Perches# check for c99 types like uint8_t used outside of uapi/ 5097e6176fa4SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 5098e6176fa4SJoe Perches $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 5099e6176fa4SJoe Perches my $type = $1; 5100e6176fa4SJoe Perches if ($type =~ /\b($typeC99Typedefs)\b/) { 5101e6176fa4SJoe Perches $type = $1; 5102e6176fa4SJoe Perches my $kernel_type = 'u'; 5103e6176fa4SJoe Perches $kernel_type = 's' if ($type =~ /^_*[si]/); 5104e6176fa4SJoe Perches $type =~ /(\d+)/; 5105e6176fa4SJoe Perches $kernel_type .= $1; 5106e6176fa4SJoe Perches if (CHK("PREFER_KERNEL_TYPES", 5107e6176fa4SJoe Perches "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 5108e6176fa4SJoe Perches $fix) { 5109e6176fa4SJoe Perches $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 5110e6176fa4SJoe Perches } 5111e6176fa4SJoe Perches } 5112e6176fa4SJoe Perches } 5113e6176fa4SJoe Perches 51148f53a9b8SJoe Perches# check for sizeof(&) 51158f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 5116000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 5117000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 51188f53a9b8SJoe Perches } 51198f53a9b8SJoe Perches 512066c80b60SJoe Perches# check for sizeof without parenthesis 512166c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 5122d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 5123d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 5124d5e616fcSJoe Perches $fix) { 5125194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 5126d5e616fcSJoe Perches } 512766c80b60SJoe Perches } 512866c80b60SJoe Perches 512988982feaSJoe Perches# check for struct spinlock declarations 513088982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 513188982feaSJoe Perches WARN("USE_SPINLOCK_T", 513288982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 513388982feaSJoe Perches } 513488982feaSJoe Perches 5135a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 513606668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 5137a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 5138caac1d5fSHeba Aamer $fmt =~ s/%%//g; 5139caac1d5fSHeba Aamer if ($fmt !~ /%/) { 5140d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 5141d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 5142d5e616fcSJoe Perches $fix) { 5143194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 5144d5e616fcSJoe Perches } 5145a6962d72SJoe Perches } 5146a6962d72SJoe Perches } 5147a6962d72SJoe Perches 5148554e165cSAndy Whitcroft# Check for misused memsets 5149d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5150d1fe9c09SJoe Perches defined $stat && 51519e20a853SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 5152554e165cSAndy Whitcroft 5153d7c76ba7SJoe Perches my $ms_addr = $2; 5154d1fe9c09SJoe Perches my $ms_val = $7; 5155d1fe9c09SJoe Perches my $ms_size = $12; 5156d7c76ba7SJoe Perches 5157554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 5158554e165cSAndy Whitcroft ERROR("MEMSET", 5159d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 5160554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 5161554e165cSAndy Whitcroft WARN("MEMSET", 5162d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 5163d7c76ba7SJoe Perches } 5164d7c76ba7SJoe Perches } 5165d7c76ba7SJoe Perches 516698a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 516798a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 516810895d2cSMateusz Kulikowski defined $stat && 516910895d2cSMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 517098a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 517110895d2cSMateusz Kulikowski "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 517298a9bba5SJoe Perches $fix) { 5173194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 517498a9bba5SJoe Perches } 517598a9bba5SJoe Perches } 517698a9bba5SJoe Perches 5177b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 5178b6117d17SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 5179b6117d17SMateusz Kulikowski defined $stat && 5180b6117d17SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 5181b6117d17SMateusz Kulikowski WARN("PREFER_ETHER_ADDR_EQUAL", 5182b6117d17SMateusz Kulikowski "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 5183b6117d17SMateusz Kulikowski } 5184b6117d17SMateusz Kulikowski 51858617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 51868617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 51878617cd09SMateusz Kulikowski if ($^V && $^V ge 5.10.0 && 51888617cd09SMateusz Kulikowski defined $stat && 51898617cd09SMateusz Kulikowski $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 51908617cd09SMateusz Kulikowski 51918617cd09SMateusz Kulikowski my $ms_val = $7; 51928617cd09SMateusz Kulikowski 51938617cd09SMateusz Kulikowski if ($ms_val =~ /^(?:0x|)0+$/i) { 51948617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_ZERO_ADDR", 51958617cd09SMateusz Kulikowski "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 51968617cd09SMateusz Kulikowski $fix) { 51978617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 51988617cd09SMateusz Kulikowski } 51998617cd09SMateusz Kulikowski } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 52008617cd09SMateusz Kulikowski if (WARN("PREFER_ETH_BROADCAST_ADDR", 52018617cd09SMateusz Kulikowski "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 52028617cd09SMateusz Kulikowski $fix) { 52038617cd09SMateusz Kulikowski $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 52048617cd09SMateusz Kulikowski } 52058617cd09SMateusz Kulikowski } 52068617cd09SMateusz Kulikowski } 52078617cd09SMateusz Kulikowski 5208d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 5209d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 5210d1fe9c09SJoe Perches defined $stat && 5211d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 5212d1fe9c09SJoe Perches if (defined $2 || defined $7) { 5213d7c76ba7SJoe Perches my $call = $1; 5214d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 5215d7c76ba7SJoe Perches my $arg1 = $3; 5216d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 5217d1fe9c09SJoe Perches my $arg2 = $8; 5218d7c76ba7SJoe Perches my $cast; 5219d7c76ba7SJoe Perches 5220d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 5221d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 5222d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 5223d7c76ba7SJoe Perches $cast = $cast1; 5224d7c76ba7SJoe Perches } else { 5225d7c76ba7SJoe Perches $cast = $cast2; 5226d7c76ba7SJoe Perches } 5227d7c76ba7SJoe Perches WARN("MINMAX", 5228d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 5229554e165cSAndy Whitcroft } 5230554e165cSAndy Whitcroft } 5231554e165cSAndy Whitcroft 52324a273195SJoe Perches# check usleep_range arguments 52334a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 52344a273195SJoe Perches defined $stat && 52354a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 52364a273195SJoe Perches my $min = $1; 52374a273195SJoe Perches my $max = $7; 52384a273195SJoe Perches if ($min eq $max) { 52394a273195SJoe Perches WARN("USLEEP_RANGE", 52404a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 52414a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 52424a273195SJoe Perches $min > $max) { 52434a273195SJoe Perches WARN("USLEEP_RANGE", 52444a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 52454a273195SJoe Perches } 52464a273195SJoe Perches } 52474a273195SJoe Perches 5248823b794cSJoe Perches# check for naked sscanf 5249823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5250823b794cSJoe Perches defined $stat && 52516c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5252823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5253823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5254823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5255823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5256823b794cSJoe Perches $lc = $lc + $linenr; 5257823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5258823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5259823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5260823b794cSJoe Perches } 5261823b794cSJoe Perches WARN("NAKED_SSCANF", 5262823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5263823b794cSJoe Perches } 5264823b794cSJoe Perches 5265afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5266afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5267afc819abSJoe Perches defined $stat && 5268afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5269afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5270afc819abSJoe Perches $lc = $lc + $linenr; 5271afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5272afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5273afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5274afc819abSJoe Perches } 5275afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5276afc819abSJoe Perches my $format = $6; 5277afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5278afc819abSJoe Perches if ($count == 1 && 5279afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5280afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5281afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5282afc819abSJoe Perches } 5283afc819abSJoe Perches } 5284afc819abSJoe Perches } 5285afc819abSJoe Perches 528670dc8a48SJoe Perches# check for new externs in .h files. 528770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 528870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5289d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 529070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 529170dc8a48SJoe Perches $fix) { 5292194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 529370dc8a48SJoe Perches } 529470dc8a48SJoe Perches } 529570dc8a48SJoe Perches 5296de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5297171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5298c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5299171ae1a4SAndy Whitcroft { 5300c45dcabdSAndy Whitcroft my $function_name = $1; 5301c45dcabdSAndy Whitcroft my $paren_space = $2; 5302171ae1a4SAndy Whitcroft 5303171ae1a4SAndy Whitcroft my $s = $stat; 5304171ae1a4SAndy Whitcroft if (defined $cond) { 5305171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5306171ae1a4SAndy Whitcroft } 5307c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5308c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5309c45dcabdSAndy Whitcroft { 5310000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5311000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5312de7d4f0eSAndy Whitcroft } 5313de7d4f0eSAndy Whitcroft 5314171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5315000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5316000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5317171ae1a4SAndy Whitcroft } 53189c9ba34eSAndy Whitcroft 53199c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 53209c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 53219c9ba34eSAndy Whitcroft { 5322000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5323000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5324171ae1a4SAndy Whitcroft } 5325171ae1a4SAndy Whitcroft 5326de7d4f0eSAndy Whitcroft# checks for new __setup's 5327de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5328de7d4f0eSAndy Whitcroft my $name = $1; 5329de7d4f0eSAndy Whitcroft 5330de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5331000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5332000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5333de7d4f0eSAndy Whitcroft } 5334653d4876SAndy Whitcroft } 53359c0ca6f9SAndy Whitcroft 53369c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5337caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5338000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5339000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 53409c0ca6f9SAndy Whitcroft } 534113214adfSAndy Whitcroft 5342a640d25cSJoe Perches# alloc style 5343a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5344a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5345a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5346a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5347a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5348a640d25cSJoe Perches } 5349a640d25cSJoe Perches 535060a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 535160a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5352e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 535360a55369SJoe Perches my $oldfunc = $3; 535460a55369SJoe Perches my $a1 = $4; 535560a55369SJoe Perches my $a2 = $10; 535660a55369SJoe Perches my $newfunc = "kmalloc_array"; 535760a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 535860a55369SJoe Perches my $r1 = $a1; 535960a55369SJoe Perches my $r2 = $a2; 536060a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 536160a55369SJoe Perches $r1 = $a2; 536260a55369SJoe Perches $r2 = $a1; 536360a55369SJoe Perches } 5364e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5365e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5366e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5367e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5368e367455aSJoe Perches $fix) { 5369194f66fcSJoe 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; 537060a55369SJoe Perches 537160a55369SJoe Perches } 537260a55369SJoe Perches } 537360a55369SJoe Perches } 537460a55369SJoe Perches 5375972fdea2SJoe Perches# check for krealloc arg reuse 5376972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5377972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5378972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5379972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5380972fdea2SJoe Perches } 5381972fdea2SJoe Perches 53825ce59ae0SJoe Perches# check for alloc argument mismatch 53835ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 53845ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 53855ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 53865ce59ae0SJoe Perches } 53875ce59ae0SJoe Perches 5388caf2a54fSJoe Perches# check for multiple semicolons 5389caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5390d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5391d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5392d5e616fcSJoe Perches $fix) { 5393194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5394d5e616fcSJoe Perches } 5395d1e2ad07SJoe Perches } 5396d1e2ad07SJoe Perches 53970ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 53980ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 53990ab90191SJoe Perches my $ull = ""; 54000ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 54010ab90191SJoe Perches if (CHK("BIT_MACRO", 54020ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 54030ab90191SJoe Perches $fix) { 54040ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 54050ab90191SJoe Perches } 54060ab90191SJoe Perches } 54070ab90191SJoe Perches 5408e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5409c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5410c34c09a8SJoe Perches my $has_break = 0; 5411c34c09a8SJoe Perches my $has_statement = 0; 5412c34c09a8SJoe Perches my $count = 0; 5413c34c09a8SJoe Perches my $prevline = $linenr; 5414e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5415c34c09a8SJoe Perches $prevline--; 5416c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5417c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5418c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5419c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5420c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5421c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5422c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5423c34c09a8SJoe Perches $has_statement = 1; 5424c34c09a8SJoe Perches $count++; 5425c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5426c34c09a8SJoe Perches } 5427c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5428c34c09a8SJoe Perches WARN("MISSING_BREAK", 5429c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5430c34c09a8SJoe Perches } 5431c34c09a8SJoe Perches } 5432c34c09a8SJoe Perches 5433d1e2ad07SJoe Perches# check for switch/default statements without a break; 5434d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5435d1e2ad07SJoe Perches defined $stat && 5436d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5437d1e2ad07SJoe Perches my $ctx = ''; 5438d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5439d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5440d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5441d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5442d1e2ad07SJoe Perches } 5443d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5444d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5445caf2a54fSJoe Perches } 5446caf2a54fSJoe Perches 544713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5448d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5449d5e616fcSJoe Perches if (WARN("USE_FUNC", 5450d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5451d5e616fcSJoe Perches $fix) { 5452194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5453d5e616fcSJoe Perches } 545413214adfSAndy Whitcroft } 5455773647a0SAndy Whitcroft 545662ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 545762ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 545862ec818fSJoe Perches ERROR("DATE_TIME", 545962ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 546062ec818fSJoe Perches } 546162ec818fSJoe Perches 54622c92488aSJoe Perches# check for use of yield() 54632c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 54642c92488aSJoe Perches WARN("YIELD", 54652c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 54662c92488aSJoe Perches } 54672c92488aSJoe Perches 5468179f8f40SJoe Perches# check for comparisons against true and false 5469179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5470179f8f40SJoe Perches my $lead = $1; 5471179f8f40SJoe Perches my $arg = $2; 5472179f8f40SJoe Perches my $test = $3; 5473179f8f40SJoe Perches my $otype = $4; 5474179f8f40SJoe Perches my $trail = $5; 5475179f8f40SJoe Perches my $op = "!"; 5476179f8f40SJoe Perches 5477179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5478179f8f40SJoe Perches 5479179f8f40SJoe Perches my $type = lc($otype); 5480179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5481179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5482179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5483179f8f40SJoe Perches $op = ""; 5484179f8f40SJoe Perches } 5485179f8f40SJoe Perches 5486179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5487179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5488179f8f40SJoe Perches 5489179f8f40SJoe Perches## maybe suggesting a correct construct would better 5490179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5491179f8f40SJoe Perches 5492179f8f40SJoe Perches } 5493179f8f40SJoe Perches } 5494179f8f40SJoe Perches 54954882720bSThomas Gleixner# check for semaphores initialized locked 54964882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5497000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5498000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5499773647a0SAndy Whitcroft } 55006712d858SJoe Perches 550167d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 550267d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5503000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 550467d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5505773647a0SAndy Whitcroft } 55066712d858SJoe Perches 5507ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5508f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5509000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5510ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5511f3db6639SMichael Ellerman } 55126712d858SJoe Perches 55130f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 55140f3c5aabSJoe Perches my $const_structs = qr{ 55150f3c5aabSJoe Perches acpi_dock_ops| 551679404849SEmese Revfy address_space_operations| 551779404849SEmese Revfy backlight_ops| 551879404849SEmese Revfy block_device_operations| 551979404849SEmese Revfy dentry_operations| 552079404849SEmese Revfy dev_pm_ops| 552179404849SEmese Revfy dma_map_ops| 552279404849SEmese Revfy extent_io_ops| 552379404849SEmese Revfy file_lock_operations| 552479404849SEmese Revfy file_operations| 552579404849SEmese Revfy hv_ops| 552679404849SEmese Revfy ide_dma_ops| 552779404849SEmese Revfy intel_dvo_dev_ops| 552879404849SEmese Revfy item_operations| 552979404849SEmese Revfy iwl_ops| 553079404849SEmese Revfy kgdb_arch| 553179404849SEmese Revfy kgdb_io| 553279404849SEmese Revfy kset_uevent_ops| 553379404849SEmese Revfy lock_manager_operations| 553479404849SEmese Revfy microcode_ops| 553579404849SEmese Revfy mtrr_ops| 553679404849SEmese Revfy neigh_ops| 553779404849SEmese Revfy nlmsvc_binding| 55380f3c5aabSJoe Perches of_device_id| 553979404849SEmese Revfy pci_raw_ops| 554079404849SEmese Revfy pipe_buf_operations| 554179404849SEmese Revfy platform_hibernation_ops| 554279404849SEmese Revfy platform_suspend_ops| 554379404849SEmese Revfy proto_ops| 554479404849SEmese Revfy rpc_pipe_ops| 554579404849SEmese Revfy seq_operations| 554679404849SEmese Revfy snd_ac97_build_ops| 554779404849SEmese Revfy soc_pcmcia_socket_ops| 554879404849SEmese Revfy stacktrace_ops| 554979404849SEmese Revfy sysfs_ops| 555079404849SEmese Revfy tty_operations| 55516d07d01bSJoe Perches uart_ops| 555279404849SEmese Revfy usb_mon_operations| 555379404849SEmese Revfy wd_ops}x; 55546903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 55550f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5556000d1cc1SJoe Perches WARN("CONST_STRUCT", 5557000d1cc1SJoe Perches "struct $1 should normally be const\n" . 55586903ffb2SAndy Whitcroft $herecurr); 55592b6db5cbSAndy Whitcroft } 5560773647a0SAndy Whitcroft 5561773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5562773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5563773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5564c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5565c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5566171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5567171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5568171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5569773647a0SAndy Whitcroft { 5570000d1cc1SJoe Perches WARN("NR_CPUS", 5571000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5572773647a0SAndy Whitcroft } 55739c9ba34eSAndy Whitcroft 557452ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 557552ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 557652ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 557752ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 557852ea8506SJoe Perches } 557952ea8506SJoe Perches 5580acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5581acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5582acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5583acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5584acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5585acd9362cSJoe Perches } 5586acd9362cSJoe Perches 5587691d77b6SAndy Whitcroft# whine mightly about in_atomic 5588691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5589691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5590000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5591000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5592f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5593000d1cc1SJoe Perches WARN("IN_ATOMIC", 5594000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5595691d77b6SAndy Whitcroft } 5596691d77b6SAndy Whitcroft } 55971704f47bSPeter Zijlstra 55981704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 55991704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 56001704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 56011704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 56021704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 56031704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5604000d1cc1SJoe Perches ERROR("LOCKDEP", 5605000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 56061704f47bSPeter Zijlstra } 56071704f47bSPeter Zijlstra } 560888f8831cSDave Jones 5609b392c64fSJoe Perches if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 5610b392c64fSJoe Perches $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 5611000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5612000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 561388f8831cSDave Jones } 56142435880fSJoe Perches 5615515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5616515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5617515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5618515a235eSJoe Perches $line =~ /$mode_perms_search/) { 56192435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 56202435880fSJoe Perches my $func = $entry->[0]; 56212435880fSJoe Perches my $arg_pos = $entry->[1]; 56222435880fSJoe Perches 56232435880fSJoe Perches my $skip_args = ""; 56242435880fSJoe Perches if ($arg_pos > 1) { 56252435880fSJoe Perches $arg_pos--; 56262435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 56272435880fSJoe Perches } 56282435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5629515a235eSJoe Perches if ($line =~ /$test/) { 56302435880fSJoe Perches my $val = $1; 56312435880fSJoe Perches $val = $6 if ($skip_args ne ""); 56322435880fSJoe Perches 56331727cc70SJoe Perches if ($val !~ /^0$/ && 56341727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 56351727cc70SJoe Perches length($val) ne 4)) { 56362435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 56371727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5638c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5639c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5640c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 56412435880fSJoe Perches } 56422435880fSJoe Perches } 56432435880fSJoe Perches } 564413214adfSAndy Whitcroft } 56455a6d20ceSBjorn Andersson 56465a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h 56475a6d20ceSBjorn Andersson if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 56485a6d20ceSBjorn Andersson my $extracted_string = get_quoted_string($line, $rawline); 56495a6d20ceSBjorn Andersson my $valid_licenses = qr{ 56505a6d20ceSBjorn Andersson GPL| 56515a6d20ceSBjorn Andersson GPL\ v2| 56525a6d20ceSBjorn Andersson GPL\ and\ additional\ rights| 56535a6d20ceSBjorn Andersson Dual\ BSD/GPL| 56545a6d20ceSBjorn Andersson Dual\ MIT/GPL| 56555a6d20ceSBjorn Andersson Dual\ MPL/GPL| 56565a6d20ceSBjorn Andersson Proprietary 56575a6d20ceSBjorn Andersson }x; 56585a6d20ceSBjorn Andersson if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 56595a6d20ceSBjorn Andersson WARN("MODULE_LICENSE", 56605a6d20ceSBjorn Andersson "unknown module license " . $extracted_string . "\n" . $herecurr); 56615a6d20ceSBjorn Andersson } 56625a6d20ceSBjorn Andersson } 5663515a235eSJoe Perches } 566413214adfSAndy Whitcroft 566513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 566613214adfSAndy Whitcroft # so just keep quiet. 566713214adfSAndy Whitcroft if ($#rawlines == -1) { 566813214adfSAndy Whitcroft exit(0); 56690a920b5bSAndy Whitcroft } 56700a920b5bSAndy Whitcroft 56718905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 56728905a67cSAndy Whitcroft # things that appear to be patches. 56738905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 56748905a67cSAndy Whitcroft exit(0); 56758905a67cSAndy Whitcroft } 56768905a67cSAndy Whitcroft 56778905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 56788905a67cSAndy Whitcroft # just keep quiet. 56798905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 56808905a67cSAndy Whitcroft exit(0); 56818905a67cSAndy Whitcroft } 56828905a67cSAndy Whitcroft 568306330fc4SJoe Perches if (!$is_patch && $file !~ /cover-letter\.patch$/) { 5684000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5685000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 56860a920b5bSAndy Whitcroft } 568734d8815fSJoe Perches if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) { 5688000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5689000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 56900a920b5bSAndy Whitcroft } 56910a920b5bSAndy Whitcroft 5692f0a594c1SAndy Whitcroft print report_dump(); 569313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 569413214adfSAndy Whitcroft print "$filename " if ($summary_file); 56956c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 56966c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 56976c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 56986c72ffaaSAndy Whitcroft } 56998905a67cSAndy Whitcroft 5700d2c0a235SAndy Whitcroft if ($quiet == 0) { 5701d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5702d2c0a235SAndy Whitcroft # then suggest that. 5703d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5704b0781216SMike Frysinger $rpt_cleaners = 0; 5705d8469f16SJoe Perches print << "EOM" 5706d8469f16SJoe Perches 5707d8469f16SJoe PerchesNOTE: Whitespace errors detected. 5708d8469f16SJoe Perches You may wish to use scripts/cleanpatch or scripts/cleanfile 5709d8469f16SJoe PerchesEOM 5710d2c0a235SAndy Whitcroft } 5711d2c0a235SAndy Whitcroft } 5712d2c0a235SAndy Whitcroft 5713d752fcc8SJoe Perches if ($clean == 0 && $fix && 5714d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5715d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 57169624b8d6SJoe Perches my $newfile = $filename; 57179624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 57183705ce5bSJoe Perches my $linecount = 0; 57193705ce5bSJoe Perches my $f; 57203705ce5bSJoe Perches 5721d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5722d752fcc8SJoe Perches 57233705ce5bSJoe Perches open($f, '>', $newfile) 57243705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 57253705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 57263705ce5bSJoe Perches $linecount++; 57273705ce5bSJoe Perches if ($file) { 57283705ce5bSJoe Perches if ($linecount > 3) { 57293705ce5bSJoe Perches $fixed_line =~ s/^\+//; 57303705ce5bSJoe Perches print $f $fixed_line . "\n"; 57313705ce5bSJoe Perches } 57323705ce5bSJoe Perches } else { 57333705ce5bSJoe Perches print $f $fixed_line . "\n"; 57343705ce5bSJoe Perches } 57353705ce5bSJoe Perches } 57363705ce5bSJoe Perches close($f); 57373705ce5bSJoe Perches 57383705ce5bSJoe Perches if (!$quiet) { 57393705ce5bSJoe Perches print << "EOM"; 5740d8469f16SJoe Perches 57413705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 57423705ce5bSJoe Perches 57433705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 57443705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 57453705ce5bSJoe Perches 57463705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 57473705ce5bSJoe PerchesNo warranties, expressed or implied... 57483705ce5bSJoe PerchesEOM 57493705ce5bSJoe Perches } 57503705ce5bSJoe Perches } 57513705ce5bSJoe Perches 5752d8469f16SJoe Perches if ($quiet == 0) { 5753d8469f16SJoe Perches print "\n"; 5754d8469f16SJoe Perches if ($clean == 1) { 5755d8469f16SJoe Perches print "$vname has no obvious style problems and is ready for submission.\n"; 5756d8469f16SJoe Perches } else { 5757d8469f16SJoe Perches print "$vname has style problems, please review.\n"; 57580a920b5bSAndy Whitcroft } 57590a920b5bSAndy Whitcroft } 57600a920b5bSAndy Whitcroft return $clean; 57610a920b5bSAndy Whitcroft} 5762