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'; 120a920b5bSAndy Whitcroft 130a920b5bSAndy Whitcroftmy $P = $0; 1436061e38SJoe Perchesmy $D = dirname(abs_path($P)); 150a920b5bSAndy Whitcroft 16000d1cc1SJoe Perchesmy $V = '0.32'; 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 190a920b5bSAndy Whitcroft 200a920b5bSAndy Whitcroftmy $quiet = 0; 210a920b5bSAndy Whitcroftmy $tree = 1; 220a920b5bSAndy Whitcroftmy $chk_signoff = 1; 230a920b5bSAndy Whitcroftmy $chk_patch = 1; 24773647a0SAndy Whitcroftmy $tst_only; 256c72ffaaSAndy Whitcroftmy $emacs = 0; 268905a67cSAndy Whitcroftmy $terse = 0; 276c72ffaaSAndy Whitcroftmy $file = 0; 286c72ffaaSAndy Whitcroftmy $check = 0; 292ac73b4fSJoe Perchesmy $check_orig = 0; 308905a67cSAndy Whitcroftmy $summary = 1; 318905a67cSAndy Whitcroftmy $mailback = 0; 3213214adfSAndy Whitcroftmy $summary_file = 0; 33000d1cc1SJoe Perchesmy $show_types = 0; 343705ce5bSJoe Perchesmy $fix = 0; 359624b8d6SJoe Perchesmy $fix_inplace = 0; 366c72ffaaSAndy Whitcroftmy $root; 37c2fdda0dSAndy Whitcroftmy %debug; 383445686aSJoe Perchesmy %camelcase = (); 3991bfe484SJoe Perchesmy %use_type = (); 4091bfe484SJoe Perchesmy @use = (); 4191bfe484SJoe Perchesmy %ignore_type = (); 42000d1cc1SJoe Perchesmy @ignore = (); 4377f5b10aSHannes Edermy $help = 0; 44000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 456cd7f386SJoe Perchesmy $max_line_length = 80; 46d62a201fSDave Hansenmy $ignore_perl_version = 0; 47d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4856193274SVadim Bendeburymy $min_conf_desc_length = 4; 4966b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt"; 50*ebfd7d62SJoe Perchesmy $codespell = 0; 51*ebfd7d62SJoe Perchesmy $codespellfile = "/usr/local/share/codespell/dictionary.txt"; 5277f5b10aSHannes Eder 5377f5b10aSHannes Edersub help { 5477f5b10aSHannes Eder my ($exitcode) = @_; 5577f5b10aSHannes Eder 5677f5b10aSHannes Eder print << "EOM"; 5777f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5877f5b10aSHannes EderVersion: $V 5977f5b10aSHannes Eder 6077f5b10aSHannes EderOptions: 6177f5b10aSHannes Eder -q, --quiet quiet 6277f5b10aSHannes Eder --no-tree run without a kernel tree 6377f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 6477f5b10aSHannes Eder --patch treat FILE as patchfile (default) 6577f5b10aSHannes Eder --emacs emacs compile window format 6677f5b10aSHannes Eder --terse one line per report 6777f5b10aSHannes Eder -f, --file treat FILE as regular source file 6877f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6991bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 70000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 716cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 7256193274SVadim Bendebury --min-conf-desc-length=n set the min description length, if shorter, warn 73000d1cc1SJoe Perches --show-types show the message "types" in the output 7477f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 7577f5b10aSHannes Eder --no-summary suppress the per-file summary 7677f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 7777f5b10aSHannes Eder --summary-file include the filename in summary 7877f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7977f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 8077f5b10aSHannes Eder is all off) 8177f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 8277f5b10aSHannes Eder literally 833705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 843705ce5bSJoe Perches If correctable single-line errors exist, create 853705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 863705ce5bSJoe Perches with potential errors corrected to the preferred 873705ce5bSJoe Perches checkpatch style 889624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 899624b8d6SJoe Perches Is the same as --fix, but overwrites the input 909624b8d6SJoe Perches file. It's your fault if there's no backup or git 91d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 92d62a201fSDave Hansen runtime errors. 93*ebfd7d62SJoe Perches --codespell Use the codespell dictionary for spelling/typos 94*ebfd7d62SJoe Perches (default:/usr/local/share/codespell/dictionary.txt) 95*ebfd7d62SJoe Perches --codespellfile Use this codespell dictionary 9677f5b10aSHannes Eder -h, --help, --version display this help and exit 9777f5b10aSHannes Eder 9877f5b10aSHannes EderWhen FILE is - read standard input. 9977f5b10aSHannes EderEOM 10077f5b10aSHannes Eder 10177f5b10aSHannes Eder exit($exitcode); 10277f5b10aSHannes Eder} 10377f5b10aSHannes Eder 104000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 105000d1cc1SJoe Perchesif (-f $conf) { 106000d1cc1SJoe Perches my @conf_args; 107000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 108000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 109000d1cc1SJoe Perches 110000d1cc1SJoe Perches while (<$conffile>) { 111000d1cc1SJoe Perches my $line = $_; 112000d1cc1SJoe Perches 113000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 114000d1cc1SJoe Perches $line =~ s/^\s*//g; 115000d1cc1SJoe Perches $line =~ s/\s+/ /g; 116000d1cc1SJoe Perches 117000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 118000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 119000d1cc1SJoe Perches 120000d1cc1SJoe Perches my @words = split(" ", $line); 121000d1cc1SJoe Perches foreach my $word (@words) { 122000d1cc1SJoe Perches last if ($word =~ m/^#/); 123000d1cc1SJoe Perches push (@conf_args, $word); 124000d1cc1SJoe Perches } 125000d1cc1SJoe Perches } 126000d1cc1SJoe Perches close($conffile); 127000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 128000d1cc1SJoe Perches} 129000d1cc1SJoe Perches 1300a920b5bSAndy WhitcroftGetOptions( 1316c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1320a920b5bSAndy Whitcroft 'tree!' => \$tree, 1330a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1340a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1356c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1368905a67cSAndy Whitcroft 'terse!' => \$terse, 13777f5b10aSHannes Eder 'f|file!' => \$file, 1386c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1396c72ffaaSAndy Whitcroft 'strict!' => \$check, 140000d1cc1SJoe Perches 'ignore=s' => \@ignore, 14191bfe484SJoe Perches 'types=s' => \@use, 142000d1cc1SJoe Perches 'show-types!' => \$show_types, 1436cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 14456193274SVadim Bendebury 'min-conf-desc-length=i' => \$min_conf_desc_length, 1456c72ffaaSAndy Whitcroft 'root=s' => \$root, 1468905a67cSAndy Whitcroft 'summary!' => \$summary, 1478905a67cSAndy Whitcroft 'mailback!' => \$mailback, 14813214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1493705ce5bSJoe Perches 'fix!' => \$fix, 1509624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 151d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 152c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 153773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 154*ebfd7d62SJoe Perches 'codespell!' => \$codespell, 155*ebfd7d62SJoe Perches 'codespellfile=s' => \$codespellfile, 15677f5b10aSHannes Eder 'h|help' => \$help, 15777f5b10aSHannes Eder 'version' => \$help 15877f5b10aSHannes Eder) or help(1); 15977f5b10aSHannes Eder 16077f5b10aSHannes Ederhelp(0) if ($help); 1610a920b5bSAndy Whitcroft 1629624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 1632ac73b4fSJoe Perches$check_orig = $check; 1649624b8d6SJoe Perches 1650a920b5bSAndy Whitcroftmy $exit = 0; 1660a920b5bSAndy Whitcroft 167d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 168d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 169d62a201fSDave Hansen if (!$ignore_perl_version) { 170d62a201fSDave Hansen exit(1); 171d62a201fSDave Hansen } 172d62a201fSDave Hansen} 173d62a201fSDave Hansen 1740a920b5bSAndy Whitcroftif ($#ARGV < 0) { 17577f5b10aSHannes Eder print "$P: no input files\n"; 1760a920b5bSAndy Whitcroft exit(1); 1770a920b5bSAndy Whitcroft} 1780a920b5bSAndy Whitcroft 17991bfe484SJoe Perchessub hash_save_array_words { 18091bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 18191bfe484SJoe Perches 18291bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 18391bfe484SJoe Perches foreach my $word (@array) { 184000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 185000d1cc1SJoe Perches $word =~ s/^\s*//g; 186000d1cc1SJoe Perches $word =~ s/\s+/ /g; 187000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 188000d1cc1SJoe Perches 189000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 190000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 191000d1cc1SJoe Perches 19291bfe484SJoe Perches $hashRef->{$word}++; 193000d1cc1SJoe Perches } 19491bfe484SJoe Perches} 19591bfe484SJoe Perches 19691bfe484SJoe Perchessub hash_show_words { 19791bfe484SJoe Perches my ($hashRef, $prefix) = @_; 19891bfe484SJoe Perches 19958cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 20091bfe484SJoe Perches print "NOTE: $prefix message types:"; 20158cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 20291bfe484SJoe Perches print " $word"; 20391bfe484SJoe Perches } 20491bfe484SJoe Perches print "\n\n"; 20591bfe484SJoe Perches } 20691bfe484SJoe Perches} 20791bfe484SJoe Perches 20891bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 20991bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 210000d1cc1SJoe Perches 211c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 212c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 2137429c690SAndy Whitcroftmy $dbg_type = 0; 214a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 215c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 21621caa13cSAndy Whitcroft ## no critic 21721caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 21821caa13cSAndy Whitcroft die "$@" if ($@); 219c2fdda0dSAndy Whitcroft} 220c2fdda0dSAndy Whitcroft 221d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 222d2c0a235SAndy Whitcroft 2238905a67cSAndy Whitcroftif ($terse) { 2248905a67cSAndy Whitcroft $emacs = 1; 2258905a67cSAndy Whitcroft $quiet++; 2268905a67cSAndy Whitcroft} 2278905a67cSAndy Whitcroft 2286c72ffaaSAndy Whitcroftif ($tree) { 2296c72ffaaSAndy Whitcroft if (defined $root) { 2306c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2316c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2326c72ffaaSAndy Whitcroft } 2336c72ffaaSAndy Whitcroft } else { 2346c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2356c72ffaaSAndy Whitcroft $root = '.'; 2366c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2376c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2386c72ffaaSAndy Whitcroft $root = $1; 2396c72ffaaSAndy Whitcroft } 2406c72ffaaSAndy Whitcroft } 2416c72ffaaSAndy Whitcroft 2426c72ffaaSAndy Whitcroft if (!defined $root) { 2430a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2440a920b5bSAndy Whitcroft exit(2); 2450a920b5bSAndy Whitcroft } 2466c72ffaaSAndy Whitcroft} 2476c72ffaaSAndy Whitcroft 2486c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2496c72ffaaSAndy Whitcroft 2502ceb532bSAndy Whitcroftour $Ident = qr{ 2512ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2522ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2532ceb532bSAndy Whitcroft }x; 2546c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2556c72ffaaSAndy Whitcroftour $Sparse = qr{ 2566c72ffaaSAndy Whitcroft __user| 2576c72ffaaSAndy Whitcroft __kernel| 2586c72ffaaSAndy Whitcroft __force| 2596c72ffaaSAndy Whitcroft __iomem| 2606c72ffaaSAndy Whitcroft __must_check| 2616c72ffaaSAndy Whitcroft __init_refok| 262417495edSAndy Whitcroft __kprobes| 263165e72a6SSven Eckelmann __ref| 264165e72a6SSven Eckelmann __rcu 2656c72ffaaSAndy Whitcroft }x; 266e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 267e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 268e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 269e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 270e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2718716de38SJoe Perches 27252131292SWolfram Sang# Notes to $Attribute: 27352131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2746c72ffaaSAndy Whitcroftour $Attribute = qr{ 2756c72ffaaSAndy Whitcroft const| 27603f1df7dSJoe Perches __percpu| 27703f1df7dSJoe Perches __nocast| 27803f1df7dSJoe Perches __safe| 27903f1df7dSJoe Perches __bitwise__| 28003f1df7dSJoe Perches __packed__| 28103f1df7dSJoe Perches __packed2__| 28203f1df7dSJoe Perches __naked| 28303f1df7dSJoe Perches __maybe_unused| 28403f1df7dSJoe Perches __always_unused| 28503f1df7dSJoe Perches __noreturn| 28603f1df7dSJoe Perches __used| 28703f1df7dSJoe Perches __cold| 288e23ef1f3SJoe Perches __pure| 28903f1df7dSJoe Perches __noclone| 29003f1df7dSJoe Perches __deprecated| 2916c72ffaaSAndy Whitcroft __read_mostly| 2926c72ffaaSAndy Whitcroft __kprobes| 2938716de38SJoe Perches $InitAttribute| 29424e1d81aSAndy Whitcroft ____cacheline_aligned| 29524e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2965fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2975fe3af11SAndy Whitcroft __weak 2986c72ffaaSAndy Whitcroft }x; 299c45dcabdSAndy Whitcroftour $Modifier; 30091cb5195SJoe Perchesour $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 3016c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 3026c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 3036c72ffaaSAndy Whitcroft 30495e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 30595e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 30695e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 30795e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 3082435880fSJoe Perchesour $Octal = qr{0[0-7]+$Int_type?}; 309c0a5c898SJoe Perchesour $String = qr{"[X\t]*"}; 310326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 311326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 312326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 31374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 3142435880fSJoe Perchesour $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 315326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 316447432f3SJoe Perchesour $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 31723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3186c72ffaaSAndy Whitcroftour $Operators = qr{ 3196c72ffaaSAndy Whitcroft <=|>=|==|!=| 3206c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 32123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3226c72ffaaSAndy Whitcroft }x; 3236c72ffaaSAndy Whitcroft 32491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 32591cb5195SJoe Perches 3268905a67cSAndy Whitcroftour $NonptrType; 3271813087dSJoe Perchesour $NonptrTypeMisordered; 3288716de38SJoe Perchesour $NonptrTypeWithAttr; 3298905a67cSAndy Whitcroftour $Type; 3301813087dSJoe Perchesour $TypeMisordered; 3318905a67cSAndy Whitcroftour $Declare; 3321813087dSJoe Perchesour $DeclareMisordered; 3338905a67cSAndy Whitcroft 33415662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 33515662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 336171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 337171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 338171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 339171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 340171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 341171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 342171ae1a4SAndy Whitcroft}x; 343171ae1a4SAndy Whitcroft 34415662b3eSJoe Perchesour $UTF8 = qr{ 34515662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 34615662b3eSJoe Perches | $NON_ASCII_UTF8 34715662b3eSJoe Perches}x; 34815662b3eSJoe Perches 349021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x: 350021158b4SJoe Perches u_(?:char|short|int|long) | # bsd 351021158b4SJoe Perches u(?:nchar|short|int|long) # sysv 352021158b4SJoe Perches)}; 353021158b4SJoe Perches 3548ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 355fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3568ed22cadSAndy Whitcroft atomic_t 3578ed22cadSAndy Whitcroft)}; 3588ed22cadSAndy Whitcroft 359691e669bSJoe Perchesour $logFunctions = qr{(?x: 3606e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3617d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3626e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 363b0531722SJoe Perches panic| 36406668727SJoe Perches MODULE_[A-Z_]+| 36506668727SJoe Perches seq_vprintf|seq_printf|seq_puts 366691e669bSJoe Perches)}; 367691e669bSJoe Perches 36820112475SJoe Perchesour $signature_tags = qr{(?xi: 36920112475SJoe Perches Signed-off-by:| 37020112475SJoe Perches Acked-by:| 37120112475SJoe Perches Tested-by:| 37220112475SJoe Perches Reviewed-by:| 37320112475SJoe Perches Reported-by:| 3748543ae12SMugunthan V N Suggested-by:| 37520112475SJoe Perches To:| 37620112475SJoe Perches Cc: 37720112475SJoe Perches)}; 37820112475SJoe Perches 3791813087dSJoe Perchesour @typeListMisordered = ( 3801813087dSJoe Perches qr{char\s+(?:un)?signed}, 3811813087dSJoe Perches qr{int\s+(?:(?:un)?signed\s+)?short\s}, 3821813087dSJoe Perches qr{int\s+short(?:\s+(?:un)?signed)}, 3831813087dSJoe Perches qr{short\s+int(?:\s+(?:un)?signed)}, 3841813087dSJoe Perches qr{(?:un)?signed\s+int\s+short}, 3851813087dSJoe Perches qr{short\s+(?:un)?signed}, 3861813087dSJoe Perches qr{long\s+int\s+(?:un)?signed}, 3871813087dSJoe Perches qr{int\s+long\s+(?:un)?signed}, 3881813087dSJoe Perches qr{long\s+(?:un)?signed\s+int}, 3891813087dSJoe Perches qr{int\s+(?:un)?signed\s+long}, 3901813087dSJoe Perches qr{int\s+(?:un)?signed}, 3911813087dSJoe Perches qr{int\s+long\s+long\s+(?:un)?signed}, 3921813087dSJoe Perches qr{long\s+long\s+int\s+(?:un)?signed}, 3931813087dSJoe Perches qr{long\s+long\s+(?:un)?signed\s+int}, 3941813087dSJoe Perches qr{long\s+long\s+(?:un)?signed}, 3951813087dSJoe Perches qr{long\s+(?:un)?signed}, 3961813087dSJoe Perches); 3971813087dSJoe Perches 3988905a67cSAndy Whitcroftour @typeList = ( 3998905a67cSAndy Whitcroft qr{void}, 4000c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?char}, 4010c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short\s+int}, 4020c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?short}, 4030c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?int}, 4040c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+int}, 4050c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 4060c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long\s+long}, 4070c773d9dSJoe Perches qr{(?:(?:un)?signed\s+)?long}, 4080c773d9dSJoe Perches qr{(?:un)?signed}, 4098905a67cSAndy Whitcroft qr{float}, 4108905a67cSAndy Whitcroft qr{double}, 4118905a67cSAndy Whitcroft qr{bool}, 4128905a67cSAndy Whitcroft qr{struct\s+$Ident}, 4138905a67cSAndy Whitcroft qr{union\s+$Ident}, 4148905a67cSAndy Whitcroft qr{enum\s+$Ident}, 4158905a67cSAndy Whitcroft qr{${Ident}_t}, 4168905a67cSAndy Whitcroft qr{${Ident}_handler}, 4178905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 4181813087dSJoe Perches @typeListMisordered, 4198905a67cSAndy Whitcroft); 4208716de38SJoe Perchesour @typeListWithAttr = ( 4218716de38SJoe Perches @typeList, 4228716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 4238716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 4248716de38SJoe Perches); 4258716de38SJoe Perches 426c45dcabdSAndy Whitcroftour @modifierList = ( 427c45dcabdSAndy Whitcroft qr{fastcall}, 428c45dcabdSAndy Whitcroft); 4298905a67cSAndy Whitcroft 4302435880fSJoe Perchesour @mode_permission_funcs = ( 4312435880fSJoe Perches ["module_param", 3], 4322435880fSJoe Perches ["module_param_(?:array|named|string)", 4], 4332435880fSJoe Perches ["module_param_array_named", 5], 4342435880fSJoe Perches ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 4352435880fSJoe Perches ["proc_create(?:_data|)", 2], 4362435880fSJoe Perches ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2], 4372435880fSJoe Perches); 4382435880fSJoe Perches 439515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below 440515a235eSJoe Perchesour $mode_perms_search = ""; 441515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) { 442515a235eSJoe Perches $mode_perms_search .= '|' if ($mode_perms_search ne ""); 443515a235eSJoe Perches $mode_perms_search .= $entry->[0]; 444515a235eSJoe Perches} 445515a235eSJoe Perches 4467840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 4477840a94cSWolfram Sang irq| 448cdcee686SSergey Ryazanov memory| 449cdcee686SSergey Ryazanov time| 450cdcee686SSergey Ryazanov reboot 4517840a94cSWolfram Sang)}; 4527840a94cSWolfram Sang# memory.h: ARM has a custom one 4537840a94cSWolfram Sang 45466b47b4aSKees Cook# Load common spelling mistakes and build regular expression list. 45566b47b4aSKees Cookmy $misspellings; 45666b47b4aSKees Cookmy %spelling_fix; 45736061e38SJoe Perches 45836061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) { 45966b47b4aSKees Cook while (<$spelling>) { 46066b47b4aSKees Cook my $line = $_; 46166b47b4aSKees Cook 46266b47b4aSKees Cook $line =~ s/\s*\n?$//g; 46366b47b4aSKees Cook $line =~ s/^\s*//g; 46466b47b4aSKees Cook 46566b47b4aSKees Cook next if ($line =~ m/^\s*#/); 46666b47b4aSKees Cook next if ($line =~ m/^\s*$/); 46766b47b4aSKees Cook 46866b47b4aSKees Cook my ($suspect, $fix) = split(/\|\|/, $line); 46966b47b4aSKees Cook 47066b47b4aSKees Cook $spelling_fix{$suspect} = $fix; 47166b47b4aSKees Cook } 47266b47b4aSKees Cook close($spelling); 47336061e38SJoe Perches} else { 47436061e38SJoe Perches warn "No typos will be found - file '$spelling_file': $!\n"; 47536061e38SJoe Perches} 47666b47b4aSKees Cook 477*ebfd7d62SJoe Perchesif ($codespell) { 478*ebfd7d62SJoe Perches if (open(my $spelling, '<', $codespellfile)) { 479*ebfd7d62SJoe Perches while (<$spelling>) { 480*ebfd7d62SJoe Perches my $line = $_; 481*ebfd7d62SJoe Perches 482*ebfd7d62SJoe Perches $line =~ s/\s*\n?$//g; 483*ebfd7d62SJoe Perches $line =~ s/^\s*//g; 484*ebfd7d62SJoe Perches 485*ebfd7d62SJoe Perches next if ($line =~ m/^\s*#/); 486*ebfd7d62SJoe Perches next if ($line =~ m/^\s*$/); 487*ebfd7d62SJoe Perches next if ($line =~ m/, disabled/i); 488*ebfd7d62SJoe Perches 489*ebfd7d62SJoe Perches $line =~ s/,.*$//; 490*ebfd7d62SJoe Perches 491*ebfd7d62SJoe Perches my ($suspect, $fix) = split(/->/, $line); 492*ebfd7d62SJoe Perches 493*ebfd7d62SJoe Perches $spelling_fix{$suspect} = $fix; 494*ebfd7d62SJoe Perches } 495*ebfd7d62SJoe Perches close($spelling); 496*ebfd7d62SJoe Perches } else { 497*ebfd7d62SJoe Perches warn "No codespell typos will be found - file '$codespellfile': $!\n"; 498*ebfd7d62SJoe Perches } 499*ebfd7d62SJoe Perches} 500*ebfd7d62SJoe Perches 501*ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 502*ebfd7d62SJoe Perches 5038905a67cSAndy Whitcroftsub build_types { 504d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 505d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 5061813087dSJoe Perches my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 5078716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 508c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 5098905a67cSAndy Whitcroft $NonptrType = qr{ 510d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 511cf655043SAndy Whitcroft (?: 5126b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 513021158b4SJoe Perches (?:$typeOtherOSTypedefs\b)| 5148ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 515c45dcabdSAndy Whitcroft (?:${all}\b) 516cf655043SAndy Whitcroft ) 517c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 5188905a67cSAndy Whitcroft }x; 5191813087dSJoe Perches $NonptrTypeMisordered = qr{ 5201813087dSJoe Perches (?:$Modifier\s+|const\s+)* 5211813087dSJoe Perches (?: 5221813087dSJoe Perches (?:${Misordered}\b) 5231813087dSJoe Perches ) 5241813087dSJoe Perches (?:\s+$Modifier|\s+const)* 5251813087dSJoe Perches }x; 5268716de38SJoe Perches $NonptrTypeWithAttr = qr{ 5278716de38SJoe Perches (?:$Modifier\s+|const\s+)* 5288716de38SJoe Perches (?: 5298716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 5308716de38SJoe Perches (?:$typeTypedefs\b)| 531021158b4SJoe Perches (?:$typeOtherOSTypedefs\b)| 5328716de38SJoe Perches (?:${allWithAttr}\b) 5338716de38SJoe Perches ) 5348716de38SJoe Perches (?:\s+$Modifier|\s+const)* 5358716de38SJoe Perches }x; 5368905a67cSAndy Whitcroft $Type = qr{ 537c45dcabdSAndy Whitcroft $NonptrType 5381574a29fSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 539c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 5408905a67cSAndy Whitcroft }x; 5411813087dSJoe Perches $TypeMisordered = qr{ 5421813087dSJoe Perches $NonptrTypeMisordered 5431813087dSJoe Perches (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? 5441813087dSJoe Perches (?:\s+$Inline|\s+$Modifier)* 5451813087dSJoe Perches }x; 54691cb5195SJoe Perches $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 5471813087dSJoe Perches $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 5488905a67cSAndy Whitcroft} 5498905a67cSAndy Whitcroftbuild_types(); 5506c72ffaaSAndy Whitcroft 5517d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 552d1fe9c09SJoe Perches 553d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 554d1fe9c09SJoe Perches# requires at least perl version v5.10.0 555d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 556d1fe9c09SJoe Perches 557d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 5582435880fSJoe Perchesour $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 559c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 5607d2367afSJoe Perches 561f8422308SJoe Perchesour $declaration_macros = qr{(?x: 562f8422308SJoe Perches (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(| 563f8422308SJoe Perches (?:$Storage\s+)?LIST_HEAD\s*\(| 564f8422308SJoe Perches (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\( 565f8422308SJoe Perches)}; 566f8422308SJoe Perches 5677d2367afSJoe Perchessub deparenthesize { 5687d2367afSJoe Perches my ($string) = @_; 5697d2367afSJoe Perches return "" if (!defined($string)); 5705b9553abSJoe Perches 5715b9553abSJoe Perches while ($string =~ /^\s*\(.*\)\s*$/) { 5725b9553abSJoe Perches $string =~ s@^\s*\(\s*@@; 5735b9553abSJoe Perches $string =~ s@\s*\)\s*$@@; 5745b9553abSJoe Perches } 5755b9553abSJoe Perches 5767d2367afSJoe Perches $string =~ s@\s+@ @g; 5775b9553abSJoe Perches 5787d2367afSJoe Perches return $string; 5797d2367afSJoe Perches} 5807d2367afSJoe Perches 5813445686aSJoe Perchessub seed_camelcase_file { 5823445686aSJoe Perches my ($file) = @_; 5833445686aSJoe Perches 5843445686aSJoe Perches return if (!(-f $file)); 5853445686aSJoe Perches 5863445686aSJoe Perches local $/; 5873445686aSJoe Perches 5883445686aSJoe Perches open(my $include_file, '<', "$file") 5893445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 5903445686aSJoe Perches my $text = <$include_file>; 5913445686aSJoe Perches close($include_file); 5923445686aSJoe Perches 5933445686aSJoe Perches my @lines = split('\n', $text); 5943445686aSJoe Perches 5953445686aSJoe Perches foreach my $line (@lines) { 5963445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 5973445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 5983445686aSJoe Perches $camelcase{$1} = 1; 59911ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 60011ea516aSJoe Perches $camelcase{$1} = 1; 60111ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 6023445686aSJoe Perches $camelcase{$1} = 1; 6033445686aSJoe Perches } 6043445686aSJoe Perches } 6053445686aSJoe Perches} 6063445686aSJoe Perches 6073445686aSJoe Perchesmy $camelcase_seeded = 0; 6083445686aSJoe Perchessub seed_camelcase_includes { 6093445686aSJoe Perches return if ($camelcase_seeded); 6103445686aSJoe Perches 6113445686aSJoe Perches my $files; 612c707a81dSJoe Perches my $camelcase_cache = ""; 613c707a81dSJoe Perches my @include_files = (); 614c707a81dSJoe Perches 615c707a81dSJoe Perches $camelcase_seeded = 1; 616351b2a1fSJoe Perches 6173645e328SRichard Genoud if (-e ".git") { 618351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 619351b2a1fSJoe Perches chomp $git_last_include_commit; 620c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 621c707a81dSJoe Perches } else { 622c707a81dSJoe Perches my $last_mod_date = 0; 623c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 624c707a81dSJoe Perches @include_files = split('\n', $files); 625c707a81dSJoe Perches foreach my $file (@include_files) { 626c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 627c707a81dSJoe Perches localtime((stat $file)[9])); 628c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 629c707a81dSJoe Perches } 630c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 631c707a81dSJoe Perches } 632c707a81dSJoe Perches 633c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 634c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 635c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 636351b2a1fSJoe Perches while (<$camelcase_file>) { 637351b2a1fSJoe Perches chomp; 638351b2a1fSJoe Perches $camelcase{$_} = 1; 639351b2a1fSJoe Perches } 640351b2a1fSJoe Perches close($camelcase_file); 641351b2a1fSJoe Perches 642351b2a1fSJoe Perches return; 643351b2a1fSJoe Perches } 644c707a81dSJoe Perches 6453645e328SRichard Genoud if (-e ".git") { 646c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 647c707a81dSJoe Perches @include_files = split('\n', $files); 6483445686aSJoe Perches } 649c707a81dSJoe Perches 6503445686aSJoe Perches foreach my $file (@include_files) { 6513445686aSJoe Perches seed_camelcase_file($file); 6523445686aSJoe Perches } 653351b2a1fSJoe Perches 654c707a81dSJoe Perches if ($camelcase_cache ne "") { 655351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 656c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 657c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 658351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 659351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 660351b2a1fSJoe Perches } 661351b2a1fSJoe Perches close($camelcase_file); 662351b2a1fSJoe Perches } 6633445686aSJoe Perches} 6643445686aSJoe Perches 665d311cd44SJoe Perchessub git_commit_info { 666d311cd44SJoe Perches my ($commit, $id, $desc) = @_; 667d311cd44SJoe Perches 668d311cd44SJoe Perches return ($id, $desc) if ((which("git") eq "") || !(-e ".git")); 669d311cd44SJoe Perches 670d311cd44SJoe Perches my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`; 671d311cd44SJoe Perches $output =~ s/^\s*//gm; 672d311cd44SJoe Perches my @lines = split("\n", $output); 673d311cd44SJoe Perches 6740d7835fcSJoe Perches return ($id, $desc) if ($#lines < 0); 6750d7835fcSJoe Perches 676d311cd44SJoe Perches if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) { 677d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns 678d311cd44SJoe Perches# all matching commit ids, but it's very slow... 679d311cd44SJoe Perches# 680d311cd44SJoe Perches# echo "checking commits $1..." 681d311cd44SJoe Perches# git rev-list --remotes | grep -i "^$1" | 682d311cd44SJoe Perches# while read line ; do 683d311cd44SJoe Perches# git log --format='%H %s' -1 $line | 684d311cd44SJoe Perches# echo "commit $(cut -c 1-12,41-)" 685d311cd44SJoe Perches# done 686d311cd44SJoe Perches } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 687d311cd44SJoe Perches } else { 688d311cd44SJoe Perches $id = substr($lines[0], 0, 12); 689d311cd44SJoe Perches $desc = substr($lines[0], 41); 690d311cd44SJoe Perches } 691d311cd44SJoe Perches 692d311cd44SJoe Perches return ($id, $desc); 693d311cd44SJoe Perches} 694d311cd44SJoe Perches 6956c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 6960a920b5bSAndy Whitcroft 69700df344fSAndy Whitcroftmy @rawlines = (); 698c2fdda0dSAndy Whitcroftmy @lines = (); 6993705ce5bSJoe Perchesmy @fixed = (); 700d752fcc8SJoe Perchesmy @fixed_inserted = (); 701d752fcc8SJoe Perchesmy @fixed_deleted = (); 702194f66fcSJoe Perchesmy $fixlinenr = -1; 703194f66fcSJoe Perches 704c2fdda0dSAndy Whitcroftmy $vname; 7056c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 70621caa13cSAndy Whitcroft my $FILE; 7076c72ffaaSAndy Whitcroft if ($file) { 70821caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 7096c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 71021caa13cSAndy Whitcroft } elsif ($filename eq '-') { 71121caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 7126c72ffaaSAndy Whitcroft } else { 71321caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 7146c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 7156c72ffaaSAndy Whitcroft } 716c2fdda0dSAndy Whitcroft if ($filename eq '-') { 717c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 718c2fdda0dSAndy Whitcroft } else { 719c2fdda0dSAndy Whitcroft $vname = $filename; 720c2fdda0dSAndy Whitcroft } 72121caa13cSAndy Whitcroft while (<$FILE>) { 7220a920b5bSAndy Whitcroft chomp; 72300df344fSAndy Whitcroft push(@rawlines, $_); 7246c72ffaaSAndy Whitcroft } 72521caa13cSAndy Whitcroft close($FILE); 726c2fdda0dSAndy Whitcroft if (!process($filename)) { 7270a920b5bSAndy Whitcroft $exit = 1; 7280a920b5bSAndy Whitcroft } 72900df344fSAndy Whitcroft @rawlines = (); 73013214adfSAndy Whitcroft @lines = (); 7313705ce5bSJoe Perches @fixed = (); 732d752fcc8SJoe Perches @fixed_inserted = (); 733d752fcc8SJoe Perches @fixed_deleted = (); 734194f66fcSJoe Perches $fixlinenr = -1; 7350a920b5bSAndy Whitcroft} 7360a920b5bSAndy Whitcroft 7370a920b5bSAndy Whitcroftexit($exit); 7380a920b5bSAndy Whitcroft 7390a920b5bSAndy Whitcroftsub top_of_kernel_tree { 7406c72ffaaSAndy Whitcroft my ($root) = @_; 7416c72ffaaSAndy Whitcroft 7426c72ffaaSAndy Whitcroft my @tree_check = ( 7436c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 7446c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 7456c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 7466c72ffaaSAndy Whitcroft ); 7476c72ffaaSAndy Whitcroft 7486c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 7496c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 7500a920b5bSAndy Whitcroft return 0; 7510a920b5bSAndy Whitcroft } 7526c72ffaaSAndy Whitcroft } 7536c72ffaaSAndy Whitcroft return 1; 7546c72ffaaSAndy Whitcroft} 7550a920b5bSAndy Whitcroft 75620112475SJoe Perchessub parse_email { 75720112475SJoe Perches my ($formatted_email) = @_; 75820112475SJoe Perches 75920112475SJoe Perches my $name = ""; 76020112475SJoe Perches my $address = ""; 76120112475SJoe Perches my $comment = ""; 76220112475SJoe Perches 76320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 76420112475SJoe Perches $name = $1; 76520112475SJoe Perches $address = $2; 76620112475SJoe Perches $comment = $3 if defined $3; 76720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 76820112475SJoe Perches $address = $1; 76920112475SJoe Perches $comment = $2 if defined $2; 77020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 77120112475SJoe Perches $address = $1; 77220112475SJoe Perches $comment = $2 if defined $2; 77320112475SJoe Perches $formatted_email =~ s/$address.*$//; 77420112475SJoe Perches $name = $formatted_email; 7753705ce5bSJoe Perches $name = trim($name); 77620112475SJoe Perches $name =~ s/^\"|\"$//g; 77720112475SJoe Perches # If there's a name left after stripping spaces and 77820112475SJoe Perches # leading quotes, and the address doesn't have both 77920112475SJoe Perches # leading and trailing angle brackets, the address 78020112475SJoe Perches # is invalid. ie: 78120112475SJoe Perches # "joe smith [email protected]" bad 78220112475SJoe Perches # "joe smith <[email protected]" bad 78320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 78420112475SJoe Perches $name = ""; 78520112475SJoe Perches $address = ""; 78620112475SJoe Perches $comment = ""; 78720112475SJoe Perches } 78820112475SJoe Perches } 78920112475SJoe Perches 7903705ce5bSJoe Perches $name = trim($name); 79120112475SJoe Perches $name =~ s/^\"|\"$//g; 7923705ce5bSJoe Perches $address = trim($address); 79320112475SJoe Perches $address =~ s/^\<|\>$//g; 79420112475SJoe Perches 79520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 79620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 79720112475SJoe Perches $name = "\"$name\""; 79820112475SJoe Perches } 79920112475SJoe Perches 80020112475SJoe Perches return ($name, $address, $comment); 80120112475SJoe Perches} 80220112475SJoe Perches 80320112475SJoe Perchessub format_email { 80420112475SJoe Perches my ($name, $address) = @_; 80520112475SJoe Perches 80620112475SJoe Perches my $formatted_email; 80720112475SJoe Perches 8083705ce5bSJoe Perches $name = trim($name); 80920112475SJoe Perches $name =~ s/^\"|\"$//g; 8103705ce5bSJoe Perches $address = trim($address); 81120112475SJoe Perches 81220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 81320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 81420112475SJoe Perches $name = "\"$name\""; 81520112475SJoe Perches } 81620112475SJoe Perches 81720112475SJoe Perches if ("$name" eq "") { 81820112475SJoe Perches $formatted_email = "$address"; 81920112475SJoe Perches } else { 82020112475SJoe Perches $formatted_email = "$name <$address>"; 82120112475SJoe Perches } 82220112475SJoe Perches 82320112475SJoe Perches return $formatted_email; 82420112475SJoe Perches} 82520112475SJoe Perches 826d311cd44SJoe Perchessub which { 827d311cd44SJoe Perches my ($bin) = @_; 828d311cd44SJoe Perches 829d311cd44SJoe Perches foreach my $path (split(/:/, $ENV{PATH})) { 830d311cd44SJoe Perches if (-e "$path/$bin") { 831d311cd44SJoe Perches return "$path/$bin"; 832d311cd44SJoe Perches } 833d311cd44SJoe Perches } 834d311cd44SJoe Perches 835d311cd44SJoe Perches return ""; 836d311cd44SJoe Perches} 837d311cd44SJoe Perches 838000d1cc1SJoe Perchessub which_conf { 839000d1cc1SJoe Perches my ($conf) = @_; 840000d1cc1SJoe Perches 841000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 842000d1cc1SJoe Perches if (-e "$path/$conf") { 843000d1cc1SJoe Perches return "$path/$conf"; 844000d1cc1SJoe Perches } 845000d1cc1SJoe Perches } 846000d1cc1SJoe Perches 847000d1cc1SJoe Perches return ""; 848000d1cc1SJoe Perches} 849000d1cc1SJoe Perches 8500a920b5bSAndy Whitcroftsub expand_tabs { 8510a920b5bSAndy Whitcroft my ($str) = @_; 8520a920b5bSAndy Whitcroft 8530a920b5bSAndy Whitcroft my $res = ''; 8540a920b5bSAndy Whitcroft my $n = 0; 8550a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 8560a920b5bSAndy Whitcroft if ($c eq "\t") { 8570a920b5bSAndy Whitcroft $res .= ' '; 8580a920b5bSAndy Whitcroft $n++; 8590a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 8600a920b5bSAndy Whitcroft $res .= ' '; 8610a920b5bSAndy Whitcroft } 8620a920b5bSAndy Whitcroft next; 8630a920b5bSAndy Whitcroft } 8640a920b5bSAndy Whitcroft $res .= $c; 8650a920b5bSAndy Whitcroft $n++; 8660a920b5bSAndy Whitcroft } 8670a920b5bSAndy Whitcroft 8680a920b5bSAndy Whitcroft return $res; 8690a920b5bSAndy Whitcroft} 8706c72ffaaSAndy Whitcroftsub copy_spacing { 871773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 8726c72ffaaSAndy Whitcroft return $res; 8736c72ffaaSAndy Whitcroft} 8740a920b5bSAndy Whitcroft 8754a0df2efSAndy Whitcroftsub line_stats { 8764a0df2efSAndy Whitcroft my ($line) = @_; 8774a0df2efSAndy Whitcroft 8784a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 8794a0df2efSAndy Whitcroft $line =~ s/^.//; 8804a0df2efSAndy Whitcroft $line = expand_tabs($line); 8814a0df2efSAndy Whitcroft 8824a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 8834a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 8844a0df2efSAndy Whitcroft 8854a0df2efSAndy Whitcroft return (length($line), length($white)); 8864a0df2efSAndy Whitcroft} 8874a0df2efSAndy Whitcroft 888773647a0SAndy Whitcroftmy $sanitise_quote = ''; 889773647a0SAndy Whitcroft 890773647a0SAndy Whitcroftsub sanitise_line_reset { 891773647a0SAndy Whitcroft my ($in_comment) = @_; 892773647a0SAndy Whitcroft 893773647a0SAndy Whitcroft if ($in_comment) { 894773647a0SAndy Whitcroft $sanitise_quote = '*/'; 895773647a0SAndy Whitcroft } else { 896773647a0SAndy Whitcroft $sanitise_quote = ''; 897773647a0SAndy Whitcroft } 898773647a0SAndy Whitcroft} 89900df344fSAndy Whitcroftsub sanitise_line { 90000df344fSAndy Whitcroft my ($line) = @_; 90100df344fSAndy Whitcroft 90200df344fSAndy Whitcroft my $res = ''; 90300df344fSAndy Whitcroft my $l = ''; 90400df344fSAndy Whitcroft 905c2fdda0dSAndy Whitcroft my $qlen = 0; 906773647a0SAndy Whitcroft my $off = 0; 907773647a0SAndy Whitcroft my $c; 90800df344fSAndy Whitcroft 909773647a0SAndy Whitcroft # Always copy over the diff marker. 910773647a0SAndy Whitcroft $res = substr($line, 0, 1); 911773647a0SAndy Whitcroft 912773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 913773647a0SAndy Whitcroft $c = substr($line, $off, 1); 914773647a0SAndy Whitcroft 915773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 916773647a0SAndy Whitcroft # and end, all to $;. 917773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 918773647a0SAndy Whitcroft $sanitise_quote = '*/'; 919773647a0SAndy Whitcroft 920773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 921773647a0SAndy Whitcroft $off++; 92200df344fSAndy Whitcroft next; 923773647a0SAndy Whitcroft } 92481bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 925773647a0SAndy Whitcroft $sanitise_quote = ''; 926773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 927773647a0SAndy Whitcroft $off++; 928773647a0SAndy Whitcroft next; 929773647a0SAndy Whitcroft } 930113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 931113f04a8SDaniel Walker $sanitise_quote = '//'; 932113f04a8SDaniel Walker 933113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 934113f04a8SDaniel Walker $off++; 935113f04a8SDaniel Walker next; 936113f04a8SDaniel Walker } 937773647a0SAndy Whitcroft 938773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 939773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 940773647a0SAndy Whitcroft $c eq "\\") { 941773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 942773647a0SAndy Whitcroft $off++; 943773647a0SAndy Whitcroft next; 944773647a0SAndy Whitcroft } 945773647a0SAndy Whitcroft # Regular quotes. 946773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 947773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 948773647a0SAndy Whitcroft $sanitise_quote = $c; 949773647a0SAndy Whitcroft 950773647a0SAndy Whitcroft substr($res, $off, 1, $c); 951773647a0SAndy Whitcroft next; 952773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 953773647a0SAndy Whitcroft $sanitise_quote = ''; 95400df344fSAndy Whitcroft } 95500df344fSAndy Whitcroft } 956773647a0SAndy Whitcroft 957fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 958773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 959773647a0SAndy Whitcroft substr($res, $off, 1, $;); 960113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 961113f04a8SDaniel Walker substr($res, $off, 1, $;); 962773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 963773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 96400df344fSAndy Whitcroft } else { 965773647a0SAndy Whitcroft substr($res, $off, 1, $c); 96600df344fSAndy Whitcroft } 967c2fdda0dSAndy Whitcroft } 968c2fdda0dSAndy Whitcroft 969113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 970113f04a8SDaniel Walker $sanitise_quote = ''; 971113f04a8SDaniel Walker } 972113f04a8SDaniel Walker 973c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 974c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 975c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 976c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 977c2fdda0dSAndy Whitcroft 978c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 979c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 980c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 981c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 982c2fdda0dSAndy Whitcroft } 983c2fdda0dSAndy Whitcroft 98400df344fSAndy Whitcroft return $res; 98500df344fSAndy Whitcroft} 98600df344fSAndy Whitcroft 987a6962d72SJoe Perchessub get_quoted_string { 988a6962d72SJoe Perches my ($line, $rawline) = @_; 989a6962d72SJoe Perches 9905e4f6ba5SJoe Perches return "" if ($line !~ m/(\"[X\t]+\")/g); 991a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 992a6962d72SJoe Perches} 993a6962d72SJoe Perches 9948905a67cSAndy Whitcroftsub ctx_statement_block { 9958905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 9968905a67cSAndy Whitcroft my $line = $linenr - 1; 9978905a67cSAndy Whitcroft my $blk = ''; 9988905a67cSAndy Whitcroft my $soff = $off; 9998905a67cSAndy Whitcroft my $coff = $off - 1; 1000773647a0SAndy Whitcroft my $coff_set = 0; 10018905a67cSAndy Whitcroft 100213214adfSAndy Whitcroft my $loff = 0; 100313214adfSAndy Whitcroft 10048905a67cSAndy Whitcroft my $type = ''; 10058905a67cSAndy Whitcroft my $level = 0; 1006a2750645SAndy Whitcroft my @stack = (); 1007cf655043SAndy Whitcroft my $p; 10088905a67cSAndy Whitcroft my $c; 10098905a67cSAndy Whitcroft my $len = 0; 101013214adfSAndy Whitcroft 101113214adfSAndy Whitcroft my $remainder; 10128905a67cSAndy Whitcroft while (1) { 1013a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 1014a2750645SAndy Whitcroft 1015773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 10168905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 10178905a67cSAndy Whitcroft # context. 10188905a67cSAndy Whitcroft if ($off >= $len) { 10198905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 1020dea33496SAndy Whitcroft last if (!defined $lines[$line]); 1021c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 10228905a67cSAndy Whitcroft $remain--; 102313214adfSAndy Whitcroft $loff = $len; 1024c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 10258905a67cSAndy Whitcroft $len = length($blk); 10268905a67cSAndy Whitcroft $line++; 10278905a67cSAndy Whitcroft last; 10288905a67cSAndy Whitcroft } 10298905a67cSAndy Whitcroft # Bail if there is no further context. 10308905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 103113214adfSAndy Whitcroft if ($off >= $len) { 10328905a67cSAndy Whitcroft last; 10338905a67cSAndy Whitcroft } 1034f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1035f74bd194SAndy Whitcroft $level++; 1036f74bd194SAndy Whitcroft $type = '#'; 1037f74bd194SAndy Whitcroft } 10388905a67cSAndy Whitcroft } 1039cf655043SAndy Whitcroft $p = $c; 10408905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 104113214adfSAndy Whitcroft $remainder = substr($blk, $off); 10428905a67cSAndy Whitcroft 1043773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 10444635f4fbSAndy Whitcroft 10454635f4fbSAndy Whitcroft # Handle nested #if/#else. 10464635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 10474635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 10484635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 10494635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 10504635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 10514635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 10524635f4fbSAndy Whitcroft } 10534635f4fbSAndy Whitcroft 10548905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 10558905a67cSAndy Whitcroft # outermost level. 10568905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 10578905a67cSAndy Whitcroft last; 10588905a67cSAndy Whitcroft } 10598905a67cSAndy Whitcroft 106013214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 1061773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 1062773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1063773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 1064773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 1065773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 1066773647a0SAndy Whitcroft $coff_set = 1; 1067773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1068773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 106913214adfSAndy Whitcroft } 107013214adfSAndy Whitcroft 10718905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 10728905a67cSAndy Whitcroft $level++; 10738905a67cSAndy Whitcroft $type = '('; 10748905a67cSAndy Whitcroft } 10758905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 10768905a67cSAndy Whitcroft $level--; 10778905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 10788905a67cSAndy Whitcroft 10798905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 10808905a67cSAndy Whitcroft $coff = $off; 1081773647a0SAndy Whitcroft $coff_set = 1; 1082773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 10838905a67cSAndy Whitcroft } 10848905a67cSAndy Whitcroft } 10858905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 10868905a67cSAndy Whitcroft $level++; 10878905a67cSAndy Whitcroft $type = '{'; 10888905a67cSAndy Whitcroft } 10898905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 10908905a67cSAndy Whitcroft $level--; 10918905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 10928905a67cSAndy Whitcroft 10938905a67cSAndy Whitcroft if ($level == 0) { 1094b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 1095b998e001SPatrick Pannuto $off++; 1096b998e001SPatrick Pannuto } 10978905a67cSAndy Whitcroft last; 10988905a67cSAndy Whitcroft } 10998905a67cSAndy Whitcroft } 1100f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 1101f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1102f74bd194SAndy Whitcroft $level--; 1103f74bd194SAndy Whitcroft $type = ''; 1104f74bd194SAndy Whitcroft $off++; 1105f74bd194SAndy Whitcroft last; 1106f74bd194SAndy Whitcroft } 11078905a67cSAndy Whitcroft $off++; 11088905a67cSAndy Whitcroft } 1109a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 111013214adfSAndy Whitcroft if ($off == $len) { 1111a3bb97a7SAndy Whitcroft $loff = $len + 1; 111213214adfSAndy Whitcroft $line++; 111313214adfSAndy Whitcroft $remain--; 111413214adfSAndy Whitcroft } 11158905a67cSAndy Whitcroft 11168905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 11178905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 11188905a67cSAndy Whitcroft 11198905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 11208905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 11218905a67cSAndy Whitcroft 1122773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 112313214adfSAndy Whitcroft 112413214adfSAndy Whitcroft return ($statement, $condition, 112513214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 112613214adfSAndy Whitcroft} 112713214adfSAndy Whitcroft 1128cf655043SAndy Whitcroftsub statement_lines { 1129cf655043SAndy Whitcroft my ($stmt) = @_; 1130cf655043SAndy Whitcroft 1131cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 1132cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1133cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1134cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1135cf655043SAndy Whitcroft 1136cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1137cf655043SAndy Whitcroft 1138cf655043SAndy Whitcroft return $#stmt_lines + 2; 1139cf655043SAndy Whitcroft} 1140cf655043SAndy Whitcroft 1141cf655043SAndy Whitcroftsub statement_rawlines { 1142cf655043SAndy Whitcroft my ($stmt) = @_; 1143cf655043SAndy Whitcroft 1144cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1145cf655043SAndy Whitcroft 1146cf655043SAndy Whitcroft return $#stmt_lines + 2; 1147cf655043SAndy Whitcroft} 1148cf655043SAndy Whitcroft 1149cf655043SAndy Whitcroftsub statement_block_size { 1150cf655043SAndy Whitcroft my ($stmt) = @_; 1151cf655043SAndy Whitcroft 1152cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 1153cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 1154cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 1155cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 1156cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 1157cf655043SAndy Whitcroft 1158cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 1159cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 1160cf655043SAndy Whitcroft 1161cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 1162cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 1163cf655043SAndy Whitcroft 1164cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 1165cf655043SAndy Whitcroft return $stmt_lines; 1166cf655043SAndy Whitcroft } else { 1167cf655043SAndy Whitcroft return $stmt_statements; 1168cf655043SAndy Whitcroft } 1169cf655043SAndy Whitcroft} 1170cf655043SAndy Whitcroft 117113214adfSAndy Whitcroftsub ctx_statement_full { 117213214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 117313214adfSAndy Whitcroft my ($statement, $condition, $level); 117413214adfSAndy Whitcroft 117513214adfSAndy Whitcroft my (@chunks); 117613214adfSAndy Whitcroft 1177cf655043SAndy Whitcroft # Grab the first conditional/block pair. 117813214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 117913214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1180773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 118113214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 1182cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1183cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 1184cf655043SAndy Whitcroft } 1185cf655043SAndy Whitcroft 1186cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 1187cf655043SAndy Whitcroft # could continue the statement. 1188cf655043SAndy Whitcroft for (;;) { 118913214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 119013214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 1191cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1192773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1193cf655043SAndy Whitcroft #print "C: push\n"; 1194cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 119513214adfSAndy Whitcroft } 119613214adfSAndy Whitcroft 119713214adfSAndy Whitcroft return ($level, $linenr, @chunks); 11988905a67cSAndy Whitcroft} 11998905a67cSAndy Whitcroft 12004a0df2efSAndy Whitcroftsub ctx_block_get { 1201f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 12024a0df2efSAndy Whitcroft my $line; 12034a0df2efSAndy Whitcroft my $start = $linenr - 1; 12044a0df2efSAndy Whitcroft my $blk = ''; 12054a0df2efSAndy Whitcroft my @o; 12064a0df2efSAndy Whitcroft my @c; 12074a0df2efSAndy Whitcroft my @res = (); 12084a0df2efSAndy Whitcroft 1209f0a594c1SAndy Whitcroft my $level = 0; 12104635f4fbSAndy Whitcroft my @stack = ($level); 121100df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 121200df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 121300df344fSAndy Whitcroft $remain--; 121400df344fSAndy Whitcroft 121500df344fSAndy Whitcroft $blk .= $rawlines[$line]; 12164635f4fbSAndy Whitcroft 12174635f4fbSAndy Whitcroft # Handle nested #if/#else. 121801464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 12194635f4fbSAndy Whitcroft push(@stack, $level); 122001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 12214635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 122201464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 12234635f4fbSAndy Whitcroft $level = pop(@stack); 12244635f4fbSAndy Whitcroft } 12254635f4fbSAndy Whitcroft 122601464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1227f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1228f0a594c1SAndy Whitcroft if ($off > 0) { 1229f0a594c1SAndy Whitcroft $off--; 1230f0a594c1SAndy Whitcroft next; 1231f0a594c1SAndy Whitcroft } 12324a0df2efSAndy Whitcroft 1233f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1234f0a594c1SAndy Whitcroft $level--; 1235f0a594c1SAndy Whitcroft last if ($level == 0); 1236f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1237f0a594c1SAndy Whitcroft $level++; 1238f0a594c1SAndy Whitcroft } 1239f0a594c1SAndy Whitcroft } 12404a0df2efSAndy Whitcroft 1241f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 124200df344fSAndy Whitcroft push(@res, $rawlines[$line]); 12434a0df2efSAndy Whitcroft } 12444a0df2efSAndy Whitcroft 1245f0a594c1SAndy Whitcroft last if ($level == 0); 12464a0df2efSAndy Whitcroft } 12474a0df2efSAndy Whitcroft 1248f0a594c1SAndy Whitcroft return ($level, @res); 12494a0df2efSAndy Whitcroft} 12504a0df2efSAndy Whitcroftsub ctx_block_outer { 12514a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12524a0df2efSAndy Whitcroft 1253f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1254f0a594c1SAndy Whitcroft return @r; 12554a0df2efSAndy Whitcroft} 12564a0df2efSAndy Whitcroftsub ctx_block { 12574a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 12584a0df2efSAndy Whitcroft 1259f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1260f0a594c1SAndy Whitcroft return @r; 1261653d4876SAndy Whitcroft} 1262653d4876SAndy Whitcroftsub ctx_statement { 1263f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1264f0a594c1SAndy Whitcroft 1265f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1266f0a594c1SAndy Whitcroft return @r; 1267f0a594c1SAndy Whitcroft} 1268f0a594c1SAndy Whitcroftsub ctx_block_level { 1269653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1270653d4876SAndy Whitcroft 1271f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 12724a0df2efSAndy Whitcroft} 12739c0ca6f9SAndy Whitcroftsub ctx_statement_level { 12749c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 12759c0ca6f9SAndy Whitcroft 12769c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 12779c0ca6f9SAndy Whitcroft} 12784a0df2efSAndy Whitcroft 12794a0df2efSAndy Whitcroftsub ctx_locate_comment { 12804a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 12814a0df2efSAndy Whitcroft 12824a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1283beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 12844a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 12854a0df2efSAndy Whitcroft 12864a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 12874a0df2efSAndy Whitcroft # comment. 12884a0df2efSAndy Whitcroft my $in_comment = 0; 12894a0df2efSAndy Whitcroft $current_comment = ''; 12904a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 129100df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 129200df344fSAndy Whitcroft #warn " $line\n"; 12934a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 12944a0df2efSAndy Whitcroft $in_comment = 1; 12954a0df2efSAndy Whitcroft } 12964a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 12974a0df2efSAndy Whitcroft $in_comment = 1; 12984a0df2efSAndy Whitcroft } 12994a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 13004a0df2efSAndy Whitcroft $current_comment = ''; 13014a0df2efSAndy Whitcroft } 13024a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 13034a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 13044a0df2efSAndy Whitcroft $in_comment = 0; 13054a0df2efSAndy Whitcroft } 13064a0df2efSAndy Whitcroft } 13074a0df2efSAndy Whitcroft 13084a0df2efSAndy Whitcroft chomp($current_comment); 13094a0df2efSAndy Whitcroft return($current_comment); 13104a0df2efSAndy Whitcroft} 13114a0df2efSAndy Whitcroftsub ctx_has_comment { 13124a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 13134a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 13144a0df2efSAndy Whitcroft 131500df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 13164a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 13174a0df2efSAndy Whitcroft 13184a0df2efSAndy Whitcroft return ($cmt ne ''); 13194a0df2efSAndy Whitcroft} 13204a0df2efSAndy Whitcroft 13214d001e4dSAndy Whitcroftsub raw_line { 13224d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 13234d001e4dSAndy Whitcroft 13244d001e4dSAndy Whitcroft my $offset = $linenr - 1; 13254d001e4dSAndy Whitcroft $cnt++; 13264d001e4dSAndy Whitcroft 13274d001e4dSAndy Whitcroft my $line; 13284d001e4dSAndy Whitcroft while ($cnt) { 13294d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 13304d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 13314d001e4dSAndy Whitcroft $cnt--; 13324d001e4dSAndy Whitcroft } 13334d001e4dSAndy Whitcroft 13344d001e4dSAndy Whitcroft return $line; 13354d001e4dSAndy Whitcroft} 13364d001e4dSAndy Whitcroft 13370a920b5bSAndy Whitcroftsub cat_vet { 13380a920b5bSAndy Whitcroft my ($vet) = @_; 13399c0ca6f9SAndy Whitcroft my ($res, $coded); 13400a920b5bSAndy Whitcroft 13419c0ca6f9SAndy Whitcroft $res = ''; 13426c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 13436c72ffaaSAndy Whitcroft $res .= $1; 13446c72ffaaSAndy Whitcroft if ($2 ne '') { 13459c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 13466c72ffaaSAndy Whitcroft $res .= $coded; 13476c72ffaaSAndy Whitcroft } 13489c0ca6f9SAndy Whitcroft } 13499c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 13500a920b5bSAndy Whitcroft 13519c0ca6f9SAndy Whitcroft return $res; 13520a920b5bSAndy Whitcroft} 13530a920b5bSAndy Whitcroft 1354c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1355cf655043SAndy Whitcroftmy $av_pending; 1356c2fdda0dSAndy Whitcroftmy @av_paren_type; 13571f65f947SAndy Whitcroftmy $av_pend_colon; 1358c2fdda0dSAndy Whitcroft 1359c2fdda0dSAndy Whitcroftsub annotate_reset { 1360c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1361cf655043SAndy Whitcroft $av_pending = '_'; 1362cf655043SAndy Whitcroft @av_paren_type = ('E'); 13631f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1364c2fdda0dSAndy Whitcroft} 1365c2fdda0dSAndy Whitcroft 13666c72ffaaSAndy Whitcroftsub annotate_values { 13676c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 13686c72ffaaSAndy Whitcroft 13696c72ffaaSAndy Whitcroft my $res; 13701f65f947SAndy Whitcroft my $var = '_' x length($stream); 13716c72ffaaSAndy Whitcroft my $cur = $stream; 13726c72ffaaSAndy Whitcroft 1373c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 13746c72ffaaSAndy Whitcroft 13756c72ffaaSAndy Whitcroft while (length($cur)) { 1376773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1377cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1378171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 13796c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1380c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1381c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1382cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1383c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 13846c72ffaaSAndy Whitcroft } 13856c72ffaaSAndy Whitcroft 1386c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 13879446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 13889446ef56SAndy Whitcroft push(@av_paren_type, $type); 1389addcdceaSAndy Whitcroft $type = 'c'; 13909446ef56SAndy Whitcroft 1391e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1392c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 13936c72ffaaSAndy Whitcroft $type = 'T'; 13946c72ffaaSAndy Whitcroft 1395389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1396389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1397389a2fe5SAndy Whitcroft $type = 'T'; 1398389a2fe5SAndy Whitcroft 1399c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1400171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1401c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1402171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1403171ae1a4SAndy Whitcroft if ($2 ne '') { 1404cf655043SAndy Whitcroft $av_pending = 'N'; 1405171ae1a4SAndy Whitcroft } 1406171ae1a4SAndy Whitcroft $type = 'E'; 1407171ae1a4SAndy Whitcroft 1408c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1409171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1410171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1411171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 14126c72ffaaSAndy Whitcroft 1413c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1414cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1415c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1416cf655043SAndy Whitcroft 1417cf655043SAndy Whitcroft push(@av_paren_type, $type); 1418cf655043SAndy Whitcroft push(@av_paren_type, $type); 1419171ae1a4SAndy Whitcroft $type = 'E'; 1420cf655043SAndy Whitcroft 1421c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1422cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1423cf655043SAndy Whitcroft $av_preprocessor = 1; 1424cf655043SAndy Whitcroft 1425cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1426cf655043SAndy Whitcroft 1427171ae1a4SAndy Whitcroft $type = 'E'; 1428cf655043SAndy Whitcroft 1429c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1430cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1431cf655043SAndy Whitcroft 1432cf655043SAndy Whitcroft $av_preprocessor = 1; 1433cf655043SAndy Whitcroft 1434cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1435cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1436cf655043SAndy Whitcroft pop(@av_paren_type); 1437cf655043SAndy Whitcroft push(@av_paren_type, $type); 1438171ae1a4SAndy Whitcroft $type = 'E'; 14396c72ffaaSAndy Whitcroft 14406c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1441c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 14426c72ffaaSAndy Whitcroft 1443171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1444171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1445171ae1a4SAndy Whitcroft $av_pending = $type; 1446171ae1a4SAndy Whitcroft $type = 'N'; 1447171ae1a4SAndy Whitcroft 14486c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1449c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 14506c72ffaaSAndy Whitcroft if (defined $2) { 1451cf655043SAndy Whitcroft $av_pending = 'V'; 14526c72ffaaSAndy Whitcroft } 14536c72ffaaSAndy Whitcroft $type = 'N'; 14546c72ffaaSAndy Whitcroft 145514b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1456c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 145714b111c1SAndy Whitcroft $av_pending = 'E'; 14586c72ffaaSAndy Whitcroft $type = 'N'; 14596c72ffaaSAndy Whitcroft 14601f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 14611f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 14621f65f947SAndy Whitcroft $av_pend_colon = 'C'; 14631f65f947SAndy Whitcroft $type = 'N'; 14641f65f947SAndy Whitcroft 146514b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1466c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 14676c72ffaaSAndy Whitcroft $type = 'N'; 14686c72ffaaSAndy Whitcroft 14696c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1470c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1471cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1472cf655043SAndy Whitcroft $av_pending = '_'; 14736c72ffaaSAndy Whitcroft $type = 'N'; 14746c72ffaaSAndy Whitcroft 14756c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1476cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1477cf655043SAndy Whitcroft if ($new_type ne '_') { 1478cf655043SAndy Whitcroft $type = $new_type; 1479c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1480c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 14816c72ffaaSAndy Whitcroft } else { 1482c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 14836c72ffaaSAndy Whitcroft } 14846c72ffaaSAndy Whitcroft 1485c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1486c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1487c8cb2ca3SAndy Whitcroft $type = 'V'; 1488cf655043SAndy Whitcroft $av_pending = 'V'; 14896c72ffaaSAndy Whitcroft 14908e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 14918e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 14921f65f947SAndy Whitcroft $av_pend_colon = 'B'; 14938e761b04SAndy Whitcroft } elsif ($type eq 'E') { 14948e761b04SAndy Whitcroft $av_pend_colon = 'L'; 14951f65f947SAndy Whitcroft } 14961f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 14971f65f947SAndy Whitcroft $type = 'V'; 14981f65f947SAndy Whitcroft 14996c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1500c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 15016c72ffaaSAndy Whitcroft $type = 'V'; 15026c72ffaaSAndy Whitcroft 15036c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1504c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 15056c72ffaaSAndy Whitcroft $type = 'N'; 15066c72ffaaSAndy Whitcroft 1507cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1508c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 150913214adfSAndy Whitcroft $type = 'E'; 15101f65f947SAndy Whitcroft $av_pend_colon = 'O'; 151113214adfSAndy Whitcroft 15128e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 15138e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 15148e761b04SAndy Whitcroft $type = 'C'; 15158e761b04SAndy Whitcroft 15161f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 15171f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 15181f65f947SAndy Whitcroft $type = 'N'; 15191f65f947SAndy Whitcroft 15201f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 15211f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 15221f65f947SAndy Whitcroft 15231f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 15241f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 15251f65f947SAndy Whitcroft $type = 'E'; 15261f65f947SAndy Whitcroft } else { 15271f65f947SAndy Whitcroft $type = 'N'; 15281f65f947SAndy Whitcroft } 15291f65f947SAndy Whitcroft $av_pend_colon = 'O'; 15301f65f947SAndy Whitcroft 15318e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 153213214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 15336c72ffaaSAndy Whitcroft $type = 'N'; 15346c72ffaaSAndy Whitcroft 15350d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 153674048ed8SAndy Whitcroft my $variant; 153774048ed8SAndy Whitcroft 153874048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 153974048ed8SAndy Whitcroft if ($type eq 'V') { 154074048ed8SAndy Whitcroft $variant = 'B'; 154174048ed8SAndy Whitcroft } else { 154274048ed8SAndy Whitcroft $variant = 'U'; 154374048ed8SAndy Whitcroft } 154474048ed8SAndy Whitcroft 154574048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 154674048ed8SAndy Whitcroft $type = 'N'; 154774048ed8SAndy Whitcroft 15486c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1549c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 15506c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 15516c72ffaaSAndy Whitcroft $type = 'N'; 15526c72ffaaSAndy Whitcroft } 15536c72ffaaSAndy Whitcroft 15546c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1555c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 15566c72ffaaSAndy Whitcroft } 15576c72ffaaSAndy Whitcroft if (defined $1) { 15586c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 15596c72ffaaSAndy Whitcroft $res .= $type x length($1); 15606c72ffaaSAndy Whitcroft } 15616c72ffaaSAndy Whitcroft } 15626c72ffaaSAndy Whitcroft 15631f65f947SAndy Whitcroft return ($res, $var); 15646c72ffaaSAndy Whitcroft} 15656c72ffaaSAndy Whitcroft 15668905a67cSAndy Whitcroftsub possible { 156713214adfSAndy Whitcroft my ($possible, $line) = @_; 15689a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 15690776e594SAndy Whitcroft ^(?: 15700776e594SAndy Whitcroft $Modifier| 15710776e594SAndy Whitcroft $Storage| 15720776e594SAndy Whitcroft $Type| 15739a974fdbSAndy Whitcroft DEFINE_\S+ 15749a974fdbSAndy Whitcroft )$| 15759a974fdbSAndy Whitcroft ^(?: 15760776e594SAndy Whitcroft goto| 15770776e594SAndy Whitcroft return| 15780776e594SAndy Whitcroft case| 15790776e594SAndy Whitcroft else| 15800776e594SAndy Whitcroft asm|__asm__| 158189a88353SAndy Whitcroft do| 158289a88353SAndy Whitcroft \#| 158389a88353SAndy Whitcroft \#\#| 15849a974fdbSAndy Whitcroft )(?:\s|$)| 15850776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 15869a974fdbSAndy Whitcroft )}x; 15879a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 15889a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1589c45dcabdSAndy Whitcroft # Check for modifiers. 1590c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1591c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1592c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1593c45dcabdSAndy Whitcroft 1594c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1595c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1596d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 15979a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1598d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1599d2506586SAndy Whitcroft push(@modifierList, $modifier); 1600d2506586SAndy Whitcroft } 16019a974fdbSAndy Whitcroft } 1602c45dcabdSAndy Whitcroft 1603c45dcabdSAndy Whitcroft } else { 160413214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 16058905a67cSAndy Whitcroft push(@typeList, $possible); 1606c45dcabdSAndy Whitcroft } 16078905a67cSAndy Whitcroft build_types(); 16080776e594SAndy Whitcroft } else { 16090776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 16108905a67cSAndy Whitcroft } 16118905a67cSAndy Whitcroft} 16128905a67cSAndy Whitcroft 16136c72ffaaSAndy Whitcroftmy $prefix = ''; 16146c72ffaaSAndy Whitcroft 1615000d1cc1SJoe Perchessub show_type { 1616cbec18afSJoe Perches my ($type) = @_; 161791bfe484SJoe Perches 1618cbec18afSJoe Perches return defined $use_type{$type} if (scalar keys %use_type > 0); 1619cbec18afSJoe Perches 1620cbec18afSJoe Perches return !defined $ignore_type{$type}; 1621000d1cc1SJoe Perches} 1622000d1cc1SJoe Perches 1623f0a594c1SAndy Whitcroftsub report { 1624cbec18afSJoe Perches my ($level, $type, $msg) = @_; 1625cbec18afSJoe Perches 1626cbec18afSJoe Perches if (!show_type($type) || 1627cbec18afSJoe Perches (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 1628773647a0SAndy Whitcroft return 0; 1629773647a0SAndy Whitcroft } 1630000d1cc1SJoe Perches my $line; 1631000d1cc1SJoe Perches if ($show_types) { 1632cbec18afSJoe Perches $line = "$prefix$level:$type: $msg\n"; 1633000d1cc1SJoe Perches } else { 1634cbec18afSJoe Perches $line = "$prefix$level: $msg\n"; 1635000d1cc1SJoe Perches } 16368905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 16378905a67cSAndy Whitcroft 163813214adfSAndy Whitcroft push(our @report, $line); 1639773647a0SAndy Whitcroft 1640773647a0SAndy Whitcroft return 1; 1641f0a594c1SAndy Whitcroft} 1642cbec18afSJoe Perches 1643f0a594c1SAndy Whitcroftsub report_dump { 164413214adfSAndy Whitcroft our @report; 1645f0a594c1SAndy Whitcroft} 1646000d1cc1SJoe Perches 1647d752fcc8SJoe Perchessub fixup_current_range { 1648d752fcc8SJoe Perches my ($lineRef, $offset, $length) = @_; 1649d752fcc8SJoe Perches 1650d752fcc8SJoe Perches if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 1651d752fcc8SJoe Perches my $o = $1; 1652d752fcc8SJoe Perches my $l = $2; 1653d752fcc8SJoe Perches my $no = $o + $offset; 1654d752fcc8SJoe Perches my $nl = $l + $length; 1655d752fcc8SJoe Perches $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 1656d752fcc8SJoe Perches } 1657d752fcc8SJoe Perches} 1658d752fcc8SJoe Perches 1659d752fcc8SJoe Perchessub fix_inserted_deleted_lines { 1660d752fcc8SJoe Perches my ($linesRef, $insertedRef, $deletedRef) = @_; 1661d752fcc8SJoe Perches 1662d752fcc8SJoe Perches my $range_last_linenr = 0; 1663d752fcc8SJoe Perches my $delta_offset = 0; 1664d752fcc8SJoe Perches 1665d752fcc8SJoe Perches my $old_linenr = 0; 1666d752fcc8SJoe Perches my $new_linenr = 0; 1667d752fcc8SJoe Perches 1668d752fcc8SJoe Perches my $next_insert = 0; 1669d752fcc8SJoe Perches my $next_delete = 0; 1670d752fcc8SJoe Perches 1671d752fcc8SJoe Perches my @lines = (); 1672d752fcc8SJoe Perches 1673d752fcc8SJoe Perches my $inserted = @{$insertedRef}[$next_insert++]; 1674d752fcc8SJoe Perches my $deleted = @{$deletedRef}[$next_delete++]; 1675d752fcc8SJoe Perches 1676d752fcc8SJoe Perches foreach my $old_line (@{$linesRef}) { 1677d752fcc8SJoe Perches my $save_line = 1; 1678d752fcc8SJoe Perches my $line = $old_line; #don't modify the array 1679d752fcc8SJoe Perches if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename 1680d752fcc8SJoe Perches $delta_offset = 0; 1681d752fcc8SJoe Perches } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 1682d752fcc8SJoe Perches $range_last_linenr = $new_linenr; 1683d752fcc8SJoe Perches fixup_current_range(\$line, $delta_offset, 0); 1684d752fcc8SJoe Perches } 1685d752fcc8SJoe Perches 1686d752fcc8SJoe Perches while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 1687d752fcc8SJoe Perches $deleted = @{$deletedRef}[$next_delete++]; 1688d752fcc8SJoe Perches $save_line = 0; 1689d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 1690d752fcc8SJoe Perches } 1691d752fcc8SJoe Perches 1692d752fcc8SJoe Perches while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 1693d752fcc8SJoe Perches push(@lines, ${$inserted}{'LINE'}); 1694d752fcc8SJoe Perches $inserted = @{$insertedRef}[$next_insert++]; 1695d752fcc8SJoe Perches $new_linenr++; 1696d752fcc8SJoe Perches fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 1697d752fcc8SJoe Perches } 1698d752fcc8SJoe Perches 1699d752fcc8SJoe Perches if ($save_line) { 1700d752fcc8SJoe Perches push(@lines, $line); 1701d752fcc8SJoe Perches $new_linenr++; 1702d752fcc8SJoe Perches } 1703d752fcc8SJoe Perches 1704d752fcc8SJoe Perches $old_linenr++; 1705d752fcc8SJoe Perches } 1706d752fcc8SJoe Perches 1707d752fcc8SJoe Perches return @lines; 1708d752fcc8SJoe Perches} 1709d752fcc8SJoe Perches 1710f2d7e4d4SJoe Perchessub fix_insert_line { 1711f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1712f2d7e4d4SJoe Perches 1713f2d7e4d4SJoe Perches my $inserted = { 1714f2d7e4d4SJoe Perches LINENR => $linenr, 1715f2d7e4d4SJoe Perches LINE => $line, 1716f2d7e4d4SJoe Perches }; 1717f2d7e4d4SJoe Perches push(@fixed_inserted, $inserted); 1718f2d7e4d4SJoe Perches} 1719f2d7e4d4SJoe Perches 1720f2d7e4d4SJoe Perchessub fix_delete_line { 1721f2d7e4d4SJoe Perches my ($linenr, $line) = @_; 1722f2d7e4d4SJoe Perches 1723f2d7e4d4SJoe Perches my $deleted = { 1724f2d7e4d4SJoe Perches LINENR => $linenr, 1725f2d7e4d4SJoe Perches LINE => $line, 1726f2d7e4d4SJoe Perches }; 1727f2d7e4d4SJoe Perches 1728f2d7e4d4SJoe Perches push(@fixed_deleted, $deleted); 1729f2d7e4d4SJoe Perches} 1730f2d7e4d4SJoe Perches 1731de7d4f0eSAndy Whitcroftsub ERROR { 1732cbec18afSJoe Perches my ($type, $msg) = @_; 1733cbec18afSJoe Perches 1734cbec18afSJoe Perches if (report("ERROR", $type, $msg)) { 1735de7d4f0eSAndy Whitcroft our $clean = 0; 17366c72ffaaSAndy Whitcroft our $cnt_error++; 17373705ce5bSJoe Perches return 1; 1738de7d4f0eSAndy Whitcroft } 17393705ce5bSJoe Perches return 0; 1740773647a0SAndy Whitcroft} 1741de7d4f0eSAndy Whitcroftsub WARN { 1742cbec18afSJoe Perches my ($type, $msg) = @_; 1743cbec18afSJoe Perches 1744cbec18afSJoe Perches if (report("WARNING", $type, $msg)) { 1745de7d4f0eSAndy Whitcroft our $clean = 0; 17466c72ffaaSAndy Whitcroft our $cnt_warn++; 17473705ce5bSJoe Perches return 1; 1748de7d4f0eSAndy Whitcroft } 17493705ce5bSJoe Perches return 0; 1750773647a0SAndy Whitcroft} 1751de7d4f0eSAndy Whitcroftsub CHK { 1752cbec18afSJoe Perches my ($type, $msg) = @_; 1753cbec18afSJoe Perches 1754cbec18afSJoe Perches if ($check && report("CHECK", $type, $msg)) { 1755de7d4f0eSAndy Whitcroft our $clean = 0; 17566c72ffaaSAndy Whitcroft our $cnt_chk++; 17573705ce5bSJoe Perches return 1; 17586c72ffaaSAndy Whitcroft } 17593705ce5bSJoe Perches return 0; 1760de7d4f0eSAndy Whitcroft} 1761de7d4f0eSAndy Whitcroft 17626ecd9674SAndy Whitcroftsub check_absolute_file { 17636ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 17646ecd9674SAndy Whitcroft my $file = $absolute; 17656ecd9674SAndy Whitcroft 17666ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 17676ecd9674SAndy Whitcroft 17686ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 17696ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 17706ecd9674SAndy Whitcroft if (-f "$root/$file") { 17716ecd9674SAndy Whitcroft ##print "file<$file>\n"; 17726ecd9674SAndy Whitcroft last; 17736ecd9674SAndy Whitcroft } 17746ecd9674SAndy Whitcroft } 17756ecd9674SAndy Whitcroft if (! -f _) { 17766ecd9674SAndy Whitcroft return 0; 17776ecd9674SAndy Whitcroft } 17786ecd9674SAndy Whitcroft 17796ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 17806ecd9674SAndy Whitcroft my $prefix = $absolute; 17816ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 17826ecd9674SAndy Whitcroft 17836ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 17846ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1785000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1786000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 17876ecd9674SAndy Whitcroft } 17886ecd9674SAndy Whitcroft} 17896ecd9674SAndy Whitcroft 17903705ce5bSJoe Perchessub trim { 17913705ce5bSJoe Perches my ($string) = @_; 17923705ce5bSJoe Perches 1793b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1794b34c648bSJoe Perches 1795b34c648bSJoe Perches return $string; 1796b34c648bSJoe Perches} 1797b34c648bSJoe Perches 1798b34c648bSJoe Perchessub ltrim { 1799b34c648bSJoe Perches my ($string) = @_; 1800b34c648bSJoe Perches 1801b34c648bSJoe Perches $string =~ s/^\s+//; 1802b34c648bSJoe Perches 1803b34c648bSJoe Perches return $string; 1804b34c648bSJoe Perches} 1805b34c648bSJoe Perches 1806b34c648bSJoe Perchessub rtrim { 1807b34c648bSJoe Perches my ($string) = @_; 1808b34c648bSJoe Perches 1809b34c648bSJoe Perches $string =~ s/\s+$//; 18103705ce5bSJoe Perches 18113705ce5bSJoe Perches return $string; 18123705ce5bSJoe Perches} 18133705ce5bSJoe Perches 181452ea8506SJoe Perchessub string_find_replace { 181552ea8506SJoe Perches my ($string, $find, $replace) = @_; 181652ea8506SJoe Perches 181752ea8506SJoe Perches $string =~ s/$find/$replace/g; 181852ea8506SJoe Perches 181952ea8506SJoe Perches return $string; 182052ea8506SJoe Perches} 182152ea8506SJoe Perches 18223705ce5bSJoe Perchessub tabify { 18233705ce5bSJoe Perches my ($leading) = @_; 18243705ce5bSJoe Perches 18253705ce5bSJoe Perches my $source_indent = 8; 18263705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 18273705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 18283705ce5bSJoe Perches 18293705ce5bSJoe Perches #convert leading spaces to tabs 18303705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 18313705ce5bSJoe Perches #Remove spaces before a tab 18323705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 18333705ce5bSJoe Perches 18343705ce5bSJoe Perches return "$leading"; 18353705ce5bSJoe Perches} 18363705ce5bSJoe Perches 1837d1fe9c09SJoe Perchessub pos_last_openparen { 1838d1fe9c09SJoe Perches my ($line) = @_; 1839d1fe9c09SJoe Perches 1840d1fe9c09SJoe Perches my $pos = 0; 1841d1fe9c09SJoe Perches 1842d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1843d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1844d1fe9c09SJoe Perches 1845d1fe9c09SJoe Perches my $last_openparen = 0; 1846d1fe9c09SJoe Perches 1847d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1848d1fe9c09SJoe Perches return -1; 1849d1fe9c09SJoe Perches } 1850d1fe9c09SJoe Perches 1851d1fe9c09SJoe Perches my $len = length($line); 1852d1fe9c09SJoe Perches 1853d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1854d1fe9c09SJoe Perches my $string = substr($line, $pos); 1855d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1856d1fe9c09SJoe Perches $pos += length($1) - 1; 1857d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1858d1fe9c09SJoe Perches $last_openparen = $pos; 1859d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1860d1fe9c09SJoe Perches last; 1861d1fe9c09SJoe Perches } 1862d1fe9c09SJoe Perches } 1863d1fe9c09SJoe Perches 186491cb5195SJoe Perches return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 1865d1fe9c09SJoe Perches} 1866d1fe9c09SJoe Perches 18670a920b5bSAndy Whitcroftsub process { 18680a920b5bSAndy Whitcroft my $filename = shift; 18690a920b5bSAndy Whitcroft 18700a920b5bSAndy Whitcroft my $linenr=0; 18710a920b5bSAndy Whitcroft my $prevline=""; 1872c2fdda0dSAndy Whitcroft my $prevrawline=""; 18730a920b5bSAndy Whitcroft my $stashline=""; 1874c2fdda0dSAndy Whitcroft my $stashrawline=""; 18750a920b5bSAndy Whitcroft 18764a0df2efSAndy Whitcroft my $length; 18770a920b5bSAndy Whitcroft my $indent; 18780a920b5bSAndy Whitcroft my $previndent=0; 18790a920b5bSAndy Whitcroft my $stashindent=0; 18800a920b5bSAndy Whitcroft 1881de7d4f0eSAndy Whitcroft our $clean = 1; 18820a920b5bSAndy Whitcroft my $signoff = 0; 18830a920b5bSAndy Whitcroft my $is_patch = 0; 18840a920b5bSAndy Whitcroft 188529ee1b0cSJoe Perches my $in_header_lines = $file ? 0 : 1; 188615662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 188713f1937eSJoe Perches my $reported_maintainer_file = 0; 1888fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1889fa64205dSPasi Savanainen 1890365dd4eaSJoe Perches my $last_blank_line = 0; 18915e4f6ba5SJoe Perches my $last_coalesced_string_linenr = -1; 1892365dd4eaSJoe Perches 189313214adfSAndy Whitcroft our @report = (); 18946c72ffaaSAndy Whitcroft our $cnt_lines = 0; 18956c72ffaaSAndy Whitcroft our $cnt_error = 0; 18966c72ffaaSAndy Whitcroft our $cnt_warn = 0; 18976c72ffaaSAndy Whitcroft our $cnt_chk = 0; 18986c72ffaaSAndy Whitcroft 18990a920b5bSAndy Whitcroft # Trace the real file/line as we go. 19000a920b5bSAndy Whitcroft my $realfile = ''; 19010a920b5bSAndy Whitcroft my $realline = 0; 19020a920b5bSAndy Whitcroft my $realcnt = 0; 19030a920b5bSAndy Whitcroft my $here = ''; 19040a920b5bSAndy Whitcroft my $in_comment = 0; 1905c2fdda0dSAndy Whitcroft my $comment_edge = 0; 19060a920b5bSAndy Whitcroft my $first_line = 0; 19071e855726SWolfram Sang my $p1_prefix = ''; 19080a920b5bSAndy Whitcroft 190913214adfSAndy Whitcroft my $prev_values = 'E'; 191013214adfSAndy Whitcroft 191113214adfSAndy Whitcroft # suppression flags 1912773647a0SAndy Whitcroft my %suppress_ifbraces; 1913170d3a22SAndy Whitcroft my %suppress_whiletrailers; 19142b474a1aSAndy Whitcroft my %suppress_export; 19153e469cdcSAndy Whitcroft my $suppress_statement = 0; 1916653d4876SAndy Whitcroft 19177e51f197SJoe Perches my %signatures = (); 1918323c1260SJoe Perches 1919c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1920de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1921c2fdda0dSAndy Whitcroft # 1922de7d4f0eSAndy Whitcroft my @setup_docs = (); 1923de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1924773647a0SAndy Whitcroft 1925d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1926d8b07710SJoe Perches 1927773647a0SAndy Whitcroft sanitise_line_reset(); 1928c2fdda0dSAndy Whitcroft my $line; 1929c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1930773647a0SAndy Whitcroft $linenr++; 1931773647a0SAndy Whitcroft $line = $rawline; 1932c2fdda0dSAndy Whitcroft 19333705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 19343705ce5bSJoe Perches 1935773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1936de7d4f0eSAndy Whitcroft $setup_docs = 0; 1937de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1938de7d4f0eSAndy Whitcroft $setup_docs = 1; 1939de7d4f0eSAndy Whitcroft } 1940773647a0SAndy Whitcroft #next; 1941de7d4f0eSAndy Whitcroft } 1942773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1943773647a0SAndy Whitcroft $realline=$1-1; 1944773647a0SAndy Whitcroft if (defined $2) { 1945773647a0SAndy Whitcroft $realcnt=$3+1; 1946773647a0SAndy Whitcroft } else { 1947773647a0SAndy Whitcroft $realcnt=1+1; 1948773647a0SAndy Whitcroft } 1949c45dcabdSAndy Whitcroft $in_comment = 0; 1950773647a0SAndy Whitcroft 1951773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1952773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1953773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1954773647a0SAndy Whitcroft # at context start. 1955773647a0SAndy Whitcroft my $edge; 195601fa9147SAndy Whitcroft my $cnt = $realcnt; 195701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 195801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 195901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 196001fa9147SAndy Whitcroft $cnt--; 196101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1962721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1963fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1964fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1965fae17daeSAndy Whitcroft ($edge) = $1; 1966fae17daeSAndy Whitcroft last; 1967fae17daeSAndy Whitcroft } 1968773647a0SAndy Whitcroft } 1969773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1970773647a0SAndy Whitcroft $in_comment = 1; 1971773647a0SAndy Whitcroft } 1972773647a0SAndy Whitcroft 1973773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1974773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1975773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1976773647a0SAndy Whitcroft if (!defined $edge && 197783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1978773647a0SAndy Whitcroft { 1979773647a0SAndy Whitcroft $in_comment = 1; 1980773647a0SAndy Whitcroft } 1981773647a0SAndy Whitcroft 1982773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1983773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1984773647a0SAndy Whitcroft 1985171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1986773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1987171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1988773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1989773647a0SAndy Whitcroft } 1990773647a0SAndy Whitcroft push(@lines, $line); 1991773647a0SAndy Whitcroft 1992773647a0SAndy Whitcroft if ($realcnt > 1) { 1993773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1994773647a0SAndy Whitcroft } else { 1995773647a0SAndy Whitcroft $realcnt = 0; 1996773647a0SAndy Whitcroft } 1997773647a0SAndy Whitcroft 1998773647a0SAndy Whitcroft #print "==>$rawline\n"; 1999773647a0SAndy Whitcroft #print "-->$line\n"; 2000de7d4f0eSAndy Whitcroft 2001de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 2002de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 2003de7d4f0eSAndy Whitcroft } 2004de7d4f0eSAndy Whitcroft } 2005de7d4f0eSAndy Whitcroft 20066c72ffaaSAndy Whitcroft $prefix = ''; 20076c72ffaaSAndy Whitcroft 2008773647a0SAndy Whitcroft $realcnt = 0; 2009773647a0SAndy Whitcroft $linenr = 0; 2010194f66fcSJoe Perches $fixlinenr = -1; 20110a920b5bSAndy Whitcroft foreach my $line (@lines) { 20120a920b5bSAndy Whitcroft $linenr++; 2013194f66fcSJoe Perches $fixlinenr++; 20141b5539b1SJoe Perches my $sline = $line; #copy of $line 20151b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 20160a920b5bSAndy Whitcroft 2017c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 20186c72ffaaSAndy Whitcroft 20190a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 20206c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 20210a920b5bSAndy Whitcroft $is_patch = 1; 20224a0df2efSAndy Whitcroft $first_line = $linenr + 1; 20230a920b5bSAndy Whitcroft $realline=$1-1; 20240a920b5bSAndy Whitcroft if (defined $2) { 20250a920b5bSAndy Whitcroft $realcnt=$3+1; 20260a920b5bSAndy Whitcroft } else { 20270a920b5bSAndy Whitcroft $realcnt=1+1; 20280a920b5bSAndy Whitcroft } 2029c2fdda0dSAndy Whitcroft annotate_reset(); 203013214adfSAndy Whitcroft $prev_values = 'E'; 203113214adfSAndy Whitcroft 2032773647a0SAndy Whitcroft %suppress_ifbraces = (); 2033170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 20342b474a1aSAndy Whitcroft %suppress_export = (); 20353e469cdcSAndy Whitcroft $suppress_statement = 0; 20360a920b5bSAndy Whitcroft next; 20370a920b5bSAndy Whitcroft 20384a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 20394a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 20404a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 2041773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 20420a920b5bSAndy Whitcroft $realline++; 2043d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 20440a920b5bSAndy Whitcroft 20454a0df2efSAndy Whitcroft # Measure the line length and indent. 2046c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 20470a920b5bSAndy Whitcroft 20480a920b5bSAndy Whitcroft # Track the previous line. 20490a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 20500a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 2051c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2052c2fdda0dSAndy Whitcroft 2053773647a0SAndy Whitcroft #warn "line<$line>\n"; 20546c72ffaaSAndy Whitcroft 2055d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 2056d8aaf121SAndy Whitcroft $realcnt--; 20570a920b5bSAndy Whitcroft } 20580a920b5bSAndy Whitcroft 2059cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 2060cc77cdcaSAndy Whitcroft 20610a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 2062773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 2063773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 2064773647a0SAndy Whitcroft 20656c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 20666c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 2067773647a0SAndy Whitcroft 20682ac73b4fSJoe Perches my $found_file = 0; 2069773647a0SAndy Whitcroft # extract the filename as it passes 20703bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 20713bf9a009SRabin Vincent $realfile = $1; 20722b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2073270c49a0SJoe Perches $in_commit_log = 0; 20742ac73b4fSJoe Perches $found_file = 1; 20753bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2076773647a0SAndy Whitcroft $realfile = $1; 20772b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 2078270c49a0SJoe Perches $in_commit_log = 0; 20791e855726SWolfram Sang 20801e855726SWolfram Sang $p1_prefix = $1; 2081e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 2082e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 2083000d1cc1SJoe Perches WARN("PATCH_PREFIX", 2084000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 20851e855726SWolfram Sang } 2086773647a0SAndy Whitcroft 2087c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 2088000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 2089000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2090773647a0SAndy Whitcroft } 20912ac73b4fSJoe Perches $found_file = 1; 20922ac73b4fSJoe Perches } 20932ac73b4fSJoe Perches 20942ac73b4fSJoe Perches if ($found_file) { 20952ac73b4fSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@) { 20962ac73b4fSJoe Perches $check = 1; 20972ac73b4fSJoe Perches } else { 20982ac73b4fSJoe Perches $check = $check_orig; 20992ac73b4fSJoe Perches } 2100773647a0SAndy Whitcroft next; 2101773647a0SAndy Whitcroft } 2102773647a0SAndy Whitcroft 2103389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 21040a920b5bSAndy Whitcroft 2105c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 2106c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 2107c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 21080a920b5bSAndy Whitcroft 21096c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 21106c72ffaaSAndy Whitcroft 21113bf9a009SRabin Vincent# Check for incorrect file permissions 21123bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 21133bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 211404db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 211504db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 2116000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 2117000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 21183bf9a009SRabin Vincent } 21193bf9a009SRabin Vincent } 21203bf9a009SRabin Vincent 212120112475SJoe Perches# Check the patch for a signoff: 2122d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 21234a0df2efSAndy Whitcroft $signoff++; 212415662b3eSJoe Perches $in_commit_log = 0; 21250a920b5bSAndy Whitcroft } 212620112475SJoe Perches 2127e0d975b1SJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 2128e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2129e0d975b1SJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2130e0d975b1SJoe Perches $reported_maintainer_file = 1; 2131e0d975b1SJoe Perches } 2132e0d975b1SJoe Perches 213320112475SJoe Perches# Check signature styles 2134270c49a0SJoe Perches if (!$in_header_lines && 2135ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 213620112475SJoe Perches my $space_before = $1; 213720112475SJoe Perches my $sign_off = $2; 213820112475SJoe Perches my $space_after = $3; 213920112475SJoe Perches my $email = $4; 214020112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 214120112475SJoe Perches 2142ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 2143ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 2144ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 2145ce0338dfSJoe Perches } 214620112475SJoe Perches if (defined $space_before && $space_before ne "") { 21473705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21483705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 21493705ce5bSJoe Perches $fix) { 2150194f66fcSJoe Perches $fixed[$fixlinenr] = 21513705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21523705ce5bSJoe Perches } 215320112475SJoe Perches } 215420112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 21553705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21563705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 21573705ce5bSJoe Perches $fix) { 2158194f66fcSJoe Perches $fixed[$fixlinenr] = 21593705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21603705ce5bSJoe Perches } 21613705ce5bSJoe Perches 216220112475SJoe Perches } 216320112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 21643705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 21653705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 21663705ce5bSJoe Perches $fix) { 2167194f66fcSJoe Perches $fixed[$fixlinenr] = 21683705ce5bSJoe Perches "$ucfirst_sign_off $email"; 21693705ce5bSJoe Perches } 217020112475SJoe Perches } 217120112475SJoe Perches 217220112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 217320112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 217420112475SJoe Perches if ($suggested_email eq "") { 2175000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 2176000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 217720112475SJoe Perches } else { 217820112475SJoe Perches my $dequoted = $suggested_email; 217920112475SJoe Perches $dequoted =~ s/^"//; 218020112475SJoe Perches $dequoted =~ s/" </ </; 218120112475SJoe Perches # Don't force email to have quotes 218220112475SJoe Perches # Allow just an angle bracketed address 218320112475SJoe Perches if ("$dequoted$comment" ne $email && 218420112475SJoe Perches "<$email_address>$comment" ne $email && 218520112475SJoe Perches "$suggested_email$comment" ne $email) { 2186000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 2187000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 218820112475SJoe Perches } 21890a920b5bSAndy Whitcroft } 21907e51f197SJoe Perches 21917e51f197SJoe Perches# Check for duplicate signatures 21927e51f197SJoe Perches my $sig_nospace = $line; 21937e51f197SJoe Perches $sig_nospace =~ s/\s//g; 21947e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 21957e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 21967e51f197SJoe Perches WARN("BAD_SIGN_OFF", 21977e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 21987e51f197SJoe Perches } else { 21997e51f197SJoe Perches $signatures{$sig_nospace} = 1; 22007e51f197SJoe Perches } 22010a920b5bSAndy Whitcroft } 22020a920b5bSAndy Whitcroft 2203a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned 2204a2fe16b9SJoe Perches if ($in_header_lines && 2205a2fe16b9SJoe Perches $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 2206a2fe16b9SJoe Perches WARN("EMAIL_SUBJECT", 2207a2fe16b9SJoe Perches "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 2208a2fe16b9SJoe Perches } 2209a2fe16b9SJoe Perches 22109b3189ebSJoe Perches# Check for old stable address 22119b3189ebSJoe Perches if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) { 22129b3189ebSJoe Perches ERROR("STABLE_ADDRESS", 22139b3189ebSJoe Perches "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr); 22149b3189ebSJoe Perches } 22159b3189ebSJoe Perches 22167ebd05efSChristopher Covington# Check for unwanted Gerrit info 22177ebd05efSChristopher Covington if ($in_commit_log && $line =~ /^\s*change-id:/i) { 22187ebd05efSChristopher Covington ERROR("GERRIT_CHANGE_ID", 22197ebd05efSChristopher Covington "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr); 22207ebd05efSChristopher Covington } 22217ebd05efSChristopher Covington 22220d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions 22230d7835fcSJoe Perches if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) { 2224d311cd44SJoe Perches my $init_char = $1; 2225d311cd44SJoe Perches my $orig_commit = lc($2); 22260d7835fcSJoe Perches my $short = 1; 22270d7835fcSJoe Perches my $long = 0; 22280d7835fcSJoe Perches my $case = 1; 22290d7835fcSJoe Perches my $space = 1; 22300d7835fcSJoe Perches my $hasdesc = 0; 223119c146a6SJoe Perches my $hasparens = 0; 22320d7835fcSJoe Perches my $id = '0123456789ab'; 22330d7835fcSJoe Perches my $orig_desc = "commit description"; 22340d7835fcSJoe Perches my $description = ""; 22350d7835fcSJoe Perches 22360d7835fcSJoe Perches $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 22370d7835fcSJoe Perches $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 22380d7835fcSJoe Perches $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 22390d7835fcSJoe Perches $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 22400d7835fcSJoe Perches if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 22410d7835fcSJoe Perches $orig_desc = $1; 224219c146a6SJoe Perches $hasparens = 1; 22430d7835fcSJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 22440d7835fcSJoe Perches defined $rawlines[$linenr] && 22450d7835fcSJoe Perches $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 22460d7835fcSJoe Perches $orig_desc = $1; 224719c146a6SJoe Perches $hasparens = 1; 2248b671fde0SJoe Perches } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 2249b671fde0SJoe Perches defined $rawlines[$linenr] && 2250b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 2251b671fde0SJoe Perches $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 2252b671fde0SJoe Perches $orig_desc = $1; 2253b671fde0SJoe Perches $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 2254b671fde0SJoe Perches $orig_desc .= " " . $1; 225519c146a6SJoe Perches $hasparens = 1; 22560d7835fcSJoe Perches } 22570d7835fcSJoe Perches 22580d7835fcSJoe Perches ($id, $description) = git_commit_info($orig_commit, 22590d7835fcSJoe Perches $id, $orig_desc); 22600d7835fcSJoe Perches 226119c146a6SJoe Perches if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) { 2262d311cd44SJoe Perches ERROR("GIT_COMMIT_ID", 22630d7835fcSJoe Perches "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 22640d7835fcSJoe Perches } 2265d311cd44SJoe Perches } 2266d311cd44SJoe Perches 226713f1937eSJoe Perches# Check for added, moved or deleted files 226813f1937eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 226913f1937eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 227013f1937eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 227113f1937eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 227213f1937eSJoe Perches (defined($1) || defined($2))))) { 227313f1937eSJoe Perches $reported_maintainer_file = 1; 227413f1937eSJoe Perches WARN("FILE_PATH_CHANGES", 227513f1937eSJoe Perches "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 227613f1937eSJoe Perches } 227713f1937eSJoe Perches 227800df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 22798905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 2280000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 2281000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 22826c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 2283de7d4f0eSAndy Whitcroft } 2284de7d4f0eSAndy Whitcroft 22856ecd9674SAndy Whitcroft# Check for absolute kernel paths. 22866ecd9674SAndy Whitcroft if ($tree) { 22876ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 22886ecd9674SAndy Whitcroft my $file = $1; 22896ecd9674SAndy Whitcroft 22906ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 22916ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 22926ecd9674SAndy Whitcroft # 22936ecd9674SAndy Whitcroft } else { 22946ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 22956ecd9674SAndy Whitcroft } 22966ecd9674SAndy Whitcroft } 22976ecd9674SAndy Whitcroft } 22986ecd9674SAndy Whitcroft 2299de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 2300de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 2301171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 2302171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 2303171ae1a4SAndy Whitcroft 2304171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 2305171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 2306171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 2307171ae1a4SAndy Whitcroft 230834d99219SJoe Perches CHK("INVALID_UTF8", 2309000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 231000df344fSAndy Whitcroft } 23110a920b5bSAndy Whitcroft 231215662b3eSJoe Perches# Check if it's the start of a commit log 231315662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 231415662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 231529ee1b0cSJoe Perches !($rawline =~ /^\s+\S/ || 231629ee1b0cSJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 231715662b3eSJoe Perches $in_header_lines = 0; 231815662b3eSJoe Perches $in_commit_log = 1; 231915662b3eSJoe Perches } 232015662b3eSJoe Perches 2321fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 2322fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 2323fa64205dSPasi Savanainen if ($in_header_lines && 2324fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 2325fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 2326fa64205dSPasi Savanainen $non_utf8_charset = 1; 2327fa64205dSPasi Savanainen } 2328fa64205dSPasi Savanainen 2329fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 233015662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 2331fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 233215662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 233315662b3eSJoe Perches } 233415662b3eSJoe Perches 233566b47b4aSKees Cook# Check for various typo / spelling mistakes 233666d7a382SJoe Perches if (defined($misspellings) && 233766d7a382SJoe Perches ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 2338*ebfd7d62SJoe Perches while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) { 233966b47b4aSKees Cook my $typo = $1; 234066b47b4aSKees Cook my $typo_fix = $spelling_fix{lc($typo)}; 234166b47b4aSKees Cook $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 234266b47b4aSKees Cook $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 234366b47b4aSKees Cook my $msg_type = \&WARN; 234466b47b4aSKees Cook $msg_type = \&CHK if ($file); 234566b47b4aSKees Cook if (&{$msg_type}("TYPO_SPELLING", 234666b47b4aSKees Cook "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) && 234766b47b4aSKees Cook $fix) { 234866b47b4aSKees Cook $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 234966b47b4aSKees Cook } 235066b47b4aSKees Cook } 235166b47b4aSKees Cook } 235266b47b4aSKees Cook 235330670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 235430670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 235500df344fSAndy Whitcroft 23560a920b5bSAndy Whitcroft#trailing whitespace 23579c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 2358c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2359d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 2360d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 2361d5e616fcSJoe Perches $fix) { 2362194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/[\s\015]+$//; 2363d5e616fcSJoe Perches } 2364c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 2365c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23663705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 23673705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 23683705ce5bSJoe Perches $fix) { 2369194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 23703705ce5bSJoe Perches } 23713705ce5bSJoe Perches 2372d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 23730a920b5bSAndy Whitcroft } 23745368df20SAndy Whitcroft 23754783f894SJosh Triplett# Check for FSF mailing addresses. 2376109d8cb2SAlexander Duyck if ($rawline =~ /\bwrite to the Free/i || 23773e2232f2SJoe Perches $rawline =~ /\b59\s+Temple\s+Pl/i || 23783e2232f2SJoe Perches $rawline =~ /\b51\s+Franklin\s+St/i) { 23794783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 23804783f894SJosh Triplett my $msg_type = \&ERROR; 23814783f894SJosh Triplett $msg_type = \&CHK if ($file); 23824783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 23834783f894SJosh 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) 23844783f894SJosh Triplett } 23854783f894SJosh Triplett 23863354957aSAndi Kleen# check for Kconfig help text having a real description 23879fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 23889fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 23893354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 23908d73e0e7SJoe Perches $line =~ /^\+\s*config\s+/) { 23913354957aSAndi Kleen my $length = 0; 23929fe287d7SAndy Whitcroft my $cnt = $realcnt; 23939fe287d7SAndy Whitcroft my $ln = $linenr + 1; 23949fe287d7SAndy Whitcroft my $f; 2395a1385803SAndy Whitcroft my $is_start = 0; 23969fe287d7SAndy Whitcroft my $is_end = 0; 2397a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 23989fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 23999fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 24009fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 24019fe287d7SAndy Whitcroft 24029fe287d7SAndy Whitcroft next if ($f =~ /^-/); 24038d73e0e7SJoe Perches last if (!$file && $f =~ /^\@\@/); 2404a1385803SAndy Whitcroft 24058d73e0e7SJoe Perches if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) { 2406a1385803SAndy Whitcroft $is_start = 1; 24078d73e0e7SJoe Perches } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 2408a1385803SAndy Whitcroft $length = -1; 2409a1385803SAndy Whitcroft } 2410a1385803SAndy Whitcroft 24119fe287d7SAndy Whitcroft $f =~ s/^.//; 24123354957aSAndi Kleen $f =~ s/#.*//; 24133354957aSAndi Kleen $f =~ s/^\s+//; 24143354957aSAndi Kleen next if ($f =~ /^$/); 24159fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 24169fe287d7SAndy Whitcroft $is_end = 1; 24179fe287d7SAndy Whitcroft last; 24189fe287d7SAndy Whitcroft } 24193354957aSAndi Kleen $length++; 24203354957aSAndi Kleen } 242156193274SVadim Bendebury if ($is_start && $is_end && $length < $min_conf_desc_length) { 2422000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 242356193274SVadim Bendebury "please write a paragraph that describes the config symbol fully\n" . $herecurr); 242456193274SVadim Bendebury } 2425a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 24263354957aSAndi Kleen } 24273354957aSAndi Kleen 24281ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 24291ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 24301ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 24311ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 24321ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 24331ba8dfd1SKees Cook } 24341ba8dfd1SKees Cook 2435327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options 2436327953e9SChristoph Jaeger if ($realfile =~ /Kconfig/ && 2437327953e9SChristoph Jaeger $line =~ /^\+\s*\bboolean\b/) { 2438327953e9SChristoph Jaeger WARN("CONFIG_TYPE_BOOLEAN", 2439327953e9SChristoph Jaeger "Use of boolean is deprecated, please use bool instead.\n" . $herecurr); 2440327953e9SChristoph Jaeger } 2441327953e9SChristoph Jaeger 2442c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2443c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2444c68e5878SArnaud Lacombe my $flag = $1; 2445c68e5878SArnaud Lacombe my $replacement = { 2446c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2447c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2448c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2449c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2450c68e5878SArnaud Lacombe }; 2451c68e5878SArnaud Lacombe 2452c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2453c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2454c68e5878SArnaud Lacombe } 2455c68e5878SArnaud Lacombe 2456bff5da43SRob Herring# check for DT compatible documentation 24577dd05b38SFlorian Vaussard if (defined $root && 24587dd05b38SFlorian Vaussard (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 24597dd05b38SFlorian Vaussard ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 24607dd05b38SFlorian Vaussard 2461bff5da43SRob Herring my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 2462bff5da43SRob Herring 2463cc93319bSFlorian Vaussard my $dt_path = $root . "/Documentation/devicetree/bindings/"; 2464cc93319bSFlorian Vaussard my $vp_file = $dt_path . "vendor-prefixes.txt"; 2465cc93319bSFlorian Vaussard 2466bff5da43SRob Herring foreach my $compat (@compats) { 2467bff5da43SRob Herring my $compat2 = $compat; 2468185d566bSRob Herring $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 2469185d566bSRob Herring my $compat3 = $compat; 2470185d566bSRob Herring $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 2471185d566bSRob Herring `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 2472bff5da43SRob Herring if ( $? >> 8 ) { 2473bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2474bff5da43SRob Herring "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 2475bff5da43SRob Herring } 2476bff5da43SRob Herring 24774fbf32a6SFlorian Vaussard next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 24784fbf32a6SFlorian Vaussard my $vendor = $1; 2479cc93319bSFlorian Vaussard `grep -Eq "^$vendor\\b" $vp_file`; 2480bff5da43SRob Herring if ( $? >> 8 ) { 2481bff5da43SRob Herring WARN("UNDOCUMENTED_DT_STRING", 2482cc93319bSFlorian Vaussard "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 2483bff5da43SRob Herring } 2484bff5da43SRob Herring } 2485bff5da43SRob Herring } 2486bff5da43SRob Herring 24875368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 2488de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); 24895368df20SAndy Whitcroft 24906cd7f386SJoe Perches#line length limit 2491c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2492f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 24930fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 24948bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 24956cd7f386SJoe Perches $length > $max_line_length) 2496c45dcabdSAndy Whitcroft { 2497000d1cc1SJoe Perches WARN("LONG_LINE", 24986cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 24990a920b5bSAndy Whitcroft } 25000a920b5bSAndy Whitcroft 25018905a67cSAndy Whitcroft# check for adding lines without a newline. 25028905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2503000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2504000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 25058905a67cSAndy Whitcroft } 25068905a67cSAndy Whitcroft 250742e41c54SMike Frysinger# Blackfin: use hi/lo macros 250842e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 250942e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 251042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2511000d1cc1SJoe Perches ERROR("LO_MACRO", 2512000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 251342e41c54SMike Frysinger } 251442e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 251542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2516000d1cc1SJoe Perches ERROR("HI_MACRO", 2517000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 251842e41c54SMike Frysinger } 251942e41c54SMike Frysinger } 252042e41c54SMike Frysinger 2521b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2522de4c924cSGeert Uytterhoeven next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 25230a920b5bSAndy Whitcroft 25240a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 25250a920b5bSAndy Whitcroft# more than 8 must use tabs. 2526c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2527c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2528c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2529d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 25303705ce5bSJoe Perches if (ERROR("CODE_INDENT", 25313705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 25323705ce5bSJoe Perches $fix) { 2533194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 25343705ce5bSJoe Perches } 25350a920b5bSAndy Whitcroft } 25360a920b5bSAndy Whitcroft 253708e44365SAlberto Panizzo# check for space before tabs. 253808e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 253908e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 25403705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 25413705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 25423705ce5bSJoe Perches $fix) { 2543194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2544d2207ccbSJoe Perches s/(^\+.*) {8,8}\t/$1\t\t/) {} 2545194f66fcSJoe Perches while ($fixed[$fixlinenr] =~ 2546c76f4cb3SJoe Perches s/(^\+.*) +\t/$1\t/) {} 25473705ce5bSJoe Perches } 254808e44365SAlberto Panizzo } 254908e44365SAlberto Panizzo 2550d1fe9c09SJoe Perches# check for && or || at the start of a line 2551d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2552d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2553d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2554d1fe9c09SJoe Perches } 2555d1fe9c09SJoe Perches 2556d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2557d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 255891cb5195SJoe Perches $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 2559d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2560d1fe9c09SJoe Perches my $oldindent = $1; 2561d1fe9c09SJoe Perches my $rest = $2; 2562d1fe9c09SJoe Perches 2563d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2564d1fe9c09SJoe Perches if ($pos >= 0) { 2565b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2566b34a26f3SJoe Perches my $newindent = $2; 2567d1fe9c09SJoe Perches 2568d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2569d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2570d1fe9c09SJoe Perches " " x ($pos % 8); 2571d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2572d1fe9c09SJoe Perches 2573d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2574d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 25753705ce5bSJoe Perches 25763705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 25773705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 25783705ce5bSJoe Perches $fix && $line =~ /^\+/) { 2579194f66fcSJoe Perches $fixed[$fixlinenr] =~ 25803705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 25813705ce5bSJoe Perches } 2582d1fe9c09SJoe Perches } 2583d1fe9c09SJoe Perches } 2584d1fe9c09SJoe Perches } 2585d1fe9c09SJoe Perches 25866ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar" 25876ab3a970SJoe Perches# avoid checking a few false positives: 25886ab3a970SJoe Perches# "sizeof(<type>)" or "__alignof__(<type>)" 25896ab3a970SJoe Perches# function pointer declarations like "(*foo)(int) = bar;" 25906ab3a970SJoe Perches# structure definitions like "(struct foo) { 0 };" 25916ab3a970SJoe Perches# multiline macros that define functions 25926ab3a970SJoe Perches# known attributes or the __attribute__ keyword 25936ab3a970SJoe Perches if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 25946ab3a970SJoe Perches (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 25953705ce5bSJoe Perches if (CHK("SPACING", 2596f27c95dbSJoe Perches "No space is necessary after a cast\n" . $herecurr) && 25973705ce5bSJoe Perches $fix) { 2598194f66fcSJoe Perches $fixed[$fixlinenr] =~ 2599f27c95dbSJoe Perches s/(\(\s*$Type\s*\))[ \t]+/$1/; 26003705ce5bSJoe Perches } 2601aad4f614SJoe Perches } 2602aad4f614SJoe Perches 260305880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2604fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 260585ad978cSJoe Perches $rawline =~ /^\+[ \t]*\*/ && 260685ad978cSJoe Perches $realline > 2) { 260705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 260805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 260905880600SJoe Perches } 261005880600SJoe Perches 261105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2612a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2613a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 261461135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2615a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2616a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2617a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2618a605e32eSJoe Perches } 2619a605e32eSJoe Perches 2620a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2621c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2622c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2623c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2624c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 262505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 262605880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 262705880600SJoe Perches } 262805880600SJoe Perches 26297f619191SJoe Perches# check for missing blank lines after struct/union declarations 26307f619191SJoe Perches# with exceptions for various attributes and macros 26317f619191SJoe Perches if ($prevline =~ /^[\+ ]};?\s*$/ && 26327f619191SJoe Perches $line =~ /^\+/ && 26337f619191SJoe Perches !($line =~ /^\+\s*$/ || 26347f619191SJoe Perches $line =~ /^\+\s*EXPORT_SYMBOL/ || 26357f619191SJoe Perches $line =~ /^\+\s*MODULE_/i || 26367f619191SJoe Perches $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 26377f619191SJoe Perches $line =~ /^\+[a-z_]*init/ || 26387f619191SJoe Perches $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 26397f619191SJoe Perches $line =~ /^\+\s*DECLARE/ || 26407f619191SJoe Perches $line =~ /^\+\s*__setup/)) { 2641d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2642d752fcc8SJoe Perches "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 2643d752fcc8SJoe Perches $fix) { 2644f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2645d752fcc8SJoe Perches } 26467f619191SJoe Perches } 26477f619191SJoe Perches 2648365dd4eaSJoe Perches# check for multiple consecutive blank lines 2649365dd4eaSJoe Perches if ($prevline =~ /^[\+ ]\s*$/ && 2650365dd4eaSJoe Perches $line =~ /^\+\s*$/ && 2651365dd4eaSJoe Perches $last_blank_line != ($linenr - 1)) { 2652d752fcc8SJoe Perches if (CHK("LINE_SPACING", 2653d752fcc8SJoe Perches "Please don't use multiple blank lines\n" . $hereprev) && 2654d752fcc8SJoe Perches $fix) { 2655f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 2656d752fcc8SJoe Perches } 2657d752fcc8SJoe Perches 2658365dd4eaSJoe Perches $last_blank_line = $linenr; 2659365dd4eaSJoe Perches } 2660365dd4eaSJoe Perches 26613b617e3bSJoe Perches# check for missing blank lines after declarations 26623f7bac03SJoe Perches if ($sline =~ /^\+\s+\S/ && #Not at char 1 26633f7bac03SJoe Perches # actual declarations 26643f7bac03SJoe Perches ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 26655a4e1fd3SJoe Perches # function pointer declarations 26665a4e1fd3SJoe Perches $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 26673f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 26683f7bac03SJoe Perches $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 26693f7bac03SJoe Perches # known declaration macros 26703f7bac03SJoe Perches $prevline =~ /^\+\s+$declaration_macros/) && 26713f7bac03SJoe Perches # for "else if" which can look like "$Ident $Ident" 26723f7bac03SJoe Perches !($prevline =~ /^\+\s+$c90_Keywords\b/ || 26733f7bac03SJoe Perches # other possible extensions of declaration lines 26743f7bac03SJoe Perches $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 26753f7bac03SJoe Perches # not starting a section or a macro "\" extended line 26763f7bac03SJoe Perches $prevline =~ /(?:\{\s*|\\)$/) && 26773f7bac03SJoe Perches # looks like a declaration 26783f7bac03SJoe Perches !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 26795a4e1fd3SJoe Perches # function pointer declarations 26805a4e1fd3SJoe Perches $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 26813f7bac03SJoe Perches # foo bar; where foo is some local typedef or #define 26823f7bac03SJoe Perches $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 26833f7bac03SJoe Perches # known declaration macros 26843f7bac03SJoe Perches $sline =~ /^\+\s+$declaration_macros/ || 26853f7bac03SJoe Perches # start of struct or union or enum 26863b617e3bSJoe Perches $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ || 26873f7bac03SJoe Perches # start or end of block or continuation of declaration 26883f7bac03SJoe Perches $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 26893f7bac03SJoe Perches # bitfield continuation 26903f7bac03SJoe Perches $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 26913f7bac03SJoe Perches # other possible extensions of declaration lines 26923f7bac03SJoe Perches $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) && 26933f7bac03SJoe Perches # indentation of previous and current line are the same 26943f7bac03SJoe Perches (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) { 2695d752fcc8SJoe Perches if (WARN("LINE_SPACING", 2696d752fcc8SJoe Perches "Missing a blank line after declarations\n" . $hereprev) && 2697d752fcc8SJoe Perches $fix) { 2698f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, "\+"); 2699d752fcc8SJoe Perches } 27003b617e3bSJoe Perches } 27013b617e3bSJoe Perches 27025f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 27036b4c5bebSAndy Whitcroft# Exceptions: 27046b4c5bebSAndy Whitcroft# 1) within comments 27056b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 27066b4c5bebSAndy Whitcroft# 3) hanging labels 27073705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 27085f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 27093705ce5bSJoe Perches if (WARN("LEADING_SPACE", 27103705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 27113705ce5bSJoe Perches $fix) { 2712194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 27133705ce5bSJoe Perches } 27145f7ddae6SRaffaele Recalcati } 27155f7ddae6SRaffaele Recalcati 2716b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2717b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2718b9ea10d6SAndy Whitcroft 2719032a4c0fSJoe Perches# check indentation of any line with a bare else 2720840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;") 2721032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more... 2722032a4c0fSJoe Perches if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 2723032a4c0fSJoe Perches my $tabs = length($1) + 1; 2724840080a0SJoe Perches if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 2725840080a0SJoe Perches ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 2726840080a0SJoe Perches defined $lines[$linenr] && 2727840080a0SJoe Perches $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 2728032a4c0fSJoe Perches WARN("UNNECESSARY_ELSE", 2729032a4c0fSJoe Perches "else is not generally useful after a break or return\n" . $hereprev); 2730032a4c0fSJoe Perches } 2731032a4c0fSJoe Perches } 2732032a4c0fSJoe Perches 2733c00df19aSJoe Perches# check indentation of a line with a break; 2734c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs 2735c00df19aSJoe Perches if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 2736c00df19aSJoe Perches my $tabs = $1; 2737c00df19aSJoe Perches if ($prevline =~ /^\+$tabs(?:goto|return)\b/) { 2738c00df19aSJoe Perches WARN("UNNECESSARY_BREAK", 2739c00df19aSJoe Perches "break is not useful after a goto or return\n" . $hereprev); 2740c00df19aSJoe Perches } 2741c00df19aSJoe Perches } 2742c00df19aSJoe Perches 27431ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 27441ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 27451ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 27461ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 27471ba8dfd1SKees Cook } 27481ba8dfd1SKees Cook 2749c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2750cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2751000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2752000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2753c2fdda0dSAndy Whitcroft } 275422f2a2efSAndy Whitcroft 275542e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 275642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 275742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2758000d1cc1SJoe Perches ERROR("CSYNC", 2759000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 276042e41c54SMike Frysinger } 276142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 276242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2763000d1cc1SJoe Perches ERROR("SSYNC", 2764000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 276542e41c54SMike Frysinger } 276642e41c54SMike Frysinger 276756e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 276856e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 276956e77d70SJoe Perches WARN("HOTPLUG_SECTION", 277056e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 277156e77d70SJoe Perches } 277256e77d70SJoe Perches 27739c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 27742b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 27752b474a1aSAndy Whitcroft $realline_next); 27763e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 27773e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 27781b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2779170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2780f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2781171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2782171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2783171ae1a4SAndy Whitcroft 27843e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 27853e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 27863e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 27873e469cdcSAndy Whitcroft # until we hit end of it. 27883e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 27893e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 27903e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 27913e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 27923e469cdcSAndy Whitcroft } 2793f74bd194SAndy Whitcroft 27942b474a1aSAndy Whitcroft # Find the real next line. 27952b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 27962b474a1aSAndy Whitcroft if (defined $realline_next && 27972b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 27982b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 27992b474a1aSAndy Whitcroft $realline_next++; 28002b474a1aSAndy Whitcroft } 28012b474a1aSAndy Whitcroft 2802171ae1a4SAndy Whitcroft my $s = $stat; 2803171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2804cf655043SAndy Whitcroft 2805c2fdda0dSAndy Whitcroft # Ignore goto labels. 2806171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2807c2fdda0dSAndy Whitcroft 2808c2fdda0dSAndy Whitcroft # Ignore functions being called 2809171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2810c2fdda0dSAndy Whitcroft 2811463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2812463f2864SAndy Whitcroft 2813c45dcabdSAndy Whitcroft # declarations always start with types 2814d2506586SAndy 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) { 2815c45dcabdSAndy Whitcroft my $type = $1; 2816c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2817c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2818c45dcabdSAndy Whitcroft 28196c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2820a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2821c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2822c2fdda0dSAndy Whitcroft } 28238905a67cSAndy Whitcroft 28246c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 282565863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2826c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 28279c0ca6f9SAndy Whitcroft } 28288905a67cSAndy Whitcroft 28298905a67cSAndy Whitcroft # Check for any sort of function declaration. 28308905a67cSAndy Whitcroft # int foo(something bar, other baz); 28318905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2832171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 28338905a67cSAndy Whitcroft my ($name_len) = length($1); 28348905a67cSAndy Whitcroft 2835cf655043SAndy Whitcroft my $ctx = $s; 2836773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 28378905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2838cf655043SAndy Whitcroft 28398905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2840c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 28418905a67cSAndy Whitcroft 2842c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 28438905a67cSAndy Whitcroft } 28448905a67cSAndy Whitcroft } 28458905a67cSAndy Whitcroft } 28468905a67cSAndy Whitcroft 28479c0ca6f9SAndy Whitcroft } 28489c0ca6f9SAndy Whitcroft 284900df344fSAndy Whitcroft# 285000df344fSAndy Whitcroft# Checks which may be anchored in the context. 285100df344fSAndy Whitcroft# 285200df344fSAndy Whitcroft 285300df344fSAndy Whitcroft# Check for switch () and associated case and default 285400df344fSAndy Whitcroft# statements should be at the same indent. 285500df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 285600df344fSAndy Whitcroft my $err = ''; 285700df344fSAndy Whitcroft my $sep = ''; 285800df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 285900df344fSAndy Whitcroft shift(@ctx); 286000df344fSAndy Whitcroft for my $ctx (@ctx) { 286100df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 286200df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 286300df344fSAndy Whitcroft $indent != $cindent) { 286400df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 286500df344fSAndy Whitcroft $sep = ''; 286600df344fSAndy Whitcroft } else { 286700df344fSAndy Whitcroft $sep = "[...]\n"; 286800df344fSAndy Whitcroft } 286900df344fSAndy Whitcroft } 287000df344fSAndy Whitcroft if ($err ne '') { 2871000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2872000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2873de7d4f0eSAndy Whitcroft } 2874de7d4f0eSAndy Whitcroft } 2875de7d4f0eSAndy Whitcroft 2876de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2877de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 28780fe3dc2bSJoe Perches if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2879773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2880773647a0SAndy Whitcroft 28819c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 28828eef05ddSJoe Perches 28838eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 28848eef05ddSJoe Perches WARN("DEEP_INDENTATION", 28858eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 28868eef05ddSJoe Perches } 28878eef05ddSJoe Perches 2888de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2889de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2890de7d4f0eSAndy Whitcroft 2891548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2892548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2893de7d4f0eSAndy Whitcroft 2894548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2895548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2896548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2897548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2898548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2899773647a0SAndy Whitcroft $ctx_ln++; 2900773647a0SAndy Whitcroft } 2901548596d5SAndy Whitcroft 290253210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 290353210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2904773647a0SAndy Whitcroft 2905773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2906000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2907000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 290801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 290900df344fSAndy Whitcroft } 2910773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2911773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2912773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2913773647a0SAndy Whitcroft { 29149c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 29159c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2916000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2917000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 291801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 29199c0ca6f9SAndy Whitcroft } 29209c0ca6f9SAndy Whitcroft } 292100df344fSAndy Whitcroft } 292200df344fSAndy Whitcroft 29234d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 29240fe3dc2bSJoe Perches if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 29253e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 29263e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 29273e469cdcSAndy Whitcroft if (!defined $stat); 29284d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 29294d001e4dSAndy Whitcroft 29304d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 29314d001e4dSAndy Whitcroft 29324d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 29334d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 29344d001e4dSAndy Whitcroft # where necessary. 29354d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 29364d001e4dSAndy Whitcroft 29374d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 29386f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 29396f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 29404d001e4dSAndy Whitcroft 29414d001e4dSAndy Whitcroft # We want to check the first line inside the block 29424d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 29434d001e4dSAndy Whitcroft # 1) any blank line termination 29444d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 29454d001e4dSAndy Whitcroft # 3) any do (...) { 29464d001e4dSAndy Whitcroft my $continuation = 0; 29474d001e4dSAndy Whitcroft my $check = 0; 29484d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 29494d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 29504d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 29514d001e4dSAndy Whitcroft $continuation = 1; 29524d001e4dSAndy Whitcroft } 29539bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 29544d001e4dSAndy Whitcroft $check = 1; 29554d001e4dSAndy Whitcroft $cond_lines++; 29564d001e4dSAndy Whitcroft } 29574d001e4dSAndy Whitcroft 29584d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 29594d001e4dSAndy Whitcroft # preprocessor statement. 29604d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 29614d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 29624d001e4dSAndy Whitcroft $check = 0; 29634d001e4dSAndy Whitcroft } 29644d001e4dSAndy Whitcroft 29659bd49efeSAndy Whitcroft my $cond_ptr = -1; 2966740504c6SAndy Whitcroft $continuation = 0; 29679bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 29689bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 29694d001e4dSAndy Whitcroft 2970f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2971f16fa28fSAndy Whitcroft # is not linear. 2972f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2973f16fa28fSAndy Whitcroft $check = 0; 2974f16fa28fSAndy Whitcroft } 2975f16fa28fSAndy Whitcroft 29769bd49efeSAndy Whitcroft # Ignore: 29779bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 29789bd49efeSAndy Whitcroft # 2) preprocessor lines, and 29799bd49efeSAndy Whitcroft # 3) labels. 2980740504c6SAndy Whitcroft if ($continuation || 2981740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 29829bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 29839bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2984740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 298530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 29869bd49efeSAndy Whitcroft $cond_lines++; 29879bd49efeSAndy Whitcroft } 29884d001e4dSAndy Whitcroft } 298930dad6ebSAndy Whitcroft } 29904d001e4dSAndy Whitcroft 29914d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 29924d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 29934d001e4dSAndy Whitcroft 29944d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 29954d001e4dSAndy Whitcroft # this is not this patch's fault. 29964d001e4dSAndy Whitcroft if (!defined($stat_real) || 29974d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 29984d001e4dSAndy Whitcroft $check = 0; 29994d001e4dSAndy Whitcroft } 30004d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 30014d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 30024d001e4dSAndy Whitcroft } 30034d001e4dSAndy Whitcroft 30049bd49efeSAndy 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"; 30054d001e4dSAndy Whitcroft 30064d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 30074d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 3008000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 3009000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 30104d001e4dSAndy Whitcroft } 30114d001e4dSAndy Whitcroft } 30124d001e4dSAndy Whitcroft 30136c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 30146c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 30151f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 30161f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 30176c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 3018c2fdda0dSAndy Whitcroft if ($dbg_values) { 3019c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 3020cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 3021cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 30221f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 3023c2fdda0dSAndy Whitcroft } 30246c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 30256c72ffaaSAndy Whitcroft 302600df344fSAndy Whitcroft#ignore lines not being added 30273705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 302800df344fSAndy Whitcroft 3029653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 30307429c690SAndy Whitcroft if ($dbg_type) { 30317429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 3032000d1cc1SJoe Perches ERROR("TEST_TYPE", 3033000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 30347429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 3035000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 3036000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 30377429c690SAndy Whitcroft } 3038653d4876SAndy Whitcroft next; 3039653d4876SAndy Whitcroft } 3040a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 3041a1ef277eSAndy Whitcroft if ($dbg_attr) { 30429360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 3043000d1cc1SJoe Perches ERROR("TEST_ATTR", 3044000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 30459360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 3046000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 3047000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 3048a1ef277eSAndy Whitcroft } 3049a1ef277eSAndy Whitcroft next; 3050a1ef277eSAndy Whitcroft } 3051653d4876SAndy Whitcroft 3052f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 305399423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 305499423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 3055d752fcc8SJoe Perches if (ERROR("OPEN_BRACE", 3056d752fcc8SJoe Perches "that open brace { should be on the previous line\n" . $hereprev) && 3057f2d7e4d4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 3058f2d7e4d4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 3059f2d7e4d4SJoe Perches fix_delete_line($fixlinenr, $rawline); 3060d752fcc8SJoe Perches my $fixedline = $prevrawline; 3061d752fcc8SJoe Perches $fixedline =~ s/\s*=\s*$/ = {/; 3062f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3063d752fcc8SJoe Perches $fixedline = $line; 3064d752fcc8SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1/; 3065f2d7e4d4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 3066d752fcc8SJoe Perches } 3067f0a594c1SAndy Whitcroft } 3068f0a594c1SAndy Whitcroft 306900df344fSAndy Whitcroft# 307000df344fSAndy Whitcroft# Checks which are anchored on the added line. 307100df344fSAndy Whitcroft# 307200df344fSAndy Whitcroft 3073653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 3074c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 3075653d4876SAndy Whitcroft my $path = $1; 3076653d4876SAndy Whitcroft if ($path =~ m{//}) { 3077000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 3078495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 3079495e9d84SJoe Perches } 3080495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 3081495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 3082495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 3083653d4876SAndy Whitcroft } 3084653d4876SAndy Whitcroft } 3085653d4876SAndy Whitcroft 308600df344fSAndy Whitcroft# no C99 // comments 308700df344fSAndy Whitcroft if ($line =~ m{//}) { 30883705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 30893705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 30903705ce5bSJoe Perches $fix) { 3091194f66fcSJoe Perches my $line = $fixed[$fixlinenr]; 30923705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 30933705ce5bSJoe Perches my $comment = trim($1); 3094194f66fcSJoe Perches $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 30953705ce5bSJoe Perches } 30963705ce5bSJoe Perches } 309700df344fSAndy Whitcroft } 309800df344fSAndy Whitcroft # Remove C99 comments. 30990a920b5bSAndy Whitcroft $line =~ s@//.*@@; 31006c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 31010a920b5bSAndy Whitcroft 31022b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 31032b474a1aSAndy Whitcroft# the whole statement. 31042b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 31052b474a1aSAndy Whitcroft if (defined $realline_next && 31062b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 31072b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 31082b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 31092b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 31103cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 31113cbf62dfSAndy Whitcroft # a prefix: 31123cbf62dfSAndy Whitcroft # XXX(foo); 31133cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 3114653d4876SAndy Whitcroft my $name = $1; 311587a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 31163cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 31173cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 31183cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 31193cbf62dfSAndy Whitcroft 31203cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 31212b474a1aSAndy Whitcroft \n.}\s*$| 312248012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 312348012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 312448012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 31252b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 31262b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 312748012058SAndy Whitcroft )/x) { 31282b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 31292b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 31302b474a1aSAndy Whitcroft } else { 31312b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 31320a920b5bSAndy Whitcroft } 31330a920b5bSAndy Whitcroft } 31342b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 31352b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 31362b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 31372b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 31382b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 31392b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 31402b474a1aSAndy Whitcroft } 31412b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 31422b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 3143000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 3144000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 31452b474a1aSAndy Whitcroft } 31460a920b5bSAndy Whitcroft 31475150bda4SJoe Eloff# check for global initialisers. 3148d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 3149d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 3150000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 3151d5e616fcSJoe Perches $herecurr) && 3152d5e616fcSJoe Perches $fix) { 3153194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 3154d5e616fcSJoe Perches } 3155f0a594c1SAndy Whitcroft } 31560a920b5bSAndy Whitcroft# check for static initialisers. 3157d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 3158d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 3159000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 3160d5e616fcSJoe Perches $herecurr) && 3161d5e616fcSJoe Perches $fix) { 3162194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 3163d5e616fcSJoe Perches } 31640a920b5bSAndy Whitcroft } 31650a920b5bSAndy Whitcroft 31661813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned 31671813087dSJoe Perches while ($sline =~ m{(\b$TypeMisordered\b)}g) { 31681813087dSJoe Perches my $tmp = trim($1); 31691813087dSJoe Perches WARN("MISORDERED_TYPE", 31701813087dSJoe Perches "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 31711813087dSJoe Perches } 31721813087dSJoe Perches 3173cb710ecaSJoe Perches# check for static const char * arrays. 3174cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 3175000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3176000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 3177cb710ecaSJoe Perches $herecurr); 3178cb710ecaSJoe Perches } 3179cb710ecaSJoe Perches 3180cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 3181cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 3182000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 3183000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 3184cb710ecaSJoe Perches $herecurr); 3185cb710ecaSJoe Perches } 3186cb710ecaSJoe Perches 31879b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations. 31889b0fa60dSJoe Perches if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 31899b0fa60dSJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 31909b0fa60dSJoe Perches "char * array declaration might be better as static const\n" . 31919b0fa60dSJoe Perches $herecurr); 31929b0fa60dSJoe Perches } 31939b0fa60dSJoe Perches 3194b36190c5SJoe Perches# check for function declarations without arguments like "int foo()" 3195b36190c5SJoe Perches if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) { 3196b36190c5SJoe Perches if (ERROR("FUNCTION_WITHOUT_ARGS", 3197b36190c5SJoe Perches "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 3198b36190c5SJoe Perches $fix) { 3199194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 3200b36190c5SJoe Perches } 3201b36190c5SJoe Perches } 3202b36190c5SJoe Perches 320392e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 320492e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 320592e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 320692e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 320792e112fdSJoe Perches $fix) { 3208194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 320992e112fdSJoe Perches } 321093ed0e2dSJoe Perches } 321193ed0e2dSJoe Perches 3212653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 3213653d4876SAndy Whitcroft# make sense. 3214653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 32158054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 3216c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 32178ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 3218021158b4SJoe Perches $line !~ /\b$typeOtherOSTypedefs\b/ && 3219653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 3220000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 3221000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 32220a920b5bSAndy Whitcroft } 32230a920b5bSAndy Whitcroft 32240a920b5bSAndy Whitcroft# * goes on variable not on type 322565863862SAndy Whitcroft # (char*[ const]) 3226bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 3227bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 32283705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 3229d8aaf121SAndy Whitcroft 323065863862SAndy Whitcroft # Should start with a space. 323165863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 323265863862SAndy Whitcroft # Should not end with a space. 323365863862SAndy Whitcroft $to =~ s/\s+$//; 323465863862SAndy Whitcroft # '*'s should not have spaces between. 3235f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 323665863862SAndy Whitcroft } 3237d8aaf121SAndy Whitcroft 32383705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 323965863862SAndy Whitcroft if ($from ne $to) { 32403705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 32413705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 32423705ce5bSJoe Perches $fix) { 32433705ce5bSJoe Perches my $sub_from = $ident; 32443705ce5bSJoe Perches my $sub_to = $ident; 32453705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3246194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32473705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 32483705ce5bSJoe Perches } 324965863862SAndy Whitcroft } 3250bfcb2cc7SAndy Whitcroft } 3251bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 3252bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 32533705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 3254d8aaf121SAndy Whitcroft 325565863862SAndy Whitcroft # Should start with a space. 325665863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 325765863862SAndy Whitcroft # Should not end with a space. 325865863862SAndy Whitcroft $to =~ s/\s+$//; 325965863862SAndy Whitcroft # '*'s should not have spaces between. 3260f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 326165863862SAndy Whitcroft } 326265863862SAndy Whitcroft # Modifiers should have spaces. 326365863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 326465863862SAndy Whitcroft 32653705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 3266667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 32673705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 32683705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 32693705ce5bSJoe Perches $fix) { 32703705ce5bSJoe Perches 32713705ce5bSJoe Perches my $sub_from = $match; 32723705ce5bSJoe Perches my $sub_to = $match; 32733705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 3274194f66fcSJoe Perches $fixed[$fixlinenr] =~ 32753705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 32763705ce5bSJoe Perches } 327765863862SAndy Whitcroft } 32780a920b5bSAndy Whitcroft } 32790a920b5bSAndy Whitcroft 32800a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 32810a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 32820a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 32830a920b5bSAndy Whitcroft# print "$herecurr"; 32840a920b5bSAndy Whitcroft# $clean = 0; 32850a920b5bSAndy Whitcroft# } 32860a920b5bSAndy Whitcroft 32878905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 3288000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 3289000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 32908905a67cSAndy Whitcroft } 32918905a67cSAndy Whitcroft 329217441227SJoe Perches# check for uses of printk_ratelimit 329317441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 3294000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 3295000d1cc1SJoe Perches "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 329617441227SJoe Perches } 329717441227SJoe Perches 329800df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 329900df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 330000df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 330125985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 330200df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 3303f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 330400df344fSAndy Whitcroft my $ok = 0; 330500df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 330600df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 330725985edcSLucas De Marchi # we have a preceding printk if it ends 330800df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 330900df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 331000df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 331100df344fSAndy Whitcroft $ok = 1; 331200df344fSAndy Whitcroft } 331300df344fSAndy Whitcroft last; 331400df344fSAndy Whitcroft } 331500df344fSAndy Whitcroft } 331600df344fSAndy Whitcroft if ($ok == 0) { 3317000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 3318000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 33190a920b5bSAndy Whitcroft } 332000df344fSAndy Whitcroft } 33210a920b5bSAndy Whitcroft 3322243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 3323243f3803SJoe Perches my $orig = $1; 3324243f3803SJoe Perches my $level = lc($orig); 3325243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 33268f26b837SJoe Perches my $level2 = $level; 33278f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 3328243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 3329daa8b059SYogesh Chaudhari "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 3330243f3803SJoe Perches } 3331243f3803SJoe Perches 3332243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 3333d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 3334d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 3335d5e616fcSJoe Perches $fix) { 3336194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3337d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 3338d5e616fcSJoe Perches } 3339243f3803SJoe Perches } 3340243f3803SJoe Perches 3341dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 3342dc139313SJoe Perches my $orig = $1; 3343dc139313SJoe Perches my $level = lc($orig); 3344dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 3345dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 3346dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 3347dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 3348dc139313SJoe Perches } 3349dc139313SJoe Perches 3350653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 3351653d4876SAndy Whitcroft# or if closed on same line 33528d182478SJoe Perches if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and 3353c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 33548d182478SJoe Perches if (ERROR("OPEN_BRACE", 33558d182478SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr) && 33568d182478SJoe Perches $fix) { 33578d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 33588d182478SJoe Perches my $fixed_line = $rawline; 33598d182478SJoe Perches $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/; 33608d182478SJoe Perches my $line1 = $1; 33618d182478SJoe Perches my $line2 = $2; 33628d182478SJoe Perches fix_insert_line($fixlinenr, ltrim($line1)); 33638d182478SJoe Perches fix_insert_line($fixlinenr, "\+{"); 33648d182478SJoe Perches if ($line2 !~ /^\s*$/) { 33658d182478SJoe Perches fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 33668d182478SJoe Perches } 33678d182478SJoe Perches } 33680a920b5bSAndy Whitcroft } 3369653d4876SAndy Whitcroft 33708905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 33718905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 33728905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 33738d182478SJoe Perches if (ERROR("OPEN_BRACE", 33748d182478SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev) && 33758d182478SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 33768d182478SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 33778d182478SJoe Perches fix_delete_line($fixlinenr, $rawline); 33788d182478SJoe Perches my $fixedline = rtrim($prevrawline) . " {"; 33798d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 33808d182478SJoe Perches $fixedline = $rawline; 33818d182478SJoe Perches $fixedline =~ s/^(.\s*){\s*/$1\t/; 33828d182478SJoe Perches if ($fixedline !~ /^\+\s*$/) { 33838d182478SJoe Perches fix_insert_line($fixlinenr, $fixedline); 33848d182478SJoe Perches } 33858d182478SJoe Perches } 33868905a67cSAndy Whitcroft } 33878905a67cSAndy Whitcroft 33880c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 33893705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 33903705ce5bSJoe Perches if (WARN("SPACING", 33913705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 33923705ce5bSJoe Perches $fix) { 3393194f66fcSJoe Perches $fixed[$fixlinenr] =~ 33943705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 33953705ce5bSJoe Perches } 33960c73b4ebSAndy Whitcroft } 33970c73b4ebSAndy Whitcroft 339831070b5dSJoe Perches# Function pointer declarations 339931070b5dSJoe Perches# check spacing between type, funcptr, and args 340031070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)" 340191f72e9cSJoe Perches if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 340231070b5dSJoe Perches my $declare = $1; 340331070b5dSJoe Perches my $pre_pointer_space = $2; 340431070b5dSJoe Perches my $post_pointer_space = $3; 340531070b5dSJoe Perches my $funcname = $4; 340631070b5dSJoe Perches my $post_funcname_space = $5; 340731070b5dSJoe Perches my $pre_args_space = $6; 340831070b5dSJoe Perches 340991f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type 341091f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types 341191f72e9cSJoe Perches# don't need a space so don't warn for those. 341291f72e9cSJoe Perches my $post_declare_space = ""; 341391f72e9cSJoe Perches if ($declare =~ /(\s+)$/) { 341491f72e9cSJoe Perches $post_declare_space = $1; 341591f72e9cSJoe Perches $declare = rtrim($declare); 341691f72e9cSJoe Perches } 341791f72e9cSJoe Perches if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 341831070b5dSJoe Perches WARN("SPACING", 341931070b5dSJoe Perches "missing space after return type\n" . $herecurr); 342091f72e9cSJoe Perches $post_declare_space = " "; 342131070b5dSJoe Perches } 342231070b5dSJoe Perches 342331070b5dSJoe Perches# unnecessary space "type (*funcptr)(args...)" 342491f72e9cSJoe Perches# This test is not currently implemented because these declarations are 342591f72e9cSJoe Perches# equivalent to 342691f72e9cSJoe Perches# int foo(int bar, ...) 342791f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning. 342891f72e9cSJoe Perches# 342991f72e9cSJoe Perches# elsif ($declare =~ /\s{2,}$/) { 343091f72e9cSJoe Perches# WARN("SPACING", 343191f72e9cSJoe Perches# "Multiple spaces after return type\n" . $herecurr); 343291f72e9cSJoe Perches# } 343331070b5dSJoe Perches 343431070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)" 343531070b5dSJoe Perches if (defined $pre_pointer_space && 343631070b5dSJoe Perches $pre_pointer_space =~ /^\s/) { 343731070b5dSJoe Perches WARN("SPACING", 343831070b5dSJoe Perches "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 343931070b5dSJoe Perches } 344031070b5dSJoe Perches 344131070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)" 344231070b5dSJoe Perches if (defined $post_pointer_space && 344331070b5dSJoe Perches $post_pointer_space =~ /^\s/) { 344431070b5dSJoe Perches WARN("SPACING", 344531070b5dSJoe Perches "Unnecessary space before function pointer name\n" . $herecurr); 344631070b5dSJoe Perches } 344731070b5dSJoe Perches 344831070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)" 344931070b5dSJoe Perches if (defined $post_funcname_space && 345031070b5dSJoe Perches $post_funcname_space =~ /^\s/) { 345131070b5dSJoe Perches WARN("SPACING", 345231070b5dSJoe Perches "Unnecessary space after function pointer name\n" . $herecurr); 345331070b5dSJoe Perches } 345431070b5dSJoe Perches 345531070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)" 345631070b5dSJoe Perches if (defined $pre_args_space && 345731070b5dSJoe Perches $pre_args_space =~ /^\s/) { 345831070b5dSJoe Perches WARN("SPACING", 345931070b5dSJoe Perches "Unnecessary space before function pointer arguments\n" . $herecurr); 346031070b5dSJoe Perches } 346131070b5dSJoe Perches 346231070b5dSJoe Perches if (show_type("SPACING") && $fix) { 3463194f66fcSJoe Perches $fixed[$fixlinenr] =~ 346491f72e9cSJoe Perches s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 346531070b5dSJoe Perches } 346631070b5dSJoe Perches } 346731070b5dSJoe Perches 34688d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 34698d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 3470fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 3471fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 34728d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 34738d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 34748d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 3475fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 3476daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 34773705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 34783705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 34793705ce5bSJoe Perches $fix) { 3480194f66fcSJoe Perches $fixed[$fixlinenr] =~ 34813705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 34823705ce5bSJoe Perches } 34838d31cfceSAndy Whitcroft } 34848d31cfceSAndy Whitcroft } 34858d31cfceSAndy Whitcroft 3486f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 34876c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 3488c2fdda0dSAndy Whitcroft my $name = $1; 3489773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 3490773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 3491c2fdda0dSAndy Whitcroft 3492c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 3493773647a0SAndy Whitcroft if ($name =~ /^(?: 3494773647a0SAndy Whitcroft if|for|while|switch|return|case| 3495773647a0SAndy Whitcroft volatile|__volatile__| 3496773647a0SAndy Whitcroft __attribute__|format|__extension__| 3497773647a0SAndy Whitcroft asm|__asm__)$/x) 3498773647a0SAndy Whitcroft { 3499c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 3500c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 3501c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 3502c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 3503773647a0SAndy Whitcroft 3504773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 3505c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 3506c2fdda0dSAndy Whitcroft 3507c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 3508c2fdda0dSAndy Whitcroft # likely a typedef for a function. 3509773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 3510c2fdda0dSAndy Whitcroft 3511c2fdda0dSAndy Whitcroft } else { 35123705ce5bSJoe Perches if (WARN("SPACING", 35133705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 35143705ce5bSJoe Perches $fix) { 3515194f66fcSJoe Perches $fixed[$fixlinenr] =~ 35163705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 35173705ce5bSJoe Perches } 3518f0a594c1SAndy Whitcroft } 35196c72ffaaSAndy Whitcroft } 35209a4cad4eSEric Nelson 3521653d4876SAndy Whitcroft# Check operator spacing. 35220a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 35233705ce5bSJoe Perches my $fixed_line = ""; 35243705ce5bSJoe Perches my $line_fixed = 0; 35253705ce5bSJoe Perches 35269c0ca6f9SAndy Whitcroft my $ops = qr{ 35279c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 35289c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 35299c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 35301f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 353184731623SJoe Perches \?:|\?|: 35329c0ca6f9SAndy Whitcroft }x; 3533cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 35343705ce5bSJoe Perches 35353705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 35363705ce5bSJoe Perches## foreach my $el (@elements) { 35373705ce5bSJoe Perches## print("el: <$el>\n"); 35383705ce5bSJoe Perches## } 35393705ce5bSJoe Perches 35403705ce5bSJoe Perches my @fix_elements = (); 354100df344fSAndy Whitcroft my $off = 0; 35426c72ffaaSAndy Whitcroft 35433705ce5bSJoe Perches foreach my $el (@elements) { 35443705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 35453705ce5bSJoe Perches $off += length($el); 35463705ce5bSJoe Perches } 35473705ce5bSJoe Perches 35483705ce5bSJoe Perches $off = 0; 35493705ce5bSJoe Perches 35506c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 3551b34c648bSJoe Perches my $last_after = -1; 35526c72ffaaSAndy Whitcroft 35530a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 35543705ce5bSJoe Perches 35553705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 35563705ce5bSJoe Perches 35573705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 35583705ce5bSJoe Perches 35594a0df2efSAndy Whitcroft $off += length($elements[$n]); 35604a0df2efSAndy Whitcroft 356125985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 3562773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 3563773647a0SAndy Whitcroft my $cc = ''; 3564773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 3565773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 3566773647a0SAndy Whitcroft } 3567773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 3568773647a0SAndy Whitcroft 35694a0df2efSAndy Whitcroft my $a = ''; 35704a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 35714a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 3572cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 35734a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 35744a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 3575773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 35764a0df2efSAndy Whitcroft 35770a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 35784a0df2efSAndy Whitcroft 35794a0df2efSAndy Whitcroft my $c = ''; 35800a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 35814a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 35824a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 3583cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 35844a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 35854a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 35868b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 35874a0df2efSAndy Whitcroft } else { 35884a0df2efSAndy Whitcroft $c = 'E'; 35890a920b5bSAndy Whitcroft } 35900a920b5bSAndy Whitcroft 35914a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 35924a0df2efSAndy Whitcroft 35934a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 35944a0df2efSAndy Whitcroft 35956c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 3596de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 35970a920b5bSAndy Whitcroft 359874048ed8SAndy Whitcroft # Pull out the value of this operator. 35996c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 36000a920b5bSAndy Whitcroft 36011f65f947SAndy Whitcroft # Get the full operator variant. 36021f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 36031f65f947SAndy Whitcroft 360413214adfSAndy Whitcroft # Ignore operators passed as parameters. 360513214adfSAndy Whitcroft if ($op_type ne 'V' && 360613214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 360713214adfSAndy Whitcroft 3608cf655043SAndy Whitcroft# # Ignore comments 3609cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 361013214adfSAndy Whitcroft 3611d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 361213214adfSAndy Whitcroft } elsif ($op eq ';') { 3613cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 3614cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 36153705ce5bSJoe Perches if (ERROR("SPACING", 36163705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 3617b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 36183705ce5bSJoe Perches $line_fixed = 1; 36193705ce5bSJoe Perches } 3620d8aaf121SAndy Whitcroft } 3621d8aaf121SAndy Whitcroft 3622d8aaf121SAndy Whitcroft # // is a comment 3623d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 36240a920b5bSAndy Whitcroft 3625b00e4814SJoe Perches # : when part of a bitfield 3626b00e4814SJoe Perches } elsif ($opv eq ':B') { 3627b00e4814SJoe Perches # skip the bitfield test for now 3628b00e4814SJoe Perches 36291f65f947SAndy Whitcroft # No spaces for: 36301f65f947SAndy Whitcroft # -> 3631b00e4814SJoe Perches } elsif ($op eq '->') { 36324a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 36333705ce5bSJoe Perches if (ERROR("SPACING", 36343705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 3635b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 36363705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 36373705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 36383705ce5bSJoe Perches } 3639b34c648bSJoe Perches $line_fixed = 1; 36403705ce5bSJoe Perches } 36410a920b5bSAndy Whitcroft } 36420a920b5bSAndy Whitcroft 36432381097bSJoe Perches # , must not have a space before and must have a space on the right. 36440a920b5bSAndy Whitcroft } elsif ($op eq ',') { 36452381097bSJoe Perches my $rtrim_before = 0; 36462381097bSJoe Perches my $space_after = 0; 36472381097bSJoe Perches if ($ctx =~ /Wx./) { 36482381097bSJoe Perches if (ERROR("SPACING", 36492381097bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 36502381097bSJoe Perches $line_fixed = 1; 36512381097bSJoe Perches $rtrim_before = 1; 36522381097bSJoe Perches } 36532381097bSJoe Perches } 3654cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 36553705ce5bSJoe Perches if (ERROR("SPACING", 36563705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 36573705ce5bSJoe Perches $line_fixed = 1; 3658b34c648bSJoe Perches $last_after = $n; 36592381097bSJoe Perches $space_after = 1; 36602381097bSJoe Perches } 36612381097bSJoe Perches } 36622381097bSJoe Perches if ($rtrim_before || $space_after) { 36632381097bSJoe Perches if ($rtrim_before) { 36642381097bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 36652381097bSJoe Perches } else { 36662381097bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 36672381097bSJoe Perches } 36682381097bSJoe Perches if ($space_after) { 36692381097bSJoe Perches $good .= " "; 36703705ce5bSJoe Perches } 36710a920b5bSAndy Whitcroft } 36720a920b5bSAndy Whitcroft 36739c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 367474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 36759c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 36769c0ca6f9SAndy Whitcroft 36779c0ca6f9SAndy Whitcroft # unary operators should have a space before and 36789c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 36799c0ca6f9SAndy Whitcroft # unary operator, or a cast 36809c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 368174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 36820d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3683cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 36843705ce5bSJoe Perches if (ERROR("SPACING", 36853705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3686b34c648bSJoe Perches if ($n != $last_after + 2) { 3687b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 36883705ce5bSJoe Perches $line_fixed = 1; 36893705ce5bSJoe Perches } 36900a920b5bSAndy Whitcroft } 3691b34c648bSJoe Perches } 3692a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3693171ae1a4SAndy Whitcroft # A unary '*' may be const 3694171ae1a4SAndy Whitcroft 3695171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 36963705ce5bSJoe Perches if (ERROR("SPACING", 36973705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3698b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 36993705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37003705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 37013705ce5bSJoe Perches } 3702b34c648bSJoe Perches $line_fixed = 1; 37033705ce5bSJoe Perches } 37040a920b5bSAndy Whitcroft } 37050a920b5bSAndy Whitcroft 37060a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 37070a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3708773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 37093705ce5bSJoe Perches if (ERROR("SPACING", 37103705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3711b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 37123705ce5bSJoe Perches $line_fixed = 1; 37133705ce5bSJoe Perches } 37140a920b5bSAndy Whitcroft } 3715773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3716773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 37173705ce5bSJoe Perches if (ERROR("SPACING", 37183705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3719b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37203705ce5bSJoe Perches $line_fixed = 1; 37213705ce5bSJoe Perches } 3722653d4876SAndy Whitcroft } 3723773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 37243705ce5bSJoe Perches if (ERROR("SPACING", 37253705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3726b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 37273705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 37283705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3729773647a0SAndy Whitcroft } 3730b34c648bSJoe Perches $line_fixed = 1; 37313705ce5bSJoe Perches } 37323705ce5bSJoe Perches } 37330a920b5bSAndy Whitcroft 37340a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 37359c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 37369c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 37379c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3738c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3739c2fdda0dSAndy Whitcroft $op eq '%') 37400a920b5bSAndy Whitcroft { 3741d2e025f3SJoe Perches if ($check) { 3742d2e025f3SJoe Perches if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 3743d2e025f3SJoe Perches if (CHK("SPACING", 3744d2e025f3SJoe Perches "spaces preferred around that '$op' $at\n" . $hereptr)) { 3745d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3746d2e025f3SJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3747d2e025f3SJoe Perches $line_fixed = 1; 3748d2e025f3SJoe Perches } 3749d2e025f3SJoe Perches } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 3750d2e025f3SJoe Perches if (CHK("SPACING", 3751d2e025f3SJoe Perches "space preferred before that '$op' $at\n" . $hereptr)) { 3752d2e025f3SJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 3753d2e025f3SJoe Perches $line_fixed = 1; 3754d2e025f3SJoe Perches } 3755d2e025f3SJoe Perches } 3756d2e025f3SJoe Perches } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 37573705ce5bSJoe Perches if (ERROR("SPACING", 37583705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3759b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3760b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3761b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3762b34c648bSJoe Perches } 37633705ce5bSJoe Perches $line_fixed = 1; 37643705ce5bSJoe Perches } 37650a920b5bSAndy Whitcroft } 37660a920b5bSAndy Whitcroft 37671f65f947SAndy Whitcroft # A colon needs no spaces before when it is 37681f65f947SAndy Whitcroft # terminating a case value or a label. 37691f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 37701f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 37713705ce5bSJoe Perches if (ERROR("SPACING", 37723705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3773b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 37743705ce5bSJoe Perches $line_fixed = 1; 37753705ce5bSJoe Perches } 37761f65f947SAndy Whitcroft } 37771f65f947SAndy Whitcroft 37780a920b5bSAndy Whitcroft # All the others need spaces both sides. 3779cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 37801f65f947SAndy Whitcroft my $ok = 0; 37811f65f947SAndy Whitcroft 378222f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 37831f65f947SAndy Whitcroft if (($op eq '<' && 37841f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 37851f65f947SAndy Whitcroft ($op eq '>' && 37861f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 37871f65f947SAndy Whitcroft { 37881f65f947SAndy Whitcroft $ok = 1; 37891f65f947SAndy Whitcroft } 37901f65f947SAndy Whitcroft 379184731623SJoe Perches # messages are ERROR, but ?: are CHK 37921f65f947SAndy Whitcroft if ($ok == 0) { 379384731623SJoe Perches my $msg_type = \&ERROR; 379484731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 379584731623SJoe Perches 379684731623SJoe Perches if (&{$msg_type}("SPACING", 37973705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3798b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3799b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3800b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3801b34c648bSJoe Perches } 38023705ce5bSJoe Perches $line_fixed = 1; 38033705ce5bSJoe Perches } 38040a920b5bSAndy Whitcroft } 380522f2a2efSAndy Whitcroft } 38064a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 38073705ce5bSJoe Perches 38083705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 38093705ce5bSJoe Perches 38103705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 38110a920b5bSAndy Whitcroft } 38123705ce5bSJoe Perches 38133705ce5bSJoe Perches if (($#elements % 2) == 0) { 38143705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 38153705ce5bSJoe Perches } 38163705ce5bSJoe Perches 3817194f66fcSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 3818194f66fcSJoe Perches $fixed[$fixlinenr] = $fixed_line; 38193705ce5bSJoe Perches } 38203705ce5bSJoe Perches 38213705ce5bSJoe Perches 38220a920b5bSAndy Whitcroft } 38230a920b5bSAndy Whitcroft 3824786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3825d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3826786b6326SJoe Perches if (WARN("SPACING", 3827786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3828786b6326SJoe Perches $fix) { 3829194f66fcSJoe Perches 1 while $fixed[$fixlinenr] =~ 3830786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3831786b6326SJoe Perches } 3832786b6326SJoe Perches } 3833786b6326SJoe Perches 3834f0a594c1SAndy Whitcroft# check for multiple assignments 3835f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3836000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3837000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3838f0a594c1SAndy Whitcroft } 3839f0a594c1SAndy Whitcroft 384022f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 384122f2a2efSAndy Whitcroft## # continuation. 384222f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 384322f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 384422f2a2efSAndy Whitcroft## 384522f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 384622f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 384722f2a2efSAndy Whitcroft## my $ln = $line; 384822f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 384922f2a2efSAndy Whitcroft## } 385022f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3851000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3852000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 385322f2a2efSAndy Whitcroft## } 385422f2a2efSAndy Whitcroft## } 3855f0a594c1SAndy Whitcroft 38560a920b5bSAndy Whitcroft#need space before brace following if, while, etc 385722f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 385822f2a2efSAndy Whitcroft $line =~ /do{/) { 38593705ce5bSJoe Perches if (ERROR("SPACING", 38603705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 38613705ce5bSJoe Perches $fix) { 3862194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/; 38633705ce5bSJoe Perches } 3864de7d4f0eSAndy Whitcroft } 3865de7d4f0eSAndy Whitcroft 3866c4a62ef9SJoe Perches## # check for blank lines before declarations 3867c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3868c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3869c4a62ef9SJoe Perches## WARN("SPACING", 3870c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3871c4a62ef9SJoe Perches## } 3872c4a62ef9SJoe Perches## 3873c4a62ef9SJoe Perches 3874de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3875de7d4f0eSAndy Whitcroft# on the line 3876de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3877d5e616fcSJoe Perches if (ERROR("SPACING", 3878d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3879d5e616fcSJoe Perches $fix) { 3880194f66fcSJoe Perches $fixed[$fixlinenr] =~ 3881d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3882d5e616fcSJoe Perches } 38830a920b5bSAndy Whitcroft } 38840a920b5bSAndy Whitcroft 388522f2a2efSAndy Whitcroft# check spacing on square brackets 388622f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 38873705ce5bSJoe Perches if (ERROR("SPACING", 38883705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 38893705ce5bSJoe Perches $fix) { 3890194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38913705ce5bSJoe Perches s/\[\s+/\[/; 38923705ce5bSJoe Perches } 389322f2a2efSAndy Whitcroft } 389422f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 38953705ce5bSJoe Perches if (ERROR("SPACING", 38963705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 38973705ce5bSJoe Perches $fix) { 3898194f66fcSJoe Perches $fixed[$fixlinenr] =~ 38993705ce5bSJoe Perches s/\s+\]/\]/; 39003705ce5bSJoe Perches } 390122f2a2efSAndy Whitcroft } 390222f2a2efSAndy Whitcroft 3903c45dcabdSAndy Whitcroft# check spacing on parentheses 39049c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 39059c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 39063705ce5bSJoe Perches if (ERROR("SPACING", 39073705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 39083705ce5bSJoe Perches $fix) { 3909194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39103705ce5bSJoe Perches s/\(\s+/\(/; 39113705ce5bSJoe Perches } 391222f2a2efSAndy Whitcroft } 391313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3914c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3915c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 39163705ce5bSJoe Perches if (ERROR("SPACING", 39173705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 39183705ce5bSJoe Perches $fix) { 3919194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39203705ce5bSJoe Perches s/\s+\)/\)/; 39213705ce5bSJoe Perches } 392222f2a2efSAndy Whitcroft } 392322f2a2efSAndy Whitcroft 3924e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals 3925e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 3926e2826fd0SJoe Perches 3927e2826fd0SJoe Perches while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 3928ea4acbb1SJoe Perches my $var = $1; 3929ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3930ea4acbb1SJoe Perches "Unnecessary parentheses around $var\n" . $herecurr) && 3931ea4acbb1SJoe Perches $fix) { 3932ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 3933ea4acbb1SJoe Perches } 3934ea4acbb1SJoe Perches } 3935ea4acbb1SJoe Perches 3936ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses 3937ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar(); 3938ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives 3939ea4acbb1SJoe Perches if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 3940ea4acbb1SJoe Perches my $var = $2; 3941ea4acbb1SJoe Perches if (CHK("UNNECESSARY_PARENTHESES", 3942ea4acbb1SJoe Perches "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 3943ea4acbb1SJoe Perches $fix) { 3944ea4acbb1SJoe Perches my $var2 = deparenthesize($var); 3945ea4acbb1SJoe Perches $var2 =~ s/\s//g; 3946ea4acbb1SJoe Perches $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 3947ea4acbb1SJoe Perches } 3948e2826fd0SJoe Perches } 3949e2826fd0SJoe Perches 39500a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 39514a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 39520a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 39533705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 39543705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 39553705ce5bSJoe Perches $fix) { 3956194f66fcSJoe Perches $fixed[$fixlinenr] =~ 39573705ce5bSJoe Perches s/^(.)\s+/$1/; 39583705ce5bSJoe Perches } 39590a920b5bSAndy Whitcroft } 39600a920b5bSAndy Whitcroft 39615b9553abSJoe Perches# return is not a function 3962507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3963c45dcabdSAndy Whitcroft my $spacing = $1; 3964507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 39655b9553abSJoe Perches $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 39665b9553abSJoe Perches my $value = $1; 39675b9553abSJoe Perches $value = deparenthesize($value); 39685b9553abSJoe Perches if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 3969000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3970000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 39715b9553abSJoe Perches } 3972c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3973000d1cc1SJoe Perches ERROR("SPACING", 3974000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3975c45dcabdSAndy Whitcroft } 3976c45dcabdSAndy Whitcroft } 3977507e5141SJoe Perches 3978b43ae21bSJoe Perches# unnecessary return in a void function 3979b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return; 3980b43ae21bSJoe Perches# and the line before that not a goto label target like "out:" 3981b43ae21bSJoe Perches if ($sline =~ /^[ \+]}\s*$/ && 3982b43ae21bSJoe Perches $prevline =~ /^\+\treturn\s*;\s*$/ && 3983b43ae21bSJoe Perches $linenr >= 3 && 3984b43ae21bSJoe Perches $lines[$linenr - 3] =~ /^[ +]/ && 3985b43ae21bSJoe Perches $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 39869819cf25SJoe Perches WARN("RETURN_VOID", 3987b43ae21bSJoe Perches "void function return statements are not generally useful\n" . $hereprev); 39889819cf25SJoe Perches } 39899819cf25SJoe Perches 3990189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar)) 3991189248d8SJoe Perches if ($^V && $^V ge 5.10.0 && 3992189248d8SJoe Perches $line =~ /\bif\s*((?:\(\s*){2,})/) { 3993189248d8SJoe Perches my $openparens = $1; 3994189248d8SJoe Perches my $count = $openparens =~ tr@\(@\(@; 3995189248d8SJoe Perches my $msg = ""; 3996189248d8SJoe Perches if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 3997189248d8SJoe Perches my $comp = $4; #Not $1 because of $LvalOrFunc 3998189248d8SJoe Perches $msg = " - maybe == should be = ?" if ($comp eq "=="); 3999189248d8SJoe Perches WARN("UNNECESSARY_PARENTHESES", 4000189248d8SJoe Perches "Unnecessary parentheses$msg\n" . $herecurr); 4001189248d8SJoe Perches } 4002189248d8SJoe Perches } 4003189248d8SJoe Perches 400453a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 400553a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 400653a3c448SAndy Whitcroft my $name = $1; 400753a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 4008000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 4009000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 401053a3c448SAndy Whitcroft } 401153a3c448SAndy Whitcroft } 4012c45dcabdSAndy Whitcroft 40130a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 40144a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 40153705ce5bSJoe Perches if (ERROR("SPACING", 40163705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 40173705ce5bSJoe Perches $fix) { 4018194f66fcSJoe Perches $fixed[$fixlinenr] =~ 40193705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 40203705ce5bSJoe Perches } 40210a920b5bSAndy Whitcroft } 40220a920b5bSAndy Whitcroft 4023f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 4024f5fe35ddSAndy Whitcroft# statements after the conditional. 4025170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 40263e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 40273e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 40283e469cdcSAndy Whitcroft if (!defined $stat); 4029170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 4030170d3a22SAndy Whitcroft $remain_next, $off_next); 4031170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 4032170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 4033170d3a22SAndy Whitcroft 4034170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 4035170d3a22SAndy Whitcroft # If the statement carries leading newlines, 4036170d3a22SAndy Whitcroft # then count those as offsets. 4037170d3a22SAndy Whitcroft my ($whitespace) = 4038170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 4039170d3a22SAndy Whitcroft my $offset = 4040170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 4041170d3a22SAndy Whitcroft 4042170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 4043170d3a22SAndy Whitcroft $offset} = 1; 4044170d3a22SAndy Whitcroft } 4045170d3a22SAndy Whitcroft } 4046170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 4047c11230f4SJoe Perches defined($stat) && defined($cond) && 4048170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 4049171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 40508905a67cSAndy Whitcroft 4051b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 4052000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 4053000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 40548905a67cSAndy Whitcroft } 40558905a67cSAndy Whitcroft 40568905a67cSAndy Whitcroft # Find out what is on the end of the line after the 40578905a67cSAndy Whitcroft # conditional. 4058773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 40598905a67cSAndy Whitcroft $s =~ s/\n.*//g; 406013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 406153210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 406253210168SAndy Whitcroft $c !~ /}\s*while\s*/) 4063773647a0SAndy Whitcroft { 4064bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 4065bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 4066bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 406742bdf74cSHidetoshi Seto my $stat_real = ''; 4068bb44ad39SAndy Whitcroft 406942bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 407042bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 4071bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 4072bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 4073bb44ad39SAndy Whitcroft } 4074bb44ad39SAndy Whitcroft 4075000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4076000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 40778905a67cSAndy Whitcroft } 40788905a67cSAndy Whitcroft } 40798905a67cSAndy Whitcroft 408013214adfSAndy Whitcroft# Check for bitwise tests written as boolean 408113214adfSAndy Whitcroft if ($line =~ / 408213214adfSAndy Whitcroft (?: 408313214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 408413214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 408513214adfSAndy Whitcroft (?:\&\&|\|\|) 408613214adfSAndy Whitcroft | 408713214adfSAndy Whitcroft (?:\&\&|\|\|) 408813214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 408913214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 409013214adfSAndy Whitcroft )/x) 409113214adfSAndy Whitcroft { 4092000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 4093000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 409413214adfSAndy Whitcroft } 409513214adfSAndy Whitcroft 40968905a67cSAndy Whitcroft# if and else should not have general statements after it 409713214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 409813214adfSAndy Whitcroft my $s = $1; 409913214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 410013214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 4101000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4102000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 41030a920b5bSAndy Whitcroft } 410413214adfSAndy Whitcroft } 410539667782SAndy Whitcroft# if should not continue a brace 410639667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 4107000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4108048b123fSRasmus Villemoes "trailing statements should be on next line (or did you mean 'else if'?)\n" . 410939667782SAndy Whitcroft $herecurr); 411039667782SAndy Whitcroft } 4111a1080bf8SAndy Whitcroft# case and default should not have general statements after them 4112a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 4113a1080bf8SAndy Whitcroft $line !~ /\G(?: 41143fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 4115a1080bf8SAndy Whitcroft \s*return\s+ 4116a1080bf8SAndy Whitcroft )/xg) 4117a1080bf8SAndy Whitcroft { 4118000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 4119000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 4120a1080bf8SAndy Whitcroft } 41210a920b5bSAndy Whitcroft 41220a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 41230a920b5bSAndy Whitcroft # indent level to be relevant to each other. 41248b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 41250a920b5bSAndy Whitcroft $previndent == $indent) { 41268b8856f4SJoe Perches if (ERROR("ELSE_AFTER_BRACE", 41278b8856f4SJoe Perches "else should follow close brace '}'\n" . $hereprev) && 41288b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 41298b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 41308b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 41318b8856f4SJoe Perches my $fixedline = $prevrawline; 41328b8856f4SJoe Perches $fixedline =~ s/}\s*$//; 41338b8856f4SJoe Perches if ($fixedline !~ /^\+\s*$/) { 41348b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41358b8856f4SJoe Perches } 41368b8856f4SJoe Perches $fixedline = $rawline; 41378b8856f4SJoe Perches $fixedline =~ s/^(.\s*)else/$1} else/; 41388b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41398b8856f4SJoe Perches } 41400a920b5bSAndy Whitcroft } 41410a920b5bSAndy Whitcroft 41428b8856f4SJoe Perches if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 4143c2fdda0dSAndy Whitcroft $previndent == $indent) { 4144c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 4145c2fdda0dSAndy Whitcroft 4146c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 4147c2fdda0dSAndy Whitcroft # conditional. 4148773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 4149c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 4150c2fdda0dSAndy Whitcroft 4151c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 41528b8856f4SJoe Perches if (ERROR("WHILE_AFTER_BRACE", 41538b8856f4SJoe Perches "while should follow close brace '}'\n" . $hereprev) && 41548b8856f4SJoe Perches $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 41558b8856f4SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 41568b8856f4SJoe Perches fix_delete_line($fixlinenr, $rawline); 41578b8856f4SJoe Perches my $fixedline = $prevrawline; 41588b8856f4SJoe Perches my $trailing = $rawline; 41598b8856f4SJoe Perches $trailing =~ s/^\+//; 41608b8856f4SJoe Perches $trailing = trim($trailing); 41618b8856f4SJoe Perches $fixedline =~ s/}\s*$/} $trailing/; 41628b8856f4SJoe Perches fix_insert_line($fixlinenr, $fixedline); 41638b8856f4SJoe Perches } 4164c2fdda0dSAndy Whitcroft } 4165c2fdda0dSAndy Whitcroft } 4166c2fdda0dSAndy Whitcroft 416795e2c602SJoe Perches#Specific variable tests 4168323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 4169323c1260SJoe Perches my $var = $1; 417095e2c602SJoe Perches 417195e2c602SJoe Perches#gcc binary extension 417295e2c602SJoe Perches if ($var =~ /^$Binary$/) { 4173d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 4174d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 4175d5e616fcSJoe Perches $fix) { 4176d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 4177194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4178d5e616fcSJoe Perches s/\b$var\b/$hexval/; 4179d5e616fcSJoe Perches } 418095e2c602SJoe Perches } 418195e2c602SJoe Perches 418295e2c602SJoe Perches#CamelCase 4183807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 4184be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 418522735ce8SJoe Perches#Ignore Page<foo> variants 4186807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 418722735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 4188f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ && 4189f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz 4190f5123576SJulius Werner $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 41917e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 41927e781f67SJoe Perches my $word = $1; 41937e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 4194d8b07710SJoe Perches if ($check) { 4195d8b07710SJoe Perches seed_camelcase_includes(); 4196d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 4197d8b07710SJoe Perches seed_camelcase_file($realfile); 4198d8b07710SJoe Perches $camelcase_file_seeded = 1; 4199d8b07710SJoe Perches } 4200d8b07710SJoe Perches } 42017e781f67SJoe Perches if (!defined $camelcase{$word}) { 42027e781f67SJoe Perches $camelcase{$word} = 1; 4203be79794bSJoe Perches CHK("CAMELCASE", 42047e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 42057e781f67SJoe Perches } 4206323c1260SJoe Perches } 4207323c1260SJoe Perches } 42083445686aSJoe Perches } 42090a920b5bSAndy Whitcroft 42100a920b5bSAndy Whitcroft#no spaces allowed after \ in define 4211d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 4212d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 4213d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 4214d5e616fcSJoe Perches $fix) { 4215194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\s+$//; 4216d5e616fcSJoe Perches } 42170a920b5bSAndy Whitcroft } 42180a920b5bSAndy Whitcroft 4219653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 4220c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 4221e09dec48SAndy Whitcroft my $file = "$1.h"; 4222e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 4223e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 4224e09dec48SAndy Whitcroft $realfile ne $checkfile && 42257840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 4226c45dcabdSAndy Whitcroft { 4227e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 4228000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 4229000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4230e09dec48SAndy Whitcroft } else { 4231000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 4232000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 4233e09dec48SAndy Whitcroft } 42340a920b5bSAndy Whitcroft } 42350a920b5bSAndy Whitcroft } 42360a920b5bSAndy Whitcroft 4237653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 4238653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 4239cf655043SAndy Whitcroft# in a known good container 4240b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 4241b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 4242d8aaf121SAndy Whitcroft my $ln = $linenr; 4243d8aaf121SAndy Whitcroft my $cnt = $realcnt; 4244c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 4245c45dcabdSAndy Whitcroft my $ctx = ''; 424608a2843eSJoe Perches my $has_flow_statement = 0; 424708a2843eSJoe Perches my $has_arg_concat = 0; 4248c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 4249f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 4250f74bd194SAndy Whitcroft $ctx = $dstat; 4251c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 4252a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 4253c45dcabdSAndy Whitcroft 425408a2843eSJoe Perches $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 425508a2843eSJoe Perches $has_arg_concat = 1 if ($ctx =~ /\#\#/); 425608a2843eSJoe Perches 4257f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 4258292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 4259c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 4260c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 4261c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 4262c45dcabdSAndy Whitcroft 4263c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 4264bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 4265bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 4266c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 4267bf30d6edSAndy Whitcroft { 4268c45dcabdSAndy Whitcroft } 4269c45dcabdSAndy Whitcroft 4270e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 4271e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 4272e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 4273e45bab8eSAndy Whitcroft { 4274e45bab8eSAndy Whitcroft } 4275e45bab8eSAndy Whitcroft 4276c45dcabdSAndy Whitcroft my $exceptions = qr{ 4277c45dcabdSAndy Whitcroft $Declare| 4278c45dcabdSAndy Whitcroft module_param_named| 4279a0a0a7a9SKees Cook MODULE_PARM_DESC| 4280c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 4281c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 4282383099fdSAndy Whitcroft __typeof__\(| 428322fd2d3eSStefani Seibold union| 428422fd2d3eSStefani Seibold struct| 4285ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 4286ea71a0a0SAndy Whitcroft ^\"|\"$ 4287c45dcabdSAndy Whitcroft }x; 42885eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 4289f74bd194SAndy Whitcroft if ($dstat ne '' && 4290f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 4291f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 42923cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 4293356fd398SJoe Perches $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 4294f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 4295f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 4296e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 429772f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 4298f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 4299f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 4300f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 4301f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 4302f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 4303c45dcabdSAndy Whitcroft { 4304f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 4305f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 4306f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 4307f74bd194SAndy Whitcroft 4308f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 4309f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 4310c45dcabdSAndy Whitcroft } 4311c45dcabdSAndy Whitcroft 4312f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 4313f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 4314f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 4315f74bd194SAndy Whitcroft } else { 4316000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 4317388982b5SAndrew Morton "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 4318d8aaf121SAndy Whitcroft } 43190a920b5bSAndy Whitcroft } 43205023d347SJoe Perches 432108a2843eSJoe Perches# check for macros with flow control, but without ## concatenation 432208a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those 432308a2843eSJoe Perches if ($has_flow_statement && !$has_arg_concat) { 432408a2843eSJoe Perches my $herectx = $here . "\n"; 432508a2843eSJoe Perches my $cnt = statement_rawlines($ctx); 432608a2843eSJoe Perches 432708a2843eSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 432808a2843eSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 432908a2843eSJoe Perches } 433008a2843eSJoe Perches WARN("MACRO_WITH_FLOW_CONTROL", 433108a2843eSJoe Perches "Macros with flow control statements should be avoided\n" . "$herectx"); 433208a2843eSJoe Perches } 433308a2843eSJoe Perches 4334481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 43355023d347SJoe Perches 43365023d347SJoe Perches } else { 43375023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 4338481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 4339481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 43405023d347SJoe Perches $line =~ /^\+.*\\$/) { 43415023d347SJoe Perches WARN("LINE_CONTINUATIONS", 43425023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 43435023d347SJoe Perches } 4344653d4876SAndy Whitcroft } 43450a920b5bSAndy Whitcroft 4346b13edf7fSJoe Perches# do {} while (0) macro tests: 4347b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 4348b13edf7fSJoe Perches# macro should not end with a semicolon 4349b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 4350b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 4351b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 4352b13edf7fSJoe Perches my $ln = $linenr; 4353b13edf7fSJoe Perches my $cnt = $realcnt; 4354b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 4355b13edf7fSJoe Perches my $ctx = ''; 4356b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 4357b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 4358b13edf7fSJoe Perches $ctx = $dstat; 4359b13edf7fSJoe Perches 4360b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 43611b36b201SJoe Perches $dstat =~ s/$;/ /g; 4362b13edf7fSJoe Perches 4363b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 4364b13edf7fSJoe Perches my $stmts = $2; 4365b13edf7fSJoe Perches my $semis = $3; 4366b13edf7fSJoe Perches 4367b13edf7fSJoe Perches $ctx =~ s/\n*$//; 4368b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 4369b13edf7fSJoe Perches my $herectx = $here . "\n"; 4370b13edf7fSJoe Perches 4371b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4372b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4373b13edf7fSJoe Perches } 4374b13edf7fSJoe Perches 4375ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 4376ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 4377b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 4378b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 4379b13edf7fSJoe Perches } 4380b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 4381b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 4382b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 4383b13edf7fSJoe Perches } 4384f5ef95b1SJoe Perches } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 4385f5ef95b1SJoe Perches $ctx =~ s/\n*$//; 4386f5ef95b1SJoe Perches my $cnt = statement_rawlines($ctx); 4387f5ef95b1SJoe Perches my $herectx = $here . "\n"; 4388f5ef95b1SJoe Perches 4389f5ef95b1SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4390f5ef95b1SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4391f5ef95b1SJoe Perches } 4392f5ef95b1SJoe Perches 4393f5ef95b1SJoe Perches WARN("TRAILING_SEMICOLON", 4394f5ef95b1SJoe Perches "macros should not use a trailing semicolon\n" . "$herectx"); 4395b13edf7fSJoe Perches } 4396b13edf7fSJoe Perches } 4397b13edf7fSJoe Perches 4398080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 4399080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 4400080ba929SMike Frysinger# . 4401080ba929SMike Frysinger# ALIGN(...) 4402080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 4403080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 4404000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 4405000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 4406080ba929SMike Frysinger } 4407080ba929SMike Frysinger 4408f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 440913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 441013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 4411cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 441213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 4413cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 4414cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 4415aad4f614SJoe Perches my @allowed = (); 4416aad4f614SJoe Perches my $allow = 0; 441713214adfSAndy Whitcroft my $seen = 0; 4418773647a0SAndy Whitcroft my $herectx = $here . "\n"; 4419cf655043SAndy Whitcroft my $ln = $linenr - 1; 442013214adfSAndy Whitcroft for my $chunk (@chunks) { 442113214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 442213214adfSAndy Whitcroft 4423773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 4424773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 4425773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 4426773647a0SAndy Whitcroft 4427aad4f614SJoe Perches $allowed[$allow] = 0; 4428773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 4429773647a0SAndy Whitcroft 4430773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 4431773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 4432773647a0SAndy Whitcroft 4433773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 4434cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 4435cf655043SAndy Whitcroft 4436773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 443713214adfSAndy Whitcroft 443813214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 443913214adfSAndy Whitcroft 4440aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 4441cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4442cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4443aad4f614SJoe Perches $allowed[$allow] = 1; 444413214adfSAndy Whitcroft } 444513214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4446cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4447aad4f614SJoe Perches $allowed[$allow] = 1; 444813214adfSAndy Whitcroft } 4449cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4450cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4451aad4f614SJoe Perches $allowed[$allow] = 1; 445213214adfSAndy Whitcroft } 4453aad4f614SJoe Perches $allow++; 445413214adfSAndy Whitcroft } 4455aad4f614SJoe Perches if ($seen) { 4456aad4f614SJoe Perches my $sum_allowed = 0; 4457aad4f614SJoe Perches foreach (@allowed) { 4458aad4f614SJoe Perches $sum_allowed += $_; 4459aad4f614SJoe Perches } 4460aad4f614SJoe Perches if ($sum_allowed == 0) { 4461000d1cc1SJoe Perches WARN("BRACES", 4462000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 4463aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 4464aad4f614SJoe Perches $seen != $allow) { 4465aad4f614SJoe Perches CHK("BRACES", 4466aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 4467aad4f614SJoe Perches } 446813214adfSAndy Whitcroft } 446913214adfSAndy Whitcroft } 447013214adfSAndy Whitcroft } 4471773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 447213214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 4473cf655043SAndy Whitcroft my $allowed = 0; 4474f0a594c1SAndy Whitcroft 4475cf655043SAndy Whitcroft # Check the pre-context. 4476cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 4477cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 4478cf655043SAndy Whitcroft $allowed = 1; 4479f0a594c1SAndy Whitcroft } 4480773647a0SAndy Whitcroft 4481773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 4482773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 4483773647a0SAndy Whitcroft 4484cf655043SAndy Whitcroft # Check the condition. 4485cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 4486773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 4487cf655043SAndy Whitcroft if (defined $cond) { 4488773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4489cf655043SAndy Whitcroft } 4490cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 4491cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 4492cf655043SAndy Whitcroft $allowed = 1; 4493cf655043SAndy Whitcroft } 4494cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 4495cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 4496cf655043SAndy Whitcroft $allowed = 1; 4497cf655043SAndy Whitcroft } 4498cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 4499cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 4500cf655043SAndy Whitcroft $allowed = 1; 4501cf655043SAndy Whitcroft } 4502cf655043SAndy Whitcroft # Check the post-context. 4503cf655043SAndy Whitcroft if (defined $chunks[1]) { 4504cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 4505cf655043SAndy Whitcroft if (defined $cond) { 4506773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 4507cf655043SAndy Whitcroft } 4508cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 4509cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 4510cf655043SAndy Whitcroft $allowed = 1; 4511cf655043SAndy Whitcroft } 4512cf655043SAndy Whitcroft } 4513cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 451469932487SJustin P. Mattock my $herectx = $here . "\n"; 4515f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 4516cf655043SAndy Whitcroft 4517f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 451869932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 4519cf655043SAndy Whitcroft } 4520cf655043SAndy Whitcroft 4521000d1cc1SJoe Perches WARN("BRACES", 4522000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 4523f0a594c1SAndy Whitcroft } 4524f0a594c1SAndy Whitcroft } 4525f0a594c1SAndy Whitcroft 45260979ae66SJoe Perches# check for unnecessary blank lines around braces 452777b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 4528f8e58219SJoe Perches if (CHK("BRACES", 4529f8e58219SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 4530f8e58219SJoe Perches $fix && $prevrawline =~ /^\+/) { 4531f8e58219SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 4532f8e58219SJoe Perches } 45330979ae66SJoe Perches } 453477b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 4535f8e58219SJoe Perches if (CHK("BRACES", 4536f8e58219SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 4537f8e58219SJoe Perches $fix) { 4538f8e58219SJoe Perches fix_delete_line($fixlinenr, $rawline); 4539f8e58219SJoe Perches } 45400979ae66SJoe Perches } 45410979ae66SJoe Perches 45424a0df2efSAndy Whitcroft# no volatiles please 45436c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 45446c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 4545000d1cc1SJoe Perches WARN("VOLATILE", 4546000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 45474a0df2efSAndy Whitcroft } 45484a0df2efSAndy Whitcroft 45495e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability 45505e4f6ba5SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 45515e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 45525e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 45535e4f6ba5SJoe Perches if ($line =~ /^\+\s*"[X\t]*"/ && 45545e4f6ba5SJoe Perches $prevline =~ /"\s*$/ && 45555e4f6ba5SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 45565e4f6ba5SJoe Perches if (WARN("SPLIT_STRING", 45575e4f6ba5SJoe Perches "quoted string split across lines\n" . $hereprev) && 45585e4f6ba5SJoe Perches $fix && 45595e4f6ba5SJoe Perches $prevrawline =~ /^\+.*"\s*$/ && 45605e4f6ba5SJoe Perches $last_coalesced_string_linenr != $linenr - 1) { 45615e4f6ba5SJoe Perches my $extracted_string = get_quoted_string($line, $rawline); 45625e4f6ba5SJoe Perches my $comma_close = ""; 45635e4f6ba5SJoe Perches if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 45645e4f6ba5SJoe Perches $comma_close = $1; 45655e4f6ba5SJoe Perches } 45665e4f6ba5SJoe Perches 45675e4f6ba5SJoe Perches fix_delete_line($fixlinenr - 1, $prevrawline); 45685e4f6ba5SJoe Perches fix_delete_line($fixlinenr, $rawline); 45695e4f6ba5SJoe Perches my $fixedline = $prevrawline; 45705e4f6ba5SJoe Perches $fixedline =~ s/"\s*$//; 45715e4f6ba5SJoe Perches $fixedline .= substr($extracted_string, 1) . trim($comma_close); 45725e4f6ba5SJoe Perches fix_insert_line($fixlinenr - 1, $fixedline); 45735e4f6ba5SJoe Perches $fixedline = $rawline; 45745e4f6ba5SJoe Perches $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 45755e4f6ba5SJoe Perches if ($fixedline !~ /\+\s*$/) { 45765e4f6ba5SJoe Perches fix_insert_line($fixlinenr, $fixedline); 45775e4f6ba5SJoe Perches } 45785e4f6ba5SJoe Perches $last_coalesced_string_linenr = $linenr; 45795e4f6ba5SJoe Perches } 45805e4f6ba5SJoe Perches } 45815e4f6ba5SJoe Perches 45825e4f6ba5SJoe Perches# check for missing a space in a string concatenation 45835e4f6ba5SJoe Perches if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 45845e4f6ba5SJoe Perches WARN('MISSING_SPACE', 45855e4f6ba5SJoe Perches "break quoted strings at a space character\n" . $hereprev); 45865e4f6ba5SJoe Perches } 45875e4f6ba5SJoe Perches 45885e4f6ba5SJoe Perches# check for spaces before a quoted newline 45895e4f6ba5SJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 45905e4f6ba5SJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 45915e4f6ba5SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 45925e4f6ba5SJoe Perches $fix) { 45935e4f6ba5SJoe Perches $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 45945e4f6ba5SJoe Perches } 45955e4f6ba5SJoe Perches 45965e4f6ba5SJoe Perches } 45975e4f6ba5SJoe Perches 4598f17dba4fSJoe Perches# concatenated string without spaces between elements 4599f17dba4fSJoe Perches if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) { 4600f17dba4fSJoe Perches CHK("CONCATENATED_STRING", 4601f17dba4fSJoe Perches "Concatenated strings should use spaces between elements\n" . $herecurr); 4602f17dba4fSJoe Perches } 4603f17dba4fSJoe Perches 460490ad30e5SJoe Perches# uncoalesced string fragments 460590ad30e5SJoe Perches if ($line =~ /"X*"\s*"/) { 460690ad30e5SJoe Perches WARN("STRING_FRAGMENTS", 460790ad30e5SJoe Perches "Consecutive strings are generally better as a single string\n" . $herecurr); 460890ad30e5SJoe Perches } 460990ad30e5SJoe Perches 46105e4f6ba5SJoe Perches# check for %L{u,d,i} in strings 46115e4f6ba5SJoe Perches my $string; 46125e4f6ba5SJoe Perches while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 46135e4f6ba5SJoe Perches $string = substr($rawline, $-[1], $+[1] - $-[1]); 46145e4f6ba5SJoe Perches $string =~ s/%%/__/g; 46155e4f6ba5SJoe Perches if ($string =~ /(?<!%)%L[udi]/) { 46165e4f6ba5SJoe Perches WARN("PRINTF_L", 46175e4f6ba5SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 46185e4f6ba5SJoe Perches last; 46195e4f6ba5SJoe Perches } 46205e4f6ba5SJoe Perches } 46215e4f6ba5SJoe Perches 46225e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of " 46235e4f6ba5SJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 46245e4f6ba5SJoe Perches WARN("LINE_CONTINUATIONS", 46255e4f6ba5SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 46265e4f6ba5SJoe Perches } 46275e4f6ba5SJoe Perches 462800df344fSAndy Whitcroft# warn about #if 0 4629c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 4630000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 4631000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 4632de7d4f0eSAndy Whitcroft $herecurr); 46334a0df2efSAndy Whitcroft } 46344a0df2efSAndy Whitcroft 463503df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 463603df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 463703df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 463803df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 463903df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 464015160f90SFabio Estevam "$1(NULL) is safe and this check is probably not required\n" . $hereprev); 46414c432a8fSGreg Kroah-Hartman } 46424c432a8fSGreg Kroah-Hartman } 4643f0a594c1SAndy Whitcroft 4644ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages 4645ebfdc409SJoe Perches if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 4646ebfdc409SJoe Perches $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 4647ebfdc409SJoe Perches (defined $1 || defined $3) && 4648ebfdc409SJoe Perches $linenr > 3) { 4649ebfdc409SJoe Perches my $testval = $2; 4650ebfdc409SJoe Perches my $testline = $lines[$linenr - 3]; 4651ebfdc409SJoe Perches 4652ebfdc409SJoe Perches my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 4653ebfdc409SJoe Perches# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 4654ebfdc409SJoe Perches 4655ebfdc409SJoe 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)/) { 4656ebfdc409SJoe Perches WARN("OOM_MESSAGE", 4657ebfdc409SJoe Perches "Possible unnecessary 'out of memory' message\n" . $hereprev); 4658ebfdc409SJoe Perches } 4659ebfdc409SJoe Perches } 4660ebfdc409SJoe Perches 4661f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL> 4662dcaf1123SPaolo Bonzini if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 4663f78d98f6SJoe Perches $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 4664f78d98f6SJoe Perches my $level = $1; 4665f78d98f6SJoe Perches if (WARN("UNNECESSARY_KERN_LEVEL", 4666f78d98f6SJoe Perches "Possible unnecessary $level\n" . $herecurr) && 4667f78d98f6SJoe Perches $fix) { 4668f78d98f6SJoe Perches $fixed[$fixlinenr] =~ s/\s*$level\s*//; 4669f78d98f6SJoe Perches } 4670f78d98f6SJoe Perches } 4671f78d98f6SJoe Perches 4672abb08a53SJoe Perches# check for mask then right shift without a parentheses 4673abb08a53SJoe Perches if ($^V && $^V ge 5.10.0 && 4674abb08a53SJoe Perches $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 4675abb08a53SJoe Perches $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 4676abb08a53SJoe Perches WARN("MASK_THEN_SHIFT", 4677abb08a53SJoe Perches "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 4678abb08a53SJoe Perches } 4679abb08a53SJoe Perches 4680b75ac618SJoe Perches# check for pointer comparisons to NULL 4681b75ac618SJoe Perches if ($^V && $^V ge 5.10.0) { 4682b75ac618SJoe Perches while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 4683b75ac618SJoe Perches my $val = $1; 4684b75ac618SJoe Perches my $equal = "!"; 4685b75ac618SJoe Perches $equal = "" if ($4 eq "!="); 4686b75ac618SJoe Perches if (CHK("COMPARISON_TO_NULL", 4687b75ac618SJoe Perches "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 4688b75ac618SJoe Perches $fix) { 4689b75ac618SJoe Perches $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 4690b75ac618SJoe Perches } 4691b75ac618SJoe Perches } 4692b75ac618SJoe Perches } 4693b75ac618SJoe Perches 46948716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 46958716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 46968716de38SJoe Perches my $attr = $1; 46978716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 46988716de38SJoe Perches my $ptr = $1; 46998716de38SJoe Perches my $var = $2; 47008716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 47018716de38SJoe Perches ERROR("MISPLACED_INIT", 47028716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 47038716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 47048716de38SJoe Perches WARN("MISPLACED_INIT", 47058716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 47068716de38SJoe Perches $fix) { 4707194f66fcSJoe 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; 47088716de38SJoe Perches } 47098716de38SJoe Perches } 47108716de38SJoe Perches } 47118716de38SJoe Perches 4712e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 4713e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 4714e970b884SJoe Perches my $attr = $1; 4715e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 4716e970b884SJoe Perches my $attr_prefix = $1; 4717e970b884SJoe Perches my $attr_type = $2; 4718e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4719e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 4720e970b884SJoe Perches $fix) { 4721194f66fcSJoe Perches $fixed[$fixlinenr] =~ 4722e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 4723e970b884SJoe Perches } 4724e970b884SJoe Perches } 4725e970b884SJoe Perches 4726e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 4727e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 4728e970b884SJoe Perches my $attr = $1; 4729e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 4730e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 4731e970b884SJoe Perches $fix) { 4732194f66fcSJoe Perches my $lead = $fixed[$fixlinenr] =~ 4733e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 4734e970b884SJoe Perches $lead = rtrim($1); 4735e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 4736e970b884SJoe Perches $lead = "${lead}const "; 4737194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 4738e970b884SJoe Perches } 4739e970b884SJoe Perches } 4740e970b884SJoe Perches 4741fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/ 4742fbdb8138SJoe Perches if ($realfile !~ m@^include/uapi/@ && 4743fbdb8138SJoe Perches $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 4744fbdb8138SJoe Perches my $constant_func = $1; 4745fbdb8138SJoe Perches my $func = $constant_func; 4746fbdb8138SJoe Perches $func =~ s/^__constant_//; 4747fbdb8138SJoe Perches if (WARN("CONSTANT_CONVERSION", 4748fbdb8138SJoe Perches "$constant_func should be $func\n" . $herecurr) && 4749fbdb8138SJoe Perches $fix) { 4750194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 4751fbdb8138SJoe Perches } 4752fbdb8138SJoe Perches } 4753fbdb8138SJoe Perches 47541a15a250SPatrick Pannuto# prefer usleep_range over udelay 475537581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 475643c1d77cSJoe Perches my $delay = $1; 47571a15a250SPatrick Pannuto # ignore udelay's < 10, however 475843c1d77cSJoe Perches if (! ($delay < 10) ) { 4759000d1cc1SJoe Perches CHK("USLEEP_RANGE", 476043c1d77cSJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr); 476143c1d77cSJoe Perches } 476243c1d77cSJoe Perches if ($delay > 2000) { 476343c1d77cSJoe Perches WARN("LONG_UDELAY", 476443c1d77cSJoe Perches "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 47651a15a250SPatrick Pannuto } 47661a15a250SPatrick Pannuto } 47671a15a250SPatrick Pannuto 476809ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 476909ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 477009ef8725SPatrick Pannuto if ($1 < 20) { 4771000d1cc1SJoe Perches WARN("MSLEEP", 477243c1d77cSJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr); 477309ef8725SPatrick Pannuto } 477409ef8725SPatrick Pannuto } 477509ef8725SPatrick Pannuto 477636ec1939SJoe Perches# check for comparisons of jiffies 477736ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 477836ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 477936ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 478036ec1939SJoe Perches } 478136ec1939SJoe Perches 47829d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 47839d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 47849d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 47859d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 47869d7a34a5SJoe Perches } 47879d7a34a5SJoe Perches 478800df344fSAndy Whitcroft# warn about #ifdefs in C files 4789c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 479000df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 479100df344fSAndy Whitcroft# print "$herecurr"; 479200df344fSAndy Whitcroft# $clean = 0; 479300df344fSAndy Whitcroft# } 479400df344fSAndy Whitcroft 479522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 4796c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 47973705ce5bSJoe Perches if (ERROR("SPACING", 47983705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 47993705ce5bSJoe Perches $fix) { 4800194f66fcSJoe Perches $fixed[$fixlinenr] =~ 48013705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 48023705ce5bSJoe Perches } 48033705ce5bSJoe Perches 480422f2a2efSAndy Whitcroft } 480522f2a2efSAndy Whitcroft 48064a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 4807171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 4808171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 48094a0df2efSAndy Whitcroft my $which = $1; 48104a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4811000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 4812000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 48134a0df2efSAndy Whitcroft } 48144a0df2efSAndy Whitcroft } 48154a0df2efSAndy Whitcroft# check for memory barriers without a comment. 48164a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 48174a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 4818c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 4819000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 48204a0df2efSAndy Whitcroft } 48214a0df2efSAndy Whitcroft } 48224a0df2efSAndy Whitcroft# check of hardware specific defines 4823c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 4824000d1cc1SJoe Perches CHK("ARCH_DEFINES", 4825000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 48260a920b5bSAndy Whitcroft } 4827653d4876SAndy Whitcroft 4828d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 4829d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 4830000d1cc1SJoe Perches WARN("STORAGE_CLASS", 4831000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 4832d4977c78STobias Klauser } 4833d4977c78STobias Klauser 4834de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 4835de7d4f0eSAndy Whitcroft# storage class and type. 48369c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 48379c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 4838000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 4839000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 4840de7d4f0eSAndy Whitcroft } 4841de7d4f0eSAndy Whitcroft 48428905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 48432b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 48442b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 4845d5e616fcSJoe Perches if (WARN("INLINE", 4846d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 4847d5e616fcSJoe Perches $fix) { 4848194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 4849d5e616fcSJoe Perches 4850d5e616fcSJoe Perches } 48518905a67cSAndy Whitcroft } 48528905a67cSAndy Whitcroft 48533d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 48542b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 48552b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 4856000d1cc1SJoe Perches WARN("PREFER_PACKED", 4857000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 48583d130fd0SJoe Perches } 48593d130fd0SJoe Perches 486039b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 48612b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 48622b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 4863000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 4864000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 486539b7e287SJoe Perches } 486639b7e287SJoe Perches 48675f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 48682b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 48692b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 4870d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 4871d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 4872d5e616fcSJoe Perches $fix) { 4873194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 4874d5e616fcSJoe Perches 4875d5e616fcSJoe Perches } 48765f14d3bdSJoe Perches } 48775f14d3bdSJoe Perches 48786061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 48792b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 48802b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 4881d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 4882d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 4883d5e616fcSJoe Perches $fix) { 4884194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 4885d5e616fcSJoe Perches } 48866061d949SJoe Perches } 48876061d949SJoe Perches 4888619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues) 4889619a908aSJoe Perches if ($^V && $^V ge 5.10.0 && 4890619a908aSJoe Perches $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 4891619a908aSJoe Perches ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 4892619a908aSJoe Perches $line =~ /\b__weak\b/)) { 4893619a908aSJoe Perches ERROR("WEAK_DECLARATION", 4894619a908aSJoe Perches "Using weak declarations can have unintended link defects\n" . $herecurr); 4895619a908aSJoe Perches } 4896619a908aSJoe Perches 48978f53a9b8SJoe Perches# check for sizeof(&) 48988f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 4899000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 4900000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 49018f53a9b8SJoe Perches } 49028f53a9b8SJoe Perches 490366c80b60SJoe Perches# check for sizeof without parenthesis 490466c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 4905d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 4906d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 4907d5e616fcSJoe Perches $fix) { 4908194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 4909d5e616fcSJoe Perches } 491066c80b60SJoe Perches } 491166c80b60SJoe Perches 491288982feaSJoe Perches# check for struct spinlock declarations 491388982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 491488982feaSJoe Perches WARN("USE_SPINLOCK_T", 491588982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 491688982feaSJoe Perches } 491788982feaSJoe Perches 4918a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 491906668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 4920a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 4921caac1d5fSHeba Aamer $fmt =~ s/%%//g; 4922caac1d5fSHeba Aamer if ($fmt !~ /%/) { 4923d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 4924d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 4925d5e616fcSJoe Perches $fix) { 4926194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 4927d5e616fcSJoe Perches } 4928a6962d72SJoe Perches } 4929a6962d72SJoe Perches } 4930a6962d72SJoe Perches 4931554e165cSAndy Whitcroft# Check for misused memsets 4932d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4933d1fe9c09SJoe Perches defined $stat && 4934d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 4935554e165cSAndy Whitcroft 4936d7c76ba7SJoe Perches my $ms_addr = $2; 4937d1fe9c09SJoe Perches my $ms_val = $7; 4938d1fe9c09SJoe Perches my $ms_size = $12; 4939d7c76ba7SJoe Perches 4940554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 4941554e165cSAndy Whitcroft ERROR("MEMSET", 4942d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 4943554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 4944554e165cSAndy Whitcroft WARN("MEMSET", 4945d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 4946d7c76ba7SJoe Perches } 4947d7c76ba7SJoe Perches } 4948d7c76ba7SJoe Perches 494998a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 495098a9bba5SJoe Perches if ($^V && $^V ge 5.10.0 && 495198a9bba5SJoe Perches $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) { 495298a9bba5SJoe Perches if (WARN("PREFER_ETHER_ADDR_COPY", 495398a9bba5SJoe Perches "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) && 495498a9bba5SJoe Perches $fix) { 4955194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 495698a9bba5SJoe Perches } 495798a9bba5SJoe Perches } 495898a9bba5SJoe Perches 4959d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 4960d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 4961d1fe9c09SJoe Perches defined $stat && 4962d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 4963d1fe9c09SJoe Perches if (defined $2 || defined $7) { 4964d7c76ba7SJoe Perches my $call = $1; 4965d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 4966d7c76ba7SJoe Perches my $arg1 = $3; 4967d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 4968d1fe9c09SJoe Perches my $arg2 = $8; 4969d7c76ba7SJoe Perches my $cast; 4970d7c76ba7SJoe Perches 4971d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4972d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4973d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4974d7c76ba7SJoe Perches $cast = $cast1; 4975d7c76ba7SJoe Perches } else { 4976d7c76ba7SJoe Perches $cast = $cast2; 4977d7c76ba7SJoe Perches } 4978d7c76ba7SJoe Perches WARN("MINMAX", 4979d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4980554e165cSAndy Whitcroft } 4981554e165cSAndy Whitcroft } 4982554e165cSAndy Whitcroft 49834a273195SJoe Perches# check usleep_range arguments 49844a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 49854a273195SJoe Perches defined $stat && 49864a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 49874a273195SJoe Perches my $min = $1; 49884a273195SJoe Perches my $max = $7; 49894a273195SJoe Perches if ($min eq $max) { 49904a273195SJoe Perches WARN("USLEEP_RANGE", 49914a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 49924a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 49934a273195SJoe Perches $min > $max) { 49944a273195SJoe Perches WARN("USLEEP_RANGE", 49954a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 49964a273195SJoe Perches } 49974a273195SJoe Perches } 49984a273195SJoe Perches 4999823b794cSJoe Perches# check for naked sscanf 5000823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 5001823b794cSJoe Perches defined $stat && 50026c8bd707SJoe Perches $line =~ /\bsscanf\b/ && 5003823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 5004823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 5005823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 5006823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 5007823b794cSJoe Perches $lc = $lc + $linenr; 5008823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 5009823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5010823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5011823b794cSJoe Perches } 5012823b794cSJoe Perches WARN("NAKED_SSCANF", 5013823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 5014823b794cSJoe Perches } 5015823b794cSJoe Perches 5016afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo> 5017afc819abSJoe Perches if ($^V && $^V ge 5.10.0 && 5018afc819abSJoe Perches defined $stat && 5019afc819abSJoe Perches $line =~ /\bsscanf\b/) { 5020afc819abSJoe Perches my $lc = $stat =~ tr@\n@@; 5021afc819abSJoe Perches $lc = $lc + $linenr; 5022afc819abSJoe Perches my $stat_real = raw_line($linenr, 0); 5023afc819abSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 5024afc819abSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 5025afc819abSJoe Perches } 5026afc819abSJoe Perches if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 5027afc819abSJoe Perches my $format = $6; 5028afc819abSJoe Perches my $count = $format =~ tr@%@%@; 5029afc819abSJoe Perches if ($count == 1 && 5030afc819abSJoe Perches $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 5031afc819abSJoe Perches WARN("SSCANF_TO_KSTRTO", 5032afc819abSJoe Perches "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 5033afc819abSJoe Perches } 5034afc819abSJoe Perches } 5035afc819abSJoe Perches } 5036afc819abSJoe Perches 503770dc8a48SJoe Perches# check for new externs in .h files. 503870dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 503970dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 5040d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 504170dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 504270dc8a48SJoe Perches $fix) { 5043194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 504470dc8a48SJoe Perches } 504570dc8a48SJoe Perches } 504670dc8a48SJoe Perches 5047de7d4f0eSAndy Whitcroft# check for new externs in .c files. 5048171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 5049c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 5050171ae1a4SAndy Whitcroft { 5051c45dcabdSAndy Whitcroft my $function_name = $1; 5052c45dcabdSAndy Whitcroft my $paren_space = $2; 5053171ae1a4SAndy Whitcroft 5054171ae1a4SAndy Whitcroft my $s = $stat; 5055171ae1a4SAndy Whitcroft if (defined $cond) { 5056171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 5057171ae1a4SAndy Whitcroft } 5058c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 5059c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 5060c45dcabdSAndy Whitcroft { 5061000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5062000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5063de7d4f0eSAndy Whitcroft } 5064de7d4f0eSAndy Whitcroft 5065171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 5066000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 5067000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 5068171ae1a4SAndy Whitcroft } 50699c9ba34eSAndy Whitcroft 50709c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 50719c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 50729c9ba34eSAndy Whitcroft { 5073000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 5074000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 5075171ae1a4SAndy Whitcroft } 5076171ae1a4SAndy Whitcroft 5077de7d4f0eSAndy Whitcroft# checks for new __setup's 5078de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 5079de7d4f0eSAndy Whitcroft my $name = $1; 5080de7d4f0eSAndy Whitcroft 5081de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 5082000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 5083000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5084de7d4f0eSAndy Whitcroft } 5085653d4876SAndy Whitcroft } 50869c0ca6f9SAndy Whitcroft 50879c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 5088caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 5089000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 5090000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 50919c0ca6f9SAndy Whitcroft } 509213214adfSAndy Whitcroft 5093a640d25cSJoe Perches# alloc style 5094a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 5095a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 5096a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 5097a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 5098a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 5099a640d25cSJoe Perches } 5100a640d25cSJoe Perches 510160a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 510260a55369SJoe Perches if ($^V && $^V ge 5.10.0 && 5103e367455aSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 510460a55369SJoe Perches my $oldfunc = $3; 510560a55369SJoe Perches my $a1 = $4; 510660a55369SJoe Perches my $a2 = $10; 510760a55369SJoe Perches my $newfunc = "kmalloc_array"; 510860a55369SJoe Perches $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 510960a55369SJoe Perches my $r1 = $a1; 511060a55369SJoe Perches my $r2 = $a2; 511160a55369SJoe Perches if ($a1 =~ /^sizeof\s*\S/) { 511260a55369SJoe Perches $r1 = $a2; 511360a55369SJoe Perches $r2 = $a1; 511460a55369SJoe Perches } 5115e367455aSJoe Perches if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 5116e367455aSJoe Perches !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 5117e367455aSJoe Perches if (WARN("ALLOC_WITH_MULTIPLY", 5118e367455aSJoe Perches "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) && 5119e367455aSJoe Perches $fix) { 5120194f66fcSJoe 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; 512160a55369SJoe Perches 512260a55369SJoe Perches } 512360a55369SJoe Perches } 512460a55369SJoe Perches } 512560a55369SJoe Perches 5126972fdea2SJoe Perches# check for krealloc arg reuse 5127972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 5128972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 5129972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 5130972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 5131972fdea2SJoe Perches } 5132972fdea2SJoe Perches 51335ce59ae0SJoe Perches# check for alloc argument mismatch 51345ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 51355ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 51365ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 51375ce59ae0SJoe Perches } 51385ce59ae0SJoe Perches 5139caf2a54fSJoe Perches# check for multiple semicolons 5140caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 5141d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 5142d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 5143d5e616fcSJoe Perches $fix) { 5144194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 5145d5e616fcSJoe Perches } 5146d1e2ad07SJoe Perches } 5147d1e2ad07SJoe Perches 51480ab90191SJoe Perches# check for #defines like: 1 << <digit> that could be BIT(digit) 51490ab90191SJoe Perches if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 51500ab90191SJoe Perches my $ull = ""; 51510ab90191SJoe Perches $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 51520ab90191SJoe Perches if (CHK("BIT_MACRO", 51530ab90191SJoe Perches "Prefer using the BIT$ull macro\n" . $herecurr) && 51540ab90191SJoe Perches $fix) { 51550ab90191SJoe Perches $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 51560ab90191SJoe Perches } 51570ab90191SJoe Perches } 51580ab90191SJoe Perches 5159e81f239bSJoe Perches# check for case / default statements not preceded by break/fallthrough/switch 5160c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 5161c34c09a8SJoe Perches my $has_break = 0; 5162c34c09a8SJoe Perches my $has_statement = 0; 5163c34c09a8SJoe Perches my $count = 0; 5164c34c09a8SJoe Perches my $prevline = $linenr; 5165e81f239bSJoe Perches while ($prevline > 1 && ($file || $count < 3) && !$has_break) { 5166c34c09a8SJoe Perches $prevline--; 5167c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 5168c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 5169c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 5170c34c09a8SJoe Perches next if ($fline =~ /^\-/); 5171c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 5172c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 5173c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 5174c34c09a8SJoe Perches $has_statement = 1; 5175c34c09a8SJoe Perches $count++; 5176c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 5177c34c09a8SJoe Perches } 5178c34c09a8SJoe Perches if (!$has_break && $has_statement) { 5179c34c09a8SJoe Perches WARN("MISSING_BREAK", 5180c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 5181c34c09a8SJoe Perches } 5182c34c09a8SJoe Perches } 5183c34c09a8SJoe Perches 5184d1e2ad07SJoe Perches# check for switch/default statements without a break; 5185d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 5186d1e2ad07SJoe Perches defined $stat && 5187d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 5188d1e2ad07SJoe Perches my $ctx = ''; 5189d1e2ad07SJoe Perches my $herectx = $here . "\n"; 5190d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 5191d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 5192d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 5193d1e2ad07SJoe Perches } 5194d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 5195d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 5196caf2a54fSJoe Perches } 5197caf2a54fSJoe Perches 519813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 5199d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 5200d5e616fcSJoe Perches if (WARN("USE_FUNC", 5201d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 5202d5e616fcSJoe Perches $fix) { 5203194f66fcSJoe Perches $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 5204d5e616fcSJoe Perches } 520513214adfSAndy Whitcroft } 5206773647a0SAndy Whitcroft 520762ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 520862ec818fSJoe Perches while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 520962ec818fSJoe Perches ERROR("DATE_TIME", 521062ec818fSJoe Perches "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 521162ec818fSJoe Perches } 521262ec818fSJoe Perches 52132c92488aSJoe Perches# check for use of yield() 52142c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 52152c92488aSJoe Perches WARN("YIELD", 52162c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 52172c92488aSJoe Perches } 52182c92488aSJoe Perches 5219179f8f40SJoe Perches# check for comparisons against true and false 5220179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 5221179f8f40SJoe Perches my $lead = $1; 5222179f8f40SJoe Perches my $arg = $2; 5223179f8f40SJoe Perches my $test = $3; 5224179f8f40SJoe Perches my $otype = $4; 5225179f8f40SJoe Perches my $trail = $5; 5226179f8f40SJoe Perches my $op = "!"; 5227179f8f40SJoe Perches 5228179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 5229179f8f40SJoe Perches 5230179f8f40SJoe Perches my $type = lc($otype); 5231179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 5232179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 5233179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 5234179f8f40SJoe Perches $op = ""; 5235179f8f40SJoe Perches } 5236179f8f40SJoe Perches 5237179f8f40SJoe Perches CHK("BOOL_COMPARISON", 5238179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 5239179f8f40SJoe Perches 5240179f8f40SJoe Perches## maybe suggesting a correct construct would better 5241179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 5242179f8f40SJoe Perches 5243179f8f40SJoe Perches } 5244179f8f40SJoe Perches } 5245179f8f40SJoe Perches 52464882720bSThomas Gleixner# check for semaphores initialized locked 52474882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 5248000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 5249000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 5250773647a0SAndy Whitcroft } 52516712d858SJoe Perches 525267d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 525367d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 5254000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 525567d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 5256773647a0SAndy Whitcroft } 52576712d858SJoe Perches 5258ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please 5259f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 5260000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 5261ae3ccc46SFabian Frederick "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 5262f3db6639SMichael Ellerman } 52636712d858SJoe Perches 52640f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree) 52650f3c5aabSJoe Perches my $const_structs = qr{ 52660f3c5aabSJoe Perches acpi_dock_ops| 526779404849SEmese Revfy address_space_operations| 526879404849SEmese Revfy backlight_ops| 526979404849SEmese Revfy block_device_operations| 527079404849SEmese Revfy dentry_operations| 527179404849SEmese Revfy dev_pm_ops| 527279404849SEmese Revfy dma_map_ops| 527379404849SEmese Revfy extent_io_ops| 527479404849SEmese Revfy file_lock_operations| 527579404849SEmese Revfy file_operations| 527679404849SEmese Revfy hv_ops| 527779404849SEmese Revfy ide_dma_ops| 527879404849SEmese Revfy intel_dvo_dev_ops| 527979404849SEmese Revfy item_operations| 528079404849SEmese Revfy iwl_ops| 528179404849SEmese Revfy kgdb_arch| 528279404849SEmese Revfy kgdb_io| 528379404849SEmese Revfy kset_uevent_ops| 528479404849SEmese Revfy lock_manager_operations| 528579404849SEmese Revfy microcode_ops| 528679404849SEmese Revfy mtrr_ops| 528779404849SEmese Revfy neigh_ops| 528879404849SEmese Revfy nlmsvc_binding| 52890f3c5aabSJoe Perches of_device_id| 529079404849SEmese Revfy pci_raw_ops| 529179404849SEmese Revfy pipe_buf_operations| 529279404849SEmese Revfy platform_hibernation_ops| 529379404849SEmese Revfy platform_suspend_ops| 529479404849SEmese Revfy proto_ops| 529579404849SEmese Revfy rpc_pipe_ops| 529679404849SEmese Revfy seq_operations| 529779404849SEmese Revfy snd_ac97_build_ops| 529879404849SEmese Revfy soc_pcmcia_socket_ops| 529979404849SEmese Revfy stacktrace_ops| 530079404849SEmese Revfy sysfs_ops| 530179404849SEmese Revfy tty_operations| 530279404849SEmese Revfy usb_mon_operations| 530379404849SEmese Revfy wd_ops}x; 53046903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 53050f3c5aabSJoe Perches $line =~ /\bstruct\s+($const_structs)\b/) { 5306000d1cc1SJoe Perches WARN("CONST_STRUCT", 5307000d1cc1SJoe Perches "struct $1 should normally be const\n" . 53086903ffb2SAndy Whitcroft $herecurr); 53092b6db5cbSAndy Whitcroft } 5310773647a0SAndy Whitcroft 5311773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 5312773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 5313773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 5314c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 5315c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 5316171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 5317171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 5318171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 5319773647a0SAndy Whitcroft { 5320000d1cc1SJoe Perches WARN("NR_CPUS", 5321000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 5322773647a0SAndy Whitcroft } 53239c9ba34eSAndy Whitcroft 532452ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 532552ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 532652ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 532752ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 532852ea8506SJoe Perches } 532952ea8506SJoe Perches 5330acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)" 5331acd9362cSJoe Perches if ($^V && $^V ge 5.10.0 && 5332acd9362cSJoe Perches $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 5333acd9362cSJoe Perches WARN("LIKELY_MISUSE", 5334acd9362cSJoe Perches "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 5335acd9362cSJoe Perches } 5336acd9362cSJoe Perches 5337691d77b6SAndy Whitcroft# whine mightly about in_atomic 5338691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 5339691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 5340000d1cc1SJoe Perches ERROR("IN_ATOMIC", 5341000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 5342f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 5343000d1cc1SJoe Perches WARN("IN_ATOMIC", 5344000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 5345691d77b6SAndy Whitcroft } 5346691d77b6SAndy Whitcroft } 53471704f47bSPeter Zijlstra 53481704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 53491704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 53501704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 53511704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 53521704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 53531704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 5354000d1cc1SJoe Perches ERROR("LOCKDEP", 5355000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 53561704f47bSPeter Zijlstra } 53571704f47bSPeter Zijlstra } 535888f8831cSDave Jones 535988f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 536088f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 5361000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 5362000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 536388f8831cSDave Jones } 53642435880fSJoe Perches 5365515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal 5366515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 5367515a235eSJoe Perches if ($^V && $^V ge 5.10.0 && 5368515a235eSJoe Perches $line =~ /$mode_perms_search/) { 53692435880fSJoe Perches foreach my $entry (@mode_permission_funcs) { 53702435880fSJoe Perches my $func = $entry->[0]; 53712435880fSJoe Perches my $arg_pos = $entry->[1]; 53722435880fSJoe Perches 53732435880fSJoe Perches my $skip_args = ""; 53742435880fSJoe Perches if ($arg_pos > 1) { 53752435880fSJoe Perches $arg_pos--; 53762435880fSJoe Perches $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 53772435880fSJoe Perches } 53782435880fSJoe Perches my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]"; 5379515a235eSJoe Perches if ($line =~ /$test/) { 53802435880fSJoe Perches my $val = $1; 53812435880fSJoe Perches $val = $6 if ($skip_args ne ""); 53822435880fSJoe Perches 53831727cc70SJoe Perches if ($val !~ /^0$/ && 53841727cc70SJoe Perches (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 53851727cc70SJoe Perches length($val) ne 4)) { 53862435880fSJoe Perches ERROR("NON_OCTAL_PERMISSIONS", 53871727cc70SJoe Perches "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr); 5388c0a5c898SJoe Perches } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) { 5389c0a5c898SJoe Perches ERROR("EXPORTED_WORLD_WRITABLE", 5390c0a5c898SJoe Perches "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 53912435880fSJoe Perches } 53922435880fSJoe Perches } 53932435880fSJoe Perches } 539413214adfSAndy Whitcroft } 5395515a235eSJoe Perches } 539613214adfSAndy Whitcroft 539713214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 539813214adfSAndy Whitcroft # so just keep quiet. 539913214adfSAndy Whitcroft if ($#rawlines == -1) { 540013214adfSAndy Whitcroft exit(0); 54010a920b5bSAndy Whitcroft } 54020a920b5bSAndy Whitcroft 54038905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 54048905a67cSAndy Whitcroft # things that appear to be patches. 54058905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 54068905a67cSAndy Whitcroft exit(0); 54078905a67cSAndy Whitcroft } 54088905a67cSAndy Whitcroft 54098905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 54108905a67cSAndy Whitcroft # just keep quiet. 54118905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 54128905a67cSAndy Whitcroft exit(0); 54138905a67cSAndy Whitcroft } 54148905a67cSAndy Whitcroft 54158905a67cSAndy Whitcroft if (!$is_patch) { 5416000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 5417000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 54180a920b5bSAndy Whitcroft } 54190a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 5420000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 5421000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 54220a920b5bSAndy Whitcroft } 54230a920b5bSAndy Whitcroft 5424f0a594c1SAndy Whitcroft print report_dump(); 542513214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 542613214adfSAndy Whitcroft print "$filename " if ($summary_file); 54276c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 54286c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 54296c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 54308905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 54316c72ffaaSAndy Whitcroft } 54328905a67cSAndy Whitcroft 5433d2c0a235SAndy Whitcroft if ($quiet == 0) { 5434d1fe9c09SJoe Perches 5435d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 5436d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 5437d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 5438d1fe9c09SJoe Perches } 5439d1fe9c09SJoe Perches 5440d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 5441d2c0a235SAndy Whitcroft # then suggest that. 5442d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 5443d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 5444d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 5445b0781216SMike Frysinger $rpt_cleaners = 0; 5446d2c0a235SAndy Whitcroft } 5447d2c0a235SAndy Whitcroft } 5448d2c0a235SAndy Whitcroft 544991bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 545091bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 5451000d1cc1SJoe Perches 5452d752fcc8SJoe Perches if ($clean == 0 && $fix && 5453d752fcc8SJoe Perches ("@rawlines" ne "@fixed" || 5454d752fcc8SJoe Perches $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 54559624b8d6SJoe Perches my $newfile = $filename; 54569624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 54573705ce5bSJoe Perches my $linecount = 0; 54583705ce5bSJoe Perches my $f; 54593705ce5bSJoe Perches 5460d752fcc8SJoe Perches @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 5461d752fcc8SJoe Perches 54623705ce5bSJoe Perches open($f, '>', $newfile) 54633705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 54643705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 54653705ce5bSJoe Perches $linecount++; 54663705ce5bSJoe Perches if ($file) { 54673705ce5bSJoe Perches if ($linecount > 3) { 54683705ce5bSJoe Perches $fixed_line =~ s/^\+//; 54693705ce5bSJoe Perches print $f $fixed_line . "\n"; 54703705ce5bSJoe Perches } 54713705ce5bSJoe Perches } else { 54723705ce5bSJoe Perches print $f $fixed_line . "\n"; 54733705ce5bSJoe Perches } 54743705ce5bSJoe Perches } 54753705ce5bSJoe Perches close($f); 54763705ce5bSJoe Perches 54773705ce5bSJoe Perches if (!$quiet) { 54783705ce5bSJoe Perches print << "EOM"; 54793705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 54803705ce5bSJoe Perches 54813705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 54823705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 54833705ce5bSJoe Perches 54843705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 54853705ce5bSJoe PerchesNo warranties, expressed or implied... 54863705ce5bSJoe Perches 54873705ce5bSJoe PerchesEOM 54883705ce5bSJoe Perches } 54893705ce5bSJoe Perches } 54903705ce5bSJoe Perches 54910a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 5492c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 54930a920b5bSAndy Whitcroft } 54940a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 5495000d1cc1SJoe Perches print << "EOM"; 5496000d1cc1SJoe Perches$vname has style problems, please review. 5497000d1cc1SJoe Perches 5498000d1cc1SJoe PerchesIf any of these errors are false positives, please report 5499000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 5500000d1cc1SJoe PerchesEOM 55010a920b5bSAndy Whitcroft } 550213214adfSAndy Whitcroft 55030a920b5bSAndy Whitcroft return $clean; 55040a920b5bSAndy Whitcroft} 5505